feat: enhance folders to support groups

Author: tngraf

ChangeLog.md

@@ -6,6 +6,7 @@
 * new method GetHealth().
 * have `FossologyClient` to be a partial class for better overview.
 * new method GetGroupList().
+* add support for groups for all methods where it did not yet exist.
 
 ## 1.1.0 (2020-06-25)
 * supports FOSSology REST API v1.0.16 (FOSSology 3.8.0 built @ 2020/06/19).

Fossology.Rest.Dotnet/FossologyClientFolder.cs

@@ -21,6 +21,8 @@ namespace Fossology.Rest.Dotnet
 
     using RestSharp;
 
+    using JsonSerializer = RestSharp.Serialization.Json.JsonSerializer;
+
     /// <summary>
     /// Client for the SW360 REST API.
     /// </summary>
@@ -30,14 +32,24 @@ public partial class FossologyClient
         /// Gets the folder with the specified id.
         /// </summary>
         /// <param name="id">The identifier.</param>
+        /// <param name="groupName">The group name to choose.</param>
         /// <returns>A <see cref="Folder"/> object.</returns>
-        public Folder GetFolder(int id)
+        public Folder GetFolder(int id, string groupName = "")
         {
             Log.Debug($"Getting folder {id}...");
 
-            var result = this.api.Get(this.Url + $"/folders/{id}");
+            var request = new RestRequest(this.Url + $"/folders/{id}", Method.GET);
+            request.RequestFormat = DataFormat.Json;
+            request.JsonSerializer = new JsonSerializer();
+            request.Parameters.Clear();
+            if (!string.IsNullOrEmpty(groupName))
+            {
+                request.AddHeader("groupName", groupName);
+            } // if
+
+            var response = this.api.Execute(request);
             var folder = JsonConvert.DeserializeObject<Folder>(
-                result.Content,
+                response.Content,
                 new JsonSerializerSettings
                     {
                         NullValueHandling = NullValueHandling.Ignore,
@@ -48,14 +60,24 @@ public Folder GetFolder(int id)
         /// <summary>
         /// Gets the list of all folders.
         /// </summary>
+        /// <param name="groupName">The group name to choose.</param>
         /// <returns>A list of <see cref="Folder"/> objects.</returns>
-        public IReadOnlyList<Folder> GetFolderList()
+        public IReadOnlyList<Folder> GetFolderList(string groupName = "")
         {
             Log.Debug("Getting list of folder...");
 
-            var result = this.api.Get(this.Url + "/folders");
+            var request = new RestRequest(this.Url + $"/folders", Method.GET);
+            request.RequestFormat = DataFormat.Json;
+            request.JsonSerializer = new JsonSerializer();
+            request.Parameters.Clear();
+            if (!string.IsNullOrEmpty(groupName))
+            {
+                request.AddHeader("groupName", groupName);
+            } // if
+
+            var response = this.api.Execute(request);
             var list = JsonConvert.DeserializeObject<List<Folder>>(
-                result.Content,
+                response.Content,
                 new JsonSerializerSettings
                 {
                     NullValueHandling = NullValueHandling.Ignore,
@@ -68,17 +90,28 @@ public IReadOnlyList<Folder> GetFolderList()
         /// </summary>
         /// <param name="folderName">Name of the folder.</param>
         /// <param name="parentFolder">The parent folder.</param>
+        /// <param name="description">The folder description (optional).</param>
+        /// <param name="groupName">The group name to choose (optional).</param>
         /// <returns>An <see cref="Result"/> object.</returns>
         /// <remarks>
         /// The message property of the result contains the folder id
         /// which is needed for further operations.
         /// </remarks>>
-        public Result CreateFolder(string folderName, int parentFolder)
+        public Result CreateFolder(string folderName, int parentFolder, string description = "", string groupName = "")
         {
             var request = new RestRequest(this.Url + "/folders", Method.POST);
             request.RequestFormat = DataFormat.Json;
             request.AddHeader("parentFolder", parentFolder.ToString());
             request.AddHeader("folderName", folderName);
+            if (!string.IsNullOrEmpty(description))
+            {
+                request.AddHeader("description", description);
+            } // if
+
+            if (!string.IsNullOrEmpty(groupName))
+            {
+                request.AddHeader("groupName", groupName);
+            } // if
 
             var resultRaw = this.api.Execute(request);
             var result = JsonConvert.DeserializeObject<Result>(resultRaw.Content);
@@ -91,12 +124,22 @@ public Result CreateFolder(string folderName, int parentFolder)
         /// Deletes the folder with the specified id.
         /// </summary>
         /// <param name="id">The identifier.</param>
+        /// <param name="groupName">The group name to choose.</param>
         /// <returns>An <see cref="Result"/> object.</returns>
-        public Result DeleteFolder(int id)
+        public Result DeleteFolder(int id, string groupName = "")
         {
             Log.Debug($"Deleting folder {id}...");
 
-            var response = this.api.Delete(this.Url + $"/folders/{id}");
+            var request = new RestRequest(this.Url + $"/folders/{id}", Method.DELETE);
+            request.RequestFormat = DataFormat.Json;
+            request.JsonSerializer = new JsonSerializer();
+            request.Parameters.Clear();
+            if (!string.IsNullOrEmpty(groupName))
+            {
+                request.AddHeader("groupName", groupName);
+            } // if
+
+            var response = this.api.Execute(request);
             var result = JsonConvert.DeserializeObject<Result>(response.Content);
             return result;
         } // DeleteFolder()