"""

    AUTHOR:

        Khushal P Soonderji

    DATE:

        Thursday, 19th Dec., 2024

    OBJECTIVE:

        To handle all SMS related behaviour for all third-party clients from one place.

    REFERENCES:

        N/A

    DOWNLOADS:

        N/A

"""


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


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

# My async utils:
from utils_v2.date_time import date_time
from utils_v2.database.async_mongo_v2 import AsyncMongo
from utils_v2.cache.async_redis_cache_v2 import AsyncRedisCache

# Controllers:
from controllers_v2.message.sms.base import SMSController

# Models:
from models.core.auth_token import CoreAuthTokenModel
from models.core.message import CoreMessageModel
from models.api.message.sms.send import (
    NimbusSMSIndiaMessage,
    SMSSendOneResult,
    SMSSendManyResults
)

# SMS Clients:
from utils_v2.sms.india.nimbus.controllers.async_nimbus import AsyncNimbusSMS

# To work with datatypes:
from typing import List, Any

# To make HTTP requests:
import httpx

# For asynchronous activities:
import asyncio


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


# --- Nothing Yet


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


# --- Nothing Yet


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


# --- Nothing Yet


#   *****************************************************************************************************************
#  *****                                                                                                          ****
# ***                                                   CLASSES                                                     ***
#  *****                                                                                                          ****
#   *****************************************************************************************************************


class AllSMSController(SMSController):

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

    def __init__(
            self,
            cache: AsyncRedisCache = None,
            http_client: httpx.AsyncClient = None,
            alert_url: str = None,
            debug: bool = True,
            debug_prefix: str = "All SMS (C) | ",
            debug_only_errors: bool = True
    ):

        """
        This is the foundational controller for all SMS services. This is built on top of the core message controller,
        and, in turn, all individual SMS client controllers must be built on top of this.
        :param cache: The object to use for caching results from database calls.
        :param http_client: The HTTP client
        :param debug: Whether, or not, you would like to print debugging messages:
        :param debug_prefix: The prefix to print with the debugging messages.
        :param debug_only_errors: Whether you would like to print only error messages or all messages.
        :return: None.
        """

        # Invoke the parent's constructor:
        super().__init__(
            cache = cache,
            alert_url = alert_url,
            http_client = http_client,
            base_filter = None,
            debug = debug,
            debug_prefix = debug_prefix,
            debug_only_errors = debug_only_errors
        )

    # ┏┓┳┳┓┏┓  ┏┓     ┓•
    # ┗┓┃┃┃┗┓  ┗┓┏┓┏┓┏┫┓┏┓┏┓
    # ┗┛┛ ┗┗┛  ┗┛┗ ┛┗┗┻┗┛┗┗┫
    #                      ┛

    async def send_one_sms(
            self,
            mongo_data_conn: AsyncMongo,
            auth_token: CoreAuthTokenModel,
            client: AsyncNimbusSMS,
            message: NimbusSMSIndiaMessage,
            tags: List[Any]
    ) -> SMSSendOneResult:

        """
        Just a placeholder to match the abstract parent.
        :param mongo_data_conn: The database connection to use to perform this task.
        :param auth_token: The auth token that will be used to send this message.
        :param client: The third-party SMS client to use to send this message.
        :param message: The actual message that needs to be sent.
        :param tags: Any tags to attach with this SMS for filtering when querying in the listing service.
        :return: The structured result of sending one message.
        """

        raise NotImplementedError

    async def send_many_sms(
            self,
            mongo_data_conn: AsyncMongo,
            auth_token: CoreAuthTokenModel,
            messages: List[NimbusSMSIndiaMessage],
            tags: List[Any]
    ) -> SMSSendManyResults:

        """
        Just a placeholder to match the abstract parent.
        individual message, and then aggregates the results.
        :param mongo_data_conn: The database connection to use to perform this task.
        :param auth_token: The auth token that will be used to send this message.
        :param messages: The list of messages to send out.
        :param tags: Any tags to attach with these SMS for filtering when querying in the listing service. The same tags
            will be applied to all messages. Do not call this method if you need to have different tags for all of them.
        :return: The structured result of sending many SMS messages.
        """

        raise NotImplementedError


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


if __name__ == "__main__":

    pass
