feat: new method GetInfo()

Author: tngraf

ChangeLog.md

@@ -7,6 +7,7 @@
 * 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.
+* new method GetInfo().
 
 ## 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/AppInfo.cs

@@ -0,0 +1,66 @@
+// ---------------------------------------------------------------------------
+// <copyright file="AppInfo.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 application information.
+    /// </summary>
+    public class AppInfo
+    {
+        /// <summary>
+        /// Gets or sets the name.
+        /// </summary>
+        [JsonProperty("name")]
+        public string Name { get; set; }
+
+        /// <summary>
+        /// Gets or sets the description.
+        /// </summary>
+        [JsonProperty("description")]
+        public string Description { get; set; }
+
+        /// <summary>
+        /// Gets or sets the version.
+        /// </summary>
+        [JsonProperty("version")]
+        public string Version { get; set; }
+
+        /// <summary>
+        /// Gets or sets the contact information.
+        /// </summary>
+        [JsonProperty("contact")]
+        public string Contact { get; set; }
+
+        /// <summary>
+        /// Gets or sets the Fossology license information.
+        /// </summary>
+        [JsonProperty("license")]
+        public FossologyLicense FossologyLicense { get; set; }
+
+        /// <summary>
+        /// Gets or sets the Fossology information.
+        /// </summary>
+        [JsonProperty("fossology")]
+        public FossologyInfo FossologyInfo { get; set; }
+
+        /// <inheritdoc />
+        public override string ToString()
+        {
+            return $"{this.Name}, {this.Version}";
+        }
+    } // AppInfo
+}

Fossology.Rest.Dotnet.Model/FossologyInfo.cs

@@ -0,0 +1,60 @@
+// ---------------------------------------------------------------------------
+// <copyright file="FossologyInfo.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 information.
+    /// </summary>
+    public class FossologyInfo
+    {
+        /// <summary>
+        /// Gets or sets the version.
+        /// </summary>
+        [JsonProperty("version")]
+        public string Version { get; set; }
+
+        /// <summary>
+        /// Gets or sets the branch name.
+        /// </summary>
+        [JsonProperty("branchName")]
+        public string BranchName { get; set; }
+
+        /// <summary>
+        /// Gets or sets the commit hash.
+        /// </summary>
+        [JsonProperty("commitHash")]
+        public string CommitHash { get; set; }
+
+        /// <summary>
+        /// Gets or sets the commit date.
+        /// </summary>
+        [JsonProperty("commitDate")]
+        public string CommitDate { get; set; }
+
+        /// <summary>
+        /// Gets or sets the build date.
+        /// </summary>
+        [JsonProperty("buildDate")]
+        public string BuildDate { get; set; }
+
+        /// <inheritdoc />
+        public override string ToString()
+        {
+            return $"{this.Version}, {this.BranchName}, parent={this.CommitHash}, {this.CommitDate}, {this.BuildDate}";
+        }
+    } // FossologyInfo
+}

Fossology.Rest.Dotnet.Model/FossologyLicense.cs

@@ -0,0 +1,42 @@
+// ---------------------------------------------------------------------------
+// <copyright file="FossologyLicense.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 license information.
+    /// </summary>
+    public class FossologyLicense
+    {
+        /// <summary>
+        /// Gets or sets the name.
+        /// </summary>
+        [JsonProperty("name")]
+        public string Name { get; set; }
+
+        /// <summary>
+        /// Gets or sets the url.
+        /// </summary>
+        [JsonProperty("url")]
+        public string Url { get; set; }
+
+        /// <inheritdoc />
+        public override string ToString()
+        {
+            return $"{this.Name}, {this.Url}";
+        }
+    } // FossologyLicense
+}

Fossology.Rest.Dotnet.Test/FossologyClientTest.cs

@@ -28,9 +28,10 @@ namespace Fossology.Rest.Dotnet.Test
     using Tethys.Logging.Console;
 
     // NOTE:
-    // If you just run all tests, a number of them will fail.
-    // This is just because the test will be run in random order ... and if
-    // for example a folder has not yet been created it will be impossible to delete it.
+    // 1. Prior to running test, valid token information needs to be provided.
+    // 2. If you just run all tests, a number of them will fail.
+    //    This is just because the test will be run in random order ... and if
+    //    for example a folder has not yet been created it will be impossible to delete it.
 
     /// <summary>
     /// Unit test class.
@@ -48,7 +49,7 @@ public class FossologyClientTest
         /// <summary>
         /// The access token.
         /// </summary>
-        private const string Token = "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE2NDc0NzUxOTksIm5iZiI6MTY0NzEyOTYwMCwianRpIjoiTWk0eiIsInNjb3BlIjoid3JpdGUifQ.AKflkhB4194sjPAxMrse3kyBAeMdnGjtQzZZGsYRqMI";
+        private const string Token = "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE2NDc1NjE1OTksIm5iZiI6MTY0NzIxNjAwMCwianRpIjoiTWk0eiIsInNjb3BlIjoid3JpdGUifQ.VoBawVZLVEBUs75EEN39L_ml7ZuQhRsJVTWxtxGC26I";
 
         /// <summary>
         /// The filename of a test package.
@@ -708,6 +709,21 @@ public void TestGetHealth()
             Assert.AreEqual("OK", actual.Database.Status);
         }
 
+        /// <summary>
+        /// Unit test.
+        /// </summary>
+        [TestMethod]
+        public void TestGetInfo()
+        {
+            var client = new FossologyClient(LocalUrl, Token);
+            var actual = client.GetInfo();
+            Assert.IsNotNull(actual);
+            Assert.AreEqual("FOSSology API", actual.Name);
+            Assert.AreEqual("[email protected]", actual.Contact);
+            Assert.AreEqual("GPL-2.0-only", actual.FossologyLicense.Name);
+            Assert.AreEqual("master", actual.FossologyInfo.BranchName);
+        }
+
         /// <summary>
         /// Unit test.
         /// </summary>

Fossology.Rest.Dotnet/FossologyClientInfo.cs

@@ -0,0 +1,44 @@
+// ---------------------------------------------------------------------------
+// <copyright file="FossologyClientInfo.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 Fossology.Rest.Dotnet.Model;
+
+    using Newtonsoft.Json;
+
+    /// <summary>
+    /// Client for the SW360 REST API.
+    /// </summary>
+    public partial class FossologyClient
+    {
+        /// <summary>
+        /// Gets the Fossology information.
+        /// </summary>
+        /// <returns><see cref="AppInfo"/>.</returns>
+        public AppInfo GetInfo()
+        {
+            Log.Debug($"Getting Fossology info...");
+
+            var result = this.api.Get(this.Url + "/info");
+            var info = JsonConvert.DeserializeObject<AppInfo>(
+                result.Content,
+                new JsonSerializerSettings
+                {
+                    NullValueHandling = NullValueHandling.Ignore,
+                });
+            return info;
+        } // GetInfo()
+    } // FossologyClient
+}