alpha-python 0.2.4__tar.gz → 0.2.5__tar.gz

{alpha_python-0.2.4 → alpha_python-0.2.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: alpha-python
-Version: 0.2.4
+Version: 0.2.5
 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>
 Requires-Python: >=3.11

{alpha_python-0.2.4 → alpha_python-0.2.5}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "alpha-python"
-version = "0.2.4"
+version = "0.2.5"
 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.2.5/src/alpha/__init__.py

@@ -0,0 +1,116 @@
+from alpha.adapters.sqla_unit_of_work import SqlAlchemyUnitOfWork
+from alpha.factories.jwt_factory import JWTFactory
+from alpha.factories.logging_handler_factory import LoggingHandlerFactory
+from alpha.factories.model_class_factory import ModelClassFactory
+from alpha.domain.models.user import User
+from alpha.domain.models.base_model import BaseDomainModel, DomainModel
+from alpha.domain.models.life_cycle_base import LifeCycleBase
+from alpha.infra.connectors.ldap_connector import LDAPConnector
+from alpha.infra.databases.sql_alchemy import SqlAlchemyDatabase
+from alpha.infra.models.filter_operators import And, Or
+from alpha.infra.models.json_patch import JsonPatch
+from alpha.infra.models.order_by import OrderBy, Order
+from alpha.infra.models.search_filter import SearchFilter, Operator
+from alpha.interfaces.attrs_instance import AttrsInstance
+from alpha.interfaces.dataclass_instance import DataclassInstance
+from alpha.interfaces.pydantic_instance import PydanticInstance
+from alpha.interfaces.openapi_model import OpenAPIModel
+from alpha.interfaces.updateable import Updateable
+from alpha.interfaces.patchable import Patchable
+from alpha.interfaces.sql_repository import SqlRepository
+from alpha.interfaces.sql_mapper import SqlMapper
+from alpha.interfaces.sql_database import SqlDatabase
+from alpha.interfaces.unit_of_work import UnitOfWork
+from alpha.interfaces.providers import (
+    IdentityProvider,
+    PasswordAuthenticator,
+    UserDirectory,
+    PasswordChanger,
+    TokenIssuer,
+    TokenValidator,
+)
+from alpha.interfaces.token_factory import TokenFactory
+from alpha.mixins.jwt_provider import JWTProviderMixin
+from alpha.providers.models.identity import (
+    Identity,
+    DEFAULT_LDAP_MAPPINGS,
+    DEFAULT_AD_MAPPINGS,
+    AD_SEARCH_ATTRIBUTES,
+)
+from alpha.providers.models.credentials import PasswordCredentials
+from alpha.providers.models.token import Token
+from alpha.providers.ldap_provider import LDAPProvider, ADProvider
+from alpha.repositories.models.repository_model import RepositoryModel
+from alpha.repositories.sql_alchemy_repository import SqlAlchemyRepository
+from alpha.services.authentication_service import AuthenticationService
+from alpha.utils.is_attrs import is_attrs
+from alpha.utils.is_pydantic import is_pydantic
+from alpha.utils.logging_configurator import (
+    LoggingConfigurator,
+    GunicornLogger,
+)
+from alpha.utils.logging_level_checker import logging_level_checker
+from alpha.utils.response_object import create_response_object
+from alpha.utils.verify_identity import verify_identity
+from alpha.utils.version_checker import minor_version_gte
+
+
+from alpha.encoder import JSONEncoder
+
+__all__ = [
+    "SqlAlchemyUnitOfWork",
+    "JWTFactory",
+    "LoggingHandlerFactory",
+    "ModelClassFactory",
+    "BaseDomainModel",
+    "DomainModel",
+    "LifeCycleBase",
+    "User",
+    "LDAPConnector",
+    "SqlAlchemyDatabase",
+    "And",
+    "Or",
+    "JsonPatch",
+    "OrderBy",
+    "Order",
+    "SearchFilter",
+    "Operator",
+    "AttrsInstance",
+    "DataclassInstance",
+    "PydanticInstance",
+    "OpenAPIModel",
+    "Updateable",
+    "Patchable",
+    "SqlRepository",
+    "SqlMapper",
+    "SqlDatabase",
+    "UnitOfWork",
+    "IdentityProvider",
+    "PasswordAuthenticator",
+    "TokenValidator",
+    "UserDirectory",
+    "PasswordChanger",
+    "TokenIssuer",
+    "TokenFactory",
+    "JWTProviderMixin",
+    "Identity",
+    "DEFAULT_LDAP_MAPPINGS",
+    "DEFAULT_AD_MAPPINGS",
+    "AD_SEARCH_ATTRIBUTES",
+    "PasswordCredentials",
+    "Token",
+    "LDAPProvider",
+    "ADProvider",
+    "RepositoryModel",
+    "SqlAlchemyRepository",
+    "AuthenticationService",
+    "is_attrs",
+    "is_pydantic",
+    "LoggingConfigurator",
+    "GunicornLogger",
+    "logging_level_checker",
+    "create_response_object",
+    "verify_identity",
+    "minor_version_gte",
+    "JSONEncoder",
+]

alpha_python-0.2.5/src/alpha/adapters/__init__.py

@@ -0,0 +1,5 @@
+from alpha.adapters.sqla_unit_of_work import SqlAlchemyUnitOfWork
+
+__all__ = [
+    "SqlAlchemyUnitOfWork",
+]

alpha_python-0.2.5/src/alpha/domain/__init__.py

@@ -0,0 +1,10 @@
+from alpha.domain.models.user import User
+from alpha.domain.models.base_model import BaseDomainModel, DomainModel
+from alpha.domain.models.life_cycle_base import LifeCycleBase
+
+__all__ = [
+    "BaseDomainModel",
+    "DomainModel",
+    "LifeCycleBase",
+    "User",
+]

alpha_python-0.2.5/src/alpha/domain/models/__init__.py

@@ -0,0 +1,10 @@
+from alpha.domain.models.user import User
+from alpha.domain.models.base_model import BaseDomainModel, DomainModel
+from alpha.domain.models.life_cycle_base import LifeCycleBase
+
+__all__ = [
+    "BaseDomainModel",
+    "DomainModel",
+    "LifeCycleBase",
+    "User",
+]

alpha_python-0.2.5/src/alpha/factories/__init__.py

@@ -0,0 +1,9 @@
+from alpha.factories.jwt_factory import JWTFactory
+from alpha.factories.logging_handler_factory import LoggingHandlerFactory
+from alpha.factories.model_class_factory import ModelClassFactory
+
+__all__ = [
+    "JWTFactory",
+    "LoggingHandlerFactory",
+    "ModelClassFactory",
+]

{alpha_python-0.2.4 → alpha_python-0.2.5}/src/alpha/factories/model_class_factory.py

@@ -33,7 +33,7 @@ from alpha.interfaces.factories import (
 )
 from alpha.interfaces.openapi_model import OpenAPIModel
 from alpha.interfaces.pydantic_instance import PydanticInstance
-from alpha.utils.version_check import minor_version_gte
+from alpha.utils.version_checker import minor_version_gte
 
 
 CLASS_FACTORIES: dict[str, ClassFactory] = {
@@ -173,4 +173,4 @@ class ModelClassFactory:
                     f"{field.type.__class__=}; "
                 ) from exc
             params[field.name] = value
-        return cls(**params)
+        return cls(**params)  # type: ignore

alpha_python-0.2.5/src/alpha/infra/__init__.py

@@ -0,0 +1,18 @@
+from alpha.infra.connectors.ldap_connector import LDAPConnector
+from alpha.infra.databases.sql_alchemy import SqlAlchemyDatabase
+from alpha.infra.models.filter_operators import And, Or
+from alpha.infra.models.json_patch import JsonPatch
+from alpha.infra.models.order_by import OrderBy, Order
+from alpha.infra.models.search_filter import SearchFilter, Operator
+
+__all__ = [
+    "LDAPConnector",
+    "SqlAlchemyDatabase",
+    "And",
+    "Or",
+    "JsonPatch",
+    "OrderBy",
+    "Order",
+    "SearchFilter",
+    "Operator",
+]

alpha_python-0.2.5/src/alpha/infra/connectors/__init__.py

@@ -0,0 +1,5 @@
+from alpha.infra.connectors.ldap_connector import LDAPConnector
+
+__all__ = [
+    "LDAPConnector",
+]

alpha_python-0.2.5/src/alpha/infra/databases/__init__.py

@@ -0,0 +1,5 @@
+from alpha.infra.databases.sql_alchemy import SqlAlchemyDatabase
+
+__all__ = [
+    "SqlAlchemyDatabase",
+]

alpha_python-0.2.5/src/alpha/infra/models/__init__.py

@@ -0,0 +1,14 @@
+from alpha.infra.models.filter_operators import And, Or
+from alpha.infra.models.json_patch import JsonPatch
+from alpha.infra.models.order_by import OrderBy, Order
+from alpha.infra.models.search_filter import SearchFilter, Operator
+
+__all__ = [
+    "And",
+    "Or",
+    "JsonPatch",
+    "OrderBy",
+    "Order",
+    "SearchFilter",
+    "Operator",
+]

{alpha_python-0.2.4 → alpha_python-0.2.5}/src/alpha/infra/models/query_clause.py

@@ -37,9 +37,7 @@ class QueryClause:
 
     def _raise_instrumented_attr_exception(self):
         raise exceptions.InstrumentedAttributeMissing(
-            """
-            The 'field' attribute needs to be of an \
-sqlalchemy.orm.InstrumentedAttribute type, or specify the mapped domain model \
-by adding the _domain_model attribute
-            """
+            "The \'field\' attribute needs to be of an "
+            "sqlalchemy.orm.InstrumentedAttribute type, or specify the mapped "
+            "domain model by adding the _domain_model attribute"
         )

alpha_python-0.2.5/src/alpha/interfaces/__init__.py

@@ -0,0 +1,44 @@
+# import dataclass and equivalent or related interfaces
+from alpha.interfaces.attrs_instance import AttrsInstance
+from alpha.interfaces.dataclass_instance import DataclassInstance
+from alpha.interfaces.pydantic_instance import PydanticInstance
+from alpha.interfaces.openapi_model import OpenAPIModel
+from alpha.interfaces.updateable import Updateable
+from alpha.interfaces.patchable import Patchable
+
+# import all database related interfaces
+from alpha.interfaces.sql_repository import SqlRepository
+from alpha.interfaces.sql_mapper import SqlMapper
+from alpha.interfaces.sql_database import SqlDatabase
+from alpha.interfaces.unit_of_work import UnitOfWork
+
+# import all authentication and authorization related interfaces
+from alpha.interfaces.providers import (
+    IdentityProvider,
+    PasswordAuthenticator,
+    UserDirectory,
+    PasswordChanger,
+    TokenIssuer,
+    TokenValidator,
+)
+from alpha.interfaces.token_factory import TokenFactory
+
+__all__ = [
+    "AttrsInstance",
+    "DataclassInstance",
+    "PydanticInstance",
+    "OpenAPIModel",
+    "Updateable",
+    "Patchable",
+    "SqlRepository",
+    "SqlMapper",
+    "SqlDatabase",
+    "UnitOfWork",
+    "IdentityProvider",
+    "PasswordAuthenticator",
+    "TokenValidator",
+    "UserDirectory",
+    "PasswordChanger",
+    "TokenIssuer",
+    "TokenFactory",
+]

alpha_python-0.2.5/src/alpha/mixins/__init__.py

@@ -0,0 +1,3 @@
+from alpha.mixins.jwt_provider import JWTProviderMixin
+
+__all__ = ["JWTProviderMixin"]

alpha_python-0.2.5/src/alpha/providers/__init__.py

@@ -0,0 +1,23 @@
+# Models
+from alpha.providers.models.identity import (
+    Identity,
+    DEFAULT_LDAP_MAPPINGS,
+    DEFAULT_AD_MAPPINGS,
+    AD_SEARCH_ATTRIBUTES,
+)
+from alpha.providers.models.credentials import PasswordCredentials
+from alpha.providers.models.token import Token
+
+# Providers
+from alpha.providers.ldap_provider import LDAPProvider, ADProvider
+
+__all__ = [
+    "Identity",
+    "DEFAULT_LDAP_MAPPINGS",
+    "DEFAULT_AD_MAPPINGS",
+    "AD_SEARCH_ATTRIBUTES",
+    "PasswordCredentials",
+    "Token",
+    "LDAPProvider",
+    "ADProvider",
+]

{alpha_python-0.2.4 → alpha_python-0.2.5}/src/alpha/providers/ldap_provider.py

@@ -10,14 +10,47 @@ from alpha.infra.connectors.ldap_connector import LDAPConnector
 from alpha.interfaces.token_factory import TokenFactory
 from alpha.mixins.jwt_provider import JWTProviderMixin
 from alpha.providers.models.credentials import PasswordCredentials
-from alpha.providers.models.identity import DEFAULT_LDAP_MAPPINGS, Identity
+from alpha.providers.models.identity import (
+    DEFAULT_LDAP_MAPPINGS,
+    DEFAULT_AD_MAPPINGS,
+    AD_SEARCH_ATTRIBUTES,
+    Identity,
+)
 from alpha import exceptions
 
 
 class LDAPProvider(JWTProviderMixin):
-    """LDAP Identity Provider"""
+    """LDAP Identity Provider
+
+    Parameters
+    ----------
+    connector
+        Connector to use for LDAP operations
+    search_filter_key, optional
+        Key to use for LDAP search filter, by default "uid"
+    search_base, optional
+        Base DN for LDAP search, by default "cn=users,dc=example,dc=com"
+    search_attributes, optional
+        Attributes to retrieve during LDAP search, by default
+        [ALL_ATTRIBUTES]
+    identity_mappings, optional
+        Mappings from LDAP attributes to Identity fields, by default
+        DEFAULT_LDAP_MAPPINGS
+    populate_groups, optional
+        Whether to populate groups in the Identity, by default True
+    populate_permissions, optional
+        Whether to populate permissions in the Identity, by default False
+    populate_claims, optional
+        Whether to populate claims in the Identity, by default True
+    auto_connect, optional
+        Whether to automatically connect using the connector, by default
+        True
+    change_password_supported, optional
+        Whether the provider supports changing passwords, by default False
+    """
 
     protocol = "ldap"
+    _token_factory: TokenFactory | None = None
 
     def __init__(
         self,
@@ -33,34 +66,7 @@ class LDAPProvider(JWTProviderMixin):
         auto_connect: bool = True,
         change_password_supported: bool = False,
     ) -> None:
-        """_summary_
-
-        Parameters
-        ----------
-        connector
-            Connector to use for LDAP operations
-        search_filter_key, optional
-            Key to use for LDAP search filter, by default "uid"
-        search_base, optional
-            Base DN for LDAP search, by default "cn=users,dc=example,dc=com"
-        search_attributes, optional
-            Attributes to retrieve during LDAP search, by default
-            [ALL_ATTRIBUTES]
-        identity_mappings, optional
-            Mappings from LDAP attributes to Identity fields, by default
-            DEFAULT_LDAP_MAPPINGS
-        populate_groups, optional
-            Whether to populate groups in the Identity, by default True
-        populate_permissions, optional
-            Whether to populate permissions in the Identity, by default False
-        populate_claims, optional
-            Whether to populate claims in the Identity, by default True
-        auto_connect, optional
-            Whether to automatically connect using the connector, by default
-            True
-        change_password_supported, optional
-            Whether the provider supports changing passwords, by default False
-        """
+        """Initialize LDAPProvider"""
         self._connector = connector
         self._token_factory = token_factory
         self._search_filter_key = search_filter_key
@@ -252,3 +258,73 @@ class LDAPProvider(JWTProviderMixin):
             populate_permissions=self._populate_permissions,
         )
         return identity
+
+
+class ADProvider(LDAPProvider):
+    """Active Directory Identity Provider
+
+    Inherits from LDAPProvider with default settings for Active Directory.
+
+    Parameters
+    ----------
+    connector
+        Connector to use for LDAP operations.
+    token_factory, optional
+        Factory used to create tokens, by default ``None``.
+    search_filter_key, optional
+        Key to use for Active Directory search filter, by default
+        ``"sAMAccountName"``.
+    search_base, optional
+        Base distinguished name (DN) for Active Directory searches, by default
+        ``"CN=users,DC=example,DC=com"``.
+    search_attributes, optional
+        Attributes to retrieve during Active Directory searches, by default
+        ``AD_SEARCH_ATTRIBUTES``.
+    identity_mappings, optional
+        Mapping of Active Directory attributes to :class:`Identity` fields, by
+        default ``DEFAULT_AD_MAPPINGS``.
+    populate_groups, optional
+        Whether to populate group memberships on the :class:`Identity`, by
+        default ``True``.
+    populate_permissions, optional
+        Whether to populate permissions on the :class:`Identity`, by default
+        ``False``.
+    populate_claims, optional
+        Whether to populate claims on the :class:`Identity`, by default
+        ``True``.
+    auto_connect, optional
+        Whether to automatically open the LDAP connection on first use, by
+        default ``True``.
+    change_password_supported, optional
+        Whether this provider supports changing passwords, by default
+        ``False``.
+    """
+
+    def __init__(
+        self,
+        connector: LDAPConnector,
+        token_factory: TokenFactory | None = None,
+        search_filter_key: str = "sAMAccountName",
+        search_base: str = "CN=users,DC=example,DC=com",
+        search_attributes: list[str] = AD_SEARCH_ATTRIBUTES,
+        identity_mappings: dict[str, str] = DEFAULT_AD_MAPPINGS,
+        populate_groups: bool = True,
+        populate_permissions: bool = False,
+        populate_claims: bool = True,
+        auto_connect: bool = True,
+        change_password_supported: bool = False,
+    ) -> None:
+        """Initialize ADProvider"""
+        super().__init__(
+            connector=connector,
+            token_factory=token_factory,
+            search_filter_key=search_filter_key,
+            search_base=search_base,
+            search_attributes=search_attributes,
+            identity_mappings=identity_mappings,
+            populate_groups=populate_groups,
+            populate_permissions=populate_permissions,
+            populate_claims=populate_claims,
+            auto_connect=auto_connect,
+            change_password_supported=change_password_supported,
+        )

