aspera-cli 4.12.0 → 4.13.0

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

@@ -7,6 +7,7 @@ require 'aspera/hash_ext'
 require 'aspera/id_generator'
 require 'aspera/node'
 require 'aspera/aoc'
+require 'aspera/sync'
 require 'aspera/fasp/transfer_spec'
 require 'base64'
 require 'zlib'
@@ -14,6 +15,51 @@ require 'zlib'
 module Aspera
   module Cli
     module Plugins
+      class SyncSpecGen3
+        def initialize(api_node)
+          @api_node = api_node
+        end
+
+        def transfer_spec(direction, local_path, remote_path)
+          # empty transfer spec for authorization request
+          direction_sym = direction.to_sym
+          request_transfer_spec = {
+            type:  Aspera::Sync::DIRECTION_TO_REQUEST_TYPE[direction_sym],
+            paths: {
+              source:      remote_path,
+              destination: local_path
+            }
+          }
+          # add fixed parameters if any (for COS)
+          @api_node.add_tspec_info(request_transfer_spec) if @api_node.respond_to?(:add_tspec_info)
+          # prepare payload for single request
+          setup_payload = {transfer_requests: [{transfer_request: request_transfer_spec}]}
+          # only one request, so only one answer
+          transfer_spec = @api_node.create('files/sync_setup', setup_payload)[:data]['transfer_specs'].first['transfer_spec']
+          # API returns null tag... but async does not like it
+          transfer_spec.delete_if{ |_k, v| v.nil? }
+          # delete this part, as the returned value contains only destination, and not sources
+          # transfer_spec.delete('paths') if command.eql?(:upload)
+          Log.dump(:ts, transfer_spec)
+          return transfer_spec
+        end
+      end
+
+      class SyncSpecGen4
+        def initialize(api_node, top_file_id)
+          @api_node = api_node
+          @top_file_id = top_file_id
+        end
+
+        def transfer_spec(direction, local_path, remote_path)
+          # remote is specified by option to_folder
+          apifid = @api_node.resolve_api_fid(@top_file_id, remote_path)
+          transfer_spec = apifid[:api].transfer_spec_gen4(apifid[:file_id], Fasp::TransferSpec::DIRECTION_SEND)
+          Log.dump(:ts, transfer_spec)
+          return transfer_spec
+        end
+      end
+
       class Node < Aspera::Cli::BasicAuthPlugin
         class << self
           def detect(base_url)
@@ -30,7 +76,7 @@ module Aspera
             env[:options].add_opt_simple(:asperabrowserurl, 'URL for simple aspera web ui')
             env[:options].add_opt_simple(:sync_name, 'sync name')
             env[:options].add_opt_simple(:path, 'file or folder path for gen4 operation "file"')
-            env[:options].add_opt_list(:token_type, %i[aspera basic hybrid], 'Type of token used for transfers')
+            env[:options].add_opt_list(:token_type, %i[aspera basic hybrid], 'type of token used for transfers')
             env[:options].add_opt_boolean(:default_ports, 'use standard FASP ports or get from node api (gen4)')
             env[:options].set_option(:asperabrowserurl, 'https://asperabrowser.mybluemix.net')
             env[:options].set_option(:token_type, :aspera)
@@ -53,7 +99,7 @@ module Aspera
         SEARCH_REMOVE_FIELDS = %w[basename permissions].freeze
 
         # actions in execute_command_gen3
-        COMMANDS_GEN3 = %i[search space mkdir mklink mkfile rename delete browse upload download]
+        COMMANDS_GEN3 = %i[search space mkdir mklink mkfile rename delete browse upload download sync]
 
         BASE_ACTIONS = %i[api_details].concat(COMMANDS_GEN3).freeze
 
@@ -145,7 +191,7 @@ module Aspera
         # translates paths results into CLI result, and removes prefix
         def c_result_translate_rem_prefix(response, type, success_msg, path_prefix)
           errors = []
-          resres = { data: [], type: :object_list, fields: [type, 'result']}
+          final_result = { data: [], type: :object_list, fields: [type, 'result']}
           JSON.parse(response[:http].body)['paths'].each do |p|
             result = success_msg
             if p.key?('error')
@@ -153,13 +199,13 @@ module Aspera
               result = 'ERROR: ' + p['error']['user_message']
               errors.push([p['path'], p['error']['user_message']])
             end
-            resres[:data].push({type => p['path'], 'result' => result})
+            final_result[:data].push({type => p['path'], 'result' => result})
           end
           # one error make all fail
           unless errors.empty?
             raise errors.map{|i|"#{i.first}: #{i.last}"}.join(', ')
           end
-          return c_result_remove_prefix_path(resres, type, path_prefix)
+          return c_result_remove_prefix_path(final_result, type, path_prefix)
         end
 
         # get path arguments from command line, and add prefix
@@ -187,7 +233,7 @@ module Aspera
             result = { type: :object_list, data: resp[:data]['items']}
             return Main.result_empty if result[:data].empty?
             result[:fields] = result[:data].first.keys.reject{|i|SEARCH_REMOVE_FIELDS.include?(i)}
-            formatter.display_status("Items: #{resp[:data]['item_count']}/#{resp[:data]['total_count']}")
+            formatter.display_item_count(resp[:data]['item_count'], resp[:data]['total_count'])
             formatter.display_status("params: #{resp[:data]['parameters'].keys.map{|k|"#{k}:#{resp[:data]['parameters'][k]}"}.join(',')}")
             return c_result_remove_prefix_path(result, 'path', prefix_path)
           when :space
@@ -228,13 +274,16 @@ module Aspera
             case send_result['self']['type']
             when 'directory', 'container' # directory: node, container: shares
               result = { data: send_result['items'], type: :object_list, textify: lambda { |table_data| c_textify_browse(table_data) } }
-              formatter.display_status("Items: #{send_result['item_count']}/#{send_result['total_count']}")
+              formatter.display_item_count(send_result['item_count'], send_result['total_count'])
             else # 'file','symbolic_link'
               result = { data: send_result['self'], type: :single_object}
               # result={ data: [send_result['self']] , type: :object_list, textify: lambda { |table_data| c_textify_browse(table_data) } }
               # raise "unknown type: #{send_result['self']['type']}"
             end
             return c_result_remove_prefix_path(result, 'path', prefix_path)
+          when :sync
+            node_sync = SyncSpecGen3.new(@api_node)
+            return Plugins::Sync.new(@agents, sync_spec: node_sync).execute_action
           when :upload, :download
             token_type = options.get_option(:token_type)
             # nil if Shares 1.x
@@ -244,7 +293,11 @@ module Aspera
               # empty transfer spec for authorization request
               request_transfer_spec = {}
               # set requested paths depending on direction
-              request_transfer_spec[:paths] = command.eql?(:download) ? transfer.ts_source_paths : [{ destination: transfer.destination_folder('send') }]
+              request_transfer_spec[:paths] = if command.eql?(:download)
+                transfer.ts_source_paths
+              else
+                [{ destination: transfer.destination_folder(Fasp::TransferSpec::DIRECTION_SEND) }]
+              end
               # add fixed parameters if any (for COS)
               @api_node.add_tspec_info(request_transfer_spec) if @api_node.respond_to?(:add_tspec_info)
               # prepare payload for single request
@@ -330,7 +383,7 @@ module Aspera
             return { type: :single_object, data: @api_node.params }
           end
         end
-
+        GEN4_FILE_COMMANDS = %i[show modify permission thumbnail].freeze
         def execute_node_gen4_file_command(command_node_file, top_file_id)
           file_path = options.get_option(:path)
           apifid =
@@ -347,6 +400,14 @@ module Aspera
             update_param = options.get_next_argument('update data', type: Hash)
             apifid[:api].update("files/#{apifid[:file_id]}", update_param)[:data]
             return Main.result_status('Done')
+          when :thumbnail
+            result = apifid[:api].call(
+              operation: 'GET',
+              subpath: "files/#{apifid[:file_id]}/preview",
+              headers: {'Accept' => 'image/png'}
+            )
+            require 'aspera/preview/terminal'
+            return Main.result_status(Preview::Terminal.build(result[:http].body, reserved_lines: 3))
           when :permission
             command_perm = options.get_next_command(%i[list create delete])
             case command_perm
@@ -375,7 +436,7 @@ module Aspera
               the_app[:api].permissions_create_params(create_param: create_param, app_info: the_app) unless the_app.nil?
               # create permission
               created_data = apifid[:api].create('permissions', create_param)[:data]
-              # bnotify application of creation
+              # notify application of creation
               the_app[:api].permissions_create_event(created_data: created_data, app_info: the_app) unless the_app.nil?
               return { type: :single_object, data: created_data}
             else raise "internal error:shall not reach here (#{command_perm})"
@@ -417,7 +478,7 @@ module Aspera
             if file_info['type'].eql?('folder')
               result = apifid[:api].read("files/#{apifid[:file_id]}/files", options.get_option(:value))
               items = result[:data]
-              formatter.display_status("Items: #{result[:data].length}/#{result[:http]['X-Total-Count']}")
+              formatter.display_item_count(result[:data].length, result[:http]['X-Total-Count'])
             else
               items = [file_info]
             end
@@ -446,12 +507,8 @@ module Aspera
               {'path' => l_path}
             end
           when :sync
-            # remote is specified by option to_folder
-            apifid = @api_node.resolve_api_fid(top_file_id, transfer.destination_folder(Fasp::TransferSpec::DIRECTION_SEND))
-            transfer_spec = apifid[:api].transfer_spec_gen4(apifid[:file_id], Fasp::TransferSpec::DIRECTION_SEND)
-            Log.dump(:ts, transfer_spec)
-            sync_plugin = Plugins::Sync.new(@agents, transfer_spec: transfer_spec)
-            return sync_plugin.execute_action
+            node_sync = SyncSpecGen4.new(@api_node, top_file_id)
+            return Plugins::Sync.new(@agents, sync_spec: node_sync).execute_action
           when :upload
             apifid = @api_node.resolve_api_fid(top_file_id, transfer.destination_folder(Fasp::TransferSpec::DIRECTION_SEND))
             return Main.result_transfer(transfer.start(apifid[:api].transfer_spec_gen4(apifid[:file_id], Fasp::TransferSpec::DIRECTION_SEND)))
@@ -499,7 +556,7 @@ module Aspera
               save_to_file: File.join(transfer.destination_folder(Fasp::TransferSpec::DIRECTION_RECEIVE), file_name))
             return Main.result_status("downloaded: #{file_name}")
           when :file
