maleo-foundation 0.2.96__py3-none-any.whl → 0.2.98__py3-none-any.whl

maleo_foundation/models/schemas/general.py

@@ -7,32 +7,32 @@ from maleo_foundation.types import BaseTypes
 
 class BaseGeneralSchemas:
     class DateFilter(BaseModel):
-        name:str = Field(..., description="Column name.")
-        from_date:BaseTypes.OptionalDatetime = Field(None, description="From date.")
-        to_date:BaseTypes.OptionalDatetime = Field(None, description="To date.")
+        name: str = Field(..., description="Column name.")
+        from_date: BaseTypes.OptionalDatetime = Field(None, description="From date.")
+        to_date: BaseTypes.OptionalDatetime = Field(None, description="To date.")
 
     class SortColumn(BaseModel):
-        name:str = Field(..., description="Column name.")
-        order:BaseEnums.SortOrder = Field(..., description="Sort order.")
+        name: str = Field(..., description="Column name.")
+        order: BaseEnums.SortOrder = Field(..., description="Sort order.")
 
     class SimplePagination(BaseModel):
-        page:int = Field(1, ge=1, description="Page number, must be >= 1.")
-        limit:int = Field(10, ge=1, le=100, description="Page size, must be 1 <= limit <= 100.")
+        page: int = Field(1, ge=1, description="Page number, must be >= 1.")
+        limit: int = Field(10, ge=1, le=100, description="Page size, must be 1 <= limit <= 100.")
 
     #* ----- ----- ----- Data ----- ----- ----- *#
     class Identifiers(BaseModel):
-        id:int = Field(..., ge=1, description="Data's ID, must be >= 1.")
-        uuid:UUID = Field(..., description="Data's UUID.")
+        id: int = Field(..., ge=1, description="Data's ID, must be >= 1.")
+        uuid: UUID = Field(..., description="Data's UUID.")
 
     class EssentialTimestamps(BaseModel):
-        created_at:datetime = Field(..., description="Data's created_at timestamp")
-        updated_at:datetime = Field(..., description="Data's updated_at timestamp")
+        created_at: datetime = Field(..., description="Data's created_at timestamp")
+        updated_at: datetime = Field(..., description="Data's updated_at timestamp")
 
     class StatusTimestamps(BaseModel):
-        deleted_at:BaseTypes.OptionalDatetime = Field(..., description="Data's deleted_at timestamp")
-        restored_at:BaseTypes.OptionalDatetime = Field(..., description="Data's restored_at timestamp")
-        deactivated_at:BaseTypes.OptionalDatetime = Field(..., description="Data's deactivated_at timestamp")
-        activated_at:datetime = Field(..., description="Data's activated_at timestamp")
+        deleted_at: BaseTypes.OptionalDatetime = Field(..., description="Data's deleted_at timestamp")
+        restored_at: BaseTypes.OptionalDatetime = Field(..., description="Data's restored_at timestamp")
+        deactivated_at: BaseTypes.OptionalDatetime = Field(..., description="Data's deactivated_at timestamp")
+        activated_at: datetime = Field(..., description="Data's activated_at timestamp")
 
     class Timestamps(
         StatusTimestamps,
@@ -40,54 +40,54 @@ class BaseGeneralSchemas:
     ): pass
 
     class Status(BaseModel):
-        status:BaseEnums.StatusType = Field(..., description="Data's status")
+        status: BaseEnums.StatusType = Field(..., description="Data's status")
 
     class IsDefault(BaseModel):
-        is_default:BaseTypes.OptionalBoolean = Field(None, description="Whether data is default")
+        is_default: BaseTypes.OptionalBoolean = Field(None, description="Whether data is default")
 
     class IsRoot(BaseModel):
-        is_root:BaseTypes.OptionalBoolean = Field(None, description="Whether data is root")
+        is_root: BaseTypes.OptionalBoolean = Field(None, description="Whether data is root")
 
     class IsParent(BaseModel):
