fixes + mypuy

Author: jaddek

pyproject.toml

@@ -17,6 +17,7 @@ dependencies = [
     "black>=25.1.0",
     "coverage>=7.8.0",
     "httpx[http2]>=0.28.1,<0.29.0",
+    "mypy>=1.15.0",
 ]
 
 [dependency-groups]
@@ -54,5 +55,5 @@ line-length = 120
 
 [tool.ruff]
 line-length = 120
-select = ["E", "F", "B", "I"]  # Errors, Pyflakes, Bugbear, isort
-fix = true
+lint.select = ["E", "F", "B", "I"]  # Errors, Pyflakes, Bugbear, isort
+fix = true

requirements.txt

@@ -170,10 +170,46 @@ iniconfig==2.1.0 \
     --hash=sha256:3abbd2e30b36733fee78f9c7f7308f2d0050e88f0087fd25c2645f63c773e1c7 \
     --hash=sha256:9deba5723312380e77435581c6bf4935c94cbfab9b1ed33ef8d238ea168eb760
     # via pytest
+mypy==1.15.0 \
+    --hash=sha256:1124a18bc11a6a62887e3e137f37f53fbae476dc36c185d549d4f837a2a6a14e \
+    --hash=sha256:171a9ca9a40cd1843abeca0e405bc1940cd9b305eaeea2dda769ba096932bb22 \
+    --hash=sha256:1905f494bfd7d85a23a88c5d97840888a7bd516545fc5aaedff0267e0bb54e2f \
+    --hash=sha256:1fbb8da62dc352133d7d7ca90ed2fb0e9d42bb1a32724c287d3c76c58cbaa9c2 \
+    --hash=sha256:2922d42e16d6de288022e5ca321cd0618b238cfc5570e0263e5ba0a77dbef56f \
+    --hash=sha256:2e2c2e6d3593f6451b18588848e66260ff62ccca522dd231cd4dd59b0160668b \
+    --hash=sha256:2ee2d57e01a7c35de00f4634ba1bbf015185b219e4dc5909e281016df43f5ee5 \
+    --hash=sha256:2f2147ab812b75e5b5499b01ade1f4a81489a147c01585cda36019102538615f \
+    --hash=sha256:404534629d51d3efea5c800ee7c42b72a6554d6c400e6a79eafe15d11341fd43 \
+    --hash=sha256:5469affef548bd1895d86d3bf10ce2b44e33d86923c29e4d675b3e323437ea3e \
+    --hash=sha256:5a95fb17c13e29d2d5195869262f8125dfdb5c134dc8d9a9d0aecf7525b10c2c \
+    --hash=sha256:6983aae8b2f653e098edb77f893f7b6aca69f6cffb19b2cc7443f23cce5f4828 \
+    --hash=sha256:712e962a6357634fef20412699a3655c610110e01cdaa6180acec7fc9f8513ba \
+    --hash=sha256:8023ff13985661b50a5928fc7a5ca15f3d1affb41e5f0a9952cb68ef090b31ee \
+    --hash=sha256:811aeccadfb730024c5d3e326b2fbe9249bb7413553f15499a4050f7c30e801d \
+    --hash=sha256:8f8722560a14cde92fdb1e31597760dc35f9f5524cce17836c0d22841830fd5b \
+    --hash=sha256:93faf3fdb04768d44bf28693293f3904bbb555d076b781ad2530214ee53e3445 \
+    --hash=sha256:973500e0774b85d9689715feeffcc980193086551110fd678ebe1f4342fb7c5e \
+    --hash=sha256:979e4e1a006511dacf628e36fadfecbcc0160a8af6ca7dad2f5025529e082c13 \
+    --hash=sha256:98b7b9b9aedb65fe628c62a6dc57f6d5088ef2dfca37903a7d9ee374d03acca5 \
+    --hash=sha256:aea39e0583d05124836ea645f412e88a5c7d0fd77a6d694b60d9b6b2d9f184fd \
+    --hash=sha256:b9378e2c00146c44793c98b8d5a61039a048e31f429fb0eb546d93f4b000bedf \
+    --hash=sha256:baefc32840a9f00babd83251560e0ae1573e2f9d1b067719479bfb0e987c6357 \
+    --hash=sha256:be68172e9fd9ad8fb876c6389f16d1c1b5f100ffa779f77b1fb2176fcc9ab95b \
+    --hash=sha256:c43a7682e24b4f576d93072216bf56eeff70d9140241f9edec0c104d0c515036 \
+    --hash=sha256:c4bb0e1bd29f7d34efcccd71cf733580191e9a264a2202b0239da95984c5b559 \
+    --hash=sha256:c7be1e46525adfa0d97681432ee9fcd61a3964c2446795714699a998d193f1a3 \
+    --hash=sha256:c9817fa23833ff189db061e6d2eff49b2f3b6ed9856b4a0a73046e41932d744f \
+    --hash=sha256:ce436f4c6d218a070048ed6a44c0bbb10cd2cc5e272b29e7845f6a2f57ee4464 \
+    --hash=sha256:d10d994b41fb3497719bbf866f227b3489048ea4bbbb5015357db306249f7980 \
+    --hash=sha256:e601a7fa172c2131bff456bb3ee08a88360760d0d2f8cbd7a75a65497e2df078 \
+    --hash=sha256:f95579473af29ab73a10bada2f9722856792a36ec5af5399b653aa28360290a5
+    # via jpy-tillo-sdk
 mypy-extensions==1.1.0 \
     --hash=sha256:1be4cccdb0f2482337c4743e60421de3a356cd97508abadd57d47403e94f5505 \
     --hash=sha256:52e68efc3284861e772bbcd66823fde5ae21fd2fdb51c62a211403730b916558
-    # via black
+    # via
+    #   black
+    #   mypy
 nodeenv==1.9.1 \
     --hash=sha256:6ec12890a2dab7946721edbfbcd91f3319c6ccc9aec47be7c7e6b7011ee6645f \
     --hash=sha256:ba11c9782d29c27c70ffbdda2d7415098754709be8a7056d79a737cd901155c9
@@ -319,13 +355,15 @@ tomli==2.2.1 ; python_full_version < '3.11' \
     --hash=sha256:f4039b9cbc3048b2416cc57ab3bda989a6fcf9b36cf8937f01a6e731b64f80d7
     # via
     #   black
+    #   mypy
     #   pytest
-typing-extensions==4.13.2 ; python_full_version < '3.13' \
+typing-extensions==4.13.2 \
     --hash=sha256:a439e7c04b49fec3e5d3e2beaa21755cadbbdc391694e28ccdd36ca4a1408f8c \
     --hash=sha256:e6c81219bd689f51865d9e372991c540bda33a0379d5573cddb9a3a23f7caaef
     # via
     #   anyio
     #   black
+    #   mypy
     #   pytest-asyncio
 virtualenv==20.31.2 \
     --hash=sha256:36efd0d9650ee985f0cad72065001e66d49a6f24eb44d98980f630686243cf11 \

src/jpy_tillo_sdk/contracts.py

@@ -26,11 +26,75 @@ def brand(self):
 import logging
 import uuid
 from abc import ABC, abstractmethod
+from typing import Any, Optional
+
+from httpx import Response
 
-# Configure logging
 logger = logging.getLogger("tillo.contracts")
 
 
