haveapi-client 0.20.0 → 0.21.0

data/lib/haveapi/cli/output_formatter.rb

@@ -1,12 +1,12 @@
 module HaveAPI::CLI
   class OutputFormatter
-    def self.format(*args)
-      f = new(*args)
-      f.format
+    def self.to_s(*)
+      f = new(*)
+      f.to_s
     end
 
-    def self.print(*args, **kwargs)
-      f = new(*args, **kwargs)
+    def self.print(*, **)
+      f = new(*, **)
       f.print
     end
 
@@ -18,31 +18,29 @@ module HaveAPI::CLI
       @empty = empty
 
       if @layout.nil?
-        if many?
-          @layout = :columns
+        @layout = if many?
+                    :columns
 
-        else
-          @layout = :rows
-        end
+                  else
+                    :rows
+                  end
       end
 
       if cols
         @cols = parse_cols(cols)
 
-      else
-        if @objects.is_a?(::Array) # A list of items
-          @cols ||= parse_cols(@objects.first.keys)
+      elsif @objects.is_a?(::Array)
+        @cols ||= parse_cols(@objects.first.keys) # A list of items
 
-        elsif @objects.is_a?(::Hash) # Single item
-          @cols ||= parse_cols(@objects.keys)
+      elsif @objects.is_a?(::Hash) # Single item
+        @cols ||= parse_cols(@objects.keys)
 
-        else
-          fail "unsupported type #{@objects.class}"
-        end
+      else
+        raise "unsupported type #{@objects.class}"
       end
     end
 
-    def format
+    def to_s
       @out = ''
       generate
       @out
@@ -54,6 +52,7 @@ module HaveAPI::CLI
     end
 
     protected
+
     def parse_cols(cols)
       ret = []
 
@@ -65,7 +64,7 @@ module HaveAPI::CLI
         if c.is_a?(::String) || c.is_a?(::Symbol)
           base.update({
               name: c,
-              label: c.to_s.upcase,
+              label: c.to_s.upcase
           })
           ret << base
 
@@ -74,7 +73,7 @@ module HaveAPI::CLI
           ret << base
 
         else
-          fail "unsupported column type #{c.class}"
+          raise "unsupported column type #{c.class}"
         end
       end
 
@@ -83,6 +82,7 @@ module HaveAPI::CLI
 
     def generate
       return if @cols.empty?
+
       prepare
 
       case @layout
@@ -93,7 +93,7 @@ module HaveAPI::CLI
         rows
 
       else
-        fail "unsupported layout '#{@layout}'"
+        raise "unsupported layout '#{@layout}'"
       end
     end
 
@@ -103,21 +103,21 @@ module HaveAPI::CLI
 
       formatters = @cols.map do |c|
         ret = case c[:align].to_sym
-        when :right
-          "%#{col_width(i, c)}s"
+              when :right
+                "%#{col_width(i, c)}s"
 
-        else
-          "%-#{col_width(i, c)}s"
-        end
+              else
+                "%-#{col_width(i, c)}s"
+              end
 
         i += 1
         ret
       end.join('  ')
 
-      line sprintf(formatters, * @cols.map { |c| c[:label] }) if @header
+      line format(formatters, * @cols.map { |c| c[:label] }) if @header
 
       @str_objects.each do |o|
-        line sprintf(formatters, *o)
+        line format(formatters, *o)
       end
     end
 
@@ -131,13 +131,15 @@ module HaveAPI::CLI
 
           if o[i].is_a?(::String) && o[i].index("\n")
             lines = o[i].split("\n")
-            v = ([lines.first] + lines[1..-1].map { |l| (' ' * (w+3)) + l }).join("\n")
+            v = ([lines.first] + lines[1..].map { |l| (' ' * (w + 3)) + l }).join("\n")
 
           else
             v = o[i]
           end
 
-          line sprintf("%#{w}s:  %s", c[:label], v)
+          # rubocop:disable Lint/FormatParameterMismatch
+          line format("%#{w}s:  %s", c[:label], v)
+          # rubocop:enable Lint/FormatParameterMismatch
         end
 
         line