-        is_parent:BaseTypes.OptionalBoolean = Field(None, description="Whether data is parent")
+        is_parent: BaseTypes.OptionalBoolean = Field(None, description="Whether data is parent")
 
     class IsChild(BaseModel):
-        is_child:BaseTypes.OptionalBoolean = Field(None, description="Whether data is child")
+        is_child: BaseTypes.OptionalBoolean = Field(None, description="Whether data is child")
 
     class IsLeaf(BaseModel):
-        is_leaf:BaseTypes.OptionalBoolean = Field(None, description="Whether data is leaf")
+        is_leaf: BaseTypes.OptionalBoolean = Field(None, description="Whether data is leaf")
 
     class Order(BaseModel):
-        order:BaseTypes.OptionalInteger = Field(..., description="Data's order")
+        order: BaseTypes.OptionalInteger = Field(..., description="Data's order")
 
     class Code(BaseModel):
-        code:str = Field(..., description="Data's code")
+        code: str = Field(..., description="Data's code")
 
     class Key(BaseModel):
-        key:str = Field(..., description="Data's key")
+        key: str = Field(..., description="Data's key")
 
     class Name(BaseModel):
-        name:str = Field(..., description="Data's name")
+        name: str = Field(..., description="Data's name")
 
     class Secret(BaseModel):
-        secret:UUID = Field(..., description="Data's secret")
+        secret: UUID = Field(..., description="Data's secret")
 
     #* ----- ----- ----- RSA Key ----- ----- ----- *#
     class PrivateKey(BaseModel):
-        private_key:str = Field(..., description="Private key in str format.")
+        private_key: str = Field(..., description="Private key in str format.")
 
     class PublicKey(BaseModel):
-        public_key:str = Field(..., description="Public key in str format.")
+        public_key: str = Field(..., description="Public key in str format.")
 
     class KeyPair(PublicKey, PrivateKey): pass
 
     class RSAKeys(BaseModel):
-        password:str = Field(..., description="Key's password")
-        private:str = Field(..., description="Private key")
-        public:str = Field(..., description="Public key")
+        password: str = Field(..., description="Key's password")
+        private: str = Field(..., description="Private key")
+        public: str = Field(..., description="Public key")
 
     class AccessedAt(BaseModel):
-        accessed_at:datetime = Field(datetime.now(tz=timezone.utc), description="Accessed at")
+        accessed_at: datetime = Field(datetime.now(tz=timezone.utc), description="Accessed at")
 
     class AccessedBy(BaseModel):
-        accessed_by:int = Field(0, ge=0, description="Accessed by")
+        accessed_by: int = Field(0, ge=0, description="Accessed by")

maleo_foundation/models/schemas/hash.py

@@ -3,13 +3,13 @@ from pydantic import BaseModel, Field
 
 class MaleoFoundationHashSchemas:
     class Key(BaseModel):
-        key:str = Field(..., description="Key")
+        key: str = Field(..., description="Key")
 
     class Message(BaseModel):
-        message:str = Field(..., description="Message")
+        message: str = Field(..., description="Message")
 
     class Hash(BaseModel):
-        hash:str = Field(..., description="Hash")
+        hash: str = Field(..., description="Hash")
 
     class IsValid(BaseModel):
-        is_valid:bool = Field(..., description="Is valid hash")
+        is_valid: bool = Field(..., description="Is valid hash")

maleo_foundation/models/schemas/key.py

@@ -5,11 +5,11 @@ from maleo_foundation.types import BaseTypes
 
 class BaseKeySchemas:
     class KeySize(BaseModel):
-        key_size:int = Field(2048, ge=2048, le=16384, description="Key's size")
+        key_size: int = Field(2048, ge=2048, le=16384, description="Key's size")
 
     class Password(BaseModel):
