Merge pull request #164 from swlodarski-sumoheavy/6.0.x

bobbrodie · web-flow · commit c5909ca60bb6 · 2024-09-04T15:41:36.000-04:00
SP-1028 Add X-BitPay-Platform-Info header
diff --git a/BitPay/Client.cs b/BitPay/Client.cs
@@ -34,26 +34,28 @@ public class Client
         ///     Create Client class for POS.
         /// </summary>
         /// <param name="token">Pos token VO.</param>
-        public Client(PosToken token)
+        /// <param name="platformInfo">Platform info.</param>
+        public Client(PosToken token, string? platformInfo = null)
         {
             if (token == null) throw new ArgumentNullException(nameof(token));
             
             _accessTokens = GetAccessTokens(token);
-            _bitPayClient = GetDefaultBitPayClient(Environment.Prod);
+            _bitPayClient = GetDefaultBitPayClient(Environment.Prod, platformInfo);
         }
 
         /// <summary>
         ///     Create Client class for POS.
         /// </summary>
         /// <param name="token">Pos token VO.</param>
         /// <param name="environment">Environment</param>
-        public Client(PosToken token, Environment environment)
+        /// <param name="platformInfo">Platform info.</param>
+        public Client(PosToken token, Environment environment, string? platformInfo = null)
         {
             if (token == null) 
                 throw new ArgumentNullException(nameof(token));
 
             _accessTokens = GetAccessTokens(token);
-            _bitPayClient = GetDefaultBitPayClient(environment);
+            _bitPayClient = GetDefaultBitPayClient(environment, platformInfo);
         }
 
         /// <summary>
@@ -62,7 +64,8 @@ public Client(PosToken token, Environment environment)
         /// <param name="environment">Environment</param>
         /// <param name="privateKey"></param>
         /// <param name="accessTokens"></param>
-        public Client(PrivateKey privateKey, AccessTokens accessTokens, Environment environment = Environment.Prod)
+        /// <param name="platformInfo">Platform info.</param>
+        public Client(PrivateKey privateKey, AccessTokens accessTokens, Environment environment = Environment.Prod, string? platformInfo = null)
         {
             if (privateKey == null)
             {
@@ -79,7 +82,7 @@ public Client(PrivateKey privateKey, AccessTokens accessTokens, Environment envi
             var httpClient = GetHttpClient(baseUrl);
 
             _accessTokens = accessTokens;
-            _bitPayClient = new BitPayClient(httpClient, baseUrl, ecKey);
+            _bitPayClient = new BitPayClient(httpClient, baseUrl, ecKey, platformInfo);
             CreateIdentity(ecKey);
         }
 
@@ -88,7 +91,8 @@ public Client(PrivateKey privateKey, AccessTokens accessTokens, Environment envi
         /// </summary>
         /// <param name="configFilePath">Config File Path</param>
         /// <param name="environment">Environment</param>
-        public Client(ConfigFilePath configFilePath, Environment environment = Environment.Prod)
+        /// <param name="platformInfo">Platform info.</param>
+        public Client(ConfigFilePath configFilePath, Environment environment = Environment.Prod, string? platformInfo = null)
         {
             if (configFilePath == null)
             {
@@ -102,7 +106,7 @@ public Client(ConfigFilePath configFilePath, Environment environment = Environme
             var baseUrl = GetBaseUrl(environment);
             var httpClient = GetHttpClient(baseUrl);
 
-            _bitPayClient = new BitPayClient(httpClient, baseUrl, ecKey);
+            _bitPayClient = new BitPayClient(httpClient, baseUrl, ecKey, platformInfo);
             CreateIdentity(ecKey);
         }
 
@@ -948,11 +952,11 @@ private AccessTokens GetAccessTokens(PosToken token)
             return accessTokens;
         }
 
-        private IBitPayClient GetDefaultBitPayClient(Environment environment)
+        private IBitPayClient GetDefaultBitPayClient(Environment environment, string? platformInfo)
         {
             var baseUrl = GetBaseUrl(environment);
             var httpClient = GetHttpClient(baseUrl);
-            return new BitPayClient(httpClient, baseUrl, null);
+            return new BitPayClient(httpClient, baseUrl, null, platformInfo);
         }
 
         private static HttpClient GetHttpClient(string baseUrl)
@@ -977,4 +981,4 @@ private EcKey GetEcKey(IConfiguration config, string env)
                 .GetSection("BitPayConfiguration:EnvConfig:" + env + ":PrivateKey").Value);
         }
     }
-}
+}
diff --git a/BitPay/Clients/BitPayClient.cs b/BitPay/Clients/BitPayClient.cs
@@ -18,12 +18,14 @@ public class BitPayClient : IBitPayClient
         private readonly HttpClient _httpClient;
         private readonly string _baseUrl;
         private readonly EcKey? _ecKey;
