codegrade 17.0.44__tar.gz → 17.0.46__tar.gz

{codegrade-17.0.44 → codegrade-17.0.46}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: codegrade
-Version: 17.0.44
+Version: 17.0.46
 Summary: A client library for accessing CodeGrade
 Project-URL: Documentation, https://python.api.codegrade.com
 License-Expression: AGPL-3.0-only OR BSD-3-Clause-Clear

{codegrade-17.0.44 → codegrade-17.0.46}/docs/clients/AuthenticatedClient.rst

@@ -41,6 +41,7 @@ AuthenticatedClient
       ~AuthenticatedClient.permission
       ~AuthenticatedClient.plagiarism
       ~AuthenticatedClient.pow
+      ~AuthenticatedClient.quarantined_registration
       ~AuthenticatedClient.registration_domain
       ~AuthenticatedClient.restriction
       ~AuthenticatedClient.role

{codegrade-17.0.44 → codegrade-17.0.46}/docs/conf.py

@@ -39,7 +39,7 @@ author = "CodeGrade Team"
 # built documents.
 #
 # The short X.Y version.
-version = "17.0.44"
+version = "17.0.46"
 # The full version, including alpha/beta/rc tags.
 release = version
 
@@ -103,7 +103,7 @@ html_js_files = ["toggle.js"]
 
 html_favicon = "_static/favicon/favicon.ico"
 html_logo = "_static/images/logo.svg"
-html_title = "CodeGrade 17.0.44"
+html_title = "CodeGrade 17.0.46"
 
 # -- Extension configuration -------------------------------------------------
 

codegrade-17.0.46/docs/models/AcceptQuarantinedRegistrationData.rst

@@ -0,0 +1,9 @@
+AcceptQuarantinedRegistrationData
+=================================
+
+.. currentmodule:: codegrade.models.accept_quarantined_registration_data
+
+.. autoclass:: AcceptQuarantinedRegistrationData
+   :members: tenant_role_id
+   :inherited-members:
+   :exclude-members: raw_data, data_parser, to_dict, from_dict, __init__, __new__

codegrade-17.0.46/docs/models/DenyQuarantinedRegistrationData.rst

@@ -0,0 +1,9 @@
+DenyQuarantinedRegistrationData
+===============================
+
+.. currentmodule:: codegrade.models.deny_quarantined_registration_data
+
+.. autoclass:: DenyQuarantinedRegistrationData
+   :members: explanation
+   :inherited-members:
+   :exclude-members: raw_data, data_parser, to_dict, from_dict, __init__, __new__

{codegrade-17.0.44 → codegrade-17.0.46}/docs/models/GlobalPermMap.rst

@@ -4,6 +4,6 @@ GlobalPermMap
 .. currentmodule:: codegrade.models.global_perm_map
 
 .. autoclass:: GlobalPermMap
-   :members: can_add_users, can_create_courses, can_manage_site_users, can_search_users, can_impersonate_users, can_manage_lti_providers, can_delete_community_library_items, can_list_hidden_tenants, can_manage_pearson_templates, can_view_community_library_items, can_view_all_community_library_items, can_create_community_library_items, is_admin, can_see_teacher_announcements, can_manage_sso_providers, can_manage_site_settings, can_manage_background_jobs, can_create_tenant, can_create_courses_for_other_tenants, can_see_other_tenant_statistics, can_search_users_other_tenant, can_skip_payment, can_edit_pricing, can_see_all_transactions, can_edit_coupons, can_see_coupons, can_use_snippets, can_edit_own_info, can_edit_own_password, can_view_not_started_autotest_results, can_see_other_tenant_oauth_providers, can_login_outside_system
+   :members: can_add_users, can_create_courses, can_manage_site_users, can_search_users, can_impersonate_users, can_manage_lti_providers, can_delete_community_library_items, can_list_hidden_tenants, can_manage_pearson_templates, can_view_community_library_items, can_view_all_community_library_items, can_create_community_library_items, is_admin, can_see_teacher_announcements, can_manage_sso_providers, can_manage_site_settings, can_manage_background_jobs, can_create_tenant, can_create_courses_for_other_tenants, can_see_other_tenant_statistics, can_search_users_other_tenant, can_skip_payment, can_edit_pricing, can_see_all_transactions, can_edit_coupons, can_see_coupons, can_use_snippets, can_edit_own_info, can_edit_own_password, can_view_not_started_autotest_results, can_see_other_tenant_oauth_providers, can_login_outside_system, can_manage_quarantined_registrations
    :inherited-members:
    :exclude-members: raw_data, data_parser, to_dict, from_dict, __init__, __new__

{codegrade-17.0.44 → codegrade-17.0.46}/docs/models/GlobalPermission.rst

@@ -23,6 +23,7 @@ GlobalPermission
 * ``can_manage_background_jobs``
 * ``can_manage_lti_providers``
 * ``can_manage_pearson_templates``
+* ``can_manage_quarantined_registrations``
 * ``can_manage_site_settings``
 * ``can_manage_site_users``
 * ``can_manage_sso_providers``

codegrade-17.0.46/docs/models/QuarantinedRegistration.rst

@@ -0,0 +1,9 @@
+QuarantinedRegistration
+=======================
+
+.. currentmodule:: codegrade.models.quarantined_registration
+
+.. autoclass:: QuarantinedRegistration
+   :members: id, email, username, name, created_at
+   :inherited-members:
+   :exclude-members: raw_data, data_parser, to_dict, from_dict, __init__, __new__

codegrade-17.0.46/docs/services/quarantined_registration.rst

@@ -0,0 +1,17 @@
+
+QuarantinedRegistrationService
+==============================
+
+.. currentmodule:: codegrade._api.quarantined_registration
+
+.. autoclass:: QuarantinedRegistrationService
+   :members: accept, deny, get_all
+
+	 .. rubric:: Methods
+
+	 .. autosummary::
+	    :nosignatures:
+
+			~QuarantinedRegistrationService.accept
+			~QuarantinedRegistrationService.deny
+			~QuarantinedRegistrationService.get_all

{codegrade-17.0.44 → codegrade-17.0.46}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "codegrade"
-version = "17.0.44"
+version = "17.0.46"
 description = "A client library for accessing CodeGrade"
 authors = []
 requires-python = ">=3.8.0,<4.0"

{codegrade-17.0.44 → codegrade-17.0.46}/src/codegrade/__init__.py

@@ -17,7 +17,7 @@ except ImportError:
     )
 
 __all__ = ("login", "AuthenticatedClient", "Client", "login_from_cli")
-__version__ = "17.0.44"
+__version__ = "17.0.46"
 
 _P = _ParamSpec("_P")
 _T = _t.TypeVar("_T")

{codegrade-17.0.44 → codegrade-17.0.46}/src/codegrade/_api/__init__.py

@@ -23,6 +23,7 @@ from . import (
     permission,
     plagiarism,
     pow,
+    quarantined_registration,
     registration_domain,
     restriction,
     role,

codegrade-17.0.46/src/codegrade/_api/quarantined_registration.py

@@ -0,0 +1,178 @@
+"""The endpoints for quarantined_registration 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 cg_maybe.utils import maybe_from_nullable
+
+from .. import paginated, parsers, utils
+
+if t.TYPE_CHECKING or os.getenv("CG_EAGERIMPORT", False):
+    from .. import client
+    from ..models.accept_quarantined_registration_data import (
+        AcceptQuarantinedRegistrationData,
+    )
+    from ..models.deny_quarantined_registration_data import (
+        DenyQuarantinedRegistrationData,
+    )
+    from ..models.quarantined_registration import QuarantinedRegistration
+
+
+_ClientT = t.TypeVar("_ClientT", bound="client._BaseClient")
+
+
+class QuarantinedRegistrationService(t.Generic[_ClientT]):
+    __slots__ = ("__client",)
+
+    def __init__(self, client: _ClientT) -> None:
+        self.__client = client
+
+    def accept(
+        self: QuarantinedRegistrationService[client.AuthenticatedClient],
+        json_body: AcceptQuarantinedRegistrationData,
+        *,
+        quarantined_registration_id: str,
+    ) -> None:
+        """Accept quarantined registrations.
+
+        :param json_body: The body of the request. See
+            :class:`.AcceptQuarantinedRegistrationData` for information about
+            the possible fields. You can provide this data as a
+            :class:`.AcceptQuarantinedRegistrationData` or as a dictionary.
+        :param quarantined_registration_id: Registration id to accept.
+
+        :returns: An empty response with return code 204
+        """
+
+        url = "/api/v1/quarantined_registrations/{quarantinedRegistrationId}/accept".format(
+            quarantinedRegistrationId=quarantined_registration_id
+        )
+        params = None
+
+        with self.__client as client:
+            resp = client.http.post(
+                url=url, json=utils.to_dict(json_body), params=params
+            )
+        utils.log_warnings(resp)
+
+        if utils.response_code_matches(resp.status_code, 204):
+            return parsers.ConstantlyParser(None).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),
+                ),
+            ),
+        )
+
+    def deny(
+        self: QuarantinedRegistrationService[client.AuthenticatedClient],
+        json_body: DenyQuarantinedRegistrationData,
+        *,
+        quarantined_registration_id: str,
+    ) -> None:
+        """Deny quarantined registrations.
+
+        :param json_body: The body of the request. See
+            :class:`.DenyQuarantinedRegistrationData` for information about the
+            possible fields. You can provide this data as a
+            :class:`.DenyQuarantinedRegistrationData` or as a dictionary.
+        :param quarantined_registration_id: Registration id to accept.
+
+        :returns: An empty response with return code 204
+        """
+
+        url = "/api/v1/quarantined_registrations/{quarantinedRegistrationId}/deny".format(
+            quarantinedRegistrationId=quarantined_registration_id
+        )
+        params = None
+
+        with self.__client as client:
+            resp = client.http.post(
+                url=url, json=utils.to_dict(json_body), params=params
+            )
+        utils.log_warnings(resp)
+
+        if utils.response_code_matches(resp.status_code, 204):
+            return parsers.ConstantlyParser(None).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),
+                ),
+            ),
+        )
+
+    def get_all(
+        self: QuarantinedRegistrationService[client.AuthenticatedClient],
+        *,
+        page_size: int = 25,
+    ) -> paginated.Response[QuarantinedRegistration]:
+        """List quarantined registrations.
+
+        :param page_size: The size of a single page, maximum is 100.
+
+        :returns: Paginated list of quarantined registrations.
+        """
+
+        url = "/api/v1/quarantined_registrations/"
+        params: t.Dict[str, str | int | bool] = {
+            "page-size": page_size,
+        }
+
+        if t.TYPE_CHECKING:
+            import httpx
+
+        def do_request(next_token: str | None) -> httpx.Response:
+            if next_token is None:
+                params.pop("next-token", "")
+            else:
+                params["next-token"] = next_token
+            with self.__client as client:
+                resp = client.http.get(url=url, params=params)
+            utils.log_warnings(resp)
+
+            return resp
+
+        def parse_response(
+            resp: httpx.Response,
+        ) -> t.Sequence[QuarantinedRegistration]:
+            if utils.response_code_matches(resp.status_code, 200):
+                from ..models.quarantined_registration import (
+                    QuarantinedRegistration,
+                )
+
+                return parsers.JsonResponseParser(
+                    rqa.List(parsers.ParserFor.make(QuarantinedRegistration))
+                ).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),
+                    ),
+                ),
+            )
+
+        return paginated.Response(do_request, parse_response)

{codegrade-17.0.44 → codegrade-17.0.46}/src/codegrade/client.py

@@ -88,6 +88,9 @@ if t.TYPE_CHECKING or os.getenv("CG_EAGERIMPORT", False):
         PlagiarismService as _PlagiarismService,
     )
     from codegrade._api.pow import PowService as _PowService
+    from codegrade._api.quarantined_registration import (
+        QuarantinedRegistrationService as _QuarantinedRegistrationService,
+    )
     from codegrade._api.registration_domain import (
         RegistrationDomainService as _RegistrationDomainService,
     )
@@ -508,6 +511,17 @@ class _BaseClient:
 
         return m.PowService(self)
 
+    @functools.cached_property
+    def quarantined_registration(
+        self: _BaseClientT,
+    ) -> "_QuarantinedRegistrationService[_BaseClientT]":
+        """Get a :class:`.QuarantinedRegistrationService` to do requests
+        concerning QuarantinedRegistration.
+        """
+        import codegrade._api.quarantined_registration as m
+
+        return m.QuarantinedRegistrationService(self)
+
     @functools.cached_property
     def registration_domain(
         self: _BaseClientT,
@@ -647,7 +661,7 @@ class Client(_BaseClient):
         return httpx.Client(
             base_url=self.base_url,
             headers={
-                "User-Agent": "CodeGradeAPI/17.0.44",
+                "User-Agent": "CodeGradeAPI/17.0.46",
             },
             follow_redirects=True,
             transport=RetryingTransport(httpx.HTTPTransport()),
@@ -668,7 +682,7 @@ class AuthenticatedClient(_BaseClient):
             base_url=self.base_url,
             headers={
                 "Authorization": f"Bearer {self.token}",
-                "User-Agent": "CodeGradeAPI/17.0.44",
+                "User-Agent": "CodeGradeAPI/17.0.46",
             },
             follow_redirects=True,
             transport=RetryingTransport(httpx.HTTPTransport()),

{codegrade-17.0.44 → codegrade-17.0.46}/src/codegrade/models/__init__.py

@@ -8,6 +8,9 @@ from ._submission_rubric_item_data_parser import (
 )
 from .about import About
 from .abstract_role import AbstractRole
+from .accept_quarantined_registration_data import (
+    AcceptQuarantinedRegistrationData,
+)
 from .access_expired import AccessExpired
 from .access_granted import AccessGranted
 from .access_pass_coupon import AccessPassCoupon
@@ -267,6 +270,7 @@ from .default_submission_page_tab_setting import (
 )
 from .deleted_comment_reply import DeletedCommentReply
 from .deletion_type import DeletionType as DeletionType
+from .deny_quarantined_registration_data import DenyQuarantinedRegistrationData
 from .directory_with_children import DirectoryWithChildren
 from .disabled_setting_exception import DisabledSettingException
 from .divide_graders_assignment_data import DivideGradersAssignmentData
@@ -559,6 +563,7 @@ from .quality_comment_severity import (
 )
 from .quality_test_log import QualityTestLog
 from .quality_test_log_base import QualityTestLogBase
+from .quarantined_registration import QuarantinedRegistration
 from .quiz_minimum_questions_for_dropdown_setting import (
     QuizMinimumQuestionsForDropdownSetting,
 )

codegrade-17.0.46/src/codegrade/models/accept_quarantined_registration_data.py

@@ -0,0 +1,53 @@
+"""The module that defines the ``AcceptQuarantinedRegistrationData`` 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 AcceptQuarantinedRegistrationData:
+    """Input data required for the `Quarantined Registration::Accept`
+    operation.
+    """
+
+    #: Role id of the tenant.
+    tenant_role_id: int
+
+    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(
+                "tenant_role_id",
+                rqa.SimpleValue.int,
+                doc="Role id of the tenant.",
+            ),
+        ).use_readable_describe(True)
+    )
+
+    def to_dict(self) -> t.Dict[str, t.Any]:
+        res: t.Dict[str, t.Any] = {
+            "tenant_role_id": to_dict(self.tenant_role_id),
+        }
+        return res
+
+    @classmethod
+    def from_dict(
+        cls: t.Type[AcceptQuarantinedRegistrationData], d: t.Dict[str, t.Any]
+    ) -> AcceptQuarantinedRegistrationData:
+        parsed = cls.data_parser.try_parse(d)
+
+        res = cls(
+            tenant_role_id=parsed.tenant_role_id,
+        )
+        res.raw_data = d
+        return res

