aspera-cli 4.19.0 → 4.20.0

data/lib/aspera/cli/formatter.rb

@@ -98,7 +98,7 @@ module Aspera
       CSV_RECORD_SEPARATOR = "\n"
       CSV_FIELD_SEPARATOR = ','
       # supported output formats
-      DISPLAY_FORMATS = %i[text nagios ruby json jsonpp yaml table multi csv image].freeze
+      DISPLAY_FORMATS = %i[text nagios ruby json jsonpp yaml table csv image].freeze
       # user output levels
       DISPLAY_LEVELS = %i[info data error].freeze
       FIELD_VALUE_HEADINGS = %i[key value].freeze
@@ -167,6 +167,11 @@ module Aspera
         @spinner.spin
       end
 
+      def long_operation_terminated
+        @spinner&.stop
+        @spinner = nil
+      end
+
       # options are: format, output, display, fields, select, table_style, flat_hash, transpose_single
       def option_handler(option_symbol, operation, value=nil)
         Aspera.assert_values(operation, %i[set get])
@@ -197,7 +202,6 @@ module Aspera
         else
           {}
         end
-
         options.declare(:format, 'Output format', values: DISPLAY_FORMATS, handler: {o: self, m: :option_handler}, default: :table)
         options.declare(:output, 'Destination for results', types: String, handler: {o: self, m: :option_handler})
         options.declare(:display, 'Output only some information', values: DISPLAY_LEVELS, handler: {o: self, m: :option_handler}, default: :info)
@@ -207,8 +211,9 @@ module Aspera
           default: SpecialValues::DEF)
         options.declare(:select, 'Select only some items in lists: column, value', types: [Hash, Proc], handler: {o: self, m: :option_handler})
         options.declare(:table_style, 'Table display style', types: [Hash], handler: {o: self, m: :option_handler}, default: default_table_style)
-        options.declare(:flat_hash, 'Display deep values as additional keys', values: :bool, handler: {o: self, m: :option_handler}, default: true)
-        options.declare(:transpose_single, 'Single object fields output vertically', values: :bool, handler: {o: self, m: :option_handler}, default: true)
+        options.declare(:flat_hash, '(Table) Display deep values as additional keys', values: :bool, handler: {o: self, m: :option_handler}, default: true)
+        options.declare(:transpose_single, '(Table) Single object fields output vertically', values: :bool, handler: {o: self, m: :option_handler}, default: true)
+        options.declare(:multi_table, '(Table) Each element of a table are displayed as a table', values: :bool, handler: {o: self, m: :option_handler}, default: false)
         options.declare(:show_secrets, 'Show secrets on command output', values: :bool, handler: {o: self, m: :option_handler}, default: false)
         options.declare(:image, 'Options for image display', types: Hash, handler: {o: self, m: :option_handler}, default: {})
       end
@@ -325,8 +330,9 @@ module Aspera
           display_message(:data, object_array.first[fields.first])
           return
         end
+        single_transposed = @options[:transpose_single] && object_array.length == 1
         # Special case if only one row (it could be object_list or single_object)
-        if @options[:transpose_single] && object_array.length == 1
+        if single_transposed
           single = object_array.first
           object_array = fields.map { |i| FIELD_VALUE_HEADINGS.zip([i, single[i]]).to_h }
           fields = FIELD_VALUE_HEADINGS
@@ -334,20 +340,24 @@ module Aspera
         Log.log.debug{Log.dump(:object_array, object_array)}
         # convert data to string, and keep only display fields
         final_table_rows = object_array.map { |r| fields.map { |c| r[c].to_s } }
+        # remove empty rows
+        final_table_rows.select!{|i| !(i.is_a?(Hash) && i.empty?)}
         # here : fields : list of column names
         case @options[:format]
         when :table
-          # display the table !
-          display_message(:data, Terminal::Table.new(
-            headings:  fields,
-            rows:      final_table_rows,
-            style:     @options[:table_style]&.symbolize_keys))
-        when :multi
-          final_table_rows.each do |row|
-            Log.log.debug{Log.dump(:row, row)}
+          if @options[:multi_table] && !single_transposed
+            final_table_rows.each do |row|
+              Log.log.debug{Log.dump(:row, row)}
+              display_message(:data, Terminal::Table.new(
+                headings:  FIELD_VALUE_HEADINGS,
+                rows:      fields.zip(row),
+                style:     @options[:table_style]&.symbolize_keys))
+            end
+          else
+            # display the table !
             display_message(:data, Terminal::Table.new(
-              headings:  FIELD_VALUE_HEADINGS,
-              rows:      fields.zip(row),
+              headings:  fields,
+              rows:      final_table_rows,
               style:     @options[:table_style]&.symbolize_keys))
           end
         when :csv
@@ -360,7 +370,7 @@ module Aspera
       # @return text suitable to display an image from url
       def status_image(blob)
         begin
-          raise URI::InvalidURIError, 'not uri' if !(blob =~ /\A#{URI::DEFAULT_PARSER.make_regexp}\z/)
+          raise URI::InvalidURIError, 'not uri' if !(blob =~ /\A#{URI::RFC2396_PARSER.make_regexp}\z/)
           # it's a url
           url = blob
           unless Environment.instance.url_method.eql?(:text)
@@ -424,7 +434,7 @@ module Aspera
           end
           raise "not url: #{url.class} #{url}" unless url.is_a?(String)
           display_message(:data, status_image(url))
-        when :table, :csv, :multi
+        when :table, :csv
           case type
           when :config_over
             display_table(Flattener.new(self).config_over(data), CONF_OVERVIEW_KEYS)

data/lib/aspera/cli/hints.rb

@@ -4,6 +4,7 @@ require 'aspera/transfer/error'
 require 'aspera/rest'
 require 'aspera/log'
 require 'aspera/assert'
+require 'aspera/cli/info'
 require 'net/ssh'
 require 'openssl'
 
@@ -18,7 +19,7 @@ module Aspera
           match:       'Remote host is not who we expected',
           remediation: [
             'For this specific error, refer to:',
-            "#{SRC_URL}#error-remote-host-is-not-who-we-expected",
+            "#{Info::SRC_URL}#error-remote-host-is-not-who-we-expected",
             'Add this to arguments:',
             %q{--ts=@json:'{"sshfp":null}'"}
           ]

data/lib/aspera/cli/info.rb

@@ -2,15 +2,17 @@
 
 module Aspera
   module Cli
-    # name of command line tool, also used as foldername where config is stored
-    PROGRAM_NAME = 'ascli'
-    # name of the containing gem, same as in <gem name>.gemspec
-    GEM_NAME = 'aspera-cli'
-    DOC_URL  = "https://www.rubydoc.info/gems/#{GEM_NAME}"
-    GEM_URL  = "https://rubygems.org/gems/#{GEM_NAME}"
-    SRC_URL  = 'https://github.com/IBM/aspera-cli'
-    # set this to warn in advance when minimum required ruby version will increase
-    # see also required_ruby_version in gemspec file
-    RUBY_FUTURE_MINIMUM_VERSION = '3.0'
+    module Info
+      # name of command line tool, also used as foldername where config is stored
+      CMD_NAME = 'ascli'
+      # name of the containing gem, same as in <gem name>.gemspec
+      GEM_NAME = 'aspera-cli'
+      DOC_URL  = "https://www.rubydoc.info/gems/#{GEM_NAME}"
+      GEM_URL  = "https://rubygems.org/gems/#{GEM_NAME}"
+      SRC_URL  = 'https://github.com/IBM/aspera-cli'
+      # set this to warn in advance when minimum required ruby version will increase
+      # see also required_ruby_version in gemspec file
+      RUBY_FUTURE_MINIMUM_VERSION = '3.0'
+    end
   end
 end

data/lib/aspera/cli/main.rb

@@ -94,7 +94,7 @@ module Aspera
         # create formatter, in case there is an exception, it is used to display.
         @plug_init[:formatter] = Formatter.new
         # create command line manager with arguments
-        @plug_init[:options] = Manager.new(PROGRAM_NAME, @argv)
+        @plug_init[:options] = Manager.new(Info::CMD_NAME, @argv)
         # formatter adds options
         @plug_init[:formatter].declare_options(options)
         ExtendedValue.instance.default_decoder = options.get_option(:struct_parser)
@@ -102,16 +102,18 @@ module Aspera
         current_prog_name = File.basename($PROGRAM_NAME)
         formatter.display_message(
           :error,
-          "#{Formatter::WARNING_FLASH} Please use '#{PROGRAM_NAME}' instead of '#{current_prog_name}'") unless current_prog_name.eql?(PROGRAM_NAME)
+          "#{Formatter::WARNING_FLASH} Please use '#{Info::CMD_NAME}' instead of '#{current_prog_name}'") unless current_prog_name.eql?(Info::CMD_NAME)
         # declare and parse global options
         declare_global_options
         # the Config plugin adds the @preset parser, so declare before TransferAgent which may use it
-        @plug_init[:config] = Plugins::Config.new(**@plug_init, gem: GEM_NAME, name: PROGRAM_NAME, help: DOC_URL, version: Cli::VERSION)
+        @plug_init[:config] = Plugins::Config.new(**@plug_init, man_header: false)
         @plug_init[:persistency] = @plug_init[:config].persistency
         # data persistency
         Aspera.assert(@plug_init[:persistency]){'missing persistency object'}
         # the TransferAgent plugin may use the @preset parser
         @plug_init[:config].transfer = @plug_init[:transfer] = TransferAgent.new(options, config)
+        # add commands for config plugin after all options have been added
+        @plug_init[:config].add_manual_header(false)
         nil_keys = @plug_init.select{|_, value|value.nil?}.keys
         Aspera.assert(nil_keys.empty?){"nil : #{nil_keys}"}
         Log.log.debug('plugin env created'.red)
@@ -123,23 +125,23 @@ module Aspera
         t = ' ' * 8
         return <<~END_OF_BANNER
           NAME
-          #{t}#{PROGRAM_NAME} -- a command line tool for Aspera Applications (v#{Cli::VERSION})
+          #{t}#{Info::CMD_NAME} -- a command line tool for Aspera Applications (v#{Cli::VERSION})
 
           SYNOPSIS
-          #{t}#{PROGRAM_NAME} COMMANDS [OPTIONS] [ARGS]
+          #{t}#{Info::CMD_NAME} COMMANDS [OPTIONS] [ARGS]
 
           DESCRIPTION
           #{t}Use Aspera application to perform operations on command line.
-          #{t}Documentation and examples: #{GEM_URL}
-          #{t}execute: #{PROGRAM_NAME} conf doc
-          #{t}or visit: #{DOC_URL}
-          #{t}source repo: #{SRC_URL}
+          #{t}Documentation and examples: #{Info::GEM_URL}
+          #{t}execute: #{Info::CMD_NAME} conf doc
+          #{t}or visit: #{Info::DOC_URL}
+          #{t}source repo: #{Info::SRC_URL}
 
           ENVIRONMENT VARIABLES
           #{t}Any option can be set as an environment variable, refer to the manual
 
           COMMANDS
-          #{t}To list first level commands, execute: #{PROGRAM_NAME}
+          #{t}To list first level commands, execute: #{Info::CMD_NAME}
           #{t}Note that commands can be written shortened (provided it is unique).
 
           OPTIONS
@@ -199,16 +201,17 @@ module Aspera
 
       def exit_with_usage(include_all_plugins)
         Log.log.debug{"exit_with_usage(#{include_all_plugins})".bg_red}
-        # display main plugin options
+        # display main plugin options (+config)
         formatter.display_message(:error, options.parser)
         if include_all_plugins
           # list plugins that have a "require" field, i.e. all but main plugin
           PluginFactory.instance.plugin_list.each do |plugin_name_sym|
+            # config was already included in the global options
             next if plugin_name_sym.eql?(COMMAND_CONFIG)
             # override main option parser with a brand new, to avoid having global options
             plugin_env = @plug_init.clone
             plugin_env[:only_manual] = true # force declaration of all options
-            plugin_env[:options] = Manager.new(PROGRAM_NAME)
+            plugin_env[:options] = Manager.new(Info::CMD_NAME)
             plugin_env[:options].parser.banner = '' # remove default banner
             get_plugin_instance_with_options(plugin_name_sym, plugin_env)
             # display generated help for plugin options
@@ -223,7 +226,7 @@ module Aspera
       # early debug for parser
       # Note: does not accept shortcuts
       def early_debug_setup
-        Log.instance.program_name = PROGRAM_NAME
+        Log.instance.program_name = Info::CMD_NAME
         @argv.each do |arg|
           case arg
           when '--' then break

data/lib/aspera/cli/manager.rb

@@ -386,6 +386,11 @@ module Aspera
         end
       end
 
+      # allows a plugin to add an argument as next argument to process
+      def unshift_next_argument(argument)
+        @unprocessed_cmd_line_arguments.unshift(argument)
+      end
+
       # check if there were unprocessed values to generate error
       def command_or_arg_empty?
         return @unprocessed_cmd_line_arguments.empty?

data/lib/aspera/cli/plugin.rb

@@ -24,10 +24,7 @@ module Aspera
 
       class << self
         def declare_generic_options(options)
-          options.declare(:query, 'Additional filter for for some commands (list/delete)', types: Hash)
-          options.declare(
-            :value, 'Value for create, update, list filter', types: Hash,
-            deprecation: '(4.14) Use positional value for create/modify or option: query for list/delete')
+          options.declare(:query, 'Additional filter for for some commands (list/delete)', types: [Hash, Array])
           options.declare(:property, 'Name of property to set (modify operation)')
           options.declare(:bulk, 'Bulk operation (only some)', values: :bool, default: :no)
           options.declare(:bfail, 'Bulk operation error handling', values: :bool, default: :yes)
@@ -36,21 +33,25 @@ module Aspera
 
       attr_accessor(*INIT_PARAMS)
 
-      def initialize(options:, transfer:, config:, formatter:, persistency:, only_manual:)
+      def initialize(options:, transfer:, config:, formatter:, persistency:, only_manual:, man_header: true)
+        # check presence in descendant of mandatory method and constant
+        Aspera.assert(respond_to?(:execute_action)){"Missing method 'execute_action' in #{self.class}"}
+        Aspera.assert(self.class.constants.include?(:ACTIONS)){"Missing constant 'ACTIONS' in #{self.class}"}
         @options = options
         @transfer = transfer
         @config = config
         @formatter = formatter
         @persistency = persistency
         @only_manual = only_manual
-        # check presence in descendant of mandatory method and constant
-        Aspera.assert(respond_to?(:execute_action)){"Missing method 'execute_action' in #{self.class}"}
-        Aspera.assert(self.class.constants.include?(:ACTIONS)){'ACTIONS shall be redefined by subclass'}
+        add_manual_header if man_header
+      end
+
+      def add_manual_header(has_options = true)
         # manual header for all plugins
         options.parser.separator('')
         options.parser.separator("COMMAND: #{self.class.name.split('::').last.downcase}")
         options.parser.separator("SUBCOMMANDS: #{self.class.const_get(:ACTIONS).map(&:to_s).sort.join(' ')}")
-        options.parser.separator('OPTIONS:')
+        options.parser.separator('OPTIONS:') if has_options
       end
 
       # @return a hash of instance variables
@@ -156,7 +157,7 @@ module Aspera
         when :create
           raise 'cannot create singleton' if is_singleton
           return do_bulk_operation(command: command, descr: 'data', fields: display_fields) do |params|
-            rest_api.create(res_class_path, params)[:data]
+            rest_api.create(res_class_path, params)
           end
         when :delete
           raise 'cannot delete singleton' if is_singleton
@@ -171,9 +172,9 @@ module Aspera
             {'id' => one_id}
           end
         when :show
-          return {type: :single_object, data: rest_api.read(one_res_path)[:data], fields: display_fields}
+          return {type: :single_object, data: rest_api.read(one_res_path), fields: display_fields}
         when :list
-          resp = rest_api.read(res_class_path, query_read_delete)
+          resp = rest_api.call(operation: 'GET', subpath: res_class_path, headers: {'Accept' => 'application/json'}, query: query_read_delete)
           return Main.result_empty if resp[:http].code == '204'
           data = resp[:data]
           # TODO: not generic : which application is this for ?
@@ -214,7 +215,7 @@ module Aspera
         return entity_command(command, rest_api, res_class_path, **opts, &block)
       end
 
-      # query parameters in URL suitable for REST list/GET and delete/DELETE
+      # query parameters in URL suitable for REST: list/GET and delete/DELETE
       def query_read_delete(default: nil)
         query = options.get_option(:query)
         # dup default, as it could be frozen
@@ -229,30 +230,15 @@ module Aspera
         return query
       end
 
-      # TODO: when deprecation of `value` is completed: remove this method, replace with options.get_option(:query)
-      # deprecation: 4.14
-      def query_option(mandatory: false, default: nil)
-        option = :value
-        value = options.get_option(option, mandatory: false)
-        if value.nil?
-          option = :query
-          value = options.get_option(option, mandatory: mandatory, default: default)
-        end
-        return value
-      end
-
       # Retrieves an extended value from command line, used for creation or modification of entities
       # @param command [Symbol] command name for error message
       # @param type [Class] expected type of value, either a Class, an Array of Class
       # @param bulk [Boolean] if true, value must be an Array of <type>
       # @param default [Object] default value if not provided
-      # TODO: when deprecation of `value` is completed: remove line with :value
       def value_create_modify(command:, description: nil, type: Hash, bulk: false, default: nil)
-        value = options.get_option(:value)
-        Log.log.warn("option `value` is deprecated. Use positional parameter for #{command}") unless value.nil?
         value = options.get_next_argument(
           "parameters for #{command}#{description.nil? ? '' : " (#{description})"}", mandatory: default.nil?,
-          validation: bulk ? Array : type) if value.nil?
+          validation: bulk ? Array : type)
         value = default if value.nil?
         unless type.nil?
           type = [type] unless type.is_a?(Array)

data/lib/aspera/cli/plugins/alee.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'aspera/api/aoc'
+require 'aspera/api/alee'
 require 'aspera/nagios'
 
 module Aspera
@@ -16,7 +16,7 @@ module Aspera
             nagios = Nagios.new
             begin
               api = Api::Alee.new(nil, nil, version: 'ping')
-              result = api.call(operation: 'GET', subpath: '')
+              result = api.call(operation: 'GET')
               raise "unexpected response: #{result[:http].body}" unless result[:http].body.eql?('pong')
               nagios.add_ok('api', 'answered ok')
             rescue StandardError => e
@@ -27,7 +27,7 @@ module Aspera
             entitlement_id = options.get_option(:username, mandatory: true)
             customer_id = options.get_option(:password, mandatory: true)
             api_metering = Api::Alee.new(entitlement_id, customer_id)
-            return {type: :single_object, data: api_metering.read('entitlement')[:data]}
+            return {type: :single_object, data: api_metering.read('entitlement')}
           end
         end
       end