awseward / restivus

A simple, basic .NET REST library

Restivus

A simple, basic .NET REST library

Installation

Install-Package Restivus

Usage

Here's a quick and basic request to GitHub's API v3 using Restivus

// ...
using Newtonsoft.Json;
using Restivus;

class GitHubWebApi : IWebApi
{
    public string BasePath { get; } = "/";
    public string Host { get; } = "api.github.com";
    public int? Port { get; }
    public string Scheme { get; } = "https";
}

class GitHubRestClient : IRestClient
{
    public IReadOnlyCollection<IHttpRequestMiddleware> RequestMiddlewares { get; } =
        new List<IHttpRequestMiddleware>().AsReadOnly();

    public IHttpRequestSender RequestSender { get; } =
        new HttpRequestSender(YourApp.HttpClientInstance);

    public IWebApi WebApi { get; } = new GitHubWebApi();

    public Task<GitHubUser> GetUsers()
    {
        return this.Get().SendAsync(
            "/users",
            _DeserializeJson<IEnumerable<GitHubUser>>
        );
    }

    private async Task<T> _DeserializeJson<T>(HttpResponseMessage response)
    {
        response.EnsureSuccessStatusCode();

        return JsonConvert.DeserializeObject<T>(
            await response.Content.ReadAsStringAsync()
        );
    }
}

[JsonObject]
class GitHubUser { /* ... */ }

Publishing

Mostly a reminder for myself since I publish so infrequently:

git clean -xdf

# Build in Release config in VS

nuget pack -Properties Configuration=Release src/Restivus/Restivus.csproj

nuget push Restivus.<version>.nupkg -Source https://api.nuget.org/v3/index.json -ApiKey $NUGET_API_KEY

restivus's Issues

Cancellation Support

I would like to be able to pass a CancellationToken to all the exposed methods.

Better Response Handling

Hello,

This is a pretty sweet .NET rest client. Haven't found one this nice. 👍

I would like to be able to add some hooks or be able to process the HttpResponseMessage myself.

Currently, if a bad request has happened it will throw an exception as demonstrated here. master...mglodack:fails_before_deserializing

I noticed that the SendAsync method is calling EnsureSuccessStatusCode() in the codebase here.

What do you thing about having the SendAsync method return HttpResponseMessage instead of type T?

Upload/Download file

I would like to be able to the do the following:

1. Ability to upload using multipart/form-data with the option to report progress
2. Ability to download a file and with the option to report progress

Downloading a file may not be as important because anyone can make use of the deserialize delegate to report progress.

There is a way to report progress by creating a custom HttpContent. Any interests in have that a part of this library or supporting file upload/downloads?

Handle query params in path gracefully

If I provide a path of /api/users?city=london, it should peel the query params off and include them properly instead of blowing up like it currently does.

Double logging for `HttpResponseMessage`-returning `SendAsync` calls

When you have a call to SendAsync that returns Task<HttpResponseMessage>, restivus is logging it twice.

Post provide a Generic Type instead of object

I did have a slight enhancement to the post method and possibly others that exposed a delegate to creating HttpContent.

I had to cast my object for this Func<object, HttpContent>. Any way we can make that a generic. Something like Func<T, HttpContent>?

Not Too Psyched About Last Parameter

Having a hard time trying to figure out how send a GET request with a payload.

Looks like this might still be up for improvement?

restivus/src/Restivus/SingleMethodRequestSender.cs

Line 121 in 887da55

Func<object, HttpContent> createRequestContent) // Not too thrilled with this last parameter...

Ability To Modify SendAsync Calls

As a consumer, I would like to be able to modify the SendAsync arguments.

restivus/src/Restivus/HttpRequestSender.cs

Line 73 in 8f755e4

using (var response = await HttpClient.SendAsync(message, token))

Having a way to modify the HttpCompletionOption is definitely a must have.

https://msdn.microsoft.com/en-us/library/system.net.http.httpcompletionoption(v=vs.118).aspx

Clarifying ISingleMethodRequestSender

I'm not sure I fully understand how to use ISingleMethodRequestSender.

Would you mind clarifying what this ISingleMethodRequestSender is for or how to use?