Merge pull request #58 from fintoc-com/version_handling

Version handling

fintoc/client.py

@@ -10,15 +10,15 @@
 
 
 class Client:
-
     """Encapsulates the client behaviour and methods."""
 
-    def __init__(self, base_url, api_key, user_agent, params={}):
+    def __init__(self, base_url, api_key, api_version, user_agent, params={}):
         self.base_url = base_url
         self.api_key = api_key
         self.user_agent = user_agent
         self.params = params
         self.__client = None
+        self.api_version = api_version
 
     @property
     def _client(self):
@@ -33,7 +33,15 @@ def _client(self):
     @property
     def headers(self):
         """Return the appropriate headers for every request."""
-        return {"Authorization": self.api_key, "User-Agent": self.user_agent}
+        headers = {
+            "Authorization": self.api_key,
+            "User-Agent": self.user_agent,
+        }
+
+        if self.api_version is not None:
+            headers["Fintoc-Version"] = self.api_version
+
+        return headers
 
     def request(self, path, paginated=False, method="get", params=None, json=None):
         """
@@ -62,6 +70,7 @@ def extend(
         return Client(
             base_url=base_url or self.base_url,
             api_key=api_key or self.api_key,
+            api_version=self.api_version,
             user_agent=user_agent or self.user_agent,
             params={**self.params, **params} if params else self.params,
         )

fintoc/core.py

@@ -16,13 +16,13 @@
 
 
 class Fintoc:
-
     """Encapsulates the core object's behaviour and methods."""
 
-    def __init__(self, api_key):
+    def __init__(self, api_key, api_version=None):
         self._client = Client(
             base_url=f"{API_BASE_URL}/{API_VERSION}",
             api_key=api_key,
+            api_version=api_version,
             user_agent=f"fintoc-python/{__version__}",
         )
         self.charges = ChargesManager("/charges", self._client)

tests/managers/test_links_manager.py

@@ -12,11 +12,13 @@ def patch_http_client(self, patch_http_client):
     def setup_method(self):
         self.base_url = "https://test.com"
         self.api_key = "super_secret_api_key"
+        self.api_version = None
         self.user_agent = "fintoc-python/test"
         self.params = {"first_param": "first_value", "second_param": "second_value"}
         self.client = Client(
             self.base_url,
             self.api_key,
+            self.api_version,
             self.user_agent,
             params=self.params,
         )

tests/mixins/test_manager_mixin.py

@@ -57,11 +57,13 @@ def patch_http_client(self, patch_http_client):
     def setup_method(self):
         self.base_url = "https://test.com"
         self.api_key = "super_secret_api_key"
+        self.api_version = None
         self.user_agent = "fintoc-python/test"
         self.params = {"first_param": "first_value", "second_param": "second_value"}
         self.client = Client(
             self.base_url,
             self.api_key,
+            self.api_version,
             self.user_agent,
             params=self.params,
         )
@@ -95,11 +97,13 @@ def patch_http_client(self, patch_http_client):
     def setup_method(self):
         self.base_url = "https://test.com"
         self.api_key = "super_secret_api_key"
+        self.api_version = None
         self.user_agent = "fintoc-python/test"
         self.params = {"first_param": "first_value", "second_param": "second_value"}
         self.client = Client(
             self.base_url,
             self.api_key,
+            self.api_version,
             self.user_agent,
             params=self.params,
         )
@@ -148,11 +152,13 @@ def patch_http_client(self, patch_http_client):
     def setup_method(self):
         self.base_url = "https://test.com"
         self.api_key = "super_secret_api_key"
+        self.api_version = None
         self.user_agent = "fintoc-python/test"
         self.params = {"first_param": "first_value", "second_param": "second_value"}
         self.client = Client(
             self.base_url,
             self.api_key,
+            self.api_version,
             self.user_agent,
             params=self.params,
         )

tests/mixins/test_resource_mixin.py

@@ -22,11 +22,13 @@ def patch_http_client(self, patch_http_client):
     def setup_method(self):
         self.base_url = "https://test.com"
         self.api_key = "super_secret_api_key"
+        self.api_version = None
         self.user_agent = "fintoc-python/test"
         self.params = {"first_param": "first_value", "second_param": "second_value"}
         self.client = Client(
             self.base_url,
             self.api_key,
+            self.api_version,
             self.user_agent,
             params=self.params,
         )
@@ -108,11 +110,13 @@ def patch_http_client(self, patch_http_client):
     def setup_method(self):
         self.base_url = "https://test.com"
         self.api_key = "super_secret_api_key"
