aspera-cli 4.19.0 → 4.21.1

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

@@ -9,11 +9,10 @@ require 'aspera/cli/formatter'
 require 'aspera/cli/info'
 require 'aspera/cli/transfer_progress'
 require 'aspera/ascp/installation'
-require 'aspera/ascp/products'
+require 'aspera/products/transferd'
 require 'aspera/transfer/error_info'
 require 'aspera/transfer/parameters'
 require 'aspera/transfer/spec'
-require 'aspera/keychain/encrypted_hash'
 require 'aspera/keychain/macos_security'
 require 'aspera/proxy_auto_config'
 require 'aspera/environment'
@@ -54,18 +53,17 @@ module Aspera
         PERSISTENCY_FOLDER = 'persist_store'
         ASPERA = 'aspera'
         SERVER_COMMAND = 'server'
-        APP_NAME_SDK = 'sdk'
+        DIR_SDK = 'sdk'
         CONNECT_WEB_URL = 'https://d3gcli72yxqn2z.cloudfront.net/connect'
         CONNECT_VERSIONS = 'connectversions.js' # cspell: disable-line
-        TRANSFER_SDK_ARCHIVE_URL = 'https://ibm.biz/aspera_transfer_sdk'
         DEMO_SERVER = 'demo'
         DEMO_PRESET = 'demoserver' # cspell: disable-line
         EMAIL_TEST_TEMPLATE = <<~END_OF_TEMPLATE
           From: <%=from_name%> <<%=from_email%>>
           To: <<%=to%>>
-          Subject: #{GEM_NAME} email test
+          Subject: #{Info::GEM_NAME} email test
 
-          This email was sent to test #{PROGRAM_NAME}.
+          This email was sent to test #{Info::CMD_NAME}.
         END_OF_TEMPLATE
         # special extended values
         EXTEND_PRESET = :preset
@@ -79,6 +77,7 @@ module Aspera
         GEM_CHECK_DATE_FMT = '%Y/%m/%d'
         # for testing only
         SELF_SIGNED_CERT = OpenSSL::SSL.const_get(:enon_yfirev.to_s.upcase.reverse) # cspell: disable-line
+        CONF_OVERVIEW_KEYS = %w[preset parameter value].freeze
         private_constant :DEFAULT_CONFIG_FILENAME,
           :CONF_PRESET_CONFIG,
           :CONF_PRESET_VERSION,
@@ -86,7 +85,6 @@ module Aspera
           :CONF_PRESET_GLOBAL,
           :ASPERA_PLUGINS_FOLDERNAME,
           :ASPERA,
-          :TRANSFER_SDK_ARCHIVE_URL,
           :DEMO_SERVER,
           :DEMO_PRESET,
           :EMAIL_TEST_TEMPLATE,
@@ -100,7 +98,8 @@ module Aspera
           :WIZARD_RESULT_KEYS,
           :SELF_SIGNED_CERT,
           :PERSISTENCY_FOLDER,
-          :DEFAULT_PRIV_KEY_LENGTH
+          :DEFAULT_PRIV_KEY_LENGTH,
+          :CONF_OVERVIEW_KEYS
 
         class << self
           def generate_rsa_private_key(path:, length: DEFAULT_PRIV_KEY_LENGTH)
@@ -126,8 +125,8 @@ module Aspera
           end
 
           # deep clone hash so that it does not get modified in case of display and secret hide
-          def protect_presets(val)
-            return JSON.parse(JSON.generate(val))
+          def deep_clone(val)
+            return Marshal.load(Marshal.dump(val))
           end
 
           # return product family folder (~/.aspera)
@@ -145,13 +144,9 @@ module Aspera
           end
         end
 
-        def initialize(gem:, name:, help:, version:, **env)
+        def initialize(**env)
           # we need to defer parsing of options until we have the config file, so we can use @extend with @preset
-          super(**env)
-          @gem = gem
-          @name = name
-          @help = help
-          @version = version
+          super
           @use_plugin_defaults = true
           @config_presets = nil
           @config_checksum_on_disk = nil
@@ -177,9 +172,9 @@ module Aspera
             :home, 'Home folder for tool',
             handler: {o: self, m: :main_folder},
             types: String,
-            default: self.class.default_app_main_folder(app_name: @name))
+            default: self.class.default_app_main_folder(app_name: Info::CMD_NAME))
           options.parse_options!
-          Log.log.debug{"#{@name} folder: #{@main_folder}"}
+          Log.log.debug{"#{Info::CMD_NAME} folder: #{@main_folder}"}
           # data persistency manager, created by config plugin
           @persistency = PersistencyFolder.new(File.join(@main_folder, PERSISTENCY_FOLDER))
           # set folders for plugin lookup
@@ -218,8 +213,8 @@ module Aspera
           # Transfer SDK options
           options.declare(:ascp_path, 'Path to ascp', handler: {o: Ascp::Installation.instance, m: :ascp_path})
           options.declare(:use_product, 'Use ascp from specified product', handler: {o: self, m: :option_use_product})
-          options.declare(:sdk_url, 'URL to get SDK', default: TRANSFER_SDK_ARCHIVE_URL)
-          options.declare(:sdk_folder, 'SDK folder path', handler: {o: Ascp::Installation.instance, m: :sdk_folder})
+          options.declare(:sdk_url, 'URL to get SDK', default: SpecialValues::DEF)
+          options.declare(:sdk_folder, 'SDK folder path', handler: {o: Products::Transferd, m: :sdk_directory})
           options.declare(:progress_bar, 'Display progress bar', values: :bool, default: Environment.terminal?)
           # email options
           options.declare(:smtp, 'SMTP configuration', types: Hash)
@@ -234,26 +229,26 @@ module Aspera
           options.declare(:http_proxy, 'URL for HTTP proxy with optional credentials', types: String, handler: {o: self, m: :option_http_proxy})
           options.declare(:cache_tokens, 'Save and reuse OAuth tokens', values: :bool, handler: {o: self, m: :option_cache_tokens})
           options.declare(:fpac, 'Proxy auto configuration script')
-          options.declare(:proxy_credentials, 'HTTP proxy credentials for fpac. Array: user,password', types: Array)
+          options.declare(:proxy_credentials, 'HTTP proxy credentials for fpac: user, password', types: Array)
           options.parse_options!
           @progress_bar = TransferProgress.new if options.get_option(:progress_bar)
           # Check SDK folder is set or not, for compatibility, we check in two places
-          sdk_folder = Ascp::Installation.instance.sdk_folder rescue nil
-          if sdk_folder.nil?
+          sdk_dir = Products::Transferd.sdk_directory rescue nil
+          if sdk_dir.nil?
             @sdk_default_location = true
             Log.log.debug('SDK folder is not set, checking default')
             # new location
-            sdk_folder = self.class.default_app_main_folder(app_name: APP_NAME_SDK)
-            Log.log.debug{"checking: #{sdk_folder}"}
-            if !Dir.exist?(sdk_folder)
-              Log.log.debug{"not exists: #{sdk_folder}"}
+            sdk_dir = self.class.default_app_main_folder(app_name: DIR_SDK)
+            Log.log.debug{"checking: #{sdk_dir}"}
+            if !Dir.exist?(sdk_dir)
+              Log.log.debug{"not exists: #{sdk_dir}"}
               # former location
-              former_sdk_folder = File.join(self.class.default_app_main_folder(app_name: @name), APP_NAME_SDK)
+              former_sdk_folder = File.join(self.class.default_app_main_folder(app_name: Info::CMD_NAME), DIR_SDK)
               Log.log.debug{"checking: #{former_sdk_folder}"}
-              sdk_folder = former_sdk_folder if Dir.exist?(former_sdk_folder)
+              sdk_dir = former_sdk_folder if Dir.exist?(former_sdk_folder)
             end
-            Log.log.debug{"using: #{sdk_folder}"}
-            Ascp::Installation.instance.sdk_folder = sdk_folder
+            Log.log.debug{"using: #{sdk_dir}"}
+            Products::Transferd.sdk_directory = sdk_dir
           end
           pac_script = options.get_option(:fpac)
           # create PAC executor
@@ -266,11 +261,16 @@ module Aspera
               @pac_exec.proxy_pass = proxy_user_pass[1]
             end
           end
-          Rest.set_parameters(
-            user_agent:  PROGRAM_NAME,
-            session_cb:  lambda{|http_session|update_http_session(http_session)},
-            progress_bar: @progress_bar)
+          RestParameters.instance.user_agent = Info::CMD_NAME
+          RestParameters.instance.progress_bar = @progress_bar
+          RestParameters.instance.session_cb = lambda{|http_session|update_http_session(http_session)}
+          @option_http_options.keys.select{|i|RestParameters.instance.respond_to?(i)}.each do |k|
+            method = "#{k}=".to_sym
+            RestParameters.instance.send(method, @option_http_options[k])
+            @option_http_options.delete(k)
+          end
           OAuth::Factory.instance.persist_mgr = persistency if @option_cache_tokens
+          OAuth::Web.additionnal_info = "#{Info::CMD_NAME} v#{Cli::VERSION}"
           Transfer::Parameters.file_list_folder = File.join(@main_folder, 'filelists')
           RestErrorAnalyzer.instance.log_file = File.join(@main_folder, 'rest_exceptions.log')
           # register aspera REST call error handlers
@@ -394,19 +394,19 @@ module Aspera
         def check_gem_version
           latest_version =
             begin
-              Rest.new(base_url: 'https://rubygems.org/api/v1').read("versions/#{@gem}/latest.json")[:data]['version']
+              Rest.new(base_url: 'https://rubygems.org/api/v1').read("versions/#{Info::GEM_NAME}/latest.json")['version']
             rescue StandardError
               Log.log.warn('Could not retrieve latest gem version on rubygems.')
               '0'
             end
-          if Gem::Version.new(Environment.ruby_version) < Gem::Version.new(RUBY_FUTURE_MINIMUM_VERSION)
+          if Gem::Version.new(Environment.ruby_version) < Gem::Version.new(Info::RUBY_FUTURE_MINIMUM_VERSION)
             Log.log.warn do
-              "Note that a future version will require Ruby version #{RUBY_FUTURE_MINIMUM_VERSION} at minimum, " \
+              "Note that a future version will require Ruby version #{Info::RUBY_FUTURE_MINIMUM_VERSION} at minimum, " \
                 "you are using #{Environment.ruby_version}"
             end
           end
           return {
-            name:        @gem,
+            name:        Info::GEM_NAME,
             current:     Cli::VERSION,
             latest:      latest_version,
             need_update: Gem::Version.new(Cli::VERSION) < Gem::Version.new(latest_version)
@@ -415,7 +415,7 @@ module Aspera
 
         def periodic_check_newer_gem_version
           # get verification period
-          delay_days = options.get_option(:version_check_days, mandatory: true)
+          delay_days = options.get_option(:version_check_days, mandatory: true).to_i
           # check only if not zero day
           return if delay_days.eql?(0)
           # get last date from persistency
@@ -522,7 +522,7 @@ module Aspera
             current = current[name]
             raise Cli::Error, "No such config preset: #{include_path}" if current.nil?
           end
-          current = self.class.protect_presets(current) unless current.is_a?(String)
+          current = self.class.deep_clone(current) unless current.is_a?(String)
           return ExtendedValue.instance.evaluate(current)
         end
 
@@ -592,7 +592,7 @@ module Aspera
           @config_presets[CONF_PRESET_DEFAULTS].delete(true) if @config_presets[CONF_PRESET_DEFAULTS].is_a?(Hash)
           # ^^^ Place new compatibility code before this line
           # set version to current
-          @config_presets[CONF_PRESET_CONFIG][CONF_PRESET_VERSION] = @version
+          @config_presets[CONF_PRESET_CONFIG][CONF_PRESET_VERSION] = Cli::VERSION
           unless files_to_copy.empty?
             Log.log.warn('Copying referenced files')
             files_to_copy.each do |file|
@@ -607,7 +607,7 @@ module Aspera
           Log.log.debug{"-> #{e.class.name} : #{e}"}
           if File.exist?(@option_config_file)
             # then there is a problem with that file.
-            new_name = "#{@option_config_file}.pre#{@version}.manual_conversion_needed"
+            new_name = "#{@option_config_file}.pre#{Cli::VERSION}.manual_conversion_needed"
             File.rename(@option_config_file, new_name)
             Log.log.warn{"Renamed config file to #{new_name}."}
             Log.log.warn('Manual Conversion is required. Next time, a new empty file will be created.')
@@ -664,10 +664,10 @@ module Aspera
           end
           case command
           when :list
-            return {type: :object_list, data: connect_versions, fields: %w[id title version]}
+            return Main.result_object_list(connect_versions, fields: %w[id title version])
           when :info
             one_res.delete('links')
-            return {type: :single_object, data: one_res}
+            return Main.result_single_object(one_res)
           when :version
             all_links = one_res['links']
             command = options.get_next_command(%i[list download open])
@@ -678,10 +678,9 @@ module Aspera
             end
             case command
             when :list
-              return {type: :object_list, data: all_links}
+              return Main.result_object_list(all_links)
             when :download
               folder_dest = transfer.destination_folder(Transfer::Spec::DIRECTION_RECEIVE)
-              # folder_dest=self.options.get_next_argument('destination folder')
               api_connect_cdn = Rest.new(base_url: CONNECT_WEB_URL)
               file_url = one_link['href']
               filename = file_url.gsub(%r{.*/}, '')
@@ -701,11 +700,12 @@ module Aspera
             return execute_connect_action
           when :use
             ascp_path = options.get_next_argument('path to ascp')
+            Ascp::Installation.instance.ascp_path = ascp_path
             formatter.display_status("ascp version: #{Ascp::Installation.instance.get_ascp_version(ascp_path)}")
             set_global_default(:ascp_path, ascp_path)
             return Main.result_nothing
           when :show
-            return {type: :status, data: Ascp::Installation.instance.path(:ascp)}
+            return Main.result_status(Ascp::Installation.instance.path(:ascp))
           when :info
             # collect info from ascp executable
             data = Ascp::Installation.instance.ascp_info
@@ -714,13 +714,13 @@ module Aspera
             # add keys
             DataRepository::ELEMENTS.each_with_object(data){|i, h|h[i.to_s] = DataRepository.instance.item(i)}
             # declare those as secrets
-            SecretHider::ADDITIONAL_KEYS_TO_HIDE.push(*DataRepository::ELEMENTS.map(&:to_s))
-            return {type: :single_object, data: data}
+            SecretHider::ADDITIONAL_KEYS_TO_HIDE.concat(DataRepository::ELEMENTS.map(&:to_s))
+            return Main.result_single_object(data)
           when :products
             command = options.get_next_command(%i[list use])
             case command
             when :list
-              return {type: :object_list, data: Ascp::Products.installed_products, fields: %w[name app_root]}
+              return Main.result_object_list(Ascp::Installation.instance.installed_products, fields: %w[name app_root])
             when :use
               default_product = options.get_next_argument('product name')
               Ascp::Installation.instance.use_ascp_from_product(default_product)
@@ -729,23 +729,44 @@ module Aspera
             end
           when :install
             # reset to default location, if older default was used
-            Ascp::Installation.instance.sdk_folder = self.class.default_app_main_folder(app_name: APP_NAME_SDK) if @sdk_default_location
-            n, v = Ascp::Installation.instance.install_sdk(options.get_option(:sdk_url, mandatory: true))
+            Products::Transferd.sdk_directory = self.class.default_app_main_folder(app_name: DIR_SDK) if @sdk_default_location
+            version = options.get_next_argument('transferd version', mandatory: false)
+            n, v = Ascp::Installation.instance.install_sdk(url: options.get_option(:sdk_url, mandatory: true), version: version)
             return Main.result_status("Installed #{n} version #{v}")
           when :spec
-            return {
-              type:   :object_list,
-              data:   Transfer::Parameters.man_table(formatter),
+            return Main.result_object_list(
+              Transfer::Parameters.man_table(formatter),
               fields: [%w[name type], Transfer::Parameters::SUPPORTED_AGENTS_SHORT.map(&:to_s), %w[description]].flatten.freeze
-            }
+            )
           when :errors
             error_data = []
             Transfer::ERROR_INFO.each_pair do |code, prop|
               error_data.push(code: code, mnemonic: prop[:c], retry: prop[:r], info: prop[:a])
             end
-            return {type: :object_list, data: error_data}
+            return Main.result_object_list(error_data)
+          else Aspera.error_unexpected_value(command)
+          end
+          Aspera.error_unreachable_line
+        end
+
+        def execute_action_transferd
+          command = options.get_next_command(%i[list install])
+          case command
+          when :install
+            # reset to default location, if older default was used
+            Products::Transferd.sdk_directory = self.class.default_app_main_folder(app_name: DIR_SDK) if @sdk_default_location
+            version = options.get_next_argument('transferd version', mandatory: false)
+            n, v = Ascp::Installation.instance.install_sdk(url: options.get_option(:sdk_url, mandatory: true), version: version)
+            return Main.result_status("Installed #{n} version #{v}")
+          when :list
+            sdk_list = Ascp::Installation.sdk_locations
+            return Main.result_object_list(
+              sdk_list,
+              fields: sdk_list.first.keys - ['url']
+            )
+          else Aspera.error_unexpected_value(command)
           end
-          raise "unexpected case: #{command}"
+          Aspera.error_unreachable_line
         end
 
         # legacy actions available globally
@@ -764,12 +785,20 @@ module Aspera
           raise "no such preset: #{name}" if PRESET_EXIST_ACTIONS.include?(action) && !@config_presets.key?(name)
           case action
           when :list
-            return {type: :value_list, data: @config_presets.keys, name: 'name'}
+            return Main.result_value_list(@config_presets.keys, 'name')
           when :overview
             # display process modifies the value (hide secrets): we do not want to save removed secrets
-            return {type: :config_over, data: self.class.protect_presets(@config_presets)}
+            data = self.class.deep_clone(@config_presets)
+            formatter.hide_secrets(data)
+            result = []
+            data.each do |config, preset|
+              preset.each do |parameter, value|
+                result.push(CONF_OVERVIEW_KEYS.zip([config, parameter, value]).to_h)
+              end
+            end
+            return Main.result_object_list(result, fields: CONF_OVERVIEW_KEYS)
           when :show
-            return {type: :single_object, data: self.class.protect_presets(@config_presets[name])}
+            return Main.result_single_object(self.class.deep_clone(@config_presets[name]))
           when :delete
             @config_presets.delete(name)
             return Main.result_status("Deleted: #{name}")
@@ -780,7 +809,7 @@ module Aspera
             case value
             when Numeric, String then return {type: :text, data: ExtendedValue.instance.evaluate(value.to_s)}
             end
-            return {type: :single_object, data: value}
+            return Main.result_single_object(value)
           when :unset
             param_name = options.get_next_argument('parameter name')
             @config_presets[name].delete(param_name)
@@ -819,7 +848,7 @@ module Aspera
             user = options.get_option(:username, mandatory: true)
             result = lookup_preset(url: url, username: user)
             raise 'no such config found' if result.nil?
-            return {type: :single_object, data: result}
+            return Main.result_single_object(result)
           when :secure
             identifier = options.get_next_argument('config name', mandatory: false)
             preset_names = identifier.nil? ? @config_presets.keys : [identifier]
@@ -857,13 +886,15 @@ module Aspera
           remote_certificate
           gem
           plugins
-          flush_tokens
+          tokens
           echo
+          download
           wizard
           detect
           coffee
           image
           ascp
+          transferd
           email_test
           smtp_settings
           proxy_check
@@ -872,7 +903,7 @@ module Aspera
           check_update
           initdemo
           vault
-          throw
+          test
           platform
         ].freeze
 
