aspera-cli 4.9.0 → 4.11.0

data/lib/aspera/fasp/installation.rb

@@ -42,9 +42,9 @@ module Aspera
         </default>
         </CONF>
       END_OF_CONFIG_FILE
-      DUMMY_CERT_INFO='/C=US/ST=California/L=Emeryville/O=Aspera Inc./OU=Corporate/CN=Aspera Inc./emailAddress=info@asperasoft.com'
-      private_constant :PRODUCT_CONNECT,:PRODUCT_CLI_V1,:PRODUCT_DRIVE,:PRODUCT_ENTSRV,:EXT_RUBY_PROTOBUF,:RB_SDK_FOLDER,
-        :ONE_YEAR_SECONDS,:DEFAULT_ASPERA_CONF,:DUMMY_CERT_INFO
+      DUMMY_CERT_INFO = '/C=US/ST=California/L=Emeryville/O=Aspera Inc./OU=Corporate/CN=Aspera Inc./emailAddress=info@asperasoft.com'
+      private_constant :PRODUCT_CONNECT, :PRODUCT_CLI_V1, :PRODUCT_DRIVE, :PRODUCT_ENTSRV, :EXT_RUBY_PROTOBUF, :RB_SDK_FOLDER,
+        :ONE_YEAR_SECONDS, :DEFAULT_ASPERA_CONF, :DUMMY_CERT_INFO
       # set ascp executable path
       def ascp_path=(v)
         @path_to_ascp = v
@@ -55,7 +55,7 @@ module Aspera
       end
 
       def sdk_ruby_folder
-        ruby_pb_folder = File.join(sdk_folder,RB_SDK_FOLDER)
+        ruby_pb_folder = File.join(sdk_folder, RB_SDK_FOLDER)
         FileUtils.mkdir_p(ruby_pb_folder) unless Dir.exist?(ruby_pb_folder)
         return ruby_pb_folder
       end
@@ -87,7 +87,7 @@ module Aspera
           raise "no such product installed: #{product_name}" if pl.nil?
         end
         self.ascp_path = pl[:ascp_path]
-        Log.log.debug("ascp_path=#{@path_to_ascp}")
+        Log.log.debug{"ascp_path=#{@path_to_ascp}"}
       end
 
       # @return the list of installed products in format of product_locations
@@ -104,15 +104,15 @@ module Aspera
           @found_products = scan_locations.select! do |item|
             # skip if not main folder
             next false unless Dir.exist?(item[:app_root])
-            Log.log.debug("Found #{item[:app_root]}")
+            Log.log.debug{"Found #{item[:app_root]}"}
             sub_bin = item[:sub_bin] || BIN_SUBFOLDER
-            item[:ascp_path] = File.join(item[:app_root],sub_bin,ascp_filename)
+            item[:ascp_path] = File.join(item[:app_root], sub_bin, ascp_filename)
             # skip if no ascp
             next false unless File.exist?(item[:ascp_path])
             # read info from product info file if present
             product_info_file = "#{item[:app_root]}/#{PRODUCT_INFO}"
             if File.exist?(product_info_file)
-              res_s = XmlSimple.xml_in(File.read(product_info_file),{'ForceArray' => false})
+              res_s = XmlSimple.xml_in(File.read(product_info_file), {'ForceArray' => false})
               item[:name] = res_s['name']
               item[:version] = res_s['version']
             else
@@ -131,20 +131,20 @@ module Aspera
       # keys and certs are generated locally... (they are well known values, arch. independant)
       def path(k)
         case k
-        when :ascp,:ascp4
+        when :ascp, :ascp4
           use_ascp_from_product(FIRST_FOUND) if @path_to_ascp.nil?
           file = @path_to_ascp
-          # note that there might be a .exe at the end
-          file = file.gsub('ascp','ascp4') if k.eql?(:ascp4)
+          # NOTE: that there might be a .exe at the end
+          file = file.gsub('ascp', 'ascp4') if k.eql?(:ascp4)
         when :transferd
           file = transferd_filepath
         when :ssh_bypass_key_dsa
