(20241129) Started talking to MariaDB for integration.
This commit is contained in:
@@ -0,0 +1,388 @@
|
||||
"""
|
||||
|
||||
AUTHOR:
|
||||
|
||||
Khushal P Soonderji
|
||||
|
||||
DATE:
|
||||
|
||||
Tuesday, 22nd Oct., 2024
|
||||
|
||||
OBJECTIVE:
|
||||
|
||||
To provide an easy way to create models to handle documents for Bicree.
|
||||
This is the base model for this microservice. It will define the structure for all other models that will be
|
||||
used in this particular microservice.
|
||||
|
||||
REFERENCES:
|
||||
|
||||
N/A
|
||||
|
||||
DOWNLOADS:
|
||||
|
||||
N/A
|
||||
|
||||
"""
|
||||
|
||||
|
||||
# *****************************************************************************************************************
|
||||
# ***** ****
|
||||
# *** IMPORT ***
|
||||
# ***** ****
|
||||
# *****************************************************************************************************************
|
||||
|
||||
|
||||
# To make sibling directories accessible for imports:
|
||||
import sys
|
||||
sys.path.append(".")
|
||||
sys.path.append("..")
|
||||
|
||||
# My utils:
|
||||
from utils_v2.database.async_mysql_v2 import AsyncMySQL
|
||||
from utils_v2.cache.async_redis_cache_v2 import AsyncRedisCache
|
||||
from utils_v2.api.codes import StatusCodes
|
||||
|
||||
# For asynchronous activities:
|
||||
import asyncio
|
||||
|
||||
# For debugging:
|
||||
from icecream import IceCreamDebugger
|
||||
|
||||
# To work with datatypes:
|
||||
from typing import List
|
||||
|
||||
|
||||
# *****************************************************************************************************************
|
||||
# ***** ****
|
||||
# *** MACROS / ONE-TIME INIT ***
|
||||
# ***** ****
|
||||
# *****************************************************************************************************************
|
||||
|
||||
|
||||
# --- Nothing Yet
|
||||
|
||||
|
||||
# *****************************************************************************************************************
|
||||
# ***** ****
|
||||
# *** VARIABLES ***
|
||||
# ***** ****
|
||||
# *****************************************************************************************************************
|
||||
|
||||
|
||||
# --- Nothing Yet
|
||||
|
||||
|
||||
# *****************************************************************************************************************
|
||||
# ***** ****
|
||||
# *** FUNCTIONS ***
|
||||
# ***** ****
|
||||
# *****************************************************************************************************************
|
||||
|
||||
|
||||
# --- Nothing Yet
|
||||
|
||||
|
||||
# *****************************************************************************************************************
|
||||
# ***** ****
|
||||
# *** CLASSES ***
|
||||
# ***** ****
|
||||
# *****************************************************************************************************************
|
||||
|
||||
|
||||
class BaseModel:
|
||||
|
||||
PREVIEW_LENGTH = 250
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
cache = None,
|
||||
alert_url = None,
|
||||
http_client = None,
|
||||
debug = True,
|
||||
debug_prefix = "Model | ",
|
||||
debug_only_errors = True
|
||||
):
|
||||
|
||||
"""
|
||||
This is the base model.
|
||||
:param cache: The object to use for caching results from database calls.
|
||||
:param debug: Whether, or not, you would like to print debugging messages:
|
||||
:param debug_prefix: The prefix to print with the debugging messages.
|
||||
:param debug_only_errors: Whether you would like to print only error messages or all messages.
|
||||
:return: None.
|
||||
"""
|
||||
|
||||
# Prepare the caching utility:
|
||||
self._cache = cache
|
||||
|
||||
# For sending alerts:
|
||||
self._alert_url = alert_url
|
||||
self._http_client = http_client
|
||||
|
||||
# Prepare the debugging utility:
|
||||
self._debug_prefix = debug_prefix
|
||||
self._printer = IceCreamDebugger(prefix = debug_prefix, includeContext = True)
|
||||
if not debug: self._printer.disable()
|
||||
self._debug_only_errors = debug_only_errors
|
||||
|
||||
# A semaphore for activities that must absolutely be done one at a time:
|
||||
self.__exclusive_semaphore = asyncio.Semaphore(1)
|
||||
|
||||
# A simple debugging output:
|
||||
self._printer("Model initialized.")
|
||||
|
||||
def enable_terminal_print(self):
|
||||
self._printer.enable()
|
||||
|
||||
def disable_terminal_print(self):
|
||||
self._printer.disable()
|
||||
|
||||
def debug_only_errors(self):
|
||||
self._debug_only_errors = True
|
||||
|
||||
def debug_everything(self):
|
||||
self._debug_only_errors = False
|
||||
|
||||
async def send_alert(
|
||||
self,
|
||||
message: str,
|
||||
session_token = None,
|
||||
alert_type = "error"
|
||||
):
|
||||
|
||||
"""
|
||||
Sends out an alert (ideally through the tech module). This is meant to be used when some exception occurs, and
|
||||
you want to be informed before the client complains.
|
||||
:param message: The message to send out to the admins.
|
||||
:param session_token: The session token of the user (optional) so that the alert message can display the name of
|
||||
the user who faced the trouble.
|
||||
:param alert_type: The type of alert to throw ("error", "warning", or "info").
|
||||
:return: None.
|
||||
"""
|
||||
|
||||
if self._http_client is not None and self._alert_url is not None:
|
||||
response = await self._http_client.post(
|
||||
url = self._alert_url,
|
||||
json = {
|
||||
"sessionToken": session_token,
|
||||
"message": message,
|
||||
"type": alert_type
|
||||
}
|
||||
)
|
||||
|
||||
async def call_cached_procedure(
|
||||
self,
|
||||
cache: AsyncRedisCache,
|
||||
cache_key: str,
|
||||
cache_expiry: int,
|
||||
db_conn: AsyncMySQL,
|
||||
proc_name: str,
|
||||
proc_args: tuple,
|
||||
retry_count: int = 1,
|
||||
backoff_seconds: float = 0.5,
|
||||
backoff_multiplier: float = 1.1,
|
||||
session_token: str = None
|
||||
):
|
||||
|
||||
"""
|
||||
Calls a stored procedure and returns the response as a JSON-like object (dict or list).
|
||||
:param cache: The caching object to use to set the session in cache memory.
|
||||
:param cache_key: The string to use as the key when caching the response.
|
||||
:param cache_expiry: The no. of seconds after which this information will be deleted from the cache.
|
||||
:param db_conn: The connection instance to use to call the procedure.
|
||||
:param proc_name: The name of the stored procedure that must be called.
|
||||
:param proc_args: The args to be sent to the stored procedure.
|
||||
:param retry_count: The max. number of times to try in case one or more attempts fail.
|
||||
:param backoff_seconds: The time to wait before making the next attempt if the retry count is more than 1.
|
||||
:param backoff_multiplier: The factor that dictates how much to modify the time delay by when waiting to retry.
|
||||
:param session_token: A session token to share with the tech module when alerts need to be sent out for any
|
||||
occurrence of exceptions. If this is passed, the tech module will be able to tell you which user faced the
|
||||
issue.
|
||||
:return: The response from the stored procedure.
|
||||
"""
|
||||
|
||||
# check for the data in cache:
|
||||
data = await cache.get(cache_key)
|
||||
|
||||
# If the data isn't in the cache, call the procedure:
|
||||
if data is None:
|
||||
|
||||
# Make the database call:
|
||||
data = await self.call_procedure(
|
||||
db_conn = db_conn,
|
||||
proc_name = proc_name,
|
||||
proc_args = proc_args,
|
||||
retry_count = retry_count,
|
||||
backoff_seconds = backoff_seconds,
|
||||
backoff_multiplier = backoff_multiplier,
|
||||
session_token = session_token
|
||||
)
|
||||
|
||||
# If the database call succeeded, cache the response:
|
||||
if isinstance(data, dict) and data["status"] == 1:
|
||||
await cache.set(key = cache_key, value = data, expiry = cache_expiry)
|
||||
|
||||
# Done here:
|
||||
return data
|
||||
|
||||
async def call_procedure(
|
||||
self,
|
||||
db_conn: AsyncMySQL,
|
||||
proc_name: str,
|
||||
proc_args: tuple,
|
||||
retry_count: int = 1,
|
||||
backoff_seconds: float = 0.5,
|
||||
backoff_multiplier: float = 1.1,
|
||||
session_token: str = None
|
||||
):
|
||||
|
||||
"""
|
||||
Calls a stored procedure and returns the response as a JSON-like object (dict or list).
|
||||
:param db_conn: The connection instance to use to call the procedure.
|
||||
:param proc_name: The name of the stored procedure that must be called.
|
||||
:param proc_args: The args to be sent to the stored procedure.
|
||||
:param retry_count: The max. number of times to try in case one or more attempts fail.
|
||||
:param backoff_seconds: The time to wait before making the next attempt if the retry count is more than 1.
|
||||
:param backoff_multiplier: The factor that dictates how much to modify the time delay by when waiting to retry.
|
||||
:param session_token: A session token to share with the tech module when alerts need to be sent out for any
|
||||
occurrence of exceptions. If this is passed, the tech module will be able to tell you which user faced the
|
||||
issue.
|
||||
:return: The response from the stored procedure.
|
||||
"""
|
||||
|
||||
# Call the stored procedure:
|
||||
db_json, exception = await db_conn.call_procedure_and_get_json(
|
||||
proc_name,
|
||||
proc_args,
|
||||
retry_count = retry_count,
|
||||
backoff_seconds = backoff_seconds,
|
||||
backoff_multiplier = backoff_multiplier,
|
||||
return_exception = True
|
||||
)
|
||||
|
||||
# Understand the response:
|
||||
success = True if db_json["status"] == 1 else False
|
||||
message = db_json.get("message")
|
||||
|
||||
# Debugging print:
|
||||
if not success or not self._debug_only_errors:
|
||||
self._printer(proc_name, proc_args, success, exception, message)
|
||||
|
||||
# Send an alert out on exceptions:
|
||||
if exception is not None:
|
||||
|
||||
# Format the message in Markdown format:
|
||||
exception_string = str(exception).replace("`", "'")
|
||||
formatted_message = f"*Module:*\n`{self._debug_prefix}`\n\n"
|
||||
formatted_message += f"*Proc:*\n`{proc_name}`\n\n"
|
||||
formatted_message += f"*Args:*\n`({', '.join([str(_) for _ in proc_args])})`\n\n"
|
||||
formatted_message += f"*Arg-Types:*\n`({', '.join([type(_).__name__ for _ in proc_args])})`\n\n"
|
||||
formatted_message += f"*Message:*\n`{message}`\n\n"
|
||||
formatted_message += f"*Success:*\n`{success}`\n\n"
|
||||
formatted_message += f"*Exception:*\n`{exception_string}`\n\n"
|
||||
|
||||
# Send the alert:
|
||||
await self.send_alert(formatted_message, session_token = session_token)
|
||||
|
||||
# Return the response:
|
||||
db_json["status_code"] = StatusCodes.OK if success else StatusCodes.FAILED
|
||||
return db_json
|
||||
|
||||
async def execute_one(
|
||||
self,
|
||||
db_conn: AsyncMySQL,
|
||||
query: str,
|
||||
session_token: str = None
|
||||
):
|
||||
|
||||
"""
|
||||
Runs one query and sends an alert if that fails.
|
||||
:param db_conn: The connection to use to run the query.
|
||||
:param query: The query to run.
|
||||
:param session_token: A session token to share with the tech module when alerts need to be sent out for any
|
||||
occurrence of exceptions. If this is passed, the tech module will be able to tell you which user faced the
|
||||
issue.
|
||||
:return: The response from the database.
|
||||
"""
|
||||
|
||||
# Run the query:
|
||||
rows_affected, db_response, exception = await db_conn.execute_one(query = query, return_exception = True)
|
||||
|
||||
# Send an alert out on exceptions:
|
||||
if exception is not None:
|
||||
|
||||
# Created needed previews:
|
||||
query_preview = query if len(query) <= self.PREVIEW_LENGTH else query[:self.PREVIEW_LENGTH] + "..."
|
||||
|
||||
# Format the message in Markdown format:
|
||||
formatted_message = f"*Module:*\n`{self._debug_prefix}`\n\n"
|
||||
formatted_message += f"*Query:*\n`{query_preview}`\n\n"
|
||||
formatted_message += f"*Rows Affected:*\n`{rows_affected}`\n\n"
|
||||
formatted_message += f"*DB Response:*\n`{db_response}`\n\n"
|
||||
formatted_message += f"*Exception:*\n`{exception}`\n\n"
|
||||
|
||||
# Send the alert:
|
||||
await self.send_alert(formatted_message, session_token = session_token)
|
||||
|
||||
# Return the response:
|
||||
return rows_affected, db_response
|
||||
|
||||
async def execute_many(
|
||||
self,
|
||||
db_conn: AsyncMySQL,
|
||||
query: str,
|
||||
data: List[tuple],
|
||||
session_token: str = None
|
||||
):
|
||||
|
||||
"""
|
||||
Runs many queries and sends an alert if that fails.
|
||||
:param db_conn: The connection to use to run the query.
|
||||
:param query: The query to run.
|
||||
:param data: The data to feed into the query.
|
||||
:param session_token: A session token to share with the tech module when alerts need to be sent out for any
|
||||
occurrence of exceptions. If this is passed, the tech module will be able to tell you which user faced the
|
||||
issue.
|
||||
:return: The response from the database.
|
||||
"""
|
||||
|
||||
# Run the query:
|
||||
rows_affected, db_response, exception = await db_conn.execute_many(
|
||||
query = query,
|
||||
data = data,
|
||||
return_exception = True
|
||||
)
|
||||
|
||||
# Send an alert out on exceptions:
|
||||
if exception is not None:
|
||||
|
||||
# Created needed previews:
|
||||
query_preview = query if len(query) <= self.PREVIEW_LENGTH else query[:self.PREVIEW_LENGTH] + "..."
|
||||
data_preview = str(data)
|
||||
if len(data_preview) > self.PREVIEW_LENGTH: data_preview = data_preview[:self.PREVIEW_LENGTH] + "..."
|
||||
|
||||
# Format the message in Markdown format:
|
||||
formatted_message = f"*Module:*\n`{self._debug_prefix}`\n\n"
|
||||
formatted_message += f"*Query:*\n`{query_preview}`\n\n"
|
||||
formatted_message += f"*Data:*\n`{data_preview}`\n\n"
|
||||
formatted_message += f"*Rows Affected:*\n`{rows_affected}`\n\n"
|
||||
formatted_message += f"*DB Response:*\n`{db_response}`\n\n"
|
||||
formatted_message += f"*Exception:*\n`{exception}`\n\n"
|
||||
|
||||
# Send the alert:
|
||||
await self.send_alert(formatted_message, session_token = session_token)
|
||||
|
||||
# Return the response:
|
||||
return rows_affected, db_response
|
||||
|
||||
|
||||
# *****************************************************************************************************************
|
||||
# ***** ****
|
||||
# *** MAIN PROGRAM ***
|
||||
# ***** ****
|
||||
# *****************************************************************************************************************
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
|
||||
pass
|
||||
@@ -38,8 +38,12 @@ sys.path.append("..")
|
||||
# My async utils:
|
||||
from utils_v2.string import json
|
||||
from utils_v2.date_time import date_time
|
||||
from utils_v2.database.async_mysql_v2 import AsyncMySQL
|
||||
from utils_v2.database.async_mongo_v2 import AsyncMongo
|
||||
|
||||
# Base model:
|
||||
from models.behaviour.base import BaseModel
|
||||
|
||||
# To work with MongoDB:
|
||||
from bson import ObjectId
|
||||
|
||||
@@ -87,31 +91,32 @@ import copy
|
||||
# *****************************************************************************************************************
|
||||
|
||||
|
||||
class MailOAuthModel:
|
||||
class MailOAuthModel(BaseModel):
|
||||
|
||||
AUTH_COLLECTION = "_authTokens"
|
||||
|
||||
def __init__(self):
|
||||
pass
|
||||
|
||||
@staticmethod
|
||||
async def get_id(
|
||||
db_conn: AsyncMongo,
|
||||
async def get_user_identifier(
|
||||
self,
|
||||
db_conn: AsyncMySQL,
|
||||
mongo_conn: AsyncMongo,
|
||||
user_info: dict,
|
||||
service_type: Literal["email", "chat"],
|
||||
service_client: Literal["gmail"],
|
||||
auth_type: Literal["oauth"]
|
||||
auth_type: Literal["oauth"],
|
||||
session_token: str = None
|
||||
) -> ObjectId:
|
||||
|
||||
"""
|
||||
Stores params from the session info and gives an identifier to use in the authorization URL. Use this when the
|
||||
user requests an authorization URL to link your service to another service (like GMail).
|
||||
:param db_conn: The database connection to use to perform the action.
|
||||
:param db_conn: The database connection (MariaDB) to use to perform the action.
|
||||
:param mongo_conn: The database connection (MongoDB) to use to perform the action.
|
||||
:param user_info: The dictionary that has the user's session information.
|
||||
:param service_type: The type of service being provided.
|
||||
:param service_client: The name of the company or brand that is providing this service that is being integrated.
|
||||
:param auth_type: To identify the type of authentication being done here. This could indicate simple password
|
||||
authentication, more advance OAuth2.0 authentication, etc.
|
||||
:param session_token: The session token of the user who requested this service.
|
||||
:return: An ObjectId to later store the granted tokens.
|
||||
"""
|
||||
|
||||
@@ -119,7 +124,7 @@ class MailOAuthModel:
|
||||
request_ts = date_time.get_current_utc_date_time(as_string = False)
|
||||
|
||||
# Get the identifier from the database:
|
||||
db_json = await db_conn.find_one_and_update(
|
||||
mongo_json = await mongo_conn.find_one_and_update(
|
||||
collection = MailOAuthModel.AUTH_COLLECTION,
|
||||
filter = {
|
||||
"serviceType": service_type,
|
||||
@@ -150,30 +155,59 @@ class MailOAuthModel:
|
||||
return_updated = True
|
||||
)
|
||||
|
||||
# Done here:
|
||||
return db_json["_id"] if db_json else None
|
||||
# Tell MariaDB that an authorization request was initiated:
|
||||
db_json = {}
|
||||
if mongo_json is not None:
|
||||
db_json = await self.call_procedure(
|
||||
db_conn = db_conn,
|
||||
proc_name = "entity_integration_save",
|
||||
proc_args = (
|
||||
user_info["entityId"], # .... 'p_entity_id'
|
||||
service_client, # ........... 'p_provider'
|
||||
"Auth Requested", # ......... 'p_current_status'
|
||||
"Auth URL Generated", # ..... 'p_last_action'
|
||||
None, # ..................... 'p_display_name'
|
||||
None, # ..................... 'p_display_picture'
|
||||
str(mongo_json["_id"]), # ... 'p_token_id'
|
||||
None, # ..................... 'p_notes'
|
||||
user_info["userId"] # ....... 'p_created_by'
|
||||
),
|
||||
session_token = session_token
|
||||
)
|
||||
|
||||
# Done here:
|
||||
return mongo_json["_id"] if mongo_json and db_json.get("status") == 1 else None
|
||||
|
||||
@staticmethod
|
||||
async def set_token(
|
||||
db_conn: AsyncMongo,
|
||||
self,
|
||||
db_conn: AsyncMySQL,
|
||||
mongo_conn: AsyncMongo,
|
||||
user_info: dict,
|
||||
user_identifier: ObjectId | str,
|
||||
token: dict
|
||||
token: dict,
|
||||
session_token: str = None
|
||||
) -> bool:
|
||||
|
||||
"""
|
||||
This method is to be called when the end user authorizes your service to connect to his third-party account. For
|
||||
example, when the end user allows you to access his GMail account.
|
||||
:param db_conn: The database connection to use to perform the action.
|
||||
:param user_identifier: The identifier granted by the 'get_id' method.
|
||||
:param db_conn: The database connection (MariaDB) to use to perform the action.
|
||||
:param mongo_conn: The database connection (MongoDB) to use to perform the action.
|
||||
:param user_info: The dictionary that has the user's session information.
|
||||
:param user_identifier: The identifier granted by the 'get_user_identifier' method.
|
||||
:param token: The token granted by the third-party service.
|
||||
:return:
|
||||
:param session_token: The session token of the user who requested this service.
|
||||
:return: True if saved, False if failed.
|
||||
"""
|
||||
|
||||
# Start by assuming failure:
|
||||
token_saved = False
|
||||
|
||||
# Note down the timestamp at which this event occurred:
|
||||
request_ts = date_time.get_current_utc_date_time(as_string = False)
|
||||
|
||||
# Save the token to the database:
|
||||
token_saved = await db_conn.update_one(
|
||||
# Save the token to MongoDB:
|
||||
mongo_json = await mongo_conn.find_one_and_update(
|
||||
collection = MailOAuthModel.AUTH_COLLECTION,
|
||||
filter = {"_id": ObjectId(user_identifier)},
|
||||
update = {
|
||||
@@ -181,9 +215,32 @@ class MailOAuthModel:
|
||||
"token": token,
|
||||
"firstRefreshTs": request_ts,
|
||||
}
|
||||
}
|
||||
},
|
||||
projection = {"token": False},
|
||||
return_updated = True,
|
||||
upsert = False
|
||||
)
|
||||
|
||||
# Tell MariaDB that the token was saved:
|
||||
if mongo_json is not None:
|
||||
db_json = await self.call_procedure(
|
||||
db_conn = db_conn,
|
||||
proc_name = "entity_integration_save",
|
||||
proc_args = (
|
||||
user_info["entityId"], # ... 'p_entity_id'
|
||||
mongo_json["client"], # .... 'p_provider'
|
||||
"Auth Granted", # .......... 'p_current_status'
|
||||
"Set Token", # ............. 'p_last_action'
|
||||
None, # .................... 'p_display_name'
|
||||
None, # .................... 'p_display_picture'
|
||||
user_identifier, # ......... 'p_token_id'
|
||||
token["email"], # .......... 'p_notes'
|
||||
user_info["userId"] # ...... 'p_created_by'
|
||||
),
|
||||
session_token = session_token
|
||||
)
|
||||
if db_json["status"] == 1: token_saved = True
|
||||
|
||||
# Done here:
|
||||
return token_saved
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
|
||||
OBJECTIVE:
|
||||
|
||||
Here we perform on-time mail syncing activities for our users.
|
||||
Here we perform one-time mail syncing activities for our users.
|
||||
|
||||
REFERENCES:
|
||||
|
||||
@@ -86,7 +86,7 @@ import copy
|
||||
# *****************************************************************************************************************
|
||||
|
||||
|
||||
class MailOAuthModel:
|
||||
class MailSyncModel:
|
||||
|
||||
AUTH_COLLECTION = "_authTokens"
|
||||
|
||||
|
||||
@@ -0,0 +1,156 @@
|
||||
"""
|
||||
|
||||
AUTHOR:
|
||||
|
||||
Khushal P Soonderji
|
||||
|
||||
DATE:
|
||||
|
||||
Saturday, 26th Oct., 2024.
|
||||
|
||||
OBJECTIVE:
|
||||
|
||||
To provide a data models for user-related activities.
|
||||
|
||||
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
|
||||
from typing import Optional, Literal
|
||||
|
||||
# My utils:
|
||||
from utils_v2.string import regex
|
||||
|
||||
|
||||
# *****************************************************************************************************************
|
||||
# ***** ****
|
||||
# *** MACROS / ONE-TIME INIT ***
|
||||
# ***** ****
|
||||
# *****************************************************************************************************************
|
||||
|
||||
|
||||
# RegEx Patterns:
|
||||
REGEX_SESSION_TOKEN = r"^[a-f0-9]{8}-[a-f0-9]{4}-[1-5][a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$"
|
||||
|
||||
|
||||
# *****************************************************************************************************************
|
||||
# ***** ****
|
||||
# *** VARIABLES ***
|
||||
# ***** ****
|
||||
# *****************************************************************************************************************
|
||||
|
||||
|
||||
# --- Nothing Yet
|
||||
|
||||
|
||||
# *****************************************************************************************************************
|
||||
# ***** ****
|
||||
# *** FUNCTIONS ***
|
||||
# ***** ****
|
||||
# *****************************************************************************************************************
|
||||
|
||||
|
||||
class ChatAlertRequestHeaders(BaseModel):
|
||||
|
||||
sessionToken: str = Field(
|
||||
description = "the session token of the user who is requesting the service",
|
||||
pattern = REGEX_SESSION_TOKEN,
|
||||
frozen = True,
|
||||
alias = "X-Session-Token"
|
||||
)
|
||||
|
||||
# ┏┓ ┏•
|
||||
# ┃ ┏┓┏┓╋┓┏┓
|
||||
# ┗┛┗┛┛┗┛┗┗┫
|
||||
# ┛
|
||||
|
||||
class Config:
|
||||
extra = "allow"
|
||||
|
||||
def model_dump(self, *args, **kwargs):
|
||||
return super().model_dump(*args, by_alias = True, **kwargs)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
|
||||
class ChatAlertRequestData(BaseModel):
|
||||
|
||||
message: str = Field(
|
||||
description = "the message that needs to be sent to the admins",
|
||||
frozen = True
|
||||
)
|
||||
|
||||
format: Literal["plaintext", "markdown", "html"] = Field(
|
||||
description = "the format in which the message was sent",
|
||||
default = "markdown",
|
||||
frozen = True
|
||||
)
|
||||
|
||||
type: Literal["info", "warning", "error"] = Field(
|
||||
description = "the type of alert that is being sent out",
|
||||
default = "info",
|
||||
frozen = True
|
||||
)
|
||||
|
||||
chatId: str = Field(
|
||||
description = "the identifier of the chat to send the message to",
|
||||
default = None,
|
||||
frozen = True
|
||||
)
|
||||
|
||||
chatClient: Literal["telegram", "whatsapp"] = Field(
|
||||
description = "the service to send the message through",
|
||||
default = "telegram",
|
||||
frozen = True
|
||||
)
|
||||
|
||||
# ┏┓ ┏•
|
||||
# ┃ ┏┓┏┓╋┓┏┓
|
||||
# ┗┛┗┛┛┗┛┗┗┫
|
||||
# ┛
|
||||
|
||||
class Config:
|
||||
extra = "forbid"
|
||||
|
||||
# ┓┏ ┓• ┓ •
|
||||
# ┃┃┏┓┃┓┏┫┏┓╋┓┏┓┏┓
|
||||
# ┗┛┗┻┗┗┗┻┗┻┗┗┗┛┛┗
|
||||
|
||||
@field_validator("format", "type", "chatClient", mode = "before")
|
||||
def to_lowercase(cls, value):
|
||||
if isinstance(value, str): value = value.strip().lower()
|
||||
return value
|
||||
|
||||
|
||||
# *****************************************************************************************************************
|
||||
# ***** ****
|
||||
# *** MAIN PROGRAM ***
|
||||
# ***** ****
|
||||
# *****************************************************************************************************************
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
|
||||
pass
|
||||
Reference in New Issue
Block a user