labclient 0.3.5 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f545a5b4a6c1f514ab0f0b1273e45ed5ce0d2704813754474318ff1f53c84518
-  data.tar.gz: c48a0be6ac4664251cebfd472d5458cf756ec95a67a64357a051251156e066f8
+  metadata.gz: '038bb19b37338ea79eae25d376f49c470e3a3901e84d9f578e51da0ef78f9041'
+  data.tar.gz: 8b7893bbcefc7fa4cbecdf1e3f1b3a21d0298678bb9ae8ed30cc2df13eee2e3f
 SHA512:
-  metadata.gz: e4c133b2f5a580bfd9149eabe6bf10ce352618f2bc941d89fd1c5122acaff832d6de5e405976362c9a6419529fdba785c8810054731f510bb51bc491161d2e6f
-  data.tar.gz: '091f20375cae7e990df3038975a51aba2c734cab106645fced426e166a5f5913ba18d7940ffd569a70fe8c6dccf216a59a51ea7cf5835b54c8dded1af5302ac9'
+  metadata.gz: 17c52ea58baf3bda4bf70c9111000a823e9f0eac9fdc2cbece3be95c89162ed19b31e3ec39ce86ee504be590f600d9710afe1e0ce5efe11ef339f4fa9dec963e
+  data.tar.gz: f4b66628ef3916cc5d431d36196d9abb278435fc98fba7b90ff6720cc159d3599ff6f0d87c5152b1ba0cf0d252fe4a3052a5344b28bdf8d26d8e59845f0f9d19

data/lib/labclient.rb

@@ -5,8 +5,10 @@ require 'active_support/all'
 require 'amazing_print'
 require 'gitlab_chronic_duration'
 require 'ostruct'
+require 'ougai'
 
 require 'labclient/version'
+require 'labclient/logger'
 require 'labclient/docs'
 require 'labclient/curl'
 require 'labclient/http'
@@ -876,5 +878,8 @@ require 'labclient/generator/wizard'
 # Dynamically Require Templates (Simplify new template creation)
 Dir["#{File.dirname(__FILE__)}/labclient/generator/templates/*.rb"].sort.each { |file| require file }
 
-# I am Very Last
+# Load Client Files - I am Very Last!
+require 'labclient/client/setup'
+require 'labclient/client/helpers'
+require 'labclient/client/meta'
 require 'labclient/client'

data/lib/labclient/branches/branch.rb

@@ -22,7 +22,7 @@ module LabClient
       Timeout.timeout(total_time) do
         loop do
           reload
-          puts 'Waiting for Pipelines'
+          logger.info 'Waiting for Pipelines' unless quiet?
           break unless pipelines.empty?
 
           sleep sleep_time

data/lib/labclient/client.rb

@@ -1,104 +1,10 @@
 # Top Namespace
 module LabClient
   # API Specifics
-  # rubocop:disable Metrics/ClassLength
   class Client
-    # include HTTParty
-    attr_accessor :settings, :resp, :klass, :link, :http
-
-    def inspect
-      "#<LabClient::Client url: \"#{@settings[:url]}\">"
-    end
-
-    # Helper to make subclasses directly accessible
-    def subclasses
-      self.class.instance_variable_get(:@subclasses)
-    end
-
-    # ----------
-    # Alias List
-    # approvals == merge_request_approvals
-    # repo == repository
-    # ----------
-    @subclasses = {
-      appearance: Appearances,
-      application_settings: ApplicationSettings,
-      application_statistics: ApplicationStatistics,
-      applications: Applications,
-      approvals: Approvals,
-      audit_events: AuditEvents,
-      avatar: Avatars,
-      awards: Awards,
-      branches: Branches,
-      broadcast_messages: BroadcastMessages,
-      ci_lint: CiLint,
-      commits: Commits,
-      deploy_keys: DeployKeys,
-      discussions: Discussions,
-      epics: Epics,
-      events: Events,
-      feature_flags: FeatureFlags,
-      files: Files,
-      groups: Groups,
-      impersonation_tokens: ImpersonationTokens,
-      issues: Issues,
-      jobs: Jobs,
-      keys: Keys,
-      license: Licenses,
-      markdown: Markdown,
-      members: Members,
-      merge_request_approvals: Approvals,
-      merge_requests: MergeRequests,
-      namespaces: Namespaces,
-      notes: Notes,
-      notifications: Notifications,
-      pipelines: Pipelines,
-      project_runners: ProjectRunners,
-      projects: Projects,
-      protected_branches: ProtectedBranches,
-      protected_environments: ProtectedEnvironments,
-      protected_tags: ProtectedTags,
-      registry: Registry,
-      repo: Repositories,
-      repository: Repositories,
-      resource_labels: ResourceLabels,
-      runners: Runners,
-      snippets: Snippets,
-      system_hooks: SystemHooks,
-      tags: Tags,
-      todos: Todos,
-      users: Users,
-      version: Version,
-      wikis: Wikis,
-      wizard: Generator::Wizard
-    }
-
-    @subclasses.each do |name, obj|
-      define_method(name) do
-        obj.new(self)
-      end
-    end
-
-    def api_methods
-      subclasses.keys.sort
-    end
-
-    def help(help_filter = nil)
-      puts 'Available Methods'
-
-      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"
-
-      nil
-    end
+    include ClientHelpers
+    include ClientSetup
+    include Logger
 
     # Default setup, pull in settings
     def initialize(user_settings = nil)