@@ -146,7 +148,7 @@ module HaveAPI::CLI
 
     def line(str = '')
       if @out
-        @out += str + "\n"
+        @out += "#{str}\n"
 
       else
         puts str
@@ -160,7 +162,7 @@ module HaveAPI::CLI
         arr = []
 
         @cols.each do |c|
-          v = o[ c[:name] ]
+          v = o[c[:name]]
           str = (c[:display] ? c[:display].call(v) : v)
           str = @empty if !str || (str.is_a?(::String) && str.empty?)
 
@@ -172,7 +174,7 @@ module HaveAPI::CLI
 
       if @sort
         col_i = @cols.index { |c| c[:name] == @sort }
-        fail "unknown column '#{@sort}'" unless col_i
+        raise "unknown column '#{@sort}'" unless col_i
 
         @str_objects.sort! do |a, b|
           a_i = a[col_i]
@@ -181,6 +183,7 @@ module HaveAPI::CLI
           next 0 if a_i == @empty && b_i == @empty
           next -1 if a_i == @empty && b_i != @empty
           next 1 if a_i != @empty && b_i == @empty
+
           a_i <=> b_i
         end
       end
@@ -211,9 +214,9 @@ module HaveAPI::CLI
       w + 1
     end
 
-    def each_object
+    def each_object(&)
       if @objects.is_a?(::Array)
-        @objects.each { |v| yield(v) }
+        @objects.each(&)
 
       else
         yield(@objects)

data/lib/haveapi/cli/utils.rb

@@ -6,12 +6,12 @@ module HaveAPI::CLI
       ret = '--'
       name = name.to_s.dasherize
 
-      if p[:type] == 'Boolean'
-        ret += "[no-]#{name}"
+      ret += if p[:type] == 'Boolean'
+               "[no-]#{name}"
 
-      else
-        ret += "#{name} [#{name.underscore.upcase}]"
-      end
+             else
+               "#{name} [#{name.underscore.upcase}]"
+             end
 
       ret
     end

data/lib/haveapi/cli.rb

@@ -2,7 +2,7 @@ require 'haveapi/client'
 
 module HaveAPI
   module CLI
-    module Commands ; end
+    module Commands; end
   end
 end
 

data/lib/haveapi/client/action.rb

@@ -29,15 +29,11 @@ module HaveAPI::Client
         params_arg = params.to_api
       end
 
-      ret = @api.call(self, params_arg, raw: raw)
+      ret = @api.call(self, params_arg, raw:)
       reset
       ret
     end
 
-    def name
-      @name
-    end
-
     def auth?
       @spec[:auth]
     end
@@ -167,12 +163,12 @@ module HaveAPI::Client
 
       loop do
         res = client.action_state.poll(
-            id,
-            timeout: interval,
-            update_in: update_in,
-            status: last[:status],
-            current: last[:current],
-            total: last[:total],
+          id,
+          timeout: interval,
+          update_in:,
+          status: last[:status],
+          current: last[:current],
+          total: last[:total]
         )
 
         state = ActionState.new(res)
@@ -193,18 +189,19 @@ module HaveAPI::Client
           if ret.is_a?(Response)
             # The cancel is not a blocking operation, return immediately
             raise ActionFailed, ret unless ret.ok?
+
             return ret
           end
 
           # Cancel is a blocking operation
           if cancel_block
             return wait_for_completion(
-                client,
-                ret,
-                interval: interval,
-                timeout: timeout,
-                update_in: update_in,
-                &cancel_block
+              client,
+              ret,
+              interval:,
+              timeout:,
+              update_in:,
+              &cancel_block
             )
           end
 
@@ -215,16 +212,15 @@ module HaveAPI::Client
       end
 
       state.status
-
     rescue Interrupt => e
-      %i(show poll).each do |action|
+      %i[show poll].each do |action|
         client.action_state.actions[action].reset
       end
       raise e
     end
 
     def self.cancel(client, id)
-      res = client.action_state.cancel(id, meta: {block: false})
+      res = client.action_state.cancel(id, meta: { block: false })
 
       if res.ok? && res.action.blocking? && res.meta[:action_state_id]
         res.meta[:action_state_id]
