Merge pull request #26 from contentstack/feat/CS-43224-query-in-parameter-collection

feat: ✨ adds AddQuery function to ParameterCollection

Author: nadeem-cs

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)

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);
+        }
     }
 }

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]

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);

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;
+        }
+    }
 }

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