aspera-cli 4.21.2 → 4.23.0

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

@@ -11,8 +11,10 @@ module Aspera
   module Cli
     module Plugins
       class Orchestrator < Cli::BasicAuthPlugin
+        STANDARD_PATH = '/aspera/orchestrator'
+        TEST_ENDPOINT = 'api/remote_node_ping'
+        private_constant :STANDARD_PATH, :TEST_ENDPOINT
         class << self
-          STANDARD_PATH = '/aspera/orchestrator'
           def detect(address_or_url)
             address_or_url = "https://#{address_or_url}" unless address_or_url.match?(%r{^[a-z]{1,6}://})
             urls = [address_or_url]
@@ -21,13 +23,12 @@ module Aspera
             urls.each do |base_url|
               next unless base_url.match?('https?://')
               api = Rest.new(base_url: base_url)
-              test_endpoint = 'api/remote_node_ping'
-              result = api.call(operation: 'GET', subpath: test_endpoint, headers: {'Accept' => 'application/json'}, query: {format: :json})
+              result = api.call(operation: 'GET', subpath: TEST_ENDPOINT, headers: {'Accept' => Rest::MIME_JSON}, query: {format: :json})
               next unless result[:data]['remote_orchestrator_info']
               url = result[:http].uri.to_s
               return {
                 version: result[:data]['remote_orchestrator_info']['orchestrator-version'],
-                url:     url[0..url.index(test_endpoint) - 2]
+                url:     url[0..url.index(TEST_ENDPOINT) - 2]
               }
             rescue StandardError => e
               error = e
@@ -61,27 +62,22 @@ module Aspera
 
         ACTIONS = %i[health info workflow plugins processes].freeze
 
-        # call orchestrator api
-        # @param endpoint [String] the endpoint to call
-        # @param prefix [String] the prefix to add to the endpoint
-        # @param id [String] the id to add to the endpoint
-        # @param ret_style [Symbol] the return style, :header, :arg, :ext(extension)
-        # @param format [String] the format to request, 'json', 'xml', nil
-        # @param args [Hash] the arguments to pass
+        # Call orchestrator API, it's a bit special
+        # @param endpoint   [String]  the endpoint to call
+        # @param ret_style  [Symbol]  the return style, :header, :arg, :ext(extension)
+        # @param format     [String]  the format to request, 'json', 'xml', nil
+        # @param args       [Hash]    the arguments to pass
         # @param xml_arrays [Boolean] if true, force arrays in xml parsing
-        def call_ao(endpoint, prefix: 'api', id: nil, ret_style: nil, format: 'json', args: nil, xml_arrays: true, http: false)
-          # calls are GET
-          call_args = {operation: 'GET', subpath: endpoint}
-          # specify prefix if necessary
-          call_args[:subpath] = "#{prefix}/#{call_args[:subpath]}" unless prefix.nil?
-          # specify id if necessary
-          call_args[:subpath] = "#{call_args[:subpath]}/#{id}" unless id.nil?
+        # @param http       [Boolean] if true, returns the HttpResponse, else
+        def call_ao(endpoint, ret_style: nil, format: 'json', args: nil, xml_arrays: true, http: false)
+          # calls are all GET
+          call_args = {operation: 'GET', subpath: "api/#{endpoint}"}
           ret_style = options.get_option(:ret_style, mandatory: true) if ret_style.nil?
           call_args[:query] = args unless args.nil?
           unless format.nil?
             case ret_style
             when :header
-              call_args[:headers] = {'Accept' => "application/#{format}" }
+              call_args[:headers] = {'Accept' => "application/#{format}"}
             when :arg
               call_args[:query] ||= {}
               call_args[:query][:format] = format
@@ -92,9 +88,9 @@ module Aspera
           end
           result = @api_orch.call(**call_args)
           return result[:http] if http
-          result[:data] = XmlSimple.xml_in(result[:http].body, {'ForceArray' => xml_arrays}) if format.eql?('xml')
-          Log.log.debug{Log.dump(:data, result[:data])}
-          return result[:data]
+          result = format.eql?('xml') ? XmlSimple.xml_in(result[:http].body, {'ForceArray' => xml_arrays}) : result[:data]
+          Log.log.debug{Log.dump(:data, result)}
+          return result
         end
 
         def execute_action
@@ -105,7 +101,7 @@ module Aspera
                 type:      :url,
                 url_query: {
                   'login'    => options.get_option(:username, mandatory: true),
-                  'password' => options.get_option(:password, mandatory: true) }
+                  'password' => options.get_option(:password, mandatory: true)}
               }
             when :head_basic
               {
@@ -136,47 +132,45 @@ module Aspera
             return nagios.result
           when :info
             result = call_ao('remote_node_ping', format: 'xml', xml_arrays: false)
-            return {type: :single_object, data: result}
+            return Main.result_single_object(result)
           when :processes
             # TODO: Bug ? API has only XML format
             result = call_ao('processes_status', format: 'xml')
-            return {type: :object_list, data: result['process']}
+            return Main.result_object_list(result['process'])
           when :plugins
             # TODO: Bug ? only json format on url
             result = call_ao('plugin_version')
-            return {type: :object_list, data: result['Plugin']}
+            return Main.result_object_list(result['Plugin'])
           when :workflow
             command = options.get_next_command(%i[list status inputs details start export])
-            unless [:list].include?(command)
-              wf_id = instance_identifier
-            end
             case command
             when :status
-              wf_id = nil if wf_id.eql?(SpecialValues::ALL)
-              result = call_ao('workflows_status', id: wf_id)
-              return {type: :object_list, data: result['workflows']['workflow']}
+              wf_id = instance_identifier
+              result = call_ao(wf_id.eql?(SpecialValues::ALL) ? 'workflows_status' : "workflows_status/#{wf_id}")
+              return Main.result_object_list(result['workflows']['workflow'])
             when :list
-              result = call_ao('workflows_list', id: 0)
+              result = call_ao('workflows_list/0')
               return {
                 type:   :object_list,
                 data:   result['workflows']['workflow'],
                 fields: %w[id portable_id name published_status published_revision_id latest_revision_id last_modification]
               }
             when :details
-              result = call_ao('workflow_details', id: wf_id)
-              return {type: :object_list, data: result['workflows']['workflow']['statuses']}
+              result = call_ao("workflow_details/#{instance_identifier}")
+              return Main.result_object_list(result['workflows']['workflow']['statuses'])
             when :inputs
-              result = call_ao('workflow_inputs_spec', id: wf_id)
-              return {type: :single_object, data: result['workflow_inputs_spec']}
+              result = call_ao("workflow_inputs_spec/#{instance_identifier}")
+              return Main.result_single_object(result['workflow_inputs_spec'])
             when :export
-              result = call_ao('export_workflow', id: wf_id, format: nil, http: true)
-              return {type: :text, data: result.body}
+              result = call_ao("export_workflow/#{instance_identifier}", format: nil, http: true)
+              return Main.result_text(result.body)
             when :start
               result = {
                 type: :single_object,
                 data: nil
               }
               call_params = {format: :json}
+              wf_id = instance_identifier
               # get external parameters if any
               options.get_next_argument('external_parameters', mandatory: false, validation: Hash, default: {}).each do |name, value|
                 call_params["external_parameters[#{name}]"] = value
@@ -197,7 +191,7 @@ module Aspera
               if call_params['synchronous']
                 result[:type] = :text
               end
-              result[:data] = call_ao('initiate', id: wf_id, args: call_params)
+              result[:data] = call_ao("initiate/#{wf_id}", args: call_params)
               return result
             end
           else Aspera.error_unexpected_value(command)

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

@@ -126,7 +126,7 @@ module Aspera
         # /files/id/files is normally cached in redis, but we can discard the cache
         # but /files/id is not cached
         def get_folder_entries(file_id, request_args=nil)
-          headers = {'Accept' => 'application/json'}
+          headers = {'Accept' => Rest::MIME_JSON}
           headers['X-Aspera-Cache-Control'] = 'no-cache' if @option_folder_reset_cache.eql?(:header)
           return @api_node.call(
             operation: 'GET',
@@ -194,7 +194,7 @@ module Aspera
             if event.dig('data', 'type').eql?('file')
               file_entry = @api_node.read("files/#{event['data']['id']}") rescue nil
               if !file_entry.nil? &&
-                  @option_skip_folders.none?{|d|file_entry['path'].start_with?(d)}
+                  @option_skip_folders.none?{ |d| file_entry['path'].start_with?(d)}
                 file_entry['parent_file_id'] = event['data']['parent_file_id']
                 if event['types'].include?('file.deleted')
                   Log.log.error('TODO'.red)
@@ -460,7 +460,7 @@ module Aspera
                   'id'   => @access_key_self['root_file_id'],
                   'name' => '/',
                   'type' => 'folder',
-                  'path' => '/' }
+                  'path' => '/'}
               else
                 @api_node.read("files/#{scan_id}")
               end

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