-            command_node_file = options.get_next_command(%i[show modify permission])
+            command_node_file = options.get_next_command(GEN4_FILE_COMMANDS)
             return execute_node_gen4_file_command(command_node_file, top_file_id)
           else raise "INTERNAL ERROR: no case for #{command_repo}"
           end # command_repo
@@ -510,43 +567,43 @@ module Aspera
         def execute_async
           command = options.get_next_command(%i[list delete files show counters bandwidth])
           unless command.eql?(:list)
-            asyncname = options.get_option(:sync_name)
-            if asyncname.nil?
-              asyncid = instance_identifier
-              if asyncid.eql?(VAL_ALL) && %i[show delete].include?(command)
-                asyncids = @api_node.read('async/list')[:data]['sync_ids']
+            async_name = options.get_option(:sync_name)
+            if async_name.nil?
+              async_id = instance_identifier
+              if async_id.eql?(VAL_ALL) && %i[show delete].include?(command)
+                async_ids = @api_node.read('async/list')[:data]['sync_ids']
               else
-                Integer(asyncid) # must be integer
-                asyncids = [asyncid]
+                Integer(async_id) # must be integer
+                async_ids = [async_id]
               end
             else
-              asyncids = @api_node.read('async/list')[:data]['sync_ids']
-              summaries = @api_node.create('async/summary', {'syncs' => asyncids})[:data]['sync_summaries']
-              selected = summaries.find{|s|s['name'].eql?(asyncname)}
-              raise "no such sync: #{asyncname}" if selected.nil?
-              asyncid = selected['snid']
-              asyncids = [asyncid]
+              async_ids = @api_node.read('async/list')[:data]['sync_ids']
+              summaries = @api_node.create('async/summary', {'syncs' => async_ids})[:data]['sync_summaries']
+              selected = summaries.find{|s|s['name'].eql?(async_name)}
+              raise "no such sync: #{async_name}" if selected.nil?
+              async_id = selected['snid']
+              async_ids = [async_id]
             end
