Allow adding empty value for URL segments

alexeyzimarev · alexeyzimarev · commit 40b9416d2ce4 · 2024-12-17T11:14:07.000+01:00
diff --git a/src/RestSharp/Parameters/UrlSegmentParameter.cs b/src/RestSharp/Parameters/UrlSegmentParameter.cs
@@ -13,6 +13,7 @@
 // limitations under the License.
 
 using System.Text.RegularExpressions;
+using RestSharp.Extensions;
 
 namespace RestSharp;
 
@@ -30,7 +31,7 @@ public partial record UrlSegmentParameter : NamedParameter {
     public UrlSegmentParameter(string name, string value, bool encode = true, bool replaceEncodedSlash = true)
         : base(
             name,
-            replaceEncodedSlash ? RegexPattern.Replace(Ensure.NotEmptyString(value, nameof(value)), "/") : value,
+            value.IsEmpty() ? value : replaceEncodedSlash ? RegexPattern.Replace(value, "/") : value,
             ParameterType.UrlSegment,
             encode
         ) { }
diff --git a/test/RestSharp.Tests/Headers/DefaultHeaderTests.cs b/test/RestSharp.Tests/Headers/DefaultHeaderTests.cs
@@ -0,0 +1,23 @@
+namespace RestSharp.Tests.Headers;
+
+public class DefaultHeaderTests {
+    const string BaseUrl = "http://localhost:8888/";
+    
+    [Fact]
+    public void AddDefaultHeadersUsingDictionary() {
+        var headers = new Dictionary<string, string> {
+            { KnownHeaders.ContentType, ContentType.Json },
+            { KnownHeaders.Accept, ContentType.Json },
+            { KnownHeaders.ContentEncoding, "gzip, deflate" }
+        };
+
+        var expected = headers.Select(x => new HeaderParameter(x.Key, x.Value));
+
+        using var client = new RestClient(BaseUrl);
+        client.AddDefaultHeaders(headers);
+
+        var actual = client.DefaultParameters.Select(x => x as HeaderParameter);
+        expected.Should().BeSubsetOf(actual);
+    }
+
+}
diff --git a/test/RestSharp.Tests/Headers/HeaderRangeTests.cs b/test/RestSharp.Tests/Headers/HeaderRangeTests.cs
@@ -1,6 +1,6 @@
-﻿namespace RestSharp.Tests;
+﻿namespace RestSharp.Tests.Parameters;
 
-public class AddRangeTests {
+public class HeaderRangeTests {
     [Fact]
     public async Task ShouldParseOutLongRangeSpecifier() {
         using var restClient = new RestClient("http://localhost");
diff --git a/test/RestSharp.Tests/Headers/HostHeaderTests.cs b/test/RestSharp.Tests/Headers/HostHeaderTests.cs
diff --git a/test/RestSharp.Tests/Headers/RequestHeaderTests.cs b/test/RestSharp.Tests/Headers/RequestHeaderTests.cs
diff --git a/test/RestSharp.Tests/Parameters/ObjectParameterTests.ArrayData.cs b/test/RestSharp.Tests/Parameters/ObjectParameterTests.ArrayData.cs
@@ -1,4 +1,4 @@
-﻿namespace RestSharp.Tests;
+﻿namespace RestSharp.Tests.Parameters;
 
 public partial class ObjectParameterTests {
     sealed record ArrayData<TEnumerable>([property: RequestProperty(ArrayQueryType = RequestArrayQueryType.ArrayParameters)] TEnumerable Array) where TEnumerable : notnull;
diff --git a/test/RestSharp.Tests/Parameters/ObjectParameterTests.CsvData.cs b/test/RestSharp.Tests/Parameters/ObjectParameterTests.CsvData.cs
@@ -1,4 +1,4 @@
-﻿namespace RestSharp.Tests;
+﻿namespace RestSharp.Tests.Parameters;
 
 public partial class ObjectParameterTests {
     sealed record CsvData<TEnumerable>([property: RequestProperty(ArrayQueryType = RequestArrayQueryType.CommaSeparated)] TEnumerable Csv) where TEnumerable : notnull;
diff --git a/test/RestSharp.Tests/Parameters/ObjectParameterTests.FormattedData.cs b/test/RestSharp.Tests/Parameters/ObjectParameterTests.FormattedData.cs
@@ -1,4 +1,4 @@
-﻿namespace RestSharp.Tests;
+﻿namespace RestSharp.Tests.Parameters;
 
 public partial class ObjectParameterTests {
     sealed record FormattedData<TDateTime>([property: RequestProperty(Format = "hh:mm tt")] TDateTime FormattedParameter) where TDateTime : notnull;
diff --git a/test/RestSharp.Tests/Parameters/ObjectParameterTests.NamedData.cs b/test/RestSharp.Tests/Parameters/ObjectParameterTests.NamedData.cs
@@ -1,4 +1,4 @@
-﻿namespace RestSharp.Tests;
+﻿namespace RestSharp.Tests.Parameters;
 
 public partial class ObjectParameterTests {
     sealed record NamedData([property: RequestProperty(Name = "CustomName")] object NamedParameter);
diff --git a/test/RestSharp.Tests/Parameters/ObjectParameterTests.cs b/test/RestSharp.Tests/Parameters/ObjectParameterTests.cs
@@ -1,7 +1,7 @@
 using System.Collections;
 using System.Globalization;
 
-namespace RestSharp.Tests;
+namespace RestSharp.Tests.Parameters;
 
 public partial class ObjectParameterTests {
     public ObjectParameterTests() => Thread.CurrentThread.CurrentCulture = CultureInfo.InvariantCulture;
diff --git a/test/RestSharp.Tests/Parameters/ParameterValidationTests.cs b/test/RestSharp.Tests/Parameters/ParameterValidationTests.cs
@@ -1,4 +1,4 @@
-﻿namespace RestSharp.Tests;
+﻿namespace RestSharp.Tests.Parameters;
 
 public class ParameterValidationTests {
     [Fact]
diff --git a/test/RestSharp.Tests/Parameters/UrlSegmentTests.cs b/test/RestSharp.Tests/Parameters/UrlSegmentTests.cs
@@ -1,25 +1,8 @@
-namespace RestSharp.Tests;
+namespace RestSharp.Tests.Parameters;
 
-public class ParametersTests {
+public class UrlSegmentTests {
     const string BaseUrl = "http://localhost:8888/";
 
-    [Fact]
-    public void AddDefaultHeadersUsingDictionary() {
-        var headers = new Dictionary<string, string> {
-            { KnownHeaders.ContentType, ContentType.Json },
-            { KnownHeaders.Accept, ContentType.Json },
-            { KnownHeaders.ContentEncoding, "gzip, deflate" }
-        };
-
-        var expected = headers.Select(x => new HeaderParameter(x.Key, x.Value));
-
-        using var client = new RestClient(BaseUrl);
-        client.AddDefaultHeaders(headers);
-
-        var actual = client.DefaultParameters.Select(x => x as HeaderParameter);
-        expected.Should().BeSubsetOf(actual);
-    }
-
     [Fact]
     public void AddUrlSegmentWithInt() {
         const string name = "foo";
diff --git a/test/RestSharp.Tests/RestClientTests.cs b/test/RestSharp.Tests/RestClientTests.cs
@@ -32,38 +32,6 @@ public async Task ConfigureHttp_will_set_proxy_to_null_with_no_exceptions_When_n
         await client.ExecuteAsync(req);
     }
 
-    [Fact]
-    public void BuildUri_should_build_with_passing_link_as_Uri() {
-        // arrange
-        var relative    = new Uri("/foo/bar/baz", UriKind.Relative);
-        var absoluteUri = new Uri(new Uri(BaseUrl), relative);
-        var req         = new RestRequest(absoluteUri);
-
-        // act
-        using var client = new RestClient();
-
-        var builtUri = client.BuildUri(req);
-
-        // assert
-        absoluteUri.Should().Be(builtUri);
-    }
-
-    [Fact]
-    public void BuildUri_should_build_with_passing_link_as_Uri_with_set_BaseUrl() {
-        // arrange
-        var baseUrl  = new Uri(BaseUrl);
-        var relative = new Uri("/foo/bar/baz", UriKind.Relative);
-        var req      = new RestRequest(relative);
-
-        // act
-        using var client = new RestClient(baseUrl);
-
-        var builtUri = client.BuildUri(req);
-
-        // assert
-        new Uri(baseUrl, relative).Should().Be(builtUri);
-    }
-
     [Fact]
     public void UseJson_leaves_only_json_serializer() {
         // arrange
diff --git a/test/RestSharp.Tests/RestSharp.Tests.csproj b/test/RestSharp.Tests/RestSharp.Tests.csproj
@@ -29,17 +29,11 @@
         <None Update="SampleData\underscore_prefix.json" CopyToOutputDirectory="PreserveNewest"/>
     </ItemGroup>
     <ItemGroup>
-      <Compile Update="ObjectParameterTests.ArrayData.cs">
-        <DependentUpon>ObjectParameterTests.cs</DependentUpon>
+      <Compile Update="UrlBuilderTests.Get.cs">
+        <DependentUpon>UrlBuilderTests.cs</DependentUpon>
       </Compile>
-      <Compile Update="ObjectParameterTests.CsvData.cs">
-        <DependentUpon>ObjectParameterTests.cs</DependentUpon>
-      </Compile>
-      <Compile Update="ObjectParameterTests.FormattedData.cs">
-        <DependentUpon>ObjectParameterTests.cs</DependentUpon>
-      </Compile>
-      <Compile Update="ObjectParameterTests.NamedData.cs">
-        <DependentUpon>ObjectParameterTests.cs</DependentUpon>
+      <Compile Update="UrlBuilderTests.Post.cs">
+        <DependentUpon>UrlBuilderTests.cs</DependentUpon>
       </Compile>
     </ItemGroup>
 </Project>
diff --git a/test/RestSharp.Tests/UrlBuilderTests.Get.cs b/test/RestSharp.Tests/UrlBuilderTests.Get.cs
@@ -0,0 +1,197 @@
+namespace RestSharp.Tests;
+
+public partial class UrlBuilderTests {
+    [Fact]
+    public void GET_with_empty_base_and_query_parameters_without_encoding() {
+        var request = new RestRequest($"{Base}/{Resource}?param1=value1")
+            .AddQueryParameter("foo", "bar,baz", false);
+        var expected = new Uri($"{Base}/{Resource}?param1=value1&foo=bar,baz");
+
+        using var client = new RestClient();
+
+        var output = client.BuildUri(request);
+        Assert.Equal(expected, output);
+    }
+
+    [Fact]
+    public void GET_with_empty_base_and_resource_containing_tokens() {
+        var request = new RestRequest($"{Base}/{Resource}/{{foo}}");
+        request.AddUrlSegment("foo", "bar");
+
+        using var client = new RestClient();
+
+        var expected = new Uri($"{Base}/{Resource}/bar");
+        var output   = client.BuildUri(request);
+
+        Assert.Equal(expected, output);
+    }
+
+    [Fact]
+    public void GET_with_empty_request() {
+        var request  = new RestRequest();
+        var expected = new Uri(Base);
+
+        using var client = new RestClient(new Uri(Base));
+
+        var output = client.BuildUri(request);
+        Assert.Equal(expected, output);
+    }
+
+    [Fact]
+    public void GET_with_empty_request_and_bare_hostname() {
+        var request  = new RestRequest();
+        var expected = new Uri(Base);
+
+        using var client = new RestClient(new Uri(Base));
+
+        var output = client.BuildUri(request);
+        Assert.Equal(expected, output);
+    }
+
+    [Fact]
+    public void GET_with_empty_request_and_query_parameters_without_encoding() {
+        var request = new RestRequest();
+        request.AddQueryParameter("foo", "bar,baz", false);
+        var expected = new Uri($"{Base}/{Resource}?param1=value1&foo=bar,baz");
+
+        using var client = new RestClient($"{Base}/{Resource}?param1=value1");
+
+        var output = client.BuildUri(request);
+        Assert.Equal(expected, output);
+    }
+
+    [Fact]
+    public void GET_with_Invalid_Url_string_throws_exception()
+        => Assert.Throws<UriFormatException>(
+            () => { _ = new RestClient("invalid url"); }
+        );
+
+    [Fact]
+    public void GET_with_leading_slash() {
+        var request  = new RestRequest($"/{Resource}");
+        var expected = new Uri($"{Base}/{Resource}");
+
+        using var client = new RestClient(new Uri(Base));
+
+        var output = client.BuildUri(request);
+        Assert.Equal(expected, output);
+    }
+
+    [Fact]
+    public void GET_with_leading_slash_and_baseurl_trailing_slash() {
+        var request = new RestRequest($"/{Resource}");
+        request.AddParameter("foo", "bar");
+        var expected = new Uri($"{Base}/{Resource}?foo=bar");
+
+        using var client = new RestClient(new Uri(Base));
+
+        var output = client.BuildUri(request);
+        Assert.Equal(expected, output);
+    }
+
+    [Fact]
+    public void GET_with_multiple_instances_of_same_key() {
+        var request = new RestRequest("v1/people/~/network/updates");
+        request.AddParameter("type", "STAT");
+        request.AddParameter("type", "PICT");
+        request.AddParameter("count", "50");
+        request.AddParameter("start", "50");
+        var expected = new Uri("https://api.linkedin.com/v1/people/~/network/updates?type=STAT&type=PICT&count=50&start=50");
+
+        using var client = new RestClient("https://api.linkedin.com");
+
+        var output = client.BuildUri(request);
+        Assert.Equal(expected, output);
+    }
+
+    [Fact]
+    public void GET_with_resource_containing_null_token() {
+        var request = new RestRequest($"/{Resource}/{{foo}}");
+        Assert.Throws<ArgumentNullException>(() => request.AddUrlSegment("foo", null!));
+    }
+
+    [Fact]
+    public void GET_with_resource_containing_slashes() {
+        var request  = new RestRequest($"{Resource}/foo");
+        var expected = new Uri($"{Base}/{Resource}/foo");
+
+        using var client = new RestClient(new Uri(Base));
+
+        var output = client.BuildUri(request);
+        Assert.Equal(expected, output);
+    }
+
+    [Fact]
+    public void GET_with_resource_containing_tokens() {
+        var request = new RestRequest($"{Resource}/{{foo}}");
+        request.AddUrlSegment("foo", "bar");
+        var expected = new Uri($"{Base}/{Resource}/bar");
+
+        using var client = new RestClient(new Uri(Base));
+
+        var output = client.BuildUri(request);
+        Assert.Equal(expected, output);
+    }
+
+    [Fact]
+    public void GET_with_Uri_and_resource_containing_tokens() {
+        var request = new RestRequest($"/{{foo}}/{Resource}/{{baz}}");
+        request.AddUrlSegment("foo", "bar");
+        request.AddUrlSegment("baz", "bat");
+        var expected = new Uri($"{Base}/bar/{Resource}/bat");
+
+        using var client = new RestClient(Base);
+
+        var output = client.BuildUri(request);
+        Assert.Equal(expected, output);
+    }
+
+    [Fact]
+    public void GET_with_Uri_containing_tokens() {
+        var request = new RestRequest();
+        request.AddUrlSegment("foo", "bar");
+        var expected = new Uri(Base);
+
+        using var client = new RestClient(Base);
+
+        var output = client.BuildUri(request);
+        Assert.Equal(expected, output);
+    }
+
+    [Fact]
+    public void GET_with_Url_string_and_resource_containing_tokens() {
+        var request = new RestRequest($"{Resource}/{{baz}}");
+        request.AddUrlSegment("foo", "bar");
+        request.AddUrlSegment("baz", "bat");
+        var expected = new Uri($"{Base}/bar/{Resource}/bat");
+
+        using var client = new RestClient($"{Base}/{{foo}}");
+
+        var output = client.BuildUri(request);
+        Assert.Equal(expected, output);
+    }
+
+    [Fact]
+    public void GET_with_Url_string_containing_tokens() {
+        var request = new RestRequest();
+        request.AddUrlSegment("foo", "bar");
+        var expected = new Uri($"{Base}/bar");
+
+        using var client = new RestClient($"{Base}/{{foo}}");
+
+        var output = client.BuildUri(request);
+        Assert.Equal(expected, output);
+    }
+
+    [Fact]
+    public void GET_wth_trailing_slash_and_query_parameters() {
+        var request = new RestRequest($"/{Resource}/");
+        request.AddParameter("foo", "bar");
+        var expected = new Uri($"{Base}/{Resource}/?foo=bar");
+
+        using var client = new RestClient(Base);
+
+        var output = client.BuildUri(request);
+        Assert.Equal(expected, output);
+    }
+}
diff --git a/test/RestSharp.Tests/UrlBuilderTests.Post.cs b/test/RestSharp.Tests/UrlBuilderTests.Post.cs
diff --git a/test/RestSharp.Tests/UrlBuilderTests.cs b/test/RestSharp.Tests/UrlBuilderTests.cs

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-namespace RestSharp.Tests;`
	`1`	`+namespace RestSharp.Tests.Parameters;`
`2`	`2`
`3`	`3`	`public partial class ObjectParameterTests {`
`4`	`4`	`sealed record ArrayData<TEnumerable>([property: RequestProperty(ArrayQueryType = RequestArrayQueryType.ArrayParameters)] TEnumerable Array) where TEnumerable : notnull;`