+class IssueDigitalCodeServiceInterface(ABC):
+    @abstractmethod
+    async def issue_digital_code(
+        self,
+        query_params: Optional[Any] = None,
+        body: Optional[Any] = None,
+    ): ...
+
+
+class IssueDigitalCodeServiceAsyncInterface(ABC):
+    @abstractmethod
+    async def order_digital_code(
+        self,
+        query_params: Optional[Any] = None,
+        body: Optional[Any] = None,
+    ): ...
+
+
+class TemplateServiceInterface(ABC):
+    @abstractmethod
+    def download_brand_template(
+        self,
+        query_params: Optional[Any] = None,
+    ) -> Any: ...
+
+    @abstractmethod
+    def get_brand_templates(
+        self,
+        query_params: Optional[Any] = None,
+    ) -> Any: ...
+
+
+class TemplateServiceAsyncInterface(ABC):
+    @abstractmethod
+    async def download_brand_template(
+        self,
+        query_params: Optional[Any] = None,
+    ) -> Any: ...
+
+    @abstractmethod
+    async def get_brand_templates(
+        self,
+        query_params: Optional[Any] = None,
+    ) -> Any: ...
+
+
+class FloatServiceAsyncInterface(ABC):
+    @abstractmethod
+    async def check_floats(
+        self,
+        query_params: Optional[Any] = None,
+    ) -> Response: ...
+
+
+class FloatServiceInterface(ABC):
+    @abstractmethod
+    def check_floats(
+        self,
+        query_params: Optional[Any] = None,
+    ) -> Response: ...
+
+
 class SignatureGeneratorInterface(ABC):
     """Interface for generating secure signatures for Tillo API requests.
 
@@ -55,8 +119,7 @@ def get_api_key(self) -> str:
         Returns:
             str: The API key used for Tillo API authentication
         """
-        logger.debug("Getting API key for authentication")
-        pass
+        ...
 
     @abstractmethod
     def get_secret_key_as_bytes(self) -> bytearray:
@@ -65,8 +128,7 @@ def get_secret_key_as_bytes(self) -> bytearray:
         Returns:
             bytearray: The secret key encoded as UTF-8 bytes
         """
-        logger.debug("Getting secret key as bytes for HMAC generation")
-        pass
+        ...
 
     @staticmethod
     @abstractmethod
@@ -76,8 +138,7 @@ def generate_timestamp() -> str:
         Returns:
             str: Current timestamp in milliseconds as a string
         """
-        logger.debug("Generating Unix timestamp in milliseconds")
-        pass
+        ...
 
     @staticmethod
     @abstractmethod
@@ -87,8 +148,7 @@ def generate_unique_client_request_id() -> uuid.UUID:
         Returns:
             uuid.UUID: A new UUID v4 for request identification
         """
-        logger.debug("Generating unique client request ID")
-        pass
+        ...
 
     @abstractmethod
     def generate_signature_string(self, endpoint: str, request_type: str, timestamp: str, params: tuple) -> str:
@@ -103,12 +163,7 @@ def generate_signature_string(self, endpoint: str, request_type: str, timestamp:
         Returns:
             str: The string to be signed according to Tillo's specification
         """
-        logger.debug(
-            "Generating signature string for endpoint: %s, method: %s",
-            endpoint,
-            request_type,
-        )
-        pass
+        ...
 
     @abstractmethod
     def generate_signature(self, seed: str) -> str:
@@ -120,8 +175,7 @@ def generate_signature(self, seed: str) -> str:
         Returns:
             str: The hexadecimal HMAC-SHA256 signature
         """
-        logger.debug("Generating HMAC-SHA256 signature")
-        pass
+        ...
 
 
 class SignatureBridgeInterface(ABC):
@@ -157,12 +211,7 @@ def sign(
         Returns:
             tuple: A tuple containing (api_key, signature, timestamp)
         """
-        logger.debug(
-            "Generating complete signature for endpoint: %s, method: %s",
-            endpoint,
-            method,
-        )
-        pass
+        ...
 
 
 class TilloInterface(ABC):
@@ -185,8 +234,9 @@ def brand(self):
         ```
     """
 
+    @property
     @abstractmethod
-    def floats(self):
+    def floats(self) -> FloatServiceInterface:
         """Get the floats service instance.
 
         Returns:
@@ -198,10 +248,11 @@ def floats(self):
             balance =  float_service.get_balance()
             ```
         """
-        pass
+        ...
 
+    @property
     @abstractmethod
-    def floats_async(self):
+    def floats_async(self) -> FloatServiceAsyncInterface:
         """Get the asynchronous floats service instance.
 
         Returns:
@@ -213,8 +264,9 @@ def floats_async(self):
             balance = float_service.get_balance()
             ```
         """
-        pass
+        ...
 
+    @property
     @abstractmethod
     def brands(self):
         """Get the brand service instance.
@@ -228,8 +280,9 @@ def brands(self):
             brand_info = brand_service.get_brand_details()
             ```
         """
-        pass
+        ...
 
+    @property
     @abstractmethod
     def brands_async(self):
         """Get the brand service instance.
@@ -243,10 +296,11 @@ def brands_async(self):
             brand_info = brand_service.get_brand_details()
             ```
         """
-        pass
+        ...
 
+    @property
     @abstractmethod
-    def templates(self):
+    def templates(self) -> TemplateServiceInterface:
         """Get the template service instance.
 
         Returns:
@@ -258,10 +312,11 @@ def templates(self):
             templates = template_service.list_templates()
             ```
         """
-        pass
+        ...
 
+    @property
     @abstractmethod
-    async def templates_async(self):
+    def templates_async(self) -> TemplateServiceAsyncInterface:
         """Get the template service instance.
 
         Returns:
@@ -273,10 +328,11 @@ async def templates_async(self):
             templates = template_service.list_templates()
             ```
         """
-        pass
+        ...
 
+    @property
     @abstractmethod
-    def digital_card(self):
+    def digital_card(self) -> IssueDigitalCodeServiceInterface:
         """Get the digital card service instance.
 
         Returns:
@@ -288,11 +344,11 @@ def digital_card(self):
             card = digital_card_service.issue_card(amount=50.00)
             ```
         """
-        logger.debug("Getting digital card service instance")
-        pass
+        ...
 
+    @property
     @abstractmethod
-    def digital_card_async(self):
+    def digital_card_async(self) -> IssueDigitalCodeServiceAsyncInterface:
         """Get the digital card service instance.
 
         Returns:
@@ -304,9 +360,9 @@ def digital_card_async(self):
             card = digital_card_service.issue_card(amount=50.00)
             ```
         """
-        logger.debug("Getting digital card service instance")
-        pass
+        ...
 
+    @property
     @abstractmethod
     def physical_card(self):
         """Get the physical card service instance.
@@ -320,9 +376,9 @@ def physical_card(self):
             card = physical_card_service.order_card(amount=100.00)
             ```
         """
-        logger.debug("Getting physical card service instance")
-        pass
+        ...
 
+    @property
     @abstractmethod
     def webhook(self):
         """Get the webhook service instance.
@@ -336,5 +392,4 @@ def webhook(self):
             webhooks = webhook_service.list_webhooks()
             ```
         """
-        logger.debug("Getting webhook service instance")
-        pass
+        ...

src/jpy_tillo_sdk/domain/brand/services.py

@@ -1,6 +1,7 @@
 import logging
 from typing import Any, Optional
 
+from ...contracts import TemplateServiceAsyncInterface, TemplateServiceInterface
 from ...http_client import AsyncHttpClient, HttpClient
 from .endpoints import BrandEndpoint, TemplateEndpoint, TemplateListEndpoint
 
@@ -44,7 +45,7 @@ async def get_available_brands(
         return await self.client.request(endpoint=endpoint)
 
 
-class TemplateService:
+class TemplateService(TemplateServiceInterface):
     def __init__(self, *, client: HttpClient):
         """Initialize the float service with an HTTP client.
 
@@ -69,7 +70,7 @@ def download_brand_template(
         return self.client.request(endpoint=endpoint)
 
 
-class TemplateServiceAsync:
+class TemplateServiceAsync(TemplateServiceAsyncInterface):
     def __init__(self, *, client: AsyncHttpClient):
         """Initialize the float service with an HTTP client.