labclient 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4c0988633436f9872d93e241ceb4c85e5b780b5f419a08054231138d8448dc5
-  data.tar.gz: '06268afb4c985bd5dbffebf72c610aa0c4fe1083af0b86d30d5624a69e25f52e'
+  metadata.gz: a747d261d131d7f0a228cb02753e21798c951393941247d0d4252a9c253c5650
+  data.tar.gz: 228a9181e7345f607e8d4ab6617d729f9b4b44ab7e1fdcd295db4ed3332a257d
 SHA512:
-  metadata.gz: c558d37e33b7efdad2b9e0621c3a0d437e2345cc987403af2c15bed6e1d0a04c926de86442e1595a7fbfb6b0aae63af8583430f4046782edea2362a0ebf946f7
-  data.tar.gz: 211e88abab828ddc51c7b6a8965a962ec34f95fb4f7e3106611f3af5b5d72e6c75431c3eabedb618a838f29b3b64e4301ed173d38120c9ef4bb0e5b0d45a8e69
+  metadata.gz: 2d66d602d12ccd265ae6b1e5aa28c0cdeabbbcc0ee678c5be80a30c42ef342e7b9308acf0a075da04cd4bbb76c744ce32d52122e0f4b87c36c9a9faf09b7834a
+  data.tar.gz: c3eaf2cb6c83effec491f071bf0e5de9f2638f68d0af5656ae146915245eb00b091d7a566ef6c28c88db562a9b71cf8b773798fd7890693b098fbc66bdfd9adb

data/lib/labclient.rb

@@ -359,6 +359,15 @@ require 'labclient/groups/badges/update'
 require 'labclient/groups/badges/delete'
 require 'labclient/groups/badges/group_badge'
 
+# Group Clusters
+require 'labclient/groups/clusters/client'
+require 'labclient/groups/clusters/list'
+require 'labclient/groups/clusters/show'
+require 'labclient/groups/clusters/add'
+require 'labclient/groups/clusters/update'
+require 'labclient/groups/clusters/delete'
+require 'labclient/groups/clusters/group_cluster'
+
 require 'labclient/groups/group'
 
 # Issues

data/lib/labclient/client.rb

@@ -82,9 +82,16 @@ module LabClient
       subclasses.keys.sort
     end
 
-    def help
+    def help(help_filter = nil)
       puts 'Available Methods'
