feat: first async call

Author: foarsitter

pyproject.toml

@@ -49,6 +49,7 @@ typeguard = ">=2.13.3"
 xdoctest = {extras = ["colors"], version = ">=0.15.10"}
 myst-parser = {version = ">=0.16.1"}
 respx = "^0.20.1"
+pytest-asyncio = "^0.20.3"
 
 [tool.coverage.paths]
 source = ["src", "*/site-packages"]

src/checkedid/client.py

@@ -9,28 +9,31 @@
 from httpx import Request
 from httpx import Response
 
+from . import endpoints
+from . import errors
 from . import models
-from .errors import CheckedIDAuthenticationError
-from .errors import CheckedIDError
-from .errors import CheckedIDNotFoundError
-from .errors import CheckedIDValidationError
 
 
 _T = TypeVar("_T")
 
 
 class Client:
-    ERROR_RESPONSE_MAPPING: Dict[int, Type[CheckedIDError]] = {
-        422: CheckedIDValidationError,
-        403: CheckedIDAuthenticationError,
-        404: CheckedIDNotFoundError,
+    ERROR_RESPONSE_MAPPING: Dict[int, Type[errors.CheckedIDError]] = {
+        422: errors.CheckedIDValidationError,
+        403: errors.CheckedIDAuthenticationError,
+        404: errors.CheckedIDNotFoundError,
     }
 
     def __init__(self, customer_code: str, base_url: str = "https://api.checkedid.eu/"):
-        self.httpx = httpx.Client(base_url=base_url, auth=self.authenticate_request)
+        self.client: Optional[httpx.Client] = None
+        self.base_url = base_url
+        self.create_client(base_url)
         self.access_token: Optional[str] = None
         self.customer_code = customer_code
 
+    def create_client(self, base_url):
+        self.httpx = httpx.Client(base_url=base_url, auth=self.authenticate_request)
+
     def authenticate_request(self, request: Request) -> Request:
         if self.access_token:
             request.headers["Authorization"] = f"Bearer {self.access_token}"
@@ -112,7 +115,7 @@ def dossier_with_scope(
 
     def handle_error_response(self, response: Response) -> None:
         if response.status_code == 400:
-            raise CheckedIDValidationError(
+            raise errors.CheckedIDValidationError(
                 response.text, status_code=response.status_code
             )
 
@@ -128,8 +131,37 @@ def handle_error_response(self, response: Response) -> None:
             status_code=response.status_code, json=json, message="Error from server"
         )
 
-    def map_exception(self, response: Response) -> Type[CheckedIDError]:
+    def map_exception(self, response: Response) -> Type[errors.CheckedIDError]:
         exception_type = self.ERROR_RESPONSE_MAPPING.get(
-            response.status_code, CheckedIDError
+            response.status_code, errors.CheckedIDError
         )
         return exception_type
+
+
+class ClientAsync(Client):
+    """for asyncio"""
+
+    def create_client(self, base_url):
+        self.client = httpx.AsyncClient(base_url=base_url)
+
+    async def dossier(self, dossier_number: str) -> endpoints.DossierEndpoint.response:
+        response = await self.client.get(
+            url=endpoints.DossierEndpoint.url(dossier_number=dossier_number)
+        )
+
+        return self.process_response(response, endpoints.DossierEndpoint.response)
+
+    def close(self):
+        self.client.aclose()
+
+    def open(self):
+        self.create_client(self.base_url)
+
+    def __enter__(self):
+        """Open the httpx client"""
+        self.open()
+        return self
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        """Close the httpx client"""
+        self.close()

src/checkedid/endpoints.py

@@ -0,0 +1,21 @@
+from typing import Type
+
+from pydantic import BaseModel
+
+from checkedid import models
+
+
+class Endpoint:
+    path: str
+    request: Type[BaseModel]
+    response = Type[BaseModel]
+
+
+class DossierEndpoint(Endpoint):
+    path = "/report/{dossier_number}"
+    request = None
+    response = models.ReportResponse
+
+    @classmethod
+    def url(cls, **kwargs):
+        return cls.path.format(**kwargs)

tests/conftest.py

@@ -50,3 +50,17 @@ def auth_client(client: Client, access_token_mock) -> Client:
     assert response.access_token
 
     return client
+
+
+@pytest.fixture
+def dossier_number():
+    return "999999-8888800"
+
+
+@pytest.fixture()
+def dossier_response_200(respx_mock, dossier_number):
+    respx_mock.get("").mock(
+        return_value=Response(
+            status_code=200, json={"DossierNumber": dossier_number, "ReportPDF": ""}
+        )
+    )

tests/test_async_dossiers.py

@@ -0,0 +1,13 @@
+import pytest
+
+from checkedid.client import ClientAsync
+
+
+@pytest.mark.asyncio
+async def test_dossiers(customer_code, dossier_response_200):
+    client = ClientAsync(customer_code)
+
+    with client as client:
+        response = await client.dossier("999999-8888800")
+
+        assert response.DossierNumber == "999999-8888800"

tests/test_dossiers.py

@@ -4,13 +4,7 @@
 from checkedid import errors
 
 
-def test_dossier(auth_client, respx_mock):
-    dossier_number = "999999-8888800"
-    respx_mock.get("").mock(
-        return_value=Response(
-            status_code=200, json={"DossierNumber": dossier_number, "ReportPDF": ""}
-        )
-    )
+def test_dossier(auth_client, respx_mock, dossier_response_200, dossier_number):
     response = auth_client.dossier(dossier_number)
 
     assert response.DossierNumber == dossier_number