From 3f5a5e54041a641e30fc5cc899046953d9763da4 Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <github@jplamondonw.com>
Date: Thu, 28 Jun 2018 22:01:04 -0400
Subject: use more structured API response for update checks (#532)

---
 .../Framework/Clients/WebApi/ModEntryModel.cs      | 45 +++++++++++++++++++---
 .../Clients/WebApi/ModEntryVersionModel.cs         | 31 +++++++++++++++
 .../ModData/ModDataRecordVersionedFields.cs        |  9 +++--
 3 files changed, 76 insertions(+), 9 deletions(-)
 create mode 100644 src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModEntryVersionModel.cs

(limited to 'src/StardewModdingAPI.Toolkit')

diff --git a/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModEntryModel.cs b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModEntryModel.cs
index e4ab168e..581a524c 100644
--- a/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModEntryModel.cs
+++ b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModEntryModel.cs
@@ -1,3 +1,5 @@
+using System;
+
 namespace StardewModdingAPI.Toolkit.Framework.Clients.WebApi
 {
     /// <summary>Metadata about a mod.</summary>
@@ -12,19 +14,50 @@ namespace StardewModdingAPI.Toolkit.Framework.Clients.WebApi
         /// <summary>The mod name.</summary>
         public string Name { get; set; }
 
+        /// <summary>The main version.</summary>
+        public ModEntryVersionModel Main { get; set; }
+
+        /// <summary>The latest optional version, if newer than <see cref="Main"/>.</summary>
+        public ModEntryVersionModel Optional { get; set; }
+
+        /// <summary>The errors that occurred while fetching update data.</summary>
+        public string[] Errors { get; set; } = new string[0];
+
+        /****
+        ** Backwards-compatible fields
+        ****/
         /// <summary>The mod's latest version number.</summary>
-        public string Version { get; set; }
+        [Obsolete("Use " + nameof(ModEntryModel.Main))]
+        internal string Version { get; private set; }
 
         /// <summary>The mod's web URL.</summary>
-        public string Url { get; set; }
+        [Obsolete("Use " + nameof(ModEntryModel.Main))]
+        internal string Url { get; private set; }
 
         /// <summary>The mod's latest optional release, if newer than <see cref="Version"/>.</summary>
-        public string PreviewVersion { get; set; }
+        [Obsolete("Use " + nameof(ModEntryModel.Optional))]
+        internal string PreviewVersion { get; private set; }
 
         /// <summary>The web URL to the mod's latest optional release, if newer than <see cref="Version"/>.</summary>
-        public string PreviewUrl { get; set; }
+        [Obsolete("Use " + nameof(ModEntryModel.Optional))]
+        internal string PreviewUrl { get; private set; }
 
-        /// <summary>The errors that occurred while fetching update data.</summary>
-        public string[] Errors { get; set; } = new string[0];
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Set backwards-compatible fields.</summary>
+        /// <param name="version">The requested API version.</param>
+        public void SetBackwardsCompatibility(ISemanticVersion version)
+        {
+            if (version.IsOlderThan("2.6-beta.19"))
+            {
+                this.Version = this.Main?.Version?.ToString();
+                this.Url = this.Main?.Url;
+
+                this.PreviewVersion = this.Optional?.Version?.ToString();
+                this.PreviewUrl = this.Optional?.Url;
+            }
+        }
     }
 }
diff --git a/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModEntryVersionModel.cs b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModEntryVersionModel.cs
new file mode 100644
index 00000000..dadb8c10
--- /dev/null
+++ b/src/StardewModdingAPI.Toolkit/Framework/Clients/WebApi/ModEntryVersionModel.cs
@@ -0,0 +1,31 @@
+namespace StardewModdingAPI.Toolkit.Framework.Clients.WebApi
+{
+    /// <summary>Metadata about a version.</summary>
+    public class ModEntryVersionModel
+    {
+        /*********
+        ** Accessors
+        *********/
+        /// <summary>The version number.</summary>
+        public ISemanticVersion Version { get; set; }
+
+        /// <summary>The mod page URL.</summary>
+        public string Url { get; set; }
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Construct an instance.</summary>
+        public ModEntryVersionModel() { }
+
+        /// <summary>Construct an instance.</summary>
+        /// <param name="version">The version number.</param>
+        /// <param name="url">The mod page URL.</param>
+        public ModEntryVersionModel(ISemanticVersion version, string url)
+        {
+            this.Version = version;
+            this.Url = url;
+        }
+    }
+}
diff --git a/src/StardewModdingAPI.Toolkit/Framework/ModData/ModDataRecordVersionedFields.cs b/src/StardewModdingAPI.Toolkit/Framework/ModData/ModDataRecordVersionedFields.cs
index 3601fc53..237f2c66 100644
--- a/src/StardewModdingAPI.Toolkit/Framework/ModData/ModDataRecordVersionedFields.cs
+++ b/src/StardewModdingAPI.Toolkit/Framework/ModData/ModDataRecordVersionedFields.cs
@@ -40,12 +40,15 @@ namespace StardewModdingAPI.Toolkit.Framework.ModData
 
         /// <summary>Get a semantic remote version for update checks.</summary>
         /// <param name="version">The remote version to normalise.</param>
-        public ISemanticVersion GetRemoteVersionForUpdateChecks(string version)
+        public ISemanticVersion GetRemoteVersionForUpdateChecks(ISemanticVersion version)
         {
-            string rawVersion = this.DataRecord.GetRemoteVersionForUpdateChecks(version);
+            if (version == null)
+                return null;
+
+            string rawVersion = this.DataRecord.GetRemoteVersionForUpdateChecks(version.ToString());
             return rawVersion != null
                 ? new SemanticVersion(rawVersion)
-                : null;
+                : version;
         }
     }
 }
-- 
cgit