Merge pull request #1168 from dlcs/feature/supportProvides

Add provides to adjunct

Author: JackLewis-digirati

src/protagonist/API.Tests/Integration/AdjunctTests.cs

@@ -67,6 +67,7 @@ public async Task PostAdjunct_CreatesExternalAdjunct()
                                                 "mediaType": "a-mediaType",
                                                 "label": {"label": ["value"]},
                                                 "motivation": "a motivation",
+                                                "provides": "translation",
                                                 "language": ["en"],
                                               }
                                       """;
@@ -90,6 +91,7 @@ public async Task PostAdjunct_CreatesExternalAdjunct()
         adjunct.ExternalId.Should().Be("https://some-location.com/an-adjunct");
         adjunct.PublicId.Should().Be("https://some-location.com/an-adjunct");
         adjunct.Motivation.Should().Be("a motivation");
+        adjunct.Provides.Should().Be("translation");
 
         response.Headers.Location.Should()
             .Be(
@@ -580,7 +582,7 @@ public async Task PutAdjunct_UpdatesAdjunct_WhenIdAlreadyExists()
         // Arrange
         var assetId = AssetIdGenerator.GetAssetId();
         await dbContext.Images.AddTestAsset(assetId)
-            .WithTestAdjunct("someAdjunctId", created: DateTime.UtcNow.AddDays(-2), motivation: "something");
+            .WithTestAdjunct("someAdjunctId", created: DateTime.UtcNow.AddDays(-2), motivation: "something", provides: "something");
         await dbContext.SaveChangesAsync();
 
         const string updateAdjunctJson = """
@@ -592,7 +594,8 @@ await dbContext.Images.AddTestAsset(assetId)
                                                    "mediaType": "a-mediaType",
                                                    "label": {"label": ["value"]},
                                                    "language": ["en"],
-                                                   "motivation": "changed"
+                                                   "motivation": "changed",
+                                                   "provides": "changed"
                                                  }
                                          """;
 
@@ -617,6 +620,7 @@ await dbContext.Images.AddTestAsset(assetId)
         adjunct.ExternalId.Should().Be("https://some-location.com/an-adjunct");
         adjunct.PublicId.Should().Be("https://some-location.com/an-adjunct");
         adjunct.Motivation.Should().Be("changed");
+        adjunct.Provides.Should().Be("changed");
 
         A.CallTo(() => DeliverableNotificationSender.SendDeliverableModifiedMessage(
             A<NotificationRecord<DLCS.Model.Assets.Adjunct>>.That.Matches(r => r.ChangeType == ChangeType.Update && r.After.AssetId == assetId), 

src/protagonist/API/Converters/AdjunctConverter.cs

@@ -48,6 +48,7 @@ public static Adjunct ToDlcsModel(this DLCS.HydraModel.Adjunct hydraAdjunct, int
             Language = hydraAdjunct.Language,
             Size = hydraAdjunct.Size,
             Motivation = hydraAdjunct.Motivation,
+            Provides = hydraAdjunct.Provides,
         };
 
         if (hydraAdjunct.Origin is not null)
@@ -87,6 +88,7 @@ public static DLCS.HydraModel.Adjunct ToHydra(this Adjunct adjunct, UrlRoots url
             Size = adjunct.Size,
             Error = adjunct.Error,
             Motivation = adjunct.Motivation,
+            Provides =  adjunct.Provides,
             Ingesting = adjunct.Ingesting
         };
 }

src/protagonist/API/Features/Adjuncts/Requests/CreateOrUpdateAdjunct.cs

@@ -83,6 +83,7 @@ public async Task<ModifyEntityResult<Adjunct>> Handle(CreateOrUpdateAdjunct requ
             dbAdjunct.Error = adjunct.Error;
             dbAdjunct.Type = adjunct.Type;
             dbAdjunct.Motivation =  adjunct.Motivation;
+            dbAdjunct.Provides = adjunct.Provides;
             dbAdjunct.Ingesting = adjunct.Ingesting;
         }
         else

src/protagonist/DLCS.HydraModel/Adjunct.cs

@@ -91,13 +91,18 @@ public Adjunct(string baseUrl, int customerId, int space, string assetId, string
     [JsonProperty(Order = 24, PropertyName = "motivation")]
     public string? Motivation { get; set; }
 
+    [RdfProperty(Description = "An additional set of features or functionality this adjunct provides.",
+    Range = Names.XmlSchema.String, ReadOnly = false, WriteOnly = false)]
+    [JsonProperty(Order = 25, PropertyName = "provides")]
+    public string? Provides { get; set; }
+    
     [RdfProperty(Description = "Whether the adjunct is currently being ingested.",
         Range = Names.XmlSchema.Boolean, ReadOnly = true, WriteOnly = false)]
-    [JsonProperty(Order = 25, PropertyName = "ingesting")]
+    [JsonProperty(Order = 26, PropertyName = "ingesting")]
     public bool? Ingesting { get; set; }
 
     [RdfProperty(Description = "Reported errors with this adjunct.",
         Range = Names.XmlSchema.String, ReadOnly = false, WriteOnly = false)]
-    [JsonProperty(Order = 26, PropertyName = "error")]
+    [JsonProperty(Order = 27, PropertyName = "error")]
     public string? Error { get; set; }
 }

src/protagonist/DLCS.Model/Assets/Adjunct.cs

@@ -90,6 +90,11 @@ public class Adjunct : IDeliverable
     /// The reason why this adjunct exists.
     /// </summary>
     public string? Motivation { get; set; }
+    
+    /// <summary>
+    /// An additional set of features or functionality this adjunct provides
+    /// </summary>
+    public string? Provides { get; set; }
 
     public Asset Asset { get; set; } = null!;