api_utils_converse_v2/models/software/mikrotik/configure.py

"""

    AUTHOR:

        Khushal P Soonderji

    DATE:

        Monday, 10th Feb., 2025.

    OBJECTIVE:

        To provide a structure to receive auth details for MikroTik devices.

    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, PastDatetime, model_validator
from typing import Optional, Literal, Union, Any

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

# To work with date and time:
import datetime


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


# RegEx Patterns:
REGEX_SESSION_TOKEN = r"^[a-f0-9]{8}-[a-f0-9]{4}-[1-5][a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$"


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


# --- Nothing Yet


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


class MikroTikPPPoE1000Auth(BaseModel):

    siteName: str = Field(
        description = "Don't know, and don't want to know.",
        min_length = 1,
        frozen = True
    )

    nasIp: str = Field(
        description = "Don't know, and don't want to know.",
        min_length = 1,
        frozen = True
    )

    nasPort: int | None = Field(
        description = "Don't know, and don't want to know.",
        frozen = True,
        default = None
    )

    radius: str = Field(
        description = "Don't know, and don't want to know.",
        min_length = 1,
        frozen = True
    )

    secret: str = Field(
        description = "Don't know, and don't want to know.",
        min_length = 1,
        frozen = True
    )

    username: str = Field(
        description = "Don't know, and don't want to know.",
        min_length = 1,
        frozen = True
    )

    password: str = Field(
        description = "Don't know, and don't want to know.",
        min_length = 1,
        frozen = True
    )

    location: str = Field(
        description = "Don't know, and don't want to know.",
        min_length = 1,
        frozen = True
    )

    snmpCommunity: str = Field(
        description = "Don't know, and don't want to know.",
        min_length = 1,
        frozen = True
    )

    publicIpPool: str = Field(
        description = "Don't know, and don't want to know.",
        min_length = 1,
        frozen = True
    )

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

    class Config:
        extra = "forbid"

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

    @field_validator("nasPort", mode = "before")
    def validate_port_no(cls, value):
        if isinstance(value, (str, float)): value = int(value)
        return value


# ---------------------------------------------------------------------------------------------------------------------


class MikroTikHotspot1000Auth(BaseModel):

    siteName: str = Field(
        description = "Don't know, and don't want to know.",
        min_length = 1,
        frozen = True
    )

    nasIp: str = Field(
        description = "Don't know, and don't want to know.",
        min_length = 1,
        frozen = True
    )

    nasPort: int | None = Field(
        description = "Don't know, and don't want to know.",
        frozen = True,
        default = None
    )

    radius: str = Field(
        description = "Don't know, and don't want to know.",
        min_length = 1,
        frozen = True
    )

    secret: str = Field(
        description = "Don't know, and don't want to know.",
        min_length = 1,
        frozen = True
    )

    username: str = Field(
        description = "Don't know, and don't want to know.",
        min_length = 1,
        frozen = True
    )

    password: str = Field(
        description = "Don't know, and don't want to know.",
        min_length = 1,
        frozen = True
    )

    location: str = Field(
        description = "Don't know, and don't want to know.",
        min_length = 1,
        frozen = True
    )

    snmpCommunity: str = Field(
        description = "Don't know, and don't want to know.",
        min_length = 1,
        frozen = True
    )

    vlanRange: str = Field(
        description = "Don't know, and don't want to know.",
        min_length = 1,
        frozen = True
    )

    privateIpPool: str = Field(
        description = "Don't know, and don't want to know.",
        min_length = 1,
        frozen = True
    )

    publicIpPool: str = Field(
        description = "Don't know, and don't want to know.",
        min_length = 1,
        frozen = True
    )

    domainName: str = Field(
        description = "Don't know, and don't want to know.",
        min_length = 1,
        frozen = True
    )

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

    class Config:
        extra = "forbid"

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

    @field_validator("nasPort", mode = "before")
    def validate_port_no(cls, value):
        if isinstance(value, (str, float)): value = int(value)
        return value


# ---------------------------------------------------------------------------------------------------------------------


class MikroTikAuthResponse(BaseModel):

    success: bool = Field(
        description = "To indicate whether or not, the action was a success",
        frozen = False,
        default = False
    )

    message: str = Field(
        description = "To explain what happened in the process of handling the OAuth callback.",
        frozen = False,
        default = "ERR: Message not captured."
    )

    exception: Any = Field(
        description = "To pass on any exception that occurred in the process.",
        frozen = False,
        default = None
    )

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

    class Config:
        extra = "forbid"

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

    pass

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

    pass


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


if __name__ == "__main__":

    pass