-      puts " - #{subclasses.keys.sort.join(' ')}\n\n"
+
+      shown_subclasses = if help_filter
+                           api_methods.grep(/#{help_filter}/)
+                         else
+                           api_methods
+                         end
+
+      puts " - #{shown_subclasses.join(' ')}\n\n"
       puts "See help for each specific sub-category\n"
       puts "- client.users.help\n"
       puts "- client.users.api_methods\n"

data/lib/labclient/common.rb

@@ -12,13 +12,15 @@ module LabClient
     end
 
     def api_methods
-      public_methods(false)
+      public_methods(false).sort
     end
 
-    def help
-      api_methods_help
+    def help(help_filter = nil)
+      api_methods_help(help_filter)
+
+      LabClient::Docs.docs[group_name]&.each do |key, group|
+        next if help_filter && !key.downcase.include?(help_filter.to_s)
 
-      LabClient::Docs.docs[group_name].each do |key, group|
         puts "\n=====[ #{key} ]====="
         group.select { |x| x[:example] }.each { |x| puts "#{x[:example]}\n" }
       end
@@ -26,10 +28,17 @@ module LabClient
       nil
     end
 
-    def api_methods_help
+    def api_methods_help(help_filter = nil)
       puts group_name
       puts '  Available Methods'
-      puts "      #{api_methods.sort.join(' ')}\n"
+
+      shown_subclasses = if help_filter
+                           api_methods.grep(/#{help_filter}/)
+                         else
+                           api_methods
+                         end
+
+      puts "      #{shown_subclasses.join(' ')}\n"
     end
 
     # Helper to get docs

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

@@ -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/klass.rb

@@ -14,7 +14,7 @@ module LabClient
 
     # API Methods here have to be explicitly documented / custom helpers
     # Assume no methods by default
-    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+    # rubocop:disable Metrics/AbcSize
     def help(help_filter = nil)
       docs = LabClient::Docs.docs.dig(group_name, 'Reference')
       unless docs
@@ -27,9 +27,7 @@ module LabClient
         next unless doc[:options]
 
         doc[:options].each do |opt|
-          if help_filter
-            next unless (opt[:name] + opt[:text]).include? help_filter.to_s
-          end
+          next if help_filter && !(opt[:name] + opt[:text]).include?(help_filter.to_s)
 
           puts "  #{opt[:name]}"
           puts "    #{opt[:text]}\n"
@@ -39,7 +37,7 @@ module LabClient
       # Ignore Output
       nil
     end
-    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
+    # rubocop:enable Metrics/AbcSize
 
     # Documented API Methods
     def api_methods

data/lib/labclient/overview.rb

@@ -206,16 +206,21 @@ module LabClient
     doc 'Other' do
       title 'Common Helpers'
       markdown <<~DOC
-        The main api namespaces have a `help` and an `api_methods` methods. These will print out available methods and examples
+        The main api namespaces have a `help` and an `api_methods` methods. These will print out available methods and examples.
+
+        These each accept a filter argument
       DOC
 
       result <<~DOC
+        # General Help / Available Methods
         client.help
         client.api_methods
 
+        # Show Project specific Methods
         client.projects.api_methods
         # => [:show, :list, :create]
 
+        # Show Users specific help
         client.users.help
         Users
           Available Methods
@@ -231,6 +236,25 @@ module LabClient
           - client.users.show(5)
           - client.users.show(5)
           
+        # General Help Filter
+        client.help :protect
+        Available Methods
+        - protected_branches protected_environments protected_tags
+        
+        # Projects Help Filter
+        client.projects.help :cluster
+        Projects
+          Available Methods
+              - clusters
+      
+        # Project Object Help
+        project = client.projects.show(16)
+        project.help
+
+        # Project Object Help Filter
+        project.help :member
+
+
       DOC
     end
 

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

@@ -27,7 +27,7 @@ module LabClient
         | --------- | ---- | -------- | ----------- |
         | 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 |
+        | 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 |

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

@@ -11,11 +11,10 @@ module LabClient
 
     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. |
+        | Attribute | Type | Required | Description |
+        | --------- | ---- | -------- | ----------- |
+        | `id` | integer | yes | The ID of the project owned by the authenticated user |
+        | `cluster_id` | integer | yes | The ID of the cluster |
       DOC
     end
 
@@ -23,7 +22,7 @@ module LabClient
       desc 'Via ProjectCluster [Params]'
       example <<~DOC
         cluster = client.projects.clusters.list(310).first
-        cluster.update(enabled: false)
+        cluster.delete
       DOC
     end
 

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

@@ -12,10 +12,10 @@ module LabClient
     end
 
     doc 'Show' do
-      desc 'Via Project'
+      desc 'Via Project [Cluster ID]'
       example <<~DOC
         project = client.projects.show(16)
-        project.clusters
+        project.cluster(cluster_id)
       DOC
     end
 

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

@@ -11,11 +11,19 @@ module LabClient
 
     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. |
+        | 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. |
+        | platform_kubernetes_attributes[namespace] | string | no | The unique namespace related to the project |
+        | 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
 

data/lib/labclient/projects/forks/fork.rb

@@ -2,8 +2,6 @@
 module LabClient
   # Specifics
   class Projects < Common
-    @group_name = 'Project Forks'
-
     doc 'Create' do
       desc 'Forks a project into the user namespace of the authenticated user or the one provided.'
       example 'client.projects.fork(299)'

data/lib/labclient/projects/methods.rb

@@ -709,6 +709,10 @@ module LabClient
       client.projects.clusters.list(id)
     end
 
+    def cluster(cluster_id)
+      client.projects.clusters.show(id, cluster_id)
+    end
+
     # Reload
     def reload
       update_self client.projects.show(id)

data/lib/labclient/projects/stars/starrers.rb

@@ -2,8 +2,6 @@
 module LabClient
   # Specifics
   class Projects < Common
-    @group_name = 'Project Stars'
-
     doc 'Starrers' do
       desc 'List the users who starred the specified project. [user id]'
       example 'client.projects.starrers(5)'

data/lib/labclient/version.rb

@@ -1,3 +1,3 @@
 module LabClient
-  VERSION = '0.2.1'.freeze
+  VERSION = '0.3.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: labclient
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Davin Walker
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-28 00:00:00.000000000 Z
+date: 2020-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -210,16 +210,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.82'
+        version: 0.91.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.82'
+        version: 0.91.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -423,6 +423,13 @@ files:
 - lib/labclient/groups/badges/preview.rb
 - lib/labclient/groups/badges/show.rb
 - lib/labclient/groups/badges/update.rb
+- lib/labclient/groups/clusters/add.rb
+- lib/labclient/groups/clusters/client.rb
+- lib/labclient/groups/clusters/delete.rb
+- lib/labclient/groups/clusters/group_cluster.rb
+- lib/labclient/groups/clusters/list.rb
+- lib/labclient/groups/clusters/show.rb
+- lib/labclient/groups/clusters/update.rb
 - lib/labclient/groups/create.rb
 - lib/labclient/groups/delete.rb
 - lib/labclient/groups/group.rb