maleo-foundation 0.3.55__py3-none-any.whl → 0.3.57__py3-none-any.whl

maleo_foundation/enums.py

@@ -67,19 +67,69 @@ class BaseEnums:
         REFRESH = "refresh"
         ACCESS = "access"
 
-    class StatusUpdateType(StrEnum):
-        ACTIVATE = "activate"
-        DEACTIVATE = "deactivate"
-        RESTORE = "restore"
-        DELETE = "delete"
+    class ExceptionType(StrEnum):
+        TIMEOUT = "timeout"
+        UNAUTHORIZED = "unauthorized"
+        FORBIDDEN = "forbidden"
+        NOT_FOUND = "not_found"
+        VALIDATION = "validation"
+        INTERNAL = "internal"
+        UNAVAILABLE = "unavailable"
+
+    class OperationOrigin(StrEnum):
+        SERVICE = "service"
+        CLIENT = "client"
 
-    class UpdateType(StrEnum):
-        STATUS = "status"
-        DATA = "data"
+    class ServiceOperationLayer(StrEnum):
+        ROUTER = "router"
+        CONTROLLER = "controller"
+        SERVICE = "service"
+        REPOSITORY = "repository"
+
+    class ClientOperationLayer(StrEnum):
+        CONTROLLER = "controller"
+        SERVICE = "service"
+
+    class OperationLayer(StrEnum):
+        ROUTER = "router"
+        CONTROLLER = "controller"
+        SERVICE = "service"
+        REPOSITORY = "repository"
+
+    class ServiceOperationTarget(StrEnum):
+        CACHE = "cache"
+        DATABASE = "database"
+        MICROSERVICE = "microservice"
+        THIRD_PARTY = "third_party"
+
+    class ClientOperationTarget(StrEnum):
+        CACHE = "cache"
+        CONTROLLER = "controller"
+
+    class OperationTarget(StrEnum):
+        CACHE = "cache"
+        CONTROLLER = "controller"
+        DATABASE = "database"
+        MICROSERVICE = "microservice"
+        THIRD_PARTY = "third_party"
 
     class OperationType(StrEnum):
         CREATE = "create"
+        READ = "read"
         UPDATE = "update"
+        DELETE = "delete"
+
+    class CreateType(StrEnum):
+        CREATE = "create"
+        RESTORE = "restore"
+
+    class UpdateType(StrEnum):
+        DATA = "data"
+        STATUS = "status"
+
+    class StatusUpdateType(StrEnum):
+        ACTIVATE = "activate"
+        DEACTIVATE = "deactivate"
         RESTORE = "restore"
         DELETE = "delete"
 
@@ -167,13 +217,3 @@ class BaseEnums:
         EXP_1WK = int(1 * 7 * 24 * 60 * 60)
         EXP_2WK = int(2 * 7 * 24 * 60 * 60)
         EXP_1MO = int(1 * 30 * 24 * 60 * 60)
-
-    class ServiceDataSource(StrEnum):
-        CACHE = "cache"
-        DATABASE = "database"
-        MICROSERVICE = "microservice"
-        THIRD_PARTY = "third_party"
-
-    class ClientDataSource(StrEnum):
-        CACHE = "cache"
-        REQUEST = "request"

maleo_foundation/managers/service.py

@@ -28,7 +28,7 @@ from maleo_foundation.managers.client.google.storage import GoogleCloudStorage
 from maleo_foundation.managers.client.google.secret import GoogleSecretManager
 from maleo_foundation.managers.middleware import MiddlewareManager
 from maleo_foundation.types import BaseTypes
-from maleo_foundation.utils.exceptions import BaseExceptions
+from maleo_foundation.utils.exceptions.request import BaseRequestExceptions
 from maleo_foundation.utils.logging import (
     SimpleConfig,
     ApplicationLogger,
@@ -52,7 +52,7 @@ class ServiceManager:
         self._db_metadata = db_metadata  # * Declare DB Metadata
         self._log_config = log_config  # * Declare log config
         self._settings = (
-            settings if settings is not None else Settings()
+            settings if settings is not None else Settings()  # type: ignore
         )  # * Initialize settings
 
         # * Disable google cloud logging if environment is local
@@ -244,13 +244,18 @@ class ServiceManager:
             u_u=self.maleo_credentials.username,
             u_e=self.maleo_credentials.email,
             u_ut="service",
+            o_i=None,
+            o_uu=None,
+            o_k=None,
+            o_ot=None,
+            uor=None,
             exp_in=1,
         )
         parameters = MaleoFoundationTokenParametersTransfers.Encode(
             key=self._keys.private, password=self._keys.password, payload=payload
         )
         result = self._foundation.services.token.encode(parameters=parameters)
-        return result.data.token if result.success else None
+        return result.data.token if result.success and result.data is not None else None
 
     def create_app(
         self,
@@ -263,7 +268,7 @@ class ServiceManager:
         self._app = FastAPI(
             title=self.configurations.service.name,
             version=version,
-            lifespan=lifespan,
+            lifespan=lifespan,  # type: ignore
             root_path=root_path,
         )
         self._loggers.application.info("FastAPI application created successfully")
@@ -284,11 +289,11 @@ class ServiceManager:
         self._loggers.application.info("Adding exception handlers")
         self._app.add_exception_handler(
             exc_class_or_status_code=RequestValidationError,
-            handler=BaseExceptions.validation_exception_handler,
+            handler=BaseRequestExceptions.validation_exception_handler,  # type: ignore
         )
         self._app.add_exception_handler(
             exc_class_or_status_code=HTTPException,
-            handler=BaseExceptions.http_exception_handler,
+            handler=BaseRequestExceptions.http_exception_handler,  # type: ignore
         )
         self._loggers.application.info("Exception handlers added successfully")
 
@@ -307,10 +312,8 @@ class ServiceManager:
         self._loggers.application.info("Disposing service manager")
         if self._redis is not None:
             await self._redis.close()
-            self._redis = None
         if self._database is not None:
             self._database.dispose()
-            self._database = None
         self._loggers.application.info("Service manager disposed successfully")
         if self._loggers is not None:
             self._loggers.application.info("Disposing logger")
@@ -319,4 +322,3 @@ class ServiceManager:
             self._loggers.database.dispose()
             self._loggers.middleware.info("Disposing logger")
             self._loggers.middleware.dispose()
-            self._loggers = None

maleo_foundation/middlewares/authentication.py

@@ -10,7 +10,7 @@ from maleo_foundation.models.schemas import BaseGeneralSchemas
 from maleo_foundation.models.transfers.parameters.token import (
     MaleoFoundationTokenParametersTransfers,
 )
-from maleo_foundation.utils.exceptions import BaseExceptions
+from maleo_foundation.utils.exceptions.request import BaseRequestExceptions
 
 
 class Backend(AuthenticationBackend):
@@ -100,5 +100,5 @@ def add_authentication_middleware(
     app.add_middleware(
         AuthenticationMiddleware,
         backend=Backend(keys, maleo_foundation),
-        on_error=BaseExceptions.authentication_error_handler,  # type: ignore
+        on_error=BaseRequestExceptions.authentication_error_handler,  # type: ignore
     )

maleo_foundation/models/responses.py

@@ -1,18 +1,48 @@
 from __future__ import annotations
 from fastapi import status
-from pydantic import Field, model_validator
-from typing import Dict, Type, Union
-from maleo_foundation.models.schemas.result import BaseResultSchemas
+from pydantic import BaseModel, Field, model_validator
+from typing import Any, Dict, Optional, Type, Union
+from maleo_foundation.models.schemas.result import BaseResultSchemas, ResultMetadata
 from maleo_foundation.types import BaseTypes
 
 
 class BaseResponses:
-    class Fail(BaseResultSchemas.Fail):
+    # * ----- ----- ----- Base ----- ----- ----- *#
+    class Base(BaseModel):
+        success: bool = Field(..., description="Success status")
+        code: BaseTypes.OptionalString = Field(None, description="Optional result code")
+        message: BaseTypes.OptionalString = Field(None, description="Optional message")
+        description: BaseTypes.OptionalString = Field(
+            None, description="Optional description"
+        )
+        data: Any = Field(..., description="Data")
+        metadata: Optional[ResultMetadata] = Field(
+            None, description="Optional metadata"
+        )
+        other: BaseTypes.OptionalAny = Field(
+            None, description="Optional other information"
+        )
+
+    # * ----- ----- ----- Intermediary ----- ----- ----- *#
+    class Fail(Base):
+        success: BaseTypes.LiteralFalse = Field(False, description="Success status")  # type: ignore
+        code: str = "MAL-FAI-001"  # type: ignore
+        message: str = "Fail result"  # type: ignore
+        description: str = "Operation failed."  # type: ignore
+        data: None = Field(None, description="No data")
         other: BaseTypes.OptionalAny = Field(
             "Please try again later or contact administrator.",
             description="Response's other information",
         )
 
+    class Success(Base):
+        success: BaseTypes.LiteralTrue = Field(True, description="Success status")  # type: ignore
+        code: str = "MAL-SCS-001"  # type: ignore
+        message: str = "Success result"  # type: ignore
+        description: str = "Operation succeeded."  # type: ignore
+        data: Any = Field(..., description="Data")
+
+    # * ----- ----- ----- Derived ----- ----- ----- *#
     class BadRequest(Fail):
         code: str = "MAL-BDR-001"
         message: str = "Bad Request"
@@ -83,16 +113,32 @@ class BaseResponses:
         message: str = "Resource not found"
         description: str = "The requested resource can not be found."
 
-    class NoData(BaseResultSchemas.NoData):
-        pass
-
-    class SingleData(BaseResultSchemas.SingleData):
-        pass
-
-    class UnpaginatedMultipleData(BaseResultSchemas.UnpaginatedMultipleData):
-        pass
-
-    class PaginatedMultipleData(BaseResultSchemas.PaginatedMultipleData):
+    class NoData(Success):
+        code: str = "MAL-NDT-001"
+        message: str = "No data found"
+        description: str = "No data found in the requested resource."
+        data: None = Field(None, description="No data")
+
+    class SingleData(Success):
+        code: str = "MAL-SGD-001"
+        message: str = "Single data found"
+        description: str = "Requested data found in database."
+        data: Any = Field(..., description="Fetched single data")
+
+    class UnpaginatedMultipleData(Success):
+        code: str = "MAL-MTD-001"
+        message: str = "Multiple unpaginated data found"
+        description: str = "Requested unpaginated data found in database."
+        data: BaseTypes.ListOfAny = Field(..., description="Unpaginated multiple data")
+
+    class PaginatedMultipleData(Success):
+        code: str = "MAL-MTD-002"
+        message: str = "Multiple paginated data found"
+        description: str = "Requested paginated data found in database."
+        total_data: int = Field(..., ge=0, description="Total data count")
+        pagination: BaseResultSchemas.ExtendedPagination = Field(
+            ..., description="Pagination metadata"
+        )
         page: int = Field(
             1, ge=1, description="Page number, must be >= 1.", exclude=True
         )

maleo_foundation/models/schemas/result.py

@@ -1,5 +1,7 @@
-from pydantic import BaseModel, Field
-from typing import Dict, Optional, Union, Any
+from datetime import datetime, timezone
+from pydantic import BaseModel, Field, model_validator
+from typing import Any, Dict, Optional, Self, Union
+from maleo_foundation.enums import BaseEnums
 from maleo_foundation.models.schemas.general import BaseGeneralSchemas
 from maleo_foundation.types import BaseTypes
 
@@ -29,6 +31,29 @@ class BaseResultSchemas:
     # * ----- ----- ----- Base ----- ----- ----- *#
     class Base(BaseModel):
         success: bool = Field(..., description="Success status")
+        exception: Optional[BaseEnums.ExceptionType] = Field(
+            None, description="Exception type (optional)"
+        )
+        timestamp: datetime = Field(datetime.now(timezone.utc), description="Timestamp")
+        origin: BaseEnums.OperationOrigin = Field(..., description="Operation origin")
+        layer: BaseEnums.OperationLayer = Field(..., description="Operation layer")
+        target: Optional[BaseEnums.OperationTarget] = Field(
+            None, description="Operation target (optional)"
+        )
+        environment: Optional[BaseEnums.EnvironmentType] = Field(
+            None, description="Operation target environment (optional)"
+        )
+        resource: str = Field(..., description="Resource name")
+        operation: BaseEnums.OperationType = Field(..., description="Operation type")
+        create_type: Optional[BaseEnums.CreateType] = Field(
+            None, description="Create type (optional)"
+        )
+        update_type: Optional[BaseEnums.UpdateType] = Field(
+            None, description="Update type (optional)"
+        )
+        status_update_type: Optional[BaseEnums.StatusUpdateType] = Field(
+            None, description="Status update type (optional)"
+        )
         code: BaseTypes.OptionalString = Field(None, description="Optional result code")
         message: BaseTypes.OptionalString = Field(None, description="Optional message")
         description: BaseTypes.OptionalString = Field(
@@ -42,9 +67,52 @@ class BaseResultSchemas:
             None, description="Optional other information"
         )
 
+        @model_validator(mode="after")
+        def verify_fields(self) -> Self:
+            """Verify that the required fields are set."""
+            if self.origin is BaseEnums.OperationOrigin.SERVICE:
+                if self.layer not in BaseEnums.ServiceOperationLayer:
+                    raise ValueError(
+                        f"Invalid layer '{self.layer}' for service operation."
+                    )
+                if self.target and self.target not in BaseEnums.ServiceOperationTarget:
+                    raise ValueError(
+                        f"Invalid target '{self.target}' for service operation."
+                    )
+            elif self.origin is BaseEnums.OperationOrigin.CLIENT:
+                if self.layer not in BaseEnums.ClientOperationLayer:
+                    raise ValueError(
+                        f"Invalid layer '{self.layer}' for client operation."
+                    )
+                if self.target and self.target not in BaseEnums.ClientOperationTarget:
+                    raise ValueError(
+                        f"Invalid target '{self.target}' for client operation."
+                    )
+            else:
+                raise ValueError(
+                    f"Invalid operation origin '{self.origin}'. Must be 'service' or 'client'."
+                )
+
+            if self.operation is BaseEnums.OperationType.CREATE:
+                if self.create_type is None:
+                    raise ValueError("Create type must be set for create operations.")
+            elif self.operation is BaseEnums.OperationType.UPDATE:
+                if self.update_type is None:
+                    raise ValueError("Update type must be set for update operations.")
+                if self.update_type is BaseEnums.UpdateType.STATUS:
+                    if self.status_update_type is None:
+                        raise ValueError(
+                            "Status update type must be set for status update operations."
+                        )
+
+            return self
+
     # * ----- ----- ----- Intermediary ----- ----- ----- *#
     class Fail(Base):
         success: BaseTypes.LiteralFalse = Field(False, description="Success status")  # type: ignore
+        exception: BaseEnums.ExceptionType = Field(  # type: ignore
+            ..., description="Exception type"
+        )
         code: str = "MAL-FAI-001"  # type: ignore
         message: str = "Fail result"  # type: ignore
         description: str = "Operation failed."  # type: ignore
@@ -60,9 +128,11 @@ class BaseResultSchemas:
     # * ----- ----- ----- Derived ----- ----- ----- *#
     class NotFound(Fail):
         code: str = "MAL-NTF-001"
+        exception: BaseEnums.ExceptionType = Field(
+            BaseEnums.ExceptionType.NOT_FOUND, description="Exception type"
+        )
         message: str = "Resource not found"
         description: str = "The requested resource can not be found."
-        data: None = Field(None, description="No data")
 
     class NoData(Success):
         code: str = "MAL-NDT-001"
@@ -93,10 +163,5 @@ class BaseResultSchemas:
             ..., description="Pagination metadata"
         )
 
-    class Get(BaseModel):
-        accessed_at: BaseTypes.OptionalDatetime = Field(
-            None, description="Accessed at timestamp"
-        )
-
 
 BaseResultSchemas.PaginatedMultipleData.model_rebuild()

maleo_foundation/models/transfers/general/configurations/cache/redis.py

@@ -19,6 +19,9 @@ class RedisCacheNamespaces(BaseModel):
 
 
 class RedisCacheConfigurations(BaseModel):
+    environment: BaseEnums.EnvironmentType = Field(
+        ..., description="Redis cache's environment"
+    )
     ttl: Union[int, float] = Field(
         BaseEnums.Expiration.EXP_5MN, description="Default TTL"
     )

maleo_foundation/models/transfers/general/configurations/client/maleo.py

@@ -1,8 +1,12 @@
 from pydantic import BaseModel, ConfigDict, Field
 from typing import Optional
+from maleo_foundation.enums import BaseEnums
 
 
 class MaleoClientConfigurations(BaseModel):
+    environment: BaseEnums.EnvironmentType = Field(
+        ..., description="Client's environment"
+    )
     key: str = Field(..., description="Client's key")
     name: str = Field(..., description="Client's name")
     url: str = Field(..., description="Client's URL")

maleo_foundation/models/transfers/results/client/controllers/http.py

@@ -1,37 +1,41 @@
 from __future__ import annotations
 from httpx import Response
 from pydantic import BaseModel, ConfigDict, Field, model_validator
-from typing import Any
+from typing import Any, Self
 
 
 class BaseClientHTTPControllerResults(BaseModel):
     model_config = ConfigDict(arbitrary_types_allowed=True)
 
     response: Response = Field(..., description="Client's HTTP Controller response")
-    status_code: int = Field(
-        ..., description="Client's HTTP Controller response status code"
-    )
-    content: Any = Field(..., description="Client's HTTP Controller response content")
-    success: bool = Field(..., description="Client's HTTP Controller success status")
 
-    @model_validator(mode="before")
-    @classmethod
-    def process_response(cls, values: dict) -> dict:
-        """Process the response to set status_code, content, and success."""
-        response: Response = values.get("response")
+    @model_validator(mode="after")
+    def verify_response(self) -> Self:
+        """Verify that the response is an instance of httpx.Response."""
+        if not isinstance(self.response, Response):
+            raise TypeError("Response must be an instance of httpx.Response")
+        return self
 
-        if response:
-            values["status_code"] = response.status_code
-            values["success"] = response.is_success
+    @property
+    def status_code(self) -> int:
+        """Get the status code of the response."""
+        return self.response.status_code
 
-            # * Determine content type and parse accordingly
-            content_type: str = response.headers.get("content-type", "")
-            content_type = content_type.lower()
-            if "application/json" in content_type:
-                values["content"] = response.json()
-            elif "text/" in content_type or "application/xml" in content_type:
-                values["content"] = response.text
-            else:
-                values["content"] = response.content  # * Raw bytes for unknown types
+    @property
+    def success(self) -> bool:
+        """Get the success status of the response."""
+        return self.response.is_success
 
-        return values
+    @property
+    def content(self) -> Any:
+        """Get the content of the response."""
+        # * Determine content type and parse accordingly
+        content_type: str = self.response.headers.get("content-type", "")
+        content_type = content_type.lower()
+        if "application/json" in content_type:
+            content = self.response.json()
+        elif "text/" in content_type or "application/xml" in content_type:
+            content = self.response.text
+        else:
+            content = self.response.content  # * Raw bytes for unknown types
+        return content

maleo_foundation/models/transfers/results/client/service.py

@@ -1,7 +1,5 @@
 from __future__ import annotations
-from pydantic import Field, model_validator
-from typing import Optional
-from maleo_foundation.enums import BaseEnums
+from pydantic import model_validator
 from maleo_foundation.models.schemas.result import BaseResultSchemas
 
 
@@ -35,8 +33,3 @@ class BaseClientServiceResultsTransfers:
             values["total_data"] = pagination.total_data
 
             return values
-
-    class Get(BaseResultSchemas.Get):
-        source: Optional[BaseEnums.ClientDataSource] = Field(
-            None, description="Data source"
-        )

maleo_foundation/models/transfers/results/service/general.py

@@ -1,7 +1,5 @@
 from __future__ import annotations
-from pydantic import Field, model_validator
-from typing import Optional
-from maleo_foundation.enums import BaseEnums
+from pydantic import model_validator
 from maleo_foundation.models.schemas.result import BaseResultSchemas
 
 
@@ -45,8 +43,3 @@ class BaseServiceGeneralResultsTransfers:
                 total_pages=total_pages,
             )
             return values
-
-    class Get(BaseResultSchemas.Get):
-        source: Optional[BaseEnums.ServiceDataSource] = Field(
-            None, description="Data source"
-        )

maleo_foundation/utils/__init__.py

@@ -1,6 +1,5 @@
 from __future__ import annotations
 from .formatter import BaseFormatter
-from .exceptions import BaseExceptions
 from .loaders import BaseLoaders
 from .controller import BaseControllerUtils
 from .query import BaseQueryUtils
@@ -8,7 +7,6 @@ from .query import BaseQueryUtils
 
 class BaseUtils:
     Formatter = BaseFormatter
-    Exceptions = BaseExceptions
     Loaders = BaseLoaders
     Controller = BaseControllerUtils
     Query = BaseQueryUtils

maleo_foundation/utils/exceptions/client.py

@@ -0,0 +1,221 @@
+from datetime import datetime, timezone
+from functools import wraps
+from httpx import RequestError
+from pydantic import ValidationError
+from typing import Optional
+from maleo_foundation.enums import BaseEnums
+from maleo_foundation.models.transfers.results.client.service import (
+    BaseClientServiceResultsTransfers,
+)
+from maleo_foundation.utils.logging import BaseLogger
+
+
+class BaseClientExceptions:
+    @staticmethod
+    def _exception_handler(
+        layer: BaseEnums.OperationLayer,
+        resource: str,
+        operation: BaseEnums.OperationType,
+        summary: str,
+        e: Exception,
+        exception: BaseEnums.ExceptionType,
+        category: str,
+        description: str,
+        target: Optional[BaseEnums.OperationTarget] = None,
+        environment: Optional[BaseEnums.EnvironmentType] = None,
+        create_type: Optional[BaseEnums.CreateType] = None,
+        update_type: Optional[BaseEnums.UpdateType] = None,
+        status_update_type: Optional[BaseEnums.StatusUpdateType] = None,
+        logger: Optional[BaseLogger] = None,
+        fail_result_class: type[
+            BaseClientServiceResultsTransfers.Fail
+        ] = BaseClientServiceResultsTransfers.Fail,
+    ) -> BaseClientServiceResultsTransfers.Fail:
+        if logger:
+            logger.error(
+                f"{category} occurred while {summary}: '{str(e)}'",
+                exc_info=True,
+            )
+        return fail_result_class(
+            success=False,
+            exception=exception,
+            timestamp=datetime.now(timezone.utc),
+            origin=BaseEnums.OperationOrigin.CLIENT,
+            layer=layer,
+            target=target,
+            environment=environment,
+            resource=resource,
+            operation=operation,
+            create_type=create_type,
+            update_type=update_type,
+            status_update_type=status_update_type,
+            message=f"Failed {summary}",
+            description=description,
+            data=None,
+            metadata=None,
+            other=category,
+        )
+
+    @staticmethod
+    def async_exception_handler(
+        layer: BaseEnums.OperationLayer,
+        resource: str,
+        operation: BaseEnums.OperationType,
+        summary: str,
+        target: Optional[BaseEnums.OperationTarget] = None,
+        environment: Optional[BaseEnums.EnvironmentType] = None,
+        create_type: Optional[BaseEnums.CreateType] = None,
+        update_type: Optional[BaseEnums.UpdateType] = None,
+        status_update_type: Optional[BaseEnums.StatusUpdateType] = None,
+        logger: Optional[BaseLogger] = None,
+        fail_result_class: type[
+            BaseClientServiceResultsTransfers.Fail
+        ] = BaseClientServiceResultsTransfers.Fail,
+    ):
+        """Decorator to handle exceptions consistently for async operation functions."""
+
+        def decorator(func):
+            @wraps(func)
+            async def wrapper(*args, **kwargs):
+                try:
+                    return await func(*args, **kwargs)
+                except ValidationError as e:
+                    return BaseClientExceptions._exception_handler(
+                        layer=layer,
+                        resource=resource,
+                        operation=operation,
+                        summary=summary,
+                        e=e,
+                        exception=BaseEnums.ExceptionType.VALIDATION,
+                        category="Validation error",
+                        description=f"A validation error occurred while {operation}. Please try again later or contact administrator.",
+                        target=target,
+                        environment=environment,
+                        create_type=create_type,
+                        update_type=update_type,
+                        status_update_type=status_update_type,
+                        logger=logger,
+                        fail_result_class=fail_result_class,
+                    )
+                except RequestError as e:
+                    return BaseClientExceptions._exception_handler(
+                        layer=layer,
+                        resource=resource,
+                        operation=operation,
+                        summary=summary,
+                        e=e,
+                        exception=BaseEnums.ExceptionType.UNAVAILABLE,
+                        category="Request error",
+                        description=f"A request error occurred while {operation}. Please try again later or contact administrator.",
+                        target=target,
+                        environment=environment,
+                        create_type=create_type,
+                        update_type=update_type,
+                        status_update_type=status_update_type,
+                        logger=logger,
+                        fail_result_class=fail_result_class,
+                    )
+                except Exception as e:
+                    return BaseClientExceptions._exception_handler(
+                        layer=layer,
+                        resource=resource,
+                        operation=operation,
+                        summary=summary,
+                        e=e,
+                        exception=BaseEnums.ExceptionType.INTERNAL,
+                        category="Internal processing error",
+                        description=f"An unexpected error occurred while {operation}. Please try again later or contact administrator.",
+                        target=target,
+                        environment=environment,
+                        create_type=create_type,
+                        update_type=update_type,
+                        status_update_type=status_update_type,
+                        logger=logger,
+                        fail_result_class=fail_result_class,
+                    )
+
+            return wrapper
+
+        return decorator
+
+    @staticmethod
+    def sync_exception_handler(
+        layer: BaseEnums.OperationLayer,
+        resource: str,
+        operation: BaseEnums.OperationType,
+        summary: str,
+        target: Optional[BaseEnums.OperationTarget] = None,
+        environment: Optional[BaseEnums.EnvironmentType] = None,
+        create_type: Optional[BaseEnums.CreateType] = None,
+        update_type: Optional[BaseEnums.UpdateType] = None,
+        status_update_type: Optional[BaseEnums.StatusUpdateType] = None,
+        logger: Optional[BaseLogger] = None,
+        fail_result_class: type[
+            BaseClientServiceResultsTransfers.Fail
+        ] = BaseClientServiceResultsTransfers.Fail,
+    ):
+        """Decorator to handle exceptions consistently for sync operation functions."""
+
+        def decorator(func):
+            @wraps(func)
+            def wrapper(*args, **kwargs):
+                try:
+                    return func(*args, **kwargs)
+                except ValidationError as e:
+                    return BaseClientExceptions._exception_handler(
+                        layer=layer,
+                        resource=resource,
+                        operation=operation,
+                        summary=summary,
+                        e=e,
+                        exception=BaseEnums.ExceptionType.VALIDATION,
+                        category="Validation error",
+                        description=f"A validation error occurred while {operation}. Please try again later or contact administrator.",
+                        target=target,
+                        environment=environment,
+                        create_type=create_type,
+                        update_type=update_type,
+                        status_update_type=status_update_type,
+                        logger=logger,
+                        fail_result_class=fail_result_class,
+                    )
+                except RequestError as e:
+                    return BaseClientExceptions._exception_handler(
+                        layer=layer,
+                        resource=resource,
+                        operation=operation,
+                        summary=summary,
+                        e=e,
+                        exception=BaseEnums.ExceptionType.UNAVAILABLE,
+                        category="Request error",
+                        description=f"A request error occurred while {operation}. Please try again later or contact administrator.",
+                        target=target,
+                        environment=environment,
+                        create_type=create_type,
+                        update_type=update_type,
+                        status_update_type=status_update_type,
+                        logger=logger,
+                        fail_result_class=fail_result_class,
+                    )
+                except Exception as e:
+                    return BaseClientExceptions._exception_handler(
+                        layer=layer,
+                        resource=resource,
+                        operation=operation,
+                        summary=summary,
+                        e=e,
+                        exception=BaseEnums.ExceptionType.INTERNAL,
+                        category="Internal processing error",
+                        description=f"An unexpected error occurred while {operation}. Please try again later or contact administrator.",
+                        target=target,
+                        environment=environment,
+                        create_type=create_type,
+                        update_type=update_type,
+                        status_update_type=status_update_type,
+                        logger=logger,
+                        fail_result_class=fail_result_class,
+                    )
+
+            return wrapper
+
+        return decorator

