SP-1029 - Add X-BitPay-Platform-Info header

Author: swlodarski

src/bitpay/client.py

@@ -61,11 +61,11 @@ def __init__(
             )
 
     @staticmethod
-    def create_pos_client(pos_token: str, environment: Environment = Environment.PROD):  # type: ignore
+    def create_pos_client(pos_token: str, environment: Environment = Environment.PROD, platform_info: Optional[str] = None):  # type: ignore
         token_container = TokenContainer()
         token_container.add_pos(pos_token)
 
-        bitpay_client = BitPayClient(Client.get_base_url(environment))
+        bitpay_client = BitPayClient(Client.get_base_url(environment), None, platform_info)
 
         return Client(bitpay_client, token_container, GuidGenerator())
 
@@ -75,14 +75,15 @@ def create_client(  # type: ignore
         token_container: TokenContainer,
         environment: Environment = Environment.PROD,
         proxy: Optional[str] = None,
+        platform_info: Optional[str] = None
     ):
         """
         :raises BitPayGenericException
         """
         try:
             base_url = Client.get_base_url(environment)
             ec_key = Client.get_ec_key(private_key_or_private_key_path)
-            bitpay_client = BitPayClient(base_url, ec_key, proxy)
+            bitpay_client = BitPayClient(base_url, ec_key, proxy, platform_info)
             guid_generator = GuidGenerator()
 
             return Client(bitpay_client, token_container, guid_generator)
@@ -92,7 +93,7 @@ def create_client(  # type: ignore
             )
 
     @staticmethod
-    def create_client_by_config_file_path(config_file_path: str):  # type: ignore
+    def create_client_by_config_file_path(config_file_path: str, platform_info: Optional[str] = None):  # type: ignore
         """
         :raises BitPayGenericException
         """
@@ -125,7 +126,7 @@ def create_client_by_config_file_path(config_file_path: str):  # type: ignore
                 environment = Environment.PROD
 
             return Client.create_client(
-                private_key_or_private_key_path, token_container, environment, proxy
+                private_key_or_private_key_path, token_container, environment, proxy, platform_info
             )
         except Exception as exe:
             BitPayExceptionProvider.throw_generic_exception_with_message(

src/bitpay/clients/bitpay_client.py

@@ -17,13 +17,15 @@ class BitPayClient:
     __base_url: str
     __ec_key: Optional[str] = None
     __proxy: Optional[str] = None
+    __platform_info: Optional[str] = None
 
     def __init__(
-        self, base_url: str, ec_key: Optional[str] = None, proxy: Optional[str] = None
+        self, base_url: str, ec_key: Optional[str] = None, proxy: Optional[str] = None, platform_info: Optional[str] = None
     ):
         self.__base_url = base_url
         self.__ec_key = ec_key
         self.__proxy = proxy
+        self.__platform_info = platform_info
         self.init()
 
     def init(self) -> None:
@@ -38,6 +40,9 @@ def init(self) -> None:
         if self.__proxy is not None:
             self.__headers["proxy"] = self.__proxy
 
+        if self.__platform_info is not None:
+            self.__headers["x-bitpay-platform-info"] = self.__platform_info
+
     def post(
         self, uri: str, form_data: Any = {}, signature_required: bool = True
     ) -> Response: