Updates for REST API version 1.0.16

Author: tngraf

ChangeLog.md

@@ -0,0 +1,28 @@
+# ChangeLog - FOSSology.REST.dotnet
+
+## 1.1.0 (NEXT)
+* supports FOSSOlogy REST API v1.0.16 (FOSSology 3.8.0).
+* ?? /uploads/{id}/summary:
+* ?? /uploads/{id}/licenses:
+* ?? search using groupName
+* ?? new param groupName for report generation
+* ?? ojo for license decider
+
+* new method GetToken().
+* new method UploadPackageFromUrl().
+* new method UploadPackageFromVcs().
+* new method UploadPackageFromServer() (not tested).
+* new method GetUploadSummary()
+* new method GetUploadLicenses()
+* new class UploadSummary.
+* new class UploadLicenses.
+* new class VcsUpload.
+* new class ServerUpload.
+* new class UrlUpload.
+* class Upload has new property FileSha1
+* Integration test improved.
+    
+
+## 1.0.0 (2020-11-24)
+* first version released.
+* supports FOSSOlogy REST API v1.0.3 (FOSSology 3.7.0).

Fossology.Rest.Dotnet.Model/Analysis.cs

@@ -0,0 +1,80 @@
+#region Header
+// ---------------------------------------------------------------------------
+// <copyright file="Analysis.cs" company="Tethys">
+//   Copyright (C) 2020 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.
+// ---------------------------------------------------------------------------
+#endregion
+
+namespace Fossology.Rest.Dotnet.Model
+{
+    using Newtonsoft.Json;
+
+    /// <summary>
+    /// Trigger analysis information.
+    /// </summary>
+    public class Analysis
+    {
+        /// <summary>
+        /// Gets or sets a value indicating whether to use the bucket.
+        /// </summary>
+        [JsonProperty("bucket")]
+        public bool Bucket { get; set; }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether to use copyright email author.
+        /// </summary>
+        [JsonProperty("copyright_email_author")]
+        public bool CopyrightEmailAuthor { get; set; }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether to use the ecc scanner.
+        /// </summary>
+        [JsonProperty("ecc")]
+        public bool Ecc { get; set; }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether to use the keyword scanner.
+        /// </summary>
+        [JsonProperty("keyword")]
+        public bool Keyword { get; set; }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether to use the mime scanner.
+        /// </summary>
+        [JsonProperty("mime")]
+        public bool Mime { get; set; }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether to use the monk scanner.
+        /// </summary>
+        [JsonProperty("monk")]
+        public bool Monk { get; set; }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether to use the nomos scanner.
+        /// </summary>
+        [JsonProperty("nomos")]
+        public bool Nomos { get; set; }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether to use the <c>ojo</c> scanner.
+        /// </summary>
+        [JsonProperty("ojo")]
+        public bool Ojo { get; set; }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether to use the package scanner.
+        /// </summary>
+        [JsonProperty("package")]
+        public bool Package { get; set; }
+    } // Analysis
+}

Fossology.Rest.Dotnet.Model/Fossology.Rest.dotnet.Model.csproj

@@ -34,10 +34,21 @@
   <ItemGroup>
     <Reference Include="System" />
     <Reference Include="System.Core" />
-    <Reference Include="System.Runtime.Serialization" />
   </ItemGroup>
   <ItemGroup>
+    <Compile Include="..\GlobalAssemblyInfo.cs">
+      <Link>Properties\GlobalAssemblyInfo.cs</Link>
+    </Compile>
     <Compile Include="SearchResult.cs" />
+    <Compile Include="Analysis.cs" />
+    <Compile Include="Support.cs" />
+    <Compile Include="TokenResponse.cs" />
+    <Compile Include="TokenRequest.cs" />
+    <Compile Include="UploadSummary.cs" />
+    <Compile Include="UploadLicenses.cs" />
+    <Compile Include="VcsUpload.cs" />
+    <Compile Include="ServerUpload.cs" />
+    <Compile Include="UrlUpload.cs" />
     <Compile Include="Upload.cs" />
     <Compile Include="User.cs" />
     <Compile Include="TriggerInfo.cs" />

Fossology.Rest.Dotnet.Model/Properties/AssemblyInfo.cs

@@ -1,7 +1,7 @@
 #region Header
 // ---------------------------------------------------------------------------
 // <copyright file="AssemblyInfo.cs" company="Tethys">
-//   Copyright (C) 2019 T. Graf
+//   Copyright (C) 2019-2020 T. Graf
 // </copyright>
 //
 // Licensed under the MIT License.
@@ -23,11 +23,7 @@
 [assembly: AssemblyTitle("Fossology.Rest.Dotnet.Model")]
 [assembly: AssemblyDescription("")]
 [assembly: AssemblyConfiguration("")]
-[assembly: AssemblyCompany("")]
 [assembly: AssemblyProduct("Fossology.Rest.Dotnet.Model")]
-[assembly: AssemblyCopyright("Copyright © 2019 T. Graf")]
-[assembly: AssemblyTrademark("")]
-[assembly: AssemblyCulture("")]
 
 // Setting ComVisible to false makes the types in this assembly not visible
 // to COM components.  If you need to access a type in this assembly from
@@ -36,7 +32,3 @@
 
 // The following GUID is for the ID of the typelib if this project is exposed to COM
 [assembly: Guid("396e05c3-9ad3-4d1b-8e0b-8c24c6c490eb")]
-
-// Version information for an assembly consists of the following four values:
-[assembly: AssemblyVersion("1.0.0.0")]
-[assembly: AssemblyFileVersion("1.0.0.0")]