-        password:BaseTypes.OptionalString = Field(None, min_length=32, max_length=1024, description="password")
+        password: BaseTypes.OptionalString = Field(None, min_length=32, max_length=1024, description="password")
 
     class Key(BaseModel):
-        type:BaseEnums.KeyType = Field(..., description="Key's type")
-        value:str = Field(..., description="Key's value")
+        type: BaseEnums.KeyType = Field(..., description="Key's type")
+        value: str = Field(..., description="Key's value")

maleo_foundation/models/schemas/parameter.py

@@ -9,19 +9,19 @@ from maleo_foundation.extended_types import ExtendedTypes
 
 class BaseParameterSchemas:
     class IdentifierType(BaseModel):
-        identifier:BaseEnums.IdentifierTypes = Field(..., description="Data's identifier type")
+        identifier: BaseEnums.IdentifierTypes = Field(..., description="Data's identifier type")
 
     class IdentifierValue(BaseModel):
-        value:BaseTypes.IdentifierValue = Field(..., description="Data's identifier value")
+        value: BaseTypes.IdentifierValue = Field(..., description="Data's identifier value")
 
     class OptionalListOfIds(BaseModel):
-        ids:BaseTypes.OptionalListOfIntegers = Field(None, description="Specific Ids")
+        ids: BaseTypes.OptionalListOfIntegers = Field(None, description="Specific Ids")
 
     class OptionalListOfUuids(BaseModel):
-        uuids:BaseTypes.OptionalListOfUUIDs = Field(None, description="Specific Uuids")
+        uuids: BaseTypes.OptionalListOfUUIDs = Field(None, description="Specific Uuids")
 
     class Filters(BaseModel):
-        filters:BaseTypes.ListOfStrings = Field([], description="Filters for date range, e.g. 'created_at|from::<ISO_DATETIME>|to::<ISO_DATETIME>'.")
+        filters: BaseTypes.ListOfStrings = Field([], description="Filters for date range, e.g. 'created_at|from::<ISO_DATETIME>|to::<ISO_DATETIME>'.")
 
         @field_validator("filters")
         @classmethod
@@ -38,25 +38,25 @@ class BaseParameterSchemas:
                 return final_values
 
     class DateFilters(BaseModel):
-        date_filters:ExtendedTypes.ListOfDateFilters = Field([], description="Date filters to be applied")
+        date_filters: ExtendedTypes.ListOfDateFilters = Field([], description="Date filters to be applied")
 
     class OptionalListOfStatuses(BaseModel):
-        statuses:BaseTypes.OptionalListOfStatuses = Field(None, description="Data's status")
+        statuses: BaseTypes.OptionalListOfStatuses = Field(None, description="Data's status")
 
     class OptionalListOfCodes(BaseModel):
-        codes:BaseTypes.OptionalListOfStrings = Field(None, description="Specific Codes")
+        codes: BaseTypes.OptionalListOfStrings = Field(None, description="Specific Codes")
 
     class OptionalListOfKeys(BaseModel):
-        keys:BaseTypes.OptionalListOfStrings = Field(None, description="Specific Keys")
+        keys: BaseTypes.OptionalListOfStrings = Field(None, description="Specific Keys")
 
     class OptionalListOfNames(BaseModel):
-        names:BaseTypes.OptionalListOfStrings = Field(None, description="Specific Names")
+        names: BaseTypes.OptionalListOfStrings = Field(None, description="Specific Names")
 
     class Search(BaseModel):
-        search:BaseTypes.OptionalString = Field(None, description="Search string.")
+        search: BaseTypes.OptionalString = Field(None, description="Search string.")
 
     class Sorts(BaseModel):
-        sorts:BaseTypes.ListOfStrings = Field(["id.asc"], description="Sorting columns in 'column_name.asc' or 'column_name.desc' format.")
+        sorts: BaseTypes.ListOfStrings = Field(["id.asc"], description="Sorting columns in 'column_name.asc' or 'column_name.desc' format.")
 
         @field_validator("sorts")
         @classmethod