maleo_foundation/utils/exceptions/request.py

@@ -0,0 +1,38 @@
+from fastapi import Request, status
+from fastapi.encoders import jsonable_encoder
+from fastapi.exceptions import RequestValidationError
+from fastapi.responses import JSONResponse
+from starlette.exceptions import HTTPException as StarletteHTTPException
+from maleo_foundation.models.responses import BaseResponses
+
+
+class BaseRequestExceptions:
+    @staticmethod
+    def authentication_error_handler(request: Request, exc: Exception):
+        return JSONResponse(
+            content=BaseResponses.Unauthorized(other=str(exc)).model_dump(mode="json"),  # type: ignore
+            status_code=status.HTTP_401_UNAUTHORIZED,
+        )
+
+    @staticmethod
+    async def validation_exception_handler(
+        request: Request, exc: RequestValidationError
+    ):
+        serialized_error = jsonable_encoder(exc.errors())
+        return JSONResponse(
+            content=BaseResponses.ValidationError(other=serialized_error).model_dump(mode="json"),  # type: ignore
+            status_code=status.HTTP_422_UNPROCESSABLE_ENTITY,
+        )
+
+    @staticmethod
+    async def http_exception_handler(request: Request, exc: StarletteHTTPException):
+        if exc.status_code in BaseResponses.other_responses:
+            return JSONResponse(
+                content=BaseResponses.other_responses[exc.status_code]["model"]().model_dump(mode="json"),  # type: ignore
+                status_code=exc.status_code,
+            )
+
+        return JSONResponse(
+            content=BaseResponses.ServerError().model_dump(mode="json"),  # type: ignore
+            status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
+        )

