From 89da76b72f9e5f64580d98d5bcc4217d72a5f29f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Lo=C3=AFc=20Sharma?= <sharma.loic@gmail.com>
Date: Thu, 13 Feb 2020 21:57:12 -0800
Subject: [PATCH] [Client SDK] Add package deprecation (#471)

Addresses https://github.com/loic-sharma/baget/issues/395
---
 src/BaGet.Protocol/Models/AlternatePackage.cs | 31 +++++++++++++++
 .../Models/PackageDeprecation.cs              | 38 +++++++++++++++++++
 src/BaGet.Protocol/Models/PackageMetadata.cs  | 18 ++++++---
 .../RawPackageMetadataClientTests.cs          |  7 ++++
 4 files changed, 88 insertions(+), 6 deletions(-)
 create mode 100644 src/BaGet.Protocol/Models/AlternatePackage.cs
 create mode 100644 src/BaGet.Protocol/Models/PackageDeprecation.cs

diff --git a/src/BaGet.Protocol/Models/AlternatePackage.cs b/src/BaGet.Protocol/Models/AlternatePackage.cs
new file mode 100644
index 00000000..6699c240
--- /dev/null
+++ b/src/BaGet.Protocol/Models/AlternatePackage.cs
@@ -0,0 +1,31 @@
+using System.Collections.Generic;
+using Newtonsoft.Json;
+
+namespace BaGet.Protocol.Models
+{
+    /// <summary>
+    /// The alternate package that should be used instead of a deprecated package.
+    /// 
+    /// See https://docs.microsoft.com/en-us/nuget/api/registration-base-url-resource#package-deprecation
+    /// </summary>
+    public class AlternatePackage
+    {
+        [JsonProperty("@id")]
+        public string Url { get; set; }
+
+        [JsonProperty("@type")]
+        public string Type { get; set; }
+
+        /// <summary>
+        /// The ID of the alternate package.
+        /// </summary>
+        [JsonProperty("id")]
+        public string Id { get; set; }
+
+        /// <summary>
+        /// The allowed version range, or * if any version is allowed.
+        /// </summary>
+        [JsonProperty("range")]
+        public string Range { get; set; }
+    }
+}
diff --git a/src/BaGet.Protocol/Models/PackageDeprecation.cs b/src/BaGet.Protocol/Models/PackageDeprecation.cs
new file mode 100644
index 00000000..c00a986c
--- /dev/null
+++ b/src/BaGet.Protocol/Models/PackageDeprecation.cs
@@ -0,0 +1,38 @@
+using System.Collections.Generic;
+using Newtonsoft.Json;
+
+namespace BaGet.Protocol.Models
+{
+    /// <summary>
+    /// A package's metadata.
+    /// 
+    /// See https://docs.microsoft.com/en-us/nuget/api/registration-base-url-resource#package-deprecation
+    /// </summary>
+    public class PackageDeprecation
+    {
+        /// <summary>
+        /// The URL to the document used to produce this object.
+        /// </summary>
+        [JsonProperty("@id")]
+        public string CatalogLeafUrl { get; set; }
+
+        /// <summary>
+        /// The reasons why the package was deprecated.
+        /// Deprecation reasons include: "Legacy", "CriticalBugs", and "Other".
+        /// </summary>
+        [JsonProperty("reasons")]
+        public IReadOnlyList<string> Reasons { get; set; }
+
+        /// <summary>
+        /// The additional details about this deprecation.
+        /// </summary>
+        [JsonProperty("message")]
+        public string Message { get; set; }
+
+        /// <summary>
+        /// The alternate package that should be used instead.
+        /// </summary>
+        [JsonProperty("alternatePackage")]
+        public AlternatePackage AlternatePackage { get; set; }
+    }
+}
diff --git a/src/BaGet.Protocol/Models/PackageMetadata.cs b/src/BaGet.Protocol/Models/PackageMetadata.cs
index 1b570f77..044e3f51 100644
--- a/src/BaGet.Protocol/Models/PackageMetadata.cs
+++ b/src/BaGet.Protocol/Models/PackageMetadata.cs
@@ -35,6 +35,18 @@ public class PackageMetadata
         [JsonProperty("authors")]
         public string Authors { get; set; }
 
+        /// <summary>
+        /// The dependencies of the package, grouped by target framework.
+        /// </summary>
+        [JsonProperty("dependencyGroups")]
+        public IReadOnlyList<DependencyGroupItem> DependencyGroups { get; set; }
+
+        /// <summary>
+        /// The deprecation associated with the package, if any.
+        /// </summary>
+        [JsonProperty("deprecation")]
+        public PackageDeprecation Deprecation { get; set; }
+
         /// <summary>
         /// The package's description.
         /// </summary>
@@ -113,11 +125,5 @@ public class PackageMetadata
         /// </summary>
         [JsonProperty("title")]
         public string Title { get; set; }
-
-        /// <summary>
-        /// The dependencies of the package, grouped by target framework.
-        /// </summary>
-        [JsonProperty("dependencyGroups")]
-        public IReadOnlyList<DependencyGroupItem> DependencyGroups { get; set; }
     }
 }
diff --git a/tests/BaGet.Protocol.Tests/RawPackageMetadataClientTests.cs b/tests/BaGet.Protocol.Tests/RawPackageMetadataClientTests.cs
index b79e521a..97c727b9 100644
--- a/tests/BaGet.Protocol.Tests/RawPackageMetadataClientTests.cs
+++ b/tests/BaGet.Protocol.Tests/RawPackageMetadataClientTests.cs
@@ -72,6 +72,13 @@ public async Task GetRegistrationPage()
             Assert.Equal("2.0.0+build", firstMetadata.Version);
         }
 
+        [Fact]
+        public async Task GetRegistrationPageDeprecated()
+        {
+            // TODO
+            await Task.Yield();
+        }
+
         [Fact]
         public async Task GetsRegistrationLeaf()
         {