labclient 0.1.0

data/lib/labclient/projects/clusters/add.rb

@@ -0,0 +1,48 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectClusters < Common
+    doc 'Add' do
+      desc 'Adds an existing Kubernetes cluster to the project. [Project ID, Hash]'
+      example <<~DOC
+        params = {
+          name: 'cluster-5',
+          platform_kubernetes_attributes: {
+            api_url: 'https://35.111.51.20',
+            token: '12345',
+            namespace: 'cluster-5-namespace',
+            ca_cert: "-----BEGIN .....-----END CERTIFICATE-----"
+          }
+        }
+
+          client.projects.clusters.add(310, params)
+      DOC
+
+      result '=>  #<ProjectCluster id: 2, name: cluster-5>'
+    end
+
+    doc 'Add' do
+      markdown <<~DOC
+        | Attribute | Type | Required | Description |
+        | --------- | ---- | -------- | ----------- |
+        | name      | string | yes | The name of the cluster |
+        | domain      | string | no | The base domain of the cluster |
+        | management_project_id | integer | no | The ID of the [management project](../user/clusters/management_project.md) for the cluster |
+        | enabled      | boolean | no | Determines if cluster is active or not, defaults to true |
+        | managed      | boolean | no | Determines if GitLab will manage namespaces and service accounts for this cluster, defaults to true |
+        | platform_kubernetes_attributes[api_url] | string | yes | The URL to access the Kubernetes API |
+        | platform_kubernetes_attributes[token] | string | yes | The token to authenticate against Kubernetes |
+        | platform_kubernetes_attributes[ca_cert] | string | no | TLS certificate. Required if API is using a self-signed TLS certificate. |
+        | platform_kubernetes_attributes[namespace] | string | no | The unique namespace related to the project |
+        | platform_kubernetes_attributes[authorization_type] | string | no | The cluster authorization type: rbac, abac or unknown_authorization. Defaults to rbac. |
+        | environment_scope | string | no | The associated environment to the cluster. Defaults to * **(PREMIUM)** |
+      DOC
+    end
+
+    def add(project_id, query)
+      project_id = format_id(project_id)
+
+      client.request(:post, "projects/#{project_id}/clusters/user", ProjectCluster, query)
+    end
+  end
+end

data/lib/labclient/projects/clusters/client.rb

@@ -0,0 +1,17 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class ProjectClusters < Common
+    include ClassHelpers
+  end
+end
+
+# Top namespace
+module LabClient
+  # Specifics
+  class Projects < Common
+    def clusters
+      ProjectClusters.new(client)
+    end
+  end
+end

data/lib/labclient/projects/clusters/delete.rb

@@ -0,0 +1,37 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectClusters < Common
+    doc 'Delete' do
+      desc 'Deletes an existing project cluster. [Project ID, Mirror ID, Params]'
+      example 'client.projects.clusters.update(310, 3, enabled: true)'
+
+      result '=>  #<ProjectCluster id: 3, name: planet bob>'
+    end
+
+    doc 'Delete' do
+      markdown <<~DOC
+        | Attribute              | Type    | Required   | Description                                         |
+        | ----------             | -----   | ---------  | ------------                                        |
+        | url                    | String  | yes        | The URL of the remote repository to be clustered.    |
+        | enabled                | Boolean | no         | Determines if the cluster is enabled.                |
+        | only_protected_branches| Boolean | no         | Determines if only protected branches are clustered. |
+      DOC
+    end
+
+    doc 'Delete' do
+      desc 'Via ProjectCluster [Params]'
+      example <<~DOC
+        cluster = client.projects.clusters.list(310).first
+        cluster.update(enabled: false)
+      DOC
+    end
+
+    def delete(project_id, cluster_id)
+      project_id = format_id(project_id)
+      cluster_id = format_id(cluster_id)
+
+      client.request(:delete, "projects/#{project_id}/clusters/#{cluster_id}", ProjectCluster)
+    end
+  end
+end

data/lib/labclient/projects/clusters/list.rb