-            pdata = {'syncs' => asyncids}
+            post_data = {'syncs' => async_ids}
           end
           case command
           when :list
             resp = @api_node.read('async/list')[:data]['sync_ids']
             return { type: :value_list, data: resp, name: 'id' }
           when :show
-            resp = @api_node.create('async/summary', pdata)[:data]['sync_summaries']
+            resp = @api_node.create('async/summary', post_data)[:data]['sync_summaries']
             return Main.result_empty if resp.empty?
-            return { type: :object_list, data: resp, fields: %w[snid name local_dir remote_dir] } if asyncid.eql?(VAL_ALL)
+            return { type: :object_list, data: resp, fields: %w[snid name local_dir remote_dir] } if async_id.eql?(VAL_ALL)
             return { type: :single_object, data: resp.first }
           when :delete
-            resp = @api_node.create('async/delete', pdata)[:data]
+            resp = @api_node.create('async/delete', post_data)[:data]
             return { type: :single_object, data: resp, name: 'id' }
           when :bandwidth
-            pdata['seconds'] = 100 # TODO: as parameter with --value
-            resp = @api_node.create('async/bandwidth', pdata)[:data]
+            post_data['seconds'] = 100 # TODO: as parameter with --value
+            resp = @api_node.create('async/bandwidth', post_data)[:data]
             data = resp['bandwidth_data']
             return Main.result_empty if data.empty?
-            data = data.first[asyncid]['data']
+            data = data.first[async_id]['data']
             return { type: :object_list, data: data, name: 'id' }
           when :files
             # count int
@@ -554,10 +611,10 @@ module Aspera
             # skip int
             # status int
             filter = options.get_option(:value)
-            pdata.merge!(filter) unless filter.nil?
-            resp = @api_node.create('async/files', pdata)[:data]
+            post_data.merge!(filter) unless filter.nil?
+            resp = @api_node.create('async/files', post_data)[:data]
             data = resp['sync_files']
-            data = data.first[asyncid] unless data.empty?
+            data = data.first[async_id] unless data.empty?
             iteration_data = []
             skip_ids_persistency = nil
             if options.get_option(:once_only, is_type: :mandatory)
@@ -568,7 +625,7 @@ module Aspera
                   'sync_files',
                   options.get_option(:url, is_type: :mandatory),
                   options.get_option(:username, is_type: :mandatory),
-                  asyncid]))
+                  async_id]))
               unless iteration_data.first.nil?
                 data.select!{|l| l['fnid'].to_i > iteration_data.first}
               end
@@ -578,7 +635,7 @@ module Aspera
             skip_ids_persistency&.save
             return { type: :object_list, data: data, name: 'id' }
           when :counters
-            resp = @api_node.create('async/counters', pdata)[:data]['sync_counters'].first[asyncid].last
+            resp = @api_node.create('async/counters', post_data)[:data]['sync_counters'].first[async_id].last
             return Main.result_empty if resp.nil?
             return { type: :single_object, data: resp }
           end
@@ -586,7 +643,7 @@ module Aspera
 
         ACTIONS = %i[
           async
-          sync
+          ssync
           stream
           transfer
           service
@@ -599,9 +656,9 @@ module Aspera
           command ||= options.get_next_command(ACTIONS)
           case command
           when *COMMON_ACTIONS then return execute_simple_common(command, prefix_path)
-          when :async then return execute_async
-          when :sync
-            # newer api
+          when :async then return execute_async # former API
+          when :ssync
+            # newer API
             sync_command = options.get_next_command(%i[bandwidth counters files start state stop summary].concat(Plugin::ALL_OPS) - %i[modify])
             case sync_command
             when *Plugin::ALL_OPS then return entity_command(sync_command, @api_node, 'asyncs', item_list_key: 'ids')
@@ -665,7 +722,7 @@ module Aspera
           when :service
             command = options.get_next_command(%i[list create delete])
             if [:delete].include?(command)
-              svcid = instance_identifier
+              service_id = instance_identifier
             end
             case command
             when :list
@@ -677,8 +734,8 @@ module Aspera
               resp = @api_node.create('rund/services', params)
               return Main.result_status("#{resp[:data]['id']} created")
             when :delete
-              @api_node.delete("rund/services/#{svcid}")
-              return Main.result_status("#{svcid} deleted")
+              @api_node.delete("rund/services/#{service_id}")
+              return Main.result_status("#{service_id} deleted")
             end
           when :watch_folder
             res_class_path = 'v3/watchfolders'

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

@@ -149,8 +149,8 @@ module Aspera
             if event['data']['direction'].eql?(Fasp::TransferSpec::DIRECTION_RECEIVE) &&
                 event['data']['status'].eql?('completed') &&
                 event['data']['error_code'].eql?(0) &&
-                event['data'].dig('tags', 'aspera', PREV_GEN_TAG).nil?
-              folder_id = event.dig('data', 'tags', 'aspera', 'node', 'file_id')
+                event['data'].dig('tags', Fasp::TransferSpec::TAG_RESERVED, PREV_GEN_TAG).nil?
+              folder_id = event.dig('data', 'tags', Fasp::TransferSpec::TAG_RESERVED, 'node', 'file_id')
               folder_id ||= event.dig('data', 'file_id')
               if !folder_id.nil?
                 folder_entry = @api_node.read("files/#{folder_id}")[:data] rescue nil
@@ -226,7 +226,7 @@ module Aspera
             'direction' => direction,
             'paths'     => [{'source' => source_filename}],
             'tags'      => {
-              'aspera' => {
+              Fasp::TransferSpec::TAG_RESERVED => {
                 PREV_GEN_TAG => true,
                 'node'       => {
                   'access_key' => @access_key_self['id'],

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

@@ -13,6 +13,16 @@ module Aspera
   module Cli
     module Plugins
       # implement basic remote access with FASP/SSH
+      class SyncSpecServer
+        def initialize(transfer_spec)
+          @transfer_spec = transfer_spec
+        end
+
+        def transfer_spec(direction, local_path, remote_path)
+          return @transfer_spec
+        end
+      end
+
       class Server < Aspera::Cli::BasicAuthPlugin
         SSH_SCHEME = 'ssh'
         URI_SCHEMES = %w[https local].push(SSH_SCHEME).freeze
@@ -121,7 +131,7 @@ module Aspera
             Fasp::TransferSpec.action_to_direction(transfer_spec, command)
             return Main.result_transfer(transfer.start(transfer_spec))
           when :sync
-            sync_plugin = Sync.new(@agents, transfer_spec: transfer_spec)
+            sync_plugin = Plugins::Sync.new(@agents, sync_spec: SyncSpecServer.new(transfer_spec))
             return sync_plugin.execute_action
           end
         end

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

@@ -11,14 +11,14 @@ module Aspera
     module Plugins
       # Execute Aspera Sync
       class Sync < Aspera::Cli::Plugin
-        def initialize(env, transfer_spec: nil)
+        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.parse_options!
           return if env[:man_only]
           @params = options.get_option(:sync_info, is_type: :mandatory)
-          Aspera::Sync.update_parameters_with_transfer_spec(@params, transfer_spec) unless transfer_spec.nil?
+          @sync_spec = sync_spec
         end
 
         ACTIONS = %i[start admin].freeze
@@ -27,7 +27,7 @@ module Aspera
           command = options.get_next_command(ACTIONS)
           case command
           when :start
-            Aspera::Sync.new(@params).start
+            Aspera::Sync.new(@params, @sync_spec).start
             return Main.result_success
           when :admin
             sync_admin = Aspera::SyncAdmin.new(@params, options.get_option(:sync_session))

data/lib/aspera/cli/transfer_agent.rb

@@ -48,18 +48,20 @@ module Aspera
         @config = config
         # command line can override transfer spec
         @transfer_spec_cmdline = {'create_dir' => true}
+        @transfer_info = {}
         # the currently selected transfer agent
         @agent = nil
         @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')
+        @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)
@@ -70,7 +72,18 @@ module Aspera
       def option_transfer_spec; @transfer_spec_cmdline; end
 
       # multiple option are merged
-      def option_transfer_spec=(value); @transfer_spec_cmdline.merge!(value); end
+      def option_transfer_spec=(value)
+        raise 'option ts shall be a Hash' unless value.is_a?(Hash)
+        @transfer_spec_cmdline.merge!(value)
+      end
+
+      def option_transfer_info; @transfer_info; end
+
+      # 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)
+      end
 
       def option_transfer_spec_deep_merge(ts); @transfer_spec_cmdline.deep_merge!(ts); end
 
@@ -92,19 +105,19 @@ module Aspera
         require "aspera/fasp/agent_#{agent_type}"
         agent_options = @opt_mgr.get_option(:transfer_info)
         raise CliBadArgument, "the transfer agent configuration shall be Hash, not #{agent_options.class} (#{agent_options}), "\
-          'use either @json:<json> or @preset:<parameter set name>' unless [Hash, NilClass].include?(agent_options.class)
-        # special case
-        if agent_type.eql?(:node) && agent_options.nil?
+          'e.g. use @json:<json>' unless agent_options.is_a?(Hash)
+        # special case: use default node
+        if agent_type.eql?(:node) && agent_options.empty?
           param_set_name = @config.get_plugin_default_config_name(:node)
-          raise CliBadArgument, "No default node configured, Please specify --#{:transfer_info.to_s.tr('_', '-')}" if param_set_name.nil?
+          raise CliBadArgument, "No default node configured. Please specify #{Manager.option_name_to_line(:transfer_info)}" if param_set_name.nil?
           agent_options = @config.preset_by_name(param_set_name)
         end
-        # special case
+        # special case: native progress bar
         if agent_type.eql?(:direct) && @opt_mgr.get_option(:progress, is_type: :mandatory).eql?(:native)
-          agent_options = {} if agent_options.nil?
           agent_options[:quiet] = false
         end
-        agent_options = agent_options.symbolize_keys if agent_options.is_a?(Hash)
+        # normalize after getting from user or default node
+        agent_options = agent_options.symbolize_keys
         # get agent instance
         new_agent = Kernel.const_get("Aspera::Fasp::Agent#{agent_type.capitalize}").new(agent_options)
         self.agent_instance = new_agent
@@ -129,6 +142,7 @@ module Aspera
         return dest_folder
       end
 
+      # @return [Array] list of source files
       def source_list
         return ts_source_paths.map do |i|
           i['source']
@@ -196,7 +210,7 @@ module Aspera
           # init default if required in any case
           @transfer_spec_cmdline['destination_root'] ||= destination_folder(transfer_spec['direction'])
         when Fasp::TransferSpec::DIRECTION_SEND
-          if transfer_spec.dig('tags', 'aspera', 'node', 'access_key')
+          if transfer_spec.dig('tags', Fasp::TransferSpec::TAG_RESERVED, 'node', 'access_key')
             # gen4
             @transfer_spec_cmdline.delete('destination_root') if @transfer_spec_cmdline.key?('destination_root_id')
           elsif transfer_spec.key?('token')

data/lib/aspera/cli/version.rb

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

data/lib/aspera/command_line_builder.rb

@@ -9,7 +9,7 @@ module Aspera
     # parameter with one of those tags is a command line option with --
     CLI_OPTION_TYPE_SWITCH = %i[opt_without_arg opt_with_arg].freeze
     CLI_OPTION_TYPES = %i[special ignore envvar].concat(CLI_OPTION_TYPE_SWITCH).freeze
-    OPTIONS_KEYS = %i[desc accepted_types default enum agents required cli ts].freeze
+    OPTIONS_KEYS = %i[desc accepted_types default enum agents required cli ts deprecation].freeze
     CLI_KEYS = %i[type switch convert variable].freeze
 
     private_constant :CLI_OPTION_TYPE_SWITCH, :OPTIONS_KEYS, :CLI_KEYS
@@ -37,6 +37,7 @@ module Aspera
           # by default : optional
           options[:mandatory] ||= false
           options[:desc] ||= ''
+          options[:desc] = "DEPRECATED: #{options[:deprecation]}\n#{options[:desc]}" if options.key?(:deprecation)
           cli = options[:cli]
           unsupported_cli_keys = cli.keys - CLI_KEYS
           raise "Unsupported cli keys: #{unsupported_cli_keys}" unless unsupported_cli_keys.empty?

data/lib/aspera/cos_node.rb

@@ -65,7 +65,7 @@ module Aspera
             type:     :basic,
             username: ats_info['AccessKey']['Id'],
             password: ats_info['AccessKey']['Secret']}},
-        add_tspec: {'tags'=>{'aspera'=>{'node'=>{'storage_credentials'=>@storage_credentials}}}})
+        add_tspec: {'tags'=>{Fasp::TransferSpec::TAG_RESERVED=>{'node'=>{'storage_credentials'=>@storage_credentials}}}})
       # update storage_credentials AND Rest params
       generate_token
     end

data/lib/aspera/fasp/agent_connect.rb

@@ -66,7 +66,7 @@ module Aspera
           }]}
         # asynchronous anyway
         res = @connect_api.create('transfers/start', connect_transfer_args)[:data]
-        @xfer_id = res['transfer_specs'].first['transfer_spec']['tags']['aspera']['xfer_id']
+        @xfer_id = res['transfer_specs'].first['transfer_spec']['tags'][Fasp::TransferSpec::TAG_RESERVED]['xfer_id']
       end
 
       def wait_for_transfers_completion

data/lib/aspera/fasp/agent_direct.rb

@@ -37,15 +37,15 @@ module Aspera
         # clone transfer spec because we modify it (first level keys)
         transfer_spec = transfer_spec.clone
         # if there is aspera tags
-        if transfer_spec['tags'].is_a?(Hash) && transfer_spec['tags']['aspera'].is_a?(Hash)
+        if transfer_spec['tags'].is_a?(Hash) && transfer_spec['tags'][Fasp::TransferSpec::TAG_RESERVED].is_a?(Hash)
           # TODO: what is this for ? only on local ascp ?
           # NOTE: important: transfer id must be unique: generate random id
           # using a non unique id results in discard of tags in AoC, and a package is never finalized
           # all sessions in a multi-session transfer must have the same xfer_id (see admin manual)
