From a0888e0ad1bf0ed38982d2aadf78c31d046b061b Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <github@jplamondonw.com>
Date: Fri, 29 Jun 2018 01:01:57 -0400
Subject: add optional extended metadata to mods API (#532)

---
 .../Clients/WebApi/ModExtendedMetadataModel.cs     | 77 ++++++++++++++++++++++
 1 file changed, 77 insertions(+)
 create mode 100644 src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModExtendedMetadataModel.cs

(limited to 'src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModExtendedMetadataModel.cs')

diff --git a/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModExtendedMetadataModel.cs b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModExtendedMetadataModel.cs
new file mode 100644
index 00000000..a716114b
--- /dev/null
+++ b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModExtendedMetadataModel.cs
@@ -0,0 +1,77 @@
+using System.Linq;
+using Newtonsoft.Json;
+using Newtonsoft.Json.Converters;
+using StardewModdingAPI.Toolkit.Framework.Clients.Wiki;
+using StardewModdingAPI.Toolkit.Framework.ModData;
+
+namespace StardewModdingAPI.Toolkit.Framework.Clients.WebApi
+{
+    /// <summary>Extended metadata about a mod.</summary>
+    public class ModExtendedMetadataModel
+    {
+        /*********
+        ** Accessors
+        *********/
+        /// <summary>The mod's unique ID. A mod may have multiple current IDs in rare cases (e.g. due to parallel releases or unofficial updates).</summary>
+        public string[] ID { get; set; } = new string[0];
+
+        /// <summary>The mod's display name.</summary>
+        public string Name { get; set; }
+
+        /// <summary>The mod ID on Nexus.</summary>
+        public int? NexusID { get; set; }
+
+        /// <summary>The mod ID in the Chucklefish mod repo.</summary>
+        public int? ChucklefishID { get; set; }
+
+        /// <summary>The GitHub repository in the form 'owner/repo'.</summary>
+        public string GitHubRepo { get; set; }
+
+        /// <summary>The URL to a non-GitHub source repo.</summary>
+        public string CustomSourceUrl { get; set; }
+
+        /// <summary>The custom mod page URL (if applicable).</summary>
+        public string CustomUrl { get; set; }
+
+        /// <summary>The compatibility status.</summary>
+        [JsonConverter(typeof(StringEnumConverter))]
+        public WikiCompatibilityStatus? CompatibilityStatus { get; set; }
+
+        /// <summary>The human-readable summary of the compatibility status or workaround, without HTML formatitng.</summary>
+        public string CompatibilitySummary { get; set; }
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Construct an instance.</summary>
+        public ModExtendedMetadataModel() { }
+
+        /// <summary>Construct an instance.</summary>
+        /// <param name="wiki">The mod metadata from the wiki (if available).</param>
+        /// <param name="db">The mod metadata from SMAPI's internal DB (if available).</param>
+        public ModExtendedMetadataModel(WikiCompatibilityEntry wiki, ModDataRecord db)
+        {
+            // wiki data
+            if (wiki != null)
+            {
+                this.ID = wiki.ID;
+                this.Name = wiki.Name;
+                this.NexusID = wiki.NexusID;
+                this.ChucklefishID = wiki.ChucklefishID;
+                this.GitHubRepo = wiki.GitHubRepo;
+                this.CustomSourceUrl = wiki.CustomSourceUrl;
+                this.CustomUrl = wiki.CustomUrl;
+                this.CompatibilityStatus = wiki.Status;
+                this.CompatibilitySummary = wiki.Summary;
+            }
+
+            // internal DB data
+            if (db != null)
+            {
+                this.ID = this.ID.Union(db.FormerIDs).ToArray();
+                this.Name = this.Name ?? db.DisplayName;
+            }
+        }
+    }
+}
-- 
cgit 


From 34c43f9f66b33c402947be5e84544e09cb048290 Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <github@jplamondonw.com>
Date: Sun, 1 Jul 2018 12:23:03 -0400
Subject: add toolkit method for API data (#532)

---
 .../Framework/Clients/WebApi/ModExtendedMetadataModel.cs     | 12 ++++++++++++
 1 file changed, 12 insertions(+)

(limited to 'src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModExtendedMetadataModel.cs')

diff --git a/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModExtendedMetadataModel.cs b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModExtendedMetadataModel.cs
index a716114b..21376b36 100644
--- a/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModExtendedMetadataModel.cs
+++ b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModExtendedMetadataModel.cs
@@ -1,3 +1,4 @@
+using System.Collections.Generic;
 using System.Linq;
 using Newtonsoft.Json;
 using Newtonsoft.Json.Converters;
@@ -73,5 +74,16 @@ namespace StardewModdingAPI.Toolkit.Framework.Clients.WebApi
                 this.Name = this.Name ?? db.DisplayName;
             }
         }
+
+        /// <summary>Get update keys based on the metadata.</summary>
+        public IEnumerable<string> GetUpdateKeys()
+        {
+            if (this.NexusID.HasValue)
+                yield return $"Nexus:{this.NexusID}";
+            if (this.ChucklefishID.HasValue)
+                yield return $"Chucklefish:{this.ChucklefishID}";
+            if (this.GitHubRepo != null)
+                yield return $"GitHub:{this.GitHubRepo}";
+        }
     }
 }
-- 
cgit