SIMNet/simnet/models/lab/daily.py

import calendar
from datetime import timezone, timedelta, datetime
from typing import NamedTuple

from pydantic import Field

from simnet.models.base import APIModel

__all__ = ("ClaimedDailyReward", "DailyReward", "DailyRewardInfo")


class DailyRewardInfo(NamedTuple):
    """Information about the current daily reward status.

    Attributes:
        signed_in (bool): Whether the user has signed in today.
        claimed_rewards (int): The number of rewards claimed today.
    """

    signed_in: bool
    claimed_rewards: int

    @property
    def missed_rewards(self) -> int:
        """The number of rewards that the user has missed since the start of the month."""
        cn_timezone = timezone(timedelta(hours=8))
        now = datetime.now(cn_timezone)
        month_days = calendar.monthrange(now.year, now.month)[1]
        return month_days - self.claimed_rewards


class DailyReward(APIModel):
    """Claimable daily reward.

    Attributes:
        name (str): The name of the reward.
        amount (int): The amount of the reward.
        icon (str): The URL of the icon for the reward.
    """

    name: str
    amount: int = Field(alias="cnt")
    icon: str


class ClaimedDailyReward(APIModel):
    """Claimed daily reward.

    Attributes:
        id (int): The ID of the claimed reward.
        name (str): The name of the reward.
        amount (int): The amount of the reward.
        icon (str): The URL of the icon for the reward.
        time (datetime): The time at which the reward was claimed.
    """

    id: int
    name: str
    amount: int = Field(alias="cnt")
    icon: str = Field(alias="img")
    time: datetime = Field(alias="created_at", tzinfo=timezone(timedelta(hours=8)))