@@ -235,6 +231,7 @@ module HaveAPI::Client
     end
 
     private
+
     def apply_args(args)
       @prepared_path ||= @spec[:path].dup
       @prepared_help ||= @spec[:help].dup

data/lib/haveapi/client/action_state.rb

@@ -11,7 +11,7 @@ module HaveAPI::Client
       end
     end
 
-    attr_reader :progress
+    attr_reader :progress, :cancel_block
 
     def initialize(response)
       @data = response.response
@@ -26,7 +26,7 @@ module HaveAPI::Client
     def status
       @data[:status] === true
     end
-    
+
     def finished?
       @data[:finished] === true
     end
@@ -40,7 +40,7 @@ module HaveAPI::Client
     # is used only if the cancel operation is blocking.
     def cancel(&block)
       unless can_cancel?
-        fail "action ##{@data[:id]} (#{label}) cannot be cancelled"
+        raise "action ##{@data[:id]} (#{label}) cannot be cancelled"
       end
 
       @cancel = true
@@ -51,10 +51,6 @@ module HaveAPI::Client
       @cancel === true
     end
 
-    def cancel_block
-      @cancel_block
-    end
-    
     # Stop monitoring the action's state, the call from Action.wait_for_completion
     # will return.
     def stop

data/lib/haveapi/client/authentication/base.rb

@@ -4,8 +4,9 @@ module HaveAPI::Client
   module Authentication
     # Raise this exception when authentication process fails somewhere
     # outside action execution (in which access forbidden is raised from RestClient).
-    class AuthenticationFailed < Exception
+    class AuthenticationFailed < StandardError
       def initialize(msg)
+        super
         @msg = msg
       end
 
@@ -43,14 +44,10 @@ module HaveAPI::Client
       end
 
       # Called right after initialize. Use this method to initialize provider.
-      def setup
-
-      end
+      def setup; end
 
       # Return RestClient::Resource instance. This is mainly for HTTP basic auth.
-      def resource
-
-      end
+      def resource; end
 
       # Called for each request. Returns a hash of query parameters.
       def request_query_params

data/lib/haveapi/client/authentication/basic.rb

@@ -8,7 +8,7 @@ module HaveAPI::Client::Authentication
       RestClient::Resource.new(@communicator.url, @opts[:user], @opts[:password])
     end
 
-    def user ; @opts[:user] ; end
-    def password ; @opts[:password] ; end
+    def user = @opts.[](:user)
+    def password = @opts.[](:password)
   end
 end

data/lib/haveapi/client/authentication/noauth.rb

@@ -2,6 +2,5 @@ require 'haveapi/client/authentication/base'
 
 module HaveAPI::Client::Authentication
   class NoAuth < Base
-
   end
 end

data/lib/haveapi/client/authentication/token.rb

@@ -17,18 +17,20 @@ module HaveAPI::Client::Authentication
 
     def request_query_params
       return {} unless @configured
+
       check_validity
-      @via == :query_param ? {@desc[:query_parameter] => @token} : {}
+      @via == :query_param ? { @desc[:query_parameter] => @token } : {}
     end
 
     def request_headers
       return {} unless @configured
+
       check_validity
-      @via == :header ? {@desc[:http_header] => @token} : {}
+      @via == :header ? { @desc[:http_header] => @token } : {}
     end
 
     def save
-      {token: @token, valid_to: @valid_to}
+      { token: @token, valid_to: @valid_to }
     end
 
     def load(hash)
@@ -38,36 +40,37 @@ module HaveAPI::Client::Authentication
 
     def renew
       a = HaveAPI::Client::Action.new(
-          nil,
-          @communicator,
-          :renew,
-          @desc[:resources][:token][:actions][:renew],
-          []
+        nil,
+        @communicator,
+        :renew,
+        @desc[:resources][:token][:actions][:renew],
+        []
       )
       ret = HaveAPI::Client::Response.new(a, a.execute({}))
-      raise HaveAPI::Client::ActionFailed.new(ret) unless ret.ok?
+      raise HaveAPI::Client::ActionFailed, ret unless ret.ok?
 
       @valid_to = ret[:valid_to]
