8000 Add support for controlling how string body parameters are serialized by clairernovotny · Pull Request #425 · reactiveui/refit · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Add support for controlling how string body parameters are serialized #425

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 29, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Refit.Tests/InterfaceStubGenerator.cs
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ public void GenerateClassInfoForInterfaceSmokeTest()

var result = fixture.GenerateClassInfoForInterface(input);

Assert.Equal(10, result.MethodList.Count);
Assert.Equal(11, result.MethodList.Count);
Assert.Equal("GetUser", result.MethodList[0].Name);
Assert.Equal("string userName", result.MethodList[0].ArgumentListWithTypes);
Assert.Equal("IGitHubApi", result.InterfaceName);
Expand Down
24 changes: 24 additions & 0 deletions Refit.Tests/RefitStubs.Net46.cs
Original file line number Diff line number Diff line change
Expand Up @@ -603,6 +603,9 @@ public AutoGeneratedIRequestBin(HttpClient client, IRequestBuilder requestBuilde
{
Client = client;
methodImpls.Add("Post()", requestBuilder.BuildRestResultFuncForMethod("Post", new Type[] { }));
methodImpls.Add("PostRawStringDefault(string str)", requestBuilder.BuildRestResultFuncForMethod("PostRawStringDefault", new Type[] { typeof(string) }));
methodImpls.Add("PostRawStringJson(string str)", requestBuilder.BuildRestResultFuncForMethod("PostRawStringJson", new Type[] { typeof(string) }));
methodImpls.Add("PostRawStringUrlEncoded(string str)", requestBuilder.BuildRestResultFuncForMethod("PostRawStringUrlEncoded", new Type[] { typeof(string) }));
}

/// <inheritdoc />
Expand All @@ -612,6 +615,27 @@ public virtual Task Post()
return (Task) methodImpls["Post()"](Client, arguments);
}

/// <inheritdoc />
public virtual Task PostRawStringDefault(string str)
{
var arguments = new object[] { str };
return (Task) methodImpls["PostRawStringDefault(string str)"](Client, arguments);
}

/// <inheritdoc />
public virtual Task PostRawStringJson(string str)
{
var arguments = new object[] { str };
return (Task) methodImpls["PostRawStringJson(string str)"](Client, arguments);
}

/// <inheritdoc />
public virtual Task PostRawStringUrlEncoded(string str)
{
var arguments = new object[] { str };
return (Task) methodImpls["PostRawStringUrlEncoded(string str)"](Client, arguments);
}

}
}

Expand Down
24 changes: 24 additions & 0 deletions Refit.Tests/RefitStubs.NetCore2.cs
Original file line number Diff line number Diff line change
Expand Up @@ -603,6 +603,9 @@ public AutoGeneratedIRequestBin(HttpClient client, IRequestBuilder requestBuilde
{
Client = client;
methodImpls.Add("Post()", requestBuilder.BuildRestResultFuncForMethod("Post", new Type[] { }));
methodImpls.Add("PostRawStringDefault(string str)", requestBuilder.BuildRestResultFuncForMethod("PostRawStringDefault", new Type[] { typeof(string) }));
methodImpls.Add("PostRawStringJson(string str)", requestBuilder.BuildRestResultFuncForMethod("PostRawStringJson", new Type[] { typeof(string) }));
methodImpls.Add("PostRawStringUrlEncoded(string str)", requestBuilder.BuildRestResultFuncForMethod("PostRawStringUrlEncoded", new Type[] { typeof(string) }));
}

/// <inheritdoc />
Expand All @@ -612,6 +615,27 @@ public virtual Task Post()
return (Task) methodImpls["Post()"](Client, arguments);
}

/// <inheritdoc />
public virtual Task PostRawStringDefault(string str)
{
var arguments = new object[] { str };
return (Task) methodImpls["PostRawStringDefault(string str)"](Client, arguments);
}

/// <inheritdoc />
public virtual Task PostRawStringJson(string str)
{
var arguments = new object[] { str };
return (Task) methodImpls["PostRawStringJson(string str)"](Client, arguments);
}

/// <inheritdoc />
public virtual Task PostRawStringUrlEncoded(string str)
{
var arguments = new object[] { str };
return (Task) methodImpls["PostRawStringUrlEncoded(string str)"](Client, arguments);
}

}
}

Expand Down
4 changes: 2 additions & 2 deletions Refit.Tests/RequestBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -293,7 +293,7 @@ public void ValueTypesDontBlowUp()
var fixture = new RestMethodInfo(input, input.GetMethods().First(x => x.Name == "OhYeahValueTypes"));
Assert.Equal("id", fixture.ParameterMap[0]);
Assert.Empty(fixture.QueryParameterMap);
Assert.Equal(BodySerializationMethod.Json, fixture.BodyParameterInfo.Item1);
Assert.Equal(BodySerializationMethod.Default, fixture.BodyParameterInfo.Item1);
Assert.False(fixture.BodyParameterInfo.Item2);
Assert.Equal(1, fixture.BodyParameterInfo.Item3);

Expand All @@ -307,7 +307,7 @@ public void StreamMethodPullWorks()
var fixture = new RestMethodInfo(input, input.GetMethods().First(x => x.Name == "PullStreamMethod"));
Assert.Equal("id", fixture.ParameterMap[0]);
Assert.Empty(fixture.QueryParameterMap);
Assert.Equal(BodySerializationMethod.Json, fixture.BodyParameterInfo.Item1);
Assert.Equal(BodySerializationMethod.Default, fixture.BodyParameterInfo.Item1);
Assert.True(fixture.BodyParameterInfo.Item2);
Assert.Equal(1, fixture.BodyParameterInfo.Item3);