alpha_python-0.2.5/src/alpha/providers/models/__init__.py

@@ -0,0 +1,17 @@
+from alpha.providers.models.identity import (
+    Identity,
+    DEFAULT_LDAP_MAPPINGS,
+    DEFAULT_AD_MAPPINGS,
+    AD_SEARCH_ATTRIBUTES,
+)
+from alpha.providers.models.credentials import PasswordCredentials
+from alpha.providers.models.token import Token
+
+__all__ = [
+    "Identity",
+    "DEFAULT_LDAP_MAPPINGS",
+    "DEFAULT_AD_MAPPINGS",
+    "AD_SEARCH_ATTRIBUTES",
+    "PasswordCredentials",
+    "Token",
+]

{alpha_python-0.2.4 → alpha_python-0.2.5}/src/alpha/providers/models/identity.py

@@ -26,6 +26,46 @@ DEFAULT_AD_MAPPINGS = {
     "permissions": "permissions",
 }
 
+AD_SEARCH_ATTRIBUTES = [
+    'cn',
+    'generationQualifier',
+    'name',
+    'postalAddress',
+    'lastLogonTimestamp',
+    'mobile',
+    'postalCode',
+    'countryCode',
+    'company',
+    'displayName',
+    'o',
+    'st',
+    'ou',
+    'givenName',
+    'msExchUserCulture',
+    'l',
+    'initials',
+    'msTSLicenseVersion',
+    'memberOf',
+    'whenChanged',
+    'mailNickname',
+    'sn',
+    'street',
+    'accountExpires',
+    'uSNChanged',
+    'distinguishedName',
+    'whenCreated',
+    'sAMAccountName',
+    'c',
+    'employeeID',
+    'streetAddress',
+    'description',
+    'mail',
+    'title',
+    'department',
+    'co',
+    'personalTitle',
+]
+
 
 @dataclass
 class Identity:
@@ -199,8 +239,10 @@ class Identity:
             User object to update from.
         """
         self.username = user.username
-        self.email = user.email
-        self.display_name = user.display_name
+        if not self.email:
+            self.email = user.email
+        if not self.display_name:
+            self.display_name = user.display_name
         for permission in user.permissions or []:
             if permission not in self.permissions:
                 self.permissions.append(permission)  # type: ignore

alpha_python-0.2.5/src/alpha/repositories/__init__.py

@@ -0,0 +1,7 @@
+from alpha.repositories.models.repository_model import RepositoryModel
+from alpha.repositories.sql_alchemy_repository import SqlAlchemyRepository
+
+__all__ = [
+    "RepositoryModel",
+    "SqlAlchemyRepository",
+]

alpha_python-0.2.5/src/alpha/repositories/models/__init__.py

@@ -0,0 +1,5 @@
+from alpha.repositories.models.repository_model import RepositoryModel
+
+__all__ = [
+    "RepositoryModel",
+]

alpha_python-0.2.5/src/alpha/services/__init__.py

@@ -0,0 +1,5 @@
+from alpha.services.authentication_service import AuthenticationService
+
+__all__ = [
+    "AuthenticationService",
+]

{alpha_python-0.2.4 → alpha_python-0.2.5}/src/alpha/services/authentication_service.py

@@ -11,37 +11,40 @@ from alpha import exceptions
 
 
 class AuthenticationService:
-    """Service for handling authentication operations."""
+    """This class is responsible for handling authentication operations in an
+    application. It provides methods for user authentication, token, issuance,
+    token validation, password change, pretending to login as another user,
+    and merging user data with identity data.
+
+    Parameters
+    ----------
+    identity_provider
+        Identity provider to use for authentication.
+    identity_id_attribute, optional
+        Attribute name in the identity to use as the unique identifier, by
+        default "subject"
+    merge_with_database_users, optional
+        Whether to merge identity data with database user data, by default
+        False
+    user_id_attribute, optional
+        Attribute name in the user database to use as the unique
+        identifier, by default "username"
+    uow, optional
+        UnitOfWork instance for database operations, by default None
+    repository_name, optional
+        Name of the user repository in the UnitOfWork, by default "users"
+    """
 
     def __init__(
         self,
         identity_provider: IdentityProvider,
         identity_id_attribute: str = "subject",
         merge_with_database_users: bool = False,
-        user_id_attribute: str = "id",
+        user_id_attribute: str = "username",
         uow: UnitOfWork | None = None,
         repository_name: str = "users",
     ) -> None:
-        """Initialize the AuthenticationService.
-
-        Parameters
-        ----------
-        identity_provider
-            Identity provider to use for authentication.
-        identity_id_attribute, optional
-            Attribute name in the identity to use as the unique identifier, by
-            default "subject"
-        merge_with_database_users, optional
-            Whether to merge identity data with database user data, by default
-            False
-        user_id_attribute, optional
-            Attribute name in the user database to use as the unique
-            identifier, by default "id"
-        uow, optional
-            UnitOfWork instance for database operations, by default None
-        repository_name, optional
-            Name of the user repository in the UnitOfWork, by default "users"
-        """
+        """Initialize the AuthenticationService."""
         self._identity_provider = identity_provider
         self._identity_id_attribute = identity_id_attribute
         self._merge_with_database_users = merge_with_database_users
@@ -163,7 +166,7 @@ class AuthenticationService:
         self,
         identity: Identity,
     ) -> Identity:
-        """Merge User data into a Identity instance.
+        """Merge User data into an Identity instance.
 
         Parameters
         ----------
@@ -184,11 +187,13 @@ class AuthenticationService:
                 self.uow, self._repository_name
             )
             user = users.get_by_id(
-                identity.subject, id_attribute=self._user_id_attribute
+                value=identity.subject, attr=self._user_id_attribute
             )
-            if not user:
+            if user:
+                identity.update_from_user(user)
+            else:
+                # Create new user from identity if not found in database
                 user = User.from_identity(identity)
                 users.add(user)
-            identity.update_from_user(user)
-            self.uow.commit()
+                self.uow.commit()
         return identity