aspera-cli 4.11.0 → 4.12.0

data/lib/aspera/cli/main.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'aspera/cli/manager'
-require 'aspera/cli/formater'
+require 'aspera/cli/formatter'
 require 'aspera/cli/plugins/config'
 require 'aspera/cli/extended_value'
 require 'aspera/cli/transfer_agent'
@@ -81,13 +81,13 @@ module Aspera
 
       def option_ui=(value); OpenApplication.instance.url_method = value; end
 
-      # called everytime a new REST HTTP session is opened
+      # called every time a new REST HTTP session is opened
       # @param http [Net::HTTP] the newly created http session object
       def http_parameters=(http)
         if @option_insecure
           url = http.inspect.gsub(/^[^ ]* /, 'https://').gsub(/ [^ ]*$/, '')
           if !@ssl_warned_urls.include?(url)
-            @plugin_env[:formater].display_message(:error, "#{WARNING_FLASH} ignoring certificate for: #{url}. Do not use unsafe certificates in production.")
+            @formatter.display_message(:error, "#{WARNING_FLASH} ignoring certificate for: #{url}. Do not use unsafe certificates in production.")
             @ssl_warned_urls.push(url)
           end
           http.verify_mode = SELF_SIGNED_CERT
@@ -113,7 +113,7 @@ module Aspera
         early_debug_setup(argv)
         # compare $0 with expected name
         current_prog_name = File.basename($PROGRAM_NAME)
-        @plugin_env[:formater].display_message(:error, "#{'WARNING'.bg_red.blink.gray} Please use '#{PROGRAM_NAME}' instead of '#{current_prog_name}'") \
+        @formatter.display_message(:error, "#{'WARNING'.bg_red.blink.gray} Please use '#{PROGRAM_NAME}' instead of '#{current_prog_name}'") \
           unless current_prog_name.eql?(PROGRAM_NAME)
         @option_help = false
         @bash_completion = false
@@ -128,7 +128,7 @@ module Aspera
         # give command line arguments to option manager
         @plugin_env[:options] = @opt_mgr = Manager.new(PROGRAM_NAME, argv: argv)
         # formatter adds options
-        @plugin_env[:formater] = Formater.new(@plugin_env[:options])
+        @formatter = @plugin_env[:formatter] = Formatter.new(@plugin_env[:options])
         Rest.user_agent = PROGRAM_NAME
         Rest.session_cb = lambda{|http|self.http_parameters = http}
         # declare and parse global options
@@ -191,7 +191,7 @@ module Aspera
         @opt_mgr.add_opt_switch(:bash_comp, 'generate bash completion for command') { @bash_completion = true }
         @opt_mgr.add_opt_switch(:show_config, 'Display parameters used for the provided action.') { @option_show_config = true }
         @opt_mgr.add_opt_switch(:rest_debug, '-r', 'more debug for HTTP calls') { @option_rest_debug = true }
-        @opt_mgr.add_opt_switch(:version, '-v', 'display version') { @plugin_env[:formater].display_message(:data, Aspera::Cli::VERSION); Process.exit(0) } # rubocop:disable Style/Semicolon, Layout/LineLength
+        @opt_mgr.add_opt_switch(:version, '-v', 'display version') { @formatter.display_message(:data, Aspera::Cli::VERSION); Process.exit(0) } # rubocop:disable Style/Semicolon, Layout/LineLength
         @opt_mgr.add_opt_switch(:warnings, '-w', 'check for language warnings') { $VERBOSE = true }
         # handler must be set before declaration
         @opt_mgr.set_obj_attr(:log_level, Log.instance, :level)
@@ -203,7 +203,7 @@ module Aspera
         @opt_mgr.set_obj_attr(:cache_tokens, self, :option_cache_tokens)
         @opt_mgr.add_opt_list(:ui, OpenApplication.user_interfaces, 'method to start browser')
         @opt_mgr.add_opt_list(:log_level, Log.levels, 'Log level')
-        @opt_mgr.add_opt_list(:logger, Log.logtypes, 'log method')
+        @opt_mgr.add_opt_list(:logger, Log::LOG_TYPES, 'logging method')
         @opt_mgr.add_opt_simple(:lock_port, 'prevent dual execution of a command, e.g. in cron')
         @opt_mgr.add_opt_simple(:http_options, 'options for http socket (extended value)')
         @opt_mgr.add_opt_boolean(:insecure, 'do not validate HTTPS certificate')
