feat(http client builder): configurable http version/policy via WithVersion, WithVersionPolicy (#83)

* feat(http client builder): configurable http version/policy via `WithVersion`, `WithVersionPolicy`

* up readme with dotnet support

Author: stephenlautier

CHANGELOG.md

@@ -2,6 +2,16 @@
 
 [_vNext_](https://github.com/sketch7/FluentlyHttpClient/compare/3.8.1...3.9.0) (2020-X-X)
 
+## [4.0.0](https://github.com/sketch7/FluentlyHttpClient/compare/3.9.6...4.0.0) (2024-07-23)
+
+### Features
+- **http client builder:** configurable http version/policy via `WithVersion`, `WithVersionPolicy`
+- **http client builder:** defaults to http version http2.0
+
+### BREAKING CHANGES
+
+- **deps:** now target .net8
+
 ## [3.9.6](https://github.com/sketch7/FluentlyHttpClient/compare/3.9.5...3.9.6) (2024-06-11)
 
 ### Features

Directory.Build.props

@@ -38,6 +38,6 @@
   </PropertyGroup>
 
   <PropertyGroup>
-    <TargetFramework>netstandard2.0</TargetFramework>
+    <TargetFramework>net8.0</TargetFramework>
   </PropertyGroup>
 </Project>

Directory.Packages.props

@@ -6,10 +6,10 @@
     <!-- system -->
     <PackageVersion Include="System.Data.HashFunction.xxHash" Version="2.0.0" />
     <!-- microsoft packages -->
-    <PackageVersion Include="Microsoft.Extensions.Caching.Memory" Version="2.2.0" />
-    <PackageVersion Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="2.2.0" />
-    <PackageVersion Include="Microsoft.Extensions.Http" Version="2.2.0" />
-    <PackageVersion Include="Microsoft.Extensions.Logging.Abstractions" Version="2.2.0" />
+    <PackageVersion Include="Microsoft.Extensions.Caching.Memory" Version="8.0.0" />
+    <PackageVersion Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="8.0.0" />
+    <PackageVersion Include="Microsoft.Extensions.Http" Version="8.0.0" />
+    <PackageVersion Include="Microsoft.Extensions.Logging.Abstractions" Version="8.0.0" />
 
     <PackageVersion Include="Microsoft.Extensions.DependencyInjection" Version="8.0.0" />
     <PackageVersion Include="Microsoft.Extensions.Logging" Version="8.0.0" />

README.md

@@ -30,6 +30,15 @@ Available for [.NET Standard 2.0+](https://docs.microsoft.com/en-gb/dotnet/stand
 
 NOTE: 1.x depends on .NET Standard 1.4+, use that if you need older .NET standard.
 
+## dotnet support
+
+| Version | .NET               | Status                                                                                                                                                                                               |
+| ------- | ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| 1.x     | .NET Standard 1.4+ |                                                                                                                                                                                                      |
+| 2.x     | .NET Standard 2    |                                                                                                                                                                                                      |
+| 3.x     | .NET Standard 2    | [![CI](https://github.com/sketch7/FluentlyHttpClient/actions/workflows/dotnet-publish.yml/badge.svg?branch=3.x)](https://github.com/sketch7/FluentlyHttpClient/actions/workflows/dotnet-publish.yml) |
+| 4.x     | net8               | [![CI](https://github.com/sketch7/FluentlyHttpClient/actions/workflows/dotnet-publish.yml/badge.svg?branch=4.x)](https://github.com/sketch7/FluentlyHttpClient/actions/workflows/dotnet-publish.yml) |
+
 ### NuGet
 ```
 PM> Install-Package FluentlyHttpClient
@@ -135,7 +144,7 @@ Fluent request API (request builder) allows to create more complex requests and
 var httpClient = fluentHttpClientFactory.Get(identifier: "platform");
 
 // HTTP GET + return response and deserialize result (fluent API)
-FluentHttpResponse<Hero> response = 
+FluentHttpResponse<Hero> response =
   await httpClient.CreateRequest("/api/heroes/azmodan")
     .ReturnAsResponse<Hero>(); // return with response
 
@@ -410,7 +419,7 @@ fluentHttpClientFactory.CreateBuilder("platform")
           WarnThreshold = TimeSpan.Zero
       }) // register a middleware using extension method
 ```
-As a best practice, it's best to provide an extension method for usage such as `UseTimer` 
+As a best practice, it's best to provide an extension method for usage such as `UseTimer`
 especially when it has any arguments (options), as it won't be convenient to use.
 
 
@@ -455,7 +464,7 @@ public static class FluentHttpRequestBuilderExtensions
 ```
 
 #### Extending Request Builder/Client Builder headers
-In order to extend headers for both `FluentHttpClientBuilder` and `FluentHttpRequestBuilder`, the best approach would be to extend on 
+In order to extend headers for both `FluentHttpClientBuilder` and `FluentHttpRequestBuilder`, the best approach would be to extend on
 `IFluentHttpHeaderBuilder<T>`, this way it will be available for both. See example below.
 
 ```cs

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sketch7/fluently-http-client",
-  "version": "3.9.6",
+  "version": "4.0.0",
   "versionSuffix": "",
   "scripts": {
     "pack": "bash ./tools/pack.sh",

src/FluentlyHttpClient.Entity/FluentlyHttpClient.Entity.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFramework>netstandard2.0</TargetFramework>
+    <!-- <TargetFramework>netstandard2.0</TargetFramework> -->
     <Description>Fluent Http Client with a fluent APIs which are intuitive, easy to use and also highly extensible.</Description>
     <PackageTags>$(PackageTags) ef entityframework</PackageTags>
   </PropertyGroup>

src/FluentlyHttpClient/FluentHttpRequestBuilder.cs

@@ -1,4 +1,5 @@
 using Microsoft.Extensions.Primitives;
+using System.Net;
 using System.Text.RegularExpressions;
 
 namespace FluentlyHttpClient;
@@ -8,6 +9,18 @@ namespace FluentlyHttpClient;
 /// </summary>
 public class FluentHttpRequestBuilder : IFluentHttpHeaderBuilder<FluentHttpRequestBuilder>, IFluentHttpMessageItems
 {
+	internal static Version _defaultVersion = HttpVersion.Version20;
+
+	/// <summary>
+	/// Gets the HTTP Version for the Http Request.
+	/// </summary>
+	public Version Version { get; private set; } = _defaultVersion;
+
+	/// <summary>
+	/// Gets the HTTP Version for the Http Request.
+	/// </summary>
+	public HttpVersionPolicy? VersionPolicy { get; private set; }
+
 	/// <summary>
 	/// Gets the HTTP Method for the Http Request.
 	/// </summary>
@@ -78,6 +91,26 @@ public FluentHttpRequestBuilder WithMethod(HttpMethod method)
 		return this;
 	}
 
+	/// <summary>
+	/// Set request HTTP version with specified version.
+	/// </summary>
+	/// <returns>Returns request builder for chaining.</returns>
+	public FluentHttpRequestBuilder WithVersion(Version version)
+	{
+		Version = version;
+		return this;
+	}
+
+	/// <summary>
+	/// Set request HTTP version policy with specified policy.
+	/// </summary>
+	/// <returns>Returns request builder for chaining.</returns>
+	public FluentHttpRequestBuilder WithVersionPolicy(HttpVersionPolicy policy)
+	{
+		VersionPolicy = policy;
+		return this;
+	}
+
 	/// <inheritdoc />
 	public FluentHttpRequestBuilder WithHeader(string key, string value)
 	{
@@ -300,7 +333,13 @@ public FluentHttpRequest Build()
 
 		Uri ??= string.Empty;
 		var uri = BuildUri(Uri, _queryParams, _queryStringOptions);
-		var httpRequest = new HttpRequestMessage(HttpMethod, uri);
+		var httpRequest = new HttpRequestMessage(HttpMethod, uri)
+		{
+			Version = Version,
+		};
+		if (VersionPolicy.HasValue)
+			httpRequest.VersionPolicy = VersionPolicy.Value;
+
 		if (_httpBody != null)
 			httpRequest.Content = _httpBody;
 
@@ -358,7 +397,7 @@ private static string BuildUri(string uri, object? queryParams, QueryStringOptio
 		if (string.IsNullOrEmpty(queryString))
 			return uri;
 
-		if (uri.Contains("?"))
+		if (uri.Contains('?'))
 			uri += $"&{queryString}";
 		else
 			uri += $"?{queryString}";

src/FluentlyHttpClient/FluentHttpResponse.cs

@@ -44,6 +44,15 @@ public class FluentHttpResponse : IFluentHttpMessageState
 	/// </summary>
 	public HttpResponseMessage Message { get; }
 
+	/// <summary>
+	/// Gets or sets the version of the HTTP response.
+	/// </summary>
+	public Version Version
+	{
+		get => Message.Version;
+		set => Message.Version = value;
+	}
+
 	/// <summary>
 	/// Gets or sets the status code of the HTTP response.
 	/// </summary>

src/FluentlyHttpClient/FluentlyHttpClient.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFramework>netstandard2.0</TargetFramework>
+    <!-- <TargetFramework>netstandard2.0</TargetFramework> -->
     <Description>Fluent Http Client with a fluent APIs which are intuitive, easy to use and also highly extensible.</Description>
     <PackageTags>$(PackageTags)</PackageTags>
   </PropertyGroup>

test/FluentlyHttpClient.Test.csproj

@@ -17,7 +17,7 @@
     <PackageReference Include="MessagePack" />
     <PackageReference Include="Microsoft.Extensions.DependencyInjection" />
     <PackageReference Include="Microsoft.Extensions.Logging" />
-    <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" VersionOverride="8.0.0" />
+    <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" />
     <PackageReference Include="MimeTypesMap" />
     <PackageReference Include="Serilog.Extensions.Logging" />
     <PackageReference Include="Serilog.Sinks.Console" />