alpha-python 0.7.0__tar.gz → 0.7.1__tar.gz

{alpha_python-0.7.0 → alpha_python-0.7.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: alpha-python
-Version: 0.7.0
+Version: 0.7.1
 Summary: Alpha is intended to be the first dependency you need to add to your Python application. It is a Python library which contains standard building blocks that can be used in applications that are used as APIs and/or make use of database interaction.
 Author-email: Bart Reijling <bart@reijling.eu>
 License-Expression: MIT

{alpha_python-0.7.0 → alpha_python-0.7.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "alpha-python"
-version = "0.7.0"
+version = "0.7.1"
 description = "Alpha is intended to be the first dependency you need to add to your Python application. It is a Python library which contains standard building blocks that can be used in applications that are used as APIs and/or make use of database interaction."
 readme = "README.md"
 authors = [

{alpha_python-0.7.0 → alpha_python-0.7.1}/src/alpha/__init__.py

@@ -30,6 +30,7 @@ from alpha.interfaces.pydantic_instance import PydanticInstance
 from alpha.interfaces.openapi_model import OpenAPIModel
 from alpha.interfaces.updatable import Updatable
 from alpha.interfaces.patchable import Patchable
+from alpha.interfaces.http_client import HTTPClient, HTTPResponse
 from alpha.interfaces.api_repository import ApiRepository
 from alpha.interfaces.sql_repository import SqlRepository
 from alpha.interfaces.sql_mapper import SqlMapper
@@ -140,6 +141,8 @@ __all__ = [
     "OpenAPIModel",
     "Updatable",
     "Patchable",
+    "HTTPClient",
+    "HTTPResponse",
     "ApiRepository",
     "SqlRepository",
     "SqlMapper",

{alpha_python-0.7.0 → alpha_python-0.7.1}/src/alpha/interfaces/__init__.py

@@ -6,6 +6,9 @@ from alpha.interfaces.openapi_model import OpenAPIModel
 from alpha.interfaces.updatable import Updatable
 from alpha.interfaces.patchable import Patchable
 
+# import all http client related interfaces
+from alpha.interfaces.http_client import HTTPClient, HTTPResponse
+
 # import all repository related interfaces
 from alpha.interfaces.api_repository import ApiRepository
 from alpha.interfaces.sql_repository import SqlRepository
@@ -34,6 +37,8 @@ __all__ = [
     "OpenAPIModel",
     "Updatable",
     "Patchable",
+    "HTTPClient",
+    "HTTPResponse",
     "ApiRepository",
     "SqlRepository",
     "RefreshRepository",

{alpha_python-0.7.0 → alpha_python-0.7.1}/src/alpha/interfaces/api_repository.py

@@ -263,7 +263,7 @@ class ApiRepository(Protocol[DomainModel]):
             Whether to use the model factory method for creating models from
             response data.
         endpoint
-            The API endpoint to which the object should be added.
+            The API endpoint from which the object should be retrieved.
         parent_endpoint
             The parent API endpoint, if the resource is nested under a parent
             resource.
@@ -340,7 +340,7 @@ class ApiRepository(Protocol[DomainModel]):
             Whether to use the model factory method for creating models from
             response data.
         endpoint
-            The API endpoint to which the object should be added.
+            The API endpoint from which the objects should be retrieved.
         parent_endpoint
             The parent API endpoint, if the resource is nested under a parent
             resource.
@@ -441,7 +441,7 @@ class ApiRepository(Protocol[DomainModel]):
             Whether to use the model factory method for creating models from
             response data.
         endpoint
-            The API endpoint to which the object should be added.
+            The API endpoint to which the patch should be applied.
         parent_endpoint
             The parent API endpoint, if the resource is nested under a parent
             resource.
@@ -485,7 +485,7 @@ class ApiRepository(Protocol[DomainModel]):
         Parameters
         ----------
         endpoint
-            The API endpoint to which the object should be added.
+            The API endpoint from which the object should be removed.
         parent_endpoint
             The parent API endpoint, if the resource is nested under a parent
             resource.
@@ -585,7 +585,7 @@ class ApiRepository(Protocol[DomainModel]):
             Whether to use the model factory method for creating models from
             response data.
         endpoint
-            The API endpoint to which the object should be added.
+            The API endpoint to which the object should be updated.
         parent_endpoint
             The parent API endpoint, if the resource is nested under a parent
             resource.

alpha_python-0.7.1/src/alpha/interfaces/http_client.py

@@ -0,0 +1,61 @@
+from typing import MutableMapping, Protocol, Any, runtime_checkable
+
+
+@runtime_checkable
+class HTTPResponse(Protocol):
+    """Interface for HTTP response objects returned by HTTP clients.
+
+    This interface is compatible with the response objects returned by popular
+    synchronous HTTP client libraries, for example, the `requests` library,
+    `httpx` library or any custom implementation that follows the same
+    attributes and method signatures.
+
+    This interface defines the attributes and methods that an HTTP response
+    object should have to be compatible with the REST API repository. It
+    includes attributes for accessing the response status code, headers, and
+    content, as well as a method for parsing the response content as JSON.
+    """
+
+    status_code: int
+    headers: dict[str, str]
+    content: bytes
+    text: str
+
+    def json(self) -> Any: ...
+    def raise_for_status(self) -> None: ...
+
+
+@runtime_checkable
+class HTTPClient(Protocol):
+    """Interface for HTTP clients like requests, httpx or a custom
+    implementation.
+
+    This interface is compatible with the popular synchronous HTTP client
+    libraries, for example, the `requests` library, `httpx` library or any
+    custom implementation that follows the same method signatures.
+
+    This interface defines the methods that an HTTP client should implement to
+    be compatible with the REST API repository. It includes methods for making
+    HTTP requests (POST, GET, DELETE, PUT, PATCH) and allows for additional
+    parameters to be passed as needed.
+    """
+
+    cookies: MutableMapping[str, str]
+    headers: MutableMapping[str, str]
+
+    def request(
+        self, method: str, url: str, **kwargs: Any
+    ) -> HTTPResponse: ...
+    def close(self) -> None: ...
+
+    def post(
+        self, url: str, json: Any = None, **kwargs: Any
+    ) -> HTTPResponse: ...
+    def get(self, url: str, **kwargs: Any) -> HTTPResponse: ...
+    def delete(self, url: str, **kwargs: Any) -> HTTPResponse: ...
+    def put(
+        self, url: str, json: Any = None, **kwargs: Any
+    ) -> HTTPResponse: ...
+    def patch(
+        self, url: str, json: Any = None, **kwargs: Any
+    ) -> HTTPResponse: ...

{alpha_python-0.7.0 → alpha_python-0.7.1}/src/alpha/providers/models/token.py

@@ -93,11 +93,11 @@ class Token(BaseDomainModel):
         ----------
         subject
             The subject or user associated with the token.
-        max_age_seconds, optional
+        max_age_seconds
             Optional maximum age of the token in seconds. Defaults to 7 days.
             If provided, the expires_at will be set to created_at +
             max_age_seconds.
-        token_length, optional
+        token_length
             Optional length of the token value. Defaults to 32.
 
         Returns

{alpha_python-0.7.0 → alpha_python-0.7.1}/src/alpha/repositories/refresh/cache_repository.py

@@ -13,11 +13,14 @@ class CacheRefreshRepository:
     ):
         """Initialize the CacheRefreshRepository with the given cache connector.
 
+        *** This class is not fully implemented yet. The methods are defined
+        but not implemented. ***
+
         Parameters
         ----------
         cache_connector
             The cache connector instance to use for cache operations.
-        token_model, optional
+        token_model
             The model class for tokens, by default Token. The model class
             should have a `from_dict` class method that takes a dictionary and
             returns an instance of the model. The dictionary will have the same
@@ -26,10 +29,10 @@ class CacheRefreshRepository:
             the model to a dictionary with the same structure as the token data
             in the JSON file. The model class should also have a
             `create_refresh` class method that creates a new refresh token.
-        token_max_age_seconds, optional
+        token_max_age_seconds
             The maximum age of a token in seconds, by default the equivalent of
             7 days in seconds
-        token_length, optional
+        token_length
             The length of the generated token string, by default 32 characters
         """
         self._cache_connector = cache_connector

{alpha_python-0.7.0 → alpha_python-0.7.1}/src/alpha/repositories/refresh/database_repository.py

@@ -27,7 +27,7 @@ class DatabaseRefreshRepository:
         ----------
         database_connector
             The database connector instance to use for database operations.
-        token_model, optional
+        token_model
             The model class for tokens, by default Token. The model class
             should have a `from_dict` class method that takes a dictionary and
             returns an instance of the model. The dictionary will have the same
@@ -36,10 +36,10 @@ class DatabaseRefreshRepository:
             the model to a dictionary with the same structure as the token data
             in the JSON file. The model class should also have a
             `create_refresh` class method that creates a new refresh token.
-        token_max_age_seconds, optional
+        token_max_age_seconds
             The maximum age of a token in seconds, by default the equivalent of
             7 days in seconds
-        token_length, optional
+        token_length
             The length of the generated token string, by default 32 characters
         """
         self._database_connector = database_connector

{alpha_python-0.7.0 → alpha_python-0.7.1}/src/alpha/repositories/refresh/file_repository.py

@@ -36,7 +36,7 @@ class FileRefreshRepository:
                 ...
             }
             ```
-        token_model, optional
+        token_model
             The model class for tokens, by default Token. The model class
             should have a `from_dict` class method that takes a dictionary and
             returns an instance of the model. The dictionary will have the same
@@ -45,10 +45,10 @@ class FileRefreshRepository:
             the model to a dictionary with the same structure as the token data
             in the JSON file. The model class should also have a
             `create_refresh` class method that creates a new refresh token.
-        token_max_age_seconds, optional
+        token_max_age_seconds
             The maximum age of a token in seconds, by default the equivalent of
             7 days in seconds
-        token_length, optional
+        token_length
             The length of the generated token string, by default 32 characters
         """
         self._file_path = file_path or "refresh_tokens.json"

{alpha_python-0.7.0 → alpha_python-0.7.1}/src/alpha/repositories/refresh/memory_repository.py

@@ -18,7 +18,7 @@ class MemoryRefreshRepository:
 
         Parameters
         ----------
-        token_model, optional
+        token_model
             The model class for tokens, by default Token. The model class
             should have a `from_dict` class method that takes a dictionary and
             returns an instance of the model. The dictionary will have the same
@@ -27,10 +27,10 @@ class MemoryRefreshRepository:
             the model to a dictionary with the same structure as the token data
             in the JSON file. The model class should also have a
             `create_refresh` class method that creates a new refresh token.
-        token_max_age_seconds, optional
+        token_max_age_seconds
             The maximum age of a token in seconds, by default the equivalent of
             7 days in seconds
-        token_length, optional
+        token_length
             The length of the generated token string, by default 32 characters
         """
         self._token_model = token_model

{alpha_python-0.7.0 → alpha_python-0.7.1}/src/alpha/repositories/rest_api_repository.py

@@ -4,14 +4,13 @@ from urllib.parse import urlencode, urljoin
 from uuid import UUID
 
 import requests
-from requests.cookies import cookiejar_from_dict  # type: ignore
-from requests.models import Response
+from requests.cookies import cookiejar_from_dict, RequestsCookieJar  # type: ignore
 from typing import Any, Generic, TypeVar, cast
 
 from alpha import exceptions
 from alpha.domain.models.base_model import BaseDomainModel, DomainModel
 from alpha.infra.models.json_patch import JsonPatch
-from alpha.interfaces.http_client import HTTPClient
+from alpha.interfaces.http_client import HTTPClient, HTTPResponse
 
 T = TypeVar("T", bound=BaseDomainModel)
 
@@ -108,7 +107,9 @@ class RestApiRepository(Generic[DomainModel]):
         self._model_factory_method_name = model_factory_method_name
         self._model_serialization_method_name = model_serialization_method_name
 
-        client_obj = client or session or requests.sessions.Session()
+        client_obj = cast(
+            HTTPClient, client or session or requests.sessions.Session()
+        )
         # Expose the underlying client publicly for consistency with other
         # repositories
         self.client = client_obj
@@ -123,12 +124,65 @@ class RestApiRepository(Generic[DomainModel]):
         self._response_data_attribute = response_data_attribute
         # Update client with default headers and cookies
         self.client.headers.update(request_headers or {})
-        cookiejar_from_dict(
-            request_cookies or {},
-            cookiejar=self.client.cookies,
-            overwrite=True,
+        if request_cookies:
+            cookies = self.client.cookies
+            # If the client's cookies object supports the `update` method and
+            # is not a `RequestsCookieJar`, use `update`. Otherwise, if it's a
+            # `RequestsCookieJar`, use `cookiejar_from_dict` to update it.
+            # This ensures compatibility with different types of cookie
+            # implementations that may be used by various HTTP clients.
+            if hasattr(cookies, "update") and not isinstance(
+                cookies, RequestsCookieJar
+            ):
+                cookies.update(request_cookies)
+            elif isinstance(cookies, RequestsCookieJar):
+                cookiejar_from_dict(
+                    request_cookies,
+                    cookiejar=cookies,
+                    overwrite=True,
+                )
+
+    def request(
+        self,
+        method: str,
+        url: str,
+        **kwargs: Any,
+    ) -> Any | None:
+        """Make a custom API request.
+
+        This method allows for making custom API requests using any HTTP method
+        supported by the underlying HTTP client. It provides flexibility for
+        making requests that may not fit the standard CRUD operations defined
+        in the repository. The method accepts the HTTP method, URL, and any
+        additional parameters that should be passed to the HTTP client's
+        request method.
+
+        Parameters
+        ----------
+        method
+            The HTTP method to use for the request (e.g., "GET", "POST", "PUT",
+            "DELETE", etc.).
+        url
+            The URL to which the request should be sent. This has to be a fully
+            constructed URL.
+        **kwargs
+            Additional parameters to include in the function call which handles
+            the API request. This allows for flexibility in specifying
+            parameters such as headers, authentication tokens, or other request
+            options that may be needed for the API call.
+
+        Returns
+        -------
+            The data retrieved from the API response.
+        """
+        response = self.client.request(
+            method=method.upper(),
+            url=url,
+            **kwargs,
         )
 
+        return self._handle_response(response)
+
     def add(
         self,
         obj: DomainModel,
@@ -324,7 +378,7 @@ class RestApiRepository(Generic[DomainModel]):
             Whether to use the model factory method for creating models from
             response data.
         endpoint
-            The API endpoint to which the object should be added.
+            The API endpoint from which the object should be retrieved.
         parent_endpoint
             The parent API endpoint, if the resource is nested under a parent
             resource.
@@ -390,7 +444,7 @@ class RestApiRepository(Generic[DomainModel]):
             Whether to use the model factory method for creating models from
             response data.
         endpoint
-            The API endpoint to which the object should be added.
+            The API endpoint from which the objects should be retrieved.
         parent_endpoint
             The parent API endpoint, if the resource is nested under a parent
             resource.
@@ -462,7 +516,7 @@ class RestApiRepository(Generic[DomainModel]):
             Whether to use the model factory method for creating models from
             response data.
         endpoint
-            The API endpoint to which the object should be added.
+            The API endpoint to which the patch should be applied.
         parent_endpoint
             The parent API endpoint, if the resource is nested under a parent
             resource.
@@ -474,7 +528,7 @@ class RestApiRepository(Generic[DomainModel]):
         param
             The parameter to identify the specific resource. This could be an
             ID or a unique identifier. The parameter will be appended to the
-            endpoint to form the full URL for the GET request.
+            endpoint to form the full URL for the PATCH request.
         model
             The model to use for serialization/deserialization.
         additional_request_params
@@ -525,7 +579,7 @@ class RestApiRepository(Generic[DomainModel]):
         Parameters
         ----------
         endpoint
-            The API endpoint to which the object should be added.
+            The API endpoint from which the object should be removed.
         parent_endpoint
             The parent API endpoint, if the resource is nested under a parent
             resource.
@@ -537,7 +591,7 @@ class RestApiRepository(Generic[DomainModel]):
         param
             The parameter to identify the specific resource. This could be an
             ID or a unique identifier. The parameter will be appended to the
-            endpoint to form the full URL for the GET request.
+            endpoint to form the full URL for the DELETE request.
         additional_request_params
             Additional parameters to include in the function call which handles
             the API request. This allows for flexibility in specifying
@@ -588,7 +642,7 @@ class RestApiRepository(Generic[DomainModel]):
             Whether to use the model factory method for creating models from
             response data.
         endpoint
-            The API endpoint to which the object should be added.
+            The API endpoint to which the object should be updated.
         parent_endpoint
             The parent API endpoint, if the resource is nested under a parent
             resource.
@@ -600,7 +654,7 @@ class RestApiRepository(Generic[DomainModel]):
         param
             The parameter to identify the specific resource. This could be an
             ID or a unique identifier. The parameter will be appended to the
-            endpoint to form the full URL for the GET request.
+            endpoint to form the full URL for the PUT request.
         model
             The model to use for serialization/deserialization.
         additional_request_params
@@ -943,7 +997,7 @@ class RestApiRepository(Generic[DomainModel]):
         return obj
 
     def _get_data_from_response(
-        self, response: Response
+        self, response: HTTPResponse
     ) -> dict[str, Any] | None:
         """Extract data from the API response. If the response_data_attribute
         is configured, it will return the value of that attribute. Otherwise,
@@ -1044,7 +1098,7 @@ class RestApiRepository(Generic[DomainModel]):
 
         return model_to_use
 
-    def _handle_response(self, response: Response) -> Any | None:
+    def _handle_response(self, response: HTTPResponse) -> Any | None:
         """Handle the API response and extract the relevant data.
 
         In addition to extracting data from successful responses, this method

{alpha_python-0.7.0 → alpha_python-0.7.1}/src/alpha_python.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: alpha-python
-Version: 0.7.0
+Version: 0.7.1
 Summary: Alpha is intended to be the first dependency you need to add to your Python application. It is a Python library which contains standard building blocks that can be used in applications that are used as APIs and/or make use of database interaction.
 Author-email: Bart Reijling <bart@reijling.eu>
 License-Expression: MIT

alpha_python-0.7.0/src/alpha/interfaces/http_client.py

@@ -1,26 +0,0 @@
-from typing import Protocol, Any, runtime_checkable
-
-
-@runtime_checkable
-class HTTPClient(Protocol):
-    """Interface for HTTP clients like requests, httpx or a custom
-    implementation.
-
-    This interface is compatible with the popular synchronous HTTP client
-    libraries, for example, the `requests` library, `httpx` library or any
-    custom implementation that follows the same method signatures.
-
-    This interface defines the methods that an HTTP client should implement to
-    be compatible with the REST API repository. It includes methods for making
-    HTTP requests (POST, GET, DELETE, PUT, PATCH) and allows for additional
-    parameters to be passed as needed.
-    """
-
-    cookies: Any
-    headers: Any
-
-    def post(self, url: str, json: Any = None, **kwargs: Any) -> Any: ...
-    def get(self, url: str, **kwargs: Any) -> Any: ...
-    def delete(self, url: str, **kwargs: Any) -> Any: ...
-    def put(self, url: str, json: Any = None, **kwargs: Any) -> Any: ...
-    def patch(self, url: str, json: Any = None, **kwargs: Any) -> Any: ...