chore: introduced base URI class and validated that the request goes to a TL address or to the configured ones or to localhost

tl-mauro-franchi · tl-mauro-franchi · commit 7e0887fe5aab · 2024-01-16T17:45:56.000Z
diff --git a/src/TrueLayer/ApiClient.cs b/src/TrueLayer/ApiClient.cs
@@ -9,6 +9,8 @@
 using System.Net.Mime;
 using TrueLayer.Serialization;
 using System.Text.Json;
+using Microsoft.Extensions.Options;
+using TrueLayer.Common;
 using TrueLayer.Signing;
 #if NET6_0 || NET6_0_OR_GREATER
 using System.Net.Http.Json;
@@ -25,20 +27,23 @@ private static readonly String TlAgentHeader
             = $"truelayer-dotnet/{ReflectionUtils.GetAssemblyVersion<ITrueLayerClient>()}";
 
         private readonly HttpClient _httpClient;
+        private readonly TrueLayerOptions _options;
 
         /// <summary>
         /// Creates a new <see cref="ApiClient"/> instance with the provided configuration, HTTP client factory and serializer.
         /// </summary>
         /// <param name="httpClient">The client used to make HTTP requests.</param>
-        public ApiClient(HttpClient httpClient)
+        /// <param name="options"></param>
+        public ApiClient(HttpClient httpClient, IOptions<TrueLayerOptions> options)
         {
             _httpClient = httpClient ?? throw new ArgumentNullException(nameof(httpClient));
+            _options = options.Value ?? throw new ArgumentNullException(nameof(options));
         }
 
         /// <inheritdoc />
         public async Task<ApiResponse<TData>> GetAsync<TData>(Uri uri, string? accessToken = null, CancellationToken cancellationToken = default)
         {
-            if (uri is null) throw new ArgumentNullException(nameof(uri));
+            uri.HasValidBaseUri(nameof(uri), _options);
 
             using var httpResponse = await SendRequestAsync(
                 httpMethod: HttpMethod.Get,
@@ -56,7 +61,7 @@ public async Task<ApiResponse<TData>> GetAsync<TData>(Uri uri, string? accessTok
         /// <inheritdoc />
         public async Task<ApiResponse<TData>> PostAsync<TData>(Uri uri, HttpContent? httpContent = null, string? accessToken = null, CancellationToken cancellationToken = default)
         {
-            if (uri is null) throw new ArgumentNullException(nameof(uri));
+            uri.HasValidBaseUri(nameof(uri), _options);
 
             using var httpResponse = await SendRequestAsync(
                 httpMethod: HttpMethod.Post,
@@ -74,7 +79,7 @@ public async Task<ApiResponse<TData>> PostAsync<TData>(Uri uri, HttpContent? htt
         /// <inheritdoc />
         public async Task<ApiResponse<TData>> PostAsync<TData>(Uri uri, object? request = null, string? idempotencyKey = null, string? accessToken = null, SigningKey? signingKey = null, CancellationToken cancellationToken = default)
         {
-            if (uri is null) throw new ArgumentNullException(nameof(uri));
+            uri.HasValidBaseUri(nameof(uri), _options);
 
             using var httpResponse = await SendJsonRequestAsync(
                 httpMethod: HttpMethod.Post,
@@ -91,7 +96,7 @@ public async Task<ApiResponse<TData>> PostAsync<TData>(Uri uri, object? request
 
         public async Task<ApiResponse> PostAsync(Uri uri, HttpContent? httpContent = null, string? accessToken = null, CancellationToken cancellationToken = default)
         {
-            if (uri is null) throw new ArgumentNullException(nameof(uri));
+            uri.HasValidBaseUri(nameof(uri), _options);
 
             using var httpResponse = await SendRequestAsync(
                 httpMethod: HttpMethod.Post,
@@ -108,7 +113,7 @@ public async Task<ApiResponse> PostAsync(Uri uri, HttpContent? httpContent = nul
 
         public async Task<ApiResponse> PostAsync(Uri uri, object? request = null, string? idempotencyKey = null, string? accessToken = null, SigningKey? signingKey = null, CancellationToken cancellationToken = default)
         {
-            if (uri is null) throw new ArgumentNullException(nameof(uri));
+            uri.HasValidBaseUri(nameof(uri), _options);
 
             using var httpResponse = await SendJsonRequestAsync(
                 httpMethod: HttpMethod.Post,
diff --git a/src/TrueLayer/Auth/AuthApi.cs b/src/TrueLayer/Auth/AuthApi.cs
@@ -3,15 +3,13 @@
 using System.Net.Http;
 using System.Threading;
 using System.Threading.Tasks;
+using TrueLayer.Common;
 using TrueLayer.Extensions;
 
 namespace TrueLayer.Auth
 {
     internal class AuthApi : IAuthApi
     {
-        internal const string ProdUrl = "https://auth.truelayer.com/";
-        internal const string SandboxUrl = "https://auth.truelayer-sandbox.com/";
-
         private readonly IApiClient _apiClient;
         private readonly TrueLayerOptions _options;
         private readonly Uri _baseUri;
@@ -21,8 +19,11 @@ public AuthApi(IApiClient apiClient, TrueLayerOptions options)
             _apiClient = apiClient.NotNull(nameof(apiClient));
             _options = options.NotNull(nameof(options));
 
-            _baseUri = options.Auth?.Uri ??
-                      new Uri((options.UseSandbox ?? true) ? SandboxUrl : ProdUrl);
+            var baseUri = (options.UseSandbox ?? true)
+                ? TrueLayerBaseUris.SandboxAuthBaseUri
+                : TrueLayerBaseUris.ProdAuthBaseUri;
+
+            _baseUri = options.Auth?.Uri ?? baseUri;
         }
 
         /// <inheritdoc />
diff --git a/src/TrueLayer/Common/TrueLayerBaseUris.cs b/src/TrueLayer/Common/TrueLayerBaseUris.cs
@@ -0,0 +1,13 @@
+using System;
+
+namespace TrueLayer.Common;
+
+internal static class TrueLayerBaseUris
+{
+    internal static readonly Uri ProdApiBaseUri = new("https://api.truelayer.com/");
+    internal static readonly Uri SandboxApiBaseUri = new("https://api.truelayer-sandbox.com/");
+    internal static readonly Uri ProdAuthBaseUri = new("https://auth.truelayer.com/");
+    internal static readonly Uri SandboxAuthBaseUri = new("https://auth.truelayer-sandbox.com/");
+    internal static readonly Uri ProdHppBaseUri = new("https://payment.truelayer.com/");
+    internal static readonly Uri SandboxHppBaseUri = new("https://payment.truelayer-sandbox.com/");
+}
diff --git a/src/TrueLayer/Guard.cs b/src/TrueLayer/Guard.cs
@@ -1,8 +1,7 @@
 using System;
 using System.Diagnostics;
 using System.Diagnostics.CodeAnalysis;
-using System.Linq;
-using System.Text.RegularExpressions;
+using TrueLayer.Common;
 
 namespace TrueLayer
 {
@@ -112,5 +111,69 @@ public static T GreaterThan<T>([NotNull] this T value, T greaterThan, string par
                 || value.Contains('.'))
                 ? throw new ArgumentException("Value is malformed", name)
                 : value;
+
+        /// <summary>
+        /// Validate that the provided URI one of the configured (from the options) URIs as base address, or one of the TrueLayer ones based on the environment used.
+        /// </summary>
+        /// <param name="value">The value to validate</param>
+        /// <param name="name">The name of the argument</param>
+        /// <param name="options">The <see cref="TrueLayerOptions"/> that contain the custom configured URIs</param>
+        /// <returns>The value of <paramref name="value"/> if it is valid</returns>
+        /// <exception cref="ArgumentException">Thrown when the value is not valid</exception>
+        /// <example>
+        /// <code>
+        /// _uri = uri.HasValidBaseUri(nameof(_uri), options);
+        /// </code>
+        /// </example>
+        internal static Uri? HasValidBaseUri(this Uri? value, string name, TrueLayerOptions options)
+        {
+            value.NotNull(name);
+            const string errorMsg = "The URI must be a valid TrueLayer API URI one of those configured in the settings.";
+            bool result = value.IsLoopback // is localhost?
+                          || ((options.Payments?.Uri is not null) && options.Payments!.Uri.IsBaseOf(value))
+                          || ((options.Auth?.Uri is not null) && options.Auth!.Uri.IsBaseOf(value))
+                          || ((options.Payments?.HppUri is not null) && options.Payments!.HppUri.IsBaseOf(value));
+
+            if (options.UseSandbox == true)
+            {
+                result = result
+                         || TrueLayerBaseUris.SandboxAuthBaseUri.IsBaseOf(value)
+                         || TrueLayerBaseUris.SandboxApiBaseUri.IsBaseOf(value)
+                         || TrueLayerBaseUris.SandboxHppBaseUri.IsBaseOf(value);
+            }
+            else
+            {
+                result = result
+                         || TrueLayerBaseUris.ProdAuthBaseUri.IsBaseOf(value)
+                         || TrueLayerBaseUris.ProdApiBaseUri.IsBaseOf(value)
+                         || TrueLayerBaseUris.ProdHppBaseUri.IsBaseOf(value);
+            }
+
+            result.ThrowIfFalse(name, errorMsg);
+            return value;
+        }
+
+        /// <summary>
+        /// Validate that the provided value is not false
+        /// </summary>
+        /// <param name="value">The value to validate</param>
+        /// <param name="name">The name of the argument</param>
+        /// <param name="message">The message that needs to be assigned to the exception</param>
+        /// <returns>The value of <paramref name="value"/> if not false</returns>
+        /// <exception cref="ArgumentException">Thrown when the value is false</exception>
+        /// <example>
+        /// <code>
+        /// _value = value.ThrowIfFalse(nameof(_value), "The value cannot be false");
+        /// </code>
+        /// </example>
+        private static bool ThrowIfFalse(this bool value, string name, string message)
+        {
+            if (!value)
+            {
+                throw new ArgumentException(message, name);
+            }
+
+            return value;
+        }
     }
 }
diff --git a/src/TrueLayer/Mandates/MandatesApi.cs b/src/TrueLayer/Mandates/MandatesApi.cs
@@ -3,27 +3,25 @@
 using System.Threading.Tasks;
 using TrueLayer.Auth;
 using OneOf;
+using TrueLayer.Common;
 using TrueLayer.Extensions;
+using TrueLayer.Mandates.Model;
+using TrueLayer.Models;
 
 namespace TrueLayer.Mandates
 {
-    using TrueLayer.Mandates.Model;
-    using TrueLayer.Models;
     using AuthorizationResponseUnion = OneOf<
-        Models.AuthorisationFlowResponse.AuthorizationFlowAuthorizing,
-        Models.AuthorisationFlowResponse.AuthorizationFlowAuthorizationFailed>;
+        AuthorisationFlowResponse.AuthorizationFlowAuthorizing,
+        AuthorisationFlowResponse.AuthorizationFlowAuthorizationFailed>;
     using MandateDetailUnion = OneOf<
-        Model.MandateDetail.AuthorizationRequiredMandateDetail,
-        Model.MandateDetail.AuthorizingMandateDetail,
-        Model.MandateDetail.AuthorizedMandateDetail,
-        Model.MandateDetail.FailedMandateDetail,
-        Model.MandateDetail.RevokedMandateDetail>;
+        MandateDetail.AuthorizationRequiredMandateDetail,
+        MandateDetail.AuthorizingMandateDetail,
+        MandateDetail.AuthorizedMandateDetail,
+        MandateDetail.FailedMandateDetail,
+        MandateDetail.RevokedMandateDetail>;
 
     internal class MandatesApi : IMandatesApi
     {
-        private const string ProdUrl = "https://api.truelayer.com/v3/mandates/";
-        private const string SandboxUrl = "https://api.truelayer-sandbox.com/v3/mandates/";
-
         private readonly IApiClient _apiClient;
         private readonly TrueLayerOptions _options;
         private readonly Uri _baseUri;
@@ -37,10 +35,12 @@ public MandatesApi(IApiClient apiClient, IAuthApi auth, TrueLayerOptions options
 
             options.Payments.NotNull(nameof(options.Payments))!.Validate();
 
-            var baseUri = (options.UseSandbox ?? true) ? SandboxUrl : ProdUrl;
-            _baseUri = options.Payments.Uri is not null
-                ? new Uri(options.Payments.Uri, "/v3/mandates/")
-                : new Uri(baseUri);
+            var baseUri = (options.UseSandbox ?? true)
+                ? TrueLayerBaseUris.SandboxApiBaseUri
+                : TrueLayerBaseUris.ProdApiBaseUri;
+
+            _baseUri = (options.Payments.Uri ?? baseUri)
+                .Append("/v3/mandates/");
         }
 
         /// <inheritdoc />
diff --git a/src/TrueLayer/MerchantAccounts/MerchantAccountsApi.cs b/src/TrueLayer/MerchantAccounts/MerchantAccountsApi.cs
@@ -2,15 +2,14 @@
 using System.Threading;
 using System.Threading.Tasks;
 using TrueLayer.Auth;
+using TrueLayer.Common;
 using TrueLayer.Extensions;
 using TrueLayer.MerchantAccounts.Model;
 
 namespace TrueLayer.MerchantAccounts
 {
     internal class MerchantAccountsApi : IMerchantAccountsApi
     {
-        private const string ProdUrl = "https://api.truelayer.com/v3/merchant-accounts";
-        private const string SandboxUrl = "https://api.truelayer-sandbox.com/v3/merchant-accounts";
         private readonly IApiClient _apiClient;
         private readonly Uri _baseUri;
         private readonly IAuthApi _auth;
@@ -22,9 +21,12 @@ public MerchantAccountsApi(IApiClient apiClient, IAuthApi auth, TrueLayerOptions
 
             options.Payments.NotNull(nameof(options.Payments))!.Validate();
 
-            _baseUri = options.Payments.Uri is not null
-                ? new Uri(options.Payments.Uri, "/v3/merchant-accounts")
-                : new Uri(options.UseSandbox ?? true ? SandboxUrl : ProdUrl);
+            var baseUri = (options.UseSandbox ?? true)
+                ? TrueLayerBaseUris.SandboxApiBaseUri
+                : TrueLayerBaseUris.ProdApiBaseUri;
+
+            _baseUri = (options.Payments.Uri ?? baseUri)
+                .Append("/v3/merchant-accounts");
         }
 
         /// <inheritdoc />
diff --git a/src/TrueLayer/Payments/PaymentsApi.cs b/src/TrueLayer/Payments/PaymentsApi.cs
@@ -3,6 +3,7 @@
 using System.Threading.Tasks;
 using OneOf;
 using TrueLayer.Auth;
+using TrueLayer.Common;
 using TrueLayer.Extensions;
 using TrueLayer.Payments.Model;
 
@@ -25,9 +26,6 @@ namespace TrueLayer.Payments
 
     internal class PaymentsApi : IPaymentsApi
     {
-        private const string ProdUrl = "https://api.truelayer.com/v3/payments/";
-        private const string SandboxUrl = "https://api.truelayer-sandbox.com/v3/payments/";
-
         private readonly IApiClient _apiClient;
         private readonly TrueLayerOptions _options;
         private readonly Uri _baseUri;
@@ -43,10 +41,12 @@ public PaymentsApi(IApiClient apiClient, IAuthApi auth, TrueLayerOptions options
 
             options.Payments.NotNull(nameof(options.Payments))!.Validate();
 
-            var baseUri = (options.UseSandbox ?? true) ? SandboxUrl : ProdUrl;
-            _baseUri = options.Payments.Uri is not null
-                ? new Uri(options.Payments.Uri, "/v3/payments/")
-                : new Uri(baseUri);
+            var baseUri = (options.UseSandbox ?? true)
+                ? TrueLayerBaseUris.SandboxApiBaseUri
+                : TrueLayerBaseUris.ProdApiBaseUri;
+
+            _baseUri = (options.Payments.Uri ?? baseUri)
+                .Append("/v3/payments/");
         }
 
         /// <inheritdoc />
diff --git a/src/TrueLayer/PaymentsProviders/PaymentsApi.cs b/src/TrueLayer/PaymentsProviders/PaymentsApi.cs
@@ -1,15 +1,13 @@
 using System;
 using System.Threading.Tasks;
+using TrueLayer.Common;
 using TrueLayer.Extensions;
 using TrueLayer.PaymentsProviders.Model;
 
 namespace TrueLayer.PaymentsProviders
 {
     internal class PaymentsProvidersApi : IPaymentsProvidersApi
     {
-        private const string ProdUrl = "https://api.truelayer.com/v3/payments-providers/";
-        private const string SandboxUrl = "https://api.truelayer-sandbox.com/v3/payments-providers/";
-
         private readonly IApiClient _apiClient;
         private readonly TrueLayerOptions _options;
         private readonly Uri _baseUri;
@@ -21,9 +19,12 @@ public PaymentsProvidersApi(IApiClient apiClient, TrueLayerOptions options)
 
             options.Payments.NotNull(nameof(options.Payments))!.Validate();
 
-            _baseUri = options.Payments.Uri is not null
-                ? new Uri(options.Payments.Uri, "/v3/payments-providers/")
-                : new Uri((options.UseSandbox ?? true) ? SandboxUrl : ProdUrl);
+            var baseUri = (options.UseSandbox ?? true)
+                ? TrueLayerBaseUris.SandboxApiBaseUri
+                : TrueLayerBaseUris.ProdApiBaseUri;
+
+            _baseUri = (options.Payments.Uri ?? baseUri)
+                .Append("/v3/payments-providers/");
         }
 
         public async Task<ApiResponse<PaymentsProvider>> GetPaymentsProvider(string id)
diff --git a/src/TrueLayer/Payouts/PayoutsApi.cs b/src/TrueLayer/Payouts/PayoutsApi.cs
@@ -3,6 +3,7 @@
 using System.Threading.Tasks;
 using OneOf;
 using TrueLayer.Auth;
+using TrueLayer.Common;
 using TrueLayer.Extensions;
 using TrueLayer.Payouts.Model;
 using static TrueLayer.Payouts.Model.GetPayoutsResponse;
@@ -18,9 +19,6 @@ namespace TrueLayer.Payouts
 
     internal class PayoutsApi : IPayoutsApi
     {
-        private const string ProdUrl = "https://api.truelayer.com/v3/payouts";
-        private const string SandboxUrl = "https://api.truelayer-sandbox.com/v3/payouts";
-
         private readonly IApiClient _apiClient;
         private readonly TrueLayerOptions _options;
         private readonly Uri _baseUri;
@@ -34,10 +32,12 @@ public PayoutsApi(IApiClient apiClient, IAuthApi auth, TrueLayerOptions options)
 
             options.Payments.NotNull(nameof(options.Payments))!.Validate();
 
-            string payoutsApiUrl = (options.UseSandbox ?? true) ? SandboxUrl : ProdUrl;
-            _baseUri = options.Payments.Uri is not null
-                ? new Uri(options.Payments.Uri, "/v3/payouts")
-                : new Uri(payoutsApiUrl);
+            var baseUri = (options.UseSandbox ?? true)
+                ? TrueLayerBaseUris.SandboxApiBaseUri
+                : TrueLayerBaseUris.ProdApiBaseUri;
+
+            _baseUri = (options.Payments.Uri ?? baseUri)
+                .Append("/v3/payouts/");
         }
 
         /// <inheritdoc />
diff --git a/src/TrueLayer/TrueLayerServiceCollectionExtensions.cs b/src/TrueLayer/TrueLayerServiceCollectionExtensions.cs
@@ -39,7 +39,7 @@ public static IServiceCollection AddTrueLayer(
             configureBuilder?.Invoke(httpClientBuilder);
 
             services.AddTransient<ITrueLayerClient, TrueLayerClient>();
-            
+
             return services;
         }
     }
diff --git a/test/TrueLayer.Tests/ApiClientTests.cs b/test/TrueLayer.Tests/ApiClientTests.cs
diff --git a/test/TrueLayer.Tests/GuardTests.cs b/test/TrueLayer.Tests/GuardTests.cs
diff --git a/test/TrueLayer.Tests/TrueLayerClientTests.cs b/test/TrueLayer.Tests/TrueLayerClientTests.cs

Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ public static IServiceCollection AddTrueLayer(`
`39`	`39`	`configureBuilder?.Invoke(httpClientBuilder);`
`40`	`40`
`41`	`41`	`services.AddTransient<ITrueLayerClient, TrueLayerClient>();`
`42`		`-`
	`42`	`+`
`43`	`43`	`return services;`
`44`	`44`	`}`
`45`	`45`	`}`