@@ -19,6 +19,7 @@ module Aspera
       # implement basic remote access with FASP/SSH
       class Server < Cli::BasicAuthPlugin
         include SyncActions
+
         SSH_SCHEME = 'ssh'
         LOCAL_SCHEME = 'local'
         HTTPS_SCHEME = 'https'
@@ -148,7 +149,7 @@ module Aspera
             ssh_key_list = [ssh_key_list] if ssh_key_list.is_a?(String)
             Aspera.assert_type(ssh_key_list, Array){'ssh_keys'}
             Aspera.assert(ssh_key_list.all?(String))
-            ssh_key_list.map!{|p|File.expand_path(p)}
+            ssh_key_list.map!{ |p| File.expand_path(p)}
             Log.log.debug{"SSH keys=#{ssh_key_list}"}
             if !ssh_key_list.empty?
               @ssh_opts[:keys] = ssh_key_list
@@ -176,7 +177,7 @@ module Aspera
             return Main.result_transfer(transfer.start(transfer_spec))
           when :sync
             # lets ignore the arguments provided by execute_sync_action, we just give the transfer spec
-            return execute_sync_action {transfer_spec}
+            return execute_sync_action{transfer_spec}
           end
         end
 
@@ -220,7 +221,7 @@ module Aspera
               if TransferAgent.session_status(statuses).eql?(:success)
                 nagios.add_ok('transfer', 'ok')
               else