-          file=Environment.write_file_restricted(File.join(sdk_folder,'aspera_bypass_dsa.pem')) {get_key('dsa',1)}
+          file = Environment.write_file_restricted(File.join(sdk_folder, 'aspera_bypass_dsa.pem')) {get_key('dsa', 1)}
         when :ssh_bypass_key_rsa
-          file=Environment.write_file_restricted(File.join(sdk_folder,'aspera_bypass_rsa.pem')) {get_key('rsa',2)}
+          file = Environment.write_file_restricted(File.join(sdk_folder, 'aspera_bypass_rsa.pem')) {get_key('rsa', 2)}
         when :aspera_license
-          file=Environment.write_file_restricted(File.join(sdk_folder,'aspera-license')) do
-            clear=[
+          file = Environment.write_file_restricted(File.join(sdk_folder, 'aspera-license')) do
+            clear = [
               Zlib::Inflate.inflate(DataRepository.instance.data(6)),
               "==SIGNATURE==\n",
               Base64.strict_encode64(DataRepository.instance.data(7))
@@ -152,10 +152,10 @@ module Aspera
             Base64.strict_encode64(clear.join)
           end
         when :aspera_conf
-          file=Environment.write_file_restricted(File.join(sdk_folder,'aspera.conf')) {DEFAULT_ASPERA_CONF}
-        when :fallback_cert,:fallback_key
-          file_key = File.join(sdk_folder,'aspera_fallback_key.pem')
-          file_cert = File.join(sdk_folder,'aspera_fallback_cert.pem')
+          file = Environment.write_file_restricted(File.join(sdk_folder, 'aspera.conf')) {DEFAULT_ASPERA_CONF}
+        when :fallback_cert, :fallback_key
+          file_key = File.join(sdk_folder, 'aspera_fallback_key.pem')
+          file_cert = File.join(sdk_folder, 'aspera_fallback_cert.pem')
           if !File.exist?(file_key) || !File.exist?(file_cert)
             require 'openssl'
             # create new self signed certificate for http fallback
@@ -182,10 +182,10 @@ module Aspera
       # @return the file path of local connect where API's URI can be read
       def connect_uri
         connect = get_product_folders(PRODUCT_CONNECT)
-        folder = File.join(connect[:run_root],VARRUN_SUBFOLDER)
-        ['','s'].each do |ext|
-          uri_file = File.join(folder,"http#{ext}.uri")
-          Log.log.debug("checking connect port file: #{uri_file}")
+        folder = File.join(connect[:run_root], VARRUN_SUBFOLDER)
+        ['', 's'].each do |ext|
+          uri_file = File.join(folder, "http#{ext}.uri")
+          Log.log.debug{"checking connect port file: #{uri_file}"}
           if File.exist?(uri_file)
             return File.open(uri_file, &:gets).strip
           end
@@ -196,12 +196,12 @@ module Aspera
       # @ return path to configuration file of aspera CLI
       def cli_conf_file
         connect = get_product_folders(PRODUCT_CLI_V1)
-        return File.join(connect[:app_root],BIN_SUBFOLDER,'.aspera_cli_conf')
+        return File.join(connect[:app_root], BIN_SUBFOLDER, '.aspera_cli_conf')
       end
 
       # default bypass key phrase
       def bypass_pass
-        return format('%08x-%04x-%04x-%04x-%04x%08x',*DataRepository.instance.data(3).unpack('NnnnnN'))
+        return format('%08x-%04x-%04x-%04x-%04x%08x', *DataRepository.instance.data(3).unpack('NnnnnN'))
       end
 
       def bypass_keys
@@ -210,16 +210,16 @@ module Aspera
 
       # use in plugin `config`
       def get_ascp_version(exe_path)
-        return get_exe_version(exe_path,'-A')
+        return get_exe_version(exe_path, '-A')
       end
 
       # Check that specified path is ascp and get version
-      def get_exe_version(exe_path,vers_arg)
+      def get_exe_version(exe_path, vers_arg)
         raise 'ERROR: nil arg' if exe_path.nil?
         return nil unless File.exist?(exe_path)
         exe_version = nil
         cmd_out = %x("#{exe_path}" #{vers_arg})
-        raise "An error occured when testing #{ascp_filename}: #{cmd_out}" unless $CHILD_STATUS == 0
+        raise "An error occurred when testing #{ascp_filename}: #{cmd_out}" unless $CHILD_STATUS == 0
         # get version from ascp, only after full extract, as windows requires DLLs (SSL/TLS/etc...)
         m = cmd_out.match(/ version ([0-9.]+)/)
         exe_version = m[1] unless m.nil?
@@ -233,18 +233,18 @@ module Aspera
         # SDK is organized by architecture, check this first, in case architecture is not supported
         arch_filter = "#{Environment.architecture}/"
         require 'zip'
-        sdk_zip_path = File.join(Dir.tmpdir,'sdk.zip')
+        sdk_zip_path = File.join(Dir.tmpdir, 'sdk.zip')
         if sdk_url.start_with?('file:')
           # require specific file scheme: the path part is "relative", or absolute if there are 4 slash
           raise 'use format: file:///<path>' unless sdk_url.start_with?('file:///')
-          sdk_zip_path = sdk_url.gsub(%r{^file:///},'')
+          sdk_zip_path = sdk_url.gsub(%r{^file:///}, '')
         else
-          Aspera::Rest.new(base_url: sdk_url, redirect_max: 3).call(operation: 'GET',save_to_file: sdk_zip_path)
+          Aspera::Rest.new(base_url: sdk_url, redirect_max: 3).call(operation: 'GET', save_to_file: sdk_zip_path)
         end
         # rename old install
         if !Dir.empty?(sdk_folder)
           Log.log.warn('Previous install exists, renaming folder.')
-          File.rename(sdk_folder,"#{sdk_folder}.#{Time.now.strftime('%Y%m%d%H%M%S')}")
+          File.rename(sdk_folder, "#{sdk_folder}.#{Time.now.strftime('%Y%m%d%H%M%S')}")
           # TODO: delete old archives ?
         end
         # extract files from archive
@@ -258,7 +258,7 @@ module Aspera
             # ruby adapters
             dest_folder = sdk_ruby_folder if entry.name.end_with?(EXT_RUBY_PROTOBUF)
             next if dest_folder.nil?
-            File.open(File.join(dest_folder,File.basename(entry.name)), 'wb') do |output_stream|
+            File.open(File.join(dest_folder, File.basename(entry.name)), 'wb') do |output_stream|
               IO.copy_stream(entry.get_input_stream, output_stream)
             end
           end
@@ -267,17 +267,17 @@ module Aspera
         # ensure license file are generated so that ascp invokation for version works
         path(:aspera_license)
         path(:aspera_conf)
-        ascp_path = File.join(sdk_folder,ascp_filename)
+        ascp_path = File.join(sdk_folder, ascp_filename)
         raise "No #{ascp_filename} found in SDK archive" unless File.exist?(ascp_path)
-        FileUtils.chmod(0755,ascp_path)
-        FileUtils.chmod(0755,ascp_path.gsub('ascp','ascp4'))
-        ascp_version = get_ascp_version(File.join(sdk_folder,ascp_filename))
+        Environment.restrict_file_access(ascp_path, mode: 0o755)
+        Environment.restrict_file_access(ascp_path.gsub('ascp', 'ascp4'), mode: 0o755)
+        ascp_version = get_ascp_version(File.join(sdk_folder, ascp_filename))
         trd_path = transferd_filepath
-        Log.log.warn("No #{trd_path} in SDK archive") unless File.exist?(trd_path)
-        FileUtils.chmod(0755,trd_path) if File.exist?(trd_path)
-        transferd_version = get_exe_version(trd_path,'version')
+        Log.log.warn{"No #{trd_path} in SDK archive"} unless File.exist?(trd_path)
+        Environment.restrict_file_access(trd_path, mode: 0o755) if File.exist?(trd_path)
+        transferd_version = get_exe_version(trd_path, 'version')
         sdk_version = transferd_version || ascp_version
-        File.write(File.join(sdk_folder,PRODUCT_INFO),"<product><name>IBM Aspera SDK</name><version>#{sdk_version}</version></product>")
+        File.write(File.join(sdk_folder, PRODUCT_INFO), "<product><name>IBM Aspera SDK</name><version>#{sdk_version}</version></product>")
         return sdk_version
       end
 
@@ -285,13 +285,13 @@ module Aspera
 
       BIN_SUBFOLDER = 'bin'
       ETC_SUBFOLDER = 'etc'
-      VARRUN_SUBFOLDER = File.join('var','run')
+      VARRUN_SUBFOLDER = File.join('var', 'run')
       # product information manifest: XML (part of aspera product)
       PRODUCT_INFO = 'product-info.mf'
       # policy for product selection
       FIRST_FOUND = 'FIRST'
 
-      private_constant :BIN_SUBFOLDER,:ETC_SUBFOLDER,:VARRUN_SUBFOLDER,:PRODUCT_INFO
+      private_constant :BIN_SUBFOLDER, :ETC_SUBFOLDER, :VARRUN_SUBFOLDER, :PRODUCT_INFO
 
       def initialize
         @path_to_ascp = nil
@@ -313,7 +313,7 @@ module Aspera
       end
 
       def transferd_filepath
-        return File.join(sdk_folder,'asperatransferd' + Environment.exe_extension)
+        return File.join(sdk_folder, 'asperatransferd' + Environment.exe_extension)
       end
 
       # @return product folders depending on OS fields
@@ -326,54 +326,54 @@ module Aspera
         case Aspera::Environment.os
         when Aspera::Environment::OS_WINDOWS; return [{
           expected: PRODUCT_CONNECT,
-          app_root: File.join(ENV['LOCALAPPDATA'],'Programs','Aspera','Aspera Connect'),
-          log_root: File.join(ENV['LOCALAPPDATA'],'Aspera','Aspera Connect','var','log'),
-          run_root: File.join(ENV['LOCALAPPDATA'],'Aspera','Aspera Connect')
-        },{
+          app_root: File.join(ENV['LOCALAPPDATA'], 'Programs', 'Aspera', 'Aspera Connect'),
+          log_root: File.join(ENV['LOCALAPPDATA'], 'Aspera', 'Aspera Connect', 'var', 'log'),
+          run_root: File.join(ENV['LOCALAPPDATA'], 'Aspera', 'Aspera Connect')
+        }, {
           expected: PRODUCT_CLI_V1,
-          app_root: File.join('C:','Program Files','Aspera','cli'),
-          log_root: File.join('C:','Program Files','Aspera','cli','var','log')
-        },{
+          app_root: File.join('C:', 'Program Files', 'Aspera', 'cli'),
+          log_root: File.join('C:', 'Program Files', 'Aspera', 'cli', 'var', 'log')
+        }, {
           expected: PRODUCT_ENTSRV,
-          app_root: File.join('C:','Program Files','Aspera','Enterprise Server'),
-          log_root: File.join('C:','Program Files','Aspera','Enterprise Server','var','log')
+          app_root: File.join('C:', 'Program Files', 'Aspera', 'Enterprise Server'),
+          log_root: File.join('C:', 'Program Files', 'Aspera', 'Enterprise Server', 'var', 'log')
         }]
         when Aspera::Environment::OS_X; return [{
           expected: PRODUCT_CONNECT,
-          app_root: File.join(Dir.home,'Applications','Aspera Connect.app'),
-          log_root: File.join(Dir.home,'Library','Logs','Aspera_Connect'),
-          run_root: File.join(Dir.home,'Library','Application Support','Aspera','Aspera Connect'),
-          sub_bin:  File.join('Contents','Resources')
-        },{
+          app_root: File.join(Dir.home, 'Applications', 'Aspera Connect.app'),
+          log_root: File.join(Dir.home, 'Library', 'Logs', 'Aspera_Connect'),
+          run_root: File.join(Dir.home, 'Library', 'Application Support', 'Aspera', 'Aspera Connect'),
+          sub_bin:  File.join('Contents', 'Resources')
+        }, {
           expected: PRODUCT_CONNECT,
-          app_root: File.join('','Applications','Aspera Connect.app'),
-          log_root: File.join(Dir.home,'Library','Logs','Aspera_Connect'),
-          run_root: File.join(Dir.home,'Library','Application Support','Aspera','Aspera Connect'),
-          sub_bin:  File.join('Contents','Resources')
-        },{
+          app_root: File.join('', 'Applications', 'Aspera Connect.app'),
+          log_root: File.join(Dir.home, 'Library', 'Logs', 'Aspera_Connect'),
+          run_root: File.join(Dir.home, 'Library', 'Application Support', 'Aspera', 'Aspera Connect'),
+          sub_bin:  File.join('Contents', 'Resources')
+        }, {
           expected: PRODUCT_CLI_V1,
-          app_root: File.join(Dir.home,'Applications','Aspera CLI'),
-          log_root: File.join(Dir.home,'Library','Logs','Aspera')
-        },{
+          app_root: File.join(Dir.home, 'Applications', 'Aspera CLI'),
+          log_root: File.join(Dir.home, 'Library', 'Logs', 'Aspera')
+        }, {
           expected: PRODUCT_ENTSRV,
-          app_root: File.join('','Library','Aspera'),
-          log_root: File.join(Dir.home,'Library','Logs','Aspera')
-        },{
+          app_root: File.join('', 'Library', 'Aspera'),
+          log_root: File.join(Dir.home, 'Library', 'Logs', 'Aspera')
+        }, {
           expected: PRODUCT_DRIVE,
-          app_root: File.join('','Applications','Aspera Drive.app'),
-          log_root: File.join(Dir.home,'Library','Logs','Aspera_Drive'),
-          sub_bin:  File.join('Contents','Resources')
+          app_root: File.join('', 'Applications', 'Aspera Drive.app'),
+          log_root: File.join(Dir.home, 'Library', 'Logs', 'Aspera_Drive'),
+          sub_bin:  File.join('Contents', 'Resources')
         }]
         else; return [{ # other: Linux and Unix family
           expected: PRODUCT_CONNECT,
-          app_root: File.join(Dir.home,'.aspera','connect'),
-          run_root: File.join(Dir.home,'.aspera','connect')
-        },{
+          app_root: File.join(Dir.home, '.aspera', 'connect'),
+          run_root: File.join(Dir.home, '.aspera', 'connect')
+        }, {
           expected: PRODUCT_CLI_V1,
-          app_root: File.join(Dir.home,'.aspera','cli')
-        },{
+          app_root: File.join(Dir.home, '.aspera', 'cli')
+        }, {
           expected: PRODUCT_ENTSRV,
-          app_root: File.join('','opt','aspera')
+          app_root: File.join('', 'opt', 'aspera')
         }]
         end
       end
@@ -381,7 +381,7 @@ module Aspera
       # @return a standard bypass key
       # @param type rsa or dsa
       # @param id in repository 1 for dsa, 2 for rsa
-      def get_key(type,id)
+      def get_key(type, id)
         # generate PEM from DER
         OpenSSL::PKey.const_get(type.upcase).new(DataRepository.instance.data(id)).to_pem
       end

data/lib/aspera/fasp/listener.rb

@@ -3,7 +3,7 @@
 module Aspera
   module Fasp
     # imlement this class to get transfer events
-    class Listener
+    class Listener # rubocop:disable Lint/EmptyClass
       # define one of the following methods:
       # event_text(text_data)
       # event_struct(legacy_names)

data/lib/aspera/fasp/parameters.rb

@@ -31,39 +31,52 @@ module Aspera
         def description
           if @param_description_cache.nil?
             # config file in same folder with same name as this source
-            description_from_yaml=YAML.load_file("#{__FILE__[0..-3]}yaml")
+            description_from_yaml = YAML.load_file("#{__FILE__[0..-3]}yaml")
             @param_description_cache = Aspera::CommandLineBuilder.normalize_description(description_from_yaml)
           end
           return @param_description_cache
         end
 
         # @return a table suitable to display in manual
-        def man_table
+        def man_table(to_text: true)
           result = []
-          description.each do |k,i|
-            param = {name: k, type: [i[:accepted_types]].flatten.join(','),description: i[:desc]}
+          description.each do |k, i|
+            param = {name: k, type: [i[:accepted_types]].flatten.join(','), description: i[:desc]}
             # add flags for supported agents in doc
             SUPPORTED_AGENTS.each do |a|
               param[a.to_s[0].to_sym] = i[:tragents].nil? || i[:tragents].include?(a) ? 'Y' : ''
             end
             # only keep lines that are usable in supported agents
-            next if SUPPORTED_AGENTS_SHORT.inject(true){|m,j|m && param[j].empty?}
+            next if SUPPORTED_AGENTS_SHORT.inject(true){|m, j|m && param[j].empty?}
             param[:cli] =
               case i[:cltype]
               when :envvar then 'env:' + i[:clvarname]
-              when :opt_without_arg,:opt_with_arg then i[:clswitch]
+              when :opt_without_arg then i[:clswitch]
+              when :opt_with_arg
+                values = if i.key?(:enum)
+                  ['enum']
+                elsif i[:accepted_types].is_a?(Array)
+                  i[:accepted_types]
+                elsif !i[:accepted_types].nil?
+                  [i[:accepted_types]]
+                else
+                  raise "error: #{param}"
+                end.map{|n|"{#{n}}"}.join('|')
+                conv = i.key?(:clconvert) ? '(conversion)' : ''
+                "#{i[:clswitch]} #{conv}#{values}"
               else ''
               end
-            if i.has_key?(:enum)
+            if i.key?(:enum)
               param[:description] += "\nAllowed values: #{i[:enum].join(', ')}"
             end
+            param[:description] = param[:description].gsub('/', '/') if to_text
             result.push(param)
           end
           return result
         end
 
         # special encoding methods used in YAML (key: :clconvert)
-        def clconv_remove_hyphen(v); v.tr('-',''); end
+        def clconv_remove_hyphen(v); v.tr('-', ''); end
 
         # special encoding methods used in YAML (key: :clconvert)
         def clconv_json64(v); Base64.strict_encode64(JSON.generate(v)); end
@@ -73,13 +86,13 @@ module Aspera
 
         # file list is provided directly with ascp arguments
         def ts_has_ascp_file_list(ts)
-          (ts['EX_ascp_args'].is_a?(Array) && ['--file-list','--file-pair-list'].any?{|i|ts['EX_ascp_args'].include?(i)}) ||
-          ts.has_key?('EX_file_list') ||
-          ts.has_key?('EX_file_pair_list')
+          (ts['EX_ascp_args'].is_a?(Array) && ['--file-list', '--file-pair-list'].any?{|i|ts['EX_ascp_args'].include?(i)}) ||
+            ts.key?('EX_file_list') ||
+            ts.key?('EX_file_pair_list')
         end
 
-        def ts_to_env_args(transfer_spec,options)
-          return Parameters.new(transfer_spec,options).ascp_args
+        def ts_to_env_args(transfer_spec, options)
+          return Parameters.new(transfer_spec, options).ascp_args
         end
 
         # temp file list files are created here
@@ -95,11 +108,56 @@ module Aspera
       end # self
 
       # @param options [Hash] key: :wss: bool
-      def initialize(job_spec,options)
+      def initialize(job_spec, options)
         @job_spec = job_spec
         @options = options
-        @builder = Aspera::CommandLineBuilder.new(@job_spec,self.class.description)
-        Log.log.debug("agent options: #{@options}")
+        @builder = Aspera::CommandLineBuilder.new(@job_spec, self.class.description)
+        Log.log.debug{"agent options: #{@options}"}
+      end
+
+      def process_file_list
+        # is the file list provided through EX_ parameters?
+        ascp_file_list_provided = self.class.ts_has_ascp_file_list(@job_spec)
+        # set if paths is mandatory in ts
+        @builder.params_definition['paths'][:mandatory] = !@job_spec.key?('keepalive') && !ascp_file_list_provided
+        # get paths in transfer spec (after setting if it is mandatory)
+        ts_paths_array = @builder.process_param('paths', :get_value)
+        if ascp_file_list_provided && !ts_paths_array.nil?
+          raise 'file list provided both in transfer spec and ascp file list. Remove one of them.'
+        end
+        # option 1: EX_file_list
+        file_list_file = @builder.process_param('EX_file_list', :get_value)
+        if file_list_file.nil?
+          # option 2: EX_file_pair_list
+          file_list_file = @builder.process_param('EX_file_pair_list', :get_value)
+          if !file_list_file.nil?
+            option = '--file-pair-list'
+          elsif !ts_paths_array.nil?
+            # option 3: in TS, it is an array
+            if self.class.file_list_folder.nil?
+              # not safe for special characters ? (maybe not, depends on OS)
+              Log.log.debug('placing source file list on command line (no file list file)')
+              @builder.add_command_line_options(ts_paths_array.map{|i|i['source']})
+            else
+              # safer option: generate a file list file if there is storage defined for it
+              # if there is destination in paths, then use filepairlist
+              # TODO: well, we test only the first one, but anyway it shall be consistent
+              if ts_paths_array.first.key?('destination')
+                option = '--file-pair-list'
+                lines = ts_paths_array.each_with_object([]){|e, m|m.push(e['source'], e['destination']); }
+              else
+                option = '--file-list'
+                lines = ts_paths_array.map{|i|i['source']}
+              end
+              file_list_file = Aspera::TempFileManager.instance.new_file_path_in_folder(self.class.file_list_folder)
+              File.write(file_list_file, lines.join("\n"))
+              Log.log.debug{"#{option}=\n#{File.read(file_list_file)}".red}
+            end
+          end
+        else
+          option = '--file-list'
+        end
+        @builder.add_command_line_options(["#{option}=#{file_list_file}"]) unless option.nil?
       end
 
       # translate transfer spec to env vars and command line arguments for ascp
@@ -111,22 +169,22 @@ module Aspera
           ascp_version: :ascp
         }
         # some ssh credentials are required to avoid interactive password input
-        if !@job_spec.has_key?('remote_password') &&
-        !@job_spec.has_key?('ssh_private_key') &&
-        !@job_spec.has_key?('EX_ssh_key_paths')
+        if !@job_spec.key?('remote_password') &&
+            !@job_spec.key?('ssh_private_key') &&
+            !@job_spec.key?('EX_ssh_key_paths')
           raise Fasp::Error, 'required: password or ssh key (value or path)'
         end
 
         # special cases
-        @job_spec.delete('source_root') if @job_spec.has_key?('source_root') && @job_spec['source_root'].empty?
+        @job_spec.delete('source_root') if @job_spec.key?('source_root') && @job_spec['source_root'].empty?
 
         # use web socket session initiation ?
-        if @builder.process_param('wss_enabled',:get_value) && (@options[:wss] || !@job_spec.has_key?('fasp_port'))
+        if @builder.process_param('wss_enabled', :get_value) && (@options[:wss] || !@job_spec.key?('fasp_port'))
           # by default use web socket session if available, unless removed by user
           @builder.add_command_line_options(['--ws-connect'])
           # TODO: option to give order ssh,ws (legacy http is implied bu ssh)
           # quel bordel:
-          @job_spec['ssh_port'] = @builder.process_param('wss_port',:get_value)
+          @job_spec['ssh_port'] = @builder.process_param('wss_port', :get_value)
           @job_spec.delete('fasp_port')
           @job_spec.delete('EX_ssh_key_paths')
           @job_spec.delete('sshfp')
@@ -142,68 +200,25 @@ module Aspera
         @builder.process_params
 
         # symbol must be index of Installation.paths
-        if @builder.process_param('use_ascp4',:get_value)
+        if @builder.process_param('use_ascp4', :get_value)
           env_args[:ascp_version] = :ascp4
         else
           env_args[:ascp_version] = :ascp
           # destination will be base64 encoded, put before path arguments
           @builder.add_command_line_options(['--dest64'])
         end
-        # process file lists
-        begin
-          # is the file list provided through EX_ parameters?
-          ascp_file_list_provided = self.class.ts_has_ascp_file_list(@job_spec)
-          # set if paths is mandatory in ts
-          @builder.params_definition['paths'][:mandatory] = !@job_spec.has_key?('keepalive') && !ascp_file_list_provided
-          # get paths in transfer spec (after setting if it is mandatory)
-          ts_paths_array = @builder.process_param('paths',:get_value)
-          if ascp_file_list_provided && !ts_paths_array.nil?
-            raise 'file list provided both in transfer spec and ascp file list. Remove one of them.'
-          end
-          # option 1: EX_file_list
-          file_list_file = @builder.process_param('EX_file_list',:get_value)
-          if !file_list_file.nil?
-            option = '--file-list'
-          else
-            # option 2: EX_file_pair_list
-            file_list_file = @builder.process_param('EX_file_pair_list',:get_value)
-            if !file_list_file.nil?
-              option = '--file-pair-list'
-            elsif !ts_paths_array.nil?
-              # option 3: in TS, it is an array
-              if !self.class.file_list_folder.nil?
-                # safer option: generate a file list file if there is storage defined for it
-                # if there is destination in paths, then use filepairlist
-                # TODO: well, we test only the first one, but anyway it shall be consistent
-                if ts_paths_array.first.has_key?('destination')
-                  option = '--file-pair-list'
-                  lines = ts_paths_array.each_with_object([]){|e,m|m.push(e['source'],e['destination']);}
-                else
-                  option = '--file-list'
-                  lines = ts_paths_array.map{|i|i['source']}
-                end
-                file_list_file = Aspera::TempFileManager.instance.new_file_path_in_folder(self.class.file_list_folder)
-                File.write(file_list_file, lines.join("\n"))
-                Log.log.debug{"#{option}=\n#{File.read(file_list_file)}".red}
-              else
-                # not safe for special characters ? (maybe not, depends on OS)
-                Log.log.debug('placing source file list on command line (no file list file)')
-                @builder.add_command_line_options(ts_paths_array.map{|i|i['source']})
-              end
-            end
-          end
-          @builder.add_command_line_options(["#{option}=#{file_list_file}"]) unless option.nil?
-        end
+        # get list of files to transfer and build arg for ascp
+        process_file_list
         # optional args, at the end to override previous ones (to allow override)
-        @builder.add_command_line_options(@builder.process_param('EX_ascp_args',:get_value))
+        @builder.add_command_line_options(@builder.process_param('EX_ascp_args', :get_value))
         # process destination folder
-        destination_folder = @builder.process_param('destination_root',:get_value) || '/'
+        destination_folder = @builder.process_param('destination_root', :get_value) || '/'
         # ascp4 does not support base64 encoding of destination
         destination_folder = Base64.strict_encode64(destination_folder) unless env_args[:ascp_version].eql?(:ascp4)
         # destination MUST be last command line argument to ascp
         @builder.add_command_line_options([destination_folder])
 
-        @builder.add_env_args(env_args[:env],env_args[:args])
+        @builder.add_env_args(env_args[:env], env_args[:args])
 
         return env_args
       end

data/lib/aspera/fasp/parameters.yaml

@@ -4,7 +4,7 @@
 # enum      : set with list of values for enum types accepted in transfer spec
 # tragents  : supported agents (for doc only)
 # required  : optional, default: false
-# cltype    : ascp: type of parameter
+# cltype    : ascp: type of parameter: :opt_with_arg,:opt_without_arg,:envvar,:defer,:ignore,
 # clswitch  : ascp: switch for ascp command line
 # clconvert : ascp: transform value: either a Hash with conversion values, or name of class
 # clvarname : ascp: name of env var
@@ -144,8 +144,11 @@ https_fallback_port:
   :cltype: :opt_with_arg
   :clswitch: "-t"
 move_after_transfer:
-  :desc: The relative path to which the files will be moved after the transfer at the source side.
+  :desc: The relative path to which the files will be moved after the transfer at the source side. Available as of 3.8.0.
   :cltype: :opt_with_arg
+  :tragents:
+  - :direct
+  - :node
 multi_session:
   :desc: |
     Use multi-session transfer. max 128.
@@ -310,8 +313,8 @@ ssh_port:
 ssh_private_key:
   :desc: |-
     Private key used for SSH authentication.
-    Shall look like: -----BEGIN RSA PRIV4TE KEY-----\nMII...
-    Note the JSON encoding: \n for newlines.
+    Shall look like: -----BEGIN RSA PRIV4TE KEY-----/nMII...
+    Note the JSON encoding: /n for newlines.
 
 
   :tragents: