1.5.21

* RequestBuilder : add WithBodyAsJson and WithBody (with IJsonConverter)

* tests

CHANGELOG.md

@@ -1,3 +1,8 @@
+# 1.5.21 (22 March 2023)
+- [#908](https://github.com/WireMock-Net/WireMock.Net/pull/908) - RequestBuilder : add WithBodyAsJson and WithBody (with IJsonConverter) [feature] contributed by [StefH](https://github.com/StefH)
+- [#911](https://github.com/WireMock-Net/WireMock.Net/pull/911) - Fixed QueryStringParser for UrlEncoded values [bug] contributed by [StefH](https://github.com/StefH)
+- [#901](https://github.com/WireMock-Net/WireMock.Net/issues/901) - Matching one form-urlencoded value [feature]
+
 # 1.5.20 (19 March 2023)
 - [#905](https://github.com/WireMock-Net/WireMock.Net/pull/905) - Add DeserializeFormUrl Encoded to the settings [feature] contributed by [StefH](https://github.com/StefH)
 - [#907](https://github.com/WireMock-Net/WireMock.Net/pull/907) - Fix issue with application/x-www-form-urlencoded and ExactMatcher [bug] contributed by [StefH](https://github.com/StefH)
@@ -6,7 +11,6 @@
 # 1.5.19 (17 March 2023)
 - [#903](https://github.com/WireMock-Net/WireMock.Net/pull/903) - Add WithBody with IDictionary (form-urlencoded values) [feature] contributed by [StefH](https://github.com/StefH)
 - [#904](https://github.com/WireMock-Net/WireMock.Net/pull/904) - Update Handlebars.Net.Helpers to 2.3.15 [feature] contributed by [StefH](https://github.com/StefH)
-- [#901](https://github.com/WireMock-Net/WireMock.Net/issues/901) - Matching one form-urlencoded value [feature]
 
 # 1.5.18 (09 March 2023)
 - [#893](https://github.com/WireMock-Net/WireMock.Net/pull/893) - Add 'Data' to response which can be used during transforming the response [feature] contributed by [StefH](https://github.com/StefH)

Directory.Build.props

@@ -4,7 +4,7 @@
     </PropertyGroup>
 
     <PropertyGroup>
-        <VersionPrefix>1.5.20</VersionPrefix>
+        <VersionPrefix>1.5.21</VersionPrefix>
         <PackageIcon>WireMock.Net-Logo.png</PackageIcon>
         <PackageProjectUrl>https://github.com/WireMock-Net/WireMock.Net</PackageProjectUrl>
         <PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>

Generate-ReleaseNotes.cmd

@@ -1,6 +1,6 @@
 rem https://github.com/StefH/GitHubReleaseNotes
 
-SET version=1.5.20
+SET version=1.5.21
 
 GitHubReleaseNotes --output CHANGELOG.md --skip-empty-releases --exclude-labels question invalid doc duplicate --version %version% --token %GH_TOKEN%
 

PackageReleaseNotes.txt

@@ -1,6 +1,6 @@
-# 1.5.20 (19 March 2023)
-- #905 Add DeserializeFormUrl Encoded to the settings [feature]
-- #907 Fix issue with application/x-www-form-urlencoded and ExactMatcher [bug]
-- #906 Upgrade to 1.5.19 breaks a form data test [bug]
+# 1.5.21 (22 March 2023)
+- #908 RequestBuilder : add WithBodyAsJson and WithBody (with IJsonConverter) [feature]
+- #911 Fixed QueryStringParser for UrlEncoded values [bug]
+- #901 Matching one form-urlencoded value [feature]
 
 The full release notes can be found here: https://github.com/WireMock-Net/WireMock.Net/blob/master/CHANGELOG.md

src/WireMock.Net/RequestBuilders/IBodyRequestBuilder.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using JsonConverter.Abstractions;
 using WireMock.Matchers;
 using WireMock.Matchers.Request;
 using WireMock.Util;
@@ -46,10 +47,28 @@ public interface IBodyRequestBuilder : IRequestMatcher
     /// WithBody: Body as object
     /// </summary>
     /// <param name="body">The body.</param>
-    /// <param name="matchBehaviour">The match behaviour.</param>
+    /// <param name="matchBehaviour">The match behaviour [default is AcceptOnMatch].</param>
     /// <returns>The <see cref="IRequestBuilder"/>.</returns>
     IRequestBuilder WithBody(object body, MatchBehaviour matchBehaviour = MatchBehaviour.AcceptOnMatch);
 
+    /// <summary>
+    /// WithBody : Body as a string response based on a object (which will be converted to a JSON string using NewtonSoft.Json).
+    /// </summary>
+    /// <param name="body">The body.</param>
+    /// <param name="matchBehaviour">The match behaviour [default is AcceptOnMatch].</param>
+    /// <returns>A <see cref="IRequestBuilder"/>.</returns>
+    IRequestBuilder WithBodyAsJson(object body, MatchBehaviour matchBehaviour = MatchBehaviour.AcceptOnMatch);
+
+    /// <summary>
+    /// WithBody : Body as a string response based on a object (which will be converted to a JSON string using the <see cref="IJsonConverter"/>).
+    /// </summary>
+    /// <param name="body">The body.</param>
+    /// <param name="converter">The JsonConverter.</param>
+    /// <param name="options">The <see cref="JsonConverterOptions"/> [optional].</param>
+    /// <param name="matchBehaviour">The match behaviour [default is AcceptOnMatch].</param>
+    /// <returns>A <see cref="IRequestBuilder"/>.</returns>
+    IRequestBuilder WithBodyAsJson(object body, IJsonConverter converter, JsonConverterOptions? options = null, MatchBehaviour matchBehaviour = MatchBehaviour.AcceptOnMatch);
+
     /// <summary>
     /// WithBody: func (string)
     /// </summary>

src/WireMock.Net/RequestBuilders/Request.WithBody.cs

@@ -2,10 +2,12 @@
 // For more details see 'mock4net/LICENSE.txt' and 'mock4net/readme.md' in this project root.
 using System;
 using System.Collections.Generic;
+using JsonConverter.Abstractions;
+using Newtonsoft.Json;
+using Stef.Validation;
 using WireMock.Matchers;
 using WireMock.Matchers.Request;
 using WireMock.Util;
-using Stef.Validation;
 
 namespace WireMock.RequestBuilders;
 
@@ -32,6 +34,24 @@ public partial class Request
         return this;
     }
 
+    /// <inheritdoc />
+    public IRequestBuilder WithBodyAsJson(object body, MatchBehaviour matchBehaviour = MatchBehaviour.AcceptOnMatch)
+    {
+        var bodyAsJsonString = JsonConvert.SerializeObject(body);
+        _requestMatchers.Add(new RequestMessageBodyMatcher(matchBehaviour, bodyAsJsonString));
+        return this;
+    }
+
+    /// <inheritdoc />
+    public IRequestBuilder WithBodyAsJson(object body, IJsonConverter converter, JsonConverterOptions? options = null, MatchBehaviour matchBehaviour = MatchBehaviour.AcceptOnMatch)
+    {
+        Guard.NotNull(converter);
+
+        var bodyAsJsonString = converter.Serialize(body, options);
+        _requestMatchers.Add(new RequestMessageBodyMatcher(matchBehaviour, bodyAsJsonString));
+        return this;
+    }
+
     /// <inheritdoc />
     public IRequestBuilder WithBody(IMatcher matcher)
     {

src/WireMock.Net/ResponseBuilders/IBodyResponseBuilder.cs

@@ -92,7 +92,7 @@ public interface IBodyResponseBuilder : IFaultResponseBuilder
     /// </summary>
     /// <param name="body">The body.</param>
     /// <param name="converter">The JsonConverter.</param>
-    /// <param name="options">The IJsonConverterOption [optional].</param>
+    /// <param name="options">The <see cref="JsonConverterOptions"/> [optional].</param>
     /// <returns>A <see cref="IResponseBuilder"/>.</returns>
     IResponseBuilder WithBody(object body, IJsonConverter converter, JsonConverterOptions? options = null);
 
@@ -102,7 +102,7 @@ public interface IBodyResponseBuilder : IFaultResponseBuilder
     /// <param name="body">The body.</param>
     /// <param name="encoding">The body encoding, can be <c>null</c>.</param>
     /// <param name="converter">The JsonConverter.</param>
-    /// <param name="options">The IJsonConverterOption [optional].</param>
+    /// <param name="options">The <see cref="JsonConverterOptions"/> [optional].</param>
     /// <returns>A <see cref="IResponseBuilder"/>.</returns>
     IResponseBuilder WithBody(object body, Encoding? encoding, IJsonConverter converter, JsonConverterOptions? options = null);
 }

src/WireMock.Net/Util/QueryStringParser.cs

@@ -32,7 +32,7 @@ internal static class QueryStringParser
         {
             if (part.Length == 2)
             {
-                nameValueCollection.Add(part[0], part[1]);
+                nameValueCollection.Add(part[0], WebUtility.UrlDecode(part[1]));
             }
         }
 

test/WireMock.Net.Tests/RequestWithBodyTests.cs

@@ -2,6 +2,8 @@ using System;
 using System.Collections.Generic;
 using System.Text;
 using FluentAssertions;
+using JsonConverter.Abstractions;
+using Moq;
 using Newtonsoft.Json;
 using NFluent;
 using WireMock.Matchers;
@@ -134,7 +136,7 @@ namespace WireMock.Net.Tests
         }
 
         [Fact]
-        public void Request_BodyAsString_Using_WildcardMatcher()
+        public void Request_WithBody_BodyDataAsString_Using_WildcardMatcher()
         {
             // Arrange
             var spec = Request.Create().WithPath("/foo").UsingAnyMethod().WithBody(new WildcardMatcher("H*o*"));
@@ -153,7 +155,7 @@ namespace WireMock.Net.Tests
         }
 
         [Fact]
-        public void Request_BodyAsJson_Using_WildcardMatcher()
+        public void Request_WithBody_BodyDataAsJson_Using_WildcardMatcher()
         {
             // Arrange
             var spec = Request.Create().WithPath("/foo").UsingAnyMethod().WithBody(new WildcardMatcher("*Hello*"));
@@ -349,6 +351,56 @@ namespace WireMock.Net.Tests
             Check.That(requestBuilder.GetMatchingScore(request, requestMatchResult)).IsEqualTo(1.0);
         }
 
+        [Fact]
+        public void Request_WithBodyAsJson_UsingObject()
+        {
+            // Assign
+            object body = new
+            {
+                Test = "abc"
+            };
+            var requestBuilder = Request.Create().UsingAnyMethod().WithBodyAsJson(body);
+
+            var bodyData = new BodyData
+            {
+                BodyAsString = JsonConvert.SerializeObject(body),
+                DetectedBodyType = BodyType.String
+            };
+
+            // Act
+            var request = new RequestMessage(new UrlDetails("http://localhost/foo"), "POST", ClientIp, bodyData);
+
+            // Assert
+            var requestMatchResult = new RequestMatchResult();
+            Check.That(requestBuilder.GetMatchingScore(request, requestMatchResult)).IsEqualTo(1.0);
+        }
+
+        [Fact]
+        public void Request_WithBodyAsJson_WithIJsonConverter_UsingObject()
+        {
+            // Assign
+            var jsonConverterMock = new Mock<IJsonConverter>();
+            jsonConverterMock.Setup(j => j.Serialize(It.IsAny<object>(), It.IsAny<JsonConverterOptions>())).Returns("test");
+            object body = new
+            {
+                Any = "key"
+            };
+            var requestBuilder = Request.Create().UsingAnyMethod().WithBodyAsJson(body, jsonConverterMock.Object);
+
+            var bodyData = new BodyData
+            {
+                BodyAsString = "test",
+                DetectedBodyType = BodyType.String
+            };
+
+            // Act
+            var request = new RequestMessage(new UrlDetails("http://localhost/foo"), "POST", ClientIp, bodyData);
+
+            // Assert
+            var requestMatchResult = new RequestMatchResult();
+            Check.That(requestBuilder.GetMatchingScore(request, requestMatchResult)).IsEqualTo(1.0);
+        }
+
         [Theory]
         [InlineData(new byte[] { 1 }, BodyType.Bytes)]
         [InlineData(new byte[] { 48, 49, 50 }, BodyType.Bytes)]

test/WireMock.Net.Tests/Util/QueryStringParserTests.cs

@@ -38,6 +38,21 @@ public class QueryStringParserTests
         actual.Should().BeEquivalentTo(expectedOutput);
     }
 
+    [Fact]
+    public void TryParse_Should_Parse_QueryStringWithUrlEncodedValues()
+    {
+        // Arrange
+        var key = "x";
+        var value = "rNaCP7hv8UOmS%2FJcujdvLw%3D%3D";
+
+        // Act
+        var result = QueryStringParser.TryParse($"{key}={value}", true, out var actual);
+
+        // Assert
+        result.Should().BeTrue();
+        actual.Should().BeEquivalentTo(new Dictionary<string, string> { { "x", "rNaCP7hv8UOmS/JcujdvLw==" } });
+    }
+
     [Fact]
     public void Parse_WithNullString()
     {