From de74b038e4c15d393de8828c89814ef7eaefe507 Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <github@jplamondonw.com>
Date: Sat, 2 Jun 2018 18:22:04 -0400
Subject: move web API client into toolkit (#532)

---
 .../Framework/Clients/WebApi/ModInfoModel.cs       | 56 +++++++++++++++++
 .../Framework/Clients/WebApi/ModSeachModel.cs      | 37 ++++++++++++
 .../Framework/Clients/WebApi/WebApiClient.cs       | 70 ++++++++++++++++++++++
 3 files changed, 163 insertions(+)
 create mode 100644 src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModInfoModel.cs
 create mode 100644 src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModSeachModel.cs
 create mode 100644 src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/WebApiClient.cs

(limited to 'src/StardewModdingAPI.Toolkit')

diff --git a/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModInfoModel.cs b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModInfoModel.cs
new file mode 100644
index 00000000..e1a204c6
--- /dev/null
+++ b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModInfoModel.cs
@@ -0,0 +1,56 @@
+namespace StardewModdingAPI.Toolkit.Framework.Clients.WebApi
+{
+    /// <summary>Generic metadata about a mod.</summary>
+    public class ModInfoModel
+    {
+        /*********
+        ** Accessors
+        *********/
+        /// <summary>The mod name.</summary>
+        public string Name { get; set; }
+
+        /// <summary>The semantic version for the mod's latest release.</summary>
+        public string Version { get; set; }
+
+        /// <summary>The semantic version for the mod's latest preview release, if available and different from <see cref="Version"/>.</summary>
+        public string PreviewVersion { get; set; }
+
+        /// <summary>The mod's web URL.</summary>
+        public string Url { get; set; }
+
+        /// <summary>The error message indicating why the mod is invalid (if applicable).</summary>
+        public string Error { get; set; }
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Construct an empty instance.</summary>
+        public ModInfoModel()
+        {
+            // needed for JSON deserialising
+        }
+
+        /// <summary>Construct an instance.</summary>
+        /// <param name="name">The mod name.</param>
+        /// <param name="version">The semantic version for the mod's latest release.</param>
+        /// <param name="previewVersion">The semantic version for the mod's latest preview release, if available and different from <see cref="Version"/>.</param>
+        /// <param name="url">The mod's web URL.</param>
+        /// <param name="error">The error message indicating why the mod is invalid (if applicable).</param>
+        public ModInfoModel(string name, string version, string url, string previewVersion = null, string error = null)
+        {
+            this.Name = name;
+            this.Version = version;
+            this.PreviewVersion = previewVersion;
+            this.Url = url;
+            this.Error = error; // mainly initialised here for the JSON deserialiser
+        }
+
+        /// <summary>Construct an instance.</summary>
+        /// <param name="error">The error message indicating why the mod is invalid.</param>
+        public ModInfoModel(string error)
+        {
+            this.Error = error;
+        }
+    }
+}
diff --git a/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModSeachModel.cs b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModSeachModel.cs
new file mode 100644
index 00000000..c0ee34ea
--- /dev/null
+++ b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModSeachModel.cs
@@ -0,0 +1,37 @@
+using System.Collections.Generic;
+using System.Linq;
+
+namespace StardewModdingAPI.Toolkit.Framework.Clients.WebApi
+{
+    /// <summary>Specifies mods whose update-check info to fetch.</summary>
+    public class ModSearchModel
+    {
+        /*********
+        ** Accessors
+        *********/
+        /// <summary>The namespaced mod keys to search.</summary>
+        public string[] ModKeys { get; set; }
+
+        /// <summary>Whether to allow non-semantic versions, instead of returning an error for those.</summary>
+        public bool AllowInvalidVersions { get; set; }
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Construct an empty instance.</summary>
+        public ModSearchModel()
+        {
+            // needed for JSON deserialising
+        }
+
+        /// <summary>Construct an instance.</summary>
+        /// <param name="modKeys">The namespaced mod keys to search.</param>
+        /// <param name="allowInvalidVersions">Whether to allow non-semantic versions, instead of returning an error for those.</param>
+        public ModSearchModel(IEnumerable<string> modKeys, bool allowInvalidVersions)
+        {
+            this.ModKeys = modKeys.ToArray();
+            this.AllowInvalidVersions = allowInvalidVersions;
+        }
+    }
+}
diff --git a/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/WebApiClient.cs b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/WebApiClient.cs
new file mode 100644
index 00000000..277fbeeb
--- /dev/null
+++ b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/WebApiClient.cs
@@ -0,0 +1,70 @@
+using System;
+using System.Collections.Generic;
+using System.Net;
+using Newtonsoft.Json;
+
+namespace StardewModdingAPI.Toolkit.Framework.Clients.WebApi
+{
+    /// <summary>Provides methods for interacting with the SMAPI web API.</summary>
+    internal class WebApiClient
+    {
+        /*********
+        ** Properties
+        *********/
+        /// <summary>The base URL for the web API.</summary>
+        private readonly Uri BaseUrl;
+
+        /// <summary>The API version number.</summary>
+        private readonly ISemanticVersion Version;
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Construct an instance.</summary>
+        /// <param name="baseUrl">The base URL for the web API.</param>
+        /// <param name="version">The web API version.</param>
+        public WebApiClient(string baseUrl, ISemanticVersion version)
+        {
+#if !SMAPI_FOR_WINDOWS
+            baseUrl = baseUrl.Replace("https://", "http://"); // workaround for OpenSSL issues with the game's bundled Mono on Linux/Mac
+#endif
+            this.BaseUrl = new Uri(baseUrl);
+            this.Version = version;
+        }
+
+        /// <summary>Get the latest SMAPI version.</summary>
+        /// <param name="modKeys">The mod keys for which to fetch the latest version.</param>
+        public IDictionary<string, ModInfoModel> GetModInfo(params string[] modKeys)
+        {
+            return this.Post<ModSearchModel, Dictionary<string, ModInfoModel>>(
+                $"v{this.Version}/mods",
+                new ModSearchModel(modKeys, allowInvalidVersions: true)
+            );
+        }
+
+
+        /*********
+        ** Private methods
+        *********/
+        /// <summary>Fetch the response from the backend API.</summary>
+        /// <typeparam name="TBody">The body content type.</typeparam>
+        /// <typeparam name="TResult">The expected response type.</typeparam>
+        /// <param name="url">The request URL, optionally excluding the base URL.</param>
+        /// <param name="content">The body content to post.</param>
+        private TResult Post<TBody, TResult>(string url, TBody content)
+        {
+            // note: avoid HttpClient for Mac compatibility
+            using (WebClient client = new WebClient())
+            {
+                Uri fullUrl = new Uri(this.BaseUrl, url);
+                string data = JsonConvert.SerializeObject(content);
+
+                client.Headers["Content-Type"] = "application/json";
+                client.Headers["User-Agent"] = $"SMAPI/{this.Version}";
+                string response = client.UploadString(fullUrl, data);
+                return JsonConvert.DeserializeObject<TResult>(response);
+            }
+        }
+    }
+}
-- 
cgit