@@ -888,7 +919,7 @@ module Aspera
           when :documentation
             section = options.get_next_argument('private key file path', mandatory: false)
             section = "##{section}" unless section.nil?
-            Environment.instance.open_uri("#{@help}#{section}")
+            Environment.instance.open_uri("#{Info::DOC_URL}#{section}")
             return Main.result_nothing
           when :genkey # generate new rsa key
             private_key_path = options.get_next_argument('private key file path')
@@ -913,9 +944,27 @@ module Aspera
             end
           when :echo # display the content of a value given on command line
             return Formatter.auto_type(options.get_next_argument('value', validation: nil))
-          when :flush_tokens
-            deleted_files = OAuth::Factory.instance.flush_tokens
-            return {type: :value_list, data: deleted_files, name: 'file'}
+          when :download
+            file_url = options.get_next_argument('source URL').chomp
+            file_dest = options.get_next_argument('file path', mandatory: false)
+            if file_dest.nil?
+              file_dest = File.join(transfer.destination_folder(Transfer::Spec::DIRECTION_RECEIVE), file_url.gsub(%r{.*/}, ''))
+            end
+            formatter.display_status("Downloading: #{file_url}")
+            Rest.new(base_url: file_url).call(operation: 'GET', save_to_file: file_dest)
+            return Main.result_status("Saved to: #{file_dest}")
+          when :tokens
+            require 'aspera/api/node'
+            case options.get_next_command(%i{flush list show})
+            when :flush
+              return Main.result_value_list(OAuth::Factory.instance.flush_tokens, name: 'file')
+            when :list
+              return Main.result_object_list(OAuth::Factory.instance.persisted_tokens)
+            when :show
+              data = OAuth::Factory.instance.get_token_info(instance_identifier)
+              raise Cli::Error, 'No such identifier' if data.nil?
+              return Main.result_single_object(data)
+            end
           when :plugins
             case options.get_next_command(%i[list create])
             when :list
@@ -929,7 +978,7 @@ module Aspera
                   path:   PluginFactory.instance.plugin_source(name)
                 })
               end
-              return {type: :object_list, data: result, fields: %w[plugin detect wizard path]}
+              return Main.result_object_list(result, fields: %w[plugin detect wizard path])
             when :create
               plugin_name = options.get_next_argument('name').downcase
               destination_folder = options.get_next_argument('folder', mandatory: false) || File.join(@main_folder, ASPERA_PLUGINS_FOLDERNAME)
@@ -955,10 +1004,7 @@ module Aspera
             options.ask_missing_mandatory = true
             # detect plugins by url and optional query
             apps = identify_plugins_for_url.freeze
-            return {
-              type: :object_list,
-              data: apps
-            } if action.eql?(:detect)
+            return Main.result_object_list(apps) if action.eql?(:detect)
             return wizard_find(apps)
           when :coffee
             return Main.result_image(COFFEE_IMAGE, formatter: formatter)
@@ -966,11 +1012,13 @@ module Aspera
             return Main.result_image(options.get_next_argument('image uri or blob'), formatter: formatter)
           when :ascp
             execute_action_ascp
+          when :transferd
+            execute_action_transferd
           when :gem
             case options.get_next_command(%i[path version name])
             when :path then return Main.result_status(self.class.gem_src_root)
             when :version then return Main.result_status(Cli::VERSION)
-            when :name then return Main.result_status(@gem)
+            when :name then return Main.result_status(Info::GEM_NAME)
             end
           when :folder
             return Main.result_status(@main_folder)
@@ -980,14 +1028,14 @@ module Aspera
             send_email_template(email_template_default: EMAIL_TEST_TEMPLATE)
             return Main.result_nothing
           when :smtp_settings
