"""

    AUTHOR:

        Khushal P Soonderji

    DATE:

        Thursday, 28th Nov., 2024

    OBJECTIVE:

        To provide a way to retrieve dates of important events like financial-results, stock-splits, fund-raising, etc.
        from NSE's portal.

        NOTE: This method involves web scraping. It is good for proof-of-concept development, but it is recommended that
        more professional data-sources be used when the product starts becoming mature.

    REFERENCES:

        N/A

    DOWNLOADS:

        N/A

"""


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


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

# System-level activities:
import io

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

# NSE-related utils:
from utils_v2.nse.controllers.base import AsyncNSEBase
from utils_v2.nse.models.api_call import NSEApiResponse

# data models:
from utils_v2.nse.models.calendar import NSECorporateAction

# To make REST-ful API calls:
import httpx

# To work with date and time:
import datetime
import pytz

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

# For asynchronous activities:
import asyncio


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


# --- Nothing Yet


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


# --- Nothing Yet


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


class NSECorporateActionsCalendar(AsyncNSEBase):

    # The types of corporate actions/entities:
    KIND_EQUITIES = "equities"
    KIND_MUTUAL_FUNDS = "mf"
    KIND_DEBT = "debt"
    KIND_SME = "sme"

    def __init__(
            self,
            http_client: httpx.AsyncClient = None,
            cookies_refresh_interval: int | float = 300,
            debug = True,
            debug_prefix = "NSE (C.Act.) | ",
            debug_only_errors = True
    ):

        # Pass on the initialization to the parent:
        super().__init__(
            base_url = r"https://www.nseindia.com/companies-listing/corporate-filings-actions",
            data_url = r"https://www.nseindia.com/api/corporates-corporateActions",
            http_client = http_client,
            cookies_refresh_interval = cookies_refresh_interval,
            debug = debug,
            debug_prefix = debug_prefix,
            debug_only_errors = debug_only_errors
        )

    async def get_data(
            self,
            kind: str = KIND_EQUITIES,
            from_date: datetime.datetime = None,
            to_date: datetime.datetime = None,
            return_raw: bool = False,
            refresh_cookies: bool = True,
            force_refresh_cookies: bool = False,
            retry_count: int = 1,
            backoff_seconds: int | float = 0.5,
            backoff_multiplier: float = 1.1
    ) -> NSEApiResponse:

        """
        To get the data of the corporate event calendar.
        :param kind: The option between 'equities", "mf", "debt", and "sme".
        :param from_date: The starting date (inclusive) from which the events must be fetched.
        :param to_date: The ending date (inclusive) till which the events must be fetched.
        :param return_raw: Whether you want the raw JSON from NSE or you want it formatted.
        :param refresh_cookies: Whether, or not, you would like to refresh the cookies.
        :param force_refresh_cookies: If set to True, cookies will be refreshed even if not timed out. If set to False,
            cookies will be refreshed only when the interval passed to the constructor has elapsed since the last
            successful refresh.
        :param retry_count: The no. of times to try to get the data from the API.
        :param backoff_seconds: The delay between unsuccessful API calls.
        :param backoff_multiplier: The multiplier to add to the delay to change delay.
        :return: The raw or formatted event calendar data in the 'data' field of the response model.
        """

        # Prepare the inputs:
        now = date_time.get_current_utc_date_time(as_string = False)
        from_date = date_time.to_timezone(from_date or now, timezone = date_time.TIMEZONE_IST).strftime("%d-%m-%Y")
        to_date = date_time.to_timezone(to_date or now, timezone = date_time.TIMEZONE_IST).strftime("%d-%m-%Y")

        # Make the API call:
        api_response = await self.get(
            params = {
                "index": kind,
                "from_date": from_date,
                "to_date": to_date,
            },
            refresh_cookies = refresh_cookies,
            force_refresh_cookies = force_refresh_cookies,
            retry_count = retry_count,
            backoff_seconds = backoff_seconds,
            backoff_multiplier = backoff_multiplier
        )

        # If the API call was successful:
        if api_response.httpCode in [200]:
            api_response.success = True
            if return_raw: api_response.data = await api_response.get_json()
            else:
                try: api_response.data = self.format_data(
                    raw_json = await api_response.get_json(),
                    kind = kind,
                    timestamp = date_time.get_current_utc_date_time(as_string = True),
                    raise_exception = True
                )
                except Exception as exception:
                    api_response.exception = exception
                    api_response.success = False

        # Done here:
        return api_response

    def format_data(
            self,
            raw_json: List[dict],
            kind: str = None,
            timestamp: datetime.datetime = None,
            raise_exception: bool = False
    ) -> List[NSECorporateAction] | None:

        """
        We format the data here to be able to retrieve it properly later.
        :param raw_json: The raw data as scraped from NSE.
        :param kind: The kind of data pulled using the 'get_data' method.
        :param timestamp: The timestamp at which the data was scraped. This shall be useful for data retrieval from the
            database, later.
        :param raise_exception: If set to True, any exception will be propagated. If set to False, any exception will be
            suppressed internally.
        :return: The formatted data if successful, else None.
        """

        # Can't do anything if the chain itself is null:
        if raw_json is None: return []
        if not isinstance(raw_json, list): return []

        # Start by assuming failure:
        formatted_data = None

        # Ensure that we've got a proper timestamp:
        if timestamp is None: timestamp = date_time.get_current_utc_date_time(as_string = False)

        try:

            # Format the data:
            formatted_data = []
            for action in raw_json:
                formatted_data.append(NSECorporateAction(**{
                    "scrapeTs": timestamp,
                    "kind": kind,
                    "symbol": action["symbol"],
                    "name": action["comp"],
                    "isin": action["isin"],
                    "series": action["series"],
                    "ind": action["ind"],
                    "faceVal": float(action["faceVal"]),
                    "action": action["subject"],
                    "exTs": self.parse_datetime_string(action["exDate"], ["%d-%b-%Y"]),
                    "recTs": self.parse_datetime_string(action["recDate"]),
                    "bcStartTs": self.parse_datetime_string(action["bcStartDate"]),
                    "bcEndTs": self.parse_datetime_string(action["bcEndDate"]),
                    "ndStartTs": self.parse_datetime_string(action["ndStartDate"]),
                    "ndEndTs": self.parse_datetime_string(action["ndEndDate"]),
                    "caBroadcastTs": self.parse_datetime_string(action["caBroadcastDate"])
                }))

        # If something goes wrong:
        except Exception as exception:
            formatted_data = None
            if raise_exception: raise

        # Done here:
        return formatted_data


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


if __name__ == "__main__":

    async def main():

        # Create an instance of the scraper, and refresh its cookies:
        my_nse = NSECorporateActionsCalendar()

        # Get and show the data:
        now = date_time.get_current_ist_date_time()
        to_date = now + datetime.timedelta(days = 31)
        from_date = now - datetime.timedelta(days = 31)
        print("FROM :", from_date)
        print("TO   :", to_date)
        api_response = await my_nse.get_data(
            kind = NSECorporateActionsCalendar.KIND_DEBT,
            from_date = from_date,
            to_date = to_date,
            return_raw = False
        )
        print("SUMMARY:", api_response.to_markdown(), "\n---\n\n")
        if api_response.success: print("CORPORATE ACTIONS:", json.to_string(api_response.data, default = str))
        else: raise api_response.exception

    asyncio.run(main())
