labclient 0.3.5 → 0.5.1

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
@@ -88,19 +88,37 @@ module Typhoeus
       elsif headers['content-type']&.include? 'text/plain'
         body
       else
-        result = Oj.load(body, mode: :compat, object_class: LabClient::LabStruct)
+        result = Oj.load(body, mode: :compat, symbol_keys: true, object_class: LabClient::LabStruct)
         result.instance_variable_set(:@response, self) if result.instance_of?(LabClient::LabStruct)
         result
       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,9 +2,10 @@
 module LabClient
   # Common Configuration for all Class Helpers
   class Klass < LabStruct
+    include LabClient::Logger
     include CurlHelper
 
-    attr_reader :client, :response
+    attr_reader :client
 
     extend Docs
 
@@ -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,18 +100,18 @@ module LabClient
       self
     end
 
-    # rubocop:disable Lint/MissingSuper
-    def initialize(hash = nil, response = nil, client = nil)
+    # Quiet Reader Helper
+    def quiet?
+      client.quiet?
+    end
+
+    def initialize(table = nil, response = nil, client = nil)
+      # @table = table unless table.nil?
       @client = client
       @response = response
 
-      @table = {}
-      hash&.each_pair do |k, v|
-        k = k.to_sym
-        @table[k] = v
-      end
+      super(table)
     end
-    # rubocop:enable Lint/MissingSuper
 
     # Forward response success
     def success?

data/lib/labclient/lab_struct.rb

@@ -1,16 +1,28 @@
-# Extensions for OpenStruct specific to LabClient
+# Extensions for LabStruct specific to LabClient
 module LabClient
-  # Unique inherited class to not override top level openstruct
-  class LabStruct < OpenStruct
+  # Unique inherited class to not override top level LabStruct
+  class LabStruct
     include CurlHelper
-    attr_reader :response
+    attr_reader :response, :table
+
+    def initialize(hash = {})
+      @table = if hash.instance_of?(LabClient::LabStruct)
+                 hash.to_h
+               else
+                 hash
+               end
+    end
+
+    def to_h
+      @table
+    end
 
     def keys
-      to_h.keys.sort
+      @table.keys.sort
     end
 
     def inspect
-      to_h.inspect
+      @table.inspect
     end
 
     def as_json(*args)
@@ -18,7 +30,7 @@ module LabClient
     end
 
     def slice(*opts)
-      to_h.slice(*opts)
+      @table.slice(*opts)
     end
 
     def client
@@ -29,5 +41,25 @@ module LabClient
     def success?
       @response.success?
     end
+
+    def method_missing(method, *_args)
+      @table[method] if @table.keys.include?(method)
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      @table.keys.include?(method_name) || super
+    end
+
+    def key?(idx)
+      @table.key? idx
+    end
+
+    def []=(name, value)
+      @table[name] = value
+    end
+
+    def [](name)
+      @table[name.to_sym]
+    end
   end
 end

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

@@ -13,13 +13,21 @@ module LabClient
     end
 
     doc 'Delete' do
-      desc 'Delete through MergeRequest'
+      desc 'Delete via MergeRequest'
       example <<~DOC
-        mr = client.merge_requests.show(343,2)
+        mr = client.merge_requests.delete(343,2)
         mr.delete
       DOC
     end
 
+    doc 'Delete' do
+      desc 'Via Project'
+      example <<~DOC
+        project = client.projects.show(1)
+        project.merge_requests_delete(12)
+      DOC
+    end
+
     # Delete
     def delete(project_id, merge_request_id)
       project_id = format_id(project_id)

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/notifications/update.rb

@@ -31,7 +31,7 @@ module LabClient
       example 'client.notifications.update_project(16, level: :custom)'
 
       result <<~DOC
-           OpenStruct {
+           LabStruct {
              :level => "custom",
             :events => LabStruct {
                            :new_release => nil,

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

@@ -321,7 +321,7 @@ module LabClient
     end
 
     # Files
-    def file(file_path, ref = :master, kind = nil)
+    def file(file_path, ref = :main, kind = nil)
       client.files.show(id, file_path, ref, kind)
     end
 
@@ -647,6 +647,10 @@ module LabClient
       client.merge_requests.create(id, query)
     end
 
+    def merge_request_delete(merge_request_iid)
+      client.merge_requests.delete(id, merge_request_iid)
+    end
+
     # Access Requests
     def request_access
       client.projects.access_requests.create(id)
@@ -748,7 +752,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/repository/repository_tree.rb

@@ -0,0 +1,7 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class RepositoryTree < Klass
+    include ClassHelpers
+  end
+end

data/lib/labclient/repository/tree.rb

@@ -29,7 +29,7 @@ module LabClient
     def tree(project_id, query = {})
       project_id = format_id(project_id)
 
-      client.request(:get, "projects/#{project_id}/repository/tree", nil, query)
+      client.request(:get, "projects/#{project_id}/repository/tree", RepositoryTree, query)
     end
   end
 end

data/lib/labclient/version.rb

@@ -1,3 +1,9 @@
+# Overall version
 module LabClient
-  VERSION = '0.3.5'.freeze
+  VERSION = '0.5.1'.freeze
+
+  # Make it easy to print version
+  def self.version
+    VERSION
+  end
 end

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'
@@ -769,6 +771,7 @@ require 'labclient/pipelines/pipeline'
 # Repository
 require 'labclient/repository/alias'
 require 'labclient/repository/tree'
+require 'labclient/repository/repository_tree'
 require 'labclient/repository/blob'
 require 'labclient/repository/archive'
 require 'labclient/repository/compare'
@@ -874,7 +877,10 @@ 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"].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'