From 05541c11a72735d79d98cf3ae14d592e70bd8f54 Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <github@jplamondonw.com>
Date: Sun, 24 Dec 2017 23:28:07 -0500
Subject: decouple API clients from mods API (#411)

---
 .../Framework/Clients/Nexus/INexusClient.cs        | 17 ++++++++
 .../Framework/Clients/Nexus/NexusClient.cs         | 48 ++++++++++++++++++++++
 src/SMAPI.Web/Framework/Clients/Nexus/NexusMod.cs  | 21 ++++++++++
 3 files changed, 86 insertions(+)
 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

(limited to 'src/SMAPI.Web/Framework/Clients/Nexus')

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
+{
+    /// <summary>An HTTP client for fetching mod metadata from Nexus Mods.</summary>
+    internal interface INexusClient : IDisposable
+    {
+        /*********
+        ** Methods
+        *********/
+        /// <summary>Get metadata about a mod.</summary>
+        /// <param name="id">The Nexus mod ID.</param>
+        /// <returns>Returns the mod info if found, else <c>null</c>.</returns>
+        Task<NexusMod> 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
+{
+    /// <summary>An HTTP client for fetching mod metadata from Nexus Mods.</summary>
+    internal class NexusClient : INexusClient
+    {
+        /*********
+        ** Properties
+        *********/
+        /// <summary>The URL for a Nexus Mods API query excluding the base URL, where {0} is the mod ID.</summary>
+        private readonly string ModUrlFormat;
+
+        /// <summary>The underlying HTTP client.</summary>
+        private readonly IClient Client;
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Construct an instance.</summary>
+        /// <param name="userAgent">The user agent for the Nexus Mods API client.</param>
+        /// <param name="baseUrl">The base URL for the Nexus Mods API.</param>
+        /// <param name="modUrlFormat">The URL for a Nexus Mods API query excluding the <paramref name="baseUrl"/>, where {0} is the mod ID.</param>
+        public NexusClient(string userAgent, string baseUrl, string modUrlFormat)
+        {
+            this.ModUrlFormat = modUrlFormat;
+            this.Client = new FluentClient(baseUrl).SetUserAgent(userAgent);
+        }
+
+        /// <summary>Get metadata about a mod.</summary>
+        /// <param name="id">The Nexus mod ID.</param>
+        /// <returns>Returns the mod info if found, else <c>null</c>.</returns>
+        public async Task<NexusMod> GetModAsync(uint id)
+        {
+            return await this.Client
+                .GetAsync(string.Format(this.ModUrlFormat, id))
+                .As<NexusMod>();
+        }
+
+        /// <summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
+        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
+{
+    /// <summary>Mod metadata from Nexus Mods.</summary>
+    internal class NexusMod
+    {
+        /*********
+        ** Accessors
+        *********/
+        /// <summary>The mod name.</summary>
+        public string Name { get; set; }
+
+        /// <summary>The mod's semantic version number.</summary>
+        public string Version { get; set; }
+
+        /// <summary>The mod's web URL.</summary>
+        [JsonProperty("mod_page_uri")]
+        public string Url { get; set; }
+    }
+}
-- 
cgit