@@ -64,10 +64,10 @@ class BaseParameterSchemas:
             return [value for value in values if SORT_COLUMN_PATTERN.match(value)]
 
     class SortColumns(BaseModel):
-        sort_columns:ExtendedTypes.ListOfSortColumns = Field([BaseGeneralSchemas.SortColumn(name="id", order=BaseEnums.SortOrder.ASC)], description="List of columns to be sorted")
+        sort_columns: ExtendedTypes.ListOfSortColumns = Field([BaseGeneralSchemas.SortColumn(name="id", order=BaseEnums.SortOrder.ASC)], description="List of columns to be sorted")
 
     class Expand(BaseModel):
-        expand:BaseTypes.OptionalListOfStrings = Field(None, description="Expanded field(s)")
+        expand: BaseTypes.OptionalListOfStrings = Field(None, description="Expanded field(s)")
 
     class Data(BaseModel):
-        data:BaseTypes.StringToAnyDict = Field(..., description="Data")
+        data: BaseTypes.StringToAnyDict = Field(..., description="Data")

maleo_foundation/models/schemas/result.py

@@ -4,79 +4,79 @@ from maleo_foundation.models.schemas.general import BaseGeneralSchemas
 from maleo_foundation.types import BaseTypes
 
 class FieldExpansionMetadata(BaseModel):
-    success:bool = Field(..., description="Field expansion's 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")
-    other:BaseTypes.OptionalAny = Field(None, description="Optional other information")
+    success: bool = Field(..., description="Field expansion's 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")
+    other: BaseTypes.OptionalAny = Field(None, description="Optional other information")
 
 class ResultMetadata(BaseModel):
-    field_expansion:Optional[Union[str, Dict[str, FieldExpansionMetadata]]] = Field(None, description="Field expansion metadata")
+    field_expansion: Optional[Union[str, Dict[str, FieldExpansionMetadata]]] = Field(None, description="Field expansion metadata")
 
 class BaseResultSchemas:
     class ExtendedPagination(BaseGeneralSchemas.SimplePagination):
-        data_count:int = Field(..., description="Fetched data count")
-        total_data:int = Field(..., description="Total data count")
-        total_pages:int = Field(..., description="Total pages count")
+        data_count: int = Field(..., description="Fetched data count")
+        total_data: int = Field(..., description="Total data count")
+        total_pages: int = Field(..., description="Total pages count")
 
     #* ----- ----- ----- 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")
+        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):
-        code:str = "MAL-FAI-001"
-        message:str = "Fail result"
-        description:str = "Operation failed."
-        success:BaseTypes.LiteralFalse = Field(False, description="Success status")
-        data:None = Field(None, description="No data")
+        code: str = "MAL-FAI-001"
+        message: str = "Fail result"
+        description: str = "Operation failed."
+        success: BaseTypes.LiteralFalse = Field(False, description="Success status")
+        data: None = Field(None, description="No data")
 
     class Success(Base):
-        success:BaseTypes.LiteralTrue = Field(True, description="Success status")
-        code:str = "MAL-SCS-001"
-        message:str = "Success result"
-        description:str = "Operation succeeded."
-        data:Any = Field(..., description="Data")
+        success: BaseTypes.LiteralTrue = Field(True, description="Success status")
+        code: str = "MAL-SCS-001"
+        message: str = "Success result"
+        description: str = "Operation succeeded."
+        data: Any = Field(..., description="Data")
 
     #* ----- ----- ----- Derived ----- ----- ----- *#
     class NotFound(Fail):
-        code:str = "MAL-NTF-001"
-        message:str = "Resource not found"
-        description:str = "The requested resource can not be found."
-        data:None = Field(None, description="No data")
+        code: str = "MAL-NTF-001"
+        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"
-        message:str = "No data found"
-        description:str = "No data found in the requested resource."
-        data:None = Field(None, description="No data")
+        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")
+        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")
+        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(
         UnpaginatedMultipleData,
         BaseGeneralSchemas.SimplePagination
     ):
-        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")
+        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")
 
 BaseResultSchemas.PaginatedMultipleData.model_rebuild()

maleo_foundation/models/schemas/signature.py

@@ -3,16 +3,16 @@ from maleo_foundation.types import BaseTypes
 
 class MaleoFoundationSignatureSchemas:
     class Key(BaseModel):
-        key:str = Field(..., description="Key")
+        key: str = Field(..., description="Key")
 
     class Password(BaseModel):
-        password:BaseTypes.OptionalString = Field(None, min_length=32, max_length=1024, description="password")
+        password: BaseTypes.OptionalString = Field(None, min_length=32, max_length=1024, description="password")
 
     class Message(BaseModel):
-        message:str = Field(..., description="Message")
+        message: str = Field(..., description="Message")
 
     class Signature(BaseModel):
-        signature:str = Field(..., description="Signature")
+        signature: str = Field(..., description="Signature")
 
     class IsValid(BaseModel):
-        is_valid:bool = Field(..., description="Is valid signature")
+        is_valid: bool = Field(..., description="Is valid signature")

maleo_foundation/models/schemas/token.py

@@ -4,13 +4,13 @@ from maleo_foundation.types import BaseTypes
 
 class MaleoFoundationTokenSchemas:
     class Key(BaseModel):
-        key:str = Field(..., description="Key")
+        key: str = Field(..., description="Key")
 
     class Password(BaseModel):
-        password:BaseTypes.OptionalString = Field(None, min_length=32, max_length=1024, description="password")
+        password: BaseTypes.OptionalString = Field(None, min_length=32, max_length=1024, description="password")
 
     class Token(BaseModel):
-        token:str = Field(..., description="Token")
+        token: str = Field(..., description="Token")
 
     class ExpIn(BaseModel):
-        exp_in:int = Field(15, ge=1, description="Expires in (integer, minutes)")
+        exp_in: int = Field(15, ge=1, description="Expires in (integer, minutes)")

maleo_foundation/models/transfers/general/__init__.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 from datetime import datetime, timezone
 from pydantic import BaseModel, Field
-from typing import Dict
+from typing import Dict, Any
 from uuid import UUID
 from maleo_foundation.models.schemas.general import BaseGeneralSchemas
 from maleo_foundation.types import BaseTypes
@@ -16,20 +16,65 @@ class AccessTransfers(
 ): pass
 
 class RequestContextTransfers(BaseModel):
