Merge pull request #27 from contentstack/next

nadeem-cs · web-flow · commit 634208c2461c · 2024-01-23T20:46:04.000+05:30
EarlyAccess Header support and AddQuery method in ParamCollection
diff --git a/.github/workflows/sast-scan.yml b/.github/workflows/sast-scan.yml
diff --git a/.github/workflows/secrets-scan.yml b/.github/workflows/secrets-scan.yml
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## [v0.1.4](https://github.com/contentstack/contentstack-management-dotnet/tree/v0.1.4) (2024-01-22)
+
+## [v0.1.3](https://github.com/contentstack/contentstack-management-dotnet/tree/v0.1.3) (2023-04-04)
+
 ## [v0.1.2](https://github.com/contentstack/contentstack-management-dotnet/tree/v0.1.2) (2023-03-07)
 
 ## [v0.1.1](https://github.com/contentstack/contentstack-management-dotnet/tree/v0.1.1) (2022-12-16)
diff --git a/Contentstack.Management.ASPNETCore/contentstack.management.aspnetcore.csproj b/Contentstack.Management.ASPNETCore/contentstack.management.aspnetcore.csproj
@@ -3,7 +3,7 @@
   <PropertyGroup>
     <TargetFramework>netstandard2.1</TargetFramework>
     <PackageId>contentstack.management.aspnetcore</PackageId>
-    <PackageVersion>0.1.2</PackageVersion>
+    <PackageVersion>0.1.4</PackageVersion>
     <Authors>Contentstack</Authors>
     <Copyright>Copyright © 2012-2023 Contentstack. All Rights Reserved</Copyright>
     <Owners>Contentstack </Owners>
@@ -14,8 +14,8 @@
     <Title>Contentstack Management</Title>
     <Description>.NET SDK for the Contentstack Content Management API.</Description>
     <PackageLicenseFile>LICENSE.txt</PackageLicenseFile>
-    <PackageTags>v0.1.2</PackageTags>
-    <ReleaseVersion>0.1.3</ReleaseVersion>
+    <PackageTags>v0.1.4</PackageTags>
+    <ReleaseVersion>0.1.4</ReleaseVersion>
     <RootNamespace>Contentstack.Management.ASPNETCore</RootNamespace>
   </PropertyGroup>
 
@@ -28,6 +28,6 @@
   <ItemGroup>
     <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="7.0.0" />
     <PackageReference Include="Microsoft.Extensions.Options.ConfigurationExtensions" Version="7.0.0" />
-    <PackageReference Include="contentstack.management.csharp" Version="0.1.1" />
+    <PackageReference Include="contentstack.management.csharp" Version="0.1.3" />
   </ItemGroup>
 </Project>
diff --git a/Contentstack.Management.Core.Tests/Contentstack.Management.Core.Tests.csproj b/Contentstack.Management.Core.Tests/Contentstack.Management.Core.Tests.csproj
@@ -4,7 +4,7 @@
     <TargetFramework>net7.0</TargetFramework>
 
     <IsPackable>false</IsPackable>
-    <ReleaseVersion>0.1.3</ReleaseVersion>
+    <ReleaseVersion>0.1.4</ReleaseVersion>
   </PropertyGroup>
 
   <ItemGroup>
diff --git a/Contentstack.Management.Core.Unit.Tests/Contentstack.Management.Core.Unit.Tests.csproj b/Contentstack.Management.Core.Unit.Tests/Contentstack.Management.Core.Unit.Tests.csproj
@@ -4,7 +4,7 @@
     <TargetFramework>net7.0</TargetFramework>
 
     <IsPackable>false</IsPackable>
-    <ReleaseVersion>0.1.3</ReleaseVersion>
+    <ReleaseVersion>0.1.4</ReleaseVersion>
   </PropertyGroup>
 
   <ItemGroup>
diff --git a/Contentstack.Management.Core.Unit.Tests/Core/ContentstackClientTest.cs b/Contentstack.Management.Core.Unit.Tests/Core/ContentstackClientTest.cs
@@ -5,6 +5,7 @@
 using Contentstack.Management.Core.Unit.Tests.Mokes;
 using Microsoft.VisualStudio.TestTools.UnitTesting;
 
+
 namespace Contentstack.Management.Core.Unit.Tests.Core
 {
     [TestClass]
@@ -74,7 +75,8 @@ public void Initialize_Contentstack_With_Clientptions()
                 Timeout= TimeSpan.FromSeconds(20),
                 RetryOnError= false,
                 ProxyHost= "proxyHost",
-                ProxyPort= 22
+                ProxyPort= 22,
+                EarlyAccess = new string[] { "ea1", "ea2" }
             });
 
             Assert.AreEqual("token", contentstackClient.contentstackOptions.Authtoken);
@@ -89,6 +91,7 @@ public void Initialize_Contentstack_With_Clientptions()
             Assert.IsTrue(contentstackClient.contentstackOptions.DisableLogging);
             Assert.AreEqual(1234, contentstackClient.contentstackOptions.MaxResponseContentBufferSize);
             Assert.AreEqual(20, contentstackClient.contentstackOptions.Timeout.Seconds);
+            CollectionAssert.AreEqual(new string[] {"ea1", "ea2"}, contentstackClient.contentstackOptions.EarlyAccess);
         }
 
         [TestMethod]
diff --git a/Contentstack.Management.Core.Unit.Tests/Queryable/ParameterCollectionTest.cs b/Contentstack.Management.Core.Unit.Tests/Queryable/ParameterCollectionTest.cs
@@ -2,6 +2,7 @@
 using System.Collections.Generic;
 using Contentstack.Management.Core.Queryable;
 using Microsoft.VisualStudio.TestTools.UnitTesting;
+using Newtonsoft.Json.Linq;
 
 namespace Contentstack.Management.Core.Unit.Tests.Queryable
 {
@@ -84,5 +85,18 @@ public void Should_Add_Double_List_Value_Parameter_Collection()
             Assert.IsInstanceOfType(collection["param1"], typeof(DoubleListParameterValue));
             Assert.AreEqual(vs, (collection["param1"] as DoubleListParameterValue).Value);
         }
+
+        [TestMethod]
+        public void Should_Add_Query_JObject_In_Parameter_Collection()
+        {
+            ParameterCollection collection = new ParameterCollection();
+            JObject queryObject = JObject.Parse("{ \"price_in_usd\": { \"$lt\": 600 } }");
+
+            collection.AddQuery(queryObject);
+
+            Assert.IsTrue(collection.ContainsKey("query"));
+            Assert.IsInstanceOfType(collection["query"], typeof(StringParameterValue));
+            Assert.AreEqual(Uri.EscapeDataString(queryObject.ToString()), (collection["query"] as StringParameterValue).Value);
+        }
     }
 }
diff --git a/Contentstack.Management.Core.Unit.Tests/Utils/ContentstackUtilitiesTest.cs b/Contentstack.Management.Core.Unit.Tests/Utils/ContentstackUtilitiesTest.cs
@@ -3,6 +3,7 @@
 using Contentstack.Management.Core.Unit.Tests.Mokes;
 using Contentstack.Management.Core.Utils;
 using Microsoft.VisualStudio.TestTools.UnitTesting;
+using Newtonsoft.Json.Linq;
 
 namespace Contentstack.Management.Core.Unit.Tests.Utils
 {
@@ -89,9 +90,12 @@ public void Return_Query_Parameters_On_ParameterCollection()
             param.Add("limit", 10);
             param.Add("include", "type");
 
+            JObject q_obj = JObject.Parse("{ \"price_in_usd\": { \"$lt\": 600 } }");
+            param.AddQuery(q_obj);
+
             var result = ContentstackUtilities.GetQueryParameter(param);
 
-            Assert.AreEqual("include=type&limit=10", result);
+            Assert.AreEqual("include=type&limit=10&query=%7B%0D%0A%20%20%22price_in_usd%22%3A%20%7B%0D%0A%20%20%20%20%22%24lt%22%3A%20600%0D%0A%20%20%7D%0D%0A%7D", result);
         }
 
         [TestMethod]
diff --git a/Contentstack.Management.Core/ContentstackClient.cs b/Contentstack.Management.Core/ContentstackClient.cs
@@ -35,7 +35,7 @@ public class ContentstackClient : IContentstackClient
         private HttpClient _httpClient;
         private bool _disposed = false;
 
-        private string Version => "0.1.2";
+        private string Version => "0.1.4";
         private string xUserAgent => $"contentstack-management-dotnet/{Version}";
         #endregion
 
@@ -96,7 +96,7 @@ public ContentstackClient(ContentstackClientOptions contentstackOptions) :
         /// </code></pre>
         /// </example>
         public ContentstackClient(
-        string authtoken = null,
+            string authtoken = null,
             string host = "api.contentstack.io",
             int port = 443,
             string version = "v3",
@@ -148,6 +148,10 @@ protected void Initialize()
                 _httpClient.Timeout = contentstackOptions.Timeout;
                 _httpClient.MaxResponseContentBufferSize = contentstackOptions.MaxResponseContentBufferSize;
                 LogManager = contentstackOptions.DisableLogging ? LogManager.EmptyLogger : LogManager.GetLogManager(GetType());
+
+                if (contentstackOptions.EarlyAccess != null) {
+                    _httpClient.DefaultRequestHeaders.Add(HeadersKey.EarlyAccessHeader, string.Join(",", contentstackOptions.EarlyAccess));
+                }
             }
 
             SerializerSettings.DateParseHandling = DateParseHandling.None;
diff --git a/Contentstack.Management.Core/ContentstackClientOptions.cs b/Contentstack.Management.Core/ContentstackClientOptions.cs
@@ -22,6 +22,10 @@ public class ContentstackClientOptions
         /// </summary>
         public string Host { get; set; } = "api.contentstack.io";
 
