(20241209) Better session info capture in the logs.

models/data/core/user_info.py

@@ -0,0 +1,212 @@
+"""
+
+    AUTHOR:
+
+        Khushal P Soonderji
+
+    DATE:
+
+        Saturday, 7th Dec., 2024.
+
+    OBJECTIVE:
+
+        To define how auth tokens will be stored in the database.
+
+    REFERENCES:
+
+        N/A
+
+    DOWNLOADS:
+
+        N/A
+
+"""
+
+
+#   *****************************************************************************************************************
+#  *****                                                                                                          ****
+# ***                                                   IMPORT                                                      ***
+#  *****                                                                                                          ****
+#   *****************************************************************************************************************
+
+
+# To make sibling directories accessible for imports:
+import sys
+sys.path.append(".")
+sys.path.append("..")
+
+# For making data behaviour_models:
+from pydantic import BaseModel, Field, field_validator, PastDatetime, AwareDatetime
+from typing import Optional, Literal, Union
+
+# My utils:
+from utils_v2.string import regex
+from utils_v2.date_time import date_time
+
+# To work with MongoDB:
+from bson.objectid import ObjectId
+
+# To work with date and time:
+import datetime
+
+
+#   *****************************************************************************************************************
+#  *****                                                                                                          ****
+# ***                                           MACROS / ONE-TIME INIT                                              ***
+#  *****                                                                                                          ****
+#   *****************************************************************************************************************
+
+
+# --- Nothing Yet
+
+
+#   *****************************************************************************************************************
+#  *****                                                                                                          ****
+# ***                                                VARIABLES                                                      ***
+#  *****                                                                                                          ****
+#   *****************************************************************************************************************
+
+
+# --- Nothing Yet
+
+
+#   *****************************************************************************************************************
+#  *****                                                                                                          ****
+# ***                                                  FUNCTIONS                                                    ***
+#  *****                                                                                                          ****
+#   *****************************************************************************************************************
+
+
+class CoreAuthTokenModel(BaseModel):
+
+    version: str = Field(
+        description = "a hint about the version no. of this message",
+        min_length = 1,
+        frozen = True,
+        default = "1.0.0"
+    )
+
+    serviceType: Literal["email", "sms", "chat"] = Field(
+        description = "the kind of service this message was sent/received from",
+        frozen = True
+    )
+
+    client: Literal[
+        "gmail", "outlook",  # ...................... Mail Clients
+        "telegram", "whatsapp",  # .................. Chat Clients
+        "nimbusSmsIndia", "savvyBulkSmsKenya",  # ... SMS Clients
+        "razorpay", "safaricomMPesaExpress"  # ...... Payment Gateways
+    ] = Field(
+        description = "the third-part client that was used",
+        frozen = True
+    )
+
+    authType: Literal["oauth", "auth"] = Field(
+        description = "the type of authentication procedure used",
+        frozen = True
+    )
+
+    firstRequestTs: AwareDatetime = Field(
+        description = "the time (utc) at which authorization was first requested",
+        frozen = True
+    )
+
+    lastRequestTs: AwareDatetime = Field(
+        description = "the time (utc) at which authorization was last requested",
+        frozen = False
+    )
+
+    firstRefreshTs: AwareDatetime = Field(
+        description = "the time (utc) at which the tokens were first refreshed",
+        frozen = False
+    )
+
+    lastRefreshTs: AwareDatetime = Field(
+        description = "the time (utc) at which the tokens were last refreshed",
+        frozen = False
+    )
+
+    token: dict | None = Field(
+        description = "the actual auth tokens of that client; will differ for each client",
+        frozen = True,
+        default_factory = lambda: date_time.get_current_utc_date_time(as_string = False)
+    )
+
+    user: dict = Field(
+        description = "how you identify your user",
+        frozen = True
+    )
+
+    clientUserId: dict = Field(
+        description = "how third-party client identifies the same user",
+        frozen = True
+    )
+
+    status: Literal["active", "disabled"] = Field(
+        description = "to indicate the status of this account",
+        frozen = False,
+        default = "active"
+    )
+
+    syncFreq: Literal[60, 300, 1500] = Field(
+        description = "the no. of seconds after which to poll for updates from the client (if applicable)",
+        frozen = False,
+        default = 300
+    )
+
+    # ┏┓    ┏•
+    # ┃ ┏┓┏┓╋┓┏┓
+    # ┗┛┗┛┛┗┛┗┗┫
+    #          ┛
+
+    class Config:
+        extra = "allow"
+        arbitrary_types_allowed = True
+
+    # ┓┏  ┓• ┓   •
+    # ┃┃┏┓┃┓┏┫┏┓╋┓┏┓┏┓
+    # ┗┛┗┻┗┗┗┻┗┻┗┗┗┛┛┗
+
+    @field_validator(
+        "firstRequestTs",
+        "lastRequestTs", "firstRefreshTs", "lastRefreshTs",
+        mode = "before"
+    )
+    def parse_date_time(cls, value):
+        return date_time.parse_date_time(input_value = value, timezone = date_time.TIMEZONE_UTC)
+
+
+#   *****************************************************************************************************************
+#  *****                                                                                                          ****
+# ***                                               MAIN PROGRAM                                                    ***
+#  *****                                                                                                          ****
+#   *****************************************************************************************************************
+
+
+if __name__ == "__main__":
+    from utils_v2.string import json
+
+    auth_token = CoreAuthTokenModel(
+        serviceType = "email",
+        client = "gmail",
+        authType = "oauth",
+        firstRequestTs = date_time.get_current_utc_date_time(as_string = False),
+        lastRequestTs = date_time.get_current_utc_date_time(as_string = False),
+        firstRefreshTs = date_time.get_current_utc_date_time(as_string = False),
+        lastRefreshTs = date_time.get_current_utc_date_time(as_string = False),
+        token = {
+            "username": "testing123",
+            "password": "abcdefgh"
+        },
+        user = {
+            "userId": 0,
+            "entityId": 1,
+            "billingAccountId": 2,
+            "fullName": "Bhopli"
+        },
+        clientUserId = {
+            "email": "bhopli@gmail.com"
+        }
+    )
+
+    print("AUTH-TOKEN MODEL:", json.to_string(auth_token.model_dump(), default = str))