Add a version of the pkg to headers (#10)

Add User-Agent which contains package version, requests version and python version.

Author: stanislav-losev

CHANGELOG.md

@@ -1,8 +1,7 @@
 # Changelog
 
 ## unreleased
-
-N/A
+- Add a version of the package to headers [#9](https://github.com/EmergingTravel/papi-sdk-python/issues/9)
 
 ## [v1.0.2](https://github.com/emergingtravel/papi-sdk-python/releases/tag/v1.0.2) - 2020-12-30
 

README.md

@@ -47,3 +47,5 @@ data = HotelInfoDumpRequest(language='ru')
 dump = papi.get_hotel_info_dump(data=data)
 print(dump.data.url)
 ```
+
+Note: if you don't provide your headers and specifically your `User-Agent` in requests options then it will be automatically added, ex. `papi-sdk/v1.0.2 requests/2.25.1 (python/3.8)`

papi_sdk/__version__.py

@@ -0,0 +1,2 @@
+__name__ = "papi_sdk"
+__version__ = "v1.0.2"

papi_sdk/api_v3.py

@@ -1,8 +1,10 @@
-from typing import Tuple
+from sys import version_info
+from typing import Optional, Tuple
 
 import requests
 from requests.auth import HTTPBasicAuth
 
+from papi_sdk.__version__ import __name__, __version__
 from papi_sdk.endpoints.endpoints import Endpoint
 from papi_sdk.exceptions.base import InvalidAuthData
 from papi_sdk.models.hotel_info import HotelInfoRequest, HotelInfoResponse
@@ -50,6 +52,10 @@
 )
 from papi_sdk.models.search.region.b2b import B2BRegionRequest, B2BRegionResponse
 
+PAPI_SDK_VERSION = f"{__name__}/{__version__}"
+REQUESTS_VERSION = f"{requests.__name__}/{requests.__version__}"
+PYTHON_VERSION = f"python/{version_info.major}.{version_info.minor}"
+
 
 class APIv3:
     def __init__(self, key: str):
@@ -65,12 +71,30 @@ def _get_key_data(key: str) -> Tuple[str, str]:
         except ValueError:
             raise InvalidAuthData(key)
 
+    @staticmethod
+    def _add_user_agent(requests_kwargs: Optional[dict]) -> dict:
+        header_key = "headers"
+        versions = f"{PAPI_SDK_VERSION} {REQUESTS_VERSION} ({PYTHON_VERSION})"
+        user_agent = {"User-Agent": versions}
+
+        headers = requests_kwargs.get(header_key)
+        if not headers:
+            requests_kwargs[header_key] = user_agent
+            return requests_kwargs
+
+        if "User-Agent" in headers:
+            return requests_kwargs
+
+        requests_kwargs[header_key] = {**requests_kwargs[header_key], **user_agent}
+        return requests_kwargs
+
     def _get_request(
         self, endpoint: str, params: dict = None, **requests_kwargs
     ) -> dict:
         """
         Inner method for GET requests.
         """
+        requests_kwargs = self._add_user_agent(requests_kwargs)
         response = self.session.get(endpoint, params=params, **requests_kwargs)
         return response.json()
 
@@ -80,6 +104,7 @@ def _post_request(
         """
         Inner method for POST requests.
         """
+        requests_kwargs = self._add_user_agent(requests_kwargs)
         response = self.session.post(endpoint, json=json, **requests_kwargs)
         return response.json()
 
@@ -225,7 +250,7 @@ def order_booking_finish_status(
         response = self._post_request(
             Endpoint.ORDER_BOOKING_FINISH_STATUS.value,
             data=data.json(),
-            **requests_kwargs
+            **requests_kwargs,
         )
         return HotelOrderBookingFinishStatusResponse(**response)
 

papi_sdk/tests/test_base.py

@@ -1,9 +1,10 @@
 import unittest
+import uuid
 
 from papi_sdk import APIv3
 
 
 class BaseTest(unittest.TestCase):
-    client = APIv3(key=f"1234:str(uuid.uuid4())")
+    client = APIv3(key=f"1234:{str(uuid.uuid4())}")
     status_ok = "ok"
     status_error = "error"