alpha-python 0.6.2__py3-none-any.whl → 0.7.0__py3-none-any.whl

alpha/__init__.py

@@ -64,6 +64,18 @@ from alpha.providers.oidc_provider import (
 from alpha.repositories.models.repository_model import RepositoryModel
 from alpha.repositories.rest_api_repository import RestApiRepository
 from alpha.repositories.sql_alchemy_repository import SqlAlchemyRepository
+from alpha.repositories.refresh.cache_repository import (
+    CacheRefreshRepository,
+)
+from alpha.repositories.refresh.database_repository import (
+    DatabaseRefreshRepository,
+)
+from alpha.repositories.refresh.file_repository import (
+    FileRefreshRepository,
+)
+from alpha.repositories.refresh.memory_repository import (
+    MemoryRefreshRepository,
+)
 from alpha.services.authentication_service import AuthenticationService
 from alpha.services.user_lifecycle_management import UserLifecycleManagement
 from alpha.utils.is_attrs import is_attrs
@@ -156,6 +168,10 @@ __all__ = [
     "RepositoryModel",
     "RestApiRepository",
     "SqlAlchemyRepository",
+    "CacheRefreshRepository",
+    "DatabaseRefreshRepository",
+    "FileRefreshRepository",
+    "MemoryRefreshRepository",
     "AuthenticationService",
     "UserLifecycleManagement",
     "is_attrs",

alpha/encoder.py

@@ -4,6 +4,7 @@ complex types into JSON format.
 
 import json
 from dataclasses import asdict, is_dataclass
+from attrs import asdict as attrs_asdict
 from datetime import date, datetime, time
 from enum import Enum
 from json import encoder
@@ -14,8 +15,9 @@ import numpy as np  # type: ignore[import-untyped]
 import pandas as pd  # type: ignore[import-untyped]
 import six  # type: ignore[import-untyped]
 
-
 from alpha.interfaces.openapi_model import OpenAPIModel
+from alpha.utils.is_attrs import is_attrs
+from alpha.utils.is_pydantic import is_pydantic
 
 
 class JSONEncoder(encoder.JSONEncoder):
@@ -72,11 +74,15 @@ class JSONEncoder(encoder.JSONEncoder):
             return o.isoformat()
         if isinstance(o, time):
             return o.isoformat()
+        if isinstance(o, type):
+            cls = getattr(o, "__name__", None)
+            return cls if cls is not None else str(o)
         if is_dataclass(o):
-            if isinstance(o, type):
-                cls = getattr(o, "__class__")
-                return cls.__name__
-            return asdict(o)
+            return asdict(o)  # type: ignore
+        if is_attrs(o):
+            return attrs_asdict(o)
+        if is_pydantic(o):
+            return o.model_dump()
 
         try:
             return json.JSONEncoder.default(self, o)

alpha/factories/response_factory.py

@@ -3,12 +3,14 @@
 import json
 from dataclasses import MISSING, is_dataclass
 from enum import Enum
-from typing import Any, Iterable, get_args, get_origin
+from typing import Any, Sequence, get_args, get_origin
 
 from alpha import exceptions
 from alpha.encoder import JSONEncoder
+from alpha.interfaces.attrs_instance import AttrsInstance
 from alpha.interfaces.dataclass_instance import DataclassInstance
 from alpha.interfaces.openapi_model import OpenAPIModel
+from alpha.interfaces.pydantic_instance import PydanticInstance
 from alpha.utils.is_attrs import is_attrs
 from alpha.utils.is_pydantic import is_pydantic
 
@@ -18,8 +20,13 @@ class ResponseFactory:
 
     def process(
         self,
-        response: DataclassInstance | Iterable[DataclassInstance],
-        cls: OpenAPIModel | Iterable[OpenAPIModel],
+        response: DataclassInstance
+        | Sequence[DataclassInstance]
+        | AttrsInstance
+        | Sequence[AttrsInstance]
+        | PydanticInstance
+        | Sequence[PydanticInstance],
+        cls: OpenAPIModel | Sequence[OpenAPIModel],
     ) -> object:
         """Mapping a dataclass instance or a collection of instances to an
         OpenAPI model
@@ -54,7 +61,7 @@ class ResponseFactory:
 
         # When the source instance and target class are of an iterable type
         if cls_origin in [list, tuple, set]:
-            if isinstance(response, Iterable):
+            if isinstance(response, Sequence):
                 arg = get_args(cls)[0]
                 return [
                     self.process(response=obj, cls=arg) for obj in response

alpha/handlers/templates/python-flask/controller.mustache

@@ -12,6 +12,7 @@ from typing import List
 from alpha.factories.request_factory import RequestFactory
 from alpha.factories.response_factory import ResponseFactory
 from alpha.encoder import JSONEncoder
+from alpha.providers.models.identity import Identity
 from alpha.utils.logging_level_checker import logging_level_checker
 from alpha.utils.response_object import create_response_object
 from alpha.utils.request_headers import Headers
@@ -227,7 +228,8 @@ def {{operationId}}(
         token_factory.validate(auth_token)
 
         # Get auth token payload and verify identity
-        identity = token_factory.get_payload(auth_token)
+        payload = token_factory.get_payload(auth_token)
+        identity = Identity.from_dict(payload)
         verify_identity(identity,
             roles=roles,
             groups=groups,
@@ -307,8 +309,9 @@ def {{operationId}}(
             status_code={{code}},
             status_message='{{message}}',
             data=result,
-            {{#vendorExtensions.x-content-type}}data_type='{{vendorExtensions.x-content-type}}'{{/vendorExtensions.x-content-type}}
-            {{#vendorExtensions.x-alpha-cookie-support}}response_type='flask'{{/vendorExtensions.x-alpha-cookie-support}}
+            accept_header={{#vendorExtensions.x-content-type}}'{{vendorExtensions.x-content-type}}'{{/vendorExtensions.x-content-type}}{{^vendorExtensions.x-content-type}}connexion.request.headers.get("Accept", None){{/vendorExtensions.x-content-type}},
+            supported_accept_headers=[{{#produces}}'{{mediaType}}',{{/produces}}{{^produces}}{{#vendorExtensions.x-preferred-produce}}'{{mediaType}}',{{/vendorExtensions.x-preferred-produce}}{{/produces}}],
+            {{#vendorExtensions.x-alpha-cookie-support}}response_format='flask'{{/vendorExtensions.x-alpha-cookie-support}}
         )
         {{/returnType}}
         {{^returnType}}
@@ -316,19 +319,20 @@ def {{operationId}}(
             http_codes=http_codes,
             status_code=204,
             status_message='{{message}}',
-            {{#vendorExtensions.x-alpha-cookie-support}}data=result, response_type='flask'{{/vendorExtensions.x-alpha-cookie-support}}
+            {{#vendorExtensions.x-alpha-cookie-support}}data=result, response_format='flask'{{/vendorExtensions.x-alpha-cookie-support}}
         )
         {{/returnType}}
         {{/vendorExtensions.x-alpha-raw-response}}
     {{/is2xx}}
-    
     {{#is4xx}}
         {{#vendorExtensions.x-alpha-exception}}
     except {{vendorExtensions.x-alpha-exception}} as exc:
         return response_object_function(
             http_codes=http_codes,
             status_code={{code}},
-            status_message=f'{exc}'
+            status_message=f'{exc}',
+            accept_header={{#vendorExtensions.x-content-type}}'{{vendorExtensions.x-content-type}}'{{/vendorExtensions.x-content-type}}{{^vendorExtensions.x-content-type}}connexion.request.headers.get("Accept", None){{/vendorExtensions.x-content-type}},
+            supported_accept_headers=[{{#produces}}'{{mediaType}}',{{/produces}}{{^produces}}{{#vendorExtensions.x-preferred-produce}}'{{mediaType}}',{{/vendorExtensions.x-preferred-produce}}{{/produces}}],
         )
         {{/vendorExtensions.x-alpha-exception}}
     {{/is4xx}}
@@ -339,6 +343,8 @@ def {{operationId}}(
             http_codes=http_codes,
             status_code={{code}},
             status_message=f'{exc}'
+            accept_header={{#vendorExtensions.x-content-type}}'{{vendorExtensions.x-content-type}}'{{/vendorExtensions.x-content-type}}{{^vendorExtensions.x-content-type}}connexion.request.headers.get("Accept", None){{/vendorExtensions.x-content-type}},
+            supported_accept_headers=[{{#produces}}'{{mediaType}}',{{/produces}}{{^produces}}{{#vendorExtensions.x-preferred-produce}}'{{mediaType}}',{{/vendorExtensions.x-preferred-produce}}{{/produces}}],
         )
         {{/vendorExtensions.x-alpha-exception}}
     {{/is5xx}}

alpha/infra/connectors/ldap_connector.py

@@ -31,6 +31,9 @@ class LDAPConnector:
         server_port: int = 636,
         use_tls: bool = True,
         client_strategy: ClientStrategyType = SYNC,
+        connect_timeout: float | None = 5.0,
+        additional_connector_params: dict[str, Any] | None = None,
+        additional_server_params: dict[str, Any] | None = None,
     ) -> None:
         """
         Parameters
@@ -59,12 +62,29 @@ class LDAPConnector:
             - 'MOCK_SYNC': Mock synchronous strategy.
             - 'MOCK_ASYNC': Mock asynchronous strategy.
             - 'ASYNC_STREAM': Asynchronous stream strategy.
+        connect_timeout
+            Maximum number of seconds to wait while opening the socket.
+        additional_connector_params
+            Additional parameters to pass to the LDAP connection, by default
+            {"receive_timeout": 5}
+        additional_server_params
+            Additional parameters to pass to the LDAP server, by default None
         """
         self._server_url = server_url
         self._bind_dn = bind_dn
         self._bind_password = bind_password
         self._client_strategy = client_strategy
-
+        self._connect_timeout = connect_timeout
+        self._additional_connector_params: dict[str, Any] = (
+            {"receive_timeout": 5}
+            if additional_connector_params is None
+            else dict(additional_connector_params)
+        )
+        self._additional_server_params: dict[str, Any] = (
+            {}
+            if additional_server_params is None
+            else dict(additional_server_params)
+        )
         tls = None
         if use_tls:
             tls = Tls(
@@ -78,6 +98,8 @@ class LDAPConnector:
             use_ssl=use_tls,
             tls=tls,
             get_info=ALL,
+            connect_timeout=self._connect_timeout,
+            **self._additional_server_params,
         )
         self._connection: Connection | None = None
 
@@ -97,8 +119,9 @@ class LDAPConnector:
             self._server,
             user=self._bind_dn,
             password=self._bind_password,
-            auto_bind=True,
             client_strategy=self._client_strategy,  # type: ignore
+            auto_bind=True,
+            **self._additional_connector_params,
         )
 
     def disconnect(self) -> None:

alpha/interfaces/__init__.py

@@ -9,6 +9,7 @@ from alpha.interfaces.patchable import Patchable
 # import all repository related interfaces
 from alpha.interfaces.api_repository import ApiRepository
 from alpha.interfaces.sql_repository import SqlRepository
+from alpha.interfaces.refresh_repository import RefreshRepository
 
 # import all database related interfaces
 from alpha.interfaces.sql_mapper import SqlMapper
@@ -35,6 +36,7 @@ __all__ = [
     "Patchable",
     "ApiRepository",
     "SqlRepository",
+    "RefreshRepository",
     "SqlMapper",
     "SqlDatabase",
     "UnitOfWork",

alpha/interfaces/http_client.py

@@ -0,0 +1,26 @@
+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: ...

alpha/interfaces/providers.py

@@ -1,11 +1,15 @@
 """This module contains interfaces for various types of identity providers."""
 
-from typing import ClassVar, Protocol, runtime_checkable
+from typing import TYPE_CHECKING, ClassVar, Protocol, runtime_checkable, Any
 
 from alpha.interfaces.token_factory import TokenFactory
 from alpha.providers.models.credentials import PasswordCredentials
 from alpha.providers.models.identity import Identity
-from alpha.providers.models.token import Token
+
+if TYPE_CHECKING:
+    from alpha.providers.models.token import Token
+else:
+    Token = Any
 
 
 @runtime_checkable

alpha/interfaces/refresh_repository.py

@@ -0,0 +1,60 @@
+from typing import TYPE_CHECKING, Protocol, Any
+
+if TYPE_CHECKING:
+    from alpha.providers.models.token import Token
+else:
+    Token = Any
+
+
+class RefreshRepository(Protocol):
+    """Repository interface for managing refresh tokens."""
+
+    def get(self, token: str) -> Token:
+        """Get a token by its value.
+
+        Parameters
+        ----------
+        token
+            Token value.
+
+        Returns
+        -------
+        Token
+            Token object with the given token value.
+        """
+        ...
+
+    def create(self, subject: str) -> Token:
+        """Create a new token for a given subject.
+
+        Parameters
+        ----------
+        subject
+            Subject identifier
+
+        Returns
+        -------
+        Token
+            Newly created token object.
+        """
+        ...
+
+    def delete(self, token: str) -> None:
+        """Delete a token by its value.
+
+        Parameters
+        ----------
+        token
+            Token value.
+        """
+        ...
+
+    def delete_all(self, subject: str) -> None:
+        """Delete all tokens for a given subject.
+
+        Parameters
+        ----------
+        subject
+            Subject identifier.
+        """
+        ...

alpha/providers/models/token.py

@@ -1,9 +1,10 @@
 from uuid import UUID
-from datetime import datetime
+from datetime import datetime, timedelta, timezone
 from dataclasses import dataclass
 from typing import Any, Literal
 
 from alpha.domain.models.base_model import BaseDomainModel
+from alpha.utils.secret_generator import generate_secret
 
 
 @dataclass
@@ -79,6 +80,40 @@ class Token(BaseDomainModel):
             ),
         )
 
+    @classmethod
+    def create_refresh(
+        cls,
+        subject: str,
+        max_age_seconds: int = 7 * 24 * 3600,
+        token_length: int = 32,
+    ) -> "Token":
+        """Factory method to create a new Refresh Token instance.
+
+        Parameters
+        ----------
+        subject
+            The subject or user associated with the token.
+        max_age_seconds, optional
+            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
+            Optional length of the token value. Defaults to 32.
+
+        Returns
+        -------
+        Token
+            A new Refresh Token instance with the provided attributes and generated id and created_at.
+        """
+        return cls(
+            value=generate_secret(token_length),
+            token_type="Refresh",
+            subject=subject,
+            created_at=datetime.now(tz=timezone.utc),
+            expires_at=datetime.now(tz=timezone.utc)
+            + timedelta(seconds=max_age_seconds),
+        )
+
     def to_dict(self) -> dict[str, str | None]:
         """Converts the Token instance to a dictionary.
 
@@ -97,15 +132,18 @@ class Token(BaseDomainModel):
             - "expires_at": ISO format datetime string for when the token
             expires or None.
         """
-        return {
-            "id": str(self.id) if self.id else None,
+
+        obj: dict[str, str | None] = {
             "value": self.value,
             "subject": self.subject,
             "token_type": self.token_type,
-            "created_at": (
-                self.created_at.isoformat() if self.created_at else None
-            ),
-            "expires_at": (
-                self.expires_at.isoformat() if self.expires_at else None
-            ),
         }
+
+        if self.id:
+            obj["id"] = str(self.id)
+        if self.created_at:
+            obj["created_at"] = self.created_at.isoformat()
+        if self.expires_at:
+            obj["expires_at"] = self.expires_at.isoformat()
+
+        return obj

alpha/repositories/__init__.py

@@ -1,4 +1,16 @@
 from alpha.repositories.models.repository_model import RepositoryModel
+from alpha.repositories.refresh.cache_repository import (
+    CacheRefreshRepository,
+)
+from alpha.repositories.refresh.database_repository import (
+    DatabaseRefreshRepository,
+)
+from alpha.repositories.refresh.file_repository import (
+    FileRefreshRepository,
+)
+from alpha.repositories.refresh.memory_repository import (
+    MemoryRefreshRepository,
+)
 from alpha.repositories.rest_api_repository import RestApiRepository
 from alpha.repositories.sql_alchemy_repository import SqlAlchemyRepository
 
@@ -6,4 +18,8 @@ __all__ = [
     "RepositoryModel",
     "RestApiRepository",
     "SqlAlchemyRepository",
+    "CacheRefreshRepository",
+    "DatabaseRefreshRepository",
+    "FileRefreshRepository",
+    "MemoryRefreshRepository",
 ]

alpha/repositories/refresh/__init__.py

@@ -0,0 +1,19 @@
+from alpha.repositories.refresh.cache_repository import (
+    CacheRefreshRepository,
+)
+from alpha.repositories.refresh.database_repository import (
+    DatabaseRefreshRepository,
+)
+from alpha.repositories.refresh.file_repository import (
+    FileRefreshRepository,
+)
+from alpha.repositories.refresh.memory_repository import (
+    MemoryRefreshRepository,
+)
+
+__all__ = [
+    "CacheRefreshRepository",
+    "DatabaseRefreshRepository",
+    "FileRefreshRepository",
+    "MemoryRefreshRepository",
+]

alpha/repositories/refresh/cache_repository.py

@@ -0,0 +1,54 @@
+from typing import Any
+
+from alpha.providers.models.token import Token
+
+
+class CacheRefreshRepository:
+    def __init__(
+        self,
+        cache_connector: Any,
+        token_model: type[Token] = Token,
+        token_max_age_seconds: int = 7 * 24 * 3600,
+        token_length: int = 32,
+    ):
+        """Initialize the CacheRefreshRepository with the given cache connector.
+
+        Parameters
+        ----------
+        cache_connector
+            The cache connector instance to use for cache operations.
+        token_model, optional
+            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
+            structure as the token data in the JSON file. The model class
+            should also have a `to_dict` method that converts an instance of
+            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
+            The maximum age of a token in seconds, by default the equivalent of
+            7 days in seconds
+        token_length, optional
+            The length of the generated token string, by default 32 characters
+        """
+        self._cache_connector = cache_connector
+        self._token_model = token_model
+        self._token_max_age_seconds = token_max_age_seconds
+        self._token_length = token_length
+
+    def get(self, token: str) -> Token:
+        """Get a token by its value."""
+        raise NotImplementedError("Method not implemented yet.")
+
+    def create(self, subject: str) -> Token:
+        """Create a new token for a given subject."""
+        raise NotImplementedError("Method not implemented yet.")
+
+    def delete(self, token: str) -> None:
+        """Delete a token by its value."""
+        raise NotImplementedError("Method not implemented yet.")
+
+    def delete_all(self, subject: str) -> None:
+        """Delete all tokens for a given subject."""
+        raise NotImplementedError("Method not implemented yet.")

alpha/repositories/refresh/database_repository.py

@@ -0,0 +1,145 @@
+from alpha import exceptions
+from alpha.infra.connectors.sql_alchemy import SqlAlchemyDatabase
+from alpha.providers.models.token import Token
+
+
+class DatabaseRefreshRepository:
+    """Implementation of the RefreshRepository interface for database
+    operations.
+
+    This repository uses a SQLAlchemy database connector to manage refresh
+    tokens in a database. It provides methods to get, create, delete, and
+    delete all refresh tokens for a given subject. The tokens are stored in a
+    database table which is mapped to the token model.
+    """
+
+    def __init__(
+        self,
+        database_connector: SqlAlchemyDatabase,
+        token_model: type[Token] = Token,
+        token_max_age_seconds: int = 7 * 24 * 3600,
+        token_length: int = 32,
+    ):
+        """Initialize the DatabaseRefreshRepository with the given database
+        connector and token model.
+
+        Parameters
+        ----------
+        database_connector
+            The database connector instance to use for database operations.
+        token_model, optional
+            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
+            structure as the token data in the JSON file. The model class
+            should also have a `to_dict` method that converts an instance of
+            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
+            The maximum age of a token in seconds, by default the equivalent of
+            7 days in seconds
+        token_length, optional
+            The length of the generated token string, by default 32 characters
+        """
+        self._database_connector = database_connector
+        self._token_model = token_model
+        self._token_max_age_seconds = token_max_age_seconds
+        self._token_length = token_length
+
+    def get(self, token: str) -> Token:
+        """Get a token by its value.
+
+        Parameters
+        ----------
+        token
+            The value of the token to retrieve.
+
+        Returns
+        -------
+        Token
+            The token object corresponding to the given value.
+
+        Raises
+        ------
+        NotFoundException
+            If the token is not found in the database.
+        """
+        with self._database_connector.get_session() as session:
+            result = (
+                session.query(self._token_model)
+                .filter_by(value=token)
+                .one_or_none()
+            )
+
+            if result is None:
+                raise exceptions.NotFoundException("Refresh token not found")
+
+            return result
+
+    def create(self, subject: str) -> Token:
+        """Create a new token for a given subject.
+
+        Parameters
+        ----------
+        subject
+            The subject for which to create the token.
+
+        Returns
+        -------
+        Token
+            The newly created token object.
+        """
+        token = self._token_model.create_refresh(
+            subject=subject,
+            max_age_seconds=self._token_max_age_seconds,
+            token_length=self._token_length,
+        )
+
+        with self._database_connector.get_session() as session:
+            session.add(token)
+            session.commit()
+            session.refresh(token)
+            return token
+
+    def delete(self, token: str) -> None:
+        """Delete a token by its value.
+
+        Parameters
+        ----------
+        token
+            The value of the token to delete.
+
+        Raises
+        ------
+        NotFoundException
+            If the token is not found in the database.
+        """
+        with self._database_connector.get_session() as session:
+            token_obj = (
+                session.query(self._token_model)
+                .filter_by(value=token)
+                .one_or_none()
+            )
+            if token_obj is None:
+                raise exceptions.NotFoundException("Refresh token not found")
+            session.delete(token_obj)
+            session.commit()
+
+    def delete_all(self, subject: str) -> None:
+        """Delete all tokens for a given subject.
+
+        Parameters
+        ----------
+        subject
+            The subject for which to delete all tokens.
+        """
+        with self._database_connector.get_session() as session:
+            tokens = (
+                session.query(self._token_model)
+                .filter_by(subject=subject)
+                .all()
+            )
+            for token in tokens:
+                session.delete(token)
+            session.commit()