-    request_id:UUID = Field(..., description="Unique identifier for tracing the request")
-    requested_at:datetime = Field(datetime.now(tz=timezone.utc), description="Request timestamp")
-    method:str = Field(..., description="Request's method")
-    url:str = Field(..., description="Request's URL")
-    path_params:Dict = Field(..., description="Request's path parameters")
-    query_params:Dict = Field(..., description="Request's query parameters")
-    ip_address:str = Field("unknown", description="Client's IP address")
-    is_internal:BaseTypes.OptionalBoolean = Field(None, description="True if IP is internal")
-    user_agent:BaseTypes.OptionalString = Field(None, description="User-Agent string")
-    ua_browser:BaseTypes.OptionalString = Field(None, description="Browser info from sec-ch-ua")
-    ua_mobile:BaseTypes.OptionalString = Field(None, description="Is mobile device?")
-    platform:BaseTypes.OptionalString = Field(None, description="Client platform or OS")
-    referer:BaseTypes.OptionalString = Field(None, description="Referrer URL")
-    origin:BaseTypes.OptionalString = Field(None, description="Origin of the request")
-    host:BaseTypes.OptionalString = Field(None, description="Host header from request")
-    forwarded_proto:BaseTypes.OptionalString = Field(None, description="Forwarded protocol (http/https)")
-    language:BaseTypes.OptionalString = Field(None, description="Accepted languages from client")
+    request_id: UUID = Field(..., description="Unique identifier for tracing the request")
+    requested_at: datetime = Field(datetime.now(tz=timezone.utc), description="Request timestamp")
+    method: str = Field(..., description="Request's method")
+    url: str = Field(..., description="Request's URL")
+    path_params: Dict = Field(..., description="Request's path parameters")
+    query_params: Dict = Field(..., description="Request's query parameters")
+    ip_address: str = Field("unknown", description="Client's IP address")
+    is_internal: BaseTypes.OptionalBoolean = Field(None, description="True if IP is internal")
+    user_agent: BaseTypes.OptionalString = Field(None, description="User-Agent string")
+    ua_browser: BaseTypes.OptionalString = Field(None, description="Browser info from sec-ch-ua")
+    ua_mobile: BaseTypes.OptionalString = Field(None, description="Is mobile device?")
+    platform: BaseTypes.OptionalString = Field(None, description="Client platform or OS")
+    referer: BaseTypes.OptionalString = Field(None, description="Referrer URL")
+    origin: BaseTypes.OptionalString = Field(None, description="Origin of the request")
+    host: BaseTypes.OptionalString = Field(None, description="Host header from request")
+    forwarded_proto: BaseTypes.OptionalString = Field(None, description="Forwarded protocol (http/https)")
+    language: BaseTypes.OptionalString = Field(None, description="Accepted languages from client")
+
+    def to_google_pubsub_object(self) -> Dict[str, Any]:
+        result = {
+            "request_id": str(self.request_id),
+            "requested_at": self.requested_at.isoformat(),
+            "method": self.method,
+            "url": self.url,
+            "path_params": {"map": self.path_params},
+            "query_params": {"map": self.query_params},
+            "ip_address": self.ip_address,
+            "is_internal": None if self.is_internal is None else {"boolean": self.is_internal},
+            "user_agent": None if self.user_agent is None else {"string": self.user_agent},
+            "ua_browser": None if self.ua_browser is None else {"string": self.ua_browser},
+            "ua_mobile": None if self.ua_mobile is None else {"string": self.ua_mobile},
+            "platform": None if self.platform is None else {"string": self.platform},
+            "referer": None if self.referer is None else {"array": self.referer},
+            "origin": None if self.origin is None else {"array": self.origin},
+            "host": None if self.host is None else {"array": self.host},
+            "forwarded_proto": None if self.forwarded_proto is None else {"array": self.forwarded_proto},
+            "language": None if self.language is None else {"array": self.language}
+        }
+
+        return result
+
+    @classmethod
+    def from_google_pubsub_object(cls, obj:Dict[str, Any]):
+        return cls(
+            request_id = UUID(obj["request_id"]),
+            requested_at = datetime.fromisoformat(obj["requested_at"]),
+            method = obj["method"],
+            url = obj["url"],
+            path_params = obj["path_params"]["map"] or {},
+            query_params = obj["query_params"]["map"] or {},
+            ip_address = obj["ip_address"],
+            is_internal = None if obj["is_internal"] is None else bool(obj["is_internal"]["boolean"]),
+            user_agent = None if obj["user_agent"] is None else obj["user_agent"]["string"],
+            ua_browser = None if obj["ua_browser"] is None else obj["ua_browser"]["string"],
+            ua_mobile = None if obj["ua_mobile"] is None else obj["ua_mobile"]["string"],
+            platform = None if obj["platform"] is None else obj["platform"]["string"],
+            referer = None if obj["referer"] is None else obj["referer"]["string"],
+            origin = None if obj["origin"] is None else obj["origin"]["string"],
+            host = None if obj["host"] is None else obj["host"]["string"],
+            forwarded_proto = None if obj["forwarded_proto"] is None else obj["forwarded_proto"]["string"],
+            language = None if obj["language"] is None else obj["language"]["string"],
+        )

maleo_foundation/models/transfers/general/key.py

@@ -5,11 +5,11 @@ from maleo_foundation.models.schemas.key import BaseKeySchemas
 
 class MaleoFoundationKeyGeneralTransfers:
     class PrivateKey(BaseKeySchemas.Key):
-        type:BaseEnums.KeyType = Field(BaseEnums.KeyType.PRIVATE, description="Private key's type")
+        type: BaseEnums.KeyType = Field(BaseEnums.KeyType.PRIVATE, description="Private key's type")
 
     class PublicKey(BaseKeySchemas.Key):
-        type:BaseEnums.KeyType = Field(BaseEnums.KeyType.PUBLIC, description="Public key's type")
+        type: BaseEnums.KeyType = Field(BaseEnums.KeyType.PUBLIC, description="Public key's type")
 
     class KeyPair(BaseModel):
-        private:MaleoFoundationKeyGeneralTransfers.PrivateKey = Field(..., description="Private key's data")
-        public:MaleoFoundationKeyGeneralTransfers.PublicKey = Field(..., description="Public key's data")
+        private: MaleoFoundationKeyGeneralTransfers.PrivateKey = Field(..., description="Private key's data")
+        public: MaleoFoundationKeyGeneralTransfers.PublicKey = Field(..., description="Public key's data")

maleo_foundation/models/transfers/general/token.py

@@ -1,37 +1,83 @@
 from __future__ import annotations
 from datetime import datetime, timedelta, timezone
 from pydantic import BaseModel, Field, model_validator
+from typing import Dict, Any
 from uuid import UUID
 from maleo_foundation.types import BaseTypes
 from maleo_foundation.models.schemas.token import MaleoFoundationTokenSchemas
 
 class MaleoFoundationTokenGeneralTransfers:
     class BasePayload(BaseModel):
-        iss:BaseTypes.OptionalString = Field(None, description="Token's issuer")
-        sub:str = Field(..., description="Token's subject")
-        sr:str = Field(..., description="System role")
-        u_i:int = Field(..., description="user's id")
-        u_uu:UUID = Field(..., description="user's uuid")
-        u_u:str = Field(..., description="user's username")
-        u_e:str = Field(..., description="user's email")
-        u_ut:str = Field(..., description="user's type")
-        o_i:BaseTypes.OptionalInteger = Field(None, description="Organization's id")
-        o_uu:BaseTypes.OptionalUUID = Field(None, description="Organization's uuid")
-        o_k:BaseTypes.OptionalString = Field(None, description="Organization's key")
-        o_ot:BaseTypes.OptionalString = Field(None, description="Organization's type")
-        uor:BaseTypes.OptionalListOfStrings = Field(None, description="User Organization Role")
+        iss: BaseTypes.OptionalString = Field(None, description="Token's issuer")
+        sub: str = Field(..., description="Token's subject")
+        sr: str = Field(..., description="System role")
+        u_i: int = Field(..., description="user's id")
+        u_uu: UUID = Field(..., description="user's uuid")
+        u_u: str = Field(..., description="user's username")
+        u_e: str = Field(..., description="user's email")
+        u_ut: str = Field(..., description="user's type")
+        o_i: BaseTypes.OptionalInteger = Field(None, description="Organization's id")
+        o_uu: BaseTypes.OptionalUUID = Field(None, description="Organization's uuid")
+        o_k: BaseTypes.OptionalString = Field(None, description="Organization's key")
+        o_ot: BaseTypes.OptionalString = Field(None, description="Organization's type")
+        uor: BaseTypes.OptionalListOfStrings = Field(None, description="User Organization Role")
 
     class DecodePayload(BasePayload):
