mirror of
https://github.com/zoriya/octokit.net.git
synced 2025-12-05 23:06:10 +00:00
9a3177e385
* add custom properties model and clients * observable * observable tests * add search * error CS8370: 'target-typed object creation' * Error CS8370: 'target-typed object creation' * add patch with body that return status code * fixes for failed ConventionTests * working UnitTests * (de)serialization and model tests * Update Repository.cs
948 lines
42 KiB
C#
948 lines
42 KiB
C#
using System;
|
|
using System.Collections.Generic;
|
|
using System.Globalization;
|
|
using System.IO;
|
|
using System.Linq;
|
|
using System.Net;
|
|
using System.Net.Http;
|
|
using System.Reflection;
|
|
using System.Threading;
|
|
using System.Threading.Tasks;
|
|
using Octokit.Caching;
|
|
using Octokit.Internal;
|
|
|
|
namespace Octokit
|
|
{
|
|
// NOTE: Every request method must go through the `RunRequest` code path. So if you need to add a new method
|
|
// ensure it goes through there. :)
|
|
/// <summary>
|
|
/// A connection for making HTTP requests against URI endpoints.
|
|
/// </summary>
|
|
public class Connection : IConnection
|
|
{
|
|
static readonly Uri _defaultGitHubApiUrl = GitHubClient.GitHubApiUrl;
|
|
static readonly ICredentialStore _anonymousCredentials = new InMemoryCredentialStore(Credentials.Anonymous);
|
|
|
|
readonly Authenticator _authenticator;
|
|
readonly JsonHttpPipeline _jsonPipeline;
|
|
internal IHttpClient _httpClient;
|
|
|
|
/// <summary>
|
|
/// Creates a new connection instance used to make requests of the GitHub API.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See more information regarding User-Agent requirements here: https://developer.github.com/v3/#user-agent-required
|
|
/// </remarks>
|
|
/// <param name="productInformation">
|
|
/// The name (and optionally version) of the product using this library, the name of your GitHub organization, or your GitHub username (in that order of preference). This is sent to the server as part of
|
|
/// the user agent for analytics purposes, and used by GitHub to contact you if there are problems.
|
|
/// </param>
|
|
public Connection(ProductHeaderValue productInformation)
|
|
: this(productInformation, _defaultGitHubApiUrl, _anonymousCredentials)
|
|
{
|
|
}
|
|
|
|
/// <summary>
|
|
/// Creates a new connection instance used to make requests of the GitHub API.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See more information regarding User-Agent requirements here: https://developer.github.com/v3/#user-agent-required
|
|
/// </remarks>
|
|
/// <param name="productInformation">
|
|
/// The name (and optionally version) of the product using this library, the name of your GitHub organization, or your GitHub username (in that order of preference). This is sent to the server as part of
|
|
/// the user agent for analytics purposes, and used by GitHub to contact you if there are problems.
|
|
/// </param>
|
|
/// <param name="httpClient">
|
|
/// The client to use for executing requests
|
|
/// </param>
|
|
public Connection(ProductHeaderValue productInformation, IHttpClient httpClient)
|
|
: this(productInformation, _defaultGitHubApiUrl, _anonymousCredentials, httpClient, new SimpleJsonSerializer())
|
|
{
|
|
}
|
|
|
|
/// <summary>
|
|
/// Creates a new connection instance used to make requests of the GitHub API.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See more information regarding User-Agent requirements here: https://developer.github.com/v3/#user-agent-required
|
|
/// </remarks>
|
|
/// <param name="productInformation">
|
|
/// The name (and optionally version) of the product using this library, the name of your GitHub organization, or your GitHub username (in that order of preference). This is sent to the server as part of
|
|
/// the user agent for analytics purposes, and used by GitHub to contact you if there are problems.
|
|
/// </param>
|
|
/// <param name="baseAddress">
|
|
/// The address to point this client to such as https://api.github.com or the URL to a GitHub Enterprise
|
|
/// instance</param>
|
|
public Connection(ProductHeaderValue productInformation, Uri baseAddress)
|
|
: this(productInformation, baseAddress, _anonymousCredentials)
|
|
{
|
|
}
|
|
|
|
/// <summary>
|
|
/// Creates a new connection instance used to make requests of the GitHub API.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See more information regarding User-Agent requirements here: https://developer.github.com/v3/#user-agent-required
|
|
/// </remarks>
|
|
/// <param name="productInformation">
|
|
/// The name (and optionally version) of the product using this library, the name of your GitHub organization, or your GitHub username (in that order of preference). This is sent to the server as part of
|
|
/// the user agent for analytics purposes, and used by GitHub to contact you if there are problems.
|
|
/// </param>
|
|
/// <param name="credentialStore">Provides credentials to the client when making requests</param>
|
|
public Connection(ProductHeaderValue productInformation, ICredentialStore credentialStore)
|
|
: this(productInformation, _defaultGitHubApiUrl, credentialStore)
|
|
{
|
|
}
|
|
|
|
/// <summary>
|
|
/// Creates a new connection instance used to make requests of the GitHub API.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See more information regarding User-Agent requirements here: https://developer.github.com/v3/#user-agent-required
|
|
/// </remarks>
|
|
/// <param name="productInformation">
|
|
/// The name (and optionally version) of the product using this library, the name of your GitHub organization, or your GitHub username (in that order of preference). This is sent to the server as part of
|
|
/// the user agent for analytics purposes, and used by GitHub to contact you if there are problems.
|
|
/// </param>
|
|
/// <param name="baseAddress">
|
|
/// The address to point this client to such as https://api.github.com or the URL to a GitHub Enterprise
|
|
/// instance</param>
|
|
/// <param name="credentialStore">Provides credentials to the client when making requests</param>
|
|
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Reliability", "CA2000:Dispose objects before losing scope")]
|
|
public Connection(ProductHeaderValue productInformation, Uri baseAddress, ICredentialStore credentialStore)
|
|
: this(productInformation, baseAddress, credentialStore, new HttpClientAdapter(HttpMessageHandlerFactory.CreateDefault), new SimpleJsonSerializer())
|
|
{
|
|
}
|
|
|
|
/// <summary>
|
|
/// Creates a new connection instance used to make requests of the GitHub API.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See more information regarding User-Agent requirements here: https://developer.github.com/v3/#user-agent-required
|
|
/// </remarks>
|
|
/// <param name="productInformation">
|
|
/// The name (and optionally version) of the product using this library, the name of your GitHub organization, or your GitHub username (in that order of preference). This is sent to the server as part of
|
|
/// the user agent for analytics purposes, and used by GitHub to contact you if there are problems.
|
|
/// </param>
|
|
/// <param name="baseAddress">
|
|
/// The address to point this client to such as https://api.github.com or the URL to a GitHub Enterprise
|
|
/// instance</param>
|
|
/// <param name="credentialStore">Provides credentials to the client when making requests</param>
|
|
/// <param name="httpClient">A raw <see cref="IHttpClient"/> used to make requests</param>
|
|
/// <param name="serializer">Class used to serialize and deserialize JSON requests</param>
|
|
public Connection(
|
|
ProductHeaderValue productInformation,
|
|
Uri baseAddress,
|
|
ICredentialStore credentialStore,
|
|
IHttpClient httpClient,
|
|
IJsonSerializer serializer)
|
|
{
|
|
Ensure.ArgumentNotNull(productInformation, nameof(productInformation));
|
|
Ensure.ArgumentNotNull(baseAddress, nameof(baseAddress));
|
|
Ensure.ArgumentNotNull(credentialStore, nameof(credentialStore));
|
|
Ensure.ArgumentNotNull(httpClient, nameof(httpClient));
|
|
Ensure.ArgumentNotNull(serializer, nameof(serializer));
|
|
|
|
if (!baseAddress.IsAbsoluteUri)
|
|
{
|
|
throw new ArgumentException(
|
|
string.Format(CultureInfo.InvariantCulture, "The base address '{0}' must be an absolute URI",
|
|
baseAddress), nameof(baseAddress));
|
|
}
|
|
|
|
UserAgent = FormatUserAgent(productInformation);
|
|
BaseAddress = baseAddress;
|
|
_authenticator = new Authenticator(credentialStore);
|
|
_httpClient = httpClient;
|
|
_jsonPipeline = new JsonHttpPipeline(serializer);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets the latest API Info - this will be null if no API calls have been made
|
|
/// </summary>
|
|
/// <returns><seealso cref="ApiInfo"/> representing the information returned as part of an Api call</returns>
|
|
public ApiInfo GetLastApiInfo()
|
|
{
|
|
// We've chosen to not wrap the _lastApiInfo in a lock. Originally the code was returning a reference - so there was a danger of
|
|
// on thread writing to the object while another was reading. Now we are cloning the ApiInfo on request - thus removing the need (or overhead)
|
|
// of putting locks in place.
|
|
// See https://github.com/octokit/octokit.net/pull/855#discussion_r36774884
|
|
return _lastApiInfo == null ? null : _lastApiInfo.Clone();
|
|
}
|
|
private ApiInfo _lastApiInfo;
|
|
|
|
public Task<IApiResponse<T>> Get<T>(Uri uri, IDictionary<string, string> parameters)
|
|
{
|
|
Ensure.ArgumentNotNull(uri, nameof(uri));
|
|
|
|
return SendData<T>(uri.ApplyParameters(parameters), HttpMethod.Get, null, null, null, CancellationToken.None);
|
|
}
|
|
|
|
public Task<IApiResponse<T>> Get<T>(Uri uri, IDictionary<string, string> parameters, string accepts)
|
|
{
|
|
Ensure.ArgumentNotNull(uri, nameof(uri));
|
|
|
|
return SendData<T>(uri.ApplyParameters(parameters), HttpMethod.Get, null, accepts, null, CancellationToken.None);
|
|
}
|
|
|
|
public Task<IApiResponse<T>> Get<T>(Uri uri, IDictionary<string, string> parameters, string accepts, CancellationToken cancellationToken)
|
|
{
|
|
Ensure.ArgumentNotNull(uri, nameof(uri));
|
|
|
|
return SendData<T>(uri.ApplyParameters(parameters), HttpMethod.Get, null, accepts, null, cancellationToken);
|
|
}
|
|
|
|
public Task<IApiResponse<T>> Get<T>(Uri uri, IDictionary<string, string> parameters, string accepts, CancellationToken cancellationToken, Func<object, object> preprocessResponseBody)
|
|
{
|
|
Ensure.ArgumentNotNull(uri, nameof(uri));
|
|
|
|
return SendData<T>(uri.ApplyParameters(parameters), HttpMethod.Get, null, accepts, null, cancellationToken, null, null, preprocessResponseBody);
|
|
}
|
|
|
|
public Task<IApiResponse<T>> Get<T>(Uri uri, TimeSpan timeout)
|
|
{
|
|
Ensure.ArgumentNotNull(uri, nameof(uri));
|
|
|
|
return SendData<T>(uri, HttpMethod.Get, null, null, null, timeout, CancellationToken.None);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Performs an asynchronous HTTP GET request that expects a <seealso cref="IResponse"/> containing HTML.
|
|
/// </summary>
|
|
/// <param name="uri">URI endpoint to send request to</param>
|
|
/// <param name="parameters">Querystring parameters for the request</param>
|
|
/// <returns><seealso cref="IResponse"/> representing the received HTTP response</returns>
|
|
public Task<IApiResponse<string>> GetHtml(Uri uri, IDictionary<string, string> parameters)
|
|
{
|
|
Ensure.ArgumentNotNull(uri, nameof(uri));
|
|
|
|
return GetHtml(new Request
|
|
{
|
|
Method = HttpMethod.Get,
|
|
BaseAddress = BaseAddress,
|
|
Endpoint = uri.ApplyParameters(parameters)
|
|
});
|
|
}
|
|
|
|
/// <summary>
|
|
/// Performs an asynchronous HTTP GET request that expects a <seealso cref="IResponse"/> containing raw data.
|
|
/// </summary>
|
|
/// <param name="uri">URI endpoint to send request to</param>
|
|
/// <param name="parameters">Querystring parameters for the request</param>
|
|
/// <returns><seealso cref="IResponse"/> representing the received HTTP response</returns>
|
|
/// <remarks>The <see cref="IResponse.Body"/> property will be <c>null</c> if the <paramref name="uri"/> points to a directory instead of a file</remarks>
|
|
public Task<IApiResponse<byte[]>> GetRaw(Uri uri, IDictionary<string, string> parameters)
|
|
{
|
|
Ensure.ArgumentNotNull(uri, nameof(uri));
|
|
|
|
return GetRaw(new Request
|
|
{
|
|
Method = HttpMethod.Get,
|
|
BaseAddress = BaseAddress,
|
|
Endpoint = uri.ApplyParameters(parameters)
|
|
});
|
|
}
|
|
|
|
/// <inheritdoc/>
|
|
public Task<IApiResponse<byte[]>> GetRaw(Uri uri, IDictionary<string, string> parameters, TimeSpan timeout)
|
|
{
|
|
Ensure.ArgumentNotNull(uri, nameof(uri));
|
|
|
|
return GetRaw(new Request
|
|
{
|
|
Method = HttpMethod.Get,
|
|
BaseAddress = BaseAddress,
|
|
Endpoint = uri.ApplyParameters(parameters),
|
|
Timeout = timeout
|
|
});
|
|
}
|
|
|
|
/// <inheritdoc/>
|
|
public Task<IApiResponse<Stream>> GetRawStream(Uri uri, IDictionary<string, string> parameters)
|
|
{
|
|
Ensure.ArgumentNotNull(uri, nameof(uri));
|
|
|
|
return GetRawStream(new Request
|
|
{
|
|
Method = HttpMethod.Get,
|
|
BaseAddress = BaseAddress,
|
|
Endpoint = uri.ApplyParameters(parameters)
|
|
});
|
|
}
|
|
|
|
public Task<IApiResponse<T>> Patch<T>(Uri uri, object body)
|
|
{
|
|
Ensure.ArgumentNotNull(uri, nameof(uri));
|
|
Ensure.ArgumentNotNull(body, nameof(body));
|
|
|
|
return SendData<T>(uri, HttpVerb.Patch, body, null, null, CancellationToken.None);
|
|
}
|
|
|
|
public Task<IApiResponse<T>> Patch<T>(Uri uri, object body, string accepts)
|
|
{
|
|
Ensure.ArgumentNotNull(uri, nameof(uri));
|
|
Ensure.ArgumentNotNull(body, nameof(body));
|
|
Ensure.ArgumentNotNull(accepts, nameof(accepts));
|
|
|
|
return SendData<T>(uri, HttpVerb.Patch, body, accepts, null, CancellationToken.None);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Performs an asynchronous HTTP POST request.
|
|
/// </summary>
|
|
/// <param name="uri">URI endpoint to send request to</param>
|
|
/// <param name="cancellationToken">An optional token to monitor for cancellation requests</param>
|
|
/// <returns><seealso cref="IResponse"/> representing the received HTTP response</returns>
|
|
public async Task<HttpStatusCode> Post(Uri uri, CancellationToken cancellationToken = default)
|
|
{
|
|
Ensure.ArgumentNotNull(uri, nameof(uri));
|
|
|
|
var response = await SendData<object>(uri, HttpMethod.Post, null, null, null, cancellationToken).ConfigureAwait(false);
|
|
return response.HttpResponse.StatusCode;
|
|
}
|
|
|
|
public async Task<HttpStatusCode> Post(Uri uri, object body, string accepts, CancellationToken cancellationToken = default)
|
|
{
|
|
Ensure.ArgumentNotNull(uri, nameof(uri));
|
|
|
|
var response = await SendData<object>(uri, HttpMethod.Post, body, accepts, null, cancellationToken).ConfigureAwait(false);
|
|
return response.HttpResponse.StatusCode;
|
|
}
|
|
|
|
public Task<IApiResponse<T>> Post<T>(Uri uri, CancellationToken cancellationToken = default)
|
|
{
|
|
Ensure.ArgumentNotNull(uri, nameof(uri));
|
|
|
|
return SendData<T>(uri, HttpMethod.Post, null, null, null, cancellationToken);
|
|
}
|
|
|
|
public Task<IApiResponse<T>> Post<T>(Uri uri, object body, string accepts, string contentType, CancellationToken cancellationToken = default)
|
|
{
|
|
Ensure.ArgumentNotNull(uri, nameof(uri));
|
|
Ensure.ArgumentNotNull(body, nameof(body));
|
|
|
|
return SendData<T>(uri, HttpMethod.Post, body, accepts, contentType, cancellationToken);
|
|
}
|
|
|
|
public Task<IApiResponse<T>> Post<T>(
|
|
Uri uri,
|
|
object body,
|
|
string accepts,
|
|
string contentType,
|
|
IDictionary<string, string> parameters,
|
|
CancellationToken cancellationToken = default)
|
|
{
|
|
Ensure.ArgumentNotNull(uri, nameof(uri));
|
|
Ensure.ArgumentNotNull(body, nameof(body));
|
|
|
|
return SendData<T>(uri.ApplyParameters(parameters), HttpMethod.Post, body, accepts, contentType, cancellationToken);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Performs an asynchronous HTTP POST request.
|
|
/// Attempts to map the response body to an object of type <typeparamref name="T"/>
|
|
/// </summary>
|
|
/// <typeparam name="T">The type to map the response to</typeparam>
|
|
/// <param name="uri">URI endpoint to send request to</param>
|
|
/// <param name="body">The object to serialize as the body of the request</param>
|
|
/// <param name="accepts">Specifies accepted response media types.</param>
|
|
/// <param name="contentType">Specifies the media type of the request body</param>
|
|
/// <param name="twoFactorAuthenticationCode">Two Factor Authentication Code</param>
|
|
/// <param name="cancellationToken">An optional token to monitor for cancellation requests</param>
|
|
/// <returns><seealso cref="IResponse"/> representing the received HTTP response</returns>
|
|
public Task<IApiResponse<T>> Post<T>(
|
|
Uri uri,
|
|
object body,
|
|
string accepts,
|
|
string contentType,
|
|
string twoFactorAuthenticationCode,
|
|
CancellationToken cancellationToken = default)
|
|
{
|
|
Ensure.ArgumentNotNull(uri, nameof(uri));
|
|
Ensure.ArgumentNotNull(body, nameof(body));
|
|
Ensure.ArgumentNotNullOrEmptyString(twoFactorAuthenticationCode, nameof(twoFactorAuthenticationCode));
|
|
|
|
return SendData<T>(uri, HttpMethod.Post, body, accepts, contentType, cancellationToken, twoFactorAuthenticationCode);
|
|
}
|
|
|
|
public Task<IApiResponse<T>> Post<T>(Uri uri, object body, string accepts, string contentType, TimeSpan timeout, CancellationToken cancellationToken = default)
|
|
{
|
|
Ensure.ArgumentNotNull(uri, nameof(uri));
|
|
Ensure.ArgumentNotNull(body, nameof(body));
|
|
|
|
return SendData<T>(uri, HttpMethod.Post, body, accepts, contentType, timeout, cancellationToken);
|
|
}
|
|
|
|
public Task<IApiResponse<T>> Post<T>(Uri uri, object body, string accepts, string contentType, Uri baseAddress, CancellationToken cancellationToken = default)
|
|
{
|
|
Ensure.ArgumentNotNull(uri, nameof(uri));
|
|
Ensure.ArgumentNotNull(body, nameof(body));
|
|
|
|
return SendData<T>(uri, HttpMethod.Post, body, accepts, contentType, cancellationToken, baseAddress: baseAddress);
|
|
}
|
|
|
|
public Task<IApiResponse<T>> Put<T>(Uri uri, object body)
|
|
{
|
|
return SendData<T>(uri, HttpMethod.Put, body, null, null, CancellationToken.None);
|
|
}
|
|
|
|
public Task<IApiResponse<T>> Put<T>(Uri uri, object body, string twoFactorAuthenticationCode)
|
|
{
|
|
return SendData<T>(uri,
|
|
HttpMethod.Put,
|
|
body,
|
|
null,
|
|
null,
|
|
CancellationToken.None,
|
|
twoFactorAuthenticationCode);
|
|
}
|
|
|
|
public Task<IApiResponse<T>> Put<T>(Uri uri, object body, string twoFactorAuthenticationCode, string accepts)
|
|
{
|
|
return SendData<T>(uri,
|
|
HttpMethod.Put,
|
|
body,
|
|
accepts,
|
|
null,
|
|
CancellationToken.None,
|
|
twoFactorAuthenticationCode);
|
|
}
|
|
|
|
Task<IApiResponse<T>> SendData<T>(
|
|
Uri uri,
|
|
HttpMethod method,
|
|
object body,
|
|
string accepts,
|
|
string contentType,
|
|
TimeSpan timeout,
|
|
CancellationToken cancellationToken,
|
|
string twoFactorAuthenticationCode = null,
|
|
Uri baseAddress = null,
|
|
Func<object, object> preprocessResponseBody = null)
|
|
{
|
|
Ensure.ArgumentNotNull(uri, nameof(uri));
|
|
Ensure.GreaterThanZero(timeout, nameof(timeout));
|
|
|
|
var request = new Request
|
|
{
|
|
Method = method,
|
|
BaseAddress = baseAddress ?? BaseAddress,
|
|
Endpoint = uri,
|
|
Timeout = timeout
|
|
};
|
|
|
|
return SendDataInternal<T>(body, accepts, contentType, cancellationToken, twoFactorAuthenticationCode, request, preprocessResponseBody);
|
|
}
|
|
|
|
Task<IApiResponse<T>> SendData<T>(
|
|
Uri uri,
|
|
HttpMethod method,
|
|
object body,
|
|
string accepts,
|
|
string contentType,
|
|
CancellationToken cancellationToken,
|
|
string twoFactorAuthenticationCode = null,
|
|
Uri baseAddress = null,
|
|
Func<object, object> preprocessResponseBody = null)
|
|
{
|
|
Ensure.ArgumentNotNull(uri, nameof(uri));
|
|
|
|
var request = new Request
|
|
{
|
|
Method = method,
|
|
BaseAddress = baseAddress ?? BaseAddress,
|
|
Endpoint = uri
|
|
};
|
|
|
|
return SendDataInternal<T>(body, accepts, contentType, cancellationToken, twoFactorAuthenticationCode, request, preprocessResponseBody);
|
|
}
|
|
|
|
Task<IApiResponse<T>> SendDataInternal<T>(object body, string accepts, string contentType, CancellationToken cancellationToken, string twoFactorAuthenticationCode, Request request, Func<object, object> preprocessResponseBody)
|
|
{
|
|
if (!string.IsNullOrEmpty(accepts))
|
|
{
|
|
request.Headers["Accept"] = accepts;
|
|
}
|
|
|
|
if (!string.IsNullOrEmpty(twoFactorAuthenticationCode))
|
|
{
|
|
request.Headers["X-GitHub-OTP"] = twoFactorAuthenticationCode;
|
|
}
|
|
|
|
if (body != null)
|
|
{
|
|
request.Body = body;
|
|
// Default Content Type per: http://developer.github.com/v3/
|
|
request.ContentType = contentType ?? "application/x-www-form-urlencoded";
|
|
}
|
|
|
|
return Run<T>(request, cancellationToken, preprocessResponseBody);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Performs an asynchronous HTTP PATCH request.
|
|
/// </summary>
|
|
/// <param name="uri">URI endpoint to send request to</param>
|
|
/// <returns><seealso cref="IResponse"/> representing the received HTTP response</returns>
|
|
public async Task<HttpStatusCode> Patch(Uri uri)
|
|
{
|
|
Ensure.ArgumentNotNull(uri, nameof(uri));
|
|
|
|
var request = new Request
|
|
{
|
|
Method = HttpVerb.Patch,
|
|
BaseAddress = BaseAddress,
|
|
Endpoint = uri
|
|
};
|
|
var response = await Run<object>(request, CancellationToken.None).ConfigureAwait(false);
|
|
return response.HttpResponse.StatusCode;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Performs an asynchronous HTTP PATCH request.
|
|
/// </summary>
|
|
/// <param name="uri">URI endpoint to send request to</param>
|
|
/// <param name="body">The object to serialize as the body of the request</param>
|
|
/// <returns><seealso cref="IResponse"/> representing the received HTTP response</returns>
|
|
public async Task<HttpStatusCode> Patch(Uri uri, object body)
|
|
{
|
|
Ensure.ArgumentNotNull(uri, nameof(uri));
|
|
Ensure.ArgumentNotNull(body, nameof(body));
|
|
|
|
var response = await SendData<object>(uri, new HttpMethod("PATCH"), body, null, null, CancellationToken.None).ConfigureAwait(false);
|
|
return response.HttpResponse.StatusCode;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Performs an asynchronous HTTP PATCH request.
|
|
/// </summary>
|
|
/// <param name="uri">URI endpoint to send request to</param>
|
|
/// <param name="accepts">Specifies accept response media type</param>
|
|
/// <returns><seealso cref="IResponse"/> representing the received HTTP response</returns>
|
|
public async Task<HttpStatusCode> Patch(Uri uri, string accepts)
|
|
{
|
|
Ensure.ArgumentNotNull(uri, nameof(uri));
|
|
Ensure.ArgumentNotNull(accepts, nameof(accepts));
|
|
|
|
var response = await SendData<object>(uri, new HttpMethod("PATCH"), null, accepts, null, CancellationToken.None).ConfigureAwait(false);
|
|
return response.HttpResponse.StatusCode;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Performs an asynchronous HTTP PATCH request.
|
|
/// </summary>
|
|
/// <param name="uri">URI endpoint to send request to</param>
|
|
/// <param name="body">The object to serialize as the body of the request</param>
|
|
/// <param name="accepts">Specifies accept response media type</param>
|
|
/// <returns><seealso cref="IResponse"/> representing the received HTTP response</returns>
|
|
public async Task<HttpStatusCode> Patch(Uri uri, object body, string accepts)
|
|
{
|
|
Ensure.ArgumentNotNull(uri, nameof(uri));
|
|
Ensure.ArgumentNotNull(body, nameof(body));
|
|
Ensure.ArgumentNotNull(accepts, nameof(accepts));
|
|
|
|
var response = await SendData<object>(uri, new HttpMethod("PATCH"), body, accepts, null, CancellationToken.None).ConfigureAwait(false);
|
|
return response.HttpResponse.StatusCode;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Performs an asynchronous HTTP PUT request that expects an empty response.
|
|
/// </summary>
|
|
/// <param name="uri">URI endpoint to send request to</param>
|
|
/// <returns>The returned <seealso cref="HttpStatusCode"/></returns>
|
|
public async Task<HttpStatusCode> Put(Uri uri)
|
|
{
|
|
Ensure.ArgumentNotNull(uri, nameof(uri));
|
|
|
|
var request = new Request
|
|
{
|
|
Method = HttpMethod.Put,
|
|
BaseAddress = BaseAddress,
|
|
Endpoint = uri
|
|
};
|
|
var response = await Run<object>(request, CancellationToken.None).ConfigureAwait(false);
|
|
return response.HttpResponse.StatusCode;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Performs an asynchronous HTTP PUT request that expects an empty response.
|
|
/// </summary>
|
|
/// <param name="uri">URI endpoint to send request to</param>
|
|
/// <param name="body">The object to serialize as the body of the request</param>
|
|
/// <returns>The returned <seealso cref="HttpStatusCode"/></returns>
|
|
public async Task<HttpStatusCode> Put(Uri uri, object body)
|
|
{
|
|
Ensure.ArgumentNotNull(uri, nameof(uri));
|
|
Ensure.ArgumentNotNull(body, nameof(body));
|
|
|
|
var response = await SendData<object>(uri, HttpMethod.Put, body, null, null, CancellationToken.None).ConfigureAwait(false);
|
|
return response.HttpResponse.StatusCode;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Performs an asynchronous HTTP DELETE request that expects an empty response.
|
|
/// </summary>
|
|
/// <param name="uri">URI endpoint to send request to</param>
|
|
/// <returns>The returned <seealso cref="HttpStatusCode"/></returns>
|
|
public async Task<HttpStatusCode> Delete(Uri uri)
|
|
{
|
|
Ensure.ArgumentNotNull(uri, nameof(uri));
|
|
|
|
var request = new Request
|
|
{
|
|
Method = HttpMethod.Delete,
|
|
BaseAddress = BaseAddress,
|
|
Endpoint = uri
|
|
};
|
|
var response = await Run<object>(request, CancellationToken.None).ConfigureAwait(false);
|
|
return response.HttpResponse.StatusCode;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Performs an asynchronous HTTP DELETE request that expects an empty response.
|
|
/// </summary>
|
|
/// <param name="uri">URI endpoint to send request to</param>
|
|
/// <param name="twoFactorAuthenticationCode">Two Factor Code</param>
|
|
/// <returns>The returned <seealso cref="HttpStatusCode"/></returns>
|
|
public async Task<HttpStatusCode> Delete(Uri uri, string twoFactorAuthenticationCode)
|
|
{
|
|
Ensure.ArgumentNotNull(uri, nameof(uri));
|
|
|
|
var response = await SendData<object>(uri, HttpMethod.Delete, null, null, null, CancellationToken.None, twoFactorAuthenticationCode).ConfigureAwait(false);
|
|
return response.HttpResponse.StatusCode;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Performs an asynchronous HTTP DELETE request that expects an empty response.
|
|
/// </summary>
|
|
/// <param name="uri">URI endpoint to send request to</param>
|
|
/// <param name="data">The object to serialize as the body of the request</param>
|
|
/// <returns>The returned <seealso cref="HttpStatusCode"/></returns>
|
|
public async Task<HttpStatusCode> Delete(Uri uri, object data)
|
|
{
|
|
Ensure.ArgumentNotNull(uri, nameof(uri));
|
|
Ensure.ArgumentNotNull(data, nameof(data));
|
|
|
|
var request = new Request
|
|
{
|
|
Method = HttpMethod.Delete,
|
|
Body = data,
|
|
BaseAddress = BaseAddress,
|
|
Endpoint = uri
|
|
};
|
|
var response = await Run<object>(request, CancellationToken.None).ConfigureAwait(false);
|
|
return response.HttpResponse.StatusCode;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Performs an asynchronous HTTP DELETE request that expects an empty response.
|
|
/// </summary>
|
|
/// <param name="uri">URI endpoint to send request to</param>
|
|
/// <param name="data">The object to serialize as the body of the request</param>
|
|
/// <param name="accepts">Specifies accept response media type</param>
|
|
/// <returns>The returned <seealso cref="HttpStatusCode"/></returns>
|
|
public async Task<HttpStatusCode> Delete(Uri uri, object data, string accepts)
|
|
{
|
|
Ensure.ArgumentNotNull(uri, nameof(uri));
|
|
Ensure.ArgumentNotNull(accepts, nameof(accepts));
|
|
|
|
var response = await SendData<object>(uri, HttpMethod.Delete, data, accepts, null, CancellationToken.None).ConfigureAwait(false);
|
|
return response.HttpResponse.StatusCode;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Performs an asynchronous HTTP DELETE request.
|
|
/// </summary>
|
|
/// <typeparam name="T">The API resource's type.</typeparam>
|
|
/// <param name="uri">URI endpoint to send request to</param>
|
|
/// <param name="data">The object to serialize as the body of the request</param>
|
|
public Task<IApiResponse<T>> Delete<T>(Uri uri, object data)
|
|
{
|
|
Ensure.ArgumentNotNull(uri, nameof(uri));
|
|
Ensure.ArgumentNotNull(data, nameof(data));
|
|
|
|
return SendData<T>(uri, HttpMethod.Delete, data, null, null, CancellationToken.None);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Performs an asynchronous HTTP DELETE request.
|
|
/// Attempts to map the response body to an object of type <typeparamref name="T"/>
|
|
/// </summary>
|
|
/// <typeparam name="T">The type to map the response to</typeparam>
|
|
/// <param name="uri">URI endpoint to send request to</param>
|
|
/// <param name="data">The object to serialize as the body of the request</param>
|
|
/// <param name="accepts">Specifies accept response media type</param>
|
|
public Task<IApiResponse<T>> Delete<T>(Uri uri, object data, string accepts)
|
|
{
|
|
Ensure.ArgumentNotNull(uri, nameof(uri));
|
|
Ensure.ArgumentNotNull(accepts, nameof(accepts));
|
|
|
|
return SendData<T>(uri, HttpMethod.Delete, data, accepts, null, CancellationToken.None);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Base address for the connection.
|
|
/// </summary>
|
|
public Uri BaseAddress { get; private set; }
|
|
|
|
public string UserAgent { get; private set; }
|
|
|
|
/// <summary>
|
|
/// Gets the <seealso cref="ICredentialStore"/> used to provide credentials for the connection.
|
|
/// </summary>
|
|
public ICredentialStore CredentialStore
|
|
{
|
|
get { return _authenticator.CredentialStore; }
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets or sets the credentials used by the connection.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// You can use this property if you only have a single hard-coded credential. Otherwise, pass in an
|
|
/// <see cref="ICredentialStore"/> to the constructor.
|
|
/// Setting this property will change the <see cref="ICredentialStore"/> to use
|
|
/// the default <see cref="InMemoryCredentialStore"/> with just these credentials.
|
|
/// </remarks>
|
|
public Credentials Credentials
|
|
{
|
|
get
|
|
{
|
|
var credentialTask = CredentialStore.GetCredentials();
|
|
if (credentialTask == null) return Credentials.Anonymous;
|
|
return credentialTask.Result ?? Credentials.Anonymous;
|
|
}
|
|
// Note this is for convenience. We probably shouldn't allow this to be mutable.
|
|
set
|
|
{
|
|
Ensure.ArgumentNotNull(value, nameof(value));
|
|
_authenticator.CredentialStore = new InMemoryCredentialStore(value);
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Sets response cache used by the connection.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Setting this property will wrap existing <see cref="IHttpClient"/> in <see cref="CachingHttpClient"/>.
|
|
/// </remarks>
|
|
public IResponseCache ResponseCache
|
|
{
|
|
set
|
|
{
|
|
Ensure.ArgumentNotNull(value, nameof(value));
|
|
_httpClient = new CachingHttpClient(_httpClient, value);
|
|
}
|
|
}
|
|
|
|
async Task<IApiResponse<string>> GetHtml(IRequest request)
|
|
{
|
|
request.Headers.Add("Accept", AcceptHeaders.StableVersionHtml);
|
|
var response = await RunRequest(request, CancellationToken.None).ConfigureAwait(false);
|
|
return new ApiResponse<string>(response, response.Body as string);
|
|
}
|
|
|
|
async Task<IApiResponse<byte[]>> GetRaw(IRequest request)
|
|
{
|
|
request.Headers.Add("Accept", AcceptHeaders.RawContentMediaType);
|
|
var response = await RunRequest(request, CancellationToken.None).ConfigureAwait(false);
|
|
|
|
if (response.Body is Stream stream)
|
|
{
|
|
return new ApiResponse<byte[]>(response, await StreamToByteArray(stream));
|
|
}
|
|
|
|
return new ApiResponse<byte[]>(response, response.Body as byte[]);
|
|
}
|
|
|
|
async Task<IApiResponse<Stream>> GetRawStream(IRequest request)
|
|
{
|
|
request.Headers.Add("Accept", AcceptHeaders.RawContentMediaType);
|
|
var response = await RunRequest(request, CancellationToken.None).ConfigureAwait(false);
|
|
|
|
return new ApiResponse<Stream>(response, response.Body as Stream);
|
|
}
|
|
|
|
async Task<byte[]> StreamToByteArray(Stream stream)
|
|
{
|
|
if (stream is MemoryStream memoryStream)
|
|
{
|
|
return memoryStream.ToArray();
|
|
}
|
|
|
|
using (var ms = new MemoryStream())
|
|
{
|
|
await stream.CopyToAsync(ms);
|
|
return ms.ToArray();
|
|
}
|
|
}
|
|
|
|
async Task<IApiResponse<T>> Run<T>(IRequest request, CancellationToken cancellationToken, Func<object, object> preprocessResponseBody = null)
|
|
{
|
|
_jsonPipeline.SerializeRequest(request);
|
|
var response = await RunRequest(request, cancellationToken, preprocessResponseBody).ConfigureAwait(false);
|
|
return _jsonPipeline.DeserializeResponse<T>(response);
|
|
}
|
|
|
|
// THIS IS THE METHOD THAT EVERY REQUEST MUST GO THROUGH!
|
|
async Task<IResponse> RunRequest(IRequest request, CancellationToken cancellationToken, Func<object, object> preprocessResponseBody = null)
|
|
{
|
|
request.Headers.Add("User-Agent", UserAgent);
|
|
await _authenticator.Apply(request).ConfigureAwait(false);
|
|
var response = await _httpClient.Send(request, cancellationToken, preprocessResponseBody).ConfigureAwait(false);
|
|
if (response != null)
|
|
{
|
|
// Use the clone method to avoid keeping hold of the original (just in case it effect the lifetime of the whole response
|
|
_lastApiInfo = response.ApiInfo.Clone();
|
|
}
|
|
HandleErrors(response);
|
|
return response;
|
|
}
|
|
|
|
static readonly Dictionary<HttpStatusCode, Func<IResponse, Exception>> _httpExceptionMap =
|
|
new Dictionary<HttpStatusCode, Func<IResponse, Exception>>
|
|
{
|
|
{ HttpStatusCode.Unauthorized, GetExceptionForUnauthorized },
|
|
{ HttpStatusCode.Forbidden, GetExceptionForForbidden },
|
|
{ HttpStatusCode.NotFound, response => new NotFoundException(response) },
|
|
{ (HttpStatusCode)422, response => new ApiValidationException(response) },
|
|
{ (HttpStatusCode)451, response => new LegalRestrictionException(response) }
|
|
};
|
|
|
|
static void HandleErrors(IResponse response)
|
|
{
|
|
Func<IResponse, Exception> exceptionFunc;
|
|
if (_httpExceptionMap.TryGetValue(response.StatusCode, out exceptionFunc))
|
|
{
|
|
throw exceptionFunc(response);
|
|
}
|
|
|
|
if ((int)response.StatusCode >= 400)
|
|
{
|
|
throw new ApiException(response);
|
|
}
|
|
}
|
|
|
|
static Exception GetExceptionForUnauthorized(IResponse response)
|
|
{
|
|
var twoFactorType = ParseTwoFactorType(response);
|
|
|
|
return twoFactorType == TwoFactorType.None
|
|
? new AuthorizationException(response)
|
|
: new TwoFactorRequiredException(response, twoFactorType);
|
|
}
|
|
|
|
static Exception GetExceptionForForbidden(IResponse response)
|
|
{
|
|
string body = response.Body as string ?? "";
|
|
|
|
if (body.Contains("rate limit exceeded"))
|
|
{
|
|
return new RateLimitExceededException(response);
|
|
}
|
|
|
|
if (body.Contains("secondary rate limit"))
|
|
{
|
|
return new SecondaryRateLimitExceededException(response);
|
|
}
|
|
|
|
if (body.Contains("number of login attempts exceeded"))
|
|
{
|
|
return new LoginAttemptsExceededException(response);
|
|
}
|
|
|
|
if (body.Contains("abuse-rate-limits") || body.Contains("abuse detection mechanism"))
|
|
{
|
|
return new AbuseException(response);
|
|
}
|
|
|
|
return new ForbiddenException(response);
|
|
}
|
|
|
|
internal static TwoFactorType ParseTwoFactorType(IResponse restResponse)
|
|
{
|
|
if (restResponse == null || restResponse.Headers == null || !restResponse.Headers.Any()) return TwoFactorType.None;
|
|
var otpHeader = restResponse.Headers.FirstOrDefault(header =>
|
|
header.Key.Equals("X-GitHub-OTP", StringComparison.OrdinalIgnoreCase));
|
|
if (string.IsNullOrEmpty(otpHeader.Value)) return TwoFactorType.None;
|
|
var factorType = otpHeader.Value;
|
|
var parts = factorType.Split(new[] { ';' }, StringSplitOptions.RemoveEmptyEntries);
|
|
if (parts.Length > 0 && parts[0] == "required")
|
|
{
|
|
var secondPart = parts.Length > 1 ? parts[1].Trim() : null;
|
|
switch (secondPart)
|
|
{
|
|
case "sms":
|
|
return TwoFactorType.Sms;
|
|
case "app":
|
|
return TwoFactorType.AuthenticatorApp;
|
|
default:
|
|
return TwoFactorType.Unknown;
|
|
}
|
|
}
|
|
return TwoFactorType.None;
|
|
}
|
|
|
|
static string FormatUserAgent(ProductHeaderValue productInformation)
|
|
{
|
|
return string.Format(CultureInfo.InvariantCulture, "{0} ({1}; {2}; Octokit.net {3})",
|
|
productInformation,
|
|
GetPlatformInformation(),
|
|
GetCultureInformation(),
|
|
GetVersionInformation());
|
|
}
|
|
|
|
private static string _platformInformation;
|
|
static string GetPlatformInformation()
|
|
{
|
|
if (string.IsNullOrEmpty(_platformInformation))
|
|
{
|
|
try
|
|
{
|
|
_platformInformation = string.Format(CultureInfo.InvariantCulture,
|
|
"{0} {1}; {2}",
|
|
Environment.OSVersion.Platform,
|
|
Environment.OSVersion.Version.ToString(3),
|
|
Environment.Is64BitOperatingSystem ? "amd64" : "x86"
|
|
);
|
|
}
|
|
catch
|
|
{
|
|
_platformInformation = "Unknown Platform";
|
|
}
|
|
}
|
|
|
|
return _platformInformation;
|
|
}
|
|
|
|
static string GetCultureInformation()
|
|
{
|
|
return CultureInfo.CurrentCulture.Name;
|
|
}
|
|
|
|
private static string _versionInformation;
|
|
static string GetVersionInformation()
|
|
{
|
|
if (string.IsNullOrEmpty(_versionInformation))
|
|
{
|
|
_versionInformation = typeof(IGitHubClient)
|
|
.GetTypeInfo()
|
|
.Assembly
|
|
.GetCustomAttribute<AssemblyInformationalVersionAttribute>()
|
|
.InformationalVersion;
|
|
}
|
|
|
|
return _versionInformation;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Sets the timeout for the connection between the client and the server.
|
|
/// </summary>
|
|
/// <param name="timeout">The Timeout value</param>
|
|
public void SetRequestTimeout(TimeSpan timeout)
|
|
{
|
|
_httpClient.SetRequestTimeout(timeout);
|
|
}
|
|
}
|
|
}
|