haveapi-client 0.20.0 → 0.21.0

data/lib/haveapi/cli/cli.rb

@@ -12,9 +12,8 @@ module HaveAPI::CLI
 
       def run
         c = new
-
       rescue Interrupt
-        warn "Interrupted"
+        warn 'Interrupted'
         exit(false)
       end
 
@@ -38,7 +37,7 @@ module HaveAPI::CLI
       connect_api unless @api
 
       if @action
-        method(@action.first).call( * @action[1..-1] )
+        method(@action.first).call(* @action[1..])
         exit
       end
 
@@ -51,7 +50,7 @@ module HaveAPI::CLI
 
       resources = args[0].split('.')
 
-      if cmd = find_command(resources, args[1])
+      if (cmd = find_command(resources, args[1]))
         authenticate if @auth
         c = cmd.new(@opts, HaveAPI::Client::Client.new(nil, communicator: @api))
 
@@ -72,21 +71,21 @@ module HaveAPI::CLI
           end
         end
 
-        if sep = ARGV.index('--')
-          cmd_opt.parse!(ARGV[sep+1..-1])
+        if (sep = ARGV.index('--'))
+          cmd_opt.parse!(ARGV[sep + 1..])
         end
 
-        c.exec(args[2..-1] || [])
+        c.exec(args[2..] || [])
 
         exit
       end
 
       if args.count == 1
         describe_resource(resources)
-        exit(true)
+        exit
       end
 
-      action = @api.get_action(resources, args[1].to_sym, args[2..-1])
+      action = @api.get_action(resources, args[1].to_sym, args[2..])
 
       unless action
         warn "Resource or action '#{args[0]} #{args[1]}' not found"
@@ -97,24 +96,23 @@ module HaveAPI::CLI
       if authenticate(action) && !action.unresolved_args?
         begin
           action.update_description(@api.describe_action(action))
-
         rescue RestClient::ResourceNotFound => e
           format_errors(action, 'Object not found', {})
           exit(false)
         end
       end
 
-      @selected_params = @opts[:output] ? @opts[:output].split(',').uniq
-                                        : nil
+      @selected_params = if @opts[:output]
+                           @opts[:output].split(',').uniq
+                         end
 
       @input_params = parameters(action)
 
       includes = build_includes(action) if @selected_params
-      @input_params[:meta] = { includes: includes } if includes
+      @input_params[:meta] = { includes: } if includes
 
       begin
         ret = action.execute(@input_params, raw: @opts[:raw])
-
       rescue HaveAPI::Client::ValidationError => e
         format_errors(action, 'input parameters not valid', e.errors)
         exit(false)
@@ -128,30 +126,30 @@ module HaveAPI::CLI
         exit(false)
       end
 
-      if action.blocking?
-        res = HaveAPI::Client::Response.new(action, ret)
+      return unless action.blocking?
 
-        if res.meta[:action_state_id]
-          state = ActionState.new(
-              @opts,
-              HaveAPI::Client::Client.new(@api.url, communicator: @api, block: false),
-              res.meta[:action_state_id]
-          )
+      res = HaveAPI::Client::Response.new(action, ret)
 
-          if @opts[:block]
-            puts
-            action_ret = state.wait_for_completion(timeout: @opts[:timeout])
+      return unless res.meta[:action_state_id]
 
-            if action_ret.nil?
-              warn "Timeout"
-              exit(false)
-            end
+      state = ActionState.new(
+        @opts,
+        HaveAPI::Client::Client.new(@api.url, communicator: @api, block: false),
+        res.meta[:action_state_id]
+      )
 
-          else
-            puts
-            state.print_help
-          end
+      puts
+
+      if @opts[:block]
+        action_ret = state.wait_for_completion(timeout: @opts[:timeout])
+
+        if action_ret.nil?
+          warn 'Timeout'
+          exit(false)
         end
+
+      else
+        state.print_help
       end
     end
 
@@ -163,7 +161,7 @@ module HaveAPI::CLI
       options = {
           client: default_url,
           block: true,
-          verbose: false,
+          verbose: false
       }
 
       @global_opt = OptionParser.new do |opts|
@@ -211,11 +209,11 @@ module HaveAPI::CLI
           options[:layout] = :columns
         end
 
-        opts.on('-H', '--no-header', 'Hide header row') do |h|
+        opts.on('-H', '--no-header', 'Hide header row') do |_h|
           options[:header] = false
         end
 
-        opts.on('-L', '--list-parameters', 'List output parameters') do |l|
+        opts.on('-L', '--list-parameters', 'List output parameters') do |_l|
           options[:list_output] = true
         end
 
@@ -260,9 +258,9 @@ module HaveAPI::CLI
         end
 
         opts.on(
-            '--timeout SEC',
-            Float,
-            'Fail when the action does not finish within the timeout'
+          '--timeout SEC',
+          Float,
+          'Fail when the action does not finish within the timeout'
         ) do |v|
           options[:timeout] = v.to_f
         end
@@ -291,11 +289,9 @@ module HaveAPI::CLI
       args = []
 
       ARGV.each do |arg|
-        if arg == '--'
-          break
-        else
-          args << arg
-        end
+        break if arg == '--'
+
+        args << arg
       end
 
       @global_opt.parse!(args)
@@ -304,11 +300,11 @@ module HaveAPI::CLI
         cfg = server_config(options[:client])
         connect_api(url: options[:client], version: options[:version]) unless @api
 
-        if m = cfg[:last_auth]
+        if (m = cfg[:last_auth])
           @auth = Cli.auth_methods[m].new(
             @api,
             @api.describe_api(options[:version])[:authentication][m],
-            cfg[:auth][m],
+            cfg[:auth][m]
           )
         end
       end
@@ -328,12 +324,12 @@ module HaveAPI::CLI
             opts.on(param_option(name, p), p[:description] || p[:label] || ' ') do |*args|
               arg = args.first
 
-              if arg.nil?
-                options[name] = read_param(name, p)
+              options[name] = if arg.nil?
+                                read_param(name, p)
 
-              else
-                options[name] = args.first
-              end
+                              else
+                                args.first
+                              end
             end
           end
         end
@@ -353,7 +349,7 @@ module HaveAPI::CLI
           puts 'Output parameters:'
 
           action.params.each do |name, param|
-            puts sprintf("    %-32s %s", name, param[:description])
+            puts format('    %-32s %s', name, param[:description])
           end
 
           print_examples(action)
@@ -367,7 +363,7 @@ module HaveAPI::CLI
 
       return {} unless sep
 
-      @action_opt.parse!(ARGV[sep+1..-1])
+      @action_opt.parse!(ARGV[sep + 1..])
 
       options
     end
@@ -375,7 +371,7 @@ module HaveAPI::CLI
     def list_versions
       desc = @api.available_versions
 
-      desc[:versions].each do |v, _|
+      desc[:versions].each_key do |v|
         next if v == :default
 
         v_int = v.to_s.to_i
@@ -384,7 +380,7 @@ module HaveAPI::CLI
       end
     end
 
-    def list_auth(v=nil)
+    def list_auth(v = nil)
       desc = @api.describe_api(v)
 
       desc[:authentication].each_key do |auth|
@@ -392,7 +388,7 @@ module HaveAPI::CLI
       end
     end
 
-    def list_resources(v=nil)
+    def list_resources(v = nil)
       desc = @api.describe_api(v)
 
       sort_by_key(desc[:resources]).each do |resource, children|
@@ -400,7 +396,7 @@ module HaveAPI::CLI
       end
     end
 
-    def list_actions(v=nil)
+    def list_actions(v = nil)
       desc = @api.describe_api(v)
 
       sort_by_key(desc[:resources]).each do |resource, children|
@@ -450,16 +446,16 @@ module HaveAPI::CLI
 
       puts '' if !desc[:resources].empty? && !desc[:actions].empty?
 
-      unless desc[:actions].empty?
-        puts 'Actions:'
+      return if desc[:actions].empty?
 
-        desc[:actions].keys.sort.each do |a|
-          puts "  #{a}"
-        end
+      puts 'Actions:'
+
+      desc[:actions].keys.sort.each do |a|
+        puts "  #{a}"
       end
     end
 
-    def nested_resource(prefix, children, actions=false)
+    def nested_resource(prefix, children, actions = false)
       if actions
         children[:actions].keys.sort.each do |action|
           puts "#{prefix}##{action}"
@@ -468,8 +464,8 @@ module HaveAPI::CLI
         puts prefix
       end
 
-      sort_by_key(children[:resources]).each do |resource, children|
-        nested_resource("#{prefix}.#{resource}", children, actions)
+      sort_by_key(children[:resources]).each do |resource, grandchildren|
+        nested_resource("#{prefix}.#{resource}", grandchildren, actions)
       end
     end
 
@@ -480,10 +476,10 @@ module HaveAPI::CLI
         puts
         puts 'Commands:'
         Cli.commands.each do |cmd|
