maleo-foundation 0.3.66__py3-none-any.whl → 0.3.68__py3-none-any.whl

maleo_foundation/managers/service.py

@@ -1,5 +1,6 @@
 from fastapi import FastAPI, APIRouter
 from fastapi.exceptions import RequestValidationError
+from google.cloud import pubsub_v1
 from google.oauth2.service_account import Credentials
 from redis.asyncio.client import Redis
 from redis.exceptions import RedisError
@@ -72,6 +73,7 @@ class ServiceManager:
         self._load_keys()
         self._initialize_loggers()
         self._initialize_database()
+        self._initialize_publisher()
         self._initialize_foundation()
 
     @property
@@ -224,6 +226,13 @@ class ServiceManager:
     def database(self) -> DatabaseManager:
         return self._database
 
+    def _initialize_publisher(self) -> None:
+        self._publisher = pubsub_v1.PublisherClient()
+
+    @property
+    def publisher(self) -> pubsub_v1.PublisherClient:
+        return self._publisher
+
     def _initialize_foundation(self) -> None:
         self._foundation = MaleoFoundationClientManager(
             log_config=self._log_config, service_key=self._settings.SERVICE_KEY

maleo_foundation/models/schemas/general.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 from datetime import datetime, timezone
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, Field, model_validator
+from typing import Any, Optional, Self
 from uuid import UUID
 from maleo_foundation.enums import BaseEnums
 from maleo_foundation.types import BaseTypes
@@ -22,6 +23,135 @@ class BaseGeneralSchemas:
             10, ge=1, le=100, description="Page size, must be 1 <= limit <= 100."
         )
 
