clear-skies-gitlab 2.0.1__py3-none-any.whl

clearskies_gitlab/models/gitlab_project.py

@@ -0,0 +1,110 @@
+from __future__ import annotations
+
+from collections import OrderedDict
+from typing import Any
+
+from clearskies import Model
+from clearskies.columns import BelongsToId, BelongsToModel, Boolean, Datetime, Integer, Json, Select, String
+
+from clearskies_gitlab.models import gitlab_group, gitlab_namespace
+
+
+class GitlabProject(Model):
+    """Base model for projects."""
+
+    id_column_name = "id"
+
+    id = String()
+    group_id = BelongsToId(gitlab_group.GitlabGroup)
+    group = BelongsToModel("group_id")
+    user_id = String()
+    namespace_id = BelongsToId(gitlab_namespace.GitlabNamespace)
+    namespace = BelongsToModel("namespace_id")
+    description = String()
+    description_html = String()
+    default_branch = String()
+    visibility = String()
+    ssh_url_to_repo = String()
+    http_url_to_repo = String()
+    web_url = String()
+    readme_url = String()
+    topics = Json()
+    owner = Json()
+    name = String()
+    name_with_namespace = String()
+    path = String()
+    path_with_namespace = String()
+    issues_enabled = Boolean()
+    open_issues_count = Integer()
+    merge_requests_enabled = Boolean()
+    jobs_enabled = Boolean()
+    wiki_enabled = Boolean()
+    snippets_enabled = Boolean()
+    can_create_merge_request_in = Boolean()
+    resolve_outdated_diff_discussions = Boolean()
+    container_registry_access_level = Select(allowed_values=["disabled", "private", "enabled"])
+    container_security_and_compliance_access_level = Select(allowed_values=["disabled", "private", "enabled"])
+    container_expiration_policy = Json()
+    created_at = Datetime()
+    updated_at = Datetime()
+    last_activity_at = Datetime()
+    creator_id = Integer()
+    import_url = String()
+    import_type = String()
+    import_status = String()
+    import_error = String()
+    permissions = Json()
+    archived = Boolean()
+    avatar_url = String()
+    license_url = String()
+    license = Json()
+    shared_runners_enabled = Boolean()
+    group_runners_enabled = Boolean()
+    forks_count = Integer()
+    star_count = Integer()
+    runners_token = String()
+    ci_default_git_depth = Integer()
+    ci_forward_deployment_enabled = Boolean()
+    ci_forward_deployment_rollback_allowed = Boolean()
+    ci_allow_fork_pipelines_to_run_in_parent_project = Boolean()
+    ci_separated_caches = Boolean()
+    ci_restrict_pipeline_cancellation_role = Select(allowed_values=["maintainer", "developer", "no_one"])
+    ci_pipeline_variables_minimum_override_role = Select(
+        allowed_values=["owner", "developer", "maintainer", "no_one_allowed"]
+    )
+    ci_push_repository_for_job_token_allowed = Boolean()
+    public_jobs = Boolean()
+    shared_with_groups = Json()
+    repository_storage = String()
+    only_allow_merge_if_pipeline_succeeds = Boolean()
+    allow_merge_on_skipped_pipeline = Boolean()
+    allow_pipeline_trigger_approve_deployment = Boolean()
+    restrict_user_defined_variables = Boolean()
+    only_allow_merge_if_all_discussions_are_resolved = Boolean()
+    remove_source_branch_after_merge = Boolean()
+    printing_merge_requests_link_enabled = Boolean()
+    request_access_enabled = Boolean()
+    only_allow_merge_if_pipeline_succeeds = Boolean()
+    merge_method = Select(allowed_values=["merge", "rebase_merge", "ff"])
+    squash_option = Select(allowed_values=["never", "always", "default_on", "default_off"])
+    auto_devops_enabled = Boolean()
+    auto_devops_deploy_strategy = Select(allowed_values=["continuous", "manual", "timed_incremental"])
+    mirror = Boolean()
+    mirror_user_id = Integer()
+    mirror_trigger_builds = Boolean()
+    only_mirror_protected_branches = Boolean()
+    mirror_overwrites_diverged_branches = Boolean()
+    external_authorization_classification_label = String()
+    packages_enabled = Boolean()
+    service_desk_enabled = Boolean()
+    service_desk_address = String()
+    autoclose_referenced_issues = Boolean()
+    suggestion_commit_message = String()
+    enforce_auth_checks_on_uploads = Boolean()
+    merge_commit_template = String()
+    squash_commit_template = String()
+    issue_branch_template = String()
+    marked_for_deletion_on = Datetime()
+    compliance_frameworks = Json()
+    statistics = Json()
+    container_registry_image_prefix = String()