@@ -114,88 +20,63 @@ module LabClient
       # Only prompt if explicitly set to nil
       prompt_for_token if @settings[:token].nil?
 
-      self.http = HTTP.new(@settings)
-    end
-
-    def base_url
-      "#{settings[:url]}/api/v4/"
-    end
+      # Initial Delay / Retry Value
+      self.delay = 0
+      self.retries = 0
 
-    def prompt_for_url
-      print 'Enter GitLab URL (e.g. https://gitlab.com): '
-      @settings[:url] = $stdin.gets.chomp
-      raise 'LabClient Error - Missing URL!' if @settings[:url].blank?
+      # Request Configuration
+      self.http = HTTP.new(@settings)
     end
 
-    def prompt_for_token
-      print 'Enter Personal Access Token: '
-      @settings[:token] = $stdin.gets.chomp
-    end
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    def request(method, path, klass = nil, body = {}, dump_json = true)
+      self.klass = klass
+      self.resp = http.request(method, path, body, dump_json)
+      self.path = path
 
-    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?
-      @settings[:token_type] = 'Private-Token' if @settings[:token_type].nil?
-    end
+      debug_handler if debug?
 
-    def home_file
-      "#{ENV['HOME']}/.gitlab-labclient"
-    end
+      post_request_handlers
 
-    # Easier Profile Name Access
-    def profile
-      if settings&.key? :profile
-        settings[:profile].to_sym
-      else
-        ENV['LABCLIENT_PROFILE'].to_sym
-      end
-    end
+      process resp
+    rescue LabClient::Error => e
+      logger.fatal('Request Failed', e.error_details) unless quiet?
+      resp
+    rescue LabClient::Retry
+      self.retries += 1
 
-    # Support for Named Profiles
-    def setup_profile
-      return false unless File.exist? home_file
+      # Assume Retry After by Default
+      logger.debug('Retry After', value: retry_after) if debug?
+      self.delay = retry_after if resp.headers.key? 'retry-after'
 
-      config = Oj.load_file(home_file, { symbol_keys: true })
-      return false unless config.key? profile
+      self.delay += delay_factor
+      logger.warn "Received #{resp.code}. Retry in #{delay}", limit: retry_max, retries: retries unless quiet?
 
-      self.settings ||= {}
-      settings.merge! config[profile]
-    end
+      sleep delay unless ENV['LABCLIENT_TESTING']
 
-    # Load default profile
-    def fill_configuration
-      if File.exist? home_file
-        Oj.load_file(home_file, { symbol_keys: true })
-      else
-        {
-          url: ENV['LABCLIENT_URL'],
-          token: ENV['LABCLIENT_TOKEN']
-        }
-      end
+      retry
     end
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
-    def request(method, path, klass = nil, body = {}, dump_json = true)
-      @klass = klass
-
-      resp = http.request(method, path, body, dump_json)
+    # Handling Details for after the request
+    # Debug,Retry, Instance Variables, Error Handling
+    def post_request_handlers
+      # Handle Retry Logic
+      raise LabClient::Retry if should_retry?
 
       # Save Client
-      resp.instance_variable_set(:@client, self)
+      save_client
+
+      # Exit on Max Retries
+      raise LabClient::Error.new(resp), resp.friendly_error if retry_max?
 
       raise LabClient::Error.new(resp), resp.friendly_error unless resp.success?
 
       # Drop in raw path
