Merge pull request #15 from scottoffen/query-parameter-fix

Query Parameter Fix

Author: scottoffen

.github/workflows/build-test.yaml

@@ -0,0 +1,30 @@
+name: Build and Test Pull Requests
+
+on:
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+    name: Build and Test
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Setup .NET (5.0.x)
+      uses: actions/setup-dotnet@v3
+      with:
+        dotnet-version: 5.0.x
+    - name: Display Available .NET SDKs
+      run: dotnet --list-sdks
+    - name: Restore dependencies
+      run: dotnet restore ./src
+    - name: Build
+      run: dotnet build ./src --no-restore
+    - name: Test
+      run: dotnet test ./src --no-build --verbosity normal

src/FluentHttpClient.Tests/QueryParamsTests.cs

@@ -0,0 +1,42 @@
+using Shouldly;
+
+namespace FluentHttpClient.Tests;
+
+public class QueryParamsTests
+{
+    [Fact]
+    public void DoesNotRemoveEmptyValues()
+    {
+        FluentHttpClient.RemoveEmptyQueryParameters = false;
+
+        var expected = "?name=bob&age=&color=blue";
+
+        var qp = new QueryParams
+        {
+            { "name", "bob" },
+            { "age", "" },
+            { "color", "blue" }
+        };
+
+        var actual = qp.ToString();
+        actual.ShouldBe(expected);
+    }
+
+    [Fact]
+    public void RemovesEmptyValues()
+    {
+        FluentHttpClient.RemoveEmptyQueryParameters = true;
+
+        var expected = "?name=bob&color=blue";
+
+        var qp = new QueryParams
+        {
+            { "name", "bob" },
+            { "age", "" },
+            { "color", "blue" }
+        };
+
+        var actual = qp.ToString();
+        actual.ShouldBe(expected);
+    }
+}

src/FluentHttpClient/FluentHttpClient.cs

@@ -10,4 +10,9 @@ public static class FluentHttpClient
         PropertyNameCaseInsensitive = true,
         DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull
     };
+
+    /// <summary>
+    /// When true, query parameters that are null or empty will not be included when converted to a string.
+    /// </summary>
+    public static bool RemoveEmptyQueryParameters { get; set; } = false;
 }

src/FluentHttpClient/FluentHttpClient.csproj

@@ -14,7 +14,7 @@
     <PackageTags>fluent httpclient rest http api web client</PackageTags>
     <AssemblyVersion>$(Version)</AssemblyVersion>
     <FileVersion>$(Version)</FileVersion>
-    <Version>3.0.2</Version>
+    <Version>3.0.3</Version>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
     <PackageReadmeFile>README.md</PackageReadmeFile>
     <PackageLicenseFile>LICENSE</PackageLicenseFile>

src/FluentHttpClient/QueryParams.cs

@@ -9,8 +9,18 @@ public class QueryParams : NameValueCollection
 {
     public override string ToString()
     {
-        return HasKeys()
-            ? string.Empty
-            : "?" + string.Join("&", (from key in AllKeys let value = Get(key) select Uri.EscapeDataString(key) + "=" + Uri.EscapeDataString(value)).ToArray());
+        if (!HasKeys()) return string.Empty;
+
+        var result = (
+            from key in AllKeys
+            let value = Get(key)
+            where (
+                !FluentHttpClient.RemoveEmptyQueryParameters
+                || !string.IsNullOrWhiteSpace(value)
+            )
+            select $"{Uri.EscapeDataString(key)}={Uri.EscapeDataString(value)}"
+        ).ToArray();
+
+        return $"?{string.Join("&", result)}";
     }
 }