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)

---
 .../Clients/Chucklefish/ChucklefishClient.cs       | 83 ++++++++++++++++++++++
 .../Clients/Chucklefish/ChucklefishMod.cs          | 18 +++++
 .../Clients/Chucklefish/IChucklefishClient.cs      | 17 +++++
 3 files changed, 118 insertions(+)
 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

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

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
+{
+    /// <summary>An HTTP client for fetching mod metadata from the Chucklefish mod site.</summary>
+    internal class ChucklefishClient : IChucklefishClient
+    {
+        /*********
+        ** Properties
+        *********/
+        /// <summary>The base URL for the Chucklefish mod site.</summary>
+        private readonly string BaseUrl;
+
+        /// <summary>The URL for a mod page excluding the base URL, where {0} is the mod ID.</summary>
+        private readonly string ModPageUrlFormat;
+
+        /// <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 API client.</param>
+        /// <param name="baseUrl">The base URL for the Chucklefish mod site.</param>
+        /// <param name="modPageUrlFormat">The URL for a mod page excluding the <paramref name="baseUrl"/>, where {0} is the mod ID.</param>
+        public ChucklefishClient(string userAgent, string baseUrl, string modPageUrlFormat)
+        {
+            this.BaseUrl = baseUrl;
+            this.ModPageUrlFormat = modPageUrlFormat;
+            this.Client = new FluentClient(baseUrl).SetUserAgent(userAgent);
+        }
+
+        /// <summary>Get metadata about a mod.</summary>
+        /// <param name="id">The Chucklefish mod ID.</param>
+        /// <returns>Returns the mod info if found, else <c>null</c>.</returns>
+        public async Task<ChucklefishMod> 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
+            };
+        }
+
+        /// <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/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
+{
+    /// <summary>Mod metadata from the Chucklefish mod site.</summary>
+    internal class ChucklefishMod
+    {
+        /*********
+        ** 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>
+        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
+{
+    /// <summary>An HTTP client for fetching mod metadata from the Chucklefish mod site.</summary>
+    internal interface IChucklefishClient : IDisposable
+    {
+        /*********
+        ** Methods
+        *********/
+        /// <summary>Get metadata about a mod.</summary>
+        /// <param name="id">The Chucklefish mod ID.</param>
+        /// <returns>Returns the mod info if found, else <c>null</c>.</returns>
+        Task<ChucklefishMod> GetModAsync(uint id);
+    }
+}
-- 
cgit