Merge pull request #233 from 7digital/postwithbodyandquery

POST/PUT with a body and query string parameters

Author: johnjcorcoran

.gitignore

@@ -17,6 +17,7 @@ build/spec/report.html
 *.DotSettings
 *.docstates
 *.ncrunchsolution
+*.ncrunchproject
 packages/*/**
 /.nuget/nuget.exe
 packages/*/**

src/SevenDigital.Api.Wrapper.Integration.Tests/EndpointTests/OAuth/OAuthRequestTokenTest.cs

@@ -20,7 +20,7 @@ public async void Should_allow_POSTing_to_request_token_endpoint()
 		{
 			var api = (FluentApi<OAuthRequestToken>) Api<OAuthRequestToken>.Create;
 
-			api.WithMethod(HttpMethod.Post).WithParameter("one", "two");
+			api.WithMethod(HttpMethod.Post).WithParameter("userid", "two");
 
 			var requestToken = await api.Please();
 
@@ -43,7 +43,7 @@ public async void Can_handle_odd_characters_in_get_signing_process()
 		{
 			var oAuthRequestToken = await Api<OAuthRequestToken>
 				.Create
-				.WithParameter("foo", "%! blah") //arbitrary parameter, but should test for errors in signature generation
+				.WithParameter("userid", "%! blah") //arbitrary parameter, but should test for errors in signature generation
 				.Please();
 
 			Assert.That(oAuthRequestToken.Secret, Is.Not.Empty);
@@ -56,7 +56,7 @@ public async void Can_handle_odd_characters_in_post_signing_process()
 			var api = (FluentApi<OAuthRequestToken>) Api<OAuthRequestToken>.Create;
 
 			api.WithMethod(HttpMethod.Post);
-			api.WithParameter("foo", "%! blah"); //arbitrary parameter, but should test for errors in signature generation
+			api.WithParameter("userid", "%! blah"); //arbitrary parameter, but should test for errors in signature generation
 
 			var oAuthRequestToken = await api.Please();
 

src/SevenDigital.Api.Wrapper.Unit.Tests/Requests/RequestBuilderMethodTests.cs

@@ -61,52 +61,23 @@ public void Should_use_secure_uri_when_requested()
 		[TestCase]
 		public void Should_include_parameters_in_querystring()
 		{
-			if (!TestedHttpMethod.HasParamsInQueryString())
-			{
-				Assert.Ignore("This http method does not use params in query string");
-			}
-
 			var requestData = MakeRequestData(TestedHttpMethod, false);
 			requestData.Parameters.Add("foo", "bar");
 
 			var request = _requestBuilder.BuildRequest(requestData);
 
 			Assert.That(request.Url, Is.StringContaining("?foo=bar"));
-			Assert.That(request.Body.Data, Is.Empty);
 		}
 
 		[TestCase]
-		public void Should_include_parameters_in_body()
+		public void Should_include_parameters_in_querystring_when_signed()
 		{
-			if (!TestedHttpMethod.ShouldHaveRequestBody())
-			{
-				Assert.Ignore("This http method does not use the request body");
-			}
-
-			var requestData = MakeRequestData(TestedHttpMethod, false);
-			requestData.Parameters.Add("foo", "bar");
-
-			var request = _requestBuilder.BuildRequest(requestData);
-
-			Assert.That(request.Url, Is.Not.StringContaining("foo=bar"));
-			Assert.That(request.Body.Data, Is.StringContaining("foo=bar"));
-		}
-
-		[TestCase]
-		public void Should_include_parameters_in_body_when_signed()
-		{
-			if (!TestedHttpMethod.ShouldHaveRequestBody())
-			{
-				Assert.Ignore("This http method does not use the request body");
-			}
-
 			var requestData = MakeRequestData(TestedHttpMethod, true);
 			requestData.Parameters.Add("foo", "bar");
 
 			var request = _requestBuilder.BuildRequest(requestData);
 
-			Assert.That(request.Url, Is.Not.StringContaining("foo=bar"));
-			Assert.That(request.Body.Data, Is.StringContaining("foo=bar"));
+			Assert.That(request.Url, Is.StringContaining("?foo=bar")); ;
 		}
 
 		[TestCase]

src/SevenDigital.Api.Wrapper.Unit.Tests/Requests/RequestBuilderTests.cs

@@ -84,11 +84,11 @@ public void Should_use_api_uri_provided_by_IApiUri_interface()
 		}
 
 		[Test]
-		public void Post_data_with_params_defaults_to_key_value_pair_post_body()
+		public void Post_data_with_params_defaults_to_params()
 		{
 			var parameters = new Dictionary<string, string>
 			{
-				{"one", "one"}
+				{"one", "foo"}
 			};
 			var requestData = new RequestData
 			{
@@ -97,16 +97,15 @@ public void Post_data_with_params_defaults_to_key_value_pair_post_body()
 			};
 
 			var request = _requestBuilder.BuildRequest(requestData);
-			Assert.That(request.Body.Data, Is.EqualTo(parameters.ToQueryString()));
-			Assert.That(request.Body.ContentType, Is.EqualTo("application/x-www-form-urlencoded"));
+			Assert.That(request.Url, Is.StringContaining("?one=foo"));
 		}
 
 		[Test]
-		public void Post_data_with_params_and_requestBody_defaults_to_key_value_pair_post_body()
+		public void Post_data_with_params_and_requestBody_defaults_to_params_and_retains_request_body()
 		{
 			var parameters = new Dictionary<string, string>
 			{
-				{"one", "one"}
+				{"one", "foo"}
 			};
 			var requestData = new RequestData
 			{
@@ -116,8 +115,9 @@ public void Post_data_with_params_and_requestBody_defaults_to_key_value_pair_pos
 			};
 
 			var request = _requestBuilder.BuildRequest(requestData);
-			Assert.That(request.Body.Data, Is.EqualTo(parameters.ToQueryString()));
-			Assert.That(request.Body.ContentType, Is.EqualTo("application/x-www-form-urlencoded"));
+			Assert.That(request.Url, Is.StringContaining("?one=foo"));
+			Assert.That(request.Body.Data, Is.EqualTo(requestData.Payload.Data));
+			Assert.That(request.Body.ContentType, Is.EqualTo("text/plain"));
 		}
 
 		[Test]

src/SevenDigital.Api.Wrapper/Http/HttpMethodHelpers.cs

@@ -22,14 +22,9 @@ public static HttpMethod Parse(string methodName)
 			}
 		}
 
