chore : (RequestBuilder) Adding support for versioned api

Author: Notorious-Coding

CHANGELOG.md

@@ -18,4 +18,15 @@
 
 ### 🐛 Bug Fixes
 
-- Fixed a bug where the entire query string was encoded instead of only the query parameter keys and values.
+- Fixed a bug where the entire query string was encoded instead of only the query parameter keys and values.
+
+## 2.1.0
+
+### ✨ Features
+
+- Added support for Versioned API routes via `VersionedEndpoint` class, and `GetBuilder(VersionedEndpoint endpoint)` method signatures.
+- Added support for M2M authentication via M2MAuthenticationClient.
+
+### 🛠 Technical
+
+- Overriding `GetBuilder` now changes the behaviour of `GetBuilderAsync`.

NotoriousClient.Sample/Program.cs

@@ -1,10 +1,9 @@
 // See https://aka.ms/new-console-template for more information
 
 using Microsoft.Extensions.DependencyInjection;
+
 using NotoriousClient.Builder;
-using NotoriousClient.Builder.Authentication;
 using NotoriousClient.Clients;
-using NotoriousClient.Converters;
 using NotoriousClient.Sender;
 
 Console.WriteLine("Hello, World!");
@@ -36,9 +35,8 @@ public class User
 }
 public class UserClient : BaseClient
 {
-    private Endpoint GET_USERS_ENDPOINT = new Endpoint("/api/users", Method.Get);
-    private Endpoint GET_USER_ENDPOINT = new Endpoint("/api/users/{id}", Method.Get);
-    private Endpoint CREATE_USER_ENDPOINT = new Endpoint("/api/users", Method.Post);
+    private Endpoint GET_USERS_ENDPOINT = new Endpoint("/users", Method.Get);
+    private VersionedEndpoint CREATE_USER_ENDPOINT = new VersionedEndpoint("/users", Method.Post, "v1.0");
     public UserClient(IRequestSender sender, string url) : base(sender, url)
     {
     }
@@ -55,18 +53,6 @@ public async Task<IEnumerable<User>> GetUsers()
         return response.ReadAs<IEnumerable<User>>();
     }
 
-    public async Task<IEnumerable<User>> GetUser(int id)
-    {
-        HttpRequestMessage request = GetBuilder(GET_USERS_ENDPOINT)
-            .WithAuthentication("username", "password")
-            .AddEndpointParameter("id", id.ToString())
-            .Build();
-
-        HttpResponseMessage response = await Sender.SendAsync(request);
-
-        return response.ReadAs<IEnumerable<User>>();
-    }
-
     public async Task<IEnumerable<User>> CreateUser(User user)
     {
         HttpRequestMessage request = GetBuilder(CREATE_USER_ENDPOINT)
@@ -94,7 +80,7 @@ public TotoBuilder(string url, string route, Method method) : base(url, route, m
 
     public override HttpRequestMessage Build()
     {
-        HttpRequestMessage request =  base.Build();
+        HttpRequestMessage request = base.Build();
         request.Headers.Add("TOTO", toto);
         return request;
     }

NotoriousClient.Tests.Unit/RequestBuilderURIUnitTests.cs

@@ -53,6 +53,22 @@ public void RequestBuilder_Should_AddUrlSlashProperly()
             Assert.NotNull(request.RequestUri);
             Assert.Equal("https://toto.com/pandas", request.RequestUri.AbsoluteUri);
         }
+
+        [GWTFact(given: "a url, an endpoint, an HTTP Verb and a version",
+                 when: "i build a request",
+                 then: "request has right url, endpoint, verb, and version")]
+        public void RequestBuilder_Should_HandleVersionProperly()
+        {
+            string url = "https://toto.com/api";
+            VersionedEndpoint endpoint = new VersionedEndpoint("pandas", Method.Get, "v1.0");
+
+            RequestBuilder requestBuilder = new RequestBuilder(url, endpoint);
+            HttpRequestMessage request = requestBuilder.Build();
+
+            Assert.Equal(HttpMethod.Get, request.Method);
+            Assert.NotNull(request.RequestUri);
+            Assert.Equal("https://toto.com/api/v1.0/pandas", request.RequestUri.AbsoluteUri);
+        }
         #endregion
 
         #region QueryParams

NotoriousClient.slnx

@@ -0,0 +1,14 @@
+<Solution>
+  <Folder Name="/CI/">
+    <File Path=".github/workflows/prerelease.yml" />
+    <File Path=".github/workflows/release.yml" />
+  </Folder>
+  <Folder Name="/Docs/">
+    <File Path="CHANGELOG.md" />
+    <File Path="LICENSE.txt" />
+    <File Path="README.md" />
+  </Folder>
+  <Project Path="NotoriousClient.Sample/NotoriousClient.Sample.csproj" />
+  <Project Path="NotoriousClient.Tests.Unit/NotoriousClient.Tests.Unit.csproj" />
+  <Project Path="NotoriousClient/NotoriousClient.csproj" />
+</Solution>

NotoriousClient/Builder/RequestBuilder.Uri.cs

@@ -4,6 +4,7 @@ public partial class RequestBuilder : IRequestBuilder
     {
         private string _url;
         private string _route;
+        private string? _version;
         private Dictionary<string, string> _queryParams = new Dictionary<string, string>();
         private Dictionary<string, string> _endpointParams = new Dictionary<string, string>();
         private const char START_ENDPOINT_PARAM = '{';
@@ -113,9 +114,10 @@ private string GetReplacementToken(string key)
         private string GetUri()
         {
             var url = !_url.EndsWith("/") ? _url : _url.Substring(0, _url.Length - 1);
+            var version = !string.IsNullOrEmpty(_version) ? $"/{_version}" : string.Empty;
             var endpoint = _route.StartsWith("/") ? _route : $"/{_route}";
 
-            return url + endpoint;
+            return url + version + endpoint;
         }
         #endregion
     }

NotoriousClient/Builder/RequestBuilder.cs

@@ -3,8 +3,8 @@
     ///<inheritdoc/>
     public partial class RequestBuilder : IRequestBuilder
     {
-        private Method _method;        
-        
+        private Method _method;
+
         /// <summary>
         /// Initialize a new instance of <see cref="RequestBuilder"/>.
         /// </summary>
@@ -20,14 +20,28 @@ public RequestBuilder(string url, string route, Method method)
         /// <summary>
         /// Initialize a new instance of <see cref="RequestBuilder"/>.
         /// </summary>
-        public RequestBuilder(string url, Endpoint endpoint)
+        public RequestBuilder(string url, Endpoint endpoint) : this(url, endpoint.Route, endpoint.Method)
         {
-            if (string.IsNullOrEmpty(url)) throw new ArgumentNullException();
-            ArgumentNullException.ThrowIfNull(endpoint, nameof(endpoint));
+        }
 
+        /// <summary>
+        /// Initialize a new instance of <see cref="RequestBuilder"/>.
+        /// </summary>
+        public RequestBuilder(string url, string route, string? version, Method method)
+        {
+            if (string.IsNullOrEmpty(url)) throw new ArgumentNullException();
+            if (string.IsNullOrEmpty(route)) throw new ArgumentNullException();
             _url = url;
-            _route = endpoint.Route;
-            _method = endpoint.Method;
+            _route = route;
+            _method = method;
+            _version = version;
+        }
+
+        /// <summary>
+        /// Initialize a new instance of <see cref="RequestBuilder"/>.
+        /// </summary>
+        public RequestBuilder(string url, VersionedEndpoint endpoint) : this(url, endpoint.Route, endpoint.Version, endpoint.Method)
+        {
         }
 
         ///<inheritdoc/>

NotoriousClient/Builder/VersionedEndpoint.cs

@@ -0,0 +1,11 @@
+namespace NotoriousClient.Builder
+{
+    public class VersionedEndpoint : Endpoint
+    {
+        public string Version { get; set; }
+        public VersionedEndpoint(string route, Method method, string version) : base(route, method)
+        {
+            Version = version;
+        }
+    }
+}

NotoriousClient/Clients/BaseClient.cs

@@ -16,7 +16,7 @@ public abstract class BaseClient
         protected IRequestSender Sender { get; }
 
         /// <summary>
-        /// Initialize a new instance of <see cref="SynchronousBaseClient"/>.
+        /// Initialize a new instance of <see cref="BaseClient"/>.
         /// </summary>
         /// <param name="sender">Class used to send <see cref="HttpRequestMessage"/>.</param>
         /// <param name="url">Base URL of api (ex: https://myapi.com/).</param>
@@ -34,8 +34,8 @@ protected BaseClient(IRequestSender sender, string url)
         /// </summary>
         /// <param name="route">Request's Route.</param>
         /// <param name="method">Request's Method (GET, POST, PUT, DELETE...).</param>
-        protected virtual IRequestBuilder GetBuilder(string route, Method method = Method.Get)
-            => new RequestBuilder(_url, route, method);
+        protected virtual IRequestBuilder GetBuilder(string route, Method method = Method.Get, string? version = null)
+            => new RequestBuilder(_url, route, version, method);
 
         /// <summary>
         /// Get preconfigured <see cref="IRequestBuilder"/>.
@@ -44,19 +44,33 @@ protected virtual IRequestBuilder GetBuilder(string route, Method method = Metho
         protected IRequestBuilder GetBuilder(Endpoint endpoint)
             => GetBuilder(endpoint.Route, endpoint.Method);
 
+        /// <summary>
+        /// Get preconfigured <see cref="IRequestBuilder"/> with versioning.
+        /// </summary>
+        /// <param name="endpoint">Request's <see cref="Endpoint"/>.</param>
+        protected IRequestBuilder GetBuilder(VersionedEndpoint endpoint)
+            => GetBuilder(endpoint.Route, endpoint.Method, endpoint.Version);
+
         /// <summary>
         /// Get preconfigured <see cref="IRequestBuilder"/>.
         /// </summary>
         /// <param name="route">Request's Route.</param>
         /// <param name="method">Request's Method (GET, POST, PUT, DELETE...).</param>
-        protected virtual async Task<IRequestBuilder> GetBuilderAsync(string route, Method method = Method.Get)
-            => new RequestBuilder(_url, route, method);
+        protected virtual async Task<IRequestBuilder> GetBuilderAsync(string route, Method method = Method.Get, string? version = null)
+            => GetBuilder(route, method, version);
 
         /// <summary>
         /// Get preconfigured <see cref="IRequestBuilder"/>.
         /// </summary>
         /// <param name="endpoint">Request's <see cref="Endpoint"/>.</param>
         protected Task<IRequestBuilder> GetBuilderAsync(Endpoint endpoint)
             => GetBuilderAsync(endpoint.Route, endpoint.Method);
+
+        /// <summary>
+        /// Get preconfigured <see cref="IRequestBuilder"/> with versioning.
+        /// </summary>
+        /// <param name="endpoint">Request's <see cref="VersionedEndpoint"/>.</param>
+        protected Task<IRequestBuilder> GetBuilderAsync(VersionedEndpoint endpoint)
+            => GetBuilderAsync(endpoint.Route, endpoint.Method, endpoint.Version);
     }
 }

NotoriousClient/Clients/BasicAuthBaseClient.cs

@@ -33,7 +33,7 @@ protected BasicAuthBaseClient(IRequestSender sender, string url, string login, s
         /// </summary>
         /// <param name="route">Request's Route.</param>
         /// <param name="method">Request's method (GET, POST, PUT, DELETE...).</param>
-        protected override IRequestBuilder GetBuilder(string route, Method method = Method.Get)
+        protected override IRequestBuilder GetBuilder(string route, Method method = Method.Get, string? version = null)
             => base.GetBuilder(route, method).WithAuthentication(_login, _password);
     }
 }

NotoriousClient/NotoriousClient.csproj

@@ -1,11 +1,11 @@
 <Project Sdk="Microsoft.NET.Sdk">
 	<PropertyGroup>
-		<TargetFramework>net8.0</TargetFramework>
+		<TargetFrameworks>net8.0;net9.0</TargetFrameworks>
 		<Description>A fluent HTTPResponseMessage builder with fully extendable API Client implementation.</Description>
 		<PackageId>NotoriousClient</PackageId>
 		<ImplicitUsings>enable</ImplicitUsings>
 		<Nullable>enable</Nullable>
-		<VersionPrefix>2.0.2</VersionPrefix>
+		<VersionPrefix>2.1.0</VersionPrefix>
 		<PackageReadmeFile>README.md</PackageReadmeFile>
 		<Authors>Brice SCHUMACHER</Authors>
 		<RepositoryUrl>https://github.com/Notorious-Coding/Notorious-Client/</RepositoryUrl>