clearskies_gitlab/models/gitlab_rest_model.py

@@ -0,0 +1,11 @@
+from __future__ import annotations
+
+from clearskies import Model
+
+from clearskies_gitlab.backends import GitlabRestBackend
+
+
+class GitlabRestModel(Model):
+    """Base model for rest api."""
+
+    backend = GitlabRestBackend()

clearskies_gitlab/models/rest/__init__.py

@@ -0,0 +1,35 @@
+from __future__ import annotations
+
+from clearskies_gitlab.models.rest.gitlab_rest_advanced_search import GitlabRestAdvancedSearch
+from clearskies_gitlab.models.rest.gitlab_rest_advanced_search_blob import GitlabRestAdvancedSearchBlob
+from clearskies_gitlab.models.rest.gitlab_rest_current_user import GitlabRestCurrentUser
+from clearskies_gitlab.models.rest.gitlab_rest_group import GitlabRestGroup
+from clearskies_gitlab.models.rest.gitlab_rest_group_access_token import GitlabRestGroupAccessToken
+from clearskies_gitlab.models.rest.gitlab_rest_group_project import GitlabRestGroupProject
+from clearskies_gitlab.models.rest.gitlab_rest_group_search import GitlabRestGroupSearch
+from clearskies_gitlab.models.rest.gitlab_rest_group_search_blob import GitlabRestGroupSearchBlob
+from clearskies_gitlab.models.rest.gitlab_rest_group_subgroup import GitlabRestGroupSubgroup
+from clearskies_gitlab.models.rest.gitlab_rest_group_variable import GitlabRestGroupVariable
+from clearskies_gitlab.models.rest.gitlab_rest_project import GitlabRestProject
+from clearskies_gitlab.models.rest.gitlab_rest_project_repository_commit import GitlabRestProjectRepositoryCommit
+from clearskies_gitlab.models.rest.gitlab_rest_project_repository_commit_diff import (
+    GitlabRestProjectRepositoryCommitDiff,
+)
+from clearskies_gitlab.models.rest.gitlab_rest_project_variable import GitlabRestProjectVariable
+
+__all__ = [
+    "GitlabRestAdvancedSearch",
+    "GitlabRestAdvancedSearchBlob",
+    "GitlabRestCurrentUser",
+    "GitlabRestGroup",
+    "GitlabRestGroupAccessToken",
+    "GitlabRestGroupProject",
+    "GitlabRestGroupSearch",
+    "GitlabRestGroupSearchBlob",
+    "GitlabRestGroupSubgroup",
+    "GitlabRestGroupVariable",
+    "GitlabRestProject",
+    "GitlabRestProjectRepositoryCommit",
+    "GitlabRestProjectRepositoryCommitDiff",
+    "GitlabRestProjectVariable",
+]

clearskies_gitlab/models/rest/gitlab_rest_advanced_search.py

@@ -0,0 +1,38 @@
+from __future__ import annotations
+
+from collections import OrderedDict
+from typing import Any, Self
+
+from clearskies.columns import Boolean, Json, Select, String
+
+from clearskies_gitlab.models import gitlab_rest_model
+
+
+class GitlabRestAdvancedSearch(
+    gitlab_rest_model.GitlabRestModel,
+):
+    """Model for groups access tokens."""
+
+    @classmethod
+    def destination_name(cls: type[Self]) -> str:
+        """Return the slug of the api endpoint for this model."""
+        return "search"
+
+    scope = Select(
+        allowed_values=[
+            "projects",
+            "issues",
+            "merge_requests",
+            "milestones",
+            "snippet_titles",
+            "users",
+            "wiki_blobs",
+            "commits",
+            "blobs",
+            "notes",
+        ]
+    )
+    search = String()
+    confidential = Boolean()
+    state = String()
+    fields = Json()

clearskies_gitlab/models/rest/gitlab_rest_advanced_search_blob.py

@@ -0,0 +1,26 @@
+from __future__ import annotations
+
+from collections import OrderedDict
+from typing import Any
+
+from clearskies.columns import BelongsToId, BelongsToModel, Integer, String
+
+from clearskies_gitlab.models.rest import gitlab_rest_advanced_search, gitlab_rest_project
+
+
+class GitlabRestAdvancedSearchBlob(
+    gitlab_rest_advanced_search.GitlabRestAdvancedSearch,
+):
+    """Model for advanced searching blobs."""
+
+    basename = String()
+    data = String()
+    path = String()
+    filename = String()
+    id = Integer()
+    ref = String()
+    startline = Integer()
+    project_id = BelongsToId(
+        gitlab_rest_project.GitlabRestProject,
+    )
+    project = BelongsToModel("project_id")

clearskies_gitlab/models/rest/gitlab_rest_current_user.py

@@ -0,0 +1,43 @@
+from __future__ import annotations
+
+from collections import OrderedDict
+from typing import Any, Self
+
+from clearskies.columns import Boolean, Datetime, Email, Integer, Json, String
+
+from clearskies_gitlab.models import gitlab_rest_model
+
+
+class GitlabRestCurrentUser(
+    gitlab_rest_model.GitlabRestModel,
+):
+    """Model for current user."""
+
+    @classmethod
+    def destination_name(cls: type[Self]) -> str:
+        """Return the slug of the api endpoint for this model."""
+        return "user"
+
+    id = Integer()
+    username = String()
+    email = Email()
+    name = String()
+    state = String()
+    locked = Boolean()
+    avatar_url = String()
+    web_url = String()
+    created_at = Datetime()
+    bio = String()
+    public_email = Email()
+    organization = String()
+    bot = Boolean()
+    last_sign_in_at = Datetime()
+    confirmed_at = Datetime()
+    last_activity_on = Datetime()
+    identities = Json()
+    can_create_group = Boolean()
+    can_create_project = Boolean()
+    two_factor_enabled = Boolean()
+    external = Boolean()
+    private_profile = Boolean()
+    commit_email = Email()

clearskies_gitlab/models/rest/gitlab_rest_group.py

@@ -0,0 +1,75 @@
+from __future__ import annotations
+
+from collections import OrderedDict
+from typing import Any, Self
+
+from clearskies.columns import (
+    BelongsToId,
+    BelongsToModel,
+    BelongsToSelf,
+    Boolean,
+    Datetime,
+    HasMany,
+    Integer,
+    Json,
+    Select,
+    String,
+)
+
+from clearskies_gitlab.models import gitlab_group, gitlab_rest_model
+from clearskies_gitlab.models.rest import (
+    gitlab_rest_group_access_token,
+    gitlab_rest_group_member_reference,
+    gitlab_rest_group_project,
+    gitlab_rest_group_subgroup_reference,
+    gitlab_rest_group_variable,
+    gitlab_rest_project_reference,
+)
+
+
+class GitlabRestGroup(
+    gitlab_rest_model.GitlabRestModel,
+    gitlab_group.GitlabGroup,
+):
+    """Model for groups."""
+
+    @classmethod
+    def destination_name(cls: type[Self]) -> str:
+        """Return the slug of the api endpoint for this model."""
+        return "groups"
+
+    projects = HasMany(
+        gitlab_rest_group_project.GitlabRestGroupProject,
+        foreign_column_name="group_id",
+    )
+    access_tokens = HasMany(
+        gitlab_rest_group_access_token.GitlabRestGroupAccessToken,
+        foreign_column_name="group_id",
+    )
+    variables = HasMany(
+        gitlab_rest_group_variable.GitlabRestGroupVariable,
+        foreign_column_name="group_id",
+    )
+    subgroups = HasMany(
+        gitlab_rest_group_subgroup_reference.GitlabRestGroupSubgroupReference,
+        foreign_column_name="group_id",
+    )
+    members = HasMany(
+        gitlab_rest_group_member_reference.GitlabRestGroupMemberReference,
+        foreign_column_name="group_id",
+    )
+    parent_id = BelongsToSelf()
+    parent = BelongsToModel("parent_id")
+    ### Search params
+    skip_groups = Json()
+    all_available = Boolean()
+    search = String()
+    order_by = String()
+    sort = String()
+    visibility = Select(allowed_values=["public", "internal", "private"])
+    with_custom_attributes = Boolean()
+    owned = Boolean()
+    min_access_level = Integer()
+    top_level_only = Boolean()
+    repository_storage = String()
+    marked_for_deletion_on = Datetime(date_format="%Y-%m-%d")

clearskies_gitlab/models/rest/gitlab_rest_group_access_token.py

@@ -0,0 +1,32 @@
+from __future__ import annotations
+
+from collections import OrderedDict
+from typing import Any, Self
+
+from clearskies.columns import BelongsToId, BelongsToModel, Boolean, Datetime, Integer, Json, String
+
+from clearskies_gitlab.models import gitlab_rest_model
+from clearskies_gitlab.models.rest import gitlab_rest_group
+
+
+class GitlabRestGroupAccessToken(
+    gitlab_rest_model.GitlabRestModel,
+):
+    """Model for groups access tokens."""
+
+    @classmethod
+    def destination_name(cls: type[Self]) -> str:
+        """Return the slug of the api endpoint for this model."""
+        return "groups/:group_id/access_tokens"
+
+    group_id = String()
+    id = Integer()
+    user_id = Integer()
+    name = String()
+    created_at = Datetime()
+    expires_at = Datetime(date_format="%Y-%m-%d")
+    active = Boolean()
+    revoked = Boolean()
+    access_level = Integer()
+    token = String()
+    scopes = Json()

clearskies_gitlab/models/rest/gitlab_rest_group_member.py

@@ -0,0 +1,28 @@
+from __future__ import annotations
+
+from collections import OrderedDict
+from typing import Any, Self
+
+from clearskies.columns import BelongsToId, BelongsToModel, Boolean, Json, String
+
+from clearskies_gitlab.models import gitlab_member, gitlab_rest_model
+from clearskies_gitlab.models.rest import gitlab_rest_group
+
+
+class GitlabRestGroupMember(
+    gitlab_rest_model.GitlabRestModel,
+    gitlab_member.GitlabMember,
+):
+    """Model for group members."""
+
+    @classmethod
+    def destination_name(cls: type[Self]) -> str:
+        """Return the slug of the api endpoint for this model."""
+        return "groups/:group_id/members"
+
+    group_id = String()
+    query = String()
+    user_ids = Json()
+    skip_users = Json()
+    show_seat_info = Boolean()
+    all = Boolean()

clearskies_gitlab/models/rest/gitlab_rest_group_member_reference.py

@@ -0,0 +1,6 @@
+from clearskies_gitlab.models.rest import gitlab_rest_group_member
+
+
+class GitlabRestGroupMemberReference:
+    def get_model_class(self):
+        return gitlab_rest_group_member.GitlabRestGroupMember

clearskies_gitlab/models/rest/gitlab_rest_group_project.py

@@ -0,0 +1,37 @@
+from __future__ import annotations
+
+from collections import OrderedDict
+from typing import Any, Self
+
+from clearskies.columns import (
+    BelongsToId,
+    BelongsToModel,
+    BelongsToSelf,
+    Boolean,
+    Datetime,
+    HasMany,
+    Integer,
+    Json,
+    Select,
+    String,
+)
+
+from clearskies_gitlab.models import gitlab_project, gitlab_rest_model
+from clearskies_gitlab.models.rest import (
+    gitlab_rest_group_access_token,
+    gitlab_rest_group_subgroup_reference,
+    gitlab_rest_group_variable,
+    gitlab_rest_project_reference,
+)
+
+
+class GitlabRestGroupProject(
+    gitlab_rest_model.GitlabRestModel,
+    gitlab_project.GitlabProject,
+):
+    """Model for groups projects."""
+
+    @classmethod
+    def destination_name(cls: type[Self]) -> str:
+        """Return the slug of the api endpoint for this model."""
+        return "groups/:group_id/projects"

clearskies_gitlab/models/rest/gitlab_rest_group_reference.py

@@ -0,0 +1,6 @@
+from clearskies_gitlab.models.rest import gitlab_rest_group
+
+
+class GitlabRestGroupReference:
+    def get_model_class(self):
+        return gitlab_rest_group.GitlabRestGroup

clearskies_gitlab/models/rest/gitlab_rest_group_search.py

@@ -0,0 +1,21 @@
+from __future__ import annotations
+
+from collections import OrderedDict
+from typing import Any, Self
+
+from clearskies.columns import Integer
+
+from clearskies_gitlab.models.rest import gitlab_rest_advanced_search
+
+
+class GitlabRestGroupSearch(
+    gitlab_rest_advanced_search.GitlabRestAdvancedSearch,
+):
+    """Model for groups access tokens."""
+
+    @classmethod
+    def destination_name(cls: type[Self]) -> str:
+        """Return the slug of the api endpoint for this model."""
+        return "groups/:group_id/search"
+
+    group_id = Integer()

clearskies_gitlab/models/rest/gitlab_rest_group_search_blob.py

@@ -0,0 +1,13 @@
+from __future__ import annotations
+
+from clearskies_gitlab.models.rest import (
+    gitlab_rest_advanced_search_blob,
+    gitlab_rest_group_search,
+)
+
+
+class GitlabRestGroupSearchBlob(
+    gitlab_rest_group_search.GitlabRestGroupSearch,
+    gitlab_rest_advanced_search_blob.GitlabRestAdvancedSearchBlob,
+):
+    """Model for advanced searching blobs."""

clearskies_gitlab/models/rest/gitlab_rest_group_subgroup.py

@@ -0,0 +1,65 @@
+from __future__ import annotations
+
+from collections import OrderedDict
+from typing import Any, Self
+
+from clearskies.columns import (
+    BelongsToId,
+    BelongsToModel,
+    BelongsToSelf,
+    Boolean,
+    Datetime,
+    HasMany,
+    Integer,
+    Json,
+    Select,
+    String,
+)
+
+from clearskies_gitlab.models import gitlab_group, gitlab_rest_model
+from clearskies_gitlab.models.rest import (
+    gitlab_rest_group_access_token,
+    gitlab_rest_group_variable,
+    gitlab_rest_project_reference,
+)
+
+
+class GitlabRestGroupSubgroup(gitlab_rest_model.GitlabRestModel, gitlab_group.GitlabGroup):
+    """Model for Subgroups."""
+
+    id_column_name = "group_id"
+
+    @classmethod
+    def destination_name(cls: type[Self]) -> str:
+        """Return the slug of the api endpoint for this model."""
+        return "groups/:group_id/subgroups"
+
+    group_id = String()
+
+    projects = HasMany(
+        gitlab_rest_project_reference.GitlabRestProjectReference,
+        foreign_column_name="group_id",
+    )
+    access_tokens = HasMany(
+        gitlab_rest_group_access_token.GitlabRestGroupAccessToken,
+        foreign_column_name="group_id",
+    )
+    variables = HasMany(
+        gitlab_rest_group_variable.GitlabRestGroupVariable,
+        foreign_column_name="group_id",
+    )
+    parent_id = BelongsToSelf()
+    parent = BelongsToModel("parent_id")
+    ### Search params
+    skip_groups = Json()
+    all_available = Boolean()
+    search = String()
+    order_by = String()
+    sort = String()
+    visibility = Select(allowed_values=["public", "internal", "private"])
+    with_custom_attributes = Boolean()
+    owned = Boolean()
+    min_access_level = Integer()
+    top_level_only = Boolean()
+    repository_storage = String()
+    marked_for_deletion_on = Datetime(date_format="%Y-%m-%d")