+        private readonly string? _platformInfo;
 
-        public BitPayClient(HttpClient httpClient, string baseUrl, EcKey? ecKey)
+        public BitPayClient(HttpClient httpClient, string baseUrl, EcKey? ecKey, string? platformInfo = null)
         {
             this._httpClient = httpClient;
             this._baseUrl = baseUrl;
             this._ecKey = ecKey;
+            this._platformInfo = platformInfo;
         }
 
         /// <summary>
@@ -39,11 +41,9 @@ public async Task<HttpResponseMessage> Get(string uri, Dictionary<string, dynami
             bool signatureRequired = true)
         {
             var fullUrl = _baseUrl + uri;
-            _httpClient.DefaultRequestHeaders.Clear();
-            _httpClient.DefaultRequestHeaders.Add("x-accept-version", Config.BitPayApiVersion);
-            _httpClient.DefaultRequestHeaders.Add("x-bitpay-plugin-info", Config.BitPayPluginInfo);
-            _httpClient.DefaultRequestHeaders.Add("x-bitpay-api-frame", Config.BitPayApiFrame);
-            _httpClient.DefaultRequestHeaders.Add("x-bitpay-api-frame-version", Config.BitPayApiFrameVersion);
+
+            AddDefaultHeaders();
+
             if (parameters != null)
             {
                 fullUrl += "?";
@@ -84,11 +84,7 @@ public async Task<HttpResponseMessage> Get(string uri, Dictionary<string, dynami
         public async Task<HttpResponseMessage> Delete(string uri, Dictionary<string, dynamic?>? parameters = null)
         {
             var fullUrl = _baseUrl + uri;
-            _httpClient.DefaultRequestHeaders.Clear();
-            _httpClient.DefaultRequestHeaders.Add("x-accept-version", Config.BitPayApiVersion);
-            _httpClient.DefaultRequestHeaders.Add("x-bitpay-plugin-info", Config.BitPayPluginInfo);
-            _httpClient.DefaultRequestHeaders.Add("x-bitpay-api-frame", Config.BitPayApiFrame);
-            _httpClient.DefaultRequestHeaders.Add("x-bitpay-api-frame-version", Config.BitPayApiFrameVersion);
+            AddDefaultHeaders();
 
             if (parameters != null)
             {
@@ -121,11 +117,7 @@ public async Task<HttpResponseMessage> Post(string uri, string json, bool signat
         {
             using var bodyContent = new StringContent(UnicodeToAscii(json));
             
-            _httpClient.DefaultRequestHeaders.Clear();
-            _httpClient.DefaultRequestHeaders.Add("x-accept-version", Config.BitPayApiVersion);
-            _httpClient.DefaultRequestHeaders.Add("x-bitpay-plugin-info", Config.BitPayPluginInfo);
-            _httpClient.DefaultRequestHeaders.Add("x-bitpay-api-frame", Config.BitPayApiFrame);
-            _httpClient.DefaultRequestHeaders.Add("x-bitpay-api-frame-version", Config.BitPayApiFrameVersion);
+            AddDefaultHeaders();
             bodyContent.Headers.ContentType = new MediaTypeHeaderValue("application/json");
             if (signatureRequired)
             {
@@ -156,11 +148,7 @@ public async Task<HttpResponseMessage> Put(string uri, string json)
         {
             using var bodyContent = new StringContent(UnicodeToAscii(json));
             
-            _httpClient.DefaultRequestHeaders.Clear();
-            _httpClient.DefaultRequestHeaders.Add("x-accept-version", Config.BitPayApiVersion);
-            _httpClient.DefaultRequestHeaders.Add("x-bitpay-plugin-info", Config.BitPayPluginInfo);
-            _httpClient.DefaultRequestHeaders.Add("x-bitpay-api-frame", Config.BitPayApiFrame);
-            _httpClient.DefaultRequestHeaders.Add("x-bitpay-api-frame-version", Config.BitPayApiFrameVersion);
+            AddDefaultHeaders();
             bodyContent.Headers.ContentType = new MediaTypeHeaderValue("application/json");
 
             var signature = KeyUtils.Sign(_ecKey, _baseUrl + uri + json);
@@ -193,5 +181,18 @@ private string UnicodeToAscii(string json)
             Encoding.ASCII.GetChars(asciiBytes, 0, asciiBytes.Length, asciiChars, 0);
             return new string(asciiChars);
         }
+
+        private void AddDefaultHeaders()
+        {
+            _httpClient.DefaultRequestHeaders.Clear();
+            _httpClient.DefaultRequestHeaders.Add("x-accept-version", Config.BitPayApiVersion);
+            _httpClient.DefaultRequestHeaders.Add("x-bitpay-plugin-info", Config.BitPayPluginInfo);
+            _httpClient.DefaultRequestHeaders.Add("x-bitpay-api-frame", Config.BitPayApiFrame);
+            _httpClient.DefaultRequestHeaders.Add("x-bitpay-api-frame-version", Config.BitPayApiFrameVersion);
+
+            if (!string.IsNullOrEmpty(this._platformInfo)) {
+                _httpClient.DefaultRequestHeaders.Add("x-bitPay-platform-info", this._platformInfo);
+            }
+        }
     }
-}
+}
diff --git a/BitPayUnitTest/ClientTest.cs b/BitPayUnitTest/ClientTest.cs
@@ -48,6 +48,17 @@ public void it_should_provide_pos_client()
             Assert.Equal(posToken, client.GetAccessToken("pos"));
         }
 
+        [Fact]
+        public void it_should_provide_pos_client_with_platform_info_header()
+        {
+            string posToken = "posToken";
+
+            var client = new Client(new PosToken(posToken), "MyPlatform_v1.0.0");
+
+            Assert.IsType<Client>(client);
+            Assert.Equal(posToken, client.GetAccessToken("pos"));
+        }
+
         [Fact]
         public void it_should_provide_client_by_key()
         {
@@ -65,6 +76,23 @@ public void it_should_provide_client_by_key()
             Assert.Equal(merchantToken, client.GetAccessToken(Facade.Merchant));
         }
 
+        [Fact]
+        public void it_should_provide_client_by_key_with_platform_info_header()
+        {
+            // given
+            String privateKey =
+                "75371435315047800683080420474719166774492308988314944856528163960396135344086";
+            String merchantToken = "merchantToken";
+            AccessTokens tokens = new AccessTokens();
+            tokens.AddMerchant(merchantToken);
+
+            // when
+            Client client = new Client(new PrivateKey(privateKey), tokens, Environment.Test, "MyPlatform_v1.0.0");
+
+            // then
+            Assert.Equal(merchantToken, client.GetAccessToken(Facade.Merchant));
+        }
+
         [Fact]
         public void it_should_provide_client_by_config_file()
         {
@@ -79,6 +107,21 @@ public void it_should_provide_client_by_config_file()
             Assert.Equal("payoutToken", bitpay.GetAccessToken(Facade.Payout));
         }
 
+
+        [Fact]
+        public void it_should_provide_client_by_config_file_with_platform_info_header()
+        {
+            // given
+            string path = GetBitPayUnitTestPath() + Path.DirectorySeparatorChar + "BitPay.config.json";
+
+            // when
+            Client bitpay = new Client(new ConfigFilePath(path), Environment.Test, "MyPlatform_v1.0.0");
+
+            // then
+            Assert.Equal("merchantToken", bitpay.GetAccessToken(Facade.Merchant));
+            Assert.Equal("payoutToken", bitpay.GetAccessToken(Facade.Payout));
+        }
+
         [Fact]
         public void TestShouldThrowsBitPayExceptionForInvalidPrivateKey()
         {
@@ -2073,4 +2116,4 @@ private Client GetTestedClassAsPayout()
             );
         }
     }
-}
+}

Original file line number	Diff line number	Diff line change
`@@ -34,26 +34,28 @@ public class Client`
`34`	`34`	`/// Create Client class for POS.`
`35`	`35`	`/// </summary>`
`36`	`36`	`/// <param name="token">Pos token VO.</param>`
`37`		`- public Client(PosToken token)`
	`37`	`+ /// <param name="platformInfo">Platform info.</param>`
	`38`	`+ public Client(PosToken token, string? platformInfo = null)`
`38`	`39`	`{`
`39`	`40`	`if (token == null) throw new ArgumentNullException(nameof(token));`
`40`	`41`
`41`	`42`	`_accessTokens = GetAccessTokens(token);`
`42`		`- _bitPayClient = GetDefaultBitPayClient(Environment.Prod);`
	`43`	`+ _bitPayClient = GetDefaultBitPayClient(Environment.Prod, platformInfo);`
`43`	`44`	`}`
`44`	`45`
`45`	`46`	`/// <summary>`
`46`	`47`	`/// Create Client class for POS.`
`47`	`48`	`/// </summary>`
`48`	`49`	`/// <param name="token">Pos token VO.</param>`
`49`	`50`	`/// <param name="environment">Environment</param>`
`50`		`- public Client(PosToken token, Environment environment)`
	`51`	`+ /// <param name="platformInfo">Platform info.</param>`
	`52`	`+ public Client(PosToken token, Environment environment, string? platformInfo = null)`
`51`	`53`	`{`
`52`	`54`	`if (token == null)`
`53`	`55`	`throw new ArgumentNullException(nameof(token));`
`54`	`56`
`55`	`57`	`_accessTokens = GetAccessTokens(token);`
`56`		`- _bitPayClient = GetDefaultBitPayClient(environment);`
	`58`	`+ _bitPayClient = GetDefaultBitPayClient(environment, platformInfo);`
`57`	`59`	`}`
`58`	`60`
`59`	`61`	`/// <summary>`
`@@ -62,7 +64,8 @@ public Client(PosToken token, Environment environment)`
`62`	`64`	`/// <param name="environment">Environment</param>`
`63`	`65`	`/// <param name="privateKey"></param>`
`64`	`66`	`/// <param name="accessTokens"></param>`
`65`		`- public Client(PrivateKey privateKey, AccessTokens accessTokens, Environment environment = Environment.Prod)`
	`67`	`+ /// <param name="platformInfo">Platform info.</param>`
	`68`	`+ public Client(PrivateKey privateKey, AccessTokens accessTokens, Environment environment = Environment.Prod, string? platformInfo = null)`
`66`	`69`	`{`
`67`	`70`	`if (privateKey == null)`
`68`	`71`	`{`
`@@ -79,7 +82,7 @@ public Client(PrivateKey privateKey, AccessTokens accessTokens, Environment envi`
`79`	`82`	`var httpClient = GetHttpClient(baseUrl);`
`80`	`83`
`81`	`84`	`_accessTokens = accessTokens;`
`82`		`- _bitPayClient = new BitPayClient(httpClient, baseUrl, ecKey);`
	`85`	`+ _bitPayClient = new BitPayClient(httpClient, baseUrl, ecKey, platformInfo);`
`83`	`86`	`CreateIdentity(ecKey);`
`84`	`87`	`}`
`85`	`88`
`@@ -88,7 +91,8 @@ public Client(PrivateKey privateKey, AccessTokens accessTokens, Environment envi`
`88`	`91`	`/// </summary>`
`89`	`92`	`/// <param name="configFilePath">Config File Path</param>`
`90`	`93`	`/// <param name="environment">Environment</param>`
`91`		`- public Client(ConfigFilePath configFilePath, Environment environment = Environment.Prod)`
	`94`	`+ /// <param name="platformInfo">Platform info.</param>`
	`95`	`+ public Client(ConfigFilePath configFilePath, Environment environment = Environment.Prod, string? platformInfo = null)`
`92`	`96`	`{`
`93`	`97`	`if (configFilePath == null)`
`94`	`98`	`{`
`@@ -102,7 +106,7 @@ public Client(ConfigFilePath configFilePath, Environment environment = Environme`
`102`	`106`	`var baseUrl = GetBaseUrl(environment);`
`103`	`107`	`var httpClient = GetHttpClient(baseUrl);`
`104`	`108`
`105`		`- _bitPayClient = new BitPayClient(httpClient, baseUrl, ecKey);`
	`109`	`+ _bitPayClient = new BitPayClient(httpClient, baseUrl, ecKey, platformInfo);`
`106`	`110`	`CreateIdentity(ecKey);`
`107`	`111`	`}`
`108`	`112`
`@@ -948,11 +952,11 @@ private AccessTokens GetAccessTokens(PosToken token)`
`948`	`952`	`return accessTokens;`
`949`	`953`	`}`
`950`	`954`
`951`		`- private IBitPayClient GetDefaultBitPayClient(Environment environment)`
	`955`	`+ private IBitPayClient GetDefaultBitPayClient(Environment environment, string? platformInfo)`
`952`	`956`	`{`
`953`	`957`	`var baseUrl = GetBaseUrl(environment);`
`954`	`958`	`var httpClient = GetHttpClient(baseUrl);`
`955`		`- return new BitPayClient(httpClient, baseUrl, null);`
	`959`	`+ return new BitPayClient(httpClient, baseUrl, null, platformInfo);`
`956`	`960`	`}`
`957`	`961`
`958`	`962`	`private static HttpClient GetHttpClient(string baseUrl)`
`@@ -977,4 +981,4 @@ private EcKey GetEcKey(IConfiguration config, string env)`
`977`	`981`	`.GetSection("BitPayConfiguration:EnvConfig:" + env + ":PrivateKey").Value);`
`978`	`982`	`}`
`979`	`983`	`}`
`980`		`-}`
	`984`	`+}`