feat: new GetUploadCopyrights to get the copyrights for an upload

Author: tngraf

ChangeLog.md

@@ -6,6 +6,7 @@
     * support new maintenance endpoint.
     * support new upload features.
     * new `GetUploadFileById` to download an upload file.
+    * new `GetUploadCopyrights` to get the copyrights for an upload.
 
 ## 1.3.0 (2022-12-30)
 

Fossology.Rest.Dotnet.Model/CopyrightEntry.cs

@@ -0,0 +1,52 @@
+// ---------------------------------------------------------------------------
+// <copyright file="CopyrightEntry.cs" company="Tethys">
+//   Copyright (C) 2023 T. Graf
+// </copyright>
+//
+// Licensed under the MIT License.
+// SPDX-License-Identifier: MIT
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+// either express or implied.
+// ---------------------------------------------------------------------------
+
+namespace Fossology.Rest.Dotnet.Model
+{
+    using System.Collections.Generic;
+
+    using Newtonsoft.Json;
+
+    /// <summary>
+    /// Information about a single copyright.
+    /// </summary>
+    public class CopyrightEntry
+    {
+        /// <summary>
+        /// Gets or sets the copyright statement.
+        /// </summary>
+        [JsonProperty("copyright")]
+        public string Copyright { get; set; }
+
+        /// <summary>
+        /// Gets or sets the list of files where the copyright was found.
+        /// </summary>
+        [JsonProperty("filePath")]
+        public List<string> FilePath { get; set; }
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="CopyrightEntry"/> class.
+        /// </summary>
+        public CopyrightEntry()
+        {
+            this.FilePath = new List<string>();
+        } // CopyrightEntry()
+
+        /// <inheritdoc />
+        public override string ToString()
+        {
+            return $"#{this.FilePath.Count}: {this.Copyright}";
+        } // ToString()
+    } // CopyrightEntry
+}

Fossology.Rest.Dotnet.Test/FossologyClientTest.cs

@@ -497,6 +497,42 @@ public void TestGetUploadFileById()
             Assert.AreEqual(200, result.Code);
         }
 
+        /// <summary>
+        /// Unit test.
+        /// </summary>
+        [TestMethod]
+        public void TestGetUploadCopyrights()
+        {
+#if true
+            var uploadId = FindUpload(PackageName2);
+            if (uploadId < 0)
+            {
+                this.TestUploadPackageFromUrl();
+                // ugly but required: wait some time until report is available
+                Thread.Sleep(3000);
+                uploadId = FindUpload(PackageName2);
+            } // if
+
+            UploadPackageAndRunJobs(uploadId);
+#else
+            // use a specific upload
+            var uploadId = 111;
+#endif
+
+            var client = new FossologyClient(LocalUrl, Token);
+            var copyrights = client.GetUploadCopyrights(uploadId);
+            Assert.IsNotNull(copyrights);
+
+            Assert.AreEqual(10, copyrights.Count);
+            Assert.AreEqual(
+                "copyright owner or by an individual or Legal Entity authorized to submit on behalf of",
+                copyrights[0].Copyright);
+            Assert.AreEqual(1, copyrights[0].FilePath.Count);
+            Assert.AreEqual(
+                "Tethys.xml_v1.0.0.zip/Tethys.Xml-1.0.0/LICENSE",
+                copyrights[0].FilePath[0]);
+        }
+
         /// <summary>
         /// Unit test.
         /// </summary>

Fossology.Rest.Dotnet/FossologyClientUpload.cs

@@ -446,7 +446,7 @@ public IReadOnlyList<Upload> GetUploadList(string groupName = "")
         } // GetUploadList()
 
         /// <summary>
-        /// Gets the summary for the upload with the specified id.
+        /// Gets the licenses for an upload.
         /// </summary>
         /// <param name="id">The identifier.</param>
         /// <param name="agent">Agent name, one of (nomos, monk, ninka, ojo, scancode).</param>
@@ -545,5 +545,32 @@ public Result GetUploadFileById(int id, string filename)
 
             return result;
         } // GetUploadFileById()
+
+        /// <summary>
+        /// Gets the coüpyright for an upload.
+        /// </summary>
+        /// <param name="id">The identifier.</param>
+        /// <returns>A list of <see cref="CopyrightEntry" /> objects.</returns>
+        public List<CopyrightEntry> GetUploadCopyrights(int id)
+        {
+            Log.Debug($"Getting upload copyrights for upload {id}...");
+
+            var request = new RestRequest(this.Url + $"/uploads/{id}/copyrights");
+            request.RequestFormat = DataFormat.Json;
+            var response = this.api.Execute(request);
+            if (response?.Content == null)
+            {
+                throw new FossologyApiException(ErrorCode.NoValidAnswer);
+            } // if
+
+            var summary = JsonConvert.DeserializeObject<List<CopyrightEntry>>(
+                response.Content,
+                new JsonSerializerSettings
+                {
+                    NullValueHandling = NullValueHandling.Ignore,
+                });
+
+            return summary;
+        } // GetUploadCopyrights()
     } // FossologyClient
 }