labclient 0.1.4 → 0.3.1

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,11 +27,9 @@ 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[:name]}"
           puts "    #{opt[:text]}\n"
         end
       end
@@ -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
@@ -63,7 +61,12 @@ module LabClient
 
     # TODO: Combine all of these?
     def collect_project_id(position = 1)
-      response.path.split('/')[position]
+      # Check if Path / Pagination will be blank
+      if response.path.nil?
+        response.request.base_url.split(@client.base_url, 2)[position]
+      else
+        response.path.split('/')[position]
+      end
     end
 
     alias collect_group_id collect_project_id
@@ -97,6 +100,7 @@ module LabClient
       self
     end
 
+    # rubocop:disable Lint/MissingSuper
     def initialize(hash = nil, response = nil, client = nil)
       @client = client
       @response = response
@@ -107,6 +111,7 @@ module LabClient
         @table[k] = v
       end
     end
+    # rubocop:enable Lint/MissingSuper
 
     # Forward response success
     def success?

data/lib/labclient/lab_struct.rb

@@ -13,5 +13,9 @@ module LabClient
     def as_json(*args)
       super.as_json['table']
     end
+
+    def slice(*opts)
+      to_h.slice(*opts)
+    end
   end
 end

data/lib/labclient/notes/epics/create.rb

@@ -11,6 +11,14 @@ module LabClient
       DOC
     end
 
+    doc 'Epics' do
+      desc 'Via Epic'
+      example <<~DOC
+        epic = client.epics.show(16, 2)
+        epic.note_create(body: 'There!')
+      DOC
+    end
+
     doc 'Epics' do
       markdown <<~DOC
         | Attribute  | Type   | Required | Description |

data/lib/labclient/notes/issues/create.rb

@@ -11,6 +11,14 @@ module LabClient
       DOC
     end
 
+    doc 'Issues' do
+      desc 'Via Issue'
+      example <<~DOC
+        issue = client.issues.show(16, 1)
+        issue.note_create(body: 'There!')
+      DOC
+    end
+
     doc 'Issues' do
       markdown <<~DOC
         | Attribute  | Type   | Required | Description |

data/lib/labclient/notes/merge_requests/create.rb

@@ -11,6 +11,14 @@ module LabClient
       DOC
     end
 
+    doc 'Merge Request' do
+      desc 'Via Merge Request'
+      example <<~DOC
+        merge_request = client.merge_requests.show(16, 2)
+        merge_request.note_create(body: 'There!')
+      DOC
+    end
+
     doc 'Merge Requests' do
       markdown <<~DOC
         | Attribute  | Type   | Required | Description |

data/lib/labclient/overview.rb

@@ -7,11 +7,24 @@ module LabClient
 
     doc 'Overview' do
       title 'About'
-      desc <<~DOC
-        Labclient is another Gitlab API Gem. A focus on ease of use and helpers and snippets.
+      markdown <<~DOC
+        LabClient is a Gitlab API Gem. Focusing on ease of use, documentation, helpers, and snippets.
+
+        - Objects for resources (User, Project)
+        - Method Chaining ( project.branch(:master).pipelines ) 
+        
+        Lots of Helpers
+        
+        - Pagination
+        - IRB/Pry
+        - Setup: credentials file, profiles, and prompt
+        - Permission Levels
+        - Curl generator
 
-        <a href="https://github.com/NARKOZ/gitlab">Gitlab</a> is an excellent gem, and is nearly complete in its implementation. While this is still a work in progress and you are looking for general use you should use it.
+        Here is a quick whirlwind example of some of the features:
       DOC
+
+      demo '350689'
     end
 
     doc 'Overview' do
@@ -202,16 +215,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
@@ -226,6 +244,26 @@ module LabClient
         User
           - 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
 
@@ -244,6 +282,9 @@ module LabClient
         # Awesome Print all details
         project.valid_group_project_levels
         # => [:guest, :reporter, :developer, :maintainer, :owner]
+
+        # Select Data from objects with `slice`
+        project.slice(:readme_url, :owner)
       DOC
     end
 
@@ -287,6 +328,22 @@ module LabClient
       DOC
     end
 
+    doc 'Other' do
+      title 'Quiet'
+      desc 'Error messages by default are printed to STDOUT. This can be supressed via the :quiet setting'
+
+      example <<~DOC
+        client = LabClient::Client.new(
+          url: 'https://gitlab.labclient',
+          token: 'gitlab api token',
+          quiet: true
+        )
+        
+        # Or after the init
+        client.settings[:quiet] = true
+      DOC
+    end
+
     doc 'Other' do
       title 'Curl'
       desc 'Sometimes you just wana have a curl example to test or send someone'

data/lib/labclient/paginated_response.rb

@@ -40,7 +40,9 @@ module LabClient
       DOC
     end
 
+    # rubocop:disable Lint/MissingSuper
     def respond_to_missing?(method_name, include_private = false); end
+    # rubocop:enable Lint/MissingSuper
 
     def each_page(&block)
       yield @array # This will eventually be the whole list

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/environments/project_environment.rb

@@ -24,6 +24,14 @@ module LabClient
       client.projects.environments.delete(project_id, id)
     end
 
+    def show
+      project_id = collect_project_id
+
+      update_self client.projects.environments.show(project_id, id)
+    end
+
+    alias reload show
+
     def stop
       project_id = collect_project_id
 
@@ -35,6 +43,8 @@ module LabClient
     help do
       subtitle 'ProjectEnvironment'
       option 'project', 'Show Project'
+      option 'show', 'Collect/reload environment'
+      option 'reload', 'Collect/reload environment'
       option 'update', 'Update this environment [Hash]'
       option 'delete', 'Delete this environment'
       option 'stop', 'Stop this environment'

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

@@ -476,6 +476,8 @@ module LabClient
       client.projects.environments.show(id, environment_id)
     end
 
+    alias environment environment_show
+
     def environment_create(query)
       client.projects.environments.create(id, query)
     end
@@ -707,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/reference.rb

@@ -139,6 +139,7 @@ module LabClient
 
       # Commits
       option 'commits', 'List Commits [Hash]'
+      option 'commit', 'Show Commit [String/Commit Sha]'
       option 'commit_create', 'Create new commit [Hash]'
       option 'commit_refs', 'Get all references (from branches or tags) a commit is pushed to. [Commit ID, Scope]'
       option 'commit_cherry_pick', 'Cherry picks a commit to a target branch. [Commit ID, Branch]'

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.1.4'.freeze
+  VERSION = '0.3.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: labclient
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.3.1
 platform: ruby
 authors:
 - Davin Walker
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-28 00:00:00.000000000 Z
+date: 2020-10-19 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
@@ -398,6 +398,10 @@ files:
 - lib/labclient/events/list.rb
 - lib/labclient/events/project.rb
 - lib/labclient/events/user.rb
+- lib/labclient/feature_flags/create.rb
+- lib/labclient/feature_flags/delete.rb
+- lib/labclient/feature_flags/feature_flag.rb
+- lib/labclient/feature_flags/list.rb
 - lib/labclient/files/create.rb
 - lib/labclient/files/delete.rb
 - lib/labclient/files/show.rb
@@ -423,6 +427,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
@@ -902,7 +913,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Gitlab API Client