aspera-cli 4.13.0 → 4.14.0

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

@@ -54,43 +54,42 @@ module Aspera
           # used to trigger periodic processing
           @periodic = TimerLimiter.new(LOG_LIMITER_SEC)
           # link CLI options to gen_info attributes
-          options.set_obj_attr(:skip_format, self, :option_skip_format, []) # no skip
-          options.set_obj_attr(:folder_reset_cache, self, :option_folder_reset_cache, :no)
-          options.set_obj_attr(:skip_types, self, :option_skip_types)
-          options.set_obj_attr(:previews_folder, self, :option_previews_folder, DEFAULT_PREVIEWS_FOLDER)
-          options.set_obj_attr(:skip_folders, self, :option_skip_folders, []) # no skip
-          options.set_obj_attr(:overwrite, self, :option_overwrite, :mtime)
-          options.set_obj_attr(:file_access, self, :option_file_access, :local)
-          options.add_opt_list(:skip_format, Aspera::Preview::Generator::PREVIEW_FORMATS, 'skip this preview format (multiple possible)')
-          options.add_opt_list(:folder_reset_cache, %i[no header read], 'force detection of generated preview by refresh cache')
-          options.add_opt_simple(:skip_types, 'skip types in comma separated list')
-          options.add_opt_simple(:previews_folder, 'preview folder in storage root')
-          options.add_opt_simple(:temp_folder, 'path to temp folder')
-          options.add_opt_simple(:skip_folders, 'list of folder to skip')
-          options.add_opt_simple(:case, 'basename of output for for test')
-          options.add_opt_simple(:scan_path, 'subpath in folder id to start scan in (default=/)')
-          options.add_opt_simple(:scan_id, 'folder id in storage to start scan in, default is access key main folder id')
-          options.add_opt_boolean(:mimemagic, 'use Mime type detection of gem mimemagic')
-          options.add_opt_list(:overwrite, %i[always never mtime], 'when to overwrite result file')
-          options.add_opt_list(:file_access, %i[local remote], 'how to read and write files in repository')
-          options.set_option(:temp_folder, Dir.tmpdir)
-          options.set_option(:mimemagic, false)
+          options.declare(
+            :skip_format, 'Skip this preview format (multiple possible)', values: Aspera::Preview::Generator::PREVIEW_FORMATS,
+            handler: {o: self, m: :option_skip_format}, default: [])
+          options.declare(
+            :folder_reset_cache, 'Force detection of generated preview by refresh cache',
+            values: %i[no header read],
+            handler: {o: self, m: :option_folder_reset_cache},
+            default: :no)
+          options.declare(:skip_types, 'Skip types in comma separated list', handler: {o: self, m: :option_skip_types})
+          options.declare(:previews_folder, 'Preview folder in storage root', handler: {o: self, m: :option_previews_folder}, default: DEFAULT_PREVIEWS_FOLDER)
+          options.declare(:temp_folder, 'Path to temp folder', default: Dir.tmpdir)
+          options.declare(:skip_folders, 'List of folder to skip', handler: {o: self, m: :option_skip_folders}, default: [])
+          options.declare(:case, 'Basename of output for for test')
+          options.declare(:scan_path, 'Subpath in folder id to start scan in (default=/)')
+          options.declare(:scan_id, 'Folder id in storage to start scan in, default is access key main folder id')
+          options.declare(:mimemagic, 'Use Mime type detection of gem mimemagic', values: :bool, default: false)
+          options.declare(:overwrite, 'When to overwrite result file', values: %i[always never mtime], handler: {o: self, m: :option_overwrite}, default: :mtime)
+          options.declare(
+            :file_access, 'How to read and write files in repository',
+            values: %i[local remote],
+            handler: {o: self, m: :option_file_access},
+            default: :local)
 
           # add other options for generator (and set default values)
           Aspera::Preview::Options::DESCRIPTIONS.each do |opt|
-            options.set_obj_attr(opt[:name], @gen_options, opt[:name], opt[:default])
-            if opt.key?(:values)
-              options.add_opt_list(opt[:name], opt[:values], opt[:description])
+            values = if opt.key?(:values)
+              opt[:values]
             elsif Cli::Manager::BOOLEAN_SIMPLE.include?(opt[:default])
