From 05541c11a72735d79d98cf3ae14d592e70bd8f54 Mon Sep 17 00:00:00 2001 From: Jesse Plamondon-Willard Date: Sun, 24 Dec 2017 23:28:07 -0500 Subject: decouple API clients from mods API (#411) --- .../Clients/Chucklefish/ChucklefishClient.cs | 83 ++++++++++++++++++++++ .../Clients/Chucklefish/ChucklefishMod.cs | 18 +++++ .../Clients/Chucklefish/IChucklefishClient.cs | 17 +++++ .../Framework/Clients/GitHub/GitHubClient.cs | 70 ++++++++++++++++++ .../Framework/Clients/GitHub/GitRelease.cs | 19 +++++ .../Framework/Clients/GitHub/IGitHubClient.cs | 17 +++++ .../Framework/Clients/Nexus/INexusClient.cs | 17 +++++ .../Framework/Clients/Nexus/NexusClient.cs | 48 +++++++++++++ src/SMAPI.Web/Framework/Clients/Nexus/NexusMod.cs | 21 ++++++ .../Framework/ConfigModels/ApiClientsConfig.cs | 56 +++++++++++++++ .../Framework/ConfigModels/ModUpdateCheckConfig.cs | 49 ------------- .../ModRepositories/ChucklefishRepository.cs | 50 +++---------- .../Framework/ModRepositories/GitHubRepository.cs | 59 +++------------ .../Framework/ModRepositories/NexusRepository.cs | 51 +++---------- 14 files changed, 395 insertions(+), 180 deletions(-) create mode 100644 src/SMAPI.Web/Framework/Clients/Chucklefish/ChucklefishClient.cs create mode 100644 src/SMAPI.Web/Framework/Clients/Chucklefish/ChucklefishMod.cs create mode 100644 src/SMAPI.Web/Framework/Clients/Chucklefish/IChucklefishClient.cs create mode 100644 src/SMAPI.Web/Framework/Clients/GitHub/GitHubClient.cs create mode 100644 src/SMAPI.Web/Framework/Clients/GitHub/GitRelease.cs create mode 100644 src/SMAPI.Web/Framework/Clients/GitHub/IGitHubClient.cs create mode 100644 src/SMAPI.Web/Framework/Clients/Nexus/INexusClient.cs create mode 100644 src/SMAPI.Web/Framework/Clients/Nexus/NexusClient.cs create mode 100644 src/SMAPI.Web/Framework/Clients/Nexus/NexusMod.cs create mode 100644 src/SMAPI.Web/Framework/ConfigModels/ApiClientsConfig.cs (limited to 'src/SMAPI.Web/Framework') diff --git a/src/SMAPI.Web/Framework/Clients/Chucklefish/ChucklefishClient.cs b/src/SMAPI.Web/Framework/Clients/Chucklefish/ChucklefishClient.cs new file mode 100644 index 00000000..6772672c --- /dev/null +++ b/src/SMAPI.Web/Framework/Clients/Chucklefish/ChucklefishClient.cs @@ -0,0 +1,83 @@ +using System; +using System.Net; +using System.Threading.Tasks; +using HtmlAgilityPack; +using Pathoschild.Http.Client; + +namespace StardewModdingAPI.Web.Framework.Clients.Chucklefish +{ + /// An HTTP client for fetching mod metadata from the Chucklefish mod site. + internal class ChucklefishClient : IChucklefishClient + { + /********* + ** Properties + *********/ + /// The base URL for the Chucklefish mod site. + private readonly string BaseUrl; + + /// The URL for a mod page excluding the base URL, where {0} is the mod ID. + private readonly string ModPageUrlFormat; + + /// The underlying HTTP client. + private readonly IClient Client; + + + /********* + ** Public methods + *********/ + /// Construct an instance. + /// The user agent for the API client. + /// The base URL for the Chucklefish mod site. + /// The URL for a mod page excluding the , where {0} is the mod ID. + public ChucklefishClient(string userAgent, string baseUrl, string modPageUrlFormat) + { + this.BaseUrl = baseUrl; + this.ModPageUrlFormat = modPageUrlFormat; + this.Client = new FluentClient(baseUrl).SetUserAgent(userAgent); + } + + /// Get metadata about a mod. + /// The Chucklefish mod ID. + /// Returns the mod info if found, else null. + public async Task GetModAsync(uint id) + { + // fetch HTML + string html; + try + { + html = await this.Client + .GetAsync(string.Format(this.ModPageUrlFormat, id)) + .AsString(); + } + catch (ApiException ex) when (ex.Status == HttpStatusCode.NotFound) + { + return null; + } + + // parse HTML + var doc = new HtmlDocument(); + doc.LoadHtml(html); + + // extract mod info + string url = new UriBuilder(new Uri(this.BaseUrl)) { Path = string.Format(this.ModPageUrlFormat, id) }.Uri.ToString(); + string name = doc.DocumentNode.SelectSingleNode("//meta[@name='twitter:title']").Attributes["content"].Value; + if (name.StartsWith("[SMAPI] ")) + name = name.Substring("[SMAPI] ".Length); + string version = doc.DocumentNode.SelectSingleNode("//h1/span").InnerText; + + // create model + return new ChucklefishMod + { + Name = name, + Version = version, + Url = url + }; + } + + /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + public void Dispose() + { + this.Client?.Dispose(); + } + } +} diff --git a/src/SMAPI.Web/Framework/Clients/Chucklefish/ChucklefishMod.cs b/src/SMAPI.Web/Framework/Clients/Chucklefish/ChucklefishMod.cs new file mode 100644 index 00000000..fd0101d4 --- /dev/null +++ b/src/SMAPI.Web/Framework/Clients/Chucklefish/ChucklefishMod.cs @@ -0,0 +1,18 @@ +namespace StardewModdingAPI.Web.Framework.Clients.Chucklefish +{ + /// Mod metadata from the Chucklefish mod site. + internal class ChucklefishMod + { + /********* + ** Accessors + *********/ + /// The mod name. + public string Name { get; set; } + + /// The mod's semantic version number. + public string Version { get; set; } + + /// The mod's web URL. + public string Url { get; set; } + } +} diff --git a/src/SMAPI.Web/Framework/Clients/Chucklefish/IChucklefishClient.cs b/src/SMAPI.Web/Framework/Clients/Chucklefish/IChucklefishClient.cs new file mode 100644 index 00000000..1d8b256e --- /dev/null +++ b/src/SMAPI.Web/Framework/Clients/Chucklefish/IChucklefishClient.cs @@ -0,0 +1,17 @@ +using System; +using System.Threading.Tasks; + +namespace StardewModdingAPI.Web.Framework.Clients.Chucklefish +{ + /// An HTTP client for fetching mod metadata from the Chucklefish mod site. + internal interface IChucklefishClient : IDisposable + { + /********* + ** Methods + *********/ + /// Get metadata about a mod. + /// The Chucklefish mod ID. + /// Returns the mod info if found, else null. + Task GetModAsync(uint id); + } +} diff --git a/src/SMAPI.Web/Framework/Clients/GitHub/GitHubClient.cs b/src/SMAPI.Web/Framework/Clients/GitHub/GitHubClient.cs new file mode 100644 index 00000000..0b205660 --- /dev/null +++ b/src/SMAPI.Web/Framework/Clients/GitHub/GitHubClient.cs @@ -0,0 +1,70 @@ +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(); + } + } +} diff --git a/src/SMAPI.Web/Framework/Clients/GitHub/GitRelease.cs b/src/SMAPI.Web/Framework/Clients/GitHub/GitRelease.cs new file mode 100644 index 00000000..0a47f3b4 --- /dev/null +++ b/src/SMAPI.Web/Framework/Clients/GitHub/GitRelease.cs @@ -0,0 +1,19 @@ +using Newtonsoft.Json; + +namespace StardewModdingAPI.Web.Framework.Clients.GitHub +{ + /// A GitHub project release. + internal class GitRelease + { + /********* + ** Accessors + *********/ + /// The display name. + [JsonProperty("name")] + public string Name { get; set; } + + /// The semantic version string. + [JsonProperty("tag_name")] + public string Tag { get; set; } + } +} diff --git a/src/SMAPI.Web/Framework/Clients/GitHub/IGitHubClient.cs b/src/SMAPI.Web/Framework/Clients/GitHub/IGitHubClient.cs new file mode 100644 index 00000000..6e8eadff --- /dev/null +++ b/src/SMAPI.Web/Framework/Clients/GitHub/IGitHubClient.cs @@ -0,0 +1,17 @@ +using System; +using System.Threading.Tasks; + +namespace StardewModdingAPI.Web.Framework.Clients.GitHub +{ + /// An HTTP client for fetching metadata from GitHub. + internal interface IGitHubClient : IDisposable + { + /********* + ** Methods + *********/ + /// Get the latest release for a GitHub repository. + /// The repository key (like Pathoschild/SMAPI). + /// Returns the latest release if found, else null. + Task GetLatestReleaseAsync(string repo); + } +} diff --git a/src/SMAPI.Web/Framework/Clients/Nexus/INexusClient.cs b/src/SMAPI.Web/Framework/Clients/Nexus/INexusClient.cs new file mode 100644 index 00000000..e56e7af4 --- /dev/null +++ b/src/SMAPI.Web/Framework/Clients/Nexus/INexusClient.cs @@ -0,0 +1,17 @@ +using System; +using System.Threading.Tasks; + +namespace StardewModdingAPI.Web.Framework.Clients.Nexus +{ + /// An HTTP client for fetching mod metadata from Nexus Mods. + internal interface INexusClient : IDisposable + { + /********* + ** Methods + *********/ + /// Get metadata about a mod. + /// The Nexus mod ID. + /// Returns the mod info if found, else null. + Task GetModAsync(uint id); + } +} diff --git a/src/SMAPI.Web/Framework/Clients/Nexus/NexusClient.cs b/src/SMAPI.Web/Framework/Clients/Nexus/NexusClient.cs new file mode 100644 index 00000000..1a7011e2 --- /dev/null +++ b/src/SMAPI.Web/Framework/Clients/Nexus/NexusClient.cs @@ -0,0 +1,48 @@ +using System.Threading.Tasks; +using Pathoschild.Http.Client; + +namespace StardewModdingAPI.Web.Framework.Clients.Nexus +{ + /// An HTTP client for fetching mod metadata from Nexus Mods. + internal class NexusClient : INexusClient + { + /********* + ** Properties + *********/ + /// The URL for a Nexus Mods API query excluding the base URL, where {0} is the mod ID. + private readonly string ModUrlFormat; + + /// The underlying HTTP client. + private readonly IClient Client; + + + /********* + ** Public methods + *********/ + /// Construct an instance. + /// The user agent for the Nexus Mods API client. + /// The base URL for the Nexus Mods API. + /// The URL for a Nexus Mods API query excluding the , where {0} is the mod ID. + public NexusClient(string userAgent, string baseUrl, string modUrlFormat) + { + this.ModUrlFormat = modUrlFormat; + this.Client = new FluentClient(baseUrl).SetUserAgent(userAgent); + } + + /// Get metadata about a mod. + /// The Nexus mod ID. + /// Returns the mod info if found, else null. + public async Task GetModAsync(uint id) + { + return await this.Client + .GetAsync(string.Format(this.ModUrlFormat, id)) + .As(); + } + + /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + public void Dispose() + { + this.Client?.Dispose(); + } + } +} diff --git a/src/SMAPI.Web/Framework/Clients/Nexus/NexusMod.cs b/src/SMAPI.Web/Framework/Clients/Nexus/NexusMod.cs new file mode 100644 index 00000000..2b04104f --- /dev/null +++ b/src/SMAPI.Web/Framework/Clients/Nexus/NexusMod.cs @@ -0,0 +1,21 @@ +using Newtonsoft.Json; + +namespace StardewModdingAPI.Web.Framework.Clients.Nexus +{ + /// Mod metadata from Nexus Mods. + internal class NexusMod + { + /********* + ** Accessors + *********/ + /// The mod name. + public string Name { get; set; } + + /// The mod's semantic version number. + public string Version { get; set; } + + /// The mod's web URL. + [JsonProperty("mod_page_uri")] + public string Url { get; set; } + } +} diff --git a/src/SMAPI.Web/Framework/ConfigModels/ApiClientsConfig.cs b/src/SMAPI.Web/Framework/ConfigModels/ApiClientsConfig.cs new file mode 100644 index 00000000..19794920 --- /dev/null +++ b/src/SMAPI.Web/Framework/ConfigModels/ApiClientsConfig.cs @@ -0,0 +1,56 @@ +namespace StardewModdingAPI.Web.Framework.ConfigModels +{ + /// The config settings for the API clients. + internal class ApiClientsConfig + { + /********* + ** Accessors + *********/ + /**** + ** Generic + ****/ + /// The user agent for API clients, where {0} is the SMAPI version. + public string UserAgent { get; set; } + + + /**** + ** Chucklefish + ****/ + /// The base URL for the Chucklefish mod site. + public string ChucklefishBaseUrl { get; set; } + + /// The URL for a mod page on the Chucklefish mod site excluding the , where {0} is the mod ID. + public string ChucklefishModPageUrlFormat { get; set; } + + + /**** + ** GitHub + ****/ + /// The base URL for the GitHub API. + public string GitHubBaseUrl { get; set; } + + /// The URL for a GitHub API latest-release query excluding the , where {0} is the organisation and project name. + public string GitHubReleaseUrlFormat { get; set; } + + /// The Accept header value expected by the GitHub API. + public string GitHubAcceptHeader { get; set; } + + /// The username with which to authenticate to the GitHub API (if any). + public string GitHubUsername { get; set; } + + /// The password with which to authenticate to the GitHub API (if any). + public string GitHubPassword { get; set; } + + /**** + ** Nexus Mods + ****/ + /// The user agent for the Nexus Mods API client. + public string NexusUserAgent { get; set; } + + /// The base URL for the Nexus Mods API. + public string NexusBaseUrl { get; set; } + + /// The URL for a Nexus Mods API query excluding the , where {0} is the mod ID. + public string NexusModUrlFormat { get; set; } + } +} diff --git a/src/SMAPI.Web/Framework/ConfigModels/ModUpdateCheckConfig.cs b/src/SMAPI.Web/Framework/ConfigModels/ModUpdateCheckConfig.cs index 2fb5b97e..58c3a100 100644 --- a/src/SMAPI.Web/Framework/ConfigModels/ModUpdateCheckConfig.cs +++ b/src/SMAPI.Web/Framework/ConfigModels/ModUpdateCheckConfig.cs @@ -6,9 +6,6 @@ namespace StardewModdingAPI.Web.Framework.ConfigModels /********* ** Accessors *********/ - /**** - ** General - ****/ /// The number of minutes update checks should be cached before refetching them. public int CacheMinutes { get; set; } @@ -16,59 +13,13 @@ namespace StardewModdingAPI.Web.Framework.ConfigModels /// Derived from SMAPI's SemanticVersion implementation. public string SemanticVersionRegex { get; set; } - /**** - ** Chucklefish mod site - ****/ /// The repository key for the Chucklefish mod site. public string ChucklefishKey { get; set; } - /// The user agent for the Chucklefish API client, where {0} is the SMAPI version. - public string ChucklefishUserAgent { get; set; } - - /// The base URL for the Chucklefish mod site. - public string ChucklefishBaseUrl { get; set; } - - /// The URL for a mod page on the Chucklefish mod site excluding the , where {0} is the mod ID. - public string ChucklefishModPageUrlFormat { get; set; } - - - /**** - ** GitHub - ****/ /// The repository key for Nexus Mods. public string GitHubKey { get; set; } - /// The user agent for the GitHub API client, where {0} is the SMAPI version. - public string GitHubUserAgent { get; set; } - - /// The base URL for the GitHub API. - public string GitHubBaseUrl { get; set; } - - /// The URL for a GitHub API latest-release query excluding the , where {0} is the organisation and project name. - public string GitHubReleaseUrlFormat { get; set; } - - /// The Accept header value expected by the GitHub API. - public string GitHubAcceptHeader { get; set; } - - /// The username with which to authenticate to the GitHub API (if any). - public string GitHubUsername { get; set; } - - /// The password with which to authenticate to the GitHub API (if any). - public string GitHubPassword { get; set; } - - /**** - ** Nexus Mods - ****/ /// The repository key for Nexus Mods. public string NexusKey { get; set; } - - /// The user agent for the Nexus Mods API client. - public string NexusUserAgent { get; set; } - - /// The base URL for the Nexus Mods API. - public string NexusBaseUrl { get; set; } - - /// The URL for a Nexus Mods API query excluding the , where {0} is the mod ID. - public string NexusModUrlFormat { get; set; } } } diff --git a/src/SMAPI.Web/Framework/ModRepositories/ChucklefishRepository.cs b/src/SMAPI.Web/Framework/ModRepositories/ChucklefishRepository.cs index 06ec58ed..266055a6 100644 --- a/src/SMAPI.Web/Framework/ModRepositories/ChucklefishRepository.cs +++ b/src/SMAPI.Web/Framework/ModRepositories/ChucklefishRepository.cs @@ -1,9 +1,7 @@ using System; -using System.Net; using System.Threading.Tasks; -using HtmlAgilityPack; -using Pathoschild.Http.Client; using StardewModdingAPI.Common.Models; +using StardewModdingAPI.Web.Framework.Clients.Chucklefish; namespace StardewModdingAPI.Web.Framework.ModRepositories { @@ -13,14 +11,8 @@ namespace StardewModdingAPI.Web.Framework.ModRepositories /********* ** Properties *********/ - /// The base URL for the Chucklefish mod site. - private readonly string BaseUrl; - - /// The URL for a mod page excluding the base URL, where {0} is the mod ID. - private readonly string ModPageUrlFormat; - /// The underlying HTTP client. - private readonly IClient Client; + private readonly IChucklefishClient Client; /********* @@ -28,15 +20,11 @@ namespace StardewModdingAPI.Web.Framework.ModRepositories *********/ /// Construct an instance. /// The unique key for this vendor. - /// The user agent for the API client. - /// The base URL for the Chucklefish mod site. - /// The URL for a mod page excluding the , where {0} is the mod ID. - public ChucklefishRepository(string vendorKey, string userAgent, string baseUrl, string modPageUrlFormat) + /// The underlying HTTP client. + public ChucklefishRepository(string vendorKey, IChucklefishClient client) : base(vendorKey) { - this.BaseUrl = baseUrl; - this.ModPageUrlFormat = modPageUrlFormat; - this.Client = new FluentClient(baseUrl).SetUserAgent(userAgent); + this.Client = client; } /// Get metadata about a mod in the repository. @@ -44,38 +32,18 @@ namespace StardewModdingAPI.Web.Framework.ModRepositories public override async Task GetModInfoAsync(string id) { // validate ID format - if (!uint.TryParse(id, out uint _)) + if (!uint.TryParse(id, out uint realID)) return new ModInfoModel($"The value '{id}' isn't a valid Chucklefish mod ID, must be an integer ID."); // fetch info try { - // fetch HTML - string html; - try - { - html = await this.Client - .GetAsync(string.Format(this.ModPageUrlFormat, id)) - .AsString(); - } - catch (ApiException ex) when (ex.Status == HttpStatusCode.NotFound) - { + var mod = await this.Client.GetModAsync(realID); + if (mod == null) return new ModInfoModel("Found no mod with this ID."); - } - - // parse HTML - var doc = new HtmlDocument(); - doc.LoadHtml(html); - - // extract mod info - string url = new UriBuilder(new Uri(this.BaseUrl)) { Path = string.Format(this.ModPageUrlFormat, id) }.Uri.ToString(); - string name = doc.DocumentNode.SelectSingleNode("//meta[@name='twitter:title']").Attributes["content"].Value; - if (name.StartsWith("[SMAPI] ")) - name = name.Substring("[SMAPI] ".Length); - string version = doc.DocumentNode.SelectSingleNode("//h1/span").InnerText; // create model - return new ModInfoModel(name, this.NormaliseVersion(version), url); + return new ModInfoModel(mod.Name, this.NormaliseVersion(mod.Version), mod.Url); } catch (Exception ex) { diff --git a/src/SMAPI.Web/Framework/ModRepositories/GitHubRepository.cs b/src/SMAPI.Web/Framework/ModRepositories/GitHubRepository.cs index 9d43adf0..7bad6127 100644 --- a/src/SMAPI.Web/Framework/ModRepositories/GitHubRepository.cs +++ b/src/SMAPI.Web/Framework/ModRepositories/GitHubRepository.cs @@ -1,9 +1,7 @@ using System; -using System.Net; using System.Threading.Tasks; -using Newtonsoft.Json; -using Pathoschild.Http.Client; using StardewModdingAPI.Common.Models; +using StardewModdingAPI.Web.Framework.Clients.GitHub; namespace StardewModdingAPI.Web.Framework.ModRepositories { @@ -13,11 +11,8 @@ namespace StardewModdingAPI.Web.Framework.ModRepositories /********* ** Properties *********/ - /// The URL for a Nexus Mods API query excluding the base URL, where {0} is the mod ID. - private readonly string ReleaseUrlFormat; - - /// The underlying HTTP client. - private readonly IClient Client; + /// The underlying GitHub API client. + private readonly IGitHubClient Client; /********* @@ -25,22 +20,11 @@ namespace StardewModdingAPI.Web.Framework.ModRepositories *********/ /// Construct an instance. /// The unique key for this vendor. - /// The base URL for the Nexus Mods API. - /// The URL for a Nexus Mods API query excluding the , where {0} is the mod ID. - /// 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 GitHubRepository(string vendorKey, string baseUrl, string releaseUrlFormat, string userAgent, string acceptHeader, string username, string password) + /// The underlying GitHub API client. + public GitHubRepository(string vendorKey, IGitHubClient client) : base(vendorKey) { - 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); + this.Client = client; } /// Get metadata about a mod in the repository. @@ -54,14 +38,10 @@ namespace StardewModdingAPI.Web.Framework.ModRepositories // fetch info try { - GitRelease release = await this.Client - .GetAsync(string.Format(this.ReleaseUrlFormat, id)) - .As(); - return new ModInfoModel(id, this.NormaliseVersion(release.Tag), $"https://github.com/{id}/releases"); - } - catch (ApiException ex) when (ex.Status == HttpStatusCode.NotFound) - { - return new ModInfoModel("Found no mod with this ID."); + GitRelease release = await this.Client.GetLatestReleaseAsync(id); + return release != null + ? new ModInfoModel(id, this.NormaliseVersion(release.Tag), $"https://github.com/{id}/releases") + : new ModInfoModel("Found no mod with this ID."); } catch (Exception ex) { @@ -74,24 +54,5 @@ namespace StardewModdingAPI.Web.Framework.ModRepositories { this.Client.Dispose(); } - - - /********* - ** Private models - *********/ - /// Metadata about a GitHub release tag. - private class GitRelease - { - /********* - ** Accessors - *********/ - /// The display name. - [JsonProperty("name")] - public string Name { get; set; } - - /// The semantic version string. - [JsonProperty("tag_name")] - public string Tag { get; set; } - } } } diff --git a/src/SMAPI.Web/Framework/ModRepositories/NexusRepository.cs b/src/SMAPI.Web/Framework/ModRepositories/NexusRepository.cs index 8a4bb0d8..cfa757ab 100644 --- a/src/SMAPI.Web/Framework/ModRepositories/NexusRepository.cs +++ b/src/SMAPI.Web/Framework/ModRepositories/NexusRepository.cs @@ -1,8 +1,7 @@ using System; using System.Threading.Tasks; -using Newtonsoft.Json; -using Pathoschild.Http.Client; using StardewModdingAPI.Common.Models; +using StardewModdingAPI.Web.Framework.Clients.Nexus; namespace StardewModdingAPI.Web.Framework.ModRepositories { @@ -12,11 +11,8 @@ namespace StardewModdingAPI.Web.Framework.ModRepositories /********* ** Properties *********/ - /// The URL for a Nexus Mods API query excluding the base URL, where {0} is the mod ID. - private readonly string ModUrlFormat; - - /// The underlying HTTP client. - private readonly IClient Client; + /// The underlying Nexus Mods API client. + private readonly INexusClient Client; /********* @@ -24,14 +20,11 @@ namespace StardewModdingAPI.Web.Framework.ModRepositories *********/ /// Construct an instance. /// The unique key for this vendor. - /// The user agent for the Nexus Mods API client. - /// The base URL for the Nexus Mods API. - /// The URL for a Nexus Mods API query excluding the , where {0} is the mod ID. - public NexusRepository(string vendorKey, string userAgent, string baseUrl, string modUrlFormat) + /// The underlying Nexus Mods API client. + public NexusRepository(string vendorKey, INexusClient client) : base(vendorKey) { - this.ModUrlFormat = modUrlFormat; - this.Client = new FluentClient(baseUrl).SetUserAgent(userAgent); + this.Client = client; } /// Get metadata about a mod in the repository. @@ -39,18 +32,15 @@ namespace StardewModdingAPI.Web.Framework.ModRepositories public override async Task GetModInfoAsync(string id) { // validate ID format - if (!uint.TryParse(id, out uint _)) + if (!uint.TryParse(id, out uint nexusID)) return new ModInfoModel($"The value '{id}' isn't a valid Nexus mod ID, must be an integer ID."); // fetch info try { - NexusResponseModel response = await this.Client - .GetAsync(string.Format(this.ModUrlFormat, id)) - .As(); - - return response != null - ? new ModInfoModel(response.Name, this.NormaliseVersion(response.Version), response.Url) + NexusMod mod = await this.Client.GetModAsync(nexusID); + return mod != null + ? new ModInfoModel(mod.Name, this.NormaliseVersion(mod.Version), mod.Url) : new ModInfoModel("Found no mod with this ID."); } catch (Exception ex) @@ -64,26 +54,5 @@ namespace StardewModdingAPI.Web.Framework.ModRepositories { this.Client.Dispose(); } - - - /********* - ** Private models - *********/ - /// A mod metadata response from Nexus Mods. - private class NexusResponseModel - { - /********* - ** Accessors - *********/ - /// The mod name. - public string Name { get; set; } - - /// The mod's semantic version number. - public string Version { get; set; } - - /// The mod's web URL. - [JsonProperty("mod_page_uri")] - public string Url { get; set; } - } } } -- cgit From bbd021f8736d1496f34a58b12bb0ee6c341d1c5e Mon Sep 17 00:00:00 2001 From: Jesse Plamondon-Willard Date: Sun, 24 Dec 2017 23:40:23 -0500 Subject: decouple Pastebin client from log parser (#411) --- .../Framework/Clients/Pastebin/IPastebinClient.cs | 17 +++ .../Framework/Clients/Pastebin/PasteInfo.cs | 15 +++ .../Framework/Clients/Pastebin/PastebinClient.cs | 134 +++++++++++++++++++++ .../Framework/Clients/Pastebin/SavePasteResult.cs | 15 +++ .../Framework/ConfigModels/ApiClientsConfig.cs | 16 +++ .../Framework/ConfigModels/LogParserConfig.cs | 12 -- .../Framework/LogParser/GetPasteResponse.cs | 15 --- .../Framework/LogParser/PastebinClient.cs | 134 --------------------- .../Framework/LogParser/SavePasteResponse.cs | 15 --- 9 files changed, 197 insertions(+), 176 deletions(-) create mode 100644 src/SMAPI.Web/Framework/Clients/Pastebin/IPastebinClient.cs create mode 100644 src/SMAPI.Web/Framework/Clients/Pastebin/PasteInfo.cs create mode 100644 src/SMAPI.Web/Framework/Clients/Pastebin/PastebinClient.cs create mode 100644 src/SMAPI.Web/Framework/Clients/Pastebin/SavePasteResult.cs delete mode 100644 src/SMAPI.Web/Framework/LogParser/GetPasteResponse.cs delete mode 100644 src/SMAPI.Web/Framework/LogParser/PastebinClient.cs delete mode 100644 src/SMAPI.Web/Framework/LogParser/SavePasteResponse.cs (limited to 'src/SMAPI.Web/Framework') diff --git a/src/SMAPI.Web/Framework/Clients/Pastebin/IPastebinClient.cs b/src/SMAPI.Web/Framework/Clients/Pastebin/IPastebinClient.cs new file mode 100644 index 00000000..630dfb76 --- /dev/null +++ b/src/SMAPI.Web/Framework/Clients/Pastebin/IPastebinClient.cs @@ -0,0 +1,17 @@ +using System; +using System.Threading.Tasks; + +namespace StardewModdingAPI.Web.Framework.Clients.Pastebin +{ + /// An API client for Pastebin. + internal interface IPastebinClient : IDisposable + { + /// Fetch a saved paste. + /// The paste ID. + Task GetAsync(string id); + + /// Save a paste to Pastebin. + /// The paste content. + Task PostAsync(string content); + } +} diff --git a/src/SMAPI.Web/Framework/Clients/Pastebin/PasteInfo.cs b/src/SMAPI.Web/Framework/Clients/Pastebin/PasteInfo.cs new file mode 100644 index 00000000..955156eb --- /dev/null +++ b/src/SMAPI.Web/Framework/Clients/Pastebin/PasteInfo.cs @@ -0,0 +1,15 @@ +namespace StardewModdingAPI.Web.Framework.Clients.Pastebin +{ + /// The response for a get-paste request. + internal class PasteInfo + { + /// Whether the log was successfully fetched. + public bool Success { get; set; } + + /// The fetched paste content (if is true). + public string Content { get; set; } + + /// The error message (if saving failed). + public string Error { get; set; } + } +} diff --git a/src/SMAPI.Web/Framework/Clients/Pastebin/PastebinClient.cs b/src/SMAPI.Web/Framework/Clients/Pastebin/PastebinClient.cs new file mode 100644 index 00000000..ef83a91e --- /dev/null +++ b/src/SMAPI.Web/Framework/Clients/Pastebin/PastebinClient.cs @@ -0,0 +1,134 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Net; +using System.Net.Http; +using System.Text; +using System.Threading.Tasks; +using System.Web; +using Pathoschild.Http.Client; + +namespace StardewModdingAPI.Web.Framework.Clients.Pastebin +{ + /// An API client for Pastebin. + internal class PastebinClient : IPastebinClient + { + /********* + ** Properties + *********/ + /// The underlying HTTP client. + private readonly IClient Client; + + /// The user key used to authenticate with the Pastebin API. + private readonly string UserKey; + + /// The developer key used to authenticate with the Pastebin API. + private readonly string DevKey; + + + /********* + ** Public methods + *********/ + /// Construct an instance. + /// The base URL for the Pastebin API. + /// The user agent for the API client. + /// The user key used to authenticate with the Pastebin API. + /// The developer key used to authenticate with the Pastebin API. + public PastebinClient(string baseUrl, string userAgent, string userKey, string devKey) + { + this.Client = new FluentClient(baseUrl).SetUserAgent(userAgent); + this.UserKey = userKey; + this.DevKey = devKey; + } + + /// Fetch a saved paste. + /// The paste ID. + public async Task GetAsync(string id) + { + try + { + // get from API + string content = await this.Client + .GetAsync($"raw/{id}") + .AsString(); + + // handle Pastebin errors + if (string.IsNullOrWhiteSpace(content)) + return new PasteInfo { Error = "Received an empty response from Pastebin." }; + if (content.StartsWith("Save a paste to Pastebin. + /// The paste content. + public async Task PostAsync(string content) + { + try + { + // validate + if (string.IsNullOrWhiteSpace(content)) + return new SavePasteResult { Error = "The log content can't be empty." }; + + // post to API + string response = await this.Client + .PostAsync("api/api_post.php") + .WithBodyContent(this.GetFormUrlEncodedContent(new Dictionary + { + ["api_option"] = "paste", + ["api_user_key"] = this.UserKey, + ["api_dev_key"] = this.DevKey, + ["api_paste_private"] = "1", // unlisted + ["api_paste_name"] = $"SMAPI log {DateTime.UtcNow:s}", + ["api_paste_expire_date"] = "N", // never expire + ["api_paste_code"] = content + })) + .AsString(); + + // handle Pastebin errors + if (string.IsNullOrWhiteSpace(response)) + return new SavePasteResult { Error = "Received an empty response from Pastebin." }; + if (response.StartsWith("Bad API request")) + return new SavePasteResult { Error = response }; + if (!response.Contains("/")) + return new SavePasteResult { Error = $"Received an unknown response: {response}" }; + + // return paste ID + string pastebinID = response.Split("/").Last(); + return new SavePasteResult { Success = true, ID = pastebinID }; + } + catch (Exception ex) + { + return new SavePasteResult { Success = false, Error = ex.ToString() }; + } + } + + /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + public void Dispose() + { + this.Client.Dispose(); + } + + + /********* + ** Private methods + *********/ + /// Build an HTTP content body with form-url-encoded content. + /// The content to encode. + /// This bypasses an issue where restricts the body length to the maximum size of a URL, which isn't applicable here. + private HttpContent GetFormUrlEncodedContent(IDictionary data) + { + string body = string.Join("&", from arg in data select $"{HttpUtility.UrlEncode(arg.Key)}={HttpUtility.UrlEncode(arg.Value)}"); + return new StringContent(body, Encoding.UTF8, "application/x-www-form-urlencoded"); + } + } +} diff --git a/src/SMAPI.Web/Framework/Clients/Pastebin/SavePasteResult.cs b/src/SMAPI.Web/Framework/Clients/Pastebin/SavePasteResult.cs new file mode 100644 index 00000000..89dab697 --- /dev/null +++ b/src/SMAPI.Web/Framework/Clients/Pastebin/SavePasteResult.cs @@ -0,0 +1,15 @@ +namespace StardewModdingAPI.Web.Framework.Clients.Pastebin +{ + /// The response for a save-log request. + internal class SavePasteResult + { + /// Whether the log was successfully saved. + public bool Success { get; set; } + + /// The saved paste ID (if is true). + public string ID { get; set; } + + /// The error message (if saving failed). + public string Error { get; set; } + } +} diff --git a/src/SMAPI.Web/Framework/ConfigModels/ApiClientsConfig.cs b/src/SMAPI.Web/Framework/ConfigModels/ApiClientsConfig.cs index 19794920..61219414 100644 --- a/src/SMAPI.Web/Framework/ConfigModels/ApiClientsConfig.cs +++ b/src/SMAPI.Web/Framework/ConfigModels/ApiClientsConfig.cs @@ -52,5 +52,21 @@ namespace StardewModdingAPI.Web.Framework.ConfigModels /// The URL for a Nexus Mods API query excluding the , where {0} is the mod ID. public string NexusModUrlFormat { get; set; } + + /**** + ** Pastebin + ****/ + /// The base URL for the Pastebin API. + public string PastebinBaseUrl { get; set; } + + /// The user agent for the Pastebin API client, where {0} is the SMAPI version. + public string PastebinUserAgent { get; set; } + + /// The user key used to authenticate with the Pastebin API. + public string PastebinUserKey { get; set; } + + /// The developer key used to authenticate with the Pastebin API. + public string PastebinDevKey { get; set; } + } } diff --git a/src/SMAPI.Web/Framework/ConfigModels/LogParserConfig.cs b/src/SMAPI.Web/Framework/ConfigModels/LogParserConfig.cs index df5d605d..198274b2 100644 --- a/src/SMAPI.Web/Framework/ConfigModels/LogParserConfig.cs +++ b/src/SMAPI.Web/Framework/ConfigModels/LogParserConfig.cs @@ -8,17 +8,5 @@ namespace StardewModdingAPI.Web.Framework.ConfigModels *********/ /// The root URL for the log parser controller. public string SectionUrl { get; set; } - - /// The base URL for the Pastebin API. - public string PastebinBaseUrl { get; set; } - - /// The user agent for the Pastebin API client, where {0} is the SMAPI version. - public string PastebinUserAgent { get; set; } - - /// The user key used to authenticate with the Pastebin API. - public string PastebinUserKey { get; set; } - - /// The developer key used to authenticate with the Pastebin API. - public string PastebinDevKey { get; set; } } } diff --git a/src/SMAPI.Web/Framework/LogParser/GetPasteResponse.cs b/src/SMAPI.Web/Framework/LogParser/GetPasteResponse.cs deleted file mode 100644 index 4f8794db..00000000 --- a/src/SMAPI.Web/Framework/LogParser/GetPasteResponse.cs +++ /dev/null @@ -1,15 +0,0 @@ -namespace StardewModdingAPI.Web.Framework.LogParser -{ - /// The response for a get-paste request. - internal class GetPasteResponse - { - /// Whether the log was successfully fetched. - public bool Success { get; set; } - - /// The fetched paste content (if is true). - public string Content { get; set; } - - /// The error message (if saving failed). - public string Error { get; set; } - } -} diff --git a/src/SMAPI.Web/Framework/LogParser/PastebinClient.cs b/src/SMAPI.Web/Framework/LogParser/PastebinClient.cs deleted file mode 100644 index 1cfaed17..00000000 --- a/src/SMAPI.Web/Framework/LogParser/PastebinClient.cs +++ /dev/null @@ -1,134 +0,0 @@ -using System; -using System.Collections.Generic; -using System.Linq; -using System.Net; -using System.Net.Http; -using System.Text; -using System.Threading.Tasks; -using System.Web; -using Pathoschild.Http.Client; - -namespace StardewModdingAPI.Web.Framework.LogParser -{ - /// An API client for Pastebin. - internal class PastebinClient : IDisposable - { - /********* - ** Properties - *********/ - /// The underlying HTTP client. - private readonly IClient Client; - - /// The user key used to authenticate with the Pastebin API. - private readonly string UserKey; - - /// The developer key used to authenticate with the Pastebin API. - private readonly string DevKey; - - - /********* - ** Public methods - *********/ - /// Construct an instance. - /// The base URL for the Pastebin API. - /// The user agent for the API client. - /// The user key used to authenticate with the Pastebin API. - /// The developer key used to authenticate with the Pastebin API. - public PastebinClient(string baseUrl, string userAgent, string userKey, string devKey) - { - this.Client = new FluentClient(baseUrl).SetUserAgent(userAgent); - this.UserKey = userKey; - this.DevKey = devKey; - } - - /// Fetch a saved paste. - /// The paste ID. - public async Task GetAsync(string id) - { - try - { - // get from API - string content = await this.Client - .GetAsync($"raw/{id}") - .AsString(); - - // handle Pastebin errors - if (string.IsNullOrWhiteSpace(content)) - return new GetPasteResponse { Error = "Received an empty response from Pastebin." }; - if (content.StartsWith("Save a paste to Pastebin. - /// The paste content. - public async Task PostAsync(string content) - { - try - { - // validate - if (string.IsNullOrWhiteSpace(content)) - return new SavePasteResponse { Error = "The log content can't be empty." }; - - // post to API - string response = await this.Client - .PostAsync("api/api_post.php") - .WithBodyContent(this.GetFormUrlEncodedContent(new Dictionary - { - ["api_option"] = "paste", - ["api_user_key"] = this.UserKey, - ["api_dev_key"] = this.DevKey, - ["api_paste_private"] = "1", // unlisted - ["api_paste_name"] = $"SMAPI log {DateTime.UtcNow:s}", - ["api_paste_expire_date"] = "N", // never expire - ["api_paste_code"] = content - })) - .AsString(); - - // handle Pastebin errors - if (string.IsNullOrWhiteSpace(response)) - return new SavePasteResponse { Error = "Received an empty response from Pastebin." }; - if (response.StartsWith("Bad API request")) - return new SavePasteResponse { Error = response }; - if (!response.Contains("/")) - return new SavePasteResponse { Error = $"Received an unknown response: {response}" }; - - // return paste ID - string pastebinID = response.Split("/").Last(); - return new SavePasteResponse { Success = true, ID = pastebinID }; - } - catch (Exception ex) - { - return new SavePasteResponse { Success = false, Error = ex.ToString() }; - } - } - - /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - public void Dispose() - { - this.Client.Dispose(); - } - - - /********* - ** Private methods - *********/ - /// Build an HTTP content body with form-url-encoded content. - /// The content to encode. - /// This bypasses an issue where restricts the body length to the maximum size of a URL, which isn't applicable here. - private HttpContent GetFormUrlEncodedContent(IDictionary data) - { - string body = string.Join("&", from arg in data select $"{HttpUtility.UrlEncode(arg.Key)}={HttpUtility.UrlEncode(arg.Value)}"); - return new StringContent(body, Encoding.UTF8, "application/x-www-form-urlencoded"); - } - } -} diff --git a/src/SMAPI.Web/Framework/LogParser/SavePasteResponse.cs b/src/SMAPI.Web/Framework/LogParser/SavePasteResponse.cs deleted file mode 100644 index 1c0960a4..00000000 --- a/src/SMAPI.Web/Framework/LogParser/SavePasteResponse.cs +++ /dev/null @@ -1,15 +0,0 @@ -namespace StardewModdingAPI.Web.Framework.LogParser -{ - /// The response for a save-log request. - internal class SavePasteResponse - { - /// Whether the log was successfully saved. - public bool Success { get; set; } - - /// The saved paste ID (if is true). - public string ID { get; set; } - - /// The error message (if saving failed). - public string Error { get; set; } - } -} -- cgit From adee66b3b4ea111b0082a31108e55726fab10643 Mon Sep 17 00:00:00 2001 From: Jesse Plamondon-Willard Date: Mon, 25 Dec 2017 01:47:10 -0500 Subject: add basic download page (#411) --- src/SMAPI.Web/Framework/Clients/GitHub/GitAsset.cs | 20 ++++++++++++++++++++ src/SMAPI.Web/Framework/Clients/GitHub/GitRelease.cs | 6 ++++++ 2 files changed, 26 insertions(+) create mode 100644 src/SMAPI.Web/Framework/Clients/GitHub/GitAsset.cs (limited to 'src/SMAPI.Web/Framework') diff --git a/src/SMAPI.Web/Framework/Clients/GitHub/GitAsset.cs b/src/SMAPI.Web/Framework/Clients/GitHub/GitAsset.cs new file mode 100644 index 00000000..73ce4025 --- /dev/null +++ b/src/SMAPI.Web/Framework/Clients/GitHub/GitAsset.cs @@ -0,0 +1,20 @@ +using Newtonsoft.Json; + +namespace StardewModdingAPI.Web.Framework.Clients.GitHub +{ + /// A GitHub download attached to a release. + internal class GitAsset + { + /// The file name. + [JsonProperty("name")] + public string FileName { get; set; } + + /// The file content type. + [JsonProperty("content_type")] + public string ContentType { get; set; } + + /// The download URL. + [JsonProperty("browser_download_url")] + public string DownloadUrl { get; set; } + } +} diff --git a/src/SMAPI.Web/Framework/Clients/GitHub/GitRelease.cs b/src/SMAPI.Web/Framework/Clients/GitHub/GitRelease.cs index 0a47f3b4..b944088d 100644 --- a/src/SMAPI.Web/Framework/Clients/GitHub/GitRelease.cs +++ b/src/SMAPI.Web/Framework/Clients/GitHub/GitRelease.cs @@ -15,5 +15,11 @@ namespace StardewModdingAPI.Web.Framework.Clients.GitHub /// The semantic version string. [JsonProperty("tag_name")] public string Tag { get; set; } + + /// The Markdown description for the release. + public string Body { get; set; } + + /// The attached files. + public GitAsset[] Assets { get; set; } } } -- cgit From 70cbfa541dade1822394f81bd1d5b6baa18e51e9 Mon Sep 17 00:00:00 2001 From: Jesse Plamondon-Willard Date: Mon, 25 Dec 2017 01:53:10 -0500 Subject: support contextual nav URLs, update nav menu (#411) --- src/SMAPI.Web/Framework/ConfigModels/ContextConfig.cs | 15 +++++++++++++++ src/SMAPI.Web/Framework/ConfigModels/LogParserConfig.cs | 12 ------------ 2 files changed, 15 insertions(+), 12 deletions(-) create mode 100644 src/SMAPI.Web/Framework/ConfigModels/ContextConfig.cs delete mode 100644 src/SMAPI.Web/Framework/ConfigModels/LogParserConfig.cs (limited to 'src/SMAPI.Web/Framework') diff --git a/src/SMAPI.Web/Framework/ConfigModels/ContextConfig.cs b/src/SMAPI.Web/Framework/ConfigModels/ContextConfig.cs new file mode 100644 index 00000000..117462f4 --- /dev/null +++ b/src/SMAPI.Web/Framework/ConfigModels/ContextConfig.cs @@ -0,0 +1,15 @@ +namespace StardewModdingAPI.Web.Framework.ConfigModels +{ + /// The config settings for the app context. + public class ContextConfig // must be public to pass into views + { + /********* + ** Accessors + *********/ + /// The root URL for the app. + public string RootUrl { get; set; } + + /// The root URL for the log parser. + public string LogParserUrl { get; set; } + } +} diff --git a/src/SMAPI.Web/Framework/ConfigModels/LogParserConfig.cs b/src/SMAPI.Web/Framework/ConfigModels/LogParserConfig.cs deleted file mode 100644 index 198274b2..00000000 --- a/src/SMAPI.Web/Framework/ConfigModels/LogParserConfig.cs +++ /dev/null @@ -1,12 +0,0 @@ -namespace StardewModdingAPI.Web.Framework.ConfigModels -{ - /// The config settings for the log parser. - internal class LogParserConfig - { - /********* - ** Accessors - *********/ - /// The root URL for the log parser controller. - public string SectionUrl { get; set; } - } -} -- cgit