-      resp.instance_variable_set(:@path, path)
-
-      process resp
-    rescue LabClient::Error => e
-      puts e.message unless quiet?
-      resp
-    end
+      save_path
 
-    def quiet?
-      settings[:quiet]
+      # Reset Delay/Retry Factor
+      retry_update
     end
 
     # Assume we want LabStruct if @klass is ever nil
@@ -214,5 +95,4 @@ module LabClient
       end
     end
   end
-  # rubocop:enable Metrics/ClassLength
 end

data/lib/labclient/client/helpers.rb

@@ -0,0 +1,108 @@
+# Top Namespace
+module LabClient
+  # Reader Methods / Accessor Helpers
+  module ClientHelpers
+    def api_methods
+      subclasses.keys.sort
+    end
+
+    def help(help_filter = nil)
+      puts 'Available Methods'
+
+      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"
+
+      nil
+    end
+
+    def home_file
+      "#{ENV['HOME']}/.gitlab-labclient"
+    end
+
+    # Easier Profile Name Access
+    def profile
+      if settings&.key? :profile
+        settings[:profile].to_sym
+      else
+        ENV['LABCLIENT_PROFILE'].to_sym
+      end
+    end
+
+    # Instance Variable Helpers
+    def save_client
+      resp.instance_variable_set(:@client, self)
+    end
+
+    def save_path
+      resp.instance_variable_set(:@path, path)
+    end
+
+    def base_url
+      "#{settings[:url]}/api/v4/"
+    end
+
+    def quiet?
+      settings[:quiet]
+    end
+
+    def debug?
+      settings[:debug]
+    end
+
+    def delay_factor
+      settings[:retry][:delay_factor]
+    end
+
+    def retry_max
+      settings[:retry][:max]
+    end
+
+    # Maximum Retries
+    def retry_max?
+      retries >= retry_max
+    end
+
+    # On Successfully response lower delay
+    # Prevent multiple request / delays
+    def retry_update
+      self.delay = [delay - 1, 1].max
+      self.retries = [retries - 1, 0].max
+    end
+
+    # Debug Print Output
+    def debug_handler
+      options = resp.request.options
+
+      logger.debug(
+        options[:method].to_s.upcase,
+        code: resp.code,
+        path: path,
+        ssl_verify: options[:ssl_verifyhost],
+        message: resp.return_message,
+        klass: klass.to_s,
+        base_url: resp.request.base_url
+      )
+    end
+
+    # Helper for Accessing the Retry Headers
+    def retry_after
+      resp.headers['retry-after'].to_i || 0
+    end
+
+    # Handle Retry Logic
+    # 1. If response merits a retry
+    # 2. Retry is enabled
+    # 3. Retry Sleep Max isn't hit
+    def should_retry?
+      resp.retry? && settings[:retry] && !retry_max?
+    end
+  end
+end

data/lib/labclient/client/meta.rb

@@ -0,0 +1,81 @@
+# Top Namespace
+module LabClient
+  # Variables / Meta
+  class Client
+    # include HTTParty
+    attr_accessor :settings, :resp, :klass, :link, :http, :delay, :retries, :path
+
+    def inspect
+      "#<LabClient::Client url: \"#{@settings[:url]}\">"
+    end
+
+    # Helper to make subclasses directly accessible
+    def subclasses
+      self.class.instance_variable_get(:@subclasses)
+    end
+
+    # ----------
+    # Alias List
+    # approvals == merge_request_approvals
+    # repo == repository
+    # ----------
+    @subclasses = {
+      appearance: Appearances,
+      application_settings: ApplicationSettings,
+      application_statistics: ApplicationStatistics,
+      applications: Applications,
+      approvals: Approvals,
+      audit_events: AuditEvents,
+      avatar: Avatars,
+      awards: Awards,
+      branches: Branches,
+      broadcast_messages: BroadcastMessages,
+      ci_lint: CiLint,
+      commits: Commits,
+      deploy_keys: DeployKeys,
+      discussions: Discussions,
+      epics: Epics,
+      events: Events,
+      feature_flags: FeatureFlags,
+      files: Files,
+      groups: Groups,
+      impersonation_tokens: ImpersonationTokens,
+      issues: Issues,
+      jobs: Jobs,
+      keys: Keys,
+      license: Licenses,
+      markdown: Markdown,
+      members: Members,
+      merge_request_approvals: Approvals,
+      merge_requests: MergeRequests,
+      namespaces: Namespaces,
+      notes: Notes,
+      notifications: Notifications,
+      pipelines: Pipelines,
+      project_runners: ProjectRunners,
+      projects: Projects,
+      protected_branches: ProtectedBranches,
+      protected_environments: ProtectedEnvironments,
+      protected_tags: ProtectedTags,
+      registry: Registry,
+      repo: Repositories,
+      repository: Repositories,
+      resource_labels: ResourceLabels,
+      runners: Runners,
+      snippets: Snippets,
+      system_hooks: SystemHooks,
+      tags: Tags,
+      todos: Todos,
+      users: Users,
+      version: Version,
+      wikis: Wikis,
+      wizard: Generator::Wizard
+    }
+
+    @subclasses.each do |name, obj|
+      define_method(name) do
+        obj.new(self)
+      end
+    end
+  end
+end