+    # * ----- ----- ----- Operation ----- ----- ----- *#
+    class OperationArguments(BaseModel):
+        positional: BaseTypes.ListOfAny = Field([], description="Positional arguments")
+        keyword: BaseTypes.StringToAnyDict = Field({}, description="Keyword arguments")
+
+    class OperationContext(BaseModel):
+        origin: BaseEnums.OperationOrigin = Field(..., description="Operation's origin")
+        client_key: BaseTypes.OptionalString = Field(None, description="Client's key")
+        layer: BaseEnums.OperationLayer = Field(..., description="Operation's layer")
+        target: Optional[BaseEnums.OperationTarget] = Field(
+            None, description="Operation's target (optional)"
+        )
+        environment: Optional[BaseEnums.EnvironmentType] = Field(
+            None, description="Operation's target's environment (optional)"
+        )
+        target_name: BaseTypes.OptionalString = Field(
+            None, description="Operation's target's name (optional)"
+        )
+        target_resource: BaseTypes.OptionalString = Field(
+            None, description="Operation's target's resource (optional)"
+        )
+
+    class OperationMetadata(BaseModel):
+        type: BaseEnums.OperationType = Field(..., description="Operation's 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)"
+        )
+        summary: BaseTypes.OptionalString = Field(
+            None, description="Summary (optional)"
+        )
+
+        @model_validator(mode="after")
+        def validate_operation_types(self) -> Self:
+            # Validate create operation type
+            if self.type is BaseEnums.OperationType.CREATE:
+                if self.create_type is None:
+                    raise ValueError(
+                        "'create_type' must have value if 'type' is 'create'"
+                    )
+                if self.create_type not in BaseEnums.CreateType:
+                    raise ValueError(
+                        f"'create_type' must be one of {[e.value for e in BaseEnums.CreateType]}"
+                    )
+
+            # Validate update operation type
+            if self.type is BaseEnums.OperationType.UPDATE:
+                if self.update_type is None:
+                    raise ValueError(
+                        "'update_type' must have value if 'type' is 'update'"
+                    )
+                if self.update_type not in BaseEnums.UpdateType:
+                    raise ValueError(
+                        f"'update_type' must be one of {[e.value for e in BaseEnums.UpdateType]}"
+                    )
+                if self.update_type is BaseEnums.UpdateType.STATUS:
+                    if self.status_update_type is None:
+                        raise ValueError(
+                            "'status_update_type' must have value if 'update_type' is 'status'"
+                        )
+                    if self.status_update_type not in BaseEnums.StatusUpdateType:
+                        raise ValueError(
+                            f"'status_update_type' must be one of {[e.value for e in BaseEnums.StatusUpdateType]}"
+                        )
+
+            return self
+
+    class OperationServiceContext(BaseModel):
+        key: BaseEnums.Service = Field(..., description="Service's key")
+        environment: BaseEnums.EnvironmentType = Field(
+            ..., description="Service's environment"
+        )
+
+    class OperationTimestamps(BaseModel):
+        started_at: BaseTypes.OptionalDatetime = Field(
+            None, description="Started at timestamp (Optional)"
+        )
+        finished_at: BaseTypes.OptionalDatetime = Field(
+            None, description="Finished at timestamp (Optional)"
+        )
+        duration: float = Field(0, description="Operation duration")
+
+        @model_validator(mode="after")
+        def calculate_duration(self) -> Self:
+            if self.started_at is not None and self.finished_at is not None:
+                self.duration = (self.finished_at - self.started_at).total_seconds()
+
+            return self
+
+    class OperationResult(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: BaseTypes.OptionalAny = Field(None, description="Optional metadata")
+        other: BaseTypes.OptionalAny = Field(
+            None, description="Optional other information"
+        )
+
+    class DatabaseOperationContext(BaseModel):
+        database: str = Field(..., description="Database name")
+        environment: BaseEnums.EnvironmentType = Field(
+            ..., description="Database environment"
+        )
+        table: str = Field(..., description="Table name")
+
+    class DatabaseOperationResult(BaseModel):
+        data_id: int = Field(..., ge=1, description="Data's ID")
+        old_data: BaseTypes.OptionalStringToAnyDict = Field(
+            None, description="Old data"
+        )
+        new_data: BaseTypes.OptionalStringToAnyDict = Field(
+            None, description="New data"
+        )
+
+        @model_validator(mode="after")
+        def validate_data(self) -> Self:
+            if self.old_data is None and self.new_data is None:
+                raise ValueError("Either 'old_data' or 'new_data' must have value")
+            return self
+
     # * ----- ----- ----- Data ----- ----- ----- *#
     class Identifiers(BaseModel):
         id: int = Field(..., ge=1, description="Data's ID, must be >= 1.")
@@ -49,6 +179,9 @@ class BaseGeneralSchemas:
     class Status(BaseModel):
         status: BaseEnums.StatusType = Field(..., description="Data's status")
 
+    class DataMixin(Status, Timestamps, Identifiers):
+        pass
+
     class IsDefault(BaseModel):
         is_default: BaseTypes.OptionalBoolean = Field(
             None, description="Whether data is default"

maleo_foundation/models/transfers/general/operation.py

@@ -0,0 +1,51 @@
+from pydantic import BaseModel, Field
+from typing import Optional
+from .request import RequestContext
+from maleo_foundation.authentication import Authentication
+from maleo_foundation.authorization import Authorization
+from maleo_foundation.models.schemas.general import BaseGeneralSchemas
+
+
+class Operation(BaseModel):
+    request_context: RequestContext = Field(..., description="Request context")
+    authentication: Authentication = Field(..., description="Authentication")
+    authorization: Optional[Authorization] = Field(None, description="Authorization")
+    service: BaseGeneralSchemas.OperationServiceContext = Field(
+        ..., description="Service's context"
+    )
+    timestamps: BaseGeneralSchemas.OperationTimestamps = Field(
+        ..., description="Operation's timestamps"
+    )
+    context: BaseGeneralSchemas.OperationContext = Field(
+        ..., description="Operation's context"
+    )
+    metadata: BaseGeneralSchemas.OperationMetadata = Field(
+        ..., description="Operation's metadata"
+    )
+    arguments: BaseGeneralSchemas.OperationArguments = Field(
+        ..., description="Operation's arguments"
+    )
+    result: BaseGeneralSchemas.OperationResult = Field(
+        ..., description="Database operation's result"
+    )
+
+
+class DatabaseOperation(BaseModel):
+    request_context: RequestContext = Field(..., description="Request context")
+    authentication: Authentication = Field(..., description="Authentication")
+    authorization: Optional[Authorization] = Field(None, description="Authorization")
+    service: BaseGeneralSchemas.OperationServiceContext = Field(
+        ..., description="Service's context"
+    )
+    timestamps: BaseGeneralSchemas.OperationTimestamps = Field(
+        ..., description="Operation's timestamps"
+    )
+    context: BaseGeneralSchemas.DatabaseOperationContext = Field(
+        ..., description="Database operation's context"
+    )
+    metadata: BaseGeneralSchemas.OperationMetadata = Field(
+        ..., description="Operation's metadata"
+    )
+    result: BaseGeneralSchemas.DatabaseOperationResult = Field(
+        ..., description="Database operation's result"
+    )

{maleo_foundation-0.3.66.dist-info → maleo_foundation-0.3.68.dist-info}/METADATA

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

{maleo_foundation-0.3.66.dist-info → maleo_foundation-0.3.68.dist-info}/RECORD

@@ -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=YRG1cLc7yGytDXzOe-btKJ5K0YRHJfkgfGF3D5h3ty4,11795
+maleo_foundation/managers/service.py,sha256=ebmKAXC02R4q_ZXXKCGgQm_SLMzLEKOleZZlD-z5N0s,12067
 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=aNh3I9EsxeD2rqx5WaXbZ5fjyyXVzvppHJiC98jJYfM,3163
@@ -54,7 +54,7 @@ maleo_foundation/models/responses.py,sha256=WNAz67ewOyWV0oHyiB_BF_-sfaoDF-FVzcwg
 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
-maleo_foundation/models/schemas/general.py,sha256=jxzBsVGsdKKEiM14MfV47dDiAZalUK4RnTlq8S36Qus,4060
+maleo_foundation/models/schemas/general.py,sha256=Vscc4BsAFUzozYXf_nCwswr3HX0t9QJ3NOb06SjWFdo,10064
 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
@@ -67,6 +67,7 @@ maleo_foundation/models/transfers/general/credentials.py,sha256=t6OhQb3DyGSfBpbq
 maleo_foundation/models/transfers/general/data.py,sha256=_J-Y5X2Nx8D1lpaR9ctpm54kUbxR7Vy00hO103uXtxE,1408
 maleo_foundation/models/transfers/general/database.py,sha256=VQYnZa8dYrqucSQdzkaPSrzLd4SJnpU8LPytUrWErO0,1245
 maleo_foundation/models/transfers/general/key.py,sha256=QV_kcxAlnrupBcGQK8tqz9FVYbivxwhgIsrmW7XDdME,845
+maleo_foundation/models/transfers/general/operation.py,sha256=M3DraArkFhgjNvA1StWfyS7W0Jhy3hIcdUWUYXlt7Do,2143
 maleo_foundation/models/transfers/general/request.py,sha256=W2aKxo0lQ-kV-4XpQEzxxa-odwLlGfOulh_wQKgcz9o,1920
 maleo_foundation/models/transfers/general/settings.py,sha256=1QkPq6GP33S5R718be3XBz0BCtApAuxlL-x21EZ2Xmo,1609
 maleo_foundation/models/transfers/general/signature.py,sha256=TCTIy928EeBBeFLlyQ3_NozpR9FUcWXPQKIYIwyj66k,308
@@ -137,7 +138,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.66.dist-info/METADATA,sha256=4NJIYuPP7pJbPrmI04VLqpmE0SGH9WloO9RjQlbNYkc,4150
-maleo_foundation-0.3.66.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-maleo_foundation-0.3.66.dist-info/top_level.txt,sha256=_iBos3F_bhEOdjOnzeiEYSrCucasc810xXtLBXI8cQc,17
-maleo_foundation-0.3.66.dist-info/RECORD,,
+maleo_foundation-0.3.68.dist-info/METADATA,sha256=xrOYCviMG8PrD0Nstd4wSY_RMJlwaB-Nn0yBAwVTC34,4150
+maleo_foundation-0.3.68.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+maleo_foundation-0.3.68.dist-info/top_level.txt,sha256=_iBos3F_bhEOdjOnzeiEYSrCucasc810xXtLBXI8cQc,17
+maleo_foundation-0.3.68.dist-info/RECORD,,