labclient 0.3.5 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f545a5b4a6c1f514ab0f0b1273e45ed5ce0d2704813754474318ff1f53c84518
-  data.tar.gz: c48a0be6ac4664251cebfd472d5458cf756ec95a67a64357a051251156e066f8
+  metadata.gz: 5a516961c1eaeef85e9ee1d1de52980e03aae212122fd8d1bc49a05e9d4328ac
+  data.tar.gz: 384c408eb1320f1d31e661fe153edaacad187f02a6971775d7b1afd918eaf88c
 SHA512:
-  metadata.gz: e4c133b2f5a580bfd9149eabe6bf10ce352618f2bc941d89fd1c5122acaff832d6de5e405976362c9a6419529fdba785c8810054731f510bb51bc491161d2e6f
-  data.tar.gz: '091f20375cae7e990df3038975a51aba2c734cab106645fced426e166a5f5913ba18d7940ffd569a70fe8c6dccf216a59a51ea7cf5835b54c8dded1af5302ac9'
+  metadata.gz: e3b2453fa6d325e570360ca1b956261e5841901c528d8df3af44b28db7bf20081b0bd49c490e58c71055524b1ceff090ba63fb8205d6f379f0547161bfd80aec
+  data.tar.gz: 942ce7e24982e01141d664b0f4038dd4f8207ccb9f849cd74a058125aecf672c51af03e198f9e2ce7dd7f9bd35976f7e9a35fe1fe7b088240a636edd376d6d6c

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

@@ -0,0 +1,116 @@
+# 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
+      retry_header || delay_factor || 1
+    end
+
+    def retry_header
+      resp.headers['retry-after']&.to_i
+    end
+
+    def retry_debug_headers
+      resp.headers.select { |k, _v| k.include? 'ratelimit' }
+    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,53 @@
+# 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] = ENV['LABCLIENT_TESTING'] ? 'testu' : $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] = ENV['LABCLIENT_TESTING'] ? 'testt' : $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: 10, 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/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,62 @@ module LabClient
       # Only prompt if explicitly set to nil
       prompt_for_token if @settings[:token].nil?
 
-      self.http = HTTP.new(@settings)
-    end
+      # Initial Delay / Retry Value
+      self.delay = 0
+      self.retries = 0
 
-    def base_url
-      "#{settings[:url]}/api/v4/"
+      # Request Configuration
+      self.http = HTTP.new(@settings)
     end
 
-    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
+    # 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 prompt_for_token
-      print 'Enter Personal Access Token: '
-      @settings[:token] = $stdin.gets.chomp
-    end
+      debug_handler if debug?
 
-    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
-
-    def home_file
-      "#{ENV['HOME']}/.gitlab-labclient"
-    end
+      post_request_handlers
+      process resp
+    rescue LabClient::Error => e
+      logger.fatal('Request Failed', e.error_details) unless quiet?
+      resp
+    rescue LabClient::Retry
+      self.retries += 1
 
-    # Easier Profile Name Access
-    def profile
-      if settings&.key? :profile
-        settings[:profile].to_sym
-      else
-        ENV['LABCLIENT_PROFILE'].to_sym
-      end
-    end
+      # Assume Retry After by Default
+      logger.debug('Retry After', value: retry_after, retry_debug_headers: retry_debug_headers) if debug?
+      self.delay = retry_after if resp.headers.key? 'retry-after'
 
-    # Support for Named Profiles
-    def setup_profile
-      return false unless File.exist? home_file
+      self.delay += delay_factor
+      logger.warn "Received #{resp.code}. Retry in #{delay}", limit: retry_max, retries: retries unless quiet?
 
-      config = Oj.load_file(home_file, { symbol_keys: true })
-      return false unless config.key? profile
+      sleep delay unless ENV['LABCLIENT_TESTING']
 
-      self.settings ||= {}
-      settings.merge! config[profile]
+      retry
     end
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
-    # 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
+    # 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?
 
-    def request(method, path, klass = nil, body = {}, dump_json = true)
-      @klass = klass
+      # Save Client
+      save_client
 
-      resp = http.request(method, path, body, dump_json)
+      # Reset Delay/Retry Factor
+      retry_update if resp.success?
 
-      # Save Client
-      resp.instance_variable_set(:@client, self)
+      # 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
-
-    def quiet?
-      settings[:quiet]
+      save_path
     end
 
     # Assume we want LabStruct if @klass is ever nil
@@ -214,5 +94,4 @@ module LabClient
       end
     end
   end
-  # rubocop:enable Metrics/ClassLength
 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/feature_flags/list.rb

@@ -20,7 +20,7 @@ module LabClient
                             :name => "create_eks_clusters",
                             :state => "on",
                             :gates => [
-                              [0] OpenStruct {
+                              [0] LabStruct {
                                     :key => "boolean",
                                     :value => true
                               }

data/lib/labclient/files/show.rb

@@ -3,11 +3,11 @@ module LabClient
   # Specifics
   class Files < Common
     doc 'Show' do
-      desc 'Allows you to receive information about file in repository like name, size, content [Project ID, File Path, Ref (master default), kind]'
+      desc 'Allows you to receive information about file in repository like name, size, content [Project ID, File Path, Ref (main default), kind]'
       example 'client.files.show(264, "README.md")'
 
       markdown <<~DOC
-        Ref will default to `master`
+        Ref will default to `main`
 
         Kind can be left empty or set to either :raw or :blame
       DOC
@@ -15,12 +15,12 @@ module LabClient
 
     doc 'Show' do
       desc 'Raw Content'
-      example 'client.files.show(264, "README.md", :master, :raw)'
+      example 'client.files.show(264, "README.md", :main, :raw)'
     end
 
     doc 'Show' do
       desc 'Blame'
-      example 'client.files.show(264, "README.md", :master, :blame)'
+      example 'client.files.show(264, "README.md", :main, :blame)'
     end
 
     doc 'Show' do
@@ -31,7 +31,7 @@ module LabClient
       DOC
     end
 
-    def show(project_id, file_path, ref = :master, kind = nil)
+    def show(project_id, file_path, ref = :main, kind = nil)
       kind = case kind
              when :raw
                '/raw'

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
 
         {