data/lib/labclient/client/setup.rb

@@ -0,0 +1,52 @@
+# Top Namespace
+module LabClient
+  # Methods for Initialization
+  module ClientSetup
+    # Load default profile
+    def fill_configuration
+      if File.exist? home_file
+        Oj.load_file(home_file, { symbol_keys: true })
+      else
+        {
+          url: ENV['LABCLIENT_URL'],
+          token: ENV['LABCLIENT_TOKEN']
+        }
+      end
+    end
+
+    # If nothing entered Prompt for Input
+    def prompt_for_url
+      print 'Enter GitLab URL (e.g. https://gitlab.com): '
+      @settings[:url] = $stdin.gets.chomp
+      raise 'LabClient Error - Missing URL!' if @settings[:url].blank?
+    end
+
+    # Check for Token
+    def prompt_for_token
+      print 'Enter Personal Access Token: '
+      @settings[:token] = $stdin.gets.chomp
+    end
+
+    # Fill Defaults
+    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?
+      @settings[:debug] = false if @settings[:quiet].nil?
+      @settings[:debug] = false if @settings[:debug].nil?
+      @settings[:token_type] = 'Private-Token' if @settings[:token_type].nil?
+      @settings[:retry] = { max: 5, delay_factor: 1, count: 0 } if @settings[:retry].nil?
+    end
+
+    # Support for Named Profiles
+    def setup_profile
+      return false unless File.exist? home_file
+
+      config = Oj.load_file(home_file, { symbol_keys: true })
+      return false unless config.key? profile
+
+      self.settings ||= {}
+      settings.merge! config[profile]
+    end
+  end
+end

data/lib/labclient/common.rb

@@ -47,8 +47,13 @@ module LabClient
     end
 
     # Category and Primary Key for docs
+    # If/Else for Instance Variable Warnings
     def group_name
-      self.class.instance_variable_get('@group_name') || klass
+      if self.class.instance_variable_defined? '@group_name'
+        self.class.instance_variable_get('@group_name')
+      else
+        klass
+      end
     end
 
     def inspect
@@ -70,7 +75,7 @@ module LabClient
       return nil if obj_id.nil?
 
       # Already a Integer
-      return obj_id if obj_id.class == Integer
+      return obj_id if obj_id.instance_of?(Integer)
 
       # If LabClient Object, send ID
       return obj_id.id if obj_id.class.module_parent_name == 'LabClient'
@@ -107,7 +112,7 @@ module LabClient
     # :developer => 30
     # :owner => 50
     def query_access_level(query, key = :group_access)
-      query[key] = machine_access_level query[key] if query.key?(key) && query[key].class == Symbol
+      query[key] = machine_access_level query[key] if query.key?(key) && query[key].instance_of?(Symbol)
     end
 
     # TODO: See if these are even needed
@@ -118,7 +123,7 @@ module LabClient
     # 40 => Maintainer access
     # 60 => Admin access
     def protected_query_access_level(query, key = :push_access_level)
-      query[key] = machine_protected_access_level query[key] if query.key?(key) && query[key].class == Symbol
+      query[key] = machine_protected_access_level query[key] if query.key?(key) && query[key].instance_of?(Symbol)
     end
   end
 end

data/lib/labclient/docs.rb

@@ -72,8 +72,13 @@ module LabClient
     end
 
     # Allow for Custom Group Name Overrides
+    # Ruby warning of uninitialized variables
     def group_name
-      @group_name || name.split('::', 2).last.split(/(?=[A-Z])/).join(' ')
+      if defined? @group_name
+        @group_name
+      else
+        name.split('::', 2).last.split(/(?=[A-Z])/).join(' ')
+      end
     end
 
     # Helper to Make navigation rendered out once rather than evaluated on Ember

