Source code for codegrade.models.block_registration_domain

"""The module that defines the ``BlockRegistrationDomain`` model.

SPDX-License-Identifier: AGPL-3.0-only OR BSD-3-Clause-Clear
"""

from __future__ import annotations

import typing as t
from dataclasses import dataclass, field

import cg_request_args as rqa

from ..utils import to_dict




@dataclass
class BlockRegistrationDomain:
    """A BLOCK registration domain rule that blocks a domain globally."""

    #: Always `'block'`.
    type: t.Literal["block"]
    #: The id of the rule.
    id: str
    #: The email domain.
    domain: str
    #: Whether subdomains are also matched.
    match_subdomains: bool

    raw_data: t.Optional[t.Dict[str, t.Any]] = field(init=False, repr=False)

    data_parser: t.ClassVar[t.Any] = rqa.Lazy(
        lambda: rqa.FixedMapping(
            rqa.RequiredArgument(
                "type",
                rqa.StringEnum("block"),
                doc="Always `'block'`.",
            ),
            rqa.RequiredArgument(
                "id",
                rqa.SimpleValue.str,
                doc="The id of the rule.",
            ),
            rqa.RequiredArgument(
                "domain",
                rqa.SimpleValue.str,
                doc="The email domain.",
            ),
            rqa.RequiredArgument(
                "match_subdomains",
                rqa.SimpleValue.bool,
                doc="Whether subdomains are also matched.",
            ),
        ).use_readable_describe(True)
    )

    def to_dict(self) -> t.Dict[str, t.Any]:
        res: t.Dict[str, t.Any] = {
            "type": to_dict(self.type),
            "id": to_dict(self.id),
            "domain": to_dict(self.domain),
            "match_subdomains": to_dict(self.match_subdomains),
        }
        return res

    @classmethod
    def from_dict(
        cls: t.Type[BlockRegistrationDomain], d: t.Dict[str, t.Any]
    ) -> BlockRegistrationDomain:
        parsed = cls.data_parser.try_parse(d)

        res = cls(
            type=parsed.type,
            id=parsed.id,
            domain=parsed.domain,
            match_subdomains=parsed.match_subdomains,
        )
        res.raw_data = d
        return res