-                nagios.add_critical('transfer', statuses.reject{|i|i.eql?(:success)}.first.to_s)
+                nagios.add_critical('transfer', statuses.reject{ |i| i.eql?(:success)}.first.to_s)
               end
             else Aspera.error_unexpected_value(command_nagios)
             end
@@ -236,11 +237,11 @@ module Aspera
               when :mkdir, :mv, :cp, :rm
                 return Main.result_success
               when :ls
-                return {type: :object_list, data: result.map(&:stringify_keys), fields: %w[zmode zuid zgid size mtime name]}
+                return Main.result_object_list(result.map(&:stringify_keys), fields: %w[zmode zuid zgid size mtime name])
               when :df
-                return {type: :object_list, data: result.map(&:stringify_keys)}
+                return Main.result_object_list(result.map(&:stringify_keys))
               when :du, :md5sum, :info
-                return {type: :single_object, data: result.stringify_keys}
+                return Main.result_single_object(result.stringify_keys)
               end
             rescue AsCmd::Error => e
               raise Cli::BadArgument, e.extended_message

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

@@ -50,7 +50,7 @@ module Aspera
           end
         end
 
-        def initialize(**env)
+        def initialize(**_)
           super
         end
 
@@ -72,14 +72,14 @@ module Aspera
                 .call(
                   operation: 'GET',
                   subpath: 'ping',
-                  headers: {'content-type': 'application/json'})
+                  headers: {'content-type': Rest::MIME_JSON})
               raise 'Shares not detected' unless res[:http].body.eql?(' ')
               nagios.add_ok('shares api', 'accessible')
             rescue StandardError => e
               nagios.add_critical('API', e.to_s)
             end
             return nagios.result
-          when :repository, :files
+          when :files
             api_shares_node = basic_auth_api(NODE_API_PATH)
             repo_command = options.get_next_command(Node::COMMANDS_SHARES)
             return Node
@@ -138,9 +138,9 @@ module Aspera
                 return entity_action(api_shares_admin, entities_path, is_singleton: !entity_verb.eql?(:share_permissions))
               when :import # saml
                 return do_bulk_operation(command: entity_verb, descr: 'user information') do |entity_parameters|
-                  entity_parameters = entity_parameters.transform_keys{|k|k.gsub(/\s+/, '_').downcase}
+                  entity_parameters = entity_parameters.transform_keys{ |k| k.gsub(/\s+/, '_').downcase}
                   Aspera.assert_type(entity_parameters, Hash)
-                  SAML_IMPORT_MANDATORY.each{|p|raise "missing mandatory field: #{p}" if entity_parameters[p].nil?}
+                  SAML_IMPORT_MANDATORY.each{ |p| raise "missing mandatory field: #{p}" if entity_parameters[p].nil?}
                   entity_parameters.each_key do |p|
                     raise "unsupported field: #{p}, use: #{SAML_IMPORT_ALLOWED.join(',')}" unless SAML_IMPORT_ALLOWED.include?(p)
                   end