clearskies_gitlab/models/rest/gitlab_rest_group_subgroup_reference.py

@@ -0,0 +1,6 @@
+from clearskies_gitlab.models.rest import gitlab_rest_group_subgroup
+
+
+class GitlabRestGroupSubgroupReference:
+    def get_model_class(self):
+        return gitlab_rest_group_subgroup.GitlabRestGroupSubgroup

clearskies_gitlab/models/rest/gitlab_rest_group_variable.py

@@ -0,0 +1,22 @@
+from __future__ import annotations
+
+from collections import OrderedDict
+from typing import TYPE_CHECKING, Any, Self
+
+from clearskies.columns import BelongsToId, BelongsToModel, String
+
+from clearskies_gitlab.models import gitlab_cicd_variable, gitlab_rest_model
+
+
+class GitlabRestGroupVariable(
+    gitlab_rest_model.GitlabRestModel,
+    gitlab_cicd_variable.GitlabCICDVariable,
+):
+    """Model for gitlab group variables."""
+
+    @classmethod
+    def destination_name(cls: type[Self]) -> str:
+        """Return the slug of the api endpoint for this model."""
+        return "groups/:group_id/variables"
+
+    group_id = String()

clearskies_gitlab/models/rest/gitlab_rest_namespace.py

@@ -0,0 +1,69 @@
+from __future__ import annotations
+
+from collections import OrderedDict
+from typing import Any, Self
+
+from clearskies.columns import (
+    BelongsToId,
+    BelongsToModel,
+    BelongsToSelf,
+    Boolean,
+    Datetime,
+    HasMany,
+    Integer,
+    Json,
+    Select,
+    String,
+)
+
+from clearskies_gitlab.models import gitlab_namespace, gitlab_rest_model
+from clearskies_gitlab.models.rest import (
+    gitlab_rest_group_access_token,
+    gitlab_rest_group_subgroup_reference,
+    gitlab_rest_group_variable,
+    gitlab_rest_project_reference,
+)
+
+
+class GitlabRestNamespace(
+    gitlab_rest_model.GitlabRestModel,
+    gitlab_namespace.GitlabNamespace,
+):
+    """Model for namespaces."""
+
+    @classmethod
+    def destination_name(cls: type[Self]) -> str:
+        """Return the slug of the api endpoint for this model."""
+        return "namespaces"
+
+    projects = HasMany(
+        gitlab_rest_project_reference.GitlabRestProjectReference,
+        foreign_column_name="group_id",
+    )
+    access_tokens = HasMany(
+        gitlab_rest_group_access_token.GitlabRestGroupAccessToken,
+        foreign_column_name="group_id",
+    )
+    variables = HasMany(
+        gitlab_rest_group_variable.GitlabRestGroupVariable,
+        foreign_column_name="group_id",
+    )
+    subgroups = HasMany(
+        gitlab_rest_group_subgroup_reference.GitlabRestGroupSubgroupReference,
+        foreign_column_name="group_id",
+    )
+    parent_id = BelongsToSelf()
+    parent = BelongsToModel("parent_id")
+    ### Search params
+    skip_groups = Json()
+    all_available = Boolean()
+    search = String()
+    order_by = String()
+    sort = String()
+    visibility = Select(allowed_values=["public", "internal", "private"])
+    with_custom_attributes = Boolean()
+    owned = Boolean()
+    min_access_level = Integer()
+    top_level_only = Boolean()
+    repository_storage = String()
+    marked_for_deletion_on = Datetime(date_format="%Y-%m-%d")