(20241218) Can now send tags to apply with the payment request itself, and can even update tags later.

2024-12-18 10:24:42 +05:30
parent 85cc330711
commit c340ebcba5
7 changed files with 388 additions and 4 deletions
@@ -195,7 +195,7 @@ async def get_one_payment_record(
    ): return ResponseModel(
        status_code = StatusCodes.FAILED,
        http_code = HttpCodes.UNAUTHORIZED,
-        message = "The message does not belong to this user."
+        message = "The record does not belong to this user."
    )

    # ┳┓
@@ -0,0 +1,234 @@
+"""
+
+    AUTHOR:
+
+        Khushal P Soonderji
+
+    DATE:
+
+        Wednesday, 18th Dec., 2024
+
+    OBJECTIVE:
+
+        To update the tags on one payment record.
+
+    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, g, request
+
+# My utils:
+from utils_v2.string import json
+from utils_v2.database.async_mongo_v2 import AsyncMongo
+from utils_v2.api.codes import StatusCodes, HttpCodes
+from utils_v2.api.response import ResponseModel
+from utils_v2.api.async_quart import (
+    make_ordered_json,
+    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
+)
+
+# GMail-related utils:
+from utils_v2.goog.gmail.gmail_client import SCOPES_GMAIL_MAIL_MANAGEMENT
+from utils_v2.goog.models.auth_tokens import GoogleAuthTokens
+
+# Common:
+from shared import constants
+
+# Data Models:
+from models.api.finstitutions.payments.tags import PGPaymentUpdateTagsRequestHeaders, PGPaymentUpdateTagsRequestData
+from models.core.user import CoreUserInfoModel
+
+# To work with datatypes:
+from typing import Literal
+
+# For asynchronous activities:
+import asyncio
+
+# To work with date and time:
+import datetime
+
+# Helpers:
+from api.helpers.user import token_check
+
+
+#   *****************************************************************************************************************
+#  *****                                                                                                          ****
+# ***                                           MACROS / ONE-TIME INIT                                              ***
+#  *****                                                                                                          ****
+#   *****************************************************************************************************************
+
+
+# Related to Quart:
+pg_tags_update_bp = Blueprint("pg_tags_update", __name__)
+
+
+#   *****************************************************************************************************************
+#  *****                                                                                                          ****
+# ***                                                VARIABLES                                                      ***
+#  *****                                                                                                          ****
+#   *****************************************************************************************************************
+
+
+# --- Nothing Yet
+
+
+#   *****************************************************************************************************************
+#  *****                                                                                                          ****
+# ***                                                  FUNCTIONS                                                    ***
+#  *****                                                                                                          ****
+#   *****************************************************************************************************************
+
+
+@pg_tags_update_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_tags_update_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")
+@log_request_to_mongo(
+    attr_name = "logs_mongo",
+    project = constants.PROJECT_NAME,
+    log_type = constants.MODULE_NAME,
+    operation = "pgTagsUpdtApi",
+    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: PGPaymentUpdateTagsRequestHeaders(**x).model_dump(),
+    data_validator = lambda x: PGPaymentUpdateTagsRequestData(**x)
+)
+@handle_cancelled_request()
+async def update_payment_record_tags(
+        inbound_headers: dict | PGPaymentUpdateTagsRequestHeaders = None,
+        inbound_data: dict | PGPaymentUpdateTagsRequestData = None,
+        inbound_files: dict = None,
+        **kwargs
+):
+
+    """
+    Use this endpoint to update the tags on an payment record.
+    :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 payment record:
+    record = await current_app.payment_controller.get_payment(
+        mongo_conn = current_app.data_mongo,
+        payment_id = inbound_data.paymentId
+    )
+
+    # ┏┓          ┓ •    ┏┓┓    ┓
+    # ┃┃┓┏┏┏┓┏┓┏┓┏┣┓┓┏┓  ┃ ┣┓┏┓┏┃┏
+    # ┗┛┗┻┛┛┗┗ ┛ ┛┛┗┗┣┛  ┗┛┛┗┗ ┗┛┗
+    #                ┛
+
+    # We check if the token that was used to fetch the mail is owned by this user:
+    if not await token_check.is_authorized(
+            mongo_conn = current_app.data_mongo,
+            user_info = CoreUserInfoModel(**kwargs["session_info"]),
+            token_ids = [record.tokenId]
+    ): return ResponseModel(
+        status_code = StatusCodes.FAILED,
+        http_code = HttpCodes.UNAUTHORIZED,
+        message = "The record does not belong to this user."
+    )
+
+    # ┳┳   ┓       ┳┓        ┓
+    # ┃┃┏┓┏┫┏┓╋┏┓  ┣┫┏┓┏┏┓┏┓┏┫
+    # ┗┛┣┛┗┻┗┻┗┗   ┛┗┗ ┗┗┛┛ ┗┻
+    #   ┛
+
+    # Update the record:
+    success = await current_app.payment_controller.update_tags(
+        mongo_conn = current_app.data_mongo,
+        payment_id = inbound_data.paymentId,
+        unset_tags = inbound_data.unsetTags,
+        set_tags = inbound_data.setTags
+    )
+
+    # ┳┓
+    # ┣┫┏┓┏┏┓┏┓┏┓┏┏┓
+    # ┛┗┗ ┛┣┛┗┛┛┗┛┗
+    #      ┛
+
+    # Done here:
+    return ResponseModel(
+        status_code = StatusCodes.OK if success else StatusCodes.FAILED,
+        http_code = HttpCodes.SUCCESS if success else HttpCodes.INTERNAL_SERVER_ERROR
+    )
+
+
+#   *****************************************************************************************************************
+#  *****                                                                                                          ****
+# ***                                               MAIN PROGRAM                                                    ***
+#  *****                                                                                                          ****
+#   *****************************************************************************************************************
+
+
+if __name__ == "__main__":
+
+    pass
@@ -36,8 +36,8 @@

 # To make sibling directories accessible for imports:
 import sys
+sys.path.append(".")
 sys.path.append("..")
-sys.path.append("../..")

 # For using Quart:
 from quart import Blueprint, current_app, g, request