-          transfer_spec['tags']['aspera']['xfer_id'] ||= SecureRandom.uuid
+          transfer_spec['tags'][Fasp::TransferSpec::TAG_RESERVED]['xfer_id'] ||= SecureRandom.uuid
           Log.log.debug{"xfer id=#{transfer_spec['xfer_id']}"}
           # TODO: useful ? node only ?
-          transfer_spec['tags']['aspera']['xfer_retry'] ||= 3600
+          transfer_spec['tags'][Fasp::TransferSpec::TAG_RESERVED]['xfer_retry'] ||= 3600
         end
         Log.dump('ts', transfer_spec)
 
@@ -85,7 +85,7 @@ module Aspera
         env_args = Parameters.ts_to_env_args(transfer_spec, wss: @options[:wss], ascp_args: @options[:ascp_args])
 
         # add fallback cert and key as arguments if needed
-        if %w[1 force].include?(transfer_spec['http_fallback'])
+        if ['1', 1, true, 'force'].include?(transfer_spec['http_fallback'])
           env_args[:args].unshift('-Y', Installation.instance.path(:fallback_key))
           env_args[:args].unshift('-I', Installation.instance.path(:fallback_cert))
         end
@@ -183,20 +183,20 @@ module Aspera
           end
           # (optional) check it exists
           raise Fasp::Error, "no such file: #{ascp_path}" unless File.exist?(ascp_path)
