labclient 0.1.4 → 0.3.1

data/lib/labclient/files/update.rb

@@ -33,7 +33,7 @@ module LabClient
       desc 'via Project'
       example <<~DOC
         project = client.projects.show(264)
-        project.file_create('other.md',
+        project.file_update('other.md',
           branch: :master,
           commit_message: "New File!",
           content: "Content!")

data/lib/labclient/generator/generator.rb

@@ -26,6 +26,16 @@ module LabClient
         example 'gem install faker'
       end
 
+      doc 'Wizard' do
+        title 'Quickstart'
+        desc 'To run, create the client/wizard and run!'
+        example <<~DOC
+          require 'labclient'
+          client = LabClient::Client.new(url: 'https://labclient', token: 'super_secret')
+          client.wizard.run!
+        DOC
+      end
+
       doc 'Wizard' do
         title 'Client'
         desc <<-DOC

data/lib/labclient/generator/template_helper.rb

@@ -74,7 +74,6 @@ module LabClient
 
       def generate_group
         @group = client.groups.create(name: group_name, path: group_path)
-        # puts "#{@group.name} - #{@group.web_url}"
         raise 'Unable to Create Group' unless @group.success?
       end
     end

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

@@ -0,0 +1,46 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class GroupClusters < Common
+    doc 'Add' do
+      desc 'Adds an existing Kubernetes cluster to the group. [Group ID, Hash]'
+      example <<~DOC
+        params = {
+          name: 'cluster-5',
+          platform_kubernetes_attributes: {
+            api_url: 'https://35.111.51.20',
+            token: '12345',
+            ca_cert: "-----BEGIN .....-----END CERTIFICATE-----"
+          }
+        }
+
+          client.groups.clusters.add(310, params)
+      DOC
+
+      result '=>  #<GroupCluster 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 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[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(group_id, query)
+      group_id = format_id(group_id)
+
+      client.request(:post, "groups/#{group_id}/clusters/user", GroupCluster, query)
+    end
+  end
+end

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

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

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

@@ -0,0 +1,36 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class GroupClusters < Common
+    doc 'Delete' do
+      desc 'Deletes an existing group cluster. [Project ID, Mirror ID, Params]'
+      example 'client.group.clusters.update(310, 3, enabled: true)'
+
+      result '=>  #<GroupCluster id: 3, name: planet bob>'
+    end
+
+    doc 'Delete' do
+      markdown <<~DOC
+        | Attribute              | Type    | Required   | Description                                         |
+        | ----------             | -----   | ---------  | ------------                                        |
+        | `id` | integer/string | yes | The ID or URL-encoded path of the group |
+        | `cluster_id` | integer | yes | The ID of the cluster |
+      DOC
+    end
+
+    doc 'Delete' do
+      desc 'Via GroupCluster [Params]'
+      example <<~DOC
+        cluster = client.groups.clusters.list(310).first
+        cluster.delete
+      DOC
+    end
+
+    def delete(group_id, cluster_id)
+      group_id = format_id(group_id)
+      cluster_id = format_id(cluster_id)
+
+      client.request(:delete, "groups/#{group_id}/clusters/#{cluster_id}", GroupCluster)
+    end
+  end
+end

data/lib/labclient/groups/clusters/group_cluster.rb

@@ -0,0 +1,37 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class GroupCluster < Klass
+    include ClassHelpers
+    def inspect
+      "#<GroupCluster id: #{id}, name: #{name}>"
+    end
+
+    def group
+      group_id = collect_group_id
+      client.groups.show group_id
+    end
+
+    def update(query)
+      group_id = collect_group_id
+
+      update_self client.groups.clusters.update(group_id, id, query)
+    end
+
+    def delete
+      group_id = collect_group_id
+
+      client.groups.clusters.delete(group_id, id)
+    end
+
+    date_time_attrs %i[created_at]
+    user_attrs %i[uster]
+
+    help do
+      subtitle 'GroupCluster'
+      option 'group', 'Show Group'
+      option 'update', 'Update this Cluster [Hash]'
+      option 'delete', 'Delete cluster'
+    end
+  end
+end

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

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

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

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

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

@@ -0,0 +1,44 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class GroupClusters < Common
+    doc 'Update' do
+      desc 'Updates an existing group cluster. [Group ID, Cluster ID, Hash]'
+      example 'client.groups.clusters.update(310, 3, name: "Sweet")'
+
+      result '=>  #<GroupCluster id: 3, name: Sweet>'
+    end
+
+    doc 'Update' 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 for the cluster |
+        | 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. |
+        | environment_scope | string | no | The associated environment to the cluster. Defaults to * **(PREMIUM)** |
+
+        `name`, `api_url`, `ca_cert` and `token` can only be updated if the cluster was added through the
+        “Add existing Kubernetes cluster” option or through the “Add existing cluster to project” endpoint.
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'Via GroupCluster [Params]'
+      example <<~DOC
+        cluster = client.groups.clusters.list(310).first
+        cluster.update(name: 'bump')
+      DOC
+    end
+
+    def update(group_id, cluster_id, query)
+      group_id = format_id(group_id)
+      cluster_id = format_id(cluster_id)
+
+      client.request(:put, "groups/#{group_id}/clusters/#{cluster_id}", GroupCluster, query)
+    end
+  end
+end

data/lib/labclient/groups/group.rb

@@ -42,7 +42,7 @@ module LabClient
 
     def projects(query = {})
       # Details Query Includes Projects
-      if query.empty? && !@table.dig(:projects).blank?
+      if query.empty? && !@table[:projects].blank?
         @table[:projects].map { |project| LabClient::Project.new(project, response, client) }
       else
         client.groups.projects(id, query)
@@ -151,6 +151,15 @@ module LabClient
       client.groups.badges.delete(id, badge_id)
     end
 
+    # Group Clusters
+    def clusters
+      client.groups.clusters.list(id)
+    end
+
+    def cluster(cluster_id)
+      client.groups.clusters.show(id, cluster_id)
+    end
+
     # Group Epics
     def epics
       client.epics.list(id)
@@ -295,6 +304,10 @@ module LabClient
       option 'badge_show', 'Show specific badge from group [Badge ID]'
       option 'badge_update', 'Update group badge [Badge ID, Hash]'
 
+      # Clusters
+      option 'clusters', "List this group's clusters"
+      option 'cluster', 'Show specific cluster from group [Cluster ID]'
+
       # Epics
       option 'epics', "List this group's epics"
       option 'epic_create', 'Create group epic [Hash]'

data/lib/labclient/http.rb

@@ -73,7 +73,7 @@ module Typhoeus
     def process_body
       if body.empty?
         nil
-      elsif headers['content-type'] == 'text/plain'
+      elsif headers['content-type']&.include? 'text/plain'
         body
       else
         Oj.load(body, mode: :compat, object_class: LabClient::LabStruct)

data/lib/labclient/issues/issue.rb

@@ -14,6 +14,16 @@ module LabClient
     # User Fields
     user_attrs %i[closed_by author assignee]
 
+    # Via State Events
+    def close
+      client.issues.update(project_id, iid, state_event: :close)
+    end
+
+    # Via State Events
+    def reopen
+      client.issues.update(project_id, iid, state_event: :reopen)
+    end
+
     def update(query)
       client.issues.update(project_id, iid, query)
     end
@@ -96,6 +106,13 @@ module LabClient
       update_self client.issues.show(project_id, iid)
     end
 
+    def project
+      # If from List Project ID isn't stored
+      project_id = collect_project_id if project_id.nil?
+
+      client.projects.show(project_id)
+    end
+
     help do
       subtitle 'Issue'
       option 'update', 'Update issue (accepts hash).'

data/lib/labclient/issues/update.rb

@@ -18,19 +18,37 @@ module LabClient
         |-------------------------------------------|----------------|----------|--------------|
         | title                                   | string         | no      | The title of an issue |
         | description                             | string         | no       | The description of an issue. Limited to 1,048,576 characters. |
+
+
       DOC
     end
 
     doc 'Update' do
-      desc 'Close Ticket'
+      title 'Close / Reopen'
+      markdown <<~DOC
+        Closing/Reopening of issues is handled via state_events. Either :close, or :reopen. The issue objects themselves also have helpers `reopen` `close`.
+      DOC
+
       example 'client.issues.update(5, 1, state_event: :close)'
     end
 
+    doc 'Update' do
+      example 'client.issues.update(5, 1, state_event: :reopen)'
+    end
+
+    doc 'Update' do
+      desc 'Through Issue Object'
+      example <<~DOC
+        issue = client.issues.show(5,1)
+        issue.close
+      DOC
+    end
+
     doc 'Update' do
       desc 'Through Issue Object'
       example <<~DOC
         issue = client.issues.show(5,1)
-        issue.update(title: "Dew it!")
+        issue.reopen
       DOC
     end
 

data/lib/labclient/jobs/delete.rb

@@ -3,7 +3,7 @@ module LabClient
   # Specifics
   class Jobs < Common
     doc 'Update' do
-      title 'Retry'
+      title 'Delete'
       desc 'Delete artifacts of a job. [Project ID, Job ID]'
       example 'client.jobs.delete(264, 14)'
     end

data/lib/labclient/jobs/keep.rb

@@ -3,7 +3,7 @@ module LabClient
   # Specifics
   class Jobs < Common
     doc 'Update' do
-      title 'Retry'
+      title 'Keep'
       desc 'Prevents artifacts from being deleted when expiration is set. [Project ID, Job ID]'
       example 'client.jobs.keep(264, 14)'
     end

data/lib/labclient/jobs/play.rb

@@ -3,7 +3,7 @@ module LabClient
   # Specifics
   class Jobs < Common
     doc 'Update' do
-      title 'Retry'
+      title 'Play'
       desc 'Triggers a manual action to start a job. [Project ID, Job ID]'
       example 'client.jobs.play(264, 14)'
     end

data/lib/labclient/jobs/trace.rb

@@ -20,14 +20,14 @@ module LabClient
       desc 'via Job'
       example <<~DOC
         job = client.jobs.show(264,1)
-        job.trace
+        job.trace #=> String
       DOC
     end
 
     def trace(project_id, job_id)
       job_id = format_id(job_id)
       project_id = format_id(project_id)
-      puts client.request(:get, "projects/#{project_id}/jobs/#{job_id}/trace")
+      client.request(:get, "projects/#{project_id}/jobs/#{job_id}/trace")
     end
   end
 end