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

(20250121) With APIs to send, list, and update tags on WhatsApp messages (through Nimbus).

Browse Source
This commit is contained in:
khushal
2025-01-21 15:27:53 +05:30
parent f94d9e1a4b
commit cadbc19f28
13 changed files with 498 additions and 182 deletions
Download Patch File Download Diff File Expand all files Collapse all files
api/blueprints/message/chat/list.py
+32 -20
View File
@@ -6,11 +6,11 @@
DATE:
Thursday, 19th Dec., 2024
Tuesday, 21st Jan., 2025.
OBJECTIVE:
To list SMS messages associated with incoming identifiers.
To list chat messages associated with incoming identifiers.
REFERENCES:
@@ -64,7 +64,7 @@ from shared import constants
# Data Models:
from models.core.user import CoreUserInfoModel
from models.api.message.sms.list import SMSListRequestHeaders, SMSListRequestData
from models.api.message.chat.list import ChatMessageListRequestHeaders, ChatMessageListRequestData
# Helpers:
from api.helpers.user import token_check
@@ -84,7 +84,7 @@ import asyncio
# Related to Quart:
sms_list_bp = Blueprint("sms_list", __name__)
chat_list_bp = Blueprint("chat_list", __name__)
# *****************************************************************************************************************
@@ -104,7 +104,7 @@ sms_list_bp = Blueprint("sms_list", __name__)
# *****************************************************************************************************************
@sms_list_bp.record_once
@chat_list_bp.record_once
def init(blueprint_setup_state):
# This gets called when the blueprint is registered.
@@ -115,7 +115,7 @@ def init(blueprint_setup_state):
# ---------------------------------------------------------------------------------------------------------------------
@sms_list_bp.route("/list", methods = ["GET"])
@chat_list_bp.route("/list", methods = ["GET"])
@set_api_version(api_version = "1.0.0")
@read_input(sanitize_headers = False, sanitize_data = False)
@get_session_info(key = "X-Session-Token", session_coro = "get_session")
@@ -123,7 +123,7 @@ def init(blueprint_setup_state):
attr_name = "logs_mongo",
project = constants.PROJECT_NAME,
log_type = constants.MODULE_NAME,
operation = "smsListApi",
operation = "chatMsgListApi",
log_input = True,
log_output = True,
sensitive_keys = ["sessionToken", "X-Session-Token", "tokenKeys"]
@@ -131,13 +131,13 @@ def init(blueprint_setup_state):
@log_chain_to_mongo(attr_name = "logs_mongo")
@should_not_be_under_maintenance(attr_name = "is_under_maintenance")
@validate_input(
header_validator = lambda x: SMSListRequestHeaders(**x).model_dump(),
data_validator = lambda x: SMSListRequestData(**x)
header_validator = lambda x: ChatMessageListRequestHeaders(**x).model_dump(),
data_validator = lambda x: ChatMessageListRequestData(**x)
)
@handle_cancelled_request()
async def list_sms_messages(
inbound_headers: dict | SMSListRequestHeaders = None,
inbound_data: dict | SMSListRequestData = None,
async def list_chat_messages(
inbound_headers: dict | ChatMessageListRequestHeaders = None,
inbound_data: dict | ChatMessageListRequestData = None,
inbound_files: dict = None,
**kwargs
):
@@ -168,7 +168,7 @@ async def list_sms_messages(
# ┛
# Get the tokens from the database:
auth_tokens = await current_app.sms_controller.get_tokens_from_keys(
auth_tokens = await current_app.chat_controller.get_tokens_from_keys(
mongo_data_conn = current_app.data_mongo,
token_keys = inbound_data.tokenKeys,
limit = len(inbound_data.tokenKeys)
@@ -177,13 +177,13 @@ async def list_sms_messages(
# Check if these tokens belong to the user claiming ownership:
if not await token_check.is_authorized(
mongo_conn = current_app.data_mongo,
mongo_data_conn = current_app.data_mongo,
user_info = CoreUserInfoModel(**kwargs["session_info"]),
token_ids = token_ids
): return ResponseModel(
status_code = StatusCodes.FAILED,
http_code = HttpCodes.UNAUTHORIZED,
message = "User doesn't have rights over one or more SMS accounts."
message = "User doesn't have rights over one or more chat accounts."
)
# ┳┓ ┓ • •
@@ -191,15 +191,27 @@ async def list_sms_messages(
# ┻┛┗┻┗┗┻ ┗┛┗┛┗┗┛┗┗┫
# ┛
messages = await current_app.sms_controller.get_messages(
# Construct any additional filter:
additional_filter = {}
if inbound_data.tags: additional_filter["tags"] = {"$in": inbound_data.tags}
# Fetch the messages:
messages = await current_app.chat_controller.get_messages(
mongo_data_conn = current_app.data_mongo,
token_ids = token_ids,
limit = inbound_data.count,
skip = inbound_data.fromCount,
projection = {
"message.metadata": False,
"message.rawResponse": False
}
"message.httpCode": False,
"message.status": False,
"message.statusCode": False,
"message.apiMessage": False,
"message.requestId": False,
"message.messageCount": False,
"message.messageCost": False,
"message.balance": False,
},
additional_filter = additional_filter
)
# ┳┓
@@ -214,7 +226,7 @@ async def list_sms_messages(
status_code = StatusCodes.OK if success else StatusCodes.FAILED,
http_code = HttpCodes.SUCCESS if success else HttpCodes.NOT_FOUND,
data = [m.full for m in messages] if success else None,
message = f"{message_count} SMS message(s) found."
message = f"{message_count} message(s) found."
)
api/blueprints/message/chat/send.py
+44 -49
View File
@@ -6,11 +6,11 @@
DATE:
Thursday, 19th Dec., 2024
Tuesday, 21st Jan., 2025.
OBJECTIVE:
To send SMS messages through various third-party clients.
To send chat-app messages through various third-party clients.
REFERENCES:
@@ -62,12 +62,8 @@ from utils_v2.api.async_quart import (
# Models:
from models.core.auth_token import CoreAuthTokenModel
from models.api.message.sms.send import SMSSendRequestHeaders, SMSSendRequestData
from models.message.sms.send import (
NimbusSMSIndiaMessage,
SavvyBulkSMSKenyaMessage,
SMSSendManyResults
)
from models.api.message.chat.send import ChatSendRequestHeaders, ChatSendRequestData
from models.message.chat.send import ChatSendOneResult, ChatSendManyResults, NimbusWhatsAppMessage
# Common:
from shared import constants
@@ -89,7 +85,7 @@ import asyncio
# Related to Quart:
sms_send_bp = Blueprint("sms_send", __name__)
chat_send_bp = Blueprint("chat_send", __name__)
# *****************************************************************************************************************
@@ -109,7 +105,7 @@ sms_send_bp = Blueprint("sms_send", __name__)
# *****************************************************************************************************************
@sms_send_bp.record_once
@chat_send_bp.record_once
def init(blueprint_setup_state):
# This gets called when the blueprint is registered.
@@ -120,44 +116,43 @@ def init(blueprint_setup_state):
# ---------------------------------------------------------------------------------------------------------------------
async def send_sms_messages(
mongo_data_conn: AsyncMongo,
async def send_chat_messages(
auth_token: CoreAuthTokenModel,
messages: List[NimbusSMSIndiaMessage | SavvyBulkSMSKenyaMessage],
messages: List[NimbusWhatsAppMessage],
tags: List[Any]
) -> SMSSendManyResults:
) -> ChatSendManyResults:
"""
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.
:param tags: Any tags to attach with these messages for filtering when querying in the listing service.
:return: The structured result of sending many chat messages.
"""
# Start by assuming failure:
results = SMSSendManyResults()
client_controller = None
results = ChatSendManyResults()
# 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 "whatsappNimbus": client_controller = current_app.whatsapp_nimbus_controller
case _:
results.message = "Invalid/unimplemented SMS client."
client_controller = None
results.message = f"Invalid/unimplemented client '{auth_token.client}'."
# If we have a match:
if client_controller is not None:
results = await client_controller.send_many_messages(
sql_conn = current_app.sql_writer,
mongo_data_conn = current_app.data_mongo,
http_client = current_app.http_client,
auth_token = auth_token,
client = None,
messages = messages,
tags = tags
)
# Done here:
return results
@@ -166,8 +161,8 @@ async def send_sms_messages(
# ---------------------------------------------------------------------------------------------------------------------
@sms_send_bp.route("", methods = ["POST"])
@sms_send_bp.route("/send", methods = ["POST"])
@chat_send_bp.route("", methods = ["POST"])
@chat_send_bp.route("/send", methods = ["POST"])
@set_api_version(api_version = "1.0.0")
@read_input(sanitize_headers = False, sanitize_data = False)
@get_session_info(key = "X-Session-Token", session_coro = "get_session")
@@ -175,27 +170,27 @@ async def send_sms_messages(
attr_name = "logs_mongo",
project = constants.PROJECT_NAME,
log_type = constants.MODULE_NAME,
operation = "smsSendApi",
log_input = True,
operation = "chatSendApi",
log_input = 1,
log_output = True,
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")
@validate_input(
header_validator = lambda x: SMSSendRequestHeaders(**x).model_dump(),
data_validator = lambda x: SMSSendRequestData(**x)
header_validator = lambda x: ChatSendRequestHeaders(**x).model_dump(),
data_validator = lambda x: ChatSendRequestData(**x)
)
@handle_cancelled_request()
async def send_sms_messages_api(
inbound_headers: dict | SMSSendRequestHeaders = None,
inbound_data: dict | SMSSendRequestData = None,
async def send_chat_messages_api(
inbound_headers: dict | ChatSendRequestHeaders = None,
inbound_data: dict | ChatSendRequestData = None,
inbound_files: dict = None,
**kwargs
):
"""
Use this API when someone wants to send one or more SMS messages.
Use this API when someone wants to send one or more chat 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.
@@ -220,7 +215,7 @@ async def send_sms_messages_api(
)
# Get the token from the token key:
auth_token = await current_app.sms_controller.get_token_from_key(
auth_token = await current_app.chat_controller.get_token_from_key(
mongo_data_conn = current_app.data_mongo,
token_key = inbound_data.tokenKey
)
@@ -230,12 +225,12 @@ async def send_sms_messages_api(
message = f"No such token key."
)
# ┏┓ ┓ ┏┳┓┓ ┏┓┳┳┓┏┓
# ┗┓┏┓┏┓┏┫ ┃ ┣┓┏┓ ┗┓┃┃┃┗┓
# ┗┛┗ ┛┗┗┻ ┻ ┛┗┗ ┗┛┛ ┗┗┛
# ┏┓ ┓ ┓ ┳┳┓
# ┗┓┏┓┏┓┏┫ ╋┣┓┏┓ ┃┃┃┏┓┏┏┏┓┏┓┏┓
# ┗┛┗ ┛┗┗┻ ┗┛┗┗ ┛ ┗┗ ┛┛┗┻┗┫┗
# ┛
sending_results = await send_sms_messages(
mongo_data_conn = current_app.data_mongo,
sending_results = await send_chat_messages(
auth_token = auth_token,
messages = inbound_data.message,
tags = inbound_data.tags
api/blueprints/message/chat/tags.py
+14 -14
View File
@@ -6,11 +6,11 @@
DATE:
Thursday, 19th Dec., 2024
Tuesday, 21st Jan., 2025.
OBJECTIVE:
To update tags on SMS messages.
To update tags on chat messages.
REFERENCES:
@@ -64,7 +64,7 @@ from shared import constants
# Data Models:
from models.core.user import CoreUserInfoModel
from models.api.message.sms.tags import SMSUpdateTagsRequestHeaders, SMSUpdateTagsRequestData
from models.api.message.chat.tags import ChatMessageUpdateTagsRequestHeaders, ChatMessageUpdateTagsRequestData
# Helpers:
from api.helpers.user import token_check
@@ -84,7 +84,7 @@ import asyncio
# Related to Quart:
sms_update_tags_bp = Blueprint("sms_upd_tags", __name__)
chat_update_tags_bp = Blueprint("chat_upd_tags", __name__)
# *****************************************************************************************************************
@@ -104,7 +104,7 @@ sms_update_tags_bp = Blueprint("sms_upd_tags", __name__)
# *****************************************************************************************************************
@sms_update_tags_bp.record_once
@chat_update_tags_bp.record_once
def init(blueprint_setup_state):
# This gets called when the blueprint is registered.
@@ -115,7 +115,7 @@ def init(blueprint_setup_state):
# ---------------------------------------------------------------------------------------------------------------------
@sms_update_tags_bp.route("/tags", methods = ["PATCH"])
@chat_update_tags_bp.route("/tags", methods = ["PATCH"])
@set_api_version(api_version = "1.0.0")
@read_input(sanitize_headers = False, sanitize_data = False)
@get_session_info(key = "X-Session-Token", session_coro = "get_session")
@@ -123,7 +123,7 @@ def init(blueprint_setup_state):
attr_name = "logs_mongo",
project = constants.PROJECT_NAME,
log_type = constants.MODULE_NAME,
operation = "smsUpdTagsApi",
operation = "chatUpdTagsApi",
log_input = True,
log_output = True,
sensitive_keys = ["sessionToken", "X-Session-Token", "tokenKey"]
@@ -131,13 +131,13 @@ def init(blueprint_setup_state):
@log_chain_to_mongo(attr_name = "logs_mongo")
@should_not_be_under_maintenance(attr_name = "is_under_maintenance")
@validate_input(
header_validator = lambda x: SMSUpdateTagsRequestHeaders(**x).model_dump(),
data_validator = lambda x: SMSUpdateTagsRequestData(**x)
header_validator = lambda x: ChatMessageUpdateTagsRequestHeaders(**x).model_dump(),
data_validator = lambda x: ChatMessageUpdateTagsRequestData(**x)
)
@handle_cancelled_request()
async def update_sms_tags(
inbound_headers: dict | SMSUpdateTagsRequestHeaders = None,
inbound_data: dict | SMSUpdateTagsRequestData = None,
async def update_chat_message_tags(
inbound_headers: dict | ChatMessageUpdateTagsRequestHeaders = None,
inbound_data: dict | ChatMessageUpdateTagsRequestData = None,
inbound_files: dict = None,
**kwargs
):
@@ -168,7 +168,7 @@ async def update_sms_tags(
# ┛
# Get the message:
message = await current_app.sms_controller.get_message(
message = await current_app.chat_controller.get_message(
mongo_data_conn = current_app.data_mongo,
message_id = inbound_data.messageId
)
@@ -195,7 +195,7 @@ async def update_sms_tags(
# ┛ ┛
# Update the message:
success = await current_app.sms_controller.update_sms_tags(
success = await current_app.chat_controller.update_chat_message_tags(
mongo_data_conn = current_app.data_mongo,
message_id = inbound_data.messageId,
unset_tags = inbound_data.unsetTags,
api/main.py
+11 -2
View File
@@ -62,14 +62,17 @@ from utils_v2.api.async_quart import (
# GMail-related utils:
from utils_v2.goog.controllers.gmail.gmail_client import AsyncGmailClient
# Chat clients:
from utils_v2.whatsapp.nimbus.controllers.async_nimbus_whatsapp import AsyncNimbusWhatsapp
# Core Controller Models:
from controllers.core.message import CoreMessageController
# from controllers.core.auth_token import CoreAuthTokenController
from controllers.core.ai.llm import CoreLLMController
from controllers.core.payment import CorePaymentController
# API Controller Models:
from controllers.api.mail import MailController
# # API Controller Models:
# from controllers.api.mail import MailController
# from controllers.api.sms import SMSController
# from controllers.api.payment import PaymentController
@@ -118,6 +121,9 @@ from api.blueprints.message.sms.tags import sms_update_tags_bp
# Chat Blueprints:
from api.blueprints.message.chat.auth import chat_auth_bp
# from api.blueprints.message.chat.webhook import chat_webhook_bp
from api.blueprints.message.chat.send import chat_send_bp
from api.blueprints.message.chat.list import chat_list_bp
from api.blueprints.message.chat.tags import chat_update_tags_bp
# Software Blueprints:
from api.blueprints.software.auth import sw_auth_bp
@@ -187,6 +193,9 @@ app.register_blueprint(sms_update_tags_bp, url_prefix = f"/{MODULE_BASE}/sms")
# Chat Blueprints:
app.register_blueprint(chat_auth_bp, url_prefix = f"/{MODULE_BASE}/chat")
# app.register_blueprint(chat_webhook_bp, url_prefix = f"/{MODULE_BASE}/chat")
app.register_blueprint(chat_send_bp, url_prefix = f"/{MODULE_BASE}/chat")
app.register_blueprint(chat_list_bp, url_prefix = f"/{MODULE_BASE}/chat")
app.register_blueprint(chat_update_tags_bp, url_prefix = f"/{MODULE_BASE}/chat")
# Software Blueprints:
app.register_blueprint(sw_auth_bp, url_prefix = f"/{MODULE_BASE}/software")