labclient 0.1.4 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09bb30f5014cb0b4a37d7f4aa421549337b6177bf132580974cf1a35199c6242'
-  data.tar.gz: cc354dc398276bba64db00bc9adafd23e9c341eba16c4c2dd315788f3ab72fb1
+  metadata.gz: 0c77fa948bc39c9ec7d677340949a7bc52ed03999c4cb5286d125154edb06f9b
+  data.tar.gz: fa96ed5df9a9ddf7eea56cd7eb7a34832b4a9509d982159fd8069c5ae49de241
 SHA512:
-  metadata.gz: f492cb23a182293f165733d7d54830a2a34b9666c487cf63b5bd2dded2dbd58a7713f513eeba0813e382f1efe0d2c50cb8204f485678448b76f109bf289b8887
-  data.tar.gz: 0d558d85cea6f58bddf600dd36962b9a3fe1bc0c91e9b398ff6d2c35103fd61d88e4b6d47d24aa06bff15a5c2c195561847f495400ddef1eabaf78cfd7c65498
+  metadata.gz: 2148330fb1c533956e2f51085729c7c8e96b8fc27e21b43bbbac2b492906047bc52d964b203fe42ac86fc2f041310ab6c6b4e7f90ae5935efcedaf11674a4363
+  data.tar.gz: 004cbd92b60fd45996a4ecd9ae38039b3bae703a22f4d804e34390a56662a0f0859992295a83bf0d53f7e4e6191e2c9f416fcc4b7618e54e1b944c73aa4478fc

data/lib/labclient.rb

@@ -1,6 +1,5 @@
 # Public Gems
 require 'oj'
-require 'pry'
 require 'typhoeus'
 require 'active_support/all'
 require 'amazing_print'
@@ -360,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
@@ -849,6 +857,12 @@ require 'labclient/resource_labels/merge_requests/client'
 require 'labclient/resource_labels/merge_requests/list'
 require 'labclient/resource_labels/merge_requests/show'
 
+# Feature Flags
+require 'labclient/feature_flags/create'
+require 'labclient/feature_flags/delete'
+require 'labclient/feature_flags/list'
+require 'labclient/feature_flags/feature_flag'
+
 require 'labclient/resource_labels/resource_label'
 
 # Generators
@@ -860,7 +874,7 @@ require 'labclient/generator/generator'
 require 'labclient/generator/wizard'
 
 # Dynamically Require Templates (Simplify new template creation)
-Dir[File.dirname(__FILE__) + '/labclient/generator/templates/*.rb'].sort.each { |file| require file }
+Dir["#{File.dirname(__FILE__)}/labclient/generator/templates/*.rb"].sort.each { |file| require file }
 
 # I am Very Last
 require 'labclient/client'

data/lib/labclient/access_levels.rb

@@ -2,46 +2,40 @@
 module LabClient
   # Shared Methods
   module AccessLevel
+    HUMAN_ACCESS_LEVELS = {
+      0 => :none,
+      10 => :guest,
+      20 => :reporter,
+      30 => :developer,
+      40 => :maintainer,
+      50 => :owner,
+      60 => :admin
+    }.freeze
+
+    MACHINE_ACCESS_LEVELS = {
+      none: 0,
+      guest: 10,
+      reporter: 20,
+      developer: 30,
+      maintainer: 40,
+      owner: 50,
+      admin: 60
+    }.freeze
+
     def human_access_level(level = 10)
-      case level
-      when 0 then :none
-      when 10 then :guest
-      when 20 then :reporter
-      when 30 then :developer
-      when 40 then :maintainer
-      when 50 then :owner
-      when 60 then :admin
-      end
+      HUMAN_ACCESS_LEVELS[level]
     end
 
     def machine_access_level(level = :developer)
-      case level
-      when :none then 0
-      when :guest then 10
-      when :reporter then 20
-      when :developer then 30
-      when :maintainer then 40
-      when :owner then 50
-      when :admin then 60
-      end
+      MACHINE_ACCESS_LEVELS[level]
     end
 
     def machine_protected_access_level(level = :developer)
-      case level
-      when :none then 0
-      when :developer then 30
-      when :maintainer then 40
-      when :admin then 60
-      end
+      MACHINE_ACCESS_LEVELS[level]
     end
 
     def human_protected_access_level(level = 10)
