"""

    AUTHOR:

        Khushal P Soonderji

    DATE:

        Wednesday, 30th Oct., 2024.

    OBJECTIVE:

        To provide a data model for describing the API response from Google's APIs.

    REFERENCES:

        N/A

    DOWNLOADS:

        N/A

"""


#   *****************************************************************************************************************
#  *****                                                                                                          ****
# ***                                                   IMPORT                                                      ***
#  *****                                                                                                          ****
#   *****************************************************************************************************************


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

# For making data behaviour_models:
from pydantic import BaseModel, Field, field_validator, model_validator
from typing import Optional, Literal, Union, Dict, List, Any

# My utils:
from utils_v2.string import json
from utils_v2.string import regex


#   *****************************************************************************************************************
#  *****                                                                                                          ****
# ***                                           MACROS / ONE-TIME INIT                                              ***
#  *****                                                                                                          ****
#   *****************************************************************************************************************


# --- Nothing Yet


#   *****************************************************************************************************************
#  *****                                                                                                          ****
# ***                                                VARIABLES                                                      ***
#  *****                                                                                                          ****
#   *****************************************************************************************************************


# --- Nothing Yet


#   *****************************************************************************************************************
#  *****                                                                                                          ****
# ***                                                  FUNCTIONS                                                    ***
#  *****                                                                                                          ****
#   *****************************************************************************************************************


class NSEApiResponse(BaseModel):

    action: str = Field(frozen = True, default = None)

    url: str = Field(frozen = True)
    method: str = Field(frozen = True)
    response: Any = None
    httpCode: int = None

    success: bool = False
    message: str = None
    data: Any = None

    exception: Any = None

    # ┏┓    ┏•
    # ┃ ┏┓┏┓╋┓┏┓
    # ┗┛┗┛┛┗┛┗┗┫
    #          ┛

    class Config:
        extra = "forbid"

    # ┏┓           ┏┓
    # ┃ ┓┏┏╋┏┓┏┳┓  ┣ ┓┏┏┓┏┏
    # ┗┛┗┻┛┗┗┛┛┗┗  ┻ ┗┻┛┗┗┛

    def to_markdown(self):
        if self.exception: message = "❌ *NSE API EXCEPTION:* ❌\n\n"
        else: message = "*NSE API RESPONSE:*\n\n"
        message += f"*ACTION:*\n`{self.action}`\n\n"
        message += f"*URL:*\n`{self.url}`\n\n"
        message += f"*METHOD:*\n`{self.method}`\n\n"
        message += f"*RESPONSE:*\n`{self.response}`\n\n"
        message += f"*MESSAGE:*\n`{self.message}`\n\n"
        message += f"*EXCEPTION:*\n`{self.exception.__class__.__name__}: {str(self.exception)}`\n\n"
        return message

    async def get_json(self):
        try: return self.response.json()
        except: return {}

    async def get_content(self):
        try: return self.response.content
        except: return b""


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


if __name__ == "__main__":

    pass