@@ -0,0 +1,28 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectClusters < Common
+    doc 'List' do
+      desc 'Returns a list of project clusters. [Project ID]'
+      example 'client.projects.clusters.list(16)'
+
+      result <<~DOC
+        => #<ProjectCluster id: 1, name: cluster-5>]
+      DOC
+    end
+
+    doc 'List' do
+      desc 'Via Project'
+      example <<~DOC
+        project = client.projects.show(16)
+        project.clusters
+      DOC
+    end
+
+    def list(project_id)
+      project_id = format_id(project_id)
+
+      client.request(:get, "projects/#{project_id}/clusters", ProjectCluster)
+    end
+  end
+end

data/lib/labclient/projects/clusters/project_cluster.rb

@@ -0,0 +1,38 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class ProjectCluster < Klass
+    include ClassHelpers
+    def inspect
+      "#<ProjectCluster id: #{id}, name: #{name}>"
+    end
+
+    def project
+      project_id = collect_project_id
+      client.projects.show project_id
+    end
+
+    def update(query)
+      project_id = collect_project_id
+
+      update_self client.projects.clusters.update(project_id, id, query)
+    end
+
+    def delete
+      project_id = collect_project_id
+
+      client.projects.clusters.delete(project_id, id)
+    end
+
+    date_time_attrs %i[created_at]
+    user_attrs %i[uster]
+
+    help do
+      @group_name = 'Projects'
+      subtitle 'ProjectCluster'
+      option 'project', 'Show Project'
+      option 'update', 'Update this Cluster [Hash]'
+      option 'delete', 'Delete cluster'
+    end
+  end
+end

data/lib/labclient/projects/clusters/show.rb

@@ -0,0 +1,29 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectClusters < Common
+    doc 'Show' do
+      desc 'Gets a single project cluster. [Project ID, Cluster ID]'
+      example 'client.projects.clusters.list(16)'
+
+      result <<~DOC
+        => #<ProjectCluster id: 1, name: cluster-5>
+      DOC
+    end
+
+    doc 'Show' do
+      desc 'Via Project'
+      example <<~DOC
+        project = client.projects.show(16)
+        project.clusters
+      DOC
+    end
+
+    def show(project_id, cluster_id)
+      cluster_id = format_id(cluster_id)
+      project_id = format_id(project_id)
+
+      client.request(:get, "projects/#{project_id}/clusters/#{cluster_id}", ProjectCluster)
+    end
+  end
+end

data/lib/labclient/projects/clusters/update.rb

@@ -0,0 +1,37 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectClusters < Common
+    doc 'Update' do
+      desc 'Updates an existing project cluster. [Project ID, Cluster ID, Hash]'
+      example 'client.projects.clusters.update(310, 3, name: "Sweet")'
+
+      result '=>  #<ProjectCluster id: 3, name: Sweet>'
+    end
+
+    doc 'Update' do
+      markdown <<~DOC
+        | Attribute              | Type    | Required   | Description                                         |
+        | ----------             | -----   | ---------  | ------------                                        |
+        | url                    | String  | yes        | The URL of the remote repository to be clustered.    |
+        | enabled                | Boolean | no         | Determines if the cluster is enabled.                |
+        | only_protected_branches| Boolean | no         | Determines if only protected branches are clustered. |
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'Via ProjectCluster [Params]'
+      example <<~DOC
+        cluster = client.projects.clusters.list(310).first
+        cluster.update(name: 'bump')
+      DOC
+    end
+
+    def update(project_id, cluster_id, query)
+      project_id = format_id(project_id)
+      cluster_id = format_id(cluster_id)
+
+      client.request(:put, "projects/#{project_id}/clusters/#{cluster_id}", ProjectCluster, query)
+    end
+  end
+end

data/lib/labclient/projects/create.rb

@@ -0,0 +1,49 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Projects < Common
+    doc 'Create' do
+      desc 'Creates a new project owned by the authenticated user.'
+      example 'client.projects.create(name: "Galaxy", description: "On orions belt")'
+      result '#<Project id: 299 root/galaxy>'
+
+      markdown <<~DOC
+        [See official docs for all possible params](https://docs.gitlab.com/ee/api/projects.html#create-project)
+
+        | Attribute | Type | Required | Description |
+        | --------- | ---- | -------- | ----------- |
+        | name | string | yes if path is not provided | The name of the new project. Equals path if not provided. |
+        | path | string | yes if name is not provided | Repository name for new project. Generated based on name if not provided (generated lowercased with dashes). |
+        | description | string | no | Short project description |
+        | namespace_id | integer | no | Namespace for the new project (defaults to the current user's namespace) |
+        | default_branch | string | no | master by default |
+
+      DOC
+    end
+
+    doc 'Create' do
+      subtitle 'Examples'
+      desc 'Specific Namespace'
+      example 'client.projects.create(name: "Winter", description: "Is coming", namespace_id: 80 )'
+    end
+
+    doc 'Create' do
+      desc 'Visibility'
+      example 'client.projects.create(name: "Verbal", description: "hes gone", visibility:  :private)'
+    end
+
+    doc 'Create' do
+      title 'For User'
+      desc 'Creates a new project owned by the specified user [user id, params]'
+      example 'client.projects.create_for_user(1, name: "Rule of battle", description: "WHOO-HOO! IM RIGHT HERE")'
+    end
+
+    def create_for_user(user_id, query = {})
+      client.request(:post, "projects/user/#{user_id}", Project, query)
+    end
+
+    def create(query = {})
+      client.request(:post, 'projects', Project, query)
+    end
+  end
+end

data/lib/labclient/projects/delete.rb

@@ -0,0 +1,25 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Projects < Common
+    doc 'Delete' do
+      desc 'Removes a project including all associated resources.'
+      example 'client.projects.delete(25)'
+      result '{:message=>"202 Accepted"}'
+    end
+
+    doc 'Delete' do
+      desc 'Via Project'
+      example <<~DOC
+        project = client.projects.show(299)
+        project.delete
+      DOC
+    end
+
+    def delete(project_id)
+      project_id = format_id(project_id)
+
+      client.request(:delete, "projects/#{project_id}")
+    end
+  end
+end

data/lib/labclient/projects/deployments/client.rb

@@ -0,0 +1,17 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class ProjectDeployments < Common
+    include ClassHelpers
+  end
+end
+
+# Top namespace
+module LabClient
+  # Specifics
+  class Projects < Common
+    def deployments
+      ProjectDeployments.new(client)
+    end
+  end
+end

data/lib/labclient/projects/deployments/create.rb

@@ -0,0 +1,56 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectDeployments < Common
+    doc 'Create' do
+      desc 'Create a deployment. [Project ID, Hash]'
+      example <<~DOC
+        params = {
+          environment: :rawr,
+          sha: '0bc128f3',
+          ref: :master,
+          tag: false,
+          status: 'running'
+        }
+
+        client.projects.deployments.create(16, params)
+      DOC
+
+      result '=>  #<ProjectDeployment id: 2, name: rawr, url: http://labclient.com>'
+    end
+
+    doc 'Create' do
+      markdown <<~DOC
+        | Attribute        | Type           | Required | Description         |
+        |------------------|----------------|----------|---------------------|
+        | environment      | string         | yes      | The name of the environment to create the deployment for |
+        | sha              | string         | yes      | The SHA of the commit that is deployed |
+        | ref              | string         | yes      | The name of the branch or tag that is deployed |
+        | tag              | boolean        | yes      | A boolean that indicates if the deployed ref is a tag (true) or not (false) |
+        | status           | string         | yes      | The status of the deployment |
+
+        The status can be one of the following values:
+
+        - created
+        - running
+        - success
+        - failed
+        - canceled
+      DOC
+    end
+
+    doc 'Create' do
+      desc 'Via Project'
+      example <<~DOC
+        project = client.projects.show(100)
+        deployment = project.deployment_create(name: 'rawr', external_url:'https://labclient')
+      DOC
+    end
+
+    def create(project_id, query)
+      project_id = format_id(project_id)
+
+      client.request(:post, "projects/#{project_id}/deployments", ProjectDeployment, query)
+    end
+  end
+end

data/lib/labclient/projects/deployments/list.rb

@@ -0,0 +1,67 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectDeployments < Common
+    doc 'List' do
+      desc 'Get a list of deployments in a project. [Project ID, Filter Params]'
+      example 'client.projects.deployments.list(16)'
+
+      result <<~DOC
+        => [#<ProjectDeployment id: 1, status: running>, #<ProjectDeployment id: 2, status: running>, #<ProjectDeployment id: 3, status: running>]
+      DOC
+    end
+
+    doc 'List' do
+      markdown <<~DOC
+        | Attribute | Type    | Required | Description         |
+        |-----------|---------|----------|---------------------|
+        | order_by| string  | no       | Return deployments ordered by id or iid or created_at or updated_at or ref fields. Default is id |
+        | sort    | string  | no       | Return deployments sorted in asc or desc order. Default is asc |
+        | updated_after | datetime | no | Return deployments updated after the specified date |
+        | updated_before | datetime | no | Return deployments updated before the specified date |
+        | environment | string | no | The name of the environment to filter deployments by |
+        | status | string | no | The status to filter deployments by |
+
+        The status attribute can be one of the following values:
+
+          - created
+          - running
+          - success
+          - failed
+          - canceled
+
+      DOC
+    end
+
+    doc 'List' do
+      desc 'Filter by Status'
+      example 'client.projects.deployments.list(status: :created)'
+    end
+    doc 'List' do
+      desc 'Search by Environment'
+      example 'client.projects.deployments.list(environment: :title)'
+    end
+
+    doc 'List' do
+      desc 'Filter by time'
+      example 'client.projects.deployments.list(updated_after: 1.year.ago)'
+    end
+
+    doc 'List' do
+      desc 'Via Project'
+      example <<~DOC
+        project = client.projects.show(16)
+        project.deployments
+      DOC
+    end
+
+    def list(project_id, query = {})
+      project_id = format_id(project_id)
+
+      query[:updated_after] = query[:updated_after].to_time.iso8601 if format_time?(query[:updated_after])
+      query[:updated_before] = query[:updated_before].to_time.iso8601 if format_time?(query[:updated_before])
+
+      client.request(:get, "projects/#{project_id}/deployments", ProjectDeployment, query)
+    end
+  end
+end

data/lib/labclient/projects/deployments/merge_requests.rb

@@ -0,0 +1,33 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectDeployments < Common
+    doc 'Merge Requests' do
+      desc 'Retrieves the list of merge requests shipped with a given deployment. [Project ID, Environment ID, Params]'
+      example 'client.projects.deployments.merge_requests(16, 1)'
+    end
+
+    doc 'Merge Requests' do
+      desc 'Via Project [Environment ID]'
+      example <<~DOC
+        project = client.projects.show(100)
+        project.deployment_merge_requests(3)
+      DOC
+    end
+
+    doc 'Merge Requests' do
+      desc 'Via ProjectDeployment'
+      example <<~DOC
+        deployment = client.projects.deployments.show(100, 4)
+        deployment.merge_requests
+      DOC
+    end
+
+    def merge_requests(project_id, deployment_id, query = {})
+      project_id = format_id(project_id)
+      deployment_id = format_id(deployment_id)
+
+      client.request(:get, "projects/#{project_id}/deployments/#{deployment_id}/merge_requests", MergeRequest, query)
+    end
+  end
+end

data/lib/labclient/projects/deployments/project_deployment.rb

@@ -0,0 +1,39 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class ProjectDeployment < Klass
+    include ClassHelpers
+    def inspect
+      "#<ProjectDeployment id: #{id}, status: #{status}>"
+    end
+
+    def project
+      project_id = collect_project_id
+      client.projects.show project_id
+    end
+
+    def update(query)
+      project_id = collect_project_id
+
+      update_self client.projects.deployments.update(project_id, id, query)
+    end
+
+    def merge_requests
+      project_id = collect_project_id
+
+      client.projects.deployments.merge_requests(project_id, id)
+    end
+
+    date_time_attrs %i[created_at updated_at]
+    user_attrs %i[user]
+
+    help do
+      @group_name = 'Projects'
+      subtitle 'ProjectDeployment'
+      option 'project', 'Show Project'
+      option 'update', 'Update this deployment [Hash]'
+      option 'delete', 'Delete this deployment'
+      option 'stop', 'Stop this deployment'
+    end
+  end
+end

data/lib/labclient/projects/deployments/show.rb

@@ -0,0 +1,27 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectDeployments < Common
+    doc 'Show' do
+      desc 'Get a specific deployment [Project ID, Deployment ID]'
+      example 'client.projects.deployments.show(16, 1)'
+
+      result '=> #<ProjectDeployment id: 1, status: running>'
+    end
+
+    doc 'Show' do
+      desc 'Via Project [Deployment ID]'
+      example <<~DOC
+        project = client.projects.show(16)
+        deployment = project.deployment_show(1)
+      DOC
+    end
+
+    def show(project_id, deployment_id)
+      project_id = format_id(project_id)
+      deployment_id = format_id(deployment_id)
+
+      client.request(:get, "projects/#{project_id}/deployments/#{deployment_id}", ProjectDeployment)
+    end
+  end
+end

data/lib/labclient/projects/deployments/update.rb

@@ -0,0 +1,52 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectDeployments < Common
+    doc 'Update' do
+      desc 'Updating a deployment status [Project ID, Environment ID, Status]'
+      example 'client.projects.deployments.update(16, 3, :success)'
+
+      result '=>  #<ProjectDeployment id: 3, status: success>'
+    end
+
+    doc 'Update' do
+      markdown <<~DOC
+        | Attribute        | Type           | Required | Description         |
+        |------------------|----------------|----------|---------------------|
+        | status           | string         | yes      | The status of the deployment |
+
+        The status can be one of the following values:
+
+        - created
+        - running
+        - success
+        - failed
+        - canceled
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'Via Project [Environment ID, Status]'
+      example <<~DOC
+        project = client.projects.show(16)
+        deployment = project.deployment_update(4, :running)
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'Via ProjectDeployment [Status]'
+      example <<~DOC
+        deployment = client.projects.deployments.show(16, 4)
+        deployment.update(:failed)
+      DOC
+    end
+
+    def update(project_id, deployment_id, status)
+      project_id = format_id(project_id)
+      deployment_id = format_id(deployment_id)
+      query = { status: status }
+
+      client.request(:put, "projects/#{project_id}/deployments/#{deployment_id}", ProjectDeployment, query)
+    end
+  end
+end

data/lib/labclient/projects/environments/client.rb

@@ -0,0 +1,17 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class ProjectEnvironments < Common
+    include ClassHelpers
+  end
+end
+
+# Top namespace
+module LabClient
+  # Specifics
+  class Projects < Common
+    def environments
+      ProjectEnvironments.new(client)
+    end
+  end
+end

data/lib/labclient/projects/environments/create.rb

@@ -0,0 +1,37 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectEnvironments < Common
+    doc 'Create' do
+      desc 'Creates a new environment with the given name and external_url. [Project ID, Hash]'
+      example <<~DOC
+        client.projects.environments.create(16, name: 'rawr', external_url:'https://labclient')
+      DOC
+
+      result '=>  #<ProjectEnvironment id: 2, name: rawr, url: http://labclient.com>'
+    end
+
+    doc 'Create' do
+      markdown <<~DOC
+        | Attribute     | Type    | Required | Description                           |
+        | ------------- | ------- | -------- | ------------------------------------- |
+        | name          | string  | yes      | The name of the environment           |
+        | external_url  | string  | no       | Place to link to for this environment |
+      DOC
+    end
+
+    doc 'Create' do
+      desc 'Via Project'
+      example <<~DOC
+        project = client.projects.show(100)
+        environment = project.environment_create(name: 'rawr', external_url:'https://labclient')
+      DOC
+    end
+
+    def create(project_id, query)
+      project_id = format_id(project_id)
+
+      client.request(:post, "projects/#{project_id}/environments", ProjectEnvironment, query)
+    end
+  end
+end