-      case level
-      when 0 then :none
-      when 30 then :developer
-      when 40 then :maintainer
-      when 60 then :admin
-      end
+      HUMAN_ACCESS_LEVELS[level]
     end
   end
 end

data/lib/labclient/client.rb

@@ -37,8 +37,8 @@ module LabClient
       discussions: Discussions,
       epics: Epics,
       events: Events,
+      feature_flags: FeatureFlags,
       files: Files,
-      wizard: Generator::Wizard,
       groups: Groups,
       impersonation_tokens: ImpersonationTokens,
       issues: Issues,
@@ -69,7 +69,8 @@ module LabClient
       todos: Todos,
       users: Users,
       version: Version,
-      wikis: Wikis
+      wikis: Wikis,
+      wizard: Generator::Wizard
     }
 
     @subclasses.each do |name, obj|
@@ -82,9 +83,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"
@@ -109,24 +117,29 @@ module LabClient
       self.http = HTTP.new(@settings)
     end
 
+    def base_url
+      "#{settings[:url]}/api/v4/"
+    end
+
     def prompt_for_url
       print 'Enter GitLab URL (e.g. https://gitlab.com): '
-      @settings[:url] = STDIN.gets.chomp
+      @settings[:url] = $stdin.gets.chomp
       raise 'LabClient Error - Missing URL!' if @settings[:url].blank?
     end
 
     def prompt_for_token
       print 'Enter Personal Access Token: '
-      @settings[:token] = STDIN.gets.chomp
+      @settings[:token] = $stdin.gets.chomp
     end
 
     def unspecified_defaults
       @settings[:paginate] = true if @settings[:paginate].nil?
       @settings[:ssl_verify] = true if @settings[:ssl_verify].nil?
+      @settings[:quiet] = false if @settings[:quiet].nil?
     end
 
     def home_file
-      ENV['HOME'] + '/.gitlab-labclient'
+      "#{ENV['HOME']}/.gitlab-labclient"
     end
 
     # Easier Profile Name Access
@@ -173,7 +186,7 @@ module LabClient
 
       process resp
     rescue LabClient::Error => e
-      puts e.message
+      puts e.message unless settings[:quiet]
       resp
     end
 

data/lib/labclient/commits/project_helpers.rb

@@ -6,6 +6,10 @@ module LabClient
       client.commits.list(id, query)
     end
 
+    def commit(commit_id, query = {})
+      client.commits.show(id, commit_id, query)
+    end
+
     def commit_create(query = {})
       client.commits.create(id, query)
     end

data/lib/labclient/commits/show.rb

@@ -16,10 +16,19 @@ module LabClient
       DOC
     end
 
+    doc 'Show' do
+      desc 'Via Project'
+      example <<~DOC
+        project = client.projects.show(16)
+        project.commit("b539e5d3")
+      DOC
+    end
+
     # Show
-    def show(project_id, commit_id)
+    def show(project_id, commit_id, query = {})
       project_id = format_id(project_id)
-      client.request(:get, "projects/#{project_id}/repository/commits/#{commit_id}", Commit)
+
+      client.request(:get, "projects/#{project_id}/repository/commits/#{commit_id}", Commit, query)
     end
   end
 end

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/docs.rb

@@ -26,11 +26,11 @@ module LabClient
     # ---------------------------------
 
     # Klass Helper
-    def help
+    def help(&block)
       # require 'active_support/inflector'
       @group_name ||= group_name.pluralize
       doc 'Reference' do
-        yield
+        block.call
       end
     end
 
@@ -50,10 +50,14 @@ module LabClient
     end
 
     def desc(value)
-      # @result[:desc] = simple_format value
       @result[:desc] = value
     end
 
+    def demo(value)
+      @result[:demo_url] = "https://asciinema.org/a/#{value}.js"
+      @result[:demo] = "<script id='asciicast-#{value}' src='#{@result[:demo_url]}' data-autoplay='true' data-loop='true' async></script>"
+    end
+
     def example(value)
       @result[:example] = value
     end
@@ -81,10 +85,10 @@ module LabClient
       subnav = subgroup.gsub(' ', '_')
 
       # Title
-      subnav += '_' + @result[:title].gsub(' ', '_') if @result.key? :title
+      subnav += "_#{@result[:title].gsub(' ', '_')}" if @result.key? :title
 
       @result[:nav] = nav
-      @result[:nav] += '-' + subnav if subnav
+      @result[:nav] += "-#{subnav}" if subnav
     end
 
     def doc(subgroup)

data/lib/labclient/feature_flags/create.rb

@@ -0,0 +1,48 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class FeatureFlags < Common
+    doc 'Create' do
+      title 'Set or create a feature'
+      example 'client.feature_flags.create(:create_eks_clusters, value: true)'
+      result <<~DOC
+        => #<FeatureFlag name: create_eks_clusters, state: on
+      DOC
+    end
+
+    doc 'Attributes' do
+      desc 'Register a new Application'
+      markdown <<~DOC
+        | Attribute | Type | Required | Description |
+        | --------- | ---- | -------- | ----------- |
+        | name | string | yes | Name of the feature to create or update |
+        | value | integer/string | yes | `true` or `false` to enable/disable, or an integer for percentage of time |
+        | feature_group | string | no | A Feature group name |
+        | user | string | no | A GitLab username |
+        | group | string | no | A GitLab group's path, for example gitlab-org |
+        | project | string | no | A projects path, for example gitlab-org/gitlab-foss |
+
+         Note that you can enable or disable a feature for a `feature_group`, a `user`,
+         a `group`, and a `project` in a single API call.
+      DOC
+    end
+
+    doc 'Create' do
+      example <<~DOC
+        client.applications.create(
+          name: "Grafana",
+          redirect_uri: "https://gitlab.com/-/grafana/login/gitlab",
+          scopes: "email"
+        )
+      DOC
+      result <<~DOC
+        #<Application id: 11, Grafana>
+      DOC
+    end
+
+    # Create
+    def create(name, query = {})
+      client.request(:post, "features/#{name}", FeatureFlag, query)
+    end
+  end
+end

data/lib/labclient/feature_flags/delete.rb

@@ -0,0 +1,23 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class FeatureFlags < Common
+    doc 'Delete' do
+      title 'Delete a feature'
+      example 'client.feature_flags.delete(:name)'
+    end
+
+    doc 'Delete' do
+      desc 'Delete via FeatureFlag'
+      example <<~DOC
+        feature = client.feature_flags.list.first
+        feature.delete
+      DOC
+    end
+
+    # Delete
+    def delete(name)
+      client.request(:delete, "features/#{name}")
+    end
+  end
+end

data/lib/labclient/feature_flags/feature_flag.rb

@@ -0,0 +1,35 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class FeatureFlag < Klass
+    include ClassHelpers
+    def inspect
+      "#<FeatureFlag name: #{name}, state: #{state}>"
+    end
+
+    def delete
+      client.feature_flags.delete name
+    end
+
+    def update(query)
+      update_self client.feature_flags.create(name, query)
+    end
+
+    def toggle
+      if state == 'off'
+        update(value: true)
+      else
+        update(value: false)
+      end
+    end
+
+    date_time_attrs %i[created_at]
+
+    help do
+      subtitle 'Feature Flag'
+      option 'delete', 'Delete this specific feature flag'
+      option 'toggle', 'Disable / Turn on feature'
+      option 'update', 'Create flag / Update with values [Hash]'
+    end
+  end
+end

data/lib/labclient/feature_flags/list.rb

@@ -0,0 +1,49 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class FeatureFlags < Common
+    doc 'List' do
+      title 'List all features'
+      desc 'Get a list of all persisted features, with its gate values.'
+      example 'client.feature_flags.list'
+      result <<~DOC
+        =>  [#<Feature name: create_eks_clusters, state: on>]
+      DOC
+    end
+
+    doc 'List' do
+      title 'View detail of features'
+      desc 'Retrieve detailed information of feature flags'
+      example 'client.feature_flags.list.each(&:verbose)'
+      result <<~DOC
+        LabClient::Feature {
+                            :name => "create_eks_clusters",
+                            :state => "on",
+                            :gates => [
+                              [0] OpenStruct {
+                                    :key => "boolean",
+                                    :value => true
+                              }
+                            ]
+        }
+        => [#<Feature name: create_eks_clusters, state: on>]
+      DOC
+    end
+
+    doc 'List' do
+      title 'Toggle all features on or off'
+      example <<~DOC
+        client.feature_flags.list.each(&:toggle)
+      DOC
+      result <<~DOC
+        [#<Feature name: create_eks_clusters, state: off>,
+         #<Feature name: merge_train1, state: off>,
+         #<Feature name: merge_train2, state: off>]
+      DOC
+    end
+
+    def list
+      client.request(:get, 'features', FeatureFlag)
+    end
+  end
+end