+        /// <summary>
+        /// The EarlyAccess used to set early access headers for the Contentstack Management API.
+        /// </summary>
+        public string[] EarlyAccess { get; set; }
 
         /// <summary>
         /// The Host used to set host url for the Contentstack Management API.
diff --git a/Contentstack.Management.Core/Queryable/ParameterCollection.cs b/Contentstack.Management.Core/Queryable/ParameterCollection.cs
@@ -3,6 +3,7 @@
 using System.Globalization;
 using System.Linq;
 using Contentstack.Management.Core.Exceptions;
+using Newtonsoft.Json.Linq;
 
 namespace Contentstack.Management.Core.Queryable
 {
@@ -60,6 +61,15 @@ public void Add(string key, List<double> values)
             Add(key, new DoubleListParameterValue(values));
         }
 
+        /// <summary>
+        /// Adds a parameter with a queryObj value.
+        /// </summary>
+        /// <param name="queryObj"></param>
+        public void AddQuery(JObject queryObj)
+        {
+            Add("query", new StringParameterValue(Uri.EscapeDataString(queryObj.ToString())));
+        }
+
         /// <summary>
         /// Converts the current parameters into a list of key-value pairs.
         /// </summary>
@@ -87,6 +97,9 @@ private IEnumerable<KeyValuePair<string, string>> GetParametersEnumerable()
                     case StringParameterValue stringParameterValue:
                         yield return new KeyValuePair<string, string>(name, stringParameterValue.Value);
                         break;
+                    case JObjectParameterValue jObjectParameterValue:
+                        yield return new KeyValuePair<string, string>(name, jObjectParameterValue.Value.ToString());
+                        break;
                     case StringListParameterValue stringListParameterValue:
                         var sortedStringListParameterValue = stringListParameterValue.Value;
                         sortedStringListParameterValue.Sort(StringComparer.Ordinal);
diff --git a/Contentstack.Management.Core/Queryable/QueryParamValue.cs b/Contentstack.Management.Core/Queryable/QueryParamValue.cs
@@ -1,5 +1,6 @@
 ﻿using System;
 using System.Collections.Generic;
+using Newtonsoft.Json.Linq;
 
 namespace Contentstack.Management.Core.Queryable
 {
@@ -109,4 +110,24 @@ public DoubleListParameterValue(List<double> values)
             Value = values;
         }
     }
+
+    /// <summary>
+    /// Double list parameter value.
+    /// </summary>
+    public class JObjectParameterValue : QueryParamValue
+    {
+        /// <summary>
+        /// List of doubles value of the parameter.
+        /// </summary>
+        public JObject Value { get; set; }
+
+        /// <summary>
+        /// Constructs ParameterValue for a list of doubles.
+        /// </summary>
+        /// <param name="values"></param>
+        public JObjectParameterValue(JObject values)
+        {
+            Value = values;
+        }
+    }
 }
diff --git a/Contentstack.Management.Core/Utils/HeadersKey.cs b/Contentstack.Management.Core/Utils/HeadersKey.cs
@@ -6,6 +6,7 @@ public abstract class HeadersKey
         public const string UserAgentHeader = "User-Agent";
         public const string XUserAgentHeader = "X-User-Agent";
         public const string ContentTypeHeader = "Content-Type";
+        public const string EarlyAccessHeader = "x-header-ea";
 
     }
 }
diff --git a/Contentstack.Management.Core/contentstack.management.core.csproj b/Contentstack.Management.Core/contentstack.management.core.csproj
@@ -3,7 +3,7 @@
   <PropertyGroup>
     <TargetFrameworks>netstandard2.0;net471;net472;</TargetFrameworks>
     <PackageId>contentstack.management.csharp</PackageId>
-    <PackageVersion>0.1.3</PackageVersion>
+    <PackageVersion>0.1.4</PackageVersion>
     <Authors>Contentstack</Authors>
     <Copyright>Copyright © 2012-2023 Contentstack. All Rights Reserved</Copyright>
     <Owners>Contentstack </Owners>
@@ -14,8 +14,8 @@
     <Title>Contentstack Management</Title>
     <Description>.NET SDK for the Contentstack Content Management API.</Description>
     <PackageLicenseFile>LICENSE.txt</PackageLicenseFile>
-    <PackageTags>v0.1.3</PackageTags>
-    <ReleaseVersion>0.1.3</ReleaseVersion>
+    <PackageTags>v0.1.4</PackageTags>
+    <ReleaseVersion>0.1.4</ReleaseVersion>
   </PropertyGroup>
 
   <ItemGroup>
@@ -56,7 +56,7 @@
   </ItemGroup>
   <ItemGroup>
     <PackageReference Include="System.Net.Http" Version="4.3.4" />
-    <PackageReference Include="Microsoft.Extensions.Options" Version="7.0.1" />
+    <PackageReference Include="Microsoft.Extensions.Options" Version="8.0.0" />
     <PackageReference Include="Newtonsoft.Json" Version="13.0.2" />
   </ItemGroup>
 </Project>
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2012-2023 Contentstack
+Copyright (c) 2012-2024 Contentstack
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