-          puts sprintf(
-              '%-36s %s',
-              "#{cmd.resource.join('.')} #{cmd.action} #{cmd.args}",
-              cmd.desc
+          puts format(
+            '%-36s %s',
+            "#{cmd.resource.join('.')} #{cmd.action} #{cmd.args}",
+            cmd.desc
           )
         end
       end
@@ -493,10 +489,10 @@ module HaveAPI::CLI
     end
 
     def print_examples(action)
-      unless action.examples.empty?
-        puts "\nExamples:\n"
-        ExampleFormatter.format_examples(self, action)
-      end
+      return if action.examples.empty?
+
+      puts "\nExamples:\n"
+      ExampleFormatter.format_examples(self, action)
     end
 
     def format_output(action, response, out = $>)
@@ -510,7 +506,7 @@ module HaveAPI::CLI
       namespace = action.namespace(:output).to_sym
 
       if action.output_layout.to_sym == :custom
-          return PP.pp(response[namespace], out)
+        return PP.pp(response[namespace], out)
       end
 
       cols = []
@@ -522,37 +518,35 @@ module HaveAPI::CLI
 
         # Fetching an associated attribute
         if raw_name.to_s.index('.')
-          parts = raw_name.to_s.split('.').map! { |v| v.to_sym }
+          parts = raw_name.to_s.split('.').map!(&:to_sym)
           name = parts.first.to_sym
 
           top = action.params
 
           parts.each do |part|
-            fail "'#{part}' not found" unless top.has_key?(part)
+            raise "'#{part}' not found" unless top.has_key?(part)
 
-            if top[part][:type] == 'Resource'
-              param = top[part]
-              top = @api.get_action(top[part][:resource], :show, []).params
+            param = top[part]
 
-            else
-              param = top[part]
-              break
-            end
+            break if param[:type] != 'Resource'
+
+            top = @api.get_action(param[:resource], :show, []).params
           end
 
-          col[:display] = Proc.new do |r|
+          col[:display] = proc do |r|
             next '' unless r
 
             top = r
-            parts[1..-1].each do |part|
-              fail "'#{part}' not found" unless top.has_key?(part)
+            parts[1..].each do |part|
+              raise "'#{part}' not found" unless top.has_key?(part)
               break if top[part].nil?
+
               top = top[part]
             end
 
             case param[:type]
             when 'Resource'
-              "#{top[ param[:value_label].to_sym ]} (##{top[ param[:value_id].to_sym ]})"
+              "#{top[param[:value_label].to_sym]} (##{top[param[:value_id].to_sym]})"
 
             when 'Datetime'
               format_date(top)
@@ -567,12 +561,13 @@ module HaveAPI::CLI
         else # directly accessible parameter
           name = raw_name.to_sym
           param = action.params[name]
-          fail "parameter '#{name}' does not exist" if param.nil?
+          raise "parameter '#{name}' does not exist" if param.nil?
 
           if param[:type] == 'Resource'
-            col[:display] = Proc.new do |r|
+            col[:display] = proc do |r|
               next '' unless r
-              "#{r[ param[:value_label].to_sym ]} (##{r[ param[:value_id].to_sym ]})"
+
+              "#{r[param[:value_label].to_sym]} (##{r[param[:value_id].to_sym]})"
             end
 
           elsif param[:type] == 'Datetime'
@@ -581,8 +576,8 @@ module HaveAPI::CLI
         end
 
         col.update({
-            name: name,
-            align: %w(Integer Float).include?(param[:type]) ? 'right' : 'left',
+            name:,
+            align: %w[Integer Float].include?(param[:type]) ? 'right' : 'left'
         })
 
         col[:label] ||= param[:label] && !param[:label].empty? ? param[:label] : name.upcase
@@ -591,11 +586,11 @@ module HaveAPI::CLI
       end
 
       OutputFormatter.print(
-          response[namespace],
-          cols,
-          header: @opts[:header].nil?,
-          sort: @opts[:sort] && @opts[:sort].to_sym,
-          layout: @opts[:layout]
+        response[namespace],
+        cols,
+        header: @opts[:header].nil?,
+        sort: @opts[:sort] && @opts[:sort].to_sym,
+        layout: @opts[:layout]
       )
     end
 
@@ -610,25 +605,23 @@ module HaveAPI::CLI
     end
 
     def authenticate(action = nil)
-      if @auth
-        @auth.validate
-        @auth.authenticate
+      raise 'auth is needed and has not been selected' unless @auth
 
-        if @opts[:save]
-          cfg = server_config(api_url)
-          cfg[:auth][@opts[:auth]] = @auth.save
-          cfg[:last_auth] = @opts[:auth]
-          write_config
-        end
+      @auth.validate
+      @auth.authenticate
 
-      else
-        # FIXME: exit as auth is needed and has not been selected
+      if @opts[:save]
+        cfg = server_config(api_url)
+        cfg[:auth][@opts[:auth]] = @auth.save
+        cfg[:last_auth] = @opts[:auth]
+        write_config
       end
 
-      return true
+      true
     end
 
     protected
+
     def default_url
       'http://localhost:4567'
     end
@@ -638,18 +631,16 @@ module HaveAPI::CLI
     end
 
     def write_config
-      File.open(config_path, 'w') do |f|
-        f.write(YAML.dump(@config))
-      end
+      File.write(config_path, YAML.dump(@config))
     end
 
     def read_config
-      @config = YAML.load_file(config_path) if File.exists?(config_path)
+      @config = YAML.load_file(config_path) if File.exist?(config_path)
     end
 
     def server_config(url)
       unless @config[:servers]
-        @config[:servers] = [{url: url, auth: {}}]
+        @config[:servers] = [{ url:, auth: {} }]
         return @config[:servers].first
       end
 
@@ -657,7 +648,7 @@ module HaveAPI::CLI
         return s if s[:url] == url
       end
 
-      @config[:servers] << {url: url, auth: {}}
+      @config[:servers] << { url:, auth: {} }
       @config[:servers].last
     end
 
@@ -708,7 +699,7 @@ module HaveAPI::CLI
         includes = []
         top = action.params
 
-        param.split('.').map! { |v| v.to_sym }.each do |part|
+        param.split('.').map!(&:to_sym).each do |part|
           next unless top.has_key?(part)
           next if top[part][:type] != 'Resource'
 
@@ -728,25 +719,22 @@ module HaveAPI::CLI
 
       t = DateTime.iso8601(date).to_time
       ret = case @opts[:datetime]
-      when :timestamp
-        t.to_i
-
-      when :utc
-        t.utc
+            when :timestamp
+              t.to_i
 
-      when :local
-        t.localtime
+            when :utc
+              t.utc
 
-      else
-        t.localtime
-      end
+            else
+              t.localtime
+            end
 
       @opts[:date_format] ? ret.strftime(@opts[:date_format]) : ret
     end
 
     def sort_by_key(hash)
       hash.sort do |a, b|
-        a[0]<=> b[0]
+        a[0] <=> b[0]
       end
     end
   end

data/lib/haveapi/cli/command.rb

@@ -5,7 +5,7 @@ module HaveAPI::CLI
 
       def cmd(resource, action = nil)
         @resource = resource.is_a?(::Array) ? resource : [resource]
-        @resource.map! { |v| v.to_s }
+        @resource.map!(&:to_s)
         @action = action && action.to_s
 
         Cli.register_command(self)
@@ -41,9 +41,7 @@ module HaveAPI::CLI
       @api = client
     end
 
-    def options(opts)
-
-    end
+    def options(opts); end
 
     def exec(args)
       raise NotImplementedError

data/lib/haveapi/cli/commands/action_state_wait.rb

@@ -7,24 +7,24 @@ module HaveAPI::CLI::Commands
     desc 'Block until the action is finished'
 
     def exec(args)
-      if args.size < 1
-        warn "Provide argument STATE ID"
+      if args.empty?
+        warn 'Provide argument STATE ID'
         exit(false)
       end
 
       @api.set_opts(block: false)
 
       state = HaveAPI::CLI::ActionState.new(
-          @global_opts,
-          @api,
-          args.first.to_i
+        @global_opts,
+        @api,
+        args.first.to_i
       )
       ret = state.wait_for_completion(timeout: @global_opts[:timeout])
 
-      if ret.nil?
-        warn "Timeout"
-        exit(false)
-      end
+      return unless ret.nil?
+
+      warn 'Timeout'
+      exit(false)
     end
   end
 end

data/lib/haveapi/cli/example_formatter.rb

@@ -24,9 +24,9 @@ module HaveAPI::CLI
 
         # response
         cli.format_output(
-            action,
-            {action.namespace(:output).to_sym => example[:response]},
-            out
+          action,
+          { action.namespace(:output).to_sym => example[:response] },
+          out
         )
       end
     end
@@ -35,16 +35,16 @@ module HaveAPI::CLI
       option = name.to_s.dasherize
 
       case desc[:type]
-        when 'Boolean'
-          value ? "--#{option}" : "--no-#{option}"
+      when 'Boolean'
+        value ? "--#{option}" : "--no-#{option}"
 
-        else
-          "--#{option} #{example_value(value)}"
+      else
+        "--#{option} #{example_value(value)}"
       end
     end
 
     def self.example_value(v)
-      (v.is_a?(String) && (v.empty? || v.index(' '))) ? "\"#{v}\"" : v
+      v.is_a?(String) && (v.empty? || v.index(' ')) ? "\"#{v}\"" : v
     end
   end
 end