Expand Down
77 changes: 77 additions & 0 deletions Refit.Tests/RestService.cs
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,15 @@ public interface IRequestBin
{
[Post("/1h3a5jm1")]
Task Post();

[Post("/foo")]
Task PostRawStringDefault([Body] string str);

[Post("/foo")]
Task PostRawStringJson([Body(BodySerializationMethod.Json)] string str);

[Post("/foo")]
Task PostRawStringUrlEncoded([Body(BodySerializationMethod.UrlEncoded)] string str);
}

public interface INoRefitHereBuddy
Expand Down Expand Up @@ -463,6 +472,74 @@ public async Task PostToRequestBin()
mockHttp.VerifyNoOutstandingExpectation();
}

[Fact]
public async Task PostStringDefaultToRequestBin()
{
var mockHttp = new MockHttpMessageHandler();

var settings = new RefitSettings
{
HttpMessageHandlerFactory = () => mockHttp
};

mockHttp.Expect(HttpMethod.Post, "http://httpbin.org/foo")
.WithContent("raw string")
.Respond(HttpStatusCode.OK);

var fixture = RestService.For<IRequestBin>("http://httpbin.org/", settings);


await fixture.PostRawStringDefault("raw string");

mockHttp.VerifyNoOutstandingExpectation();
}

[Fact]
public async Task PostStringJsonToRequestBin()
{
var mockHttp = new MockHttpMessageHandler();

var settings = new RefitSettings
{
HttpMessageHandlerFactory = () => mockHttp
};

mockHttp.Expect(HttpMethod.Post, "http://httpbin.org/foo")
.WithContent("\"json string\"")
.WithHeaders("Content-Type", "application/json")
.Respond(HttpStatusCode.OK);

var fixture = RestService.For<IRequestBin>("http://httpbin.org/", settings);


await fixture.PostRawStringJson("json string");

mockHttp.VerifyNoOutstandingExpectation();
}

[Fact]
public async Task PostStringUrlToRequestBin()
{
var mockHttp = new MockHttpMessageHandler();

var settings = new RefitSettings
{
HttpMessageHandlerFactory = () => mockHttp
};

mockHttp.Expect(HttpMethod.Post, "http://httpbin.org/foo")
.WithContent("url%26string")
.WithHeaders("Content-Type", "application/x-www-form-urlencoded; charset=utf-8")
.Respond(HttpStatusCode.OK);

var fixture = RestService.For<IRequestBin>("http://httpbin.org/", settings);


await fixture.PostRawStringUrlEncoded ("url&string");

mockHttp.VerifyNoOutstandingExpectation();
}

[Fact]
public async Task CanGetDataOutOfErrorResponses()
{
Expand Down
14 changes: 13 additions & 1 deletion Refit/Attributes.cs
Original file line number Diff line number Diff line change
Expand Up @@ -95,14 +95,26 @@ public class MultipartAttribute : Attribute { }

public enum BodySerializationMethod
{
/// <summary>
/// JSON encodes data except for strings. Strings are set as-is
/// </summary>
Default,

/// <summary>
/// Json encodes everything, including strings
/// </summary>
Json,

/// <summary>
/// Form-UrlEncode's the values
/// </summary>
UrlEncoded
}

[AttributeUsage(AttributeTargets.Parameter)]
public class BodyAttribute : Attribute
{
public BodyAttribute(BodySerializationMethod serializationMethod = BodySerializationMethod.Json,
public BodyAttribute(BodySerializationMethod serializationMethod = BodySerializationMethod.Default,
bool buffered = false)
{
SerializationMethod = serializationMethod;
Expand Down
12 changes: 6 additions & 6 deletions Refit/RequestBuilderImplementation.cs
Original file line number Diff line number Diff line change
Expand Up @@ -393,18 +393,17 @@ Func<object[], HttpRequestMessage> BuildRequestFactoryForMethod(RestMethodInfo r
// if marked as body, add to content
if (restMethod.BodyParameterInfo != null && restMethod.BodyParameterInfo.Item3 == i)
{
var streamParam = paramList[i] as Stream;
var stringParam = paramList[i] as string;

if (paramList[i] is HttpContent httpContentParam)
{
ret.Content = httpContentParam;
}
else if (streamParam != null)
else if (paramList[i] is Stream streamParam)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

❤️

{
ret.Content = new StreamContent(streamParam);
}
else if (stringParam != null)
// Default sends raw strings
else if (restMethod.BodyParameterInfo.Item1 == BodySerializationMethod.Default &&
paramList[i] is string stringParam)
{
ret.Content = new StringContent(stringParam);
}
Expand All @@ -413,8 +412,9 @@ Func<object[], HttpRequestMessage> BuildRequestFactoryForMethod(RestMethodInfo r
switch (restMethod.BodyParameterInfo.Item1)
{
case BodySerializationMethod.UrlEncoded:
ret.Content = new FormUrlEncodedContent(new FormValueDictionary(paramList[i], settings));
ret.Content = paramList[i] is string str ? (HttpContent)new StringContent(Uri.EscapeDataString(str), Encoding.UTF8, "application/x-www-form-urlencoded") : new FormUrlEncodedContent(new FormValueDictionary(paramList[i], settings));
break;
case BodySerializationMethod.Default:
case BodySerializationMethod.Json:
var param = paramList[i];
switch (restMethod.BodyParameterInfo.Item2)
Expand Down
0