+        self.api_version = None
         self.user_agent = "fintoc-python/test"
         self.params = {"first_param": "first_value", "second_param": "second_value"}
         self.client = Client(
             self.base_url,
             self.api_key,
+            self.api_version,
             self.user_agent,
             params=self.params,
         )
@@ -159,11 +163,13 @@ def patch_http_client(self, patch_http_client):
     def setup_method(self):
         self.base_url = "https://test.com"
         self.api_key = "super_secret_api_key"
+        self.api_version = None
         self.user_agent = "fintoc-python/test"
         self.params = {"first_param": "first_value", "second_param": "second_value"}
         self.client = Client(
             self.base_url,
             self.api_key,
+            self.api_version,
             self.user_agent,
             params=self.params,
         )

tests/resources/test_account.py

@@ -9,11 +9,13 @@ class TestAccountResource:
     def setup_method(self):
         self.base_url = "https://test.com"
         self.api_key = "super_secret_api_key"
+        self.api_version = None
         self.user_agent = "fintoc-python/test"
         self.params = {"first_param": "first_value", "second_param": "second_value"}
         self.client = Client(
             self.base_url,
             self.api_key,
+            self.api_version,
             self.user_agent,
             params=self.params,
         )

tests/resources/test_link.py

@@ -9,11 +9,13 @@ class TestLinkResource:
     def setup_method(self):
         self.base_url = "https://test.com"
         self.api_key = "super_secret_api_key"
+        self.api_version = None
         self.user_agent = "fintoc-python/test"
         self.params = {"first_param": "first_value", "second_param": "second_value"}
         self.client = Client(
             self.base_url,
             self.api_key,
+            self.api_version,
             self.user_agent,
             params=self.params,
         )

tests/test_client.py

@@ -12,11 +12,19 @@ def setup_method(self):
         self.api_key = "super_secret_api_key"
         self.user_agent = "fintoc-python/test"
         self.params = {"first_param": "first_value", "second_param": "second_value"}
+        self.api_version = None
 
-    def create_client(self, params=False):
+    def create_client(self, params=False, api_version=None):
         if not params:
-            return Client(self.base_url, self.api_key, self.user_agent)
-        return Client(self.base_url, self.api_key, self.user_agent, params=self.params)
+            return Client(self.base_url, self.api_key, api_version, self.user_agent)
+
+        return Client(
+            self.base_url,
+            self.api_key,
+            self.api_version,
+            self.user_agent,
+            params=self.params,
+        )
 
     def test_client_creation_without_params(self):
         client = self.create_client()
@@ -34,7 +42,17 @@ def test_client_creation_with_params(self):
         assert client.user_agent == self.user_agent
         assert client.params == self.params
 
-    def test_client_headers(self):
+    def test_client_headers_with_api_version(self):
+        client = self.create_client(api_version="2023-01-01")
+        assert isinstance(client.headers, dict)
+        assert len(client.headers.keys()) == 3
+        assert "Authorization" in client.headers
+        assert "User-Agent" in client.headers
+        assert client.headers["Authorization"] == self.api_key
+        assert client.headers["User-Agent"] == self.user_agent
+        assert client.headers["Fintoc-Version"] == "2023-01-01"
+
+    def test_client_headers_without_api_version(self):
         client = self.create_client()
         assert isinstance(client.headers, dict)
         assert len(client.headers.keys()) == 2
@@ -87,11 +105,13 @@ def patch_http_client(self, patch_http_client):
     def setup_method(self):
         self.base_url = "https://test.com"
         self.api_key = "super_secret_api_key"
+        self.api_version = None
         self.user_agent = "fintoc-python/test"
         self.params = {"first_param": "first_value", "second_param": "second_value"}
         self.client = Client(
             self.base_url,
             self.api_key,
+            self.api_version,
             self.user_agent,
             params=self.params,
         )

tests/test_core.py

@@ -11,3 +11,16 @@ def test_object_creations(self):
         assert isinstance(fintoc._client, Client)
         assert isinstance(fintoc.links, ManagerMixin)
         assert isinstance(fintoc.webhook_endpoints, ManagerMixin)
+
+    def test_fintoc_creation_with_api_version(self):
+        # pylint: disable=protected-access
+        api_key = "super_secret_api_key"
+        api_version = "2023-01-01"
+        fintoc = Fintoc(api_key, api_version)
+        assert fintoc._client.headers["Fintoc-Version"] == api_version
+
+    def test_fintoc_creation_without_api_version(self):
+        # pylint: disable=protected-access
+        api_key = "super_secret_api_key"
+        fintoc = Fintoc(api_key)
+        assert "Fintoc-Version" not in fintoc._client.headers