-            return {type: :single_object, data: email_settings}
+            return Main.result_single_object(email_settings)
           when :proxy_check
             # ensure fpac was provided
             options.get_option(:fpac, mandatory: true)
             server_url = options.get_next_argument('server url')
             return Main.result_status(@pac_exec.find_proxy_for_url(server_url))
           when :check_update
-            return {type: :single_object, data: check_gem_version}
+            return Main.result_single_object(check_gem_version)
           when :initdemo
             if @config_presets.key?(DEMO_PRESET)
               Log.log.warn{"Demo server preset already present: #{DEMO_PRESET}"}
@@ -1010,14 +1058,7 @@ module Aspera
             end
             return Main.result_status('Done')
           when :vault then execute_vault
-          when :throw
-            # :type [String]
-            options
-            exception_class_name = options.get_next_argument('exception class name', mandatory: true)
-            exception_text = options.get_next_argument('exception text', mandatory: true)
-            exception_class = Object.const_get(exception_class_name)
-            Aspera.assert(exception_class <= Exception){"#{exception_class} is not an exception: #{exception_class.class}"}
-            raise exception_class, exception_text
+          when :test then return execute_test
           when :platform
             return Main.result_status(Environment.architecture)
           else Aspera.error_unreachable_line
@@ -1093,7 +1134,7 @@ module Aspera
             wiz_preset_name = elements.join('_').strip.downcase.gsub(/[^a-z0-9]/, '_').squeeze('_')
           end
           # test mode does not change conf file
-          return {type: :single_object, data: wizard_result} if options.get_option(:test_mode)
+          return Main.result_single_object(wizard_result) if options.get_option(:test_mode)
           # Write configuration file
           formatter.display_status("Preparing preset: #{wiz_preset_name}")
           # init defaults if necessary
@@ -1112,7 +1153,7 @@ module Aspera
             test_args = "-P#{wiz_preset_name} #{test_args}"
           end
           # TODO: actually test the command
-          return Main.result_status("You can test with:\n#{@name} #{identification[:product]} #{test_args}")
+          return Main.result_status("You can test with:\n#{Info::CMD_NAME} #{identification[:product]} #{test_args}")
         end
 
         # @return [Hash] email server setting with defaults if not defined
@@ -1141,6 +1182,8 @@ module Aspera
         end
 
         # send email using ERB template
+        # @param email_template_default [String] default template, can be overriden by option
+        # @param values [Hash] values to be used in template, keys with default: to, from_name, from_email
         def send_email_template(email_template_default: nil, values: {})
           values[:to] ||= options.get_option(:notify_to, mandatory: true)
           notify_template = options.get_option(:notify_template, mandatory: email_template_default.nil?) || email_template_default
@@ -1202,7 +1245,8 @@ module Aspera
               Log.log.error do
                 "Default config name [#{default_config_name}] specified for plugin [#{plugin_name_sym}], but it does not exist in config file.\n" \
                   'Please fix the issue: either create preset with one parameter: ' \
-                  "(#{@name} config id #{default_config_name} init @json:'{}') or remove default (#{@name} config id default remove #{plugin_name_sym})."
+                  "(#{Info::CMD_NAME} config id #{default_config_name} init @json:'{}') " \
+                  "or remove default (#{Info::CMD_NAME} config id default remove #{plugin_name_sym})."
               end
             end
             raise Cli::Error, "Config name [#{default_config_name}] must be a hash, check config file." if !@config_presets[default_config_name].is_a?(Hash)
@@ -1217,11 +1261,11 @@ module Aspera
           command = options.get_next_command(%i[info list show create delete password])
           case command
           when :info
-            return {type: :single_object, data: vault_info}
+            return Main.result_single_object(vault_info)
           when :list
-            return {type: :object_list, data: vault.list, fields: %w(label url username password description)}
+            return Main.result_object_list(vault.list, fields: %w(label url username password description))
           when :show