maleo_foundation/utils/exceptions/service.py

@@ -0,0 +1,221 @@
+from datetime import datetime, timezone
+from functools import wraps
+from pydantic import ValidationError
+from sqlalchemy.exc import SQLAlchemyError
+from typing import Optional
+from maleo_foundation.enums import BaseEnums
+from maleo_foundation.models.transfers.results.service.general import (
+    BaseServiceGeneralResultsTransfers,
+)
+from maleo_foundation.utils.logging import BaseLogger
+
+
+class BaseServiceExceptions:
+    @staticmethod
+    def _exception_handler(
+        layer: BaseEnums.OperationLayer,
+        resource: str,
+        operation: BaseEnums.OperationType,
+        summary: str,
+        e: Exception,
+        exception: BaseEnums.ExceptionType,
+        category: str,
+        description: str,
+        target: Optional[BaseEnums.OperationTarget] = None,
+        environment: Optional[BaseEnums.EnvironmentType] = None,
+        create_type: Optional[BaseEnums.CreateType] = None,
+        update_type: Optional[BaseEnums.UpdateType] = None,
+        status_update_type: Optional[BaseEnums.StatusUpdateType] = None,
+        logger: Optional[BaseLogger] = None,
+        fail_result_class: type[
+            BaseServiceGeneralResultsTransfers.Fail
+        ] = BaseServiceGeneralResultsTransfers.Fail,
+    ) -> BaseServiceGeneralResultsTransfers.Fail:
+        if logger:
+            logger.error(
+                f"{category} occurred while {summary}: '{str(e)}'",
+                exc_info=True,
+            )
+        return fail_result_class(
+            success=False,
+            exception=exception,
+            timestamp=datetime.now(timezone.utc),
+            origin=BaseEnums.OperationOrigin.SERVICE,
+            layer=layer,
+            target=target,
+            environment=environment,
+            resource=resource,
+            operation=operation,
+            create_type=create_type,
+            update_type=update_type,
+            status_update_type=status_update_type,
+            message=f"Failed {summary}",
+            description=description,
+            data=None,
+            metadata=None,
+            other=category,
+        )
+
+    @staticmethod
+    def async_exception_handler(
+        layer: BaseEnums.OperationLayer,
+        resource: str,
+        operation: BaseEnums.OperationType,
+        summary: str,
+        target: Optional[BaseEnums.OperationTarget] = None,
+        environment: Optional[BaseEnums.EnvironmentType] = None,
+        create_type: Optional[BaseEnums.CreateType] = None,
+        update_type: Optional[BaseEnums.UpdateType] = None,
+        status_update_type: Optional[BaseEnums.StatusUpdateType] = None,
+        logger: Optional[BaseLogger] = None,
+        fail_result_class: type[
+            BaseServiceGeneralResultsTransfers.Fail
+        ] = BaseServiceGeneralResultsTransfers.Fail,
+    ):
+        """Decorator to handle exceptions consistently for async operation functions."""
+
+        def decorator(func):
+            @wraps(func)
+            async def wrapper(*args, **kwargs):
+                try:
+                    return await func(*args, **kwargs)
+                except ValidationError as e:
+                    return BaseServiceExceptions._exception_handler(
+                        layer=layer,
+                        resource=resource,
+                        operation=operation,
+                        summary=summary,
+                        e=e,
+                        exception=BaseEnums.ExceptionType.VALIDATION,
+                        category="Validation error",
+                        description=f"A validation error occurred while {operation}. Please try again later or contact administrator.",
+                        target=target,
+                        environment=environment,
+                        create_type=create_type,
+                        update_type=update_type,
+                        status_update_type=status_update_type,
+                        logger=logger,
+                        fail_result_class=fail_result_class,
+                    )
+                except SQLAlchemyError as e:
+                    return BaseServiceExceptions._exception_handler(
+                        layer=layer,
+                        resource=resource,
+                        operation=operation,
+                        summary=summary,
+                        e=e,
+                        exception=BaseEnums.ExceptionType.INTERNAL,
+                        category="Database error",
+                        description=f"A database error occurred while {operation}. Please try again later or contact administrator.",
+                        target=target,
+                        environment=environment,
+                        create_type=create_type,
+                        update_type=update_type,
+                        status_update_type=status_update_type,
+                        logger=logger,
+                        fail_result_class=fail_result_class,
+                    )
+                except Exception as e:
+                    return BaseServiceExceptions._exception_handler(
+                        layer=layer,
+                        resource=resource,
+                        operation=operation,
+                        summary=summary,
+                        e=e,
+                        exception=BaseEnums.ExceptionType.INTERNAL,
+                        category="Internal processing error",
+                        description=f"An unexpected error occurred while {operation}. Please try again later or contact administrator.",
+                        target=target,
+                        environment=environment,
+                        create_type=create_type,
+                        update_type=update_type,
+                        status_update_type=status_update_type,
+                        logger=logger,
+                        fail_result_class=fail_result_class,
+                    )
+
+            return wrapper
+
+        return decorator
+
+    @staticmethod
+    def sync_exception_handler(
+        layer: BaseEnums.OperationLayer,
+        resource: str,
+        operation: BaseEnums.OperationType,
+        summary: str,
+        target: Optional[BaseEnums.OperationTarget] = None,
+        environment: Optional[BaseEnums.EnvironmentType] = None,
+        create_type: Optional[BaseEnums.CreateType] = None,
+        update_type: Optional[BaseEnums.UpdateType] = None,
+        status_update_type: Optional[BaseEnums.StatusUpdateType] = None,
+        logger: Optional[BaseLogger] = None,
+        fail_result_class: type[
+            BaseServiceGeneralResultsTransfers.Fail
+        ] = BaseServiceGeneralResultsTransfers.Fail,
+    ):
+        """Decorator to handle exceptions consistently for sync operation functions."""
+
+        def decorator(func):
+            @wraps(func)
+            def wrapper(*args, **kwargs):
+                try:
+                    return func(*args, **kwargs)
+                except ValidationError as e:
+                    return BaseServiceExceptions._exception_handler(
+                        layer=layer,
+                        resource=resource,
+                        operation=operation,
+                        summary=summary,
+                        e=e,
+                        exception=BaseEnums.ExceptionType.VALIDATION,
+                        category="Validation error",
+                        description=f"A validation error occurred while {operation}. Please try again later or contact administrator.",
+                        target=target,
+                        environment=environment,
+                        create_type=create_type,
+                        update_type=update_type,
+                        status_update_type=status_update_type,
+                        logger=logger,
+                        fail_result_class=fail_result_class,
+                    )
+                except SQLAlchemyError as e:
+                    return BaseServiceExceptions._exception_handler(
+                        layer=layer,
+                        resource=resource,
+                        operation=operation,
+                        summary=summary,
+                        e=e,
+                        exception=BaseEnums.ExceptionType.INTERNAL,
+                        category="Database error",
+                        description=f"A database error occurred while {operation}. Please try again later or contact administrator.",
+                        target=target,
+                        environment=environment,
+                        create_type=create_type,
+                        update_type=update_type,
+                        status_update_type=status_update_type,
+                        logger=logger,
+                        fail_result_class=fail_result_class,
+                    )
+                except Exception as e:
+                    return BaseServiceExceptions._exception_handler(
+                        layer=layer,
+                        resource=resource,
+                        operation=operation,
+                        summary=summary,
+                        e=e,
+                        exception=BaseEnums.ExceptionType.INTERNAL,
+                        category="Internal processing error",
+                        description=f"An unexpected error occurred while {operation}. Please try again later or contact administrator.",
+                        target=target,
+                        environment=environment,
+                        create_type=create_type,
+                        update_type=update_type,
+                        status_update_type=status_update_type,
+                        logger=logger,
+                        fail_result_class=fail_result_class,
+                    )
+
+            return wrapper
+
+        return decorator

