feat: support for groups added

Author: tngraf

ChangeLog.md

@@ -5,6 +5,7 @@
 * supports FOSSology REST API v1.4.3 (FOSSology 4.0.0 built @ 2023/03/09).
 * new method GetHealth().
 * have `FossologyClient` to be a partial class for better overview.
+* new method GetGroupList().
 
 ## 1.1.0 (2020-06-25)
 * supports FOSSology REST API v1.0.16 (FOSSology 3.8.0 built @ 2020/06/19).

Fossology.Rest.Dotnet.Model/Group.cs

@@ -0,0 +1,42 @@
+// ---------------------------------------------------------------------------
+// <copyright file="Group.cs" company="Tethys">
+//   Copyright (C) 2022 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 Newtonsoft.Json;
+
+    /// <summary>
+    /// Fossology Group information.
+    /// </summary>
+    public class Group
+    {
+        /// <summary>
+        /// Gets or sets the id.
+        /// </summary>
+        [JsonProperty("id")]
+        public int Id { get; set; }
+
+        /// <summary>
+        /// Gets or sets the name.
+        /// </summary>
+        [JsonProperty("name")]
+        public string Name { get; set; }
+
+        /// <inheritdoc />
+        public override string ToString()
+        {
+            return $"{this.Id}: {this.Name}";
+        }
+    } // Group
+}

Fossology.Rest.Dotnet.Test/FossologyClientTest.cs

@@ -708,6 +708,37 @@ public void TestGetHealth()
             Assert.AreEqual("OK", actual.Database.Status);
         }
 
+        /// <summary>
+        /// Unit test.
+        /// </summary>
+        [TestMethod]
+        public void TestGetGroupList()
+        {
+            var client = new FossologyClient(LocalUrl, Token);
+            var actual = client.GetGroupList();
+            Assert.IsNotNull(actual);
+            Assert.IsTrue(actual.Count > 0);
+        }
+
+#if false // not yet supported by Fossology
+        /// <summary>
+        /// Unit test.
+        /// </summary>
+        [TestMethod]
+        public void TestCreateGroup()
+        {
+            const string GroupName = "TestGroup";
+
+            var client = new FossologyClient(LocalUrl, Token);
+            var actual = client.CreateGroup(GroupName);
+            Assert.IsNotNull(actual);
+            //Assert.AreEqual("OK", actual.Status);
+        }
+#endif
+
+        //// ---------------------------------------------------------------------
+
+#region SUPPORT METHODS
         private static void WaitUntilUploadIsDone(FossologyClient client, int id)
         {
             while (!client.IsUploadUnpacked(id))
@@ -755,5 +786,6 @@ private static int FindFolder(IEnumerable<Folder> folderList, string folderName)
 
             return -1;
         } // FindFolder()
+#endregion SUPPORT METHODS
     }
 }

Fossology.Rest.Dotnet/FossologyClientGroup.cs

@@ -0,0 +1,78 @@
+// ---------------------------------------------------------------------------
+// <copyright file="FossologyClientGroup.cs" company="Tethys">
+//   Copyright (C) 2022 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
+{
+    using System.Collections.Generic;
+    using Fossology.Rest.Dotnet.Model;
+
+    using Newtonsoft.Json;
+
+    using RestSharp;
+
+    using JsonSerializer = RestSharp.Serialization.Json.JsonSerializer;
+
+    /// <summary>
+    /// Client for the SW360 REST API.
+    /// </summary>
+    public partial class FossologyClient
+    {
+        /// <summary>
+        /// Gets the list of all groups.
+        /// </summary>
+        /// <returns>A list of <see cref="Group"/> objects.</returns>
+        public IReadOnlyList<Group> GetGroupList()
+        {
+            Log.Debug("Getting list of folder...");
+
+            var request = new RestRequest(this.Url + $"/groups", Method.GET);
+            request.RequestFormat = DataFormat.Json;
+            request.JsonSerializer = new JsonSerializer();
+            request.Parameters.Clear();
+
+            var response = this.api.Execute(request);
+            var list = JsonConvert.DeserializeObject<List<Group>>(
+                response.Content,
+                new JsonSerializerSettings
+                {
+                    NullValueHandling = NullValueHandling.Ignore,
+                });
+            return list;
+        } // GetGroupList()
+
+#if false // not yet supported by Fossology
+        /// <summary>
+        /// Creates a new group.
+        /// </summary>
+        /// <param name="groupName">Name of the group.</param>
+        /// <returns>An <see cref="Result"/> object.</returns>
+        /// <remarks>
+        /// The message property of the result contains the group id
+        /// which is needed for further operations.
+        /// </remarks>>
+        public Result CreateGroup(string groupName)
+        {
+            var request = new RestRequest(this.Url + "/groups", Method.POST);
+            request.RequestFormat = DataFormat.Json;
+            request.AddHeader("groupName", groupName);
+
+            var resultRaw = this.api.Execute(request);
+            var result = JsonConvert.DeserializeObject<Result>(resultRaw.Content);
+            Log.Debug($"Group {result.Message} created.");
+
+            return result;
+        } // CreateGroup()
+#endif
+    } // FossologyClient
+}