data/lib/aspera/cli/sync_actions.rb

@@ -7,30 +7,30 @@ module Aspera
   module Cli
     # Module for sync actions
     module SyncActions
-      # optional simple command line arguments for sync
-      # in Array to keep option order
+      # Optional simple command line arguments for sync
+      # in Array to keep order as on command line
       # conf: key in option --conf
       # args: key for command line args
       # values: possible values for argument
       # type: type for validation
-      SYNC_ARGUMENTS_INFO = [
+      ARGUMENTS_INFO = [
         {
           conf:   'direction',
           args:   'direction',
           values: Transfer::Sync::DIRECTIONS
-        }, {
-          conf: 'remote.path',
-          args: 'remote_dir',
-          type: String
         }, {
           conf: 'local.path',
           args: 'local_dir',
           type: String
+        }, {
+          conf: 'remote.path',
+          args: 'remote_dir',
+          type: String
         }
       ].freeze
       # name of minimal arguments required, also used to generate a session name
-      SYNC_SIMPLE_ARGS = SYNC_ARGUMENTS_INFO.map{|i|i[:conf]}.freeze
-      private_constant :SYNC_ARGUMENTS_INFO, :SYNC_SIMPLE_ARGS
+      ARGUMENTS_LIST = ARGUMENTS_INFO.map{ |i| i[:conf]}.freeze
+      private_constant :ARGUMENTS_INFO
 
       class << self
         def declare_options(options)
@@ -42,7 +42,7 @@ module Aspera
       def sync_args_to_params(async_params)
         # sync session parameters can be provided on command line instead of sync_info
         arguments = {}
-        SYNC_ARGUMENTS_INFO.each do |info|
+        ARGUMENTS_INFO.each do |info|
           value = options.get_next_argument(
             info[:conf],
             mandatory: false,
@@ -52,9 +52,9 @@ module Aspera
           arguments[info[:conf]] = value.to_s
         end
         Log.log.debug{Log.dump('arguments', arguments)}
-        raise Cli::BadArgument, "Provide 0 or 3 arguments, not #{arguments.keys.length} for: #{SYNC_SIMPLE_ARGS.join(', ')}" unless
-          [0, 3].include?(arguments.keys.length)
-        if !arguments.empty?
+        case arguments.keys.length
+        when 0 then nil
+        when 3
           session_info = async_params
           param_path = :conf
           if async_params.key?('sessions') || async_params.key?('instance')
@@ -63,7 +63,7 @@ module Aspera
             session_info = async_params['sessions'][0]
             param_path = :args
           end
-          SYNC_ARGUMENTS_INFO.each do |info|
+          ARGUMENTS_INFO.each do |info|
             key_path = info[param_path].split('.')
             hash_for_key = session_info
             if key_path.length > 1
@@ -76,10 +76,11 @@ module Aspera
           end
           if !session_info.key?('name')
             # if no name is specified, generate one from simple arguments
-            session_info['name'] = SYNC_SIMPLE_ARGS.filter_map do |arg_name|
-              arguments[arg_name]&.gsub(/[^a-zA-Z0-9]/, '')
-            end.reject(&:empty?).join('_')
+            session_info['name'] = ARGUMENTS_LIST.filter_map do |arg_name|
+              arguments[arg_name]&.gsub(/[^a-zA-Z0-9]+/, '_')
+            end.reject(&:empty?).join('_').gsub(/__+/, '_')
           end
+        else raise Cli::BadArgument, "Provide 0 or 3 arguments, not #{arguments.keys.length} for: #{ARGUMENTS_LIST.join(', ')}"
         end
       end
 
@@ -100,7 +101,7 @@ module Aspera
           when :status
             sync_session_name = options.get_next_argument('name of sync session', mandatory: false, validation: String)
             async_params = options.get_option(:sync_info, mandatory: true)
-            return {type: :single_object, data: Transfer::Sync.admin_status(async_params, sync_session_name)}
+            return Main.result_single_object(Transfer::Sync.admin_status(async_params, sync_session_name))
           end
         end
       end

data/lib/aspera/cli/transfer_agent.rb

@@ -38,7 +38,7 @@ module Aspera
         # @return :success if all sessions statuses returned by "start" are success
         # else return the first error exception object
         def session_status(statuses)
-          error_statuses = statuses.reject{|i|i.eql?(:success)}
+          error_statuses = statuses.reject{ |i| i.eql?(:success)}
           return :success if error_statuses.empty?
           return error_statuses.first
         end
@@ -88,14 +88,6 @@ module Aspera
       # add other transfer spec parameters
       def option_transfer_spec_deep_merge(ts); @transfer_spec_command_line.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_command_line)
-        # 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
-
       attr_reader :transfer_info
 
       # multiple option are merged
@@ -173,9 +165,10 @@ module Aspera
 
       # This is how the list of files to be transferred is specified
       # get paths suitable for transfer spec from command line
+      # @param default [String] if set, used as default file for --sources=@args
       # @return [Hash] {source: (mandatory), destination: (optional)}
       # computation is done only once, cache is kept in @transfer_paths
-      def ts_source_paths
+      def ts_source_paths(default: nil)
         # return cache if set
         return @transfer_paths unless @transfer_paths.nil?
         # start with lower priority : get paths from transfer spec on command line
@@ -185,8 +178,9 @@ module Aspera
         case file_list
         when nil, FILE_LIST_FROM_ARGS
           Log.log.debug('getting file list as parameters')
+          Aspera.assert_type(default, Array) unless default.nil?
           # get remaining arguments
-          file_list = @opt_mgr.get_next_argument('source file list', multiple: true)
+          file_list = @opt_mgr.get_next_argument('source file list', multiple: true, default: default)
           raise Cli::BadArgument, 'specify at least one file on command line or use ' \
             "--sources=#{FILE_LIST_FROM_TRANSFER_SPEC} to use transfer spec" if !file_list.is_a?(Array) || file_list.empty?
         when FILE_LIST_FROM_TRANSFER_SPEC
@@ -199,7 +193,7 @@ module Aspera
           return @transfer_paths
         when Array
           Log.log.debug('getting file list as extended value')
-          raise Cli::BadArgument, 'sources must be a Array of String' if !file_list.reject{|f|f.is_a?(String)}.empty?
+          raise Cli::BadArgument, 'sources must be a Array of String' if !file_list.reject{ |f| f.is_a?(String)}.empty?
         else
           raise Cli::BadArgument, "sources must be a Array, not #{file_list.class}"
         end
@@ -211,10 +205,10 @@ module Aspera
         case source_type
         when :list
           # when providing a list, just specify source
-          @transfer_paths = file_list.map{|i|{'source' => i}}
+          @transfer_paths = file_list.map{ |i| {'source' => i}}
         when :pair
           Aspera.assert(file_list.length.even?, exception_class: Cli::BadArgument){"When using pair, provide an even number of paths: #{file_list.length}"}
-          @transfer_paths = file_list.each_slice(2).to_a.map{|s, d|{'source' => s, 'destination' => d}}
+          @transfer_paths = file_list.each_slice(2).to_a.map{ |s, d| {'source' => s, 'destination' => d}}
         else Aspera.error_unexpected_value(source_type)
         end
         Log.log.debug{"paths=#{@transfer_paths}"}
@@ -252,7 +246,9 @@ module Aspera
         # update command line paths, unless destination already has one
         @transfer_spec_command_line['paths'] = transfer_spec['paths'] || ts_source_paths
         # updated transfer spec with command line
-        updated_ts(transfer_spec)
+        transfer_spec.deep_merge!(@transfer_spec_command_line)
+        # recursively remove values that are nil (user wants to delete)
+        transfer_spec.deep_do{ |hash, key, value, _unused| hash.delete(key) if value.nil?}
         # if TS from app has content_protection (e.g. F5), that means content is protected: ask password if not provided
         if transfer_spec['content_protection'].eql?('decrypt') && !transfer_spec.key?('content_protection_password')
           transfer_spec['content_protection_password'] = @opt_mgr.prompt_user_input('content protection password', sensitive: true)

data/lib/aspera/cli/transfer_progress.rb

@@ -32,7 +32,7 @@ module Aspera
         if @progress_bar.nil?
           @progress_bar = ProgressBar.create(
             format:      '%t %a %B %p%% %r Mbps %E',
-            rate_scale:  lambda{|rate|rate / Environment::BYTES_PER_MEBIBIT},
+            rate_scale:  lambda{ |rate| rate / Environment::BYTES_PER_MEBIBIT},
             title:       '',
             total:       nil)
         end
@@ -86,7 +86,7 @@ module Aspera
       private
 
       def total(key)
-        @sessions.values.inject(0){|m, s|m + s[key]}
+        @sessions.values.inject(0){ |m, s| m + s[key]}
       end
     end
   end

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.21.2'
+    VERSION = '4.23.0'
   end
 end