codegrade-17.0.46/src/codegrade/models/deny_quarantined_registration_data.py

@@ -0,0 +1,51 @@
+"""The module that defines the ``DenyQuarantinedRegistrationData`` 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 DenyQuarantinedRegistrationData:
+    """Input data required for the `Quarantined Registration::Deny` operation."""
+
+    #: Reason for denying the registration.
+    explanation: str
+
+    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(
+                "explanation",
+                rqa.SimpleValue.str,
+                doc="Reason for denying the registration.",
+            ),
+        ).use_readable_describe(True)
+    )
+
+    def to_dict(self) -> t.Dict[str, t.Any]:
+        res: t.Dict[str, t.Any] = {
+            "explanation": to_dict(self.explanation),
+        }
+        return res
+
+    @classmethod
+    def from_dict(
+        cls: t.Type[DenyQuarantinedRegistrationData], d: t.Dict[str, t.Any]
+    ) -> DenyQuarantinedRegistrationData:
+        parsed = cls.data_parser.try_parse(d)
+
+        res = cls(
+            explanation=parsed.explanation,
+        )
+        res.raw_data = d
+        return res

{codegrade-17.0.44 → codegrade-17.0.46}/src/codegrade/models/global_perm_map.py

@@ -107,6 +107,9 @@ class GlobalPermMap:
     #: username/password or email/OTP. When disabled, users must login through
     #: their institution's LMS or SSO.
     can_login_outside_system: bool
+    #: Users with this permission can accept and decline quarantined user
+    #: registrations.
+    can_manage_quarantined_registrations: bool
 
     raw_data: t.Optional[t.Dict[str, t.Any]] = field(init=False, repr=False)
 
@@ -272,6 +275,11 @@ class GlobalPermMap:
                 rqa.SimpleValue.bool,
                 doc="Users with this permission can login directly to CodeGrade using username/password or email/OTP. When disabled, users must login through their institution's LMS or SSO.",
             ),
+            rqa.RequiredArgument(
+                "can_manage_quarantined_registrations",
+                rqa.SimpleValue.bool,
+                doc="Users with this permission can accept and decline quarantined user registrations.",
+            ),
         ).use_readable_describe(True)
     )
 
@@ -333,6 +341,9 @@ class GlobalPermMap:
                 self.can_see_other_tenant_oauth_providers
             ),
             "can_login_outside_system": to_dict(self.can_login_outside_system),
+            "can_manage_quarantined_registrations": to_dict(
+                self.can_manage_quarantined_registrations
+            ),
         }
         return res
 
@@ -375,6 +386,7 @@ class GlobalPermMap:
             can_view_not_started_autotest_results=parsed.can_view_not_started_autotest_results,
             can_see_other_tenant_oauth_providers=parsed.can_see_other_tenant_oauth_providers,
             can_login_outside_system=parsed.can_login_outside_system,
+            can_manage_quarantined_registrations=parsed.can_manage_quarantined_registrations,
         )
         res.raw_data = d
         return res

{codegrade-17.0.44 → codegrade-17.0.46}/src/codegrade/models/global_permission.py

@@ -25,6 +25,9 @@ class GlobalPermission(str, Enum):
     can_manage_background_jobs = "can_manage_background_jobs"
     can_manage_lti_providers = "can_manage_lti_providers"
     can_manage_pearson_templates = "can_manage_pearson_templates"
+    can_manage_quarantined_registrations = (
+        "can_manage_quarantined_registrations"
+    )
     can_manage_site_settings = "can_manage_site_settings"
     can_manage_site_users = "can_manage_site_users"
     can_manage_sso_providers = "can_manage_sso_providers"

codegrade-17.0.46/src/codegrade/models/quarantined_registration.py

@@ -0,0 +1,88 @@
+"""The module that defines the ``QuarantinedRegistration`` model.
+
+SPDX-License-Identifier: AGPL-3.0-only OR BSD-3-Clause-Clear
+"""
+
+from __future__ import annotations
+
+import datetime
+import typing as t
+from dataclasses import dataclass, field
+
+import cg_request_args as rqa
+
+from ..utils import to_dict
+
+
+@dataclass
+class QuarantinedRegistration:
+    """JSON representation of a quarantined registration."""
+
+    #: The id of this quarantined registration.
+    id: str
+    #: The email of this quarantined registration.
+    email: str
+    #: The username of this quarantined registration.
+    username: str
+    #: The name of this quarantined registration.
+    name: str
+    #: The time this result was created
+    created_at: datetime.datetime
+
+    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(
+                "id",
+                rqa.SimpleValue.str,
+                doc="The id of this quarantined registration.",
+            ),
+            rqa.RequiredArgument(
+                "email",
+                rqa.SimpleValue.str,
+                doc="The email of this quarantined registration.",
+            ),
+            rqa.RequiredArgument(
+                "username",
+                rqa.SimpleValue.str,
+                doc="The username of this quarantined registration.",
+            ),
+            rqa.RequiredArgument(
+                "name",
+                rqa.SimpleValue.str,
+                doc="The name of this quarantined registration.",
+            ),
+            rqa.RequiredArgument(
+                "created_at",
+                rqa.RichValue.DateTime,
+                doc="The time this result was created",
+            ),
+        ).use_readable_describe(True)
+    )
+
+    def to_dict(self) -> t.Dict[str, t.Any]:
+        res: t.Dict[str, t.Any] = {
+            "id": to_dict(self.id),
+            "email": to_dict(self.email),
+            "username": to_dict(self.username),
+            "name": to_dict(self.name),
+            "created_at": to_dict(self.created_at),
+        }
+        return res
+
+    @classmethod
+    def from_dict(
+        cls: t.Type[QuarantinedRegistration], d: t.Dict[str, t.Any]
+    ) -> QuarantinedRegistration:
+        parsed = cls.data_parser.try_parse(d)
+
+        res = cls(
+            id=parsed.id,
+            email=parsed.email,
+            username=parsed.username,
+            name=parsed.name,
+            created_at=parsed.created_at,
+        )
+        res.raw_data = d
+        return res