using System; using System.Net; using System.Threading.Tasks; using Pathoschild.Http.Client; namespace StardewModdingAPI.Web.Framework.Clients.GitHub { /// An HTTP client for fetching metadata from GitHub. internal class GitHubClient : IGitHubClient { /********* ** Properties *********/ /// The URL for a GitHub releases API query excluding the base URL, where {0} is the repository owner and name. private readonly string ReleaseUrlFormat; /// The underlying HTTP client. private readonly IClient Client; /********* ** Public methods *********/ /// Construct an instance. /// The base URL for the GitHub API. /// The URL for a GitHub releases API query excluding the , where {0} is the repository owner and name. /// The user agent for the API client. /// The Accept header value expected by the GitHub API. /// The username with which to authenticate to the GitHub API. /// The password with which to authenticate to the GitHub API. public GitHubClient(string baseUrl, string releaseUrlFormat, string userAgent, string acceptHeader, string username, string password) { this.ReleaseUrlFormat = releaseUrlFormat; this.Client = new FluentClient(baseUrl) .SetUserAgent(userAgent) .AddDefault(req => req.WithHeader("Accept", acceptHeader)); if (!string.IsNullOrWhiteSpace(username)) this.Client = this.Client.SetBasicAuthentication(username, password); } /// Get the latest release for a GitHub repository. /// The repository key (like Pathoschild/SMAPI). /// Returns the latest release if found, else null. public async Task GetLatestReleaseAsync(string repo) { // validate key format if (!repo.Contains("/") || repo.IndexOf("/", StringComparison.InvariantCultureIgnoreCase) != repo.LastIndexOf("/", StringComparison.InvariantCultureIgnoreCase)) throw new ArgumentException($"The value '{repo}' isn't a valid GitHub repository key, must be a username and project name like 'Pathoschild/SMAPI'.", nameof(repo)); // fetch info try { return await this.Client .GetAsync(string.Format(this.ReleaseUrlFormat, repo)) .As(); } catch (ApiException ex) when (ex.Status == HttpStatusCode.NotFound) { return null; } } /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose() { this.Client?.Dispose(); } } }