maleo-foundation 0.3.55__tar.gz → 0.3.58__tar.gz

{maleo_foundation-0.3.55 → maleo_foundation-0.3.58}/PKG-INFO

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

{maleo_foundation-0.3.55 → maleo_foundation-0.3.58}/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-0.3.55 → maleo_foundation-0.3.58}/maleo_foundation/managers/client/maleo.py

@@ -1,4 +1,5 @@
 from pydantic import ConfigDict, Field
+from maleo_foundation.enums import BaseEnums
 from maleo_foundation.managers.client.base import (
     ClientManager,
     ClientHTTPControllerManager,
@@ -33,11 +34,22 @@ class MaleoClientServiceControllers(ClientServiceControllers):
 
 
 class MaleoClientService(ClientService):
-    def __init__(self, key: str, logger: ClientLogger, service_manager: ServiceManager):
+    def __init__(
+        self,
+        environment: BaseEnums.EnvironmentType,
+        key: str,
+        logger: ClientLogger,
+        service_manager: ServiceManager,
+    ):
         super().__init__(logger)
+        self._environment = environment
         self._key = key
         self._service_manager = service_manager
 
+    @property
+    def environment(self) -> BaseEnums.EnvironmentType:
+        return self._environment
+
     @property
     def key(self) -> str:
         return self._key
@@ -48,7 +60,14 @@ class MaleoClientService(ClientService):
 
 
 class MaleoClientManager(ClientManager):
-    def __init__(self, key: str, name: str, url: str, service_manager: ServiceManager):
+    def __init__(
+        self,
+        environment: BaseEnums.EnvironmentType,
+        key: str,
+        name: str,
+        url: str,
+        service_manager: ServiceManager,
+    ):
         self._url = url
         self._service_manager = service_manager
         super().__init__(
@@ -57,11 +76,16 @@ class MaleoClientManager(ClientManager):
             service_manager.log_config,
             service_manager.configurations.service.key,
         )
+        self._environment = environment
 
     @property
     def service_manager(self) -> ServiceManager:
         return self._service_manager
 
+    @property
+    def environment(self) -> BaseEnums.EnvironmentType:
+        return self._environment
+
     def _initialize_controllers(self) -> None:
         # * Initialize managers
         http_controller_manager = ClientHTTPControllerManager(url=self._url)

{maleo_foundation-0.3.55 → maleo_foundation-0.3.58}/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-0.3.55 → maleo_foundation-0.3.58}/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-0.3.55 → maleo_foundation-0.3.58}/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-0.3.55 → maleo_foundation-0.3.58}/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-0.3.55 → maleo_foundation-0.3.58}/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-0.3.55 → maleo_foundation-0.3.58}/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-0.3.58/maleo_foundation/models/transfers/results/client/controllers/http.py

@@ -0,0 +1,41 @@
+from __future__ import annotations
+from httpx import Response
+from pydantic import BaseModel, ConfigDict, Field, model_validator
+from typing import Any, Self
+
+
+class BaseClientHTTPControllerResults(BaseModel):
+    model_config = ConfigDict(arbitrary_types_allowed=True)
+
+    response: Response = Field(..., description="Client's HTTP Controller 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
+
+    @property
+    def status_code(self) -> int:
+        """Get the status code of the response."""
+        return self.response.status_code
+
+    @property
+    def success(self) -> bool:
+        """Get the success status of the response."""
+        return self.response.is_success
+
+    @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-0.3.55 → maleo_foundation-0.3.58}/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-0.3.55 → maleo_foundation-0.3.58}/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-0.3.55 → maleo_foundation-0.3.58}/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