-        iat_dt:datetime = Field(..., description="Issued at (datetime)")
-        iat:int = Field(..., description="Issued at (integer)")
-        exp_dt:datetime = Field(..., description="Expired at (datetime)")
-        exp:int = Field(..., description="Expired at (integer)")
+        iat_dt: datetime = Field(..., description="Issued at (datetime)")
+        iat: int = Field(..., description="Issued at (integer)")
+        exp_dt: datetime = Field(..., description="Expired at (datetime)")
+        exp: int = Field(..., description="Expired at (integer)")
+
+        def to_google_pubsub_object(self) -> Dict[str, Any]:
+            result = {
+                "iss": None if self.iss is None else {"string": self.iss},
+                "sub": self.sub,
+                "sr": self.sr,
+                "u_i": self.u_i,
+                "u_uu": str(self.u_uu),
+                "u_u": self.u_u,
+                "u_e": self.u_e,
+                "u_ut": self.u_ut,
+                "o_i": None if self.o_i is None else {"int": self.o_i},
+                "o_uu": None if self.o_uu is None else {"string": str(self.o_uu)},
+                "o_k": None if self.o_k is None else {"string": self.o_k},
+                "o_ot": None if self.o_ot is None else {"string": self.o_ot},
+                "uor": None if self.uor is None else {"array": self.uor},
+                "iat_dt": self.iat_dt.isoformat(),
+                "iat": self.iat,
+                "exp_dt": self.iat_dt.isoformat(),
+                "exp": self.exp
+            }
+
+            return result
+
+        @classmethod
+        def from_google_pubsub_object(cls, obj:Dict[str, Any]):
+            return cls(
+                iss = None if obj["iss"] is None else obj["iss"]["string"],
+                sub = obj["sub"],
+                sr = obj["sr"],
+                u_i = obj["u_i"],
+                u_uu = UUID(obj["u_uu"]),
+                u_u = obj["u_u"],
+                u_e = obj["u_e"],
+                u_ut = obj["u_ut"],
+                o_i = None if obj["o_i"] is None else obj["o_i"]["int"],
+                o_uu = None if obj["o_uu"] is None else UUID(obj["o_uu"]["string"]),
+                o_k = None if obj["o_k"] is None else obj["o_k"]["string"],
+                o_ot = None if obj["o_ot"] is None else obj["o_ot"]["string"],
+                uor = None if obj["uor"] is None else obj["uor"]["array"],
+                iat_dt = datetime.fromisoformat(obj["iat_dt"]),
+                iat = int(obj["iat"]),
+                exp_dt = datetime.fromisoformat(obj["exp_dt"]),
+                exp = int(obj["exp"])
+            )
 
     class BaseEncodePayload(MaleoFoundationTokenSchemas.ExpIn, BasePayload): pass
 
     class EncodePayload(DecodePayload):
-        iat_dt:datetime = Field(datetime.now(timezone.utc), description="Issued at (datetime)")
-        exp_in:int = Field(15, ge=1, description="Expires in (integer, minutes)", exclude=True)
+        iat_dt: datetime = Field(datetime.now(timezone.utc), description="Issued at (datetime)")
+        exp_in: int = Field(15, ge=1, description="Expires in (integer, minutes)", exclude=True)
 
         @model_validator(mode="before")
         @classmethod
@@ -55,4 +101,5 @@ class MaleoFoundationTokenGeneralTransfers:
             values["exp_dt"] = exp_dt
             #* Convert `exp_dt` to timestamp (int)
             values["exp"] = int(exp_dt.timestamp())
-            return values
+            return values
+        

maleo_foundation/models/transfers/parameters/token.py

@@ -8,7 +8,7 @@ class MaleoFoundationTokenParametersTransfers:
         MaleoFoundationTokenSchemas.Password,
         MaleoFoundationTokenSchemas.Key
     ):
-        payload:MaleoFoundationTokenGeneralTransfers.BaseEncodePayload = Field(..., description="Encode payload")
+        payload: MaleoFoundationTokenGeneralTransfers.BaseEncodePayload = Field(..., description="Encode payload")
 
     class Decode(
         MaleoFoundationTokenSchemas.Token,