Fossology.Rest.Dotnet.Model/ServerUpload.cs

@@ -0,0 +1,47 @@
+#region Header
+// ---------------------------------------------------------------------------
+// <copyright file="ServerUpload.cs" company="Tethys">
+//   Copyright (C) 2020 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.
+// ---------------------------------------------------------------------------
+#endregion
+
+namespace Fossology.Rest.Dotnet.Model
+{
+    using Newtonsoft.Json;
+
+    /// <summary>
+    /// Information to create an upload from a server.
+    /// </summary>
+    /// <remarks>
+    /// </remarks>
+    public class ServerUpload
+    {
+        /// <summary>
+        /// Gets or sets the file path to be uploaded (recursive, supports *).
+        /// </summary>
+        [JsonProperty("path")]
+        public string Path { get; set; }
+
+        /// <summary>
+        /// Gets or sets the viewable name for this file or directory.
+        /// </summary>
+        [JsonProperty("name")]
+        public string Name { get; set; }
+
+       
+        /// <inheritdoc />
+        public override string ToString()
+        {
+            return $"{this.Name}: {this.Path}";
+        } // ToString()
+    } // ServerUpload
+}

Fossology.Rest.Dotnet.Model/Support.cs

@@ -0,0 +1,42 @@
+#region Header
+// ---------------------------------------------------------------------------
+// <copyright file="Support.cs" company="Tethys">
+//   Copyright (C) 2020 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.
+// ---------------------------------------------------------------------------
+#endregion
+
+namespace Fossology.Rest.Dotnet.Model
+{
+    using System.Collections.Generic;
+
+    /// <summary>
+    /// Support methods.
+    /// </summary>
+    public class Support
+    {
+        /// <summary>
+        /// List to string.
+        /// </summary>
+        /// <param name="list">The list.</param>
+        /// <returns>A single string.</returns>
+        public static string ListToString(IReadOnlyList<string> list)
+        {
+            if (list == null)
+            {
+                return string.Empty;
+            } // if
+
+            var joined = string.Join(",", list);
+            return joined;
+        } // ListToString()
+    } // Support
+}

Fossology.Rest.Dotnet.Model/TokenRequest.cs

@@ -0,0 +1,66 @@
+#region Header
+// ---------------------------------------------------------------------------
+// <copyright file="TokenRequest.cs" company="Tethys">
+//   Copyright (C) 2020 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.
+// ---------------------------------------------------------------------------
+#endregion
+
+namespace Fossology.Rest.Dotnet.Model
+{
+    using Newtonsoft.Json;
+
+    /// <summary>
+    /// Information to create an access token.
+    /// </summary>
+    /// <remarks>
+    /// </remarks>
+    public class TokenRequest
+    {
+        /// <summary>
+        /// Gets or sets the user name.
+        /// </summary>
+        [JsonProperty("username")]
+        public string Username { get; set; }
+
+        /// <summary>
+        /// Gets or sets the password.
+        /// </summary>
+        [JsonProperty("password")]
+        public string Password { get; set; }
+
+        /// <summary>
+        /// Gets or sets the token name.
+        /// </summary>
+        [JsonProperty("token_name")]
+        public string TokenName { get; set; }
+
+        /// <summary>
+        /// Gets or sets the token scope, one of (read, write).
+        /// </summary>
+        [JsonProperty("token_scope")]
+        public string TokenScope { get; set; }
+
+        /// <summary>
+        /// Gets or sets the token expiry date.
+        /// </summary>
+        /// <remarks>Date format is yyyy-mm-dd.</remarks>
+        [JsonProperty("token_expire")]
+        public string TokenExpire { get; set; }
+
+       
+        /// <inheritdoc />
+        public override string ToString()
+        {
+            return $"{this.TokenName}: {this.Username}, {this.Password}, {this.TokenScope}, {this.TokenExpire}";
+        } // ToString()
+    } // TokenRequest
+}

Fossology.Rest.Dotnet.Model/TokenResponse.cs

@@ -0,0 +1,67 @@
+#region Header
+// ---------------------------------------------------------------------------
+// <copyright file="TokenResponse.cs" company="Tethys">
+//   Copyright (C) 2020 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.
+// ---------------------------------------------------------------------------
+#endregion
+
+namespace Fossology.Rest.Dotnet.Model
+{
+    using Newtonsoft.Json;
+
+    /// <summary>
+    /// Data returned by a token generation request.
+    /// </summary>
+    /// <remarks>
+    /// </remarks>
+    public class TokenResponse
+    {
+        #region PUBLIC PROPERTIES
+        /// <summary>
+        /// Gets or sets the authorization value.
+        /// </summary>
+        [JsonProperty("Authorization")]
+        public string Authorization { get; set; }
+        #endregion // PUBLIC PROPERTIES
+
+        //// ---------------------------------------------------------------------
+
+        #region PUBLIC METHODS        
+        /// <summary>
+        /// Gets the plain token.
+        /// </summary>
+        /// <returns>The token.</returns>
+        public string GetPlainToken()
+        {
+            if (string.IsNullOrEmpty(this.Authorization))
+            {
+                return string.Empty;
+            } // if
+
+            var token = this.Authorization.Substring("Bearer ".Length);
+            return token;
+        } // GetPlainToken()
+
+        /// <inheritdoc />
+        public override string ToString()
+        {
+            return $"{this.Authorization}";
+        } // ToString()
+        #endregion // PUBLIC METHODS
+
+        //// ---------------------------------------------------------------------
+
+        #region PRIVATE METHODS
+        #endregion // PRIVATE METHODS
+
+    } // ServerUpload
+}