data/lib/labclient/epics/issues/remove.rb

@@ -29,7 +29,7 @@ module LabClient
       epic_id = format_id(epic_id)
 
       # This is horrible, but has to be the epic_issue_id, not the issue's id or iid
-      epic_issue_id = epic_issue_id.epic_issue_id if epic_issue_id.class == Issue
+      epic_issue_id = epic_issue_id.epic_issue_id if epic_issue_id.instance_of?(Issue)
 
       client.request(:delete, "groups/#{group_id}/epics/#{epic_id}/issues/#{epic_issue_id}")
     end

data/lib/labclient/epics/issues/update.rb

@@ -36,7 +36,7 @@ module LabClient
       epic_id = format_id(epic_id)
 
       # This is horrible, but has to be the epic_issue_id, not the issue's id or iid
-      epic_issue_id = epic_issue_id.epic_issue_id if epic_issue_id.class == Issue
+      epic_issue_id = epic_issue_id.epic_issue_id if epic_issue_id.instance_of?(Issue)
 
       client.request(:put, "groups/#{group_id}/epics/#{epic_id}/issues/#{epic_issue_id}", nil, query)
     end

data/lib/labclient/error.rb

@@ -8,5 +8,14 @@ module LabClient
       super
       @resp = resp
     end
+
+    # Helper for Raising Exceptions
+    def error_details
+      { code: resp.code, message: resp.find_friendly_error }
+    end
+  end
+
+  # Class Shim
+  class Retry < StandardError
   end
 end

data/lib/labclient/generator/template_helper.rb

@@ -16,6 +16,7 @@ module LabClient
     # Common Helper Class
     class TemplateHelper
       include TemplateMethods
+      include LabClient::Logger
 
       attr_reader :client
       attr_accessor :opts
@@ -46,16 +47,16 @@ module LabClient
       attr_accessor :group_name, :group_path, :group_suffix, :project_name
 
       def run!
-        puts "Running: #{group_suffix}"
+        logger.info "Running: #{group_suffix}"
         generate_group
 
         # Run `setup_` prefixed classes
         self.class.instance_methods.grep(/setup_/).each { |x| send(x) }
 
         # Print Created Groups/Project
-        puts "#{@group.name} - #{@group.web_url}"
+        logger.info 'Group', name: @group.name, web_url: @group.web_url
         @projects.each do |project|
