Skip to content

Commit 77baa88

Browse files
sikeliosikelio
authored
Merge pull request #26 from FrApp42/dev/main
Serializing fix & Binary file sending method
2 parents b1b2984 + 16fc840 commit 77baa88

File tree

6 files changed

+84
-56
lines changed

6 files changed

+84
-56
lines changed

‎Web.Test/Models/HttpBinPostResponse.cs‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
1-
using System.Text.Json.Serialization;
1+
using Newtonsoft.Json;
22

33
namespace Web.Test.Models
44
{
55
public class HttpBinPostResponse : HttpBinResponseBase
66
{
7-
[JsonPropertyName("data")]
8-
public string Data { get; set; }
7+
[JsonProperty("data")]
8+
public string Data { get; set; } = string.Empty;
99

10-
[JsonPropertyName("files")]
11-
public Dictionary<string, string> Files { get; set; }
10+
[JsonProperty("files")]
11+
public Dictionary<string, string> Files { get; set; } = [];
1212

13-
[JsonPropertyName("form")]
14-
public Dictionary<string, string> Form { get; set; }
13+
[JsonProperty("form")]
14+
public Dictionary<string, string> Form { get; set; } = [];
1515

16-
[JsonPropertyName("json")]
17-
public object Json { get; set; }
16+
[JsonProperty("json")]
17+
public object Json { get; set; } = new();
1818
}
1919
}

‎Web.Test/Models/HttpBinResponseBase.cs‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,40 @@
1-
using System.Text.Json.Serialization;
1+
using Newtonsoft.Json;
22

33
namespace Web.Test.Models
44
{
55
public class HttpBinResponseBase
66
{
7-
[JsonPropertyName("args")]
8-
public Dictionary<string, string> Args { get; set; }
7+
[JsonProperty("args")]
8+
public Dictionary<string, string> Args { get; set; } = [];
99

10-
[JsonPropertyName("headers")]
11-
public HttpBinResponseHeaders Headers { get; set; }
10+
[JsonProperty("headers")]
11+
public HttpBinResponseHeaders Headers { get; set; } = new();
1212

13-
[JsonPropertyName("origin")]
14-
public string Origin { get; set; }
13+
[JsonProperty("origin")]
14+
public string Origin { get; set; } = string.Empty;
1515

16-
[JsonPropertyName("url")]
17-
public string Url { get; set; }
16+
[JsonProperty("url")]
17+
public string Url { get; set; } = string.Empty;
1818
}
1919

2020
public class HttpBinResponseHeaders
2121
{
22-
[JsonPropertyName("Accept")]
23-
public string Accept { get; set; }
22+
[JsonProperty("Accept")]
23+
public string Accept { get; set; } = string.Empty;
2424

25-
[JsonPropertyName("Accept-Encoding")]
26-
public string AcceptEncoding { get; set; }
25+
[JsonProperty("Accept-Encoding")]
26+
public string AcceptEncoding { get; set; } = string.Empty;
2727

28-
[JsonPropertyName("Accept-Language")]
29-
public string AcceptLanguage { get; set; }
28+
[JsonProperty("Accept-Language")]
29+
public string AcceptLanguage { get; set; } = string.Empty;
3030

31-
[JsonPropertyName("Host")]
32-
public string Host { get; set; }
31+
[JsonProperty("Host")]
32+
public string Host { get; set; } = string.Empty;
3333

34-
[JsonPropertyName("User-Agent")]
35-
public string UserAgent { get; set; }
34+
[JsonProperty("User-Agent")]
35+
public string UserAgent { get; set; } = string.Empty;
3636

37-
[JsonPropertyName("X-Amzn-Trace-Id")]
38-
public string AmazonTraceId { get; set; }
39-
}
37+
[JsonProperty("X-Amzn-Trace-Id")]
38+
public string AmazonTraceId { get; set; } = string.Empty;
39+
}
4040
}

‎Web.Test/RequestTest.cs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,12 +72,12 @@ public async Task SendPostRequestWithFile()
7272
Request request = new(TestPostUrl, HttpMethod.Post);
7373
request
7474
.SetContentType("text/plain")
75-
.AddDocumentBody(fileBytes, fileName);
75+
.AddByteBody(fileBytes, fileName);
7676

7777
Result<HttpBinPostFileResponse> result = await request.RunDocument<HttpBinPostFileResponse>();
7878

7979
AssertResponse(result, TestPostUrl);
80-
StringAssert.Contains(result.Value.Data, "Hello world", "File content should contain 'Hello World'");
80+
StringAssert.Contains(result.Value?.Data, "Hello world", "File content should contain 'Hello World'");
8181
}
8282

8383
[TestMethod]
@@ -135,5 +135,5 @@ private void AssertImageResponse(Result<byte[]> result, string imgType)
135135
Assert.IsTrue(result.Value.Length > 0, "Image data should not be empty");
136136
File.WriteAllBytes($"test_image.{imgType}", result.Value);
137137
}
138-
}
138+
}
139139
}

‎Web/API/Request.cs‎

Lines changed: 41 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ namespace FrApp42.Web.API
99
public class Request
1010
{
1111
#region Variables
12+
1213
/// <summary>
1314
/// The HTTP client used to send requests.
1415
/// </summary>
@@ -61,12 +62,13 @@ public class Request
6162
/// <summary>
6263
/// Gets the name of the binary document file.
6364
/// </summary>
64-
public string DocumentFileName { get; private set; } = null;
65+
public string? DocumentFileName { get; private set; } = null;
6566

6667
/// <summary>
6768
/// Gets the content type of the request.
6869
/// </summary>
6970
public string ContentType { get; private set; } = null;
71+
7072
#endregion
7173

7274
#region Constructors
@@ -202,12 +204,12 @@ public Request AddJsonBody(object body)
202204
}
203205

204206
/// <summary>
205-
/// Adds a binary document to the request content.
207+
/// Adds a <see cref="byte[]"/> to the request content.
206208
/// </summary>
207209
/// <param name="document">The binary file content.</param>
208210
/// <param name="fileName">The name of the file.</param>
209211
/// <returns>Instance</returns>
210-
public Request AddDocumentBody(byte[] document, string fileName)
212+
public Request AddByteBody(byte[] document, string? fileName)
211213
{
212214
DocumentBody = document;
213215
DocumentFileName = fileName;
@@ -325,9 +327,38 @@ public async Task<Result<byte[]>> RunGetBytes()
325327
return result;
326328
}
327329

330+
/// <summary>
331+
/// Executes the HTTP request by sending the raw binary content directly in the request body,
332+
/// without using multipart encoding. This method is ideal for APIs expecting direct binary content,
333+
/// equivalent to Postman's "Binary" body type.
334+
/// </summary>
335+
/// <typeparam name="T">The type of the expected response.</typeparam>
336+
/// <returns>
337+
/// A <see cref="Result{T}"/> object containing the deserialized response, the HTTP status code,
338+
/// and any error message if the request fails.
339+
/// </returns>
340+
public async Task<Result<T>> RunBinaryRaw<T>()
341+
{
342+
HttpRequestMessage request = BuildBaseRequest();
343+
344+
if (DocumentBody == null)
345+
{
346+
return new Result<T>
347+
{
348+
Error = "Document cannot be null",
349+
StatusCode = 500
350+
};
351+
}
352+
353+
request.Content = new ByteArrayContent(DocumentBody);
354+
request.Content.Headers.ContentType = new MediaTypeHeaderValue(ContentType ?? "application/octet-stream");
355+
356+
return await Process<T>(request);
357+
}
358+
328359
#endregion
329360

330-
#region Private function
361+
#region Private methods
331362

332363
/// <summary>
333364
/// Constructs the URL for the request, including any query parameters if present.
@@ -403,19 +434,19 @@ private async Task<Result<T>> Process<T>(HttpRequestMessage request)
403434

404435
if (response.IsSuccessStatusCode)
405436
{
406-
string? MediaType = response.Content?.Headers?.ContentType?.MediaType.ToLower();
407-
string ContentResponse = await response.Content?.ReadAsStringAsync();
437+
string? mediaType = response.Content?.Headers?.ContentType?.MediaType.ToLower();
438+
string contentResponse = await response.Content?.ReadAsStringAsync();
408439

409440
switch (true)
410441
{
411-
case bool b when (MediaType.Contains("xml")):
442+
case bool b when (mediaType.Contains("xml")):
412443
XmlSerializer xmlSerializer = new(typeof(T));
413-
StringReader reader = new(ContentResponse);
444+
StringReader reader = new(contentResponse);
414445

415446
result.Value = (T)xmlSerializer.Deserialize(reader);
416447
break;
417-
case bool b when (MediaType.Contains("application/json")):
418-
result.Value = JsonConvert.DeserializeObject<T>(ContentResponse);
448+
case bool b when (mediaType.Contains("application/json")):
449+
result.Value = JsonConvert.DeserializeObject<T>(contentResponse);
419450
break;
420451
default:
421452
result.Value = default;

‎Web/README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Install-Package FrApp42.Net
1515

1616
```csharp
1717
using FrApp42.Web.API;
18-
using System.Text.Json.Serialization;
18+
using Newtonsoft.Json;
1919

2020
string url = "your-url";
2121

@@ -34,10 +34,10 @@ if (result.StatusCode == 200 && result.Value != null)
3434

3535
class MyModel
3636
{
37-
[JsonPropertyName("name")]
37+
[JsonProperty("name")]
3838
public string Name { get; set; }
3939

40-
[JsonPropertyName("description")]
40+
[JsonProperty("description")]
4141
public string Description { get; set; }
4242
}
4343
```

‎Web/Web.csproj‎

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<Project Sdk="Microsoft.NET.Sdk">
22

33
<PropertyGroup>
4-
<TargetFramework>net8.0</TargetFramework>
4+
<TargetFramework>net8.0</TargetFramework>
55
<ImplicitUsings>enable</ImplicitUsings>
66
<Nullable>enable</Nullable>
77
<AssemblyName>FrApp42.$(MSBuildProjectName)</AssemblyName>
@@ -20,10 +20,14 @@
2020
<PackageReadmeFile>README.md</PackageReadmeFile>
2121
<Company>FrenchyApps42</Company>
2222
<PackageIcon>logo.png</PackageIcon>
23-
<Version>1.2.2</Version>
23+
<Version>1.3.0</Version>
2424
</PropertyGroup>
2525

2626
<ItemGroup>
27+
<None Update="README.md">
28+
<PackagePath>\</PackagePath>
29+
<Pack>True</Pack>
30+
</None>
2731
<None Include="..\LICENCE.md">
2832
<Pack>True</Pack>
2933
<PackagePath>\</PackagePath>
@@ -38,11 +42,4 @@
3842
<PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
3943
</ItemGroup>
4044

41-
<ItemGroup>
42-
<None Update="README.md">
43-
<PackagePath>\</PackagePath>
44-
<Pack>True</Pack>
45-
</None>
46-
</ItemGroup>
47-
4845
</Project>

0 commit comments

Comments
 (0)