-		public static bool HasParamsInQueryString(this HttpMethod method)
-		{
-			return (method == HttpMethod.Get) || (method == HttpMethod.Delete);
-		}
-
 		public static bool ShouldHaveRequestBody(this HttpMethod method)
 		{
-			return (method == HttpMethod.Post) || (method == HttpMethod.Put);
+			return method == HttpMethod.Post || method == HttpMethod.Put;
 		}
 	}
 }

src/SevenDigital.Api.Wrapper/Requests/RequestBuilder.cs

@@ -36,7 +36,7 @@ public Request BuildRequest(RequestData requestData)
 			var traceId = requestData.TraceId ?? Guid.NewGuid().ToString();
 			headers.Add("x-7d-traceid", traceId);
 
-			if (requestData.HttpMethod.HasParamsInQueryString() && (apiRequest.Parameters.Count > 0))
+			if (apiRequest.Parameters.Count > 0)
 			{
 				fullUrl += "?" + apiRequest.Parameters.ToQueryString();
 			}
@@ -47,20 +47,14 @@ public Request BuildRequest(RequestData requestData)
 		private static RequestPayload CheckForRequestPayload(RequestData requestData, IDictionary<string,string> requestParameters)
 		{
 			var shouldHaveRequestBody = requestData.HttpMethod.ShouldHaveRequestBody();
-			var hasSuppliedParameters = requestParameters.Count > 0;
 			var hasSuppliedARequestPayload = requestData.Payload != null;
 
-			if (shouldHaveRequestBody && hasSuppliedParameters)
-			{
-				return new RequestPayload(FormUrlEncoded, requestParameters.ToQueryString());
-			}
-
 			if (shouldHaveRequestBody && hasSuppliedARequestPayload)
 			{
 				return requestData.Payload;
 			}
 
-			return new RequestPayload(FormUrlEncoded, "");
+			return new RequestPayload(FormUrlEncoded, requestParameters.ToQueryString());
 		}
 
 		private string GetAuthorizationHeader(RequestData requestData, string fullUrl, ApiRequest apiRequest, RequestPayload requestBody)
@@ -84,6 +78,7 @@ private string BuildOAuthHeader(RequestData requestData, string fullUrl, IDictio
 					Method = httpMethod,
 					ConsumerKey = _oAuthCredentials.ConsumerKey,
 					ConsumerSecret = _oAuthCredentials.ConsumerSecret,
+					
 				};
 
 			if (!string.IsNullOrEmpty(requestData.OAuthToken))