-      @valid_to = @valid_to && DateTime.iso8601(@valid_to).to_time
+      @valid_to &&= DateTime.iso8601(@valid_to).to_time
     end
 
     def revoke
       a = HaveAPI::Client::Action.new(
-          nil,
-          @communicator,
-          :revoke,
-          @desc[:resources][:token][:actions][:revoke],
-          []
+        nil,
+        @communicator,
+        :revoke,
+        @desc[:resources][:token][:actions][:revoke],
+        []
       )
       ret = HaveAPI::Client::Response.new(a, a.execute({}))
-      raise HaveAPI::Client::ActionFailed.new(ret) unless ret.ok?
+      raise HaveAPI::Client::ActionFailed, ret unless ret.ok?
     end
 
     protected
+
     def request_token
       input = {
         lifetime: @opts[:lifetime],
-        interval: @opts[:interval] || 300,
+        interval: @opts[:interval] || 300
       }
       request_credentials.each { |name| input[name] = @opts[name] if @opts[name] }
 
@@ -75,11 +78,11 @@ module HaveAPI::Client::Authentication
       return if cont == :done
 
       if @block.nil?
-        raise AuthenticationFailed.new('implement multi-factor authentication')
+        raise AuthenticationFailed, 'implement multi-factor authentication'
       end
 
       loop do
-        input = {token: token}
+        input = { token: }
         input.update(@block.call(next_action, auth_action_input(next_action)))
 
         cont, next_action, token = login_step(next_action, input)
@@ -99,7 +102,7 @@ module HaveAPI::Client::Authentication
       resp = HaveAPI::Client::Response.new(a, a.execute(input))
 
       if resp.failed?
-        raise AuthenticationFailed.new(resp.message || 'invalid credentials')
+        raise AuthenticationFailed, resp.message || 'invalid credentials'
       end
 
       if resp[:complete]
@@ -112,21 +115,19 @@ module HaveAPI::Client::Authentication
     end
 
     def check_validity
-      if @valid_to && @valid_to < Time.now && @opts[:user] && @opts[:password]
-        request_token
-      end
+      return unless @valid_to && @valid_to < Time.now && @opts[:user] && @opts[:password]
+
+      request_token
     end
 
     def request_credentials
       @desc[:resources][:token][:actions][:request][:input][:parameters].each_key.reject do |name|
-        %i(interval lifetime).include?(name)
+        %i[interval lifetime].include?(name)
       end
     end
 
     def auth_action_input(name)
-      @desc[:resources][:token][:actions][name][:input][:parameters].reject do |k, _|
-        %i(token).include?(k)
-      end
+      @desc[:resources][:token][:actions][name][:input][:parameters].except(:token)
     end
   end
 end

data/lib/haveapi/client/client.rb

@@ -1,5 +1,3 @@
-require 'pp'
-
 # HaveAPI client interface.
 class HaveAPI::Client::Client
   attr_reader :resources
@@ -53,8 +51,8 @@ class HaveAPI::Client::Client
   end
 
   # See Communicator#authenticate.
-  def authenticate(auth_method, **options, &block)
-    @api.authenticate(auth_method, options, &block)
+  def authenticate(auth_method, **options, &)
+    @api.authenticate(auth_method, options, &)
   end
 
   # Get uthentication provider
@@ -92,20 +90,28 @@ class HaveAPI::Client::Client
 
   # Initialize the client if it is not yet initialized and call the resource
   # if it exists.
-  def method_missing(symbol, *args)
+  def method_missing(symbol, *)
     return super(symbol, *args) if @setup
 
     setup_api
 
     if @resources.include?(symbol)
-      method(symbol).call(*args)
+      method(symbol).call(*)
 
     else
       super(symbol, *args)
     end
   end
 
+  def respond_to_missing?(symbol, *)
+    return super if @setup
+
+    setup_api
+    @resources.include?(symbol)
+  end
+
   private
+
   # Get the description from the API and setup resource methods.
   def setup_api
     @description = @api.describe_api(@version)