-          puts " - #{project.name} - #{project.web_url}"
+          logger.info 'Project', name: project.name, web_url: project.web_url
         end
 
         {

data/lib/labclient/generator/wizard.rb

@@ -4,6 +4,7 @@ module LabClient
     # Helper to Generate Data / Populate GitLab
     class Wizard
       include Generator::Names # Name Generator
+      include LabClient::Logger
       attr_reader :client
       attr_accessor :count, :random, :password, :templates, :domain, :skip_confirmation
 
@@ -26,7 +27,7 @@ module LabClient
         self.random = true # Populate Random or use only Templates
         self.count = default_count
         self.password = SecureRandom.uuid
-        puts "Default Password: #{password}" unless client.quiet?
+        logger.info('Wizard Default Password', password: password) unless client.quiet?
 
         self.skip_confirmation = true
         self.domain = URI.parse(client.settings[:url]).hostname
@@ -54,11 +55,11 @@ module LabClient
       end
 
       def generate_users
-        puts 'Generating Users' unless client.quiet?
+        logger.info 'Generating Users' unless client.quiet?
         @users = @user_names.map do |name|
           username = name.downcase.gsub(/[^0-9A-Za-z]/, '')
           email = "#{username}@#{domain}"
-          puts "User -- Name: #{name}, UserName: #{username}, Email: #{email}" unless client.quiet?
+          logger.info('User', name: name, username: username, email: email) unless client.quiet?
 
           client.users.create(
             name: name,
@@ -71,41 +72,39 @@ module LabClient
       end
 
       def generate_groups
-        puts 'Generating Groups' unless client.quiet?
+        logger.info 'Generating Groups' unless client.quiet?
         @groups = @group_names.map do |name|
           path = name.downcase.gsub(/[^0-9A-Za-z]/, '')
-          puts "Group -- #{name}/#{path}" unless client.quiet?
+          logger.info "Group -- #{name}/#{path}" unless client.quiet?
           client.groups.create(name: name, path: path)
         end
       end
 
-      # rubocop:disable Metrics/AbcSize
       def generate_group_membership
-        puts 'Adding Group members' unless client.quiet?
+        logger.info 'Adding Group members' unless client.quiet?
         ## Group Access Level
         @groups.each do |group|
           @users.sample(rand(1..@users.count)).each do |user|
             level = group.valid_group_project_levels.sample
-            puts "Group Add: #{group.name}: #{user.name} - #{level}" unless client.quiet?
+            logger.info('Group Add', name: group.name, user: user.name, level: level) unless client.quiet?
             group.member_add(user, access_level: level)
             # :nocov:
           rescue StandardError => e
-            puts e.message unless client.quiet?
+            logger.fatal e.message unless client.quiet?
             next
             # :nocov:
           end
         end
       end
-      # rubocop:enable Metrics/AbcSize
 
       def generate_projects(group)
-        puts 'Generating Projects' unless client.quiet?
+        logger.info 'Generating Projects' unless client.quiet?
         # Collect Group Members
         members = group.members
 
         # Loop through project names, create project add issues
         @project_names.uniq.map do |project_name|
-          puts "Project: #{project_name}" unless client.quiet?
+          logger.info "Project: #{project_name}" unless client.quiet?
           project = group.project_create(name: project_name, description: gen_description)
 
           rand(count[:issues]).times do

data/lib/labclient/groups/group.rb

@@ -1,4 +1,3 @@
-# rubocop:disable Metrics/ClassLength
 # Top namespace
 module LabClient
   # Inspect Helper
@@ -344,4 +343,3 @@ module LabClient
     # rubocop:enable Metrics/BlockLength
   end
 end
-# rubocop:enable Metrics/ClassLength

data/lib/labclient/groups/search.rb

@@ -70,20 +70,16 @@ module LabClient
 
     private
 
-    # rubocop:disable Metrics/CyclomaticComplexity
-    # TODO - Finish Classes
+    # TODO: - Finish Classes
     def klass_type(scope)
       case scope
       when :projects then Project
       when :issues then Issue
       when :merge_requests then MergeRequest
-      when :wiki_blobs then nil # wiki_blobs
-      when :milestones then nil # ::Project::MileStone
-      when :blobs then nil # blobs
+      when :milestones, :wiki_blobs, :blobs then nil
       when :commits then Commit
       when :users then User
       end
     end
-    # rubocop:enable Metrics/CyclomaticComplexity
   end
 end

data/lib/labclient/groups/stub.rb

@@ -3,6 +3,7 @@ module LabClient
   # Ugly Hack, but Makes Docs Easy
   class Groups < Common
     doc '' do
+      # Do Nothing!
     end
   end
 end

data/lib/labclient/http.rb

@@ -72,9 +72,9 @@ module Typhoeus
     attr_reader :path, :client
 
     def data
-      return @data if @data
+      @data ||= process_body
 
-      @data = process_body
+      @data
     end
 
     # Shim for CurlHelper
@@ -94,13 +94,31 @@ module Typhoeus
       end
     end
 
+    # Retry Helper Accessor
+    def retry?
+      code == 429
+    end
+
+    # Print Error information
+    # 1. Use Typheous `return_message` if there isn't any return body
+    # For network/uri/dns related issues
+    # 2. Use body for parsed responses
+    # For Bad Request, invalid params
+    # 3. Return raw data
+    # For non body responses
+    def find_friendly_error
+      case data
+      when nil
+        return_message
+      when LabClient::LabStruct
+        data[:message] || data[:error]
+      else # Handle String as well
+        data
+      end
+    end
+
     def friendly_error
-      message = if data
-                  data[:message] || data[:error] || data
-                else
-                  return_message
-                end
-      "#{code} - #{message}"
+      "#{code} - #{find_friendly_error}"
     end
   end
 end

data/lib/labclient/issues/issue.rb

@@ -12,7 +12,7 @@ module LabClient
     date_time_attrs %i[closed_at created_at updated_at]
 
     # User Fields
-    user_attrs %i[closed_by author assignee]
+    user_attrs %i[author assignee]
 
     # Via State Events
     def close

data/lib/labclient/klass.rb

@@ -2,6 +2,7 @@
 module LabClient
   # Common Configuration for all Class Helpers
   class Klass < LabStruct
+    include LabClient::Logger
     include CurlHelper
 
     attr_reader :client, :response
@@ -15,7 +16,6 @@ module LabClient
 
     # API Methods here have to be explicitly documented / custom helpers
     # Assume no methods by default
-    # rubocop:disable Metrics/AbcSize
     def help(help_filter = nil)
       docs = LabClient::Docs.docs.dig(group_name, 'Reference')
       unless docs
@@ -38,7 +38,6 @@ module LabClient
       # Ignore Output
       nil
     end
-    # rubocop:enable Metrics/AbcSize
 
     # Documented API Methods
     def api_methods
@@ -101,6 +100,11 @@ module LabClient
       self
     end
 
+    # Quiet Reader Helper
+    def quiet?
+      client.quiet?
+    end
+
     # rubocop:disable Lint/MissingSuper
     def initialize(hash = nil, response = nil, client = nil)
       @client = client

data/lib/labclient/logger.rb

@@ -0,0 +1,50 @@
+# Top Namespace
+module LabClient
+  # Helper to Unify Log Output
+  module Logger
+    def logger
+      LabClient::Logger.logger
+    end
+
+    def self.logger_setup
+      logger = Ougai::Logger.new($stdout)
+      logger.formatter = Ougai::Formatters::LabClient.new
+
+      logger
+    end
+
+    def self.logger
+      @logger ||= logger_setup
+    end
+  end
+end
+
+# Log Formatter for Readable Inline (Timestamp)
+# https://github.com/eropple/ougai-formatters-inline_readable/blob/master/lib/ougai/formatters/inline_readable.rb
+module Ougai
+  module Formatters
+    # LabClient Specific
+    class LabClient < Ougai::Formatters::Readable
+      # For Amazing Print
+      def ai_settings
+        { ruby19_syntax: true, multiline: false }
+      end
+
+      def time_format
+        '%Y-%m-%e %k:%M:%S %z'
+      end
+
+      def call(severity, time, _progname, data)
+        msg = data.delete(:msg)
+        @excluded_fields.each { |f| data.delete(f) }
+
+        level = @plain ? severity : colored_level(severity)
+        output = "[#{time.strftime(time_format)}] #{level}: #{msg}"
+
+        output += " #{data.ai(ai_settings)}" unless data.empty?
+
+        "#{output}\n"
+      end
+    end
+  end
+end

data/lib/labclient/merge_requests/merge_request.rb

@@ -1,7 +1,6 @@
 # Top namespace
 module LabClient
   # Inspect Helper
-  # rubocop:disable Metrics/ClassLength
   class MergeRequest < Klass
     include ClassHelpers
     # extend Docs
@@ -193,7 +192,7 @@ module LabClient
       Timeout.timeout(total_time) do
         loop do
           reload
-          puts "Waiting for Merge Status: #{merge_status}"
+          logger.info "Waiting for Merge Status: #{merge_status}" unless quiet?
           break if %w[can_be_merged unchecked].include? merge_status
           raise "Cannot be merged! #{import_error}" if %w[cannot_be_merged cannot_be_merged_recheck].include? merge_status
 
@@ -252,5 +251,4 @@ module LabClient
 
     # rubocop:enable Metrics/BlockLength
   end
-  # rubocop:enable Metrics/ClassLength
 end

data/lib/labclient/overview.rb

@@ -1,5 +1,4 @@
 # The glorious gitlab labclient of labs
-# rubocop:disable Metrics/ClassLength
 module LabClient
   # Helper for Docs
   class Overview
@@ -362,6 +361,30 @@ module LabClient
       DOC
     end
 
+    doc 'Other' do
+      title 'Retry'
+      markdown <<~DOC
+        Gitlab.com and other instances may have protected paths or rate limiting enabled. By default the LabClient will:
+
+        1. Check if a `Retry Later` request was received (Return Code 429)
+        2. Wait for combined `retry-after` and `delay_factor` value
+        3. Retry until retries `max` is reached
+      DOC
+
+      example <<~DOC
+        client = LabClient::Client.new(
+          url: 'https://gitlab.labclient',
+          token: 'gitlab api token',
+          retry: {
+            max: 3, delay_factor: 2
+          }
+        )
+
+        # Or after the init
+        @client.settings[:retry] = { max: 3, delay_factor: 2 }
+      DOC
+    end
+
     doc 'Other' do
       title 'Quiet'
       desc 'Error messages by default are printed to STDOUT. This can be supressed via the :quiet setting'
@@ -378,6 +401,22 @@ module LabClient
       DOC
     end
 
+    doc 'Other' do
+      title 'Debug'
+      desc 'Print Request Information'
+
+      example <<~DOC
+        client = LabClient::Client.new(
+          url: 'https://gitlab.labclient',
+          token: 'gitlab api token',
+          debug: true
+        )
+
+        # Or after the init
+        client.settings[:debug] = true
+      DOC
+    end
+
     doc 'Other' do
       title 'Curl'
       desc 'Sometimes you just wana have a curl example to test or send someone'
@@ -428,4 +467,3 @@ module LabClient
     end
   end
 end
-# rubocop:enable Metrics/ClassLength

data/lib/labclient/paginated_response.rb

@@ -40,9 +40,7 @@ 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/pipelines/pipeline.rb

@@ -63,7 +63,7 @@ module LabClient
       Timeout.timeout(total_time) do
         loop do
           reload
-          puts "Waiting for Pipeline: #{status}"
+          logger.info('Waiting for Pipeline', status: status) unless quiet?
           break if %w[skipped manual canceled success].include? status
           raise 'Pipeline failed' if status == 'failed'
 

data/lib/labclient/projects/methods.rb

@@ -748,7 +748,7 @@ module LabClient
       Timeout.timeout(total_time) do
         loop do
           reload
-          puts "Waiting for Import Status: #{import_status}"
+          logger.info('Waiting for Import Status', status: import_status) unless quiet?
           break if %w[none finished].include? import_status
           raise "Import Failed: #{import_error}" if import_status == 'failed'
 

data/lib/labclient/projects/reference.rb

@@ -1,6 +1,6 @@
 # Top namespace
 module LabClient
-  # rubocop:disable Metrics/BlockLength, Metrics/ClassLength
+  # rubocop:disable Metrics/BlockLength
   # Help Do Block
   class Project < Klass
     help do
@@ -268,5 +268,5 @@ module LabClient
       option 'parent', 'Show (API Call) Project Parent, returns either Group or User'
     end
   end
-  # rubocop:enable Metrics/BlockLength, Metrics/ClassLength
+  # rubocop:enable Metrics/BlockLength
 end

data/lib/labclient/projects/search.rb

@@ -72,20 +72,16 @@ module LabClient
 
     private
 
-    # rubocop:disable Metrics/CyclomaticComplexity
-    # TODO - Finish Classes
+    # TODO: - Finish Classes
     def klass_type(scope)
       case scope
       when :issues then Issue
       when :merge_requests then MergeRequest
       when :notes then Note
-      when :wiki_blobs then nil # wiki_blobs
-      when :milestones then nil # ::Project::MileStone
-      when :blobs then nil # blobs
+      when :wiki_blobs, :milestones, :blobs then nil
       when :commits then Commit
       when :users then User
       end
     end
-    # rubocop:enable Metrics/CyclomaticComplexity
   end
 end

data/lib/labclient/version.rb

@@ -1,3 +1,3 @@
 module LabClient
-  VERSION = '0.3.5'.freeze
+  VERSION = '0.4.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: labclient
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.4.0
 platform: ruby
 authors:
 - Davin Walker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-04 00:00:00.000000000 Z
+date: 2021-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: ougai
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: typhoeus
   requirement: !ruby/object:Gem::Requirement
@@ -100,42 +114,42 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: faker
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.12'
+        version: '2.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.12'
+        version: '2.16'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.13'
+        version: '5.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.13'
+        version: '5.14'
 - !ruby/object:Gem::Dependency
   name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
@@ -184,14 +198,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -210,30 +224,58 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.91.0
+        version: '1.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.91.0
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '0.21'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '0.21'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -323,6 +365,9 @@ files:
 - lib/labclient/ci_lint/ci_lint.rb
 - lib/labclient/class_helpers.rb
 - lib/labclient/client.rb
+- lib/labclient/client/helpers.rb
+- lib/labclient/client/meta.rb
+- lib/labclient/client/setup.rb
 - lib/labclient/commits/cherry_pick.rb
 - lib/labclient/commits/comment_create.rb
 - lib/labclient/commits/comments.rb
@@ -528,6 +573,7 @@ files:
 - lib/labclient/license/delete.rb
 - lib/labclient/license/license.rb
 - lib/labclient/license/list.rb
+- lib/labclient/logger.rb
 - lib/labclient/markdown/markdown.rb
 - lib/labclient/members/groups/add.rb
 - lib/labclient/members/groups/delete.rb