226 lines
8.1 KiB
Python
226 lines
8.1 KiB
Python
"""
|
|
|
|
AUTHOR:
|
|
|
|
Khushal P Soonderji
|
|
|
|
DATE:
|
|
|
|
Saturday, 28th Dec., 2024
|
|
|
|
OBJECTIVE:
|
|
|
|
To request payments from customers from various financial institutions.
|
|
|
|
REFERENCES:
|
|
|
|
N/A
|
|
|
|
DOWNLOADS:
|
|
|
|
N/A
|
|
|
|
NOTES:
|
|
|
|
N/A
|
|
|
|
"""
|
|
|
|
|
|
# *****************************************************************************************************************
|
|
# ***** ****
|
|
# *** IMPORT ***
|
|
# ***** ****
|
|
# *****************************************************************************************************************
|
|
|
|
|
|
# To make sibling directories accessible for imports:
|
|
import sys
|
|
sys.path.append(".")
|
|
sys.path.append("..")
|
|
|
|
# For using Quart:
|
|
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.api.response import ResponseModel
|
|
from utils_v2.api.async_quart import (
|
|
set_api_version,
|
|
read_input,
|
|
get_session_info,
|
|
log_request_to_mongo,
|
|
log_chain_to_mongo,
|
|
should_not_be_under_maintenance,
|
|
only_whitelisted_ips,
|
|
limit_rate,
|
|
validate_input,
|
|
handle_cancelled_request
|
|
)
|
|
|
|
# Common:
|
|
from shared import constants
|
|
|
|
# To work with MongoDB:
|
|
from bson.objectid import ObjectId
|
|
|
|
# Data Models:
|
|
from models.core.user import CoreUserInfoModel
|
|
from models.api.finstitutions.payments.request import PGPaymentRequestHeaders, PGPaymentRequestData
|
|
from models.core.auth_token import CoreAuthTokenModel
|
|
|
|
# For asynchronous activities:
|
|
import asyncio
|
|
|
|
|
|
# *****************************************************************************************************************
|
|
# ***** ****
|
|
# *** MACROS / ONE-TIME INIT ***
|
|
# ***** ****
|
|
# *****************************************************************************************************************
|
|
|
|
|
|
# Related to Quart:
|
|
pg_request_bp = Blueprint("pg_request", __name__)
|
|
|
|
|
|
# *****************************************************************************************************************
|
|
# ***** ****
|
|
# *** VARIABLES ***
|
|
# ***** ****
|
|
# *****************************************************************************************************************
|
|
|
|
|
|
# --- Nothing Yet
|
|
|
|
|
|
# *****************************************************************************************************************
|
|
# ***** ****
|
|
# *** FUNCTIONS ***
|
|
# ***** ****
|
|
# *****************************************************************************************************************
|
|
|
|
|
|
@pg_request_bp.record_once
|
|
def init(blueprint_setup_state):
|
|
|
|
# This gets called when the blueprint is registered.
|
|
# Consider this to be a one-time setup for the whole blueprint:
|
|
pass
|
|
|
|
|
|
# ---------------------------------------------------------------------------------------------------------------------
|
|
|
|
|
|
@pg_request_bp.route("/request", 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")
|
|
@log_request_to_mongo(
|
|
attr_name = "logs_mongo",
|
|
project = constants.PROJECT_NAME,
|
|
log_type = constants.MODULE_NAME,
|
|
operation = "pgReqApi",
|
|
log_input = True,
|
|
log_output = True,
|
|
sensitive_keys = ["sessionToken", "X-Session-Token"]
|
|
)
|
|
@log_chain_to_mongo(attr_name = "logs_mongo")
|
|
@should_not_be_under_maintenance(attr_name = "is_under_maintenance")
|
|
@validate_input(
|
|
header_validator = lambda x: PGPaymentRequestHeaders(**x).model_dump(),
|
|
data_validator = lambda x: PGPaymentRequestData(**x)
|
|
)
|
|
@handle_cancelled_request()
|
|
async def request_payment(
|
|
inbound_headers: dict | PGPaymentRequestHeaders = None,
|
|
inbound_data: dict | PGPaymentRequestData = None,
|
|
inbound_files: dict = None,
|
|
**kwargs
|
|
):
|
|
|
|
"""
|
|
To request payments from customers through payment gateways.
|
|
:param inbound_headers: auto-extracted by the decorators.
|
|
:param inbound_data: auto-extracted by the decorators.
|
|
:param inbound_files: auto-extracted by the decorators.
|
|
:param kwargs: Any number of extra inputs supplied by the decorators.
|
|
:return: A standard response structure.
|
|
"""
|
|
|
|
# ┏┓
|
|
# ┃┃┏┓┏┓┏┓┏┓┏┓┏┏┓┏┏
|
|
# ┣┛┛ ┗ ┣┛┛ ┗┛┗┗ ┛┛
|
|
# ┛
|
|
|
|
# If the session token is invalid/expired:
|
|
if kwargs.get("session_info") is None:
|
|
return ResponseModel(
|
|
status_code = StatusCodes.FAILED,
|
|
http_code = HttpCodes.UNAUTHORIZED
|
|
)
|
|
|
|
# Get the token from the token key:
|
|
auth_token = await current_app.payments_controller.get_token_from_key(
|
|
mongo_data_conn = current_app.data_mongo,
|
|
token_key = inbound_data.tokenKey
|
|
)
|
|
if auth_token is None: return ResponseModel(
|
|
status_code = StatusCodes.FAILED,
|
|
http_code = HttpCodes.UNAUTHORIZED,
|
|
message = f"No such token key."
|
|
)
|
|
|
|
# Get the user's info:
|
|
user_info = CoreUserInfoModel(**kwargs["session_info"])
|
|
|
|
# Add required details to the payment's metadata:
|
|
inbound_data.metadata.idUser = user_info.userId
|
|
|
|
# ┳┓ ┏┓
|
|
# ┣┫┏┓┏┓┓┏┏┓┏╋ ┃┃┏┓┓┏┏┳┓┏┓┏┓╋
|
|
# ┛┗┗ ┗┫┗┻┗ ┛┗ ┣┛┗┻┗┫┛┗┗┗ ┛┗┗
|
|
# ┗ ┛
|
|
|
|
# For Safaricom's M-Pesa Express client:
|
|
if auth_token.client == "safaricomMPesaExpress":
|
|
response = await current_app.safaricom_mpesa_express_controller.request_payment(
|
|
sql_conn = current_app.sql_writer,
|
|
mongo_data_conn = current_app.data_mongo,
|
|
auth_token = auth_token,
|
|
user_info = user_info,
|
|
payment_request = inbound_data
|
|
)
|
|
|
|
# Invalid client:
|
|
else: return ResponseModel(
|
|
status_code = StatusCodes.FAILED,
|
|
http_code = HttpCodes.BAD_REQUEST,
|
|
message = f"Invalid/unimplemented client '{auth_token.client}'"
|
|
)
|
|
|
|
# ┳┓
|
|
# ┣┫┏┓┏┏┓┏┓┏┓┏┏┓
|
|
# ┛┗┗ ┛┣┛┗┛┛┗┛┗
|
|
# ┛
|
|
|
|
# Done here:
|
|
return ResponseModel(
|
|
status_code = StatusCodes.OK if response.success else StatusCodes.FAILED,
|
|
http_code = HttpCodes.SUCCESS if response.success else HttpCodes.INTERNAL_SERVER_ERROR,
|
|
message = response.message
|
|
)
|
|
|
|
|
|
# *****************************************************************************************************************
|
|
# ***** ****
|
|
# *** MAIN PROGRAM ***
|
|
# ***** ****
|
|
# *****************************************************************************************************************
|
|
|
|
|
|
if __name__ == "__main__":
|
|
|
|
pass
|