-            return {type: :single_object, data: vault.get(label: options.get_next_argument('label'))}
+            return Main.result_single_object(vault.get(label: options.get_next_argument('label')))
           when :create
             label = options.get_next_argument('label', validation: String)
             info = options.get_next_argument('info', validation: Hash)
@@ -1257,7 +1301,7 @@ module Aspera
           info = options.get_option(:vault) || {}
           info = info.symbolize_keys
           info[:type] ||= 'file'
-          info[:name] ||= (info[:type].eql?('file') ? DEFAULT_VAULT_FILENAME : PROGRAM_NAME)
+          info[:name] ||= (info[:type].eql?('file') ? DEFAULT_VAULT_FILENAME : Info::CMD_NAME)
           Aspera.assert(info.keys.sort == %i[name type]) {"vault info shall have exactly keys 'type' and 'name'"}
           Aspera.assert(info.values.all?(String)){'vault info shall have only string values'}
           info[:password] = options.get_option(:vault_password, mandatory: true)
@@ -1270,6 +1314,8 @@ module Aspera
             info = vault_info
             case info[:type]
             when 'file'
+              # this module requires comilation, so it is optinal
+              require 'aspera/keychain/encrypted_hash'
               # absolute_path? introduced in ruby 2.7
               @vault = Keychain::EncryptedHash.new(
                 info[:name].eql?(File.absolute_path(info[:name])) ? info[:name] : File.join(@main_folder, info[:name]),
@@ -1289,6 +1335,20 @@ module Aspera
           @vault
         end
 
+        def execute_test
+          case options.get_next_command(%i[throw web])
+          when :throw
+            # :type [String]
+            # options
+            exception_class_name = options.get_next_argument('exception class name', mandatory: true)
+            exception_text = options.get_next_argument('exception text', mandatory: true)
+            exception_class = Object.const_get(exception_class_name)
+            Aspera.assert(exception_class <= Exception){"#{exception_class} is not an exception: #{exception_class.class}"}
+            raise exception_class, exception_text
+          when :web
+          end
+        end
+
         # version of URL without trailing "/" and removing default port
         def canonical_url(url)
           url.sub(%r{/+$}, '').sub(%r{^(https://[^/]+):443$}, '\1')
@@ -1301,7 +1361,7 @@ module Aspera
           @config_presets.each_value do |v|
             next unless v.is_a?(Hash)
             conf_url = v['url'].is_a?(String) ? canonical_url(v['url']) : nil
-            return self.class.protect_presets(v) if conf_url.eql?(url) && v['username'].eql?(username)
+            return self.class.deep_clone(v) if conf_url.eql?(url) && v['username'].eql?(username)
           end
           nil
         end

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

@@ -84,11 +84,11 @@ module Aspera
               command = options.get_next_command(%i[list submit])
               case command
               when :list
-                return {type: :object_list, data: api_console.read('smart_transfers')[:data]}
+                return {type: :object_list, data: api_console.read('smart_transfers')}
               when :submit
                 smart_id = options.get_next_argument('smart_id')
                 params = options.get_next_argument('transfer parameters')
-                return {type: :object_list, data: api_console.create("smart_transfers/#{smart_id}", params)[:data]}
+                return {type: :object_list, data: api_console.create("smart_transfers/#{smart_id}", params)}
               end
             when :current
               command = options.get_next_command([:list])
@@ -99,7 +99,7 @@ module Aspera
                   data:   api_console.read('transfers', {
                     'from' => options.get_option(:filter_from, mandatory: true),
                     'to'   => options.get_option(:filter_to, mandatory: true)
-                  })[:data],
+                  }),
                   fields: %w[id contact name status]}
               end
             end

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

@@ -19,6 +19,7 @@ module Aspera
           options.declare(:region, 'Storage region')
           options.declare(:identity, "Authentication URL (#{Api::CosNode::IBM_CLOUD_TOKEN_URL})", default: Api::CosNode::IBM_CLOUD_TOKEN_URL)
           options.parse_options!
+          Node.declare_options(options)
         end
 
         ACTIONS = %i[node].freeze