Source code for patcher.models.token

from datetime import datetime, timedelta, timezone
from typing import AnyStr

from pydantic import Field

from . import Model




class AccessToken(Model):
    """
    Represents an access token for authentication.

    The ``AccessToken`` class encapsulates the access token string and its expiration
    time. It provides methods to check the token's expiration status and the time
    remaining before it expires.

    :param token: The access token string used for authentication.
    :type token: AnyStr
    :param expires: The expiration datetime of the token. The default is set to January 1, 1970.
    :type expires: datetime
    """

    token: AnyStr = ""
    expires: datetime = Field(default_factory=lambda: datetime(1970, 1, 1, tzinfo=timezone.utc))

    def __str__(self):
        """
        Returns the string representation of the access token.

        This method allows the ``AccessToken`` instance to be represented by its token string.

        :return: The access token string.
        :rtype: str
        """
        return self.token

    @property
    def is_expired(self) -> bool:
        """
        Checks if the access token is expired.

        This property evaluates whether the access token has expired. A token is
        considered expired if the current time is within 60 seconds of the expiration
        time.

        :return: ``True`` if the token is expired, ``False`` otherwise.
        :rtype: bool
        """
        return self.expires - timedelta(seconds=60) < datetime.now(timezone.utc)

    @property
    def seconds_remaining(self) -> int:
        """
        Gets the number of seconds remaining until the token expires.

        This property calculates the time remaining before the token expires.
        If the token is already expired, it returns 0.

        :return: The number of seconds remaining until the token expires.
        :rtype: int
        """
        return max(0, int((self.expires - datetime.now(timezone.utc)).total_seconds()))