"""

    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/safaricom/mpesaexpress", 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 = "pgSafaricomMPesaExpressClbkApi",
    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 safaricom_m_pesa_express_callback(
        inbound_headers: dict = None,
        inbound_data: dict = None,
        inbound_files: dict = None,
        **kwargs
):

    """
    We receive payment updates for various payment gateways here.
    :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))

    # ┏┓ ┓ ┓  ┏┓
    # ┣┫┏┫┏┫  ┣ ┓┏┏┓┏┓╋
    # ┛┗┗┻┗┻  ┗┛┗┛┗ ┛┗┗

    # Map out the documented codes provided by the payment gateway.
    # URL: https://developer.safaricom.co.ke/APIs/MpesaExpressSimulate
    code_map = {
        0: {
            "status": "settled",
            "message": "Payment successful :)"
        },  # ... Success
        1037: {
            "status": "failed",
            "message": "The payment gateway could not reach your customer."
        },  # ... DS Timeout. User could not be reached.
        1025: {
            "status": "failed",
            "message": "There was a system error in the payment gateway (1025)."
        },  # ... System error while trying to send the push request.
        9999: {
            "status": "failed",
            "message": "There was a system error in the payment gateway (9999)."
        },  # ... System error while trying to send the push request.
        1032: {
            "status": "rejected",
            "message": "Your customer declined the payment request."
        },  # ... Request Cancelled by the user.
        1: {
            "status": "failed",
            "message": "Your customer has insufficient balance."
        },  # ... The user has insufficient balance.
        2001: {
            "status": "failed",
            "message": "The payment gateway says your credentials are invalid."
        },  # ... Invalid credentials of the initiator.
        1019: {
            "status": "failed",
            "message": "The transaction expired before your customer processed it."
        },  # ... Transaction expired.
        1001: {
            "status": "failed",
            "message": "Your customer is already in the middle of some transaction on the payment gateway."
        },  # ... The payer is already making some transaction.
    }

    # Figure out which of the above codes is relevant to you:
    pg_reference_id = inbound_data["Body"]["stkCallback"]["CheckoutRequestID"]
    pg_result_code = int(inbound_data["Body"]["stkCallback"]["ResultCode"])
    relevant_code = code_map.get(
        pg_result_code,
        {
            "status": "unknown",
            "message": f"Unknown code '{pg_result_code}' from the payment gateway."
        }
    )

    # For now, we just insert the event into the record:
    event_note_success = await current_app.payment_controller.add_event_by_client_reference_id(
        mongo_conn = current_app.data_mongo,
        event = PaymentEvent(
            paymentStatus = relevant_code["status"],
            message = relevant_code["message"],
            initByPG = True,
            httpCode = None,
            headers = inbound_headers,
            payload = inbound_data
        ),
        client_reference_id = pg_reference_id
    )

    # ┳┓
    # ┣┫┏┓┏┏┓┏┓┏┓┏┏┓
    # ┛┗┗ ┛┣┛┗┛┛┗┛┗
    #      ┛

    # Done here:
    return ResponseModel(
        status_code = StatusCodes.OK if event_note_success else StatusCodes.FAILED,
        http_code = HttpCodes.SUCCESS if event_note_success else HttpCodes.INTERNAL_SERVER_ERROR
    )


#   *****************************************************************************************************************
#  *****                                                                                                          ****
# ***                                               MAIN PROGRAM                                                    ***
#  *****                                                                                                          ****
#   *****************************************************************************************************************


if __name__ == "__main__":

    pass