labclient 0.3.1 → 0.4.0

data/lib/labclient/klass.rb

@@ -2,19 +2,20 @@
 module LabClient
   # Common Configuration for all Class Helpers
   class Klass < LabStruct
+    include LabClient::Logger
     include CurlHelper
 
     attr_reader :client, :response
 
     extend Docs
 
+    # TODO: Awesome Print / Amazing Print Conflicts?
     def verbose
-      ap self, ruby19_syntax: true
+      ap @table, ruby19_syntax: true
     end
 
     # 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
@@ -37,7 +38,6 @@ module LabClient
       # Ignore Output
       nil
     end
-    # rubocop:enable Metrics/AbcSize
 
     # Documented API Methods
     def api_methods
@@ -65,7 +65,7 @@ module LabClient
       if response.path.nil?
         response.request.base_url.split(@client.base_url, 2)[position]
       else
-        response.path.split('/')[position]
+        CGI.unescape response.path.split('/')[position]
       end
     end
 
@@ -100,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/lab_struct.rb

@@ -2,6 +2,9 @@
 module LabClient
   # Unique inherited class to not override top level openstruct
   class LabStruct < OpenStruct
+    include CurlHelper
+    attr_reader :response
+
     def keys
       to_h.keys.sort
     end
@@ -17,5 +20,14 @@ module LabClient
     def slice(*opts)
       to_h.slice(*opts)
     end
+
+    def client
+      response.client
+    end
+
+    # Forward response success
+    def success?
+      @response.success?
+    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/list.rb

@@ -58,7 +58,7 @@ module LabClient
     doc 'List' do
       title 'Project'
       desc 'List project merge requests [Project ID, Hash]'
-      example 'client.merge_requests.list(16, created_after: 10.day.ago)'
+      example 'client.merge_requests.list_project(16, created_after: 10.day.ago)'
       result <<~DOC
         => [#<MergeRequest id: 37, title: Add new file>, #<MergeRequest id: 36, title: Update README.md>, ...]
       DOC

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
@@ -11,10 +10,10 @@ module LabClient
         LabClient is a Gitlab API Gem. Focusing on ease of use, documentation, helpers, and snippets.
 
         - Objects for resources (User, Project)
-        - Method Chaining ( project.branch(:master).pipelines ) 
-        
+        - Method Chaining ( project.branch(:master).pipelines )
+
         Lots of Helpers
-        
+
         - Pagination
         - IRB/Pry
         - Setup: credentials file, profiles, and prompt
@@ -102,6 +101,17 @@ module LabClient
       DOC
     end
 
+    doc 'Authentication' do
+      title 'OAuth Authorization'
+      desc 'Use OAuth access tokens to make requests to the API on behalf of a user. '
+      example <<~DOC
+        client = LabClient::Client.new(
+          url: 'https://gitlab.labclient',
+          token: 'gitlab oauth token',
+          token_type: 'Authorization'
+        )
+      DOC
+    end
     doc 'Pagination' do
       desc 'Pagination is enabled by default if not specified. Can be explicitly enabled or disabled'
       example <<~DOC
@@ -191,6 +201,31 @@ module LabClient
       DOC
     end
 
+    doc 'Pagination' do
+      title 'Other Pagination Helpers'
+    end
+
+    doc 'Pagination' do
+      desc 'Total Results'
+      example <<~DOC
+        client.users.list.total
+      DOC
+    end
+
+    doc 'Pagination' do
+      desc 'Total Pages'
+      example <<~DOC
+        client.users.list.total_pages
+      DOC
+    end
+
+    doc 'Pagination' do
+      desc 'Current Page'
+      example <<~DOC
+        client.users.list.page
+      DOC
+    end
+
     doc 'Response' do
       title 'Status'
       desc 'Each object/call will return a "response" object or the instantiated class object. On each of these you can use "success?" to verify the response of a call.'
@@ -244,26 +279,24 @@ module LabClient
         User
           - client.users.show(5)
           - client.users.show(5)
-          
+
         # General Help Filter
         client.help :protect
         Available Methods
         - protected_branches protected_environments protected_tags
-        
+
         # Projects Help Filter
         client.projects.help :cluster
         Projects
           Available Methods
               - clusters
-      
+
         # Project Object Help
         project = client.projects.show(16)
         project.help
 
         # Project Object Help Filter
         project.help :member
-
-
       DOC
     end
 
@@ -328,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'
@@ -338,12 +395,28 @@ module LabClient
           token: 'gitlab api token',
           quiet: true
         )
-        
+
         # Or after the init
         client.settings[:quiet] = true
       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'
@@ -394,4 +467,3 @@ module LabClient
     end
   end
 end
-# rubocop:enable Metrics/ClassLength