{maleo_foundation-0.3.55.dist-info → maleo_foundation-0.3.57.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: maleo_foundation
-Version: 0.3.55
+Version: 0.3.57
 Summary: Foundation package for Maleo
 Author-email: Agra Bima Yuda <agra@nexmedis.com>
 License: MIT

{maleo_foundation-0.3.55.dist-info → maleo_foundation-0.3.57.dist-info}/RECORD

@@ -2,7 +2,7 @@ maleo_foundation/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,
 maleo_foundation/authentication.py,sha256=2Y2py-teDSO_YTFdZiPtuYhC8r3qIzn7CKyLNN8b2NQ,2727
 maleo_foundation/authorization.py,sha256=8P1hleBYRv8kda4uQcbHVujHVAlI92YV1Flfzf-oJEU,285
 maleo_foundation/constants.py,sha256=cgW2TjXYEdQRoYCL3fMk3r5B2Yr-Av67CaEAdY5SZ6o,1529
-maleo_foundation/enums.py,sha256=teEj0pqZmt-V7yEzYE3PnDO4stINlxRSWbejAatmqEQ,5075
+maleo_foundation/enums.py,sha256=AwfCsYBa8ieqxc6N0gVwqJ7GFj7M76qI1mDw_9LrU9I,6153
 maleo_foundation/extended_types.py,sha256=oOAYc5f89WcPt5OWEaNdeceENHiPVr4KDhdttg6bA_w,305
 maleo_foundation/rest_controller_result.py,sha256=uZxBxZ5hB98q1B4hNyRigHcO0560NYfUjq8L662aOPw,2172
 maleo_foundation/types.py,sha256=Tq50KOISbnsMslVGBCqlY77lRAQZa-UUFDGqqwRglow,2466
@@ -36,7 +36,7 @@ maleo_foundation/managers/configuration.py,sha256=Zc397mT3Qn1Q_gDeuDVKl5YA3bSM-o
 maleo_foundation/managers/credential.py,sha256=um1M45deBEzTVfsUcpAtKEp3Rb_dH1qQrr8abkG_GeU,3057
 maleo_foundation/managers/db.py,sha256=y0rQIg-vohhFUtck3v1LCdXov7XYjy9PFiCsVtcg8VI,6496
 maleo_foundation/managers/middleware.py,sha256=Uglwt4X3MauKtBvbPTyHl0-32od3IN6AYYUtiUCoV9I,2464
-maleo_foundation/managers/service.py,sha256=GN8batfTPyZUGTVriqi9dZDu601_TYHJcrPL_VdutvQ,11660
+maleo_foundation/managers/service.py,sha256=YRG1cLc7yGytDXzOe-btKJ5K0YRHJfkgfGF3D5h3ty4,11795
 maleo_foundation/managers/client/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 maleo_foundation/managers/client/base.py,sha256=iM5xZjLm5VQqqpiYcba-rifW0LgkVd-gRTE6XwdOFqY,4369
 maleo_foundation/managers/client/maleo.py,sha256=ATZXgP8OGqoF51mxjg21UTuWwQbVte-iY0lJ4liNaog,2648
@@ -46,11 +46,11 @@ maleo_foundation/managers/client/google/parameter.py,sha256=emBgc1qCQcnETKYvwv35
 maleo_foundation/managers/client/google/secret.py,sha256=75q32U-kcTljVb19MZQQ5sOVOnf1HkquyK8nIoyeMrY,5014
 maleo_foundation/managers/client/google/storage.py,sha256=uUc3RGu5PyGOKrObP-ub2Vpztqidu5BUADUrRTMxy7E,6569
 maleo_foundation/managers/client/google/subscription.py,sha256=KLXneM39r8Uzvevir_jL7s9-q4iSakNUkD_I66JGbng,5365
-maleo_foundation/middlewares/authentication.py,sha256=Foag5Bc4tEiCZtHuCnBAKFq4t4jMoU3ZCrR_MMZRZPc,4167
+maleo_foundation/middlewares/authentication.py,sha256=b4dPkLKFqJBmhWKEvynTLe45Wax8jCcPq0luIlU_id0,4189
 maleo_foundation/middlewares/base.py,sha256=ZXMJTiuDBa6sIbgD_g1MhhlMkszsYkt3Ocl4boPtbEU,16825
 maleo_foundation/middlewares/cors.py,sha256=1QgRXOcURuEhBYMerclqbECgtAE4CFo0EhB4gJXu8Yg,2294
 maleo_foundation/models/__init__.py,sha256=OlZXaeOhGXz_FppPm87jIOItnr-r179QhIcOWDOORyQ,248
-maleo_foundation/models/responses.py,sha256=4uIrW8y6gyBQJ5DZRMWKAJcNdamDMCpgCzizwcBHGhw,6081
+maleo_foundation/models/responses.py,sha256=Tg--iTXwA0zHhd991mJiHIrBbqEW8QYC-pCM5yboIzI,8489
 maleo_foundation/models/table.py,sha256=k0-OtahF2KRmvFUL8TborT6PoIhGsyoVrPJBKGg1QbU,1855
 maleo_foundation/models/schemas/__init__.py,sha256=tmjBCyG4uMRjiTbnbhIjZaR8q7zk0_J_CqnRzsSfoBQ,279
 maleo_foundation/models/schemas/encryption.py,sha256=S86FGlcBhyGxxZ5ObNSHTjSDwBUlUtLOMoCAKd5wE34,687
@@ -58,7 +58,7 @@ maleo_foundation/models/schemas/general.py,sha256=jxzBsVGsdKKEiM14MfV47dDiAZalUK
 maleo_foundation/models/schemas/hash.py,sha256=jthDmu_VTBydffPruAIAiR8l0Xs6IrlgTptaP42zr1M,447
 maleo_foundation/models/schemas/key.py,sha256=LSEDQpaCxavwp5je2O-ZNyOPtrFW_lXDywF9LK-An1w,622
 maleo_foundation/models/schemas/parameter.py,sha256=OE1hg100lEa2IlGlT2Zz6PJ-OcC-6ZfDzsTOeJvvEig,3907
-maleo_foundation/models/schemas/result.py,sha256=k_VcmdIoZX-9nyxkmH7uPaSZFK2m0tjFIqYbVXdL1jw,4375
+maleo_foundation/models/schemas/result.py,sha256=MTRobolQeFuhjJCV652fALgLraGwCaXfcL1yRWG54tI,7772
 maleo_foundation/models/schemas/signature.py,sha256=h0sa91vnCaivmvlbqOd7RLiCz8qAY8gCzEnm0DOBlSg,649
 maleo_foundation/models/schemas/token.py,sha256=eh4k9rm_MoaCfGV3Nqa7yFH-PH7Ec6WY4RxHhbF4m5U,591
 maleo_foundation/models/transfers/__init__.py,sha256=V5kdd8wuXqe78bQ7HG3a8vW3Rkke2wTr6mb5lC0IQJg,301
@@ -76,9 +76,9 @@ maleo_foundation/models/transfers/general/configurations/database.py,sha256=4j46
 maleo_foundation/models/transfers/general/configurations/middleware.py,sha256=gBm7yv-PYOPcv-u6SXq8cMWfuuo9LwPSXuqoJ4uw9h0,1761
 maleo_foundation/models/transfers/general/configurations/service.py,sha256=1sDBwJYvO7tlKz9YH7eIkfMPWmUqRkx7aW-EMw8tpBQ,306
 maleo_foundation/models/transfers/general/configurations/cache/__init__.py,sha256=eCEeFFP4jN9FWFHWLadAnP1NoJH4CJQm7WRnXhmHUh0,264
-maleo_foundation/models/transfers/general/configurations/cache/redis.py,sha256=CUxuw9JSkw-pB4q97IduBnlINmsO487SpnrznYEf4-g,1220
+maleo_foundation/models/transfers/general/configurations/cache/redis.py,sha256=SNnI7hm8giKfR2Kp5sD_fmxo4Q5fkRCdi9zMKwTKPCs,1331
 maleo_foundation/models/transfers/general/configurations/client/__init__.py,sha256=1w17i9CH4bSQ40o8rwIew2F_id25XklFqI1YPowcHvQ,356
-maleo_foundation/models/transfers/general/configurations/client/maleo.py,sha256=aYTNsCAa0Vws1Zkt_6lnYAgJUN7Uo_YI_lAcUIaLiR0,1912
+maleo_foundation/models/transfers/general/configurations/client/maleo.py,sha256=0Hk6no800DdaAlv0SZ1OqVGxbp4LtJz1cJ0ZNbBejK4,2063
 maleo_foundation/models/transfers/parameters/__init__.py,sha256=HiV7hPn8rUaN7XeOwC_VugYQ4QQO7kbZ0fsp11GDznQ,355
 maleo_foundation/models/transfers/parameters/client.py,sha256=2V1XvhSmIDDZL7MFVpD_dR5jWIoydQnFW67n9z6rRMA,4041
 maleo_foundation/models/transfers/parameters/general.py,sha256=NUFsrrfByN9OX9QLYc2Bn0LpNPoxrKBuZae-IVhOiyo,791
@@ -99,21 +99,20 @@ maleo_foundation/models/transfers/results/key.py,sha256=dwEWM_FLubTf4tx3dFbvKJye
 maleo_foundation/models/transfers/results/signature.py,sha256=Wjn5GjWTXWMtmSykAZACvAPT_hfXzmwo8GFAOCwYCMw,728
 maleo_foundation/models/transfers/results/token.py,sha256=uucgesaw7fRUhvfJnsWpjKEARjsTQ8-HF-maAYKei3Q,659
 maleo_foundation/models/transfers/results/client/__init__.py,sha256=QVW77FHou7OOABTjiIGdwPhXub46AI3GIM8EGk6ONw4,292
-maleo_foundation/models/transfers/results/client/service.py,sha256=XfiHk4AKNIqSuKonjG76U3vfwrxbX7kykcAo1eLMh3c,1469
+maleo_foundation/models/transfers/results/client/service.py,sha256=_Eu12Zjr7vwjRoCBRkUEHCS0DEeMZtq4vLwGmBGo5tc,1234
 maleo_foundation/models/transfers/results/client/controllers/__init__.py,sha256=DN3va_Mcxjw0l1s9dSIOy3LkLR1jEERiAohuIA59vpc,175
-maleo_foundation/models/transfers/results/client/controllers/http.py,sha256=8-FvXt5n9MSutjKSEWE5k70LrC_UGZ2Ri2oCDrEIfYw,1541
+maleo_foundation/models/transfers/results/client/controllers/http.py,sha256=toDx3xeDidtCDybUtPDfHbz0BY8VM-JcZ-5o_9VApRU,1522
 maleo_foundation/models/transfers/results/encryption/__init__.py,sha256=fq8hH7SHyYgZkYEurnZpj4Plez7Ipy8-8yX60bj-I-w,309
 maleo_foundation/models/transfers/results/encryption/aes.py,sha256=5aNglJqHT3Ufordl_Bfy9thIXVblMw80xtmLs7KiCXI,877
 maleo_foundation/models/transfers/results/encryption/rsa.py,sha256=dSIshf386TAF9hfokDmj4XKHsR_MQfQLmft8AF2MTZc,748
 maleo_foundation/models/transfers/results/service/__init__.py,sha256=J2PANZfFCPIE836hqKLj7a7q9AT5YSPQ0_SlYj3OKP0,295
-maleo_foundation/models/transfers/results/service/general.py,sha256=nx23IHIxiscl1miSz2D2VNN2oFV8e7eKlm-cV4QjFWc,1750
+maleo_foundation/models/transfers/results/service/general.py,sha256=3l0YGZf8SD7udVm1EHr9frMD2kuWbGY1D_Eo1wrGS0Q,1514
 maleo_foundation/models/transfers/results/service/controllers/__init__.py,sha256=rRt93gFqsJloJXzNWS_2chBC3hJoG4WaN84H2B5UPow,177
 maleo_foundation/models/transfers/results/service/controllers/rest.py,sha256=YRD_D064BGqHUJeFH-ArOPmSNnhJO_gr_AI4gTqh8Y0,951
-maleo_foundation/utils/__init__.py,sha256=L9J946_ySumzbJoOIbSBkhGz0tcjWPZ2_g76EXyxKkk,393
+maleo_foundation/utils/__init__.py,sha256=advf6IhKQOz64jbI0f9gyabHWa7ti8wTYDkYLD85_Ss,322
 maleo_foundation/utils/cache.py,sha256=PWNef00iA2m0g3boR7JbzrJQIRITf5nKgdCmMs3s6ag,1159
 maleo_foundation/utils/client.py,sha256=KDkIEqGX6Tw07Z5HHW4HrG8IWUVkErlqnVijXnpWZGQ,2940
 maleo_foundation/utils/controller.py,sha256=S69NluxjGCB_toAu3JDLi_izE0-x2ARE_7YK3V8T1Q0,7413
-maleo_foundation/utils/exceptions.py,sha256=qNbmkfOAz_sIfO_sIypzM6ami-PiK1vs98MJJSAxj7g,6611
 maleo_foundation/utils/extractor.py,sha256=an9bKvwIniVvUCk0fSetUL_8VGBk_MNEtB2pwgkYb4k,2369
 maleo_foundation/utils/logging.py,sha256=sOQbvrLdlp1Vwx7y14YitzHx4IHh5iYaCt9WvdrapUI,9141
 maleo_foundation/utils/merger.py,sha256=UGiuH0EUQJu0WlS1xdPUuvnsNknd3k0DODjdiOTiBdI,704
@@ -123,6 +122,10 @@ maleo_foundation/utils/searcher.py,sha256=rcHa0pPZvLEk2MgI4qeGW-K6vlUy2eWTnwWzzT
 maleo_foundation/utils/dependencies/__init__.py,sha256=jJOo4uCTPiEvpgecsl4JEhKzuV85KaNxOd9PiRl-2ic,124
 maleo_foundation/utils/dependencies/auth.py,sha256=3Z0b-Xi5PAKRKlbv-ZIT46YrQFkjiS7NhSDWZTOWm8I,650
 maleo_foundation/utils/dependencies/context.py,sha256=pw18j6LZgHdJQVKCvRH71mFZ_li8jP_wIgbtBMLXpxQ,271
+maleo_foundation/utils/exceptions/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+maleo_foundation/utils/exceptions/client.py,sha256=gGA7BWf2Fel33lYqMd2LJVvt1x0HO0OqbopAJCcYnbY,9665
+maleo_foundation/utils/exceptions/request.py,sha256=p6rfya7HuqlfrvxFZm3KgTf95mPkQ6QCBlLyhiRfGtw,1600
+maleo_foundation/utils/exceptions/service.py,sha256=bhUvZb3rTx2UYwyVxbNjtKw7aru3UIVZptzTlGGk65g,9698
 maleo_foundation/utils/formatter/__init__.py,sha256=qzn45FGoZeArJYmgFpdzKe-jp3yREGSrPfc4a-iZHe4,80
 maleo_foundation/utils/formatter/case.py,sha256=VsDTkKVZgN5b5O4Q6hkEzIDTf635FHS2BF_eY-NNngQ,1359
 maleo_foundation/utils/loaders/__init__.py,sha256=aBVS-zCBdb9t4Keh5cFJ4Vqv5lFHthJoHTaGPVjnvnU,284
@@ -132,7 +135,7 @@ maleo_foundation/utils/loaders/credential/__init__.py,sha256=g-cAxkTE2EtHaG8Tv52
 maleo_foundation/utils/loaders/credential/google.py,sha256=GCJl-bsKSSxoE_ERAkIzRrRNIbIEeqYOhHwzFuBr0mk,6576
 maleo_foundation/utils/loaders/key/__init__.py,sha256=RfqIbUxkdlx1xrbzJZPD_JHiRFNFLRuQs8JoUPCGCv4,108
 maleo_foundation/utils/loaders/key/rsa.py,sha256=UXcP0rr4QVacTsHLNQuU05wcow5CHWz-JW-zsVxlbPs,4121
-maleo_foundation-0.3.55.dist-info/METADATA,sha256=BCt07Y4xUXZCRZgLjDa64c6BpJ3ZlmrMX0ZNAPHKATI,4150
-maleo_foundation-0.3.55.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-maleo_foundation-0.3.55.dist-info/top_level.txt,sha256=_iBos3F_bhEOdjOnzeiEYSrCucasc810xXtLBXI8cQc,17
-maleo_foundation-0.3.55.dist-info/RECORD,,
+maleo_foundation-0.3.57.dist-info/METADATA,sha256=-j2vLiPYXbLAevxpNYD3GYc2Bs3GkcDxvf7FRF_xX0U,4150
+maleo_foundation-0.3.57.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+maleo_foundation-0.3.57.dist-info/top_level.txt,sha256=_iBos3F_bhEOdjOnzeiEYSrCucasc810xXtLBXI8cQc,17
+maleo_foundation-0.3.57.dist-info/RECORD,,

maleo_foundation/utils/exceptions.py

@@ -1,158 +0,0 @@
-import asyncio
-from fastapi import Request, status
-from fastapi.encoders import jsonable_encoder
-from fastapi.exceptions import RequestValidationError
-from fastapi.responses import JSONResponse
-from functools import wraps
-from pydantic import ValidationError
-from starlette.exceptions import HTTPException as StarletteHTTPException
-from sqlalchemy.exc import SQLAlchemyError
-from typing import Optional
-from maleo_foundation.models.responses import BaseResponses
-from maleo_foundation.models.transfers.results.service.general import (
-    BaseServiceGeneralResultsTransfers,
-)
-from maleo_foundation.utils.logging import BaseLogger
-
-
-class BaseExceptions:
-    @staticmethod
-    def authentication_error_handler(request: Request, exc: Exception):
-        return JSONResponse(
-            content=BaseResponses.Unauthorized(other=str(exc)).model_dump(mode="json"),  # type: ignore
-            status_code=status.HTTP_401_UNAUTHORIZED,
-        )
-
-    @staticmethod
-    async def validation_exception_handler(
-        request: Request, exc: RequestValidationError
-    ):
-        serialized_error = jsonable_encoder(exc.errors())
-        return JSONResponse(
-            content=BaseResponses.ValidationError(other=serialized_error).model_dump(mode="json"),  # type: ignore
-            status_code=status.HTTP_422_UNPROCESSABLE_ENTITY,
-        )
-
-    @staticmethod
-    async def http_exception_handler(request: Request, exc: StarletteHTTPException):
-        if exc.status_code in BaseResponses.other_responses:
-            return JSONResponse(
-                content=BaseResponses.other_responses[exc.status_code]["model"]().model_dump(mode="json"),  # type: ignore
-                status_code=exc.status_code,
-            )
-
-        return JSONResponse(
-            content=BaseResponses.ServerError().model_dump(mode="json"),  # type: ignore
-            status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
-        )
-
-    @staticmethod
-    def repository_exception_handler(
-        operation: str,
-        logger: Optional[BaseLogger] = None,
-        fail_result_class: type[
-            BaseServiceGeneralResultsTransfers.Fail
-        ] = BaseServiceGeneralResultsTransfers.Fail,
-    ):
-        """Decorator to handle repository-related exceptions consistently for sync and async functions."""
-
-        def decorator(func):
-            def _handler(e: Exception, category: str, description: str):
-                if logger:
-                    logger.error(
-                        f"{category} occurred while {operation}: '{str(e)}'",
-                        exc_info=True,
-                    )
-                return fail_result_class(
-                    message=f"Failed {operation}",
-                    description=description,
-                    other=category,
-                )  # type: ignore
-
-            if asyncio.iscoroutinefunction(func):
-
-                @wraps(func)
-                async def async_wrapper(*args, **kwargs):
-                    try:
-                        return await func(*args, **kwargs)
-                    except ValidationError as e:
-                        return _handler(
-                            e,
-                            category="Validation error",
-                            description=f"A validation error occurred while {operation}. Please try again later or contact administrator.",
-                        )
-                    except SQLAlchemyError as e:
-                        return _handler(
-                            e,
-                            category="Database operation failed",
-                            description=f"A database error occurred while {operation}. Please try again later or contact administrator.",
-                        )
-                    except Exception as e:
-                        return _handler(
-                            e,
-                            category="Internal processing error",
-                            description=f"An unexpected error occurred while {operation}. Please try again later or contact administrator.",
-                        )
-
-                return async_wrapper
-            else:
-
-                @wraps(func)
-                def sync_wrapper(*args, **kwargs):
-                    try:
-                        return func(*args, **kwargs)
-                    except ValidationError as e:
-                        return _handler(
-                            e,
-                            category="Validation error",
-                            description=f"A validation error occurred while {operation}. Please try again later or contact administrator.",
-                        )
-                    except SQLAlchemyError as e:
-                        return _handler(
-                            e,
-                            category="Database operation failed",
-                            description=f"A database error occurred while {operation}. Please try again later or contact administrator.",
-                        )
-                    except Exception as e:
-                        return _handler(
-                            e,
-                            category="Internal processing error",
-                            description=f"An unexpected error occurred while {operation}. Please try again later or contact administrator.",
-                        )
-
-                return sync_wrapper
-
-        return decorator
-
-    @staticmethod
-    def service_exception_handler(
-        operation: str,
-        logger: Optional[BaseLogger] = None,
-        fail_result_class: type[
-            BaseServiceGeneralResultsTransfers.Fail
-        ] = BaseServiceGeneralResultsTransfers.Fail,
-    ):
-        """Decorator to handle service-related exceptions consistently."""
-
-        def decorator(func):
-            @wraps(func)
-            def wrapper(*args, **kwargs):
-                try:
-                    return func(*args, **kwargs)
-                except Exception as e:
-                    if logger:
-                        logger.error(
-                            "Unexpected error occurred while %s: '%s'",
-                            operation,
-                            str(e),
-                            exc_info=True,
-                        )
-                    return fail_result_class(
-                        message=f"Failed {operation}",
-                        description=f"An unexpected error occurred while {operation}. Please try again later or contact administrator.",
-                        other="Internal processing error",
-                    )  # type: ignore
-
-            return wrapper
-
-        return decorator