labclient 0.1.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6891782100fb734939767870fa735c9a0f34127582767b4b67c47bdad1f64646
-  data.tar.gz: 503518a6a45eba73b86bf44c8997d969cd78396210943753c59e330fe06b3be4
+  metadata.gz: 8a76c9e9a1408f2c357f82a955359b36b16341f2c83cdd4d3224a90fea884acf
+  data.tar.gz: 8348d2cf615d5b3911ce71f77f71830ba5020015a02d43e4bac6c572105131be
 SHA512:
-  metadata.gz: b8f5c439041953cf54681ead1caddc945e913d397cfb3b5b12d3abe81415bcebe0878c5cf13f4c541c1bc7481035d490144d429ac0e37adb82f02da21199f906
-  data.tar.gz: d160894003a7d1e48fbc952a6f3e8c27de913816162938b4b77bb67114e3294e04ce46ef866e08ca0696e6cbbb4f2762d7f811cee6721f6b8c4c447fc22e6c85
+  metadata.gz: 1072af5523d2a6773e329d6674a35f3122eadc488b0961b90b38e9c7b79b5f6cfe516909b16a54f3ad39e227c0a920462cc2b0353b9bd95dbd1e4ce216c8b15b
+  data.tar.gz: e4917da6a4d9d202604fc11b54d6d36f0ec675b2faef38ebbcf9529d9cfb56d883d64508b538dcf3cfb7d8c0c82434ad33fc5a7d3570a2bc7ecc961e64946191

data/lib/labclient.rb

@@ -1,6 +1,5 @@
 # Public Gems
 require 'oj'
-require 'pry'
 require 'typhoeus'
 require 'active_support/all'
 require 'amazing_print'
@@ -860,7 +859,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

@@ -111,22 +111,23 @@ module LabClient
 
     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 +174,7 @@ module LabClient
 
       process resp
     rescue LabClient::Error => e
-      puts e.message
+      puts e.message unless settings[:quiet]
       resp
     end
 

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
 
@@ -85,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/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/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)

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

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

data/lib/labclient/klass.rb

@@ -31,7 +31,7 @@ module LabClient
             next unless (opt[:name] + opt[:text]).include? help_filter.to_s
           end
 
-          puts '  ' + opt[:name]
+          puts "  #{opt[:name]}"
           puts "    #{opt[:text]}\n"
         end
       end
@@ -97,6 +97,7 @@ module LabClient
       self
     end
 
+    # rubocop:disable Lint/MissingSuper
     def initialize(hash = nil, response = nil, client = nil)
       @client = client
       @response = response
@@ -107,6 +108,7 @@ module LabClient
         @table[k] = v
       end
     end
+    # rubocop:enable Lint/MissingSuper
 
     # Forward response success
     def success?

data/lib/labclient/overview.rb

@@ -291,6 +291,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/version.rb

@@ -1,3 +1,3 @@
 module LabClient
-  VERSION = '0.1.5'.freeze
+  VERSION = '0.2.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: labclient
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.0
 platform: ruby
 authors:
 - Davin Walker
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-14 00:00:00.000000000 Z
+date: 2020-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport