labclient 0.3.2 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: afae2688a4bc4ee88d958081de2aa6a0f836023de31f0893b0027c95d4b25ac3
-  data.tar.gz: b89c9b5de0143fdcb4efe0ca599d3c585f0166a5d43b56f379a78680e45fb459
+  metadata.gz: 2d1d2daf2bc113e0a5e74d3b2888dc20278bb18e5aab063a21919f9ab7ef4ca9
+  data.tar.gz: 40f0b1e58ba394663e4ab90f1ac9fd6e4734e718d6f1aac9f1394bc7c067afd3
 SHA512:
-  metadata.gz: d35822a7a216bc2b35be35480c22a2c2a887218f36b6ff719fefd94d953c1711c3c190005e601d4d9380385c16e65ea632737076ef00767be7a66b0f5a035abb
-  data.tar.gz: ca0b0b31a2ab8669c2413468a942d4c24170a41fbdaa76e9cfbb7d13f5fea7f3341fd55e2d007e02e37a851a2981a7af34e33ead97762a9d3682d6bba9a1a3d3
+  metadata.gz: 9d6e0a96ecd9eba62f3a38c89b621b6379cb1e63bb67a212acc7333dc0dc3ae6d3b58011bdbbb8b2b13c08959d144540e46698112dd1d91a6c613208abe541f3
+  data.tar.gz: 317e9e1290ccad1878af5f838842ab893879ed2306fcbcf0509ba9fa4372717a94b98ba37f038db86b01945dc7d2a95b18d8f158b1db64fc6884aa310bd14001

data/lib/labclient.rb

@@ -5,13 +5,15 @@ 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'
 require 'labclient/access_levels'
 require 'labclient/common'
-require 'labclient/curl'
 require 'labclient/lab_struct'
 require 'labclient/klass'
 require 'labclient/class_helpers'
@@ -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,81 +20,63 @@ module LabClient
       # Only prompt if explicitly set to nil
       prompt_for_token if @settings[:token].nil?
 
+      # Initial Delay / Retry Value
+      self.delay = 0
+      self.retries = 0
+
+      # Request Configuration
       self.http = HTTP.new(@settings)
     end
 
-    def base_url
-      "#{settings[:url]}/api/v4/"
-    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_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
+      debug_handler if debug?
 
-    def prompt_for_token
-      print 'Enter Personal Access Token: '
-      @settings[:token] = $stdin.gets.chomp
-    end
+      post_request_handlers
 
-    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
+      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_header: retry_header) 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
+
+      # Reset Delay/Retry Factor
+      retry_update if resp.success?
 
-      resp = http.request(method, path, body, dump_json)
+      # 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 settings[:quiet]
-      resp
+      save_path
     end
 
     # Assume we want LabStruct if @klass is ever nil
@@ -207,5 +95,4 @@ module LabClient
       end
     end
   end
-  # rubocop:enable Metrics/ClassLength
 end

data/lib/labclient/client/helpers.rb

@@ -0,0 +1,112 @@
+# 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
+
+    # 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