fastapi-factory-utilities 0.3.4__tar.gz → 0.3.5__tar.gz

{fastapi_factory_utilities-0.3.4 → fastapi_factory_utilities-0.3.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: fastapi_factory_utilities
-Version: 0.3.4
+Version: 0.3.5
 Summary: Consolidate libraries and utilities to create microservices in Python with FastAPI, Beanie, Httpx, AioPika and OpenTelemetry.
 License: MIT
 Keywords: python,fastapi,beanie,httpx,opentelemetry,microservices

{fastapi_factory_utilities-0.3.4 → fastapi_factory_utilities-0.3.5}/pyproject.toml

@@ -3,7 +3,7 @@ name = "fastapi_factory_utilities"
 homepage = "https://github.com/miragecentury/fastapi_factory_utilities"
 repository = "https://github.com/miragecentury/fastapi_factory_utilities"
 keywords = ["python", "fastapi", "beanie", "httpx", "opentelemetry", "microservices"]
-version = "0.3.4"
+version = "0.3.5"
 description = "Consolidate libraries and utilities to create microservices in Python with FastAPI, Beanie, Httpx, AioPika and OpenTelemetry."
 authors = ["miragecentury <victorien.vanroye@gmail.com>"]
 maintainers = ["miragecentury <victorien.vanroye@gmail.com>"]

{fastapi_factory_utilities-0.3.4 → fastapi_factory_utilities-0.3.5}/src/fastapi_factory_utilities/core/exceptions.py

@@ -1,7 +1,8 @@
 """FastAPI Factory Utilities exceptions."""
 
 import logging
-from typing import Any, Sequence
+from collections.abc import Sequence
+from typing import Any
 
 from opentelemetry.trace import Span, get_current_span
 from opentelemetry.util.types import AttributeValue

{fastapi_factory_utilities-0.3.4 → fastapi_factory_utilities-0.3.5}/src/fastapi_factory_utilities/core/plugins/odm_plugin/repositories.py

@@ -2,24 +2,12 @@
 
 import datetime
 from abc import ABC
-from collections.abc import AsyncGenerator, Callable
+from collections.abc import AsyncGenerator, Callable, Mapping
 from contextlib import asynccontextmanager
-from typing import (
-    Any,
-    Dict,
-    Generic,
-    List,
-    Mapping,
-    Optional,
-    Tuple,
-    TypeVar,
-    Union,
-    get_args,
-)
+from typing import Any, Generic, TypeVar, get_args
 from uuid import UUID
 
 from beanie import SortDirection
-from beanie.odm.queries.find import FindMany
 from motor.motor_asyncio import AsyncIOMotorClientSession, AsyncIOMotorDatabase
 from pydantic import BaseModel
 from pymongo.errors import DuplicateKeyError, PyMongoError
@@ -229,19 +217,19 @@ class AbstractRepository(ABC, Generic[DocumentGenericType, EntityGenericType]):
         raise OperationError("Failed to delete document.")
 
     @managed_session()
-    async def find(
+    async def find(  # noqa: PLR0913
         self,
-        *args: Union[Mapping[str, Any], bool],
+        *args: Mapping[str, Any] | bool,
         projection_model: None = None,
-        skip: Optional[int] = None,
-        limit: Optional[int] = None,
-        sort: Union[None, str, List[Tuple[str, SortDirection]]] = None,
-        session: Optional[AsyncIOMotorClientSession] = None,
+        skip: int | None = None,
+        limit: int | None = None,
+        sort: None | str | list[tuple[str, SortDirection]] = None,
+        session: AsyncIOMotorClientSession | None = None,
         ignore_cache: bool = False,
         fetch_links: bool = False,
         lazy_parse: bool = False,
-        nesting_depth: Optional[int] = None,
-        nesting_depths_per_field: Optional[Dict[str, int]] = None,
+        nesting_depth: int | None = None,
+        nesting_depths_per_field: dict[str, int] | None = None,
         **pymongo_kwargs: Any,
     ) -> list[EntityGenericType]:
         """Find documents in the database.

fastapi_factory_utilities-0.3.5/src/fastapi_factory_utilities/core/security/kratos.py

@@ -0,0 +1,98 @@
+"""Provide Kratos Session and Identity classes."""
+
+from enum import StrEnum
+from typing import Annotated
+
+from fastapi import Depends, HTTPException, Request
+
+from fastapi_factory_utilities.core.services.kratos import (
+    KratosOperationError,
+    KratosService,
+    KratosSessionInvalidError,
+    KratosSessionObject,
+    depends_kratos_service,
+)
+
+
+class KratosSessionAuthenticationErrors(StrEnum):
+    """Kratos Session Authentication Errors."""
+
+    MISSING_CREDENTIALS = "Missing Credentials"
+    INVALID_CREDENTIALS = "Invalid Credentials"
+    INTERNAL_SERVER_ERROR = "Internal Server Error"
+
+
+class KratosSessionAuthentication:
+    """Kratos Session class."""
+
+    DEFAULT_COOKIE_NAME: str = "ory_kratos_session"
+
+    def __init__(self, cookie_name: str = DEFAULT_COOKIE_NAME, raise_exception: bool = True) -> None:
+        """Initialize the KratosSessionAuthentication class.
+
+        Args:
+            cookie_name (str): Name of the cookie to extract the session
+            raise_exception (bool): Whether to raise an exception or return None
+        """
+        self._cookie_name: str = cookie_name
+        self._raise_exception: bool = raise_exception
+
+    def _extract_cookie(self, request: Request) -> str | None:
+        """Extract the cookie from the request.
+
+        Args:
+            request (Request): FastAPI request object.
+
+        Returns:
+            str | None: Cookie value or None if not found.
+
+        Raises:
+            HTTPException: If the cookie is missing.
+        """
+        return request.cookies.get(self._cookie_name, None)
+
+    async def __call__(
+        self, request: Request, kratos_service: Annotated[KratosService, Depends(depends_kratos_service)]
+    ) -> KratosSessionObject | KratosSessionAuthenticationErrors:
+        """Extract the Kratos session from the request.
+
+        Args:
+            request (Request): FastAPI request object.
+            kratos_service (KratosService): Kratos service object.
+
+        Returns:
+            KratosSessionObject | KratosSessionAuthenticationErrors: Kratos session object or error.
+
+        Raises:
+            HTTPException: If the session is invalid and raise_exception is True.
+        """
+        cookie: str | None = self._extract_cookie(request)
+        if not cookie:
+            if self._raise_exception:
+                raise HTTPException(
+                    status_code=401,
+                    detail=KratosSessionAuthenticationErrors.MISSING_CREDENTIALS,
+                )
+            else:
+                return KratosSessionAuthenticationErrors.MISSING_CREDENTIALS
+
+        try:
+            session: KratosSessionObject = await kratos_service.whoami(cookie_value=cookie)
+        except KratosSessionInvalidError as e:
+            if self._raise_exception:
+                raise HTTPException(
+                    status_code=401,
+                    detail="Invalid Credentials",
+                ) from e
+            else:
+                return KratosSessionAuthenticationErrors.INVALID_CREDENTIALS
+        except KratosOperationError as e:
+            if self._raise_exception:
+                raise HTTPException(
+                    status_code=500,
+                    detail="Internal Server Error",
+                ) from e
+            else:
+                return KratosSessionAuthenticationErrors.INTERNAL_SERVER_ERROR
+
+        return session

fastapi_factory_utilities-0.3.4/src/fastapi_factory_utilities/core/security/kratos.py

@@ -1,78 +0,0 @@
-"""Provide Kratos Session and Identity classes."""
-
-from typing import Annotated
-
-from fastapi import Depends, HTTPException, Request
-
-from fastapi_factory_utilities.core.services.kratos import (
-    KratosOperationError,
-    KratosService,
-    KratosSessionInvalidError,
-    KratosSessionObject,
-    depends_kratos_service,
-)
-
-
-class KratosSessionAuthentication:
-    """Kratos Session class."""
-
-    DEFAULT_COOKIE_NAME: str = "ory_kratos_session"
-
-    def __init__(self, cookie_name: str = DEFAULT_COOKIE_NAME) -> None:
-        """Initialize the KratosSessionAuthentication class.
-
-        Args:
-            cookie_name (str): Name of the cookie to extract the session
-        """
-        self._cookie_name: str = cookie_name
-
-    def _extract_cookie(self, request: Request) -> str:
-        """Extract the cookie from the request.
-
-        Args:
-            request (Request): FastAPI request object.
-
-        Returns:
-            str | None: Cookie value or None if not found.
-
-        Raises:
-            HTTPException: If the cookie is missing.
-        """
-        cookie: str | None = request.cookies.get(self._cookie_name)
-        if not cookie:
-            raise HTTPException(
-                status_code=401,
-                detail="Missing Credentials",
-            )
-        return cookie
-
-    async def __call__(
-        self, request: Request, kratos_service: Annotated[KratosService, Depends(depends_kratos_service)]
-    ) -> KratosSessionObject:
-        """Extract the Kratos session from the request.
-
-        Args:
-            request (Request): FastAPI request object.
-            kratos_service (KratosService): Kratos service object.
-
-        Returns:
-            KratosSessionObject: Kratos session object.
-
-        Raises:
-            HTTPException: If the session is invalid.
-        """
-        cookie: str = self._extract_cookie(request)
-        try:
-            session: KratosSessionObject = await kratos_service.whoami(cookie_value=cookie)
-        except KratosSessionInvalidError as e:
-            raise HTTPException(
-                status_code=401,
-                detail="Invalid Credentials",
-            ) from e
-        except KratosOperationError as e:
-            raise HTTPException(
-                status_code=500,
-                detail="Internal Server Error",
-            ) from e
-
-        return session