khushalps/api_utils_converse_v2
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

(20241219) SMS module fully re-organized.

Browse Source
This commit is contained in:
khushal
2024-12-19 17:26:18 +05:30
parent d89a88ab8e
commit 79b771b48c
28 changed files with 1086 additions and 827 deletions
Download Patch File Download Diff File Expand all files Collapse all files
api/blueprints/sms/send_v2.py
+79 -23
View File
@@ -6,11 +6,11 @@
DATE:
Monday, 9th Dec., 2024
Thursday, 19th Dec., 2024
OBJECTIVE:
To receive auth details for various SMS client APIs.
To send SMS messages through various third-party clients.
REFERENCES:
@@ -45,6 +45,7 @@ from quart import Blueprint, current_app, request
# My utils:
from utils_v2.string import json
from utils_v2.api.codes import StatusCodes, HttpCodes
from utils_v2.database.async_mongo_v2 import AsyncMongo
from utils_v2.api.response import ResponseModel
from utils_v2.api.async_quart import (
set_api_version,
@@ -59,14 +60,24 @@ from utils_v2.api.async_quart import (
handle_cancelled_request
)
# Data Models:
# Models:
from models.core.auth_token import CoreAuthTokenModel
from models.api.sms.send import SMSSendRequestHeaders, SMSSendRequestData
from models.api.sms.send import (
NimbusSMSIndiaMessage,
SavvyBulkSMSKenyaMessage,
SMSSendManyResults
)
# Common:
from shared import constants
# For asynchronous activities:
# To work with datatypes:
from typing import List, Any
# To make HTTP requests:
import httpx
import asyncio
@@ -109,6 +120,53 @@ def init(blueprint_setup_state):
# ---------------------------------------------------------------------------------------------------------------------
async def send_sms_messages(
mongo_data_conn: AsyncMongo,
auth_token: CoreAuthTokenModel,
messages: List[NimbusSMSIndiaMessage | SavvyBulkSMSKenyaMessage],
tags: List[Any]
) -> SMSSendManyResults:
"""
This function purely tackles message sending. It is not concerned with authorization and security checks. Please
ensure that you perform those checks before coming here.
:param mongo_data_conn: The database connection to use to perform this task.
:param auth_token: The auth token that will be used to send this message.
:param messages: The list of messages to send out.
:param tags: Any tags to attach with these SMS for filtering when querying in the listing service.
:return: The structured result of sending many SMS messages.
"""
# Start by assuming failure:
results = SMSSendManyResults()
# Select the right client:
match auth_token.client:
case "nimbusSmsIndia":
results = await current_app.nimbus_sms_india_controller.send_many_sms(
mongo_data_conn = mongo_data_conn,
auth_token = auth_token,
messages = messages,
tags = tags
)
case "savvyBulkSmsKenya":
results = await current_app.savvy_bulk_sms_kenya_controller.send_many_sms(
mongo_data_conn = mongo_data_conn,
auth_token = auth_token,
messages = messages,
tags = tags
)
case _:
results.message = "Invalid/unimplemented SMS client."
# Done here:
return results
# ---------------------------------------------------------------------------------------------------------------------
@sms_send_bp.route("", methods = ["POST"])
@sms_send_bp.route("/send", methods = ["POST"])
@set_api_version(api_version = "1.0.0")
@read_input(sanitize_headers = False, sanitize_data = False)
@@ -117,10 +175,10 @@ def init(blueprint_setup_state):
attr_name = "logs_mongo",
project = constants.PROJECT_NAME,
log_type = constants.MODULE_NAME,
operation = "smsAuthApi",
operation = "smsSendApi",
log_input = True,
log_output = True,
sensitive_keys = ["sessionToken", "X-Session-Token", "tokenId"]
sensitive_keys = ["sessionToken", "X-Session-Token", "tokenKey"]
)
@log_chain_to_mongo(attr_name = "logs_mongo")
@should_not_be_under_maintenance(attr_name = "is_under_maintenance")
@@ -129,7 +187,7 @@ def init(blueprint_setup_state):
data_validator = lambda x: SMSSendRequestData(**x)
)
@handle_cancelled_request()
async def send_sms(
async def send_sms_messages_api(
inbound_headers: dict | SMSSendRequestHeaders = None,
inbound_data: dict | SMSSendRequestData = None,
inbound_files: dict = None,
@@ -137,7 +195,7 @@ async def send_sms(
):
"""
Use this when a user wants to register a third-party SMS client with your service.
Use this API when someone wants to send one or more SMS messages.
:param inbound_headers: auto-extracted by the decorators.
:param inbound_data: auto-extracted by the decorators.
:param inbound_files: auto-extracted by the decorators.
@@ -157,13 +215,9 @@ async def send_sms(
message = "invalid session"
)
# ┏┓ ┓ ┏┳┓┓ ┏┓┳┳┓┏┓
# ┗┓┏┓┏┓┏┫ ┃ ┣┓┏┓ ┗┓┃┃┃┗┓
# ┗┛┗ ┛┗┗┻ ┻ ┛┗┗ ┗┛┛ ┗┗┛
# Get the token from the token key:
auth_token = await current_app.mail_controller.get_token_from_key(
mongo_conn = current_app.data_mongo,
auth_token = await current_app.sms_controller.get_token_from_key(
mongo_data_conn = current_app.data_mongo,
token_key = inbound_data.tokenKey
)
if auth_token is None: return ResponseModel(
@@ -172,10 +226,12 @@ async def send_sms(
message = f"no such token key"
)
# Send the SMS:
client_response = await current_app.sms_controller.send(
mongo_conn = current_app.data_mongo,
http_client = current_app.http_client,
# ┏┓ ┓ ┏┳┓┓ ┏┓┳┳┓┏┓
# ┗┓┏┓┏┓┏┫ ┃ ┣┓┏┓ ┗┓┃┃┃┗┓
# ┗┛┗ ┛┗┗┻ ┻ ┛┗┗ ┗┛┛ ┗┗┛
sending_results = await send_sms_messages(
mongo_data_conn = current_app.data_mongo,
auth_token = auth_token,
messages = inbound_data.message,
tags = inbound_data.tags
@@ -187,16 +243,16 @@ async def send_sms(
# ┛
# Done here:
success = True if client_response.successCount else False
success = True if sending_results.successCount else False
return ResponseModel(
status_code = StatusCodes.OK if success else StatusCodes.FAILED,
http_code = HttpCodes.SUCCESS if success else HttpCodes.INTERNAL_SERVER_ERROR,
data = {
"successCount": client_response.successCount,
"failureCount": client_response.failureCount,
"totalCount": client_response.totalCount,
"successCount": sending_results.successCount,
"failureCount": sending_results.failureCount,
"totalCount": sending_results.totalCount,
},
message = client_response.message
message = sending_results.message
)