(20241216) Payments requesting started, callback noting started.

2024-12-16 18:29:30 +05:30
parent 0b9976fadb
commit b6ba54abd4
12 changed files with 636 additions and 117 deletions
@@ -0,0 +1,194 @@
+"""
+
+    AUTHOR:
+
+        Khushal P Soonderji
+
+    DATE:
+
+        Monday, 16th Dec., 2024
+
+    OBJECTIVE:
+
+        To receive payment updates 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.api.finstitutions.payments.request import PGPaymentRequestHeaders, PGPaymentRequestData
+from models.core.auth_token import CoreAuthTokenModel
+from models.core.payment import CorePaymentModel, PaymentEvent
+
+# For asynchronous activities:
+import asyncio
+
+
+#   *****************************************************************************************************************
+#  *****                                                                                                          ****
+# ***                                           MACROS / ONE-TIME INIT                                              ***
+#  *****                                                                                                          ****
+#   *****************************************************************************************************************
+
+
+# Related to Quart:
+pg_callback_bp = Blueprint("pg_callback", __name__)
+
+
+#   *****************************************************************************************************************
+#  *****                                                                                                          ****
+# ***                                                VARIABLES                                                      ***
+#  *****                                                                                                          ****
+#   *****************************************************************************************************************
+
+
+# --- Nothing Yet
+
+
+#   *****************************************************************************************************************
+#  *****                                                                                                          ****
+# ***                                                  FUNCTIONS                                                    ***
+#  *****                                                                                                          ****
+#   *****************************************************************************************************************
+
+
+@pg_callback_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_callback_bp.route("/callback/<payment_id>", methods = ["POST"])
+@set_api_version(api_version = "1.0.0")
+@read_input(sanitize_headers = False, sanitize_data = False)
+@log_request_to_mongo(
+    attr_name = "logs_mongo",
+    project = constants.PROJECT_NAME,
+    log_type = constants.MODULE_NAME,
+    operation = "pgClbkApi",
+    log_input = True,
+    log_output = True,
+    sensitive_keys = None
+)
+@log_chain_to_mongo(attr_name = "logs_mongo")
+@should_not_be_under_maintenance(attr_name = "is_under_maintenance")
+@handle_cancelled_request()
+async def payment_event_callback(
+        payment_id: str = None,
+        inbound_headers: dict = None,
+        inbound_data: dict = None,
+        inbound_files: dict = None,
+        **kwargs
+):
+
+    """
+    We receive payment updates for various payment gateways here.
+    :param payment_id: The id of the document in MongoDB that holds the reference to the payment.
+    :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.
+    """
+
+    # ┏┓     ┏┓              ┳  ┏
+    # ┃┓┏┓╋  ┃┃┏┓┓┏┏┳┓┏┓┏┓╋  ┃┏┓╋┏┓
+    # ┗┛┗ ┗  ┣┛┗┻┗┫┛┗┗┗ ┛┗┗  ┻┛┗┛┗┛
+    #             ┛
+
+    # payment_info = await current_app.payment_controller.get_payment_internal(
+    #     mongo_conn = current_app.data_mongo,
+    #     payment_id = ObjectId(payment_id)
+    # )
+    # print("PAYMENT INFO:", json.to_string(payment_info.model_dump(), default=str))
+
+    # For now, we just insert the event into the record:
+    event_note_success = await current_app.payment_controller.add_event(
+        mongo_conn = current_app.data_mongo,
+        payment_id = ObjectId(payment_id),
+        event = PaymentEvent(
+            paymentStatus = "unknown",
+            initByPG = True,
+            httpCode = None,
+            headers = inbound_headers,
+            payload = inbound_data
+        )
+    )
+
+    # ┳┓
+    # ┣┫┏┓┏┏┓┏┓┏┓┏┏┓
+    # ┛┗┗ ┛┣┛┗┛┛┗┛┗
+    #      ┛
+
+    # Done here:
+    return ResponseModel(
+        status_code = StatusCodes.OK if event_note_success else StatusCodes.FAILED,
+        http_code = HttpCodes.NOT_IMPLEMENTED
+    )
+
+
+#   *****************************************************************************************************************
+#  *****                                                                                                          ****
+# ***                                               MAIN PROGRAM                                                    ***
+#  *****                                                                                                          ****
+#   *****************************************************************************************************************
+
+
+if __name__ == "__main__":
+
+    pass