Source code for codegrade._api.pow

"""The endpoints for pow objects.

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

from __future__ import annotations

import os
import typing as t

import cg_request_args as rqa
from cg_maybe import Maybe, Nothing

from .. import parsers, utils

if t.TYPE_CHECKING or os.getenv("CG_EAGERIMPORT", False):
    from .. import client
    from ..models.pow_challenge_response import PowChallengeResponse


_ClientT = t.TypeVar("_ClientT", bound="client._BaseClient")




class PowService(t.Generic[_ClientT]):
    __slots__ = ("__client",)

    def __init__(self, client: _ClientT) -> None:
        self.__client = client



    def get(
        self,
    ) -> PowChallengeResponse:
        """Get a proof-of-work challenge.

        Returns a challenge that must be solved before submitting requests to
        email-sending endpoints. The client must find an integer `solution`
        such that: `SHA-256(nonce + \":\" + str(solution))` has at least
        `difficulty` leading zero bits.

        :returns: A challenge with nonce and difficulty.
        """

        url = "/api/v1/pow/challenge"
        params = None

        with self.__client as client:
            resp = client.http.get(url=url, params=params)
        utils.log_warnings(resp)

        if utils.response_code_matches(resp.status_code, 200):
            from ..models.pow_challenge_response import PowChallengeResponse

            return parsers.JsonResponseParser(
                parsers.ParserFor.make(PowChallengeResponse)
            ).try_parse(resp)

        from ..models.any_error import AnyError

        raise utils.get_error(
            resp,
            (
                (
                    (400, 409, 401, 403, 404, 429, 500),
                    utils.unpack_union(AnyError),
                ),
            ),
        )