-          # open random local TCP port for listening for ascp management
+          # open an available (0) local TCP port as ascp management
           mgt_sock = TCPServer.new('127.0.0.1', 0)
           # clone arguments as we eed to modify with mgt port
           ascp_arguments = env_args[:args].clone
-          # add management port
+          # add management port on the selected local port
           ascp_arguments.unshift('-M', mgt_sock.addr[1].to_s)
           # start ascp in sub process
           Log.log.debug do
-            'execute: ' +
-              env_args[:env].map{|k, v| "#{k}=#{Shellwords.shellescape(v)}"}.join(' ') +
-              ' ' +
-              Shellwords.shellescape(ascp_path) +
-              ' ' +
-              ascp_arguments.map{|a|Shellwords.shellescape(a)}.join(' ')
+            [
+              'execute:',
+              env_args[:env].map{|k, v| "#{k}=#{Shellwords.shellescape(v)}"},
+              Shellwords.shellescape(ascp_path),
+              ascp_arguments.map{|a|Shellwords.shellescape(a)}
+            ].flatten.join(' ')
           end
           # start process
           ascp_pid = Process.spawn(env_args[:env], [ascp_path, ascp_path], *ascp_arguments)

data/lib/aspera/fasp/agent_node.rb

@@ -76,10 +76,13 @@ module Aspera
             transfer_spec.delete('EX_ssh_key_paths')
           end
         end
-        if transfer_spec['tags'].is_a?(Hash) && transfer_spec['tags']['aspera'].is_a?(Hash)
-          transfer_spec['tags']['aspera']['xfer_retry'] ||= 150
+        # add mandatory retry parameter for node api
+        ts_tags = transfer_spec['tags']
+        if ts_tags.is_a?(Hash) && ts_tags[Fasp::TransferSpec::TAG_RESERVED].is_a?(Hash)
+          ts_tags[Fasp::TransferSpec::TAG_RESERVED]['xfer_retry'] ||= 150
         end
-        # Optimization in case of sending to the same node (TODO: probably remove this, as /etc/hosts shall be used for that)
+        # Optimization in case of sending to the same node
+        # TODO: probably remove this, as /etc/hosts shall be used for that
         if !transfer_spec['wss_enabled'] && transfer_spec['remote_host'].eql?(URI.parse(node_api_.params[:base_url]).host)
           transfer_spec['remote_host'] = '127.0.0.1'
         end
@@ -116,9 +119,16 @@ module Aspera
             else
               notify_progress(@transfer_id, transfer_data['bytes_transferred'])
             end
+          when 'failed'
+            # Bug in HSTS ? transfer is marked failed, but there is no reason
+            if transfer_data['error_code'].eql?(0) && transfer_data['error_desc'].empty?
+              notify_end(@transfer_id)
+              break
+            end
+            raise Fasp::Error, "status: #{transfer_data['status']}. code: #{transfer_data['error_code']}. description: #{transfer_data['error_desc']}"
           else
             Log.log.warn{"transfer_data -> #{transfer_data}"}
-            raise Fasp::Error, "#{transfer_data['status']}: #{transfer_data['error_desc']}"
+            raise Fasp::Error, "status: #{transfer_data['status']}. code: #{transfer_data['error_code']}. description: #{transfer_data['error_desc']}"
           end
           sleep(1)
         end

data/lib/aspera/fasp/installation.rb

@@ -62,6 +62,7 @@ module Aspera
 
       # location of SDK files
       def sdk_folder=(v)
+        Log.log.debug{"sdk_folder=#{v}"}
         @sdk_dir = v
         sdk_folder
       end