@@ -223,7 +223,7 @@ module Aspera
         env ||= @plugin_env
         Log.log.debug{"get_plugin_instance_with_options(#{plugin_name_sym})"}
         require @plugin_env[:config].plugins[plugin_name_sym][:require_stanza]
-        # load default params only if no param already loaded before plugin instanciation
+        # load default params only if no param already loaded before plugin instantiation
         env[:config].add_plugin_default_preset(plugin_name_sym)
         command_plugin = Plugins::Config.plugin_class(plugin_name_sym).new(env)
         Log.log.debug{"got #{command_plugin.class}"}
@@ -243,7 +243,7 @@ module Aspera
       def exit_with_usage(all_plugins)
         Log.log.debug('exit_with_usage'.bg_red)
         # display main plugin options
-        @plugin_env[:formater].display_message(:error, @opt_mgr.parser)
+        @formatter.display_message(:error, @opt_mgr.parser)
         if all_plugins
           # list plugins that have a "require" field, i.e. all but main plugin
           @plugin_env[:config].plugins.each_key do |plugin_name_sym|
@@ -255,7 +255,7 @@ module Aspera
             plugin_env[:options].parser.banner = '' # remove default banner
             get_plugin_instance_with_options(plugin_name_sym, plugin_env)
             # display generated help for plugin options
-            @plugin_env[:formater].display_message(:error, plugin_env[:options].parser.help)
+            @formatter.display_message(:error, plugin_env[:options].parser.help)
           end
         end
         Process.exit(0)
@@ -300,7 +300,7 @@ module Aspera
             end
           # command will not be executed, but we need manual
           @opt_mgr.fail_on_missing_mandatory = false if @option_help || @option_show_config
-          # main plugin is not dynamically instanciated
+          # main plugin is not dynamically instantiated
           case command_sym
           when :help
             exit_with_usage(true)
@@ -315,7 +315,7 @@ module Aspera
           # help requested for current plugin
           exit_with_usage(false) if @option_help
           if @option_show_config
-            @plugin_env[:formater].display_results({type: :single_object, data: @opt_mgr.declared_options(only_defined: true)})
+            @formatter.display_results({type: :single_object, data: @opt_mgr.declared_options(only_defined: true)})
             execute_command = false
           end
           # locking for single execution (only after "per plugin" option, in case lock port is there)
@@ -331,7 +331,7 @@ module Aspera
             end
           end
           # execute and display (if not exclusive execution)
-          @plugin_env[:formater].display_results(command_plugin.execute_action) if execute_command
+          @formatter.display_results(command_plugin.execute_action) if execute_command
           # finish
           @plugin_env[:transfer].shutdown
         rescue Net::SSH::AuthenticationFailed => e; exception_info = {e: e, t: 'SSH', security: true}
@@ -349,17 +349,17 @@ module Aspera
         # 1- processing of error condition
         unless exception_info.nil?
           Log.log.warn(exception_info[:e].message) if Aspera::Log.instance.logger_type.eql?(:syslog) && exception_info[:security]
-          @plugin_env[:formater].display_message(:error, "#{ERROR_FLASH} #{exception_info[:t]}: #{exception_info[:e].message}")
-          @plugin_env[:formater].display_message(:error, 'Use option -h to get help.') if exception_info[:usage]
+          @formatter.display_message(:error, "#{ERROR_FLASH} #{exception_info[:t]}: #{exception_info[:e].message}")
+          @formatter.display_message(:error, 'Use option -h to get help.') if exception_info[:usage]
           if exception_info[:e].is_a?(Fasp::Error) && exception_info[:e].message.eql?('Remote host is not who we expected')
-            @plugin_env[:formater].display_message(:error, "For this specific error, refer to:\n"\
+            @formatter.display_message(:error, "For this specific error, refer to:\n"\
               "#{SRC_URL}#error-remote-host-is-not-who-we-expected\nAdd this to arguments:\n--ts=@json:'{\"sshfp\":null}'")
           end
         end
         # 2- processing of command not processed (due to exception or bad command line)
         if execute_command || @option_show_config
           @opt_mgr.final_errors.each do |msg|
-            @plugin_env[:formater].display_message(:error, "#{ERROR_FLASH} Argument: #{msg}")
+            @formatter.display_message(:error, "#{ERROR_FLASH} Argument: #{msg}")
             # add code as exception if there is not already an error
             exception_info = {e: Exception.new(msg), t: 'UnusedArg'} if exception_info.nil?
           end
@@ -369,7 +369,7 @@ module Aspera
           # show stack trace in debug mode
           raise exception_info[:e] if Log.instance.level.eql?(:debug)
           # else give hint and exit
-          @plugin_env[:formater].display_message(:error, 'Use --log-level=debug to get more details.') if exception_info[:debug]
+          @formatter.display_message(:error, 'Use --log-level=debug to get more details.') if exception_info[:debug]
           Process.exit(1)
         end
         return nil

data/lib/aspera/cli/manager.rb

@@ -47,7 +47,7 @@ module Aspera
       BOOLEAN_SIMPLE = %i[no yes].freeze
       FALSE_VALUES = [BOOLEAN_SIMPLE.first, false].freeze
       TRUE_VALUES = [BOOLEAN_SIMPLE.last, true].freeze
-      BOOLEAN_VALUES = [].concat(TRUE_VALUES, FALSE_VALUES).freeze
+      BOOLEAN_VALUES = [TRUE_VALUES, FALSE_VALUES].flatten.freeze
 
       # option name separator on command line
       OPTION_SEP_LINE = '-'
@@ -73,7 +73,7 @@ module Aspera
           return matching_exact.first if matching_exact.length == 1
           matching = allowed_values.select{|i| i.to_s.start_with?(shortval)}
           raise CliBadArgument, bad_arg_message_multi("unknown value for #{descr}: #{shortval}", allowed_values) if matching.empty?
-          raise CliBadArgument, bad_arg_message_multi("ambigous shortcut for #{descr}: #{shortval}", matching) unless matching.length.eql?(1)
+          raise CliBadArgument, bad_arg_message_multi("ambiguous shortcut for #{descr}: #{shortval}", matching) unless matching.length.eql?(1)
           return enum_to_bool(matching.first) if allowed_values.eql?(BOOLEAN_VALUES)
           return matching.first
         end
@@ -104,10 +104,10 @@ module Aspera
         # those must be set before parse, parse consumes those defined only
         @unprocessed_defaults = []
         @unprocessed_env = []
-        # NOTE: was initially inherited but it is prefered to have specific methods
+        # NOTE: was initially inherited but it is preferred to have specific methods
         @parser = OptionParser.new
         @parser.program_name = program_name
-        # options can also be provided by env vars : --param-name -> ASLMCLI_PARAM_NAME
+        # options can also be provided by env vars : --param-name -> ASCLI_PARAM_NAME
         env_prefix = program_name.upcase + OPTION_SEP_NAME
         ENV.each do |k, v|
           if k.start_with?(env_prefix)
@@ -186,7 +186,7 @@ module Aspera
       def declare_option(option_symbol, type)
         Log.log.debug{"declare_option: #{option_symbol}: #{type}: skip=#{@declared_options.key?(option_symbol)}".green}
         if @declared_options.key?(option_symbol)
-          raise "INTERNAL ERROR: option #{option_symbol} already declared. only accessor can be redeclared and ignored" \
+          raise "INTERNAL ERROR: option #{option_symbol} already declared. only accessor can be re-declared and ignored" \
           unless @declared_options[option_symbol][:type].eql?(:accessor)
           return
         end

data/lib/aspera/cli/plugin.rb

@@ -8,7 +8,7 @@ module Aspera
       GLOBAL_OPS = %i[create list].freeze
       # operations with id
       INSTANCE_OPS = %i[modify delete show].freeze
-      ALL_OPS = [].concat(GLOBAL_OPS, INSTANCE_OPS).freeze
+      ALL_OPS = [GLOBAL_OPS, INSTANCE_OPS].flatten.freeze
       # max number of items for list command
       MAX_ITEMS = 'max'
       # max number of pages for list command
@@ -16,8 +16,6 @@ module Aspera
       # used when all resources are selected
       VAL_ALL = 'ALL'
 
-      # AGENTS=%i[options transfer config formater persistency].freeze
-
       # global for inherited classes
       @@options_created = false # rubocop:disable Style/ClassVars
 
@@ -96,9 +94,10 @@ module Aspera
       # @param res_class_path [String] sub path in URL to resource relative to base url
       # @param display_fields [Array] fields to display by default
       # @param id_default [String] default identifier to use for existing entity commands (show, modify)
-      # @param item_list_key [String] result is in a subkey of the json
+      # @param item_list_key [String] result is in a sub key of the json
+      # @param id_as_arg [String] if set, the id is provided as url argument ?<id_as_arg>=<id>
       # @return result suitable for CLI result
-      def entity_command(command, rest_api, res_class_path, display_fields: nil, id_default: nil, item_list_key: false)
+      def entity_command(command, rest_api, res_class_path, display_fields: nil, id_default: nil, item_list_key: false, id_as_arg: false)
         if INSTANCE_OPS.include?(command)
           begin
             one_res_id = instance_identifier
@@ -107,13 +106,14 @@ module Aspera
             one_res_id = id_default
           end
           one_res_path = "#{res_class_path}/#{one_res_id}"
+          one_res_path = "#{res_class_path}?#{id_as_arg}=#{one_res_id}" if id_as_arg
         end
         # parameters mandatory for create/modify
         if %i[create modify].include?(command)
           parameters = options.get_option(:value, is_type: :mandatory)
         end
         # parameters optional for list
-        if [:list].include?(command)
+        if %i[list delete].include?(command)
           parameters = options.get_option(:value)
         end
         case command
@@ -124,7 +124,7 @@ module Aspera
           end
         when :delete
           return do_bulk_operation(one_res_id, 'deleted') do |one_id|
-            rest_api.delete("#{res_class_path}/#{one_id}")
+            rest_api.delete("#{res_class_path}/#{one_id}", parameters)
             {'id' => one_id}
           end
         when :show
@@ -134,6 +134,7 @@ module Aspera
           data = resp[:data]
           # TODO: not generic : which application is this for ?
           if resp[:http]['Content-Type'].start_with?('application/vnd.api+json')
+            Log.log.debug{'is vnd.api'}
             data = data[res_class_path]
           end
           if item_list_key
@@ -142,12 +143,19 @@ module Aspera
             if !total_count.nil?
               count_msg = "Items: #{item_list.length}/#{total_count}"
               count_msg = count_msg.bg_red unless item_list.length.eql?(total_count.to_i)
-              self.format.display_status(count_msg)
+              formatter.display_status(count_msg)
             end
             data = item_list
           end
-          return {type: :object_list, data: data, fields: display_fields} if data.empty? || data.first.is_a?(Hash)
-          return {type: :value_list, data: data, name: 'id'}
+          case data
+          when Hash
+            return {type: :single_object, data: data, fields: display_fields}
+          when Array
+            return {type: :object_list, data: data, fields: display_fields} if data.empty? || data.first.is_a?(Hash)
+            return {type: :value_list, data: data, name: 'id'}
+          else
+            raise "An error occurred: unexpected result type for list: #{data.class}"
+          end
         when :modify
           property = options.get_option(:property)
           parameters = {property => parameters} unless property.nil?
@@ -168,7 +176,8 @@ module Aspera
       # query for list operation
       def option_url_query(default)
         query = options.get_option(:query)
-        query = default if query.nil?
+        # dup default, as it could be frozen
+        query = default.dup if query.nil?
         Log.log.debug{"Query=#{query}".bg_red}
         begin
           # check it is suitable
@@ -180,15 +189,9 @@ module Aspera
       end
 
       # shortcuts helpers for plugin environment
-      def options; return @agents[:options]; end
-
-      def transfer; return @agents[:transfer]; end
-
-      def config; return @agents[:config]; end
-
-      def format; return @agents[:formater]; end
-
-      def persistency; return @agents[:persistency]; end
+      %i[options transfer config formatter persistency].each do |name|
+        define_method(name){@agents[name]}
+      end
     end # Plugin
   end # Cli
 end # Aspera