-              options.add_opt_boolean(opt[:name], opt[:description])
-            else
-              options.add_opt_simple(opt[:name], opt[:description])
+              :bool
             end
+            options.declare(opt[:name], opt[:description].capitalize, values: values, handler: {o: @gen_options, m: opt[:name]}, default: opt[:default])
           end
 
           options.parse_options!
           raise 'skip_folder shall be an Array, use @json:[...]' unless @option_skip_folders.is_a?(Array)
-          @tmp_folder = File.join(options.get_option(:temp_folder, is_type: :mandatory), "#{TMP_DIR_PREFIX}.#{SecureRandom.uuid}")
+          @tmp_folder = File.join(options.get_option(:temp_folder, mandatory: true), "#{TMP_DIR_PREFIX}.#{SecureRandom.uuid}")
           FileUtils.mkdir_p(@tmp_folder)
           Log.log.debug{"tmpdir: #{@tmp_folder}"}
         end
@@ -206,34 +205,12 @@ module Aspera
         end
 
         def do_transfer(direction, folder_id, source_filename, destination='/')
-          raise 'error' if destination.nil? && direction.eql?(Fasp::TransferSpec::DIRECTION_RECEIVE)
-          if @default_transfer_spec.nil?
-            # make a dummy call to get some default transfer parameters
-            res = @api_node.create('files/upload_setup', {'transfer_requests' => [{'transfer_request' => {'paths' => [{}], 'destination_root' => '/'}}]})
-            template_ts = res[:data]['transfer_specs'].first['transfer_spec']
-            # get ports, anyway that should be 33001 for both. add remote_user ?
-            @default_transfer_spec = %w[ssh_port fasp_port].each_with_object({}){|e, h|h[e] = template_ts[e]; }
-            if !@default_transfer_spec['remote_user'].eql?(Aspera::Fasp::TransferSpec::ACCESS_KEY_TRANSFER_USER)
-              Log.log.warn('remote_user shall be xfer')
-              @default_transfer_spec['remote_user'] = Aspera::Fasp::TransferSpec::ACCESS_KEY_TRANSFER_USER
-            end
-            @api_node.ts_basic_token(@default_transfer_spec)
-            # NOTE: we use the same address for ascp than for node api instead of the one from upload_setup
-            # TODO: configurable ? useful ?
-            @default_transfer_spec['remote_host'] = @transfer_server_address
-          end
-          t_spec = @default_transfer_spec.merge({
-            'direction' => direction,
-            'paths'     => [{'source' => source_filename}],
-            'tags'      => {
-              Fasp::TransferSpec::TAG_RESERVED => {
-                PREV_GEN_TAG => true,
-                'node'       => {
-                  'access_key' => @access_key_self['id'],
-                  'file_id'    => folder_id }}}
+          raise 'Internal ERROR' if destination.nil? && direction.eql?(Fasp::TransferSpec::DIRECTION_RECEIVE)
+          t_spec = @api_node.transfer_spec_gen4(folder_id, direction, {
+            'paths' => [{'source' => source_filename}],
+            'tags'  => {Fasp::TransferSpec::TAG_RESERVED => {PREV_GEN_TAG => true}}
           })
-          # force destination
-          # t_spec['destination_root']=destination
+          # force destination, need to set this in transfer agent else it gets overwritten, not do: t_spec['destination_root']=destination
           transfer.option_transfer_spec_deep_merge({'destination_root' => destination})
           Main.result_transfer(transfer.start(t_spec))
         end
@@ -358,7 +335,7 @@ module Aspera
             scan_start = '/' + scan_start.split('/').reject(&:empty?).join('/')
             scan_start = "#{scan_start}/" # unless scan_start.end_with?('/')
           end
-          filter_block = Aspera::Node.file_matcher(options.get_option(:value))
+          filter_block = Aspera::Node.file_matcher(value_or_query(allowed_types: String))
           Log.log.debug{"scan: #{top_entry} : #{scan_start}".green}
           # don't use recursive call, use list instead
           entries_to_process = [top_entry]
@@ -455,7 +432,7 @@ module Aspera
               end
             end
           end
-          Aspera::Preview::FileTypes.instance.use_mimemagic = options.get_option(:mimemagic, is_type: :mandatory)
+          Aspera::Preview::FileTypes.instance.use_mimemagic = options.get_option(:mimemagic, mandatory: true)
           # check tools that are anyway required for all cases
           Aspera::Preview::Utils.check_tools(@skip_types)
           case command
@@ -477,15 +454,15 @@ module Aspera
             return Main.result_status('scan finished')
           when :events, :trevents
             iteration_persistency = nil
-            if options.get_option(:once_only, is_type: :mandatory)
+            if options.get_option(:once_only, mandatory: true)
               iteration_persistency = PersistencyActionOnce.new(
                 manager: @agents[:persistency],
                 data:    [],
                 id:      IdGenerator.from_list([
                   'preview_iteration',
                   command.to_s,
-                  options.get_option(:url, is_type: :mandatory),
-                  options.get_option(:username, is_type: :mandatory)
+                  options.get_option(:url, mandatory: true),
+                  options.get_option(:username, mandatory: true)
                 ]))
             end
             # call processing method specified by command line command
@@ -506,6 +483,7 @@ module Aspera
             raise 'error'
           end
         ensure
+          Log.log.debug{"cleaning up temp folder #{@tmp_folder}"}
           FileUtils.rm_rf(@tmp_folder)
         end # execute_action
       end # Preview

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

@@ -25,7 +25,9 @@ module Aspera
 
       class Server < Aspera::Cli::BasicAuthPlugin
         SSH_SCHEME = 'ssh'
-        URI_SCHEMES = %w[https local].push(SSH_SCHEME).freeze
+        LOCAL_SCHEME = 'local'
+        HTTPS_SCHEME = 'https'
+        URI_SCHEMES = [SSH_SCHEME, LOCAL_SCHEME, HTTPS_SCHEME].freeze
         ASCMD_ALIASES = {
           browse: :ls,
           delete: :rm,
@@ -41,7 +43,7 @@ module Aspera
             cmd = cmd.map{|v|%Q("#{v}")}.join(' ') if cmd.is_a?(Array)
             Log.log.debug{"Executing: #{cmd} with '#{line}'"}
             stdout_str, stderr_str, status = Open3.capture3(cmd, stdin_data: line, binmode: true)
-            Log.log.debug(">> #{status} -> #{stderr_str}")
+            Log.log.debug{"exec status: #{status} -> #{stderr_str}"}
             raise "command #{cmd} failed with code #{status.exitstatus} #{stderr_str}" unless status.success?
             return stdout_str
           end
@@ -49,28 +51,32 @@ module Aspera
 
         def initialize(env)
           super(env)
-          options.add_opt_simple(:ssh_keys, 'SSH key path list (Array or single)')
-          options.add_opt_simple(:ssh_options, 'SSH options (Hash)')
+          options.declare(:ssh_keys, 'SSH key path list (Array or single)')
+          options.declare(:passphrase, 'SSH private key passphrase')
+          options.declare(:ssh_options, 'SSH options', types: Hash, default: {})
           options.parse_options!
-          @ssh_opts = nil
+          @ssh_opts = options.get_option(:ssh_options).symbolize_keys
         end
 
         # Read command line options
         # @return [Hash] transfer specification
         def options_to_base_transfer_spec
-          url = options.get_option(:url, is_type: :mandatory)
+          url = options.get_option(:url, mandatory: true)
           server_transfer_spec = {}
           server_uri = URI.parse(url)
-          Log.log.debug{"URI : #{server_uri}, port=#{server_uri.port}, scheme:#{server_uri.scheme}"}
+          Log.log.debug{"URI=#{server_uri}, host=#{server_uri.hostname}, port=#{server_uri.port}, scheme=#{server_uri.scheme}"}
           server_transfer_spec['remote_host'] = server_uri.hostname
           unless URI_SCHEMES.include?(server_uri.scheme)
             Log.log.warn{"Scheme [#{server_uri.scheme}] not supported in #{url}, use one of: #{URI_SCHEMES.join(', ')}. Defaulting to #{SSH_SCHEME}."}
             server_uri.scheme = SSH_SCHEME
           end
-          if server_uri.scheme.eql?('local')
+          if server_uri.scheme.eql?(LOCAL_SCHEME)
             # Using local execution (mostly for testing)
+            server_transfer_spec['remote_host'] = 'localhost'
+            # simulate SSH environment, else ascp will fail
+            ENV['SSH_CLIENT'] = 'local 0 0'
             return server_transfer_spec
-          elsif transfer.option_transfer_spec['token'].is_a?(String) && server_uri.scheme.eql?('https')
+          elsif transfer.option_transfer_spec['token'].is_a?(String) && server_uri.scheme.eql?(HTTPS_SCHEME)
             server_transfer_spec['wss_enabled'] = true
             server_transfer_spec['wss_port'] = server_uri.port
             # Using WSS
@@ -88,11 +94,7 @@ module Aspera
             options.set_option(:username, Aspera::Fasp::TransferSpec::ACCESS_KEY_TRANSFER_USER)
             Log.log.info{"No username provided: Assuming default transfer user: #{Aspera::Fasp::TransferSpec::ACCESS_KEY_TRANSFER_USER}"}
           end
-          server_transfer_spec['remote_user'] = options.get_option(:username, is_type: :mandatory)
-          ssh_args = options.get_option(:ssh_options)
-          ssh_args = {} if ssh_args.nil?
-          raise 'expecting a Hash for ssh_options' unless ssh_args.is_a?(Hash)
-          @ssh_opts = ssh_args.symbolize_keys
+          server_transfer_spec['remote_user'] = options.get_option(:username, mandatory: true)
           if !server_uri.port.nil?
             @ssh_opts[:port] = server_uri.port
             server_transfer_spec['ssh_port'] = server_uri.port
@@ -119,6 +121,11 @@ module Aspera
               cred_set = true
             end
           end
+          ssh_passphrase = options.get_option(:passphrase)
+          if !ssh_passphrase.nil?
+            @ssh_opts[:passphrase] = ssh_passphrase
+            server_transfer_spec['ssh_private_key_passphrase'] = ssh_passphrase
+          end
           # if user provided transfer spec has a token, we will use bypass keys
           cred_set = true if transfer.option_transfer_spec['token'].is_a?(String)
           raise 'Either password, key , or transfer spec token must be provided' if !cred_set
@@ -143,7 +150,7 @@ module Aspera
 
         def execute_action
           server_transfer_spec = options_to_base_transfer_spec
-          ascmd_executor = if !@ssh_opts.nil?
+          ascmd_executor = if !@ssh_opts.empty?
             Ssh.new(server_transfer_spec['remote_host'], server_transfer_spec['remote_user'], @ssh_opts)
           elsif server_transfer_spec.key?('wss_enabled')
             nil

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

@@ -26,24 +26,25 @@ module Aspera
 
         def initialize(env)
           super(env)
-          options.add_opt_list(:type, %i[any local ldap saml], 'Type of user/group for operations')
-          options.set_option(:type, :any)
+          options.declare(:type, 'Type of user/group for operations', values: %i[any local ldap saml], default: :any)
           options.parse_options!
         end
 
         SAML_IMPORT_MANDATORY = %w[id name_id].freeze
         SAML_IMPORT_ALLOWED = %w[email given_name surname].concat(SAML_IMPORT_MANDATORY).freeze
 
-        ACTIONS = %i[health repository admin].freeze
+        ACTIONS = %i[health files admin].freeze
+        # common to users and groups
+        USR_GRP_SETTINGS = %i[transfer_settings app_authorizations share_permissions].freeze
 
         def execute_action
-          command = options.get_next_command(ACTIONS)
+          command = options.get_next_command(ACTIONS, aliases: {repository: :files})
           case command
           when :health
             nagios = Nagios.new
             begin
               Rest
-                .new(base_url: options.get_option(:url, is_type: :mandatory) + '/node_api')
+                .new(base_url: options.get_option(:url, mandatory: true) + '/node_api')
                 .call(
                   operation: 'GET',
                   subpath: 'ping',
@@ -54,25 +55,28 @@ module Aspera
               nagios.add_critical('node api', e.to_s)
             end
             return nagios.result
-          when :repository
+          when :repository, :files
             api_shares_node = basic_auth_api('node_api')
             repo_command = options.get_next_command(Node::COMMANDS_SHARES)
             return Node.new(@agents.merge(skip_basic_auth_options: true, node_api: api_shares_node)).execute_action(repo_command)
           when :admin
             api_shares_admin = basic_auth_api('api/v1')
-            admin_command = options.get_next_command(%i[user group share node])
+            admin_command = options.get_next_command(%i[user group share node].freeze)
             case admin_command
             when :node
               return entity_action(api_shares_admin, 'data/nodes')
             when :user, :group
               entity_type = admin_command
-              entities_location = options.get_option(:type, is_type: :mandatory)
+              entities_location = options.get_option(:type, mandatory: true)
               entities_path = "data/#{entities_location}_#{entity_type}s"
               entity_action = nil
               case entities_location
               when :any
                 entities_path = "data/#{entity_type}s"
-                entity_action = %i[list show delete share_permissions app_authorizations].freeze
+                entity_action = %i[list show delete]
+                entity_action.concat(USR_GRP_SETTINGS)
+                entity_action.push(:users) if entity_type.eql?(:group)
+                entity_action.freeze
               when :local
                 entity_action = %i[list show create modify delete].freeze
               when :ldap
@@ -80,31 +84,15 @@ module Aspera
               when :saml
                 entity_action = %i[import].freeze
               end
-              entity_command = options.get_next_command(entity_action)
-              entity_path = "#{entities_path}/#{instance_identifier}" if %i[app_authorizations share_permissions].include?(entity_command)
-              case entity_command
-              when :list, :show, :create, :delete, :modify
+              entity_verb = options.get_next_command(entity_action)
+              # entity_path = "#{entities_path}/#{instance_identifier}" if %i[app_authorizations share_permissions].include?(entity_verb)
+              case entity_verb
+              when *Plugin::ALL_OPS
                 display_fields = entity_type.eql?(:user) ? %w[id username first_name last_name email] : nil
                 display_fields.push(:directory_user) if entity_type.eql?(:user) && entities_location.eql?(:any)
-                return entity_command(entity_command, api_shares_admin, entities_path, display_fields: display_fields)
-              when :app_authorizations
-                case options.get_next_command(%i[modify show])
-                when :show
-                  return {type: :single_object, data: api_shares_admin.read("#{entity_path}/app_authorizations")[:data]}
-                when :modify
-                  parameters = options.get_option(:value, is_type: :mandatory)
-                  return {type: :single_object, data: api_shares_admin.update("#{entity_path}/app_authorizations", parameters)[:data]}
-                end
-              when :share_permissions
-                case options.get_next_command(%i[list show])
-                when :list
-                  return {type: :object_list, data: api_shares_admin.read("#{entity_path}/share_permissions")[:data]}
-                when :show
-                  return {type: :single_object, data: api_shares_admin.read("#{entity_path}/share_permissions/#{instance_identifier}")[:data]}
-                end
+                return entity_command(entity_verb, api_shares_admin, entities_path, display_fields: display_fields)
               when :import
-                parameters = options.get_option(:value, is_type: :mandatory)
-                return do_bulk_operation(parameters, 'created') do |entity_parameters|
+                return do_bulk_operation(value_create_modify(type: :bulk_hash), 'created') do |entity_parameters|
                   entity_parameters = entity_parameters.transform_keys{|k|k.gsub(/\s+/, '_').downcase}
                   raise 'expecting Hash' unless entity_parameters.is_a?(Hash)
                   SAML_IMPORT_MANDATORY.each{|p|raise "missing mandatory field: #{p}" if entity_parameters[p].nil?}
@@ -114,11 +102,14 @@ module Aspera
                   api_shares_admin.create("#{entities_path}/import", entity_parameters)[:data]
                 end
               when :add
-                parameters = options.get_option(:value)
-                return do_bulk_operation(parameters, 'created') do |entity_name|
+                return do_bulk_operation(value_create_modify(type: :bulk_hash), 'created') do |entity_name|
                   raise "expecting string (name), have #{entity_name.class}" unless entity_name.is_a?(String)
                   api_shares_admin.create(entities_path, {entity_type=>entity_name})[:data]
                 end
+              when *USR_GRP_SETTINGS
+                group_id = instance_identifier
+                entities_path = "#{entities_path}/#{group_id}/#{entity_verb}"
+                return entity_action(api_shares_admin, entities_path, is_singleton: !entity_verb.eql?(:share_permissions))
               end
             when :share
               share_command = options.get_next_command(%i[user_permissions group_permissions].concat(Plugin::ALL_OPS))

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

@@ -13,11 +13,11 @@ module Aspera
       class Sync < Aspera::Cli::Plugin
         def initialize(env, sync_spec: nil)
           super(env)
-          options.add_opt_simple(:sync_info, 'Information for sync instance and sessions (Hash)')
-          options.add_opt_simple(:sync_session, 'Name of session to use for admin commands. default: first in parameters')
+          options.declare(:sync_info, 'Information for sync instance and sessions', types: Hash)
+          options.declare(:sync_session, 'Name of session to use for admin commands. default: first in parameters')
           options.parse_options!
           return if env[:man_only]
-          @params = options.get_option(:sync_info, is_type: :mandatory)
+          @params = options.get_option(:sync_info, mandatory: true)
           @sync_spec = sync_spec
         end
 

data/lib/aspera/cli/transfer_agent.rb

@@ -54,18 +54,13 @@ module Aspera
         @progress_listener = Listener::ProgressMulti.new
         # source/destination pair, like "paths" of transfer spec
         @transfer_paths = nil
-        @opt_mgr.set_obj_attr(:ts, self, :option_transfer_spec)
-        @opt_mgr.set_obj_attr(:transfer_info, self, :option_transfer_info)
-        @opt_mgr.add_opt_simple(:ts, "Override transfer spec values (Hash, e.g. use @json: prefix), current=#{@opt_mgr.get_option(:ts)}")
-        @opt_mgr.add_opt_simple(:to_folder, 'Destination folder for transferred files')
-        @opt_mgr.add_opt_simple(:sources, "How list of transferred files is provided (#{FILE_LIST_OPTIONS.join(',')})")
-        @opt_mgr.add_opt_list(:src_type, %i[list pair], 'Type of file list')
-        @opt_mgr.add_opt_list(:transfer, TRANSFER_AGENTS, 'Type of transfer agent')
-        @opt_mgr.add_opt_simple(:transfer_info, 'Parameters for transfer agent (Hash)')
-        @opt_mgr.add_opt_list(:progress, %i[none native multi], 'Type of progress bar')
-        @opt_mgr.set_option(:transfer, :direct)
-        @opt_mgr.set_option(:src_type, :list)
-        @opt_mgr.set_option(:progress, :native) # use native ascp progress bar as it is more reliable
+        @opt_mgr.declare(:ts, 'Override transfer spec values', types: Hash, handler: {o: self, m: :option_transfer_spec})
+        @opt_mgr.declare(:to_folder, 'Destination folder for transferred files')
+        @opt_mgr.declare(:sources, "How list of transferred files is provided (#{FILE_LIST_OPTIONS.join(',')})")
+        @opt_mgr.declare(:src_type, 'Type of file list', values: %i[list pair], default: :list)
+        @opt_mgr.declare(:transfer, 'Type of transfer agent', values: TRANSFER_AGENTS, default: :direct)
+        @opt_mgr.declare(:transfer_info, 'Parameters for transfer agent', types: Hash, handler: {o: self, m: :option_transfer_info})
+        @opt_mgr.declare(:progress, 'Type of progress bar', values: %i[none native multi], default: :native)
         @opt_mgr.parse_options!
       end
 
@@ -74,7 +69,18 @@ module Aspera
       # multiple option are merged
       def option_transfer_spec=(value)
         raise 'option ts shall be a Hash' unless value.is_a?(Hash)
-        @transfer_spec_cmdline.merge!(value)
+        @transfer_spec_cmdline.deep_merge!(value)
+      end
+
+      # add other transfer spec parameters
+      def option_transfer_spec_deep_merge(ts); @transfer_spec_cmdline.deep_merge!(ts); end
+
+      # @return [Hash] transfer spec with updated values from command line, including removed values
+      def updated_ts(transfer_spec={})
+        transfer_spec.deep_merge!(@transfer_spec_cmdline)
+        # recursively remove values that are nil (user wants to delete)
+        transfer_spec.deep_do { |hash, key, value, _unused| hash.delete(key) if value.nil?}
+        return transfer_spec
       end
 
       def option_transfer_info; @transfer_info; end
@@ -82,17 +88,15 @@ module Aspera
       # multiple option are merged
       def option_transfer_info=(value)
         raise 'option transfer_info shall be a Hash' unless value.is_a?(Hash)
-        @transfer_info.merge!(value)
+        @transfer_info.deep_merge!(value)
       end
 
-      def option_transfer_spec_deep_merge(ts); @transfer_spec_cmdline.deep_merge!(ts); end
-
       def agent_instance=(instance)
         @agent = instance
         @agent.add_listener(Listener::Logger.new)
         # use local progress bar if asked so, or if native and non local ascp (because only local ascp has native progress bar)
-        if @opt_mgr.get_option(:progress, is_type: :mandatory).eql?(:multi) ||
-            (@opt_mgr.get_option(:progress, is_type: :mandatory).eql?(:native) && !instance.class.to_s.eql?('Aspera::Fasp::AgentDirect'))
+        if @opt_mgr.get_option(:progress, mandatory: true).eql?(:multi) ||
+            (@opt_mgr.get_option(:progress, mandatory: true).eql?(:native) && !instance.class.to_s.eql?('Aspera::Fasp::AgentDirect'))
           @agent.add_listener(@progress_listener)
         end
       end
@@ -100,7 +104,7 @@ module Aspera
       # analyze options and create new agent if not already created or set
       def set_agent_by_options
         return nil unless @agent.nil?
-        agent_type = @opt_mgr.get_option(:transfer, is_type: :mandatory)
+        agent_type = @opt_mgr.get_option(:transfer, mandatory: true)
         # agent plugin is loaded on demand to avoid loading unnecessary dependencies
         require "aspera/fasp/agent_#{agent_type}"
         agent_options = @opt_mgr.get_option(:transfer_info)
@@ -113,7 +117,7 @@ module Aspera
           agent_options = @config.preset_by_name(param_set_name)
         end
         # special case: native progress bar
-        if agent_type.eql?(:direct) && @opt_mgr.get_option(:progress, is_type: :mandatory).eql?(:native)
+        if agent_type.eql?(:direct) && @opt_mgr.get_option(:progress, mandatory: true).eql?(:native)
           agent_options[:quiet] = false
         end
         # normalize after getting from user or default node
@@ -170,7 +174,7 @@ module Aspera
         when FILE_LIST_FROM_TRANSFER_SPEC
           Log.log.debug('assume list provided in transfer spec')
           special_case_direct_with_list =
-            @opt_mgr.get_option(:transfer, is_type: :mandatory).eql?(:direct) &&
+            @opt_mgr.get_option(:transfer, mandatory: true).eql?(:direct) &&
             Fasp::Parameters.ts_has_ascp_file_list(@transfer_spec_cmdline, @opt_mgr.get_option(:transfer_info))
           raise CliBadArgument, 'transfer spec on command line must have sources' if @transfer_paths.nil? && !special_case_direct_with_list
           # here we assume check of sources is made in transfer agent
@@ -185,7 +189,7 @@ module Aspera
         if !@transfer_paths.nil?
           Log.log.warn('--sources overrides paths from --ts')
         end
-        case @opt_mgr.get_option(:src_type, is_type: :mandatory)
+        case @opt_mgr.get_option(:src_type, mandatory: true)
         when :list
           # when providing a list, just specify source
           @transfer_paths = file_list.map{|i|{'source' => i}}
@@ -225,14 +229,13 @@ module Aspera
         end
         # update command line paths, unless destination already has one
         @transfer_spec_cmdline['paths'] = transfer_spec['paths'] || ts_source_paths
-        transfer_spec.merge!(@transfer_spec_cmdline)
-        # remove values that are nil (user wants to delete)
-        transfer_spec.delete_if { |_key, value| value.nil? }
+        # updated transfer spec with command line
+        updated_ts(transfer_spec)
         # create transfer agent
         set_agent_by_options
         Log.log.debug{"transfer agent is a #{@agent.class}"}
         @agent.start_transfer(transfer_spec, token_regenerator: rest_token)
-        # list of : :success or error message
+        # list of: :success or "error message string"
         result = @agent.wait_for_transfers_completion
         @progress_listener.reset
         Fasp::AgentBase.validate_status_list(result)

data/lib/aspera/cli/version.rb

@@ -4,6 +4,6 @@ module Aspera
   module Cli
     # for beta add extension : .beta1
     # for dev version add extension : .pre
-    VERSION = '4.13.0'
+    VERSION = '4.14.0'
   end
 end

data/lib/aspera/colors.rb

@@ -1,16 +1,18 @@
 # frozen_string_literal: true
 
+# cspell:words
+
 # simple vt100 colors
 class String
   class << self
     private
 
-    def vtcmd(code); "\e[#{code}m"; end
+    def vt_cmd(code); "\e[#{code}m"; end
   end
   # see https://en.wikipedia.org/wiki/ANSI_escape_code
   # symbol is the method name added to String
   # it adds control chars to set color (and reset at the end).
-  VTSTYLES = {
+  VT_STYLES = {
     bold:          1,
     italic:        3,
     underline:     4,
@@ -33,17 +35,17 @@ class String
     bg_cyan:       46,
     bg_gray:       47
   }.freeze
-  private_constant :VTSTYLES
-  # defines methods to String, one per entry in VTSTYLES
-  VTSTYLES.each do |name, code|
+  private_constant :VT_STYLES
+  # defines methods to String, one per entry in VT_STYLES
+  VT_STYLES.each do |name, code|
     if $stderr.tty?
-      begin_seq = vtcmd(code)
+      begin_seq = vt_cmd(code)
       end_code = 0 # by default reset all
       if code <= 7 then code + 20
       elsif code <= 37 then 39
       elsif code <= 47 then 49
       end
-      end_seq = vtcmd(end_code)
+      end_seq = vt_cmd(end_code)
       define_method(name){"#{begin_seq}#{self}#{end_seq}"}
     else
       define_method(name){self}

data/lib/aspera/environment.rb

@@ -3,6 +3,8 @@
 require 'aspera/log'
 require 'rbconfig'
 
+# cspell:words MEBI mswin bccwin
+
 module Aspera
   # detect OS, architecture, and specific stuff
   class Environment
@@ -84,12 +86,14 @@ module Aspera
       end
 
       # value is provided in block
-      def write_file_restricted(path, force: false)
+      def write_file_restricted(path, force: false, mode: nil)
         raise 'coding error, missing content block' unless block_given?
         if force || !File.exist?(path)
-          File.unlink(path) rescue nil # Windows may give error
+          # Windows may give error
+          File.unlink(path) rescue nil
+          # content provided by block
           File.write(path, yield)
-          restrict_file_access(path)
+          restrict_file_access(path, mode: mode)
         end
         return path
       end

data/lib/aspera/fasp/agent_connect.rb

@@ -9,7 +9,9 @@ require 'tty-spinner'
 module Aspera
   module Fasp
     class AgentConnect < Aspera::Fasp::AgentBase
+      # try twice the main init url in sequence
       CONNECT_START_URIS = ['fasp://initialize', 'fasp://initialize', 'aspera-drive://initialize', 'https://test-connect.ibmaspera.com/']
+      # delay between each try to start connect
       SLEEP_SEC_BETWEEN_RETRY = 3
       private_constant :CONNECT_START_URIS, :SLEEP_SEC_BETWEEN_RETRY
       def initialize(_options)
@@ -106,6 +108,9 @@ module Aspera
               when 'failed'
                 spinner&.error
                 raise Fasp::Error, transfer['error_desc']
+              when 'cancelled'
+                spinner&.error
+                raise Fasp::Error, 'Transfer cancelled by user'
               else
                 raise Fasp::Error, "unknown status: #{transfer['status']}: #{transfer['error_desc']}"
               end