aspera-cli 4.15.0 → 4.16.0

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

@@ -12,6 +12,8 @@ require 'aspera/persistency_action_once'
 require 'aspera/open_application'
 require 'aspera/nagios'
 require 'aspera/id_generator'
+require 'aspera/log'
+require 'aspera/assert'
 require 'xmlsimple'
 require 'json'
 require 'cgi'
@@ -75,10 +77,10 @@ module Aspera
             }
           end
 
-          # extract elements from anonymous faspex link
+          # extract elements from faspex public link
           def get_link_data(public_url)
             public_uri = URI.parse(public_url)
-            raise Cli::BadArgument, 'Public link does not match Faspex format' unless (m = public_uri.path.match(%r{^(.*)/(external.*)$}))
+            assert((m = public_uri.path.match(%r{^(.*)/(external.*)$})), exception_class: Cli::BadArgument){'Public link does not match Faspex format'}
             base = m[1]
             subpath = m[2]
             port_add = public_uri.port.eql?(public_uri.default_port) ? '' : ":#{public_uri.port}"
@@ -91,16 +93,13 @@ module Aspera
             return result
           end
 
-          # get Fasp::Uri::SCHEME URI from entry in xml, and fix problems..
+          # get Fasp::Uri::SCHEME URI from entry in xml, and fix problems.
           def get_fasp_uri_from_entry(entry, raise_no_link: true)
             unless entry.key?('link')
               raise Cli::BadArgument, 'package has no link (deleted?)' if raise_no_link
               return nil
             end
             result = entry['link'].find{|e| e['rel'].eql?('package')}['href']
-            # tags in the end of URL is not well % encoded... there are "=" that should be %3D
-            # TODO: enter ticket to Faspex ?
-            # ##XXif m=result.match(/(=+)$/);result.gsub!(/=+$/,"#{"%3D"*m[1].length}");end
             return result
           end
 
@@ -162,9 +161,9 @@ module Aspera
           max_pages = nil
           result = []
           if !mailbox_query.nil?
-            raise 'query: must be Hash or nil' unless mailbox_query.is_a?(Hash)
-            raise "query: supported params: #{ATOM_EXT_PARAMS}" unless (mailbox_query.keys - ATOM_EXT_PARAMS).empty?
-            raise 'query: startIndex and page are exclusive' if mailbox_query.key?('startIndex') && mailbox_query.key?('page')
+            assert_type(mailbox_query, Hash){'query'}
+            assert((mailbox_query.keys - ATOM_EXT_PARAMS).empty?){"query: supported params: #{ATOM_EXT_PARAMS}"}
+            assert(!(mailbox_query.key?('startIndex') && mailbox_query.key?('page'))){'query: startIndex and page are exclusive'}
             max_items = mailbox_query[MAX_ITEMS]
             mailbox_query.delete(MAX_ITEMS)
             max_pages = mailbox_query[MAX_PAGES]
@@ -271,7 +270,7 @@ module Aspera
             end
             return nagios.result
           when :package
-            command_pkg = options.get_next_command(%i[send recv list show])
+            command_pkg = options.get_next_command(%i[send receive list show], aliases: {recv: :receive})
             case command_pkg
             when :show
               delivery_id = instance_identifier
@@ -284,7 +283,7 @@ module Aspera
               }
             when :send
               delivery_info = options.get_option(:delivery_info, mandatory: true)
-              raise Cli::BadArgument, 'delivery_info must be hash, refer to doc' unless delivery_info.is_a?(Hash)
+              assert_type(delivery_info, Hash, exception_class: Cli::BadArgument){'delivery_info'}
               # actual parameter to faspex API
               package_create_params = {'delivery' => delivery_info}
               public_link_url = options.get_option(:link)
@@ -294,7 +293,7 @@ module Aspera
                 first_source = delivery_info['sources'].first
                 first_source['paths'].push(*transfer.source_list)
                 source_id = instance_identifier(as_option: :remote_source) do |field, value|
-                  raise Cli::BadArgument, 'only name as selector, or give id' unless field.eql?('name')
+                  assert(field.eql?('name'), exception_class: Cli::BadArgument){'only name as selector, or give id'}
                   source_list = api_v3.call({operation: 'GET', subpath: 'source_shares', headers: {'Accept' => 'application/json'}})[:data]['items']
                   self.class.get_source_id_by_name(value, source_list)
                 end
@@ -318,7 +317,7 @@ module Aspera
               end
               # Log.log.debug{Log.dump('transfer_spec',transfer_spec)}
               return Main.result_transfer(transfer.start(transfer_spec))
-            when :recv
+            when :receive
               link_url = options.get_option(:link)
               # list of faspex ID/URI to download
               pkg_id_uri = nil
@@ -341,8 +340,13 @@ module Aspera
                 delivery_id = instance_identifier
                 raise 'empty id' if delivery_id.empty?
                 recipient = options.get_option(:recipient)
-                if ExtendedValue::ALL.eql?(delivery_id)
+                if delivery_id.eql?(ExtendedValue::ALL)
                   pkg_id_uri = mailbox_filtered_entries.map{|i|{id: i[PACKAGE_MATCH_FIELD], uri: self.class.get_fasp_uri_from_entry(i, raise_no_link: false)}}
+                elsif delivery_id.eql?(ExtendedValue::INIT)
+                  assert(skip_ids_persistency){'Only with option once_only'}
+                  skip_ids_persistency.data.clear.concat(mailbox_filtered_entries.map{|i|{id: i[PACKAGE_MATCH_FIELD]}})
+                  skip_ids_persistency.save
+                  return Main.result_status("Initialized skip for #{skip_ids_persistency.data.count} package(s)")
                 elsif !recipient.nil? && recipient.start_with?('*')
                   found_package_link = mailbox_filtered_entries(stop_at_id: delivery_id).find{|p|p[PACKAGE_MATCH_FIELD].eql?(delivery_id)}['link'].first['href']
                   raise "Not Found. Dropbox and Workgroup packages can use the link option with #{Fasp::Uri::SCHEME}" if found_package_link.nil?
@@ -423,17 +427,17 @@ module Aspera
               return {type: :object_list, data: source_list}
             else # :info :node
               source_id = instance_identifier do |field, value|
-                raise Cli::BadArgument, 'only name as selector, or give id' unless field.eql?('name')
+                assert(field.eql?('name'), exception_class: Cli::BadArgument){'only name as selector, or give id'}
                 self.class.get_source_id_by_name(value, source_list)
               end.to_i
               source_name = source_list.find{|i|i['id'].eql?(source_id)}['name']
               source_hash = options.get_option(:storage, mandatory: true)
               # check value of option
-              raise Cli::Error, 'storage option must be a Hash' unless source_hash.is_a?(Hash)
+              assert_type(source_hash, Hash, exception_class: Cli::Error){'storage option'}
               source_hash.each do |name, storage|
-                raise Cli::Error, "storage '#{name}' must be a Hash" unless storage.is_a?(Hash)
+                assert_type(storage, Hash, exception_class: Cli::Error){"storage '#{name}'"}
                 [KEY_NODE, KEY_PATH].each do |key|
-                  raise Cli::Error, "storage '#{name}' must have a '#{key}'" unless storage.key?(key)
+                  assert(storage.key?(key), exception_class: Cli::Error){"storage '#{name}' must have a '#{key}'"}
                 end
               end
               if !source_hash.key?(source_name)
@@ -446,8 +450,8 @@ module Aspera
                 return {data: source_info, type: :single_object}
               when :node
                 node_config = ExtendedValue.instance.evaluate(source_info[KEY_NODE])
-                raise Cli::Error, "bad type for: \"#{source_info[KEY_NODE]}\"" unless node_config.is_a?(Hash)
                 Log.log.debug{"node=#{node_config}"}
+                assert_type(node_config, Hash, exception_class: Cli::Error){source_info[KEY_NODE]}
                 api_node = Rest.new({
                   base_url: node_config['url'],
                   auth:     {

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

@@ -3,10 +3,12 @@
 # spellchecker: ignore workgroups mypackages passcode
 
 require 'aspera/cli/basic_auth_plugin'
+require 'aspera/cli/extended_value'
 require 'aspera/persistency_action_once'
 require 'aspera/id_generator'
 require 'aspera/nagios'
 require 'aspera/environment'
+require 'aspera/assert'
 require 'securerandom'
 require 'tty-spinner'
 
@@ -19,17 +21,17 @@ module Aspera
         API_DETECT = 'api/v5/configuration/ping'
         # list of supported mailbox types (to list packages)
         API_LIST_MAILBOX_TYPES = %w[inbox inbox_history inbox_all inbox_all_history outbox outbox_history pending pending_history all].freeze
-        PACKAGE_ALL_INIT = 'INIT'
         PACKAGE_SEND_FROM_REMOTE_SOURCE = 'remote_source'
         # Faspex API v5: get transfer spec for connect
         TRANSFER_CONNECT = 'connect'
         ADMIN_RESOURCES = %i[
           accounts contacts jobs workgroups shared_inboxes nodes oauth_clients registrations saml_configs
-          metadata_profiles email_notifications
+          metadata_profiles email_notifications alternate_addresses
         ].freeze
         JOB_RUNNING = %w[queued working].freeze
         STANDARD_PATH = '/aspera/faspex'
-        private_constant(*%i[JOB_RUNNING RECIPIENT_TYPES PACKAGE_TERMINATED API_DETECT API_LIST_MAILBOX_TYPES PACKAGE_SEND_FROM_REMOTE_SOURCE])
+        PER_PAGE_DEFAULT = 100
+        private_constant(*%i[JOB_RUNNING RECIPIENT_TYPES PACKAGE_TERMINATED API_DETECT API_LIST_MAILBOX_TYPES PACKAGE_SEND_FROM_REMOTE_SOURCE PER_PAGE_DEFAULT])
         class << self
           def application_name
             'Faspex'
@@ -102,7 +104,7 @@ module Aspera
           options.declare(:auth, 'OAuth type of authentication', values: %i[boot].concat(Oauth::STD_AUTH_TYPES), default: :jwt)
           options.declare(:private_key, 'OAuth JWT RSA private key PEM value (prefix file path with @file:)')
           options.declare(:passphrase, 'OAuth JWT RSA private key passphrase')
-          options.declare(:box, "Package inbox, either shared inbox name or one of #{API_LIST_MAILBOX_TYPES} or #{ExtendedValue::ALL}", default: 'inbox')
+          options.declare(:box, "Package inbox, either shared inbox name or one of: #{API_LIST_MAILBOX_TYPES.join(', ')} or #{ExtendedValue::ALL}", default: 'inbox')
           options.declare(:shared_folder, 'Send package with files from shared folder')
           options.declare(:group_type, 'Type of shared box', values: %i[shared_inboxes workgroups], default: :shared_inboxes)
           options.parse_options!
@@ -168,14 +170,14 @@ module Aspera
                   headers:         {typ: 'JWT'}
                 }
               }})
-          else raise 'Unexpected case for option: auth'
+          else error_unexpected_value(auth_type)
           end
         end
 
         # if recipient is just an email, then convert to expected API hash : name and type
         def normalize_recipients(parameters)
           return unless parameters.key?('recipients')
-          raise 'Field recipients must be an Array' unless parameters['recipients'].is_a?(Array)
+          assert_type(parameters['recipients'], Array){'recipients'}
           recipient_types = RECIPIENT_TYPES
           if parameters.key?('recipient_types')
             recipient_types = parameters['recipient_types']
@@ -236,27 +238,25 @@ module Aspera
             spinner.spin
             sleep(0.5)
           end
-          raise 'internal error'
+          error_unreachable_line
         end
 
-        # get a (full or partial) list of all entities of a given type
+        # Get a (full or partial) list of all entities of a given type
         # @param type [String] the type of entity to list (just a name)
         # @param query [Hash,nil] additional query parameters
-        # @param path [String] optional prefix to add to the path (nil or empty string: no prefix)
+        # @param real_path [String] real path if it's n ot just the type
         # @param item_list_key [String] key in the result to get the list of items
-        def list_entities(type:, path: nil, query: nil, item_list_key: nil)
-          query = {} if query.nil?
+        def list_entities(type:, real_path: nil, query: {}, item_list_key: nil)
           type = type.to_s if type.is_a?(Symbol)
+          assert_type(type, String)
           item_list_key = type if item_list_key.nil?
-          raise "internal error: Invalid type #{type.class}" unless type.is_a?(String)
-          full_path = type
-          full_path = "#{path}/#{full_path}" unless path.nil? || path.empty?
+          full_path = real_path.nil? ? type : real_path
           result = []
           offset = 0
           max_items = query.delete(MAX_ITEMS)
           remain_pages = query.delete(MAX_PAGES)
           # merge default parameters, by default 100 per page
-          query = {'limit'=> 100}.merge(query)
+          query = {'limit'=> PER_PAGE_DEFAULT}.merge(query)
           loop do
             query['offset'] = offset
             page_result = @api_v5.read(full_path, query)[:data]
@@ -275,33 +275,36 @@ module Aspera
         end
 
         # lookup an entity id from its name
-        def lookup_entity_by_field(type:, value:, field: 'name', query: :default, path: nil, item_list_key: nil)
-          query = {'q'=> value} if query.eql?(:default)
-          found = list_entities(type: type, path: path, query: query, item_list_key: item_list_key).select{|i|i[field].eql?(value)}
+        def lookup_entity_by_field(type:, value:, field: 'name', query: :default, real_path: nil, item_list_key: nil)
+          if query.eql?(:default)
+            assert(field.eql?('name')){'Default query is on name only'}
+            query = {'q'=> value}
+          end
+          found = list_entities(type: type, real_path: real_path, query: query, item_list_key: item_list_key).select{|i|i[field].eql?(value)}
           case found.length
           when 0 then raise "No #{type} with #{field} = #{value}"
           when 1 then return found.first
-          else raise "Found #{found.length} #{path} with #{field} = #{value}"
+          else raise "Found #{found.length} #{real_path} with #{field} = #{value}"
           end
         end
 
         # list all packages with optional filter
-        def list_packages_with_filter
+        def list_packages_with_filter(query: {})
           filter = options.get_next_argument('filter', mandatory: false, type: Proc, default: ->(_x){true})
           # translate box name to API prefix (with ending slash)
           box = options.get_option(:box)
-          api_path =
+          real_path =
             case box
-            when ExtendedValue::ALL then '' # only admin can list all packages globally
-            when *API_LIST_MAILBOX_TYPES then box
+            when ExtendedValue::ALL then 'packages' # only admin can list all packages globally
+            when *API_LIST_MAILBOX_TYPES then "#{box}/packages"
             else
               group_type = options.get_option(:group_type)
-              "#{group_type}/#{lookup_entity_by_field(type: group_type, value: box)['id']}"
+              "#{group_type}/#{lookup_entity_by_field(type: group_type, value: box)['id']}/packages"
             end
           return list_entities(
             type: 'packages',
-            query:  query_read_delete(default: {}),
-            path: api_path).select(&filter)
+            query:  query_read_delete(default: query),
+            real_path: real_path).select(&filter)
         end
 
         def package_receive(package_ids)
@@ -315,25 +318,32 @@ module Aspera
               id:      IdGenerator.from_list([
                 'faspex_recv',
                 options.get_option(:url, mandatory: true),
-                options.get_option(:username, mandatory: true)]))
+                options.get_option(:username, mandatory: true),
+                options.get_option(:box, mandatory: true)
+              ]))
           end
+          packages = []
           case package_ids
-          when PACKAGE_ALL_INIT
-            raise 'Only with option once_only' unless skip_ids_persistency
+          when ExtendedValue::INIT
+            assert(skip_ids_persistency){'Only with option once_only'}
             skip_ids_persistency.data.clear.concat(list_packages_with_filter.map{|p|p['id']})
             skip_ids_persistency.save
             return Main.result_status("Initialized skip for #{skip_ids_persistency.data.count} package(s)")
           when ExtendedValue::ALL
             # TODO: if packages have same name, they will overwrite ?
-            package_ids = list_packages_with_filter.map{|p|p['id']}
-            Log.log.debug{Log.dump(:package_ids, package_ids)}
-            Log.log.debug{Log.dump(:skip_ids, skip_ids_persistency.data)}
-            package_ids.reject!{|i|skip_ids_persistency.data.include?(i)} if skip_ids_persistency
-            Log.log.debug{Log.dump(:package_ids, package_ids)}
+            packages = list_packages_with_filter(query: {'status' => 'completed'})
+            Log.log.trace1{Log.dump(:package_ids, packages.map{|p|p['id']})}
+            Log.log.trace1{Log.dump(:skip_ids, skip_ids_persistency.data)}
+            packages.reject!{|p|skip_ids_persistency.data.include?(p['id'])} if skip_ids_persistency
+            Log.log.trace1{Log.dump(:package_ids, packages.map{|p|p['id']})}
+          else
+            # a single id was provided, or a list of ids
+            package_ids = [package_ids] unless package_ids.is_a?(Array)
+            assert_type(package_ids, Array){'Expecting a single package id or a list of ids'}
+            assert(package_ids.all?(String)){'Package id shall be String'}
+            # packages = package_ids.map{|pkg_id|@api_v5.read("packages/#{pkg_id}")[:data]}
+            packages = package_ids.map{|pkg_id|{'id'=>pkg_id}}
           end
-          # a single id was provided
-          # TODO: check package_ids is a list of strings
-          package_ids = [package_ids] if package_ids.is_a?(String)
           result_transfer = []
           param_file_list = {}
           begin
@@ -352,7 +362,8 @@ module Aspera
           else # shared inbox / workgroup
             download_params[:recipient_workgroup_id] = lookup_entity_by_field(type: options.get_option(:group_type), value: box)['id']
           end
-          package_ids.each do |pkg_id|
+          packages.each do |package|
+            pkg_id = package['id']
             formatter.display_status("Receiving package #{pkg_id}")
             # TODO: allow from sent as well ?
             transfer_spec = @api_v5.call(
@@ -406,7 +417,8 @@ module Aspera
           when :delete
             ids = package_id
             ids = [ids] unless ids.is_a?(Array)
-            raise 'Package identifier must be a single id or an Array' unless ids.is_a?(Array) && ids.all?(String)
+            assert_type(ids, Array){'Package identifier'}
+            assert(ids.all?(String)){'Package id shall be String'}
             # API returns 204, empty on success
             @api_v5.call({operation: 'DELETE', subpath: 'packages', headers: {'Accept' => 'application/json'}, json_params: {ids: ids}})
             return Main.result_status('Package(s) deleted')
@@ -523,11 +535,14 @@ module Aspera
               id_as_arg = false
               display_fields = nil
               adm_api = @api_v5
+              special_query = :default
               available_commands = [].concat(Plugin::ALL_OPS)
               case res_type
               when :metadata_profiles
                 res_path = 'configuration/metadata_profiles'
                 list_key = 'profiles'
+              when :alternate_addresses
+                res_path = 'configuration/alternate_addresses'
               when :email_notifications
                 list_key = false
                 id_as_arg = 'type'
@@ -538,11 +553,26 @@ module Aspera
                 adm_api = Rest.new(@api_v5.params.merge({base_url: auth_api_url}))
               when :shared_inboxes, :workgroups
                 available_commands.push(:members, :saml_groups, :invite_external_collaborator)
+                special_query = {'all': true}
+              when :nodes
+                available_commands.push(:shared_folders)
               end
               res_command = options.get_next_command(available_commands)
               case res_command
               when *Plugin::ALL_OPS
-                return entity_command(res_command, adm_api, res_path, item_list_key: list_key, display_fields: display_fields, id_as_arg: id_as_arg)
+                return entity_command(res_command, adm_api, res_path, item_list_key: list_key, display_fields: display_fields, id_as_arg: id_as_arg) do |field, value|
+                  lookup_entity_by_field(
+                    type: res_type, real_path: res_path, field: field, value: value, query: special_query)['id']
+                end
+              when :shared_folders
+                node_id = instance_identifier do |field, value|
+                  lookup_entity_by_field(type: res_type.to_s, field: field, value: value)['id']
+                end
+                sh_path = "#{res_path}/#{node_id}/shared_folders"
+                return entity_action(adm_api, sh_path, item_list_key: 'shared_folders') do |field, value|
+                         lookup_entity_by_field(
+                           type: 'shared_folders', real_path: sh_path, field: field, value: value)['id']
+                       end
               when :invite_external_collaborator
                 shared_inbox_id = instance_identifier { |field, value| lookup_entity_by_field(type: res_type.to_s, field: field, value: value)['id']}
                 creation_payload = value_create_modify(command: res_command, type: [Hash, String])
@@ -550,7 +580,9 @@ module Aspera
                 res_path = "#{res_type}/#{shared_inbox_id}/external_collaborator"
                 result = adm_api.create(res_path, creation_payload)[:data]
                 formatter.display_status(result['message'])
-                result = lookup_entity_by_field(type: 'members', path: "#{res_type}/#{shared_inbox_id}", value: creation_payload['email_address'], query: {})
+                result = lookup_entity_by_field(
+                  type: 'members', real_path: "#{res_type}/#{shared_inbox_id}/members", value: creation_payload['email_address'],
+                  query: {})
                 return {type: :single_object, data: result}
               when :members, :saml_groups
                 res_id = instance_identifier { |field, value| lookup_entity_by_field(type: res_type.to_s, field: field, value: value)['id']}
@@ -607,7 +639,7 @@ module Aspera
             end
           when :gateway
             require 'aspera/faspex_gw'
-            url = value_create_modify(command: command, type: String)
+            url = value_create_modify(command: command, description: 'listening url (e.g. https://localhost:12345)', type: String)
             uri = URI.parse(url)
             server = WebServerSimple.new(uri)
             server.mount(uri.path, Faspex4GWServlet, @api_v5, nil)
@@ -622,7 +654,7 @@ module Aspera
             require 'aspera/faspex_postproc' # cspell:disable-line
             parameters = value_create_modify(command: command)
             parameters = parameters.symbolize_keys
-            raise 'Missing key: url' unless parameters.key?(:url)
+            assert(parameters.key?(:url)){'Missing key: url'}
             uri = URI.parse(parameters[:url])
             parameters[:processing] ||= {}
             parameters[:processing][:root] = uri.path

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

@@ -9,8 +9,9 @@ require 'aspera/hash_ext'
 require 'aspera/id_generator'
 require 'aspera/node'
 require 'aspera/aoc'
-require 'aspera/sync'
 require 'aspera/oauth'
+require 'aspera/node_simulator'
+require 'aspera/assert'
 require 'base64'
 require 'zlib'
 
@@ -303,7 +304,7 @@ module Aspera
               save_to_file: File.join(transfer.destination_folder(Fasp::TransferSpec::DIRECTION_RECEIVE), file_name))
             return Main.result_status("downloaded: #{file_name}")
           end
-          raise 'INTERNAL ERROR'
+          error_unreachable_line
         end
 
         # common API to node and Shares
@@ -412,7 +413,7 @@ module Aspera
               url:     apifid[:api].params[:base_url],
               root_id: apifid[:file_id]
             }
-            raise 'No auth for node' if apifid[:api].params[:auth].nil?
+            assert_values(apifid[:api].params[:auth][:type], %i[basic oauth2])
             case apifid[:api].params[:auth][:type]
             when :basic
               result[:username] = apifid[:api].params[:auth][:username]
@@ -420,7 +421,7 @@ module Aspera
             when :oauth2
               result[:username] = apifid[:api].params[:headers][Aspera::Node::HEADER_X_ASPERA_ACCESS_KEY]
               result[:password] = apifid[:api].oauth_token
-            else raise 'internal error: unknown auth type'
+            else error_unreachable_line
             end
             return {type: :single_object, data: result} if command_repo.eql?(:node_info)
             # check format of bearer token
@@ -463,10 +464,11 @@ module Aspera
             return execute_sync_action do |sync_direction, _local_path, remote_path|
               # Gen4 API
               # direction is push pull, bidi
+              assert_values(sync_direction, %i[push pull bidi])
               ts_direction = case sync_direction
               when :push, :bidi then Fasp::TransferSpec::DIRECTION_SEND
               when :pull then Fasp::TransferSpec::DIRECTION_RECEIVE
-              else raise "internal error: bad direction: #{sync_direction} (#{sync_direction.class})"
+              else error_unreachable_line
               end
               # remote is specified by option to_folder
               apifid = @api_node.resolve_api_fid(top_file_id, remote_path)
@@ -536,12 +538,7 @@ module Aspera
               subpath: "files/#{apifid[:file_id]}/preview",
               headers: {'Accept' => 'image/png'}
             )
-            require 'aspera/preview/terminal'
-            terminal_options = options.get_option(:query, default: {}).symbolize_keys
-            allowed_options = Preview::Terminal.method(:build).parameters.select{|i|i[0].eql?(:key)}.map{|i|i[1]}
-            unknown_options = terminal_options.keys - allowed_options
-            raise "invalid options: #{unknown_options.join(', ')}, use #{allowed_options.join(', ')}" unless unknown_options.empty?
-            return Main.result_status(Preview::Terminal.build(result[:http].body, **terminal_options))
+            return Main.result_picture_in_terminal(options, result[:http].body)
           when :permission
             apifid = apifid_from_next_arg(top_file_id)
             command_perm = options.get_next_command(%i[list create delete])
@@ -574,11 +571,11 @@ module Aspera
               # notify application of creation
               the_app[:api].permissions_send_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})"
+            else error_unreachable_line
             end
-          else raise "INTERNAL ERROR: no case for #{command_repo}"
+          else error_unreachable_line
           end # command_repo
-          # raise 'INTERNAL ERROR: missing return'
+          error_unreachable_line
         end # execute_command_gen4
 
         # This is older API
@@ -683,7 +680,8 @@ module Aspera
           central
           asperabrowser
           basic_token
-          bearer_token].concat(COMMON_ACTIONS).freeze
+          bearer_token
+          simulator].concat(COMMON_ACTIONS).freeze
 
         def execute_action(command=nil, prefix_path=nil)
           command ||= options.get_next_command(ACTIONS)
@@ -906,6 +904,21 @@ module Aspera
             token_info = options.get_next_argument('user and group identification', type: Hash)
             access_key = options.get_option(:username, mandatory: true)
             return Main.result_status(Aspera::Node.bearer_token(payload: token_info, access_key: access_key, private_key: private_key))
+          when :simulator
+            require 'aspera/node_simulator'
+            parameters = value_create_modify(command: command)
+            parameters = parameters.symbolize_keys
+            raise 'Missing key: url' unless parameters.key?(:url)
+            uri = URI.parse(parameters[:url])
+            server = WebServerSimple.new(uri, certificate: parameters[:certificate])
+            server.mount(uri.path, NodeSimulatorServlet, parameters[:credentials], transfer)
+            # on ctrl-c, tell server main loop to exit
+            trap('INT') { server.shutdown }
+            formatter.display_status("Node Simulator listening on #{uri.port}")
+            Log.log.info{"Listening on #{uri.port}"}
+            # this is blocking until server exits
+            server.start
+            return Main.result_status('Simulator terminated')
           end # case command
           raise 'ERROR: shall not reach this line'
         end # execute_action

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

@@ -2,6 +2,8 @@
 
 require 'aspera/cli/basic_auth_plugin'
 require 'aspera/nagios'
+require 'aspera/log'
+require 'aspera/assert'
 require 'xmlsimple'
 
 module Aspera
@@ -95,7 +97,7 @@ module Aspera
               call_args[:url_params][:format] = format
             when :ext
               call_args[:subpath] = "#{call_args[:subpath]}.#{format}"
-            else raise 'unexpected'
+            else error_unexpected_value(call_type)
             end
           end
           result = @api_orch.call(call_args)
@@ -205,7 +207,7 @@ module Aspera
               result[:data] = call_ao('initiate', id: wf_id, args: call_params, accept: override_accept)[:data]
               return result
             end # wf command
-          else raise "ERROR, unknown command: [#{command}]"
+          else error_unexpected_value(command)
           end # case command
         end # execute_action
       end # Orchestrator

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

@@ -13,6 +13,8 @@ require 'aspera/node'
 require 'aspera/hash_ext'
 require 'aspera/timer_limiter'
 require 'aspera/id_generator'
+require 'aspera/log'
+require 'aspera/assert'
 require 'securerandom'
 
 module Aspera
@@ -94,7 +96,7 @@ module Aspera
           end
 
           options.parse_options!
-          raise 'skip_folder shall be an Array, use @json:[...]' unless @option_skip_folders.is_a?(Array)
+          assert_type(@option_skip_folders, Array){'skip_folder'}
           @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}"}
@@ -104,7 +106,7 @@ module Aspera
           @skip_types = []
           value.split(',').each do |v|
             s = v.to_sym
-            raise "not supported: #{v}" unless Aspera::Preview::FileTypes::CONVERSION_TYPES.include?(s)
+            assert_values(s, Aspera::Preview::FileTypes::CONVERSION_TYPES){'skip_types'}
             @skip_types.push(s)
           end
         end
@@ -211,7 +213,7 @@ module Aspera
         end
 
         def do_transfer(direction, folder_id, source_filename, destination='/')
-          raise 'Internal ERROR' if destination.nil? && direction.eql?(Fasp::TransferSpec::DIRECTION_RECEIVE)
+          assert(!(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}}
@@ -420,13 +422,13 @@ module Aspera
               raise Cli::Error, "Folder #{@option_previews_folder} does not exist on node. " \
                 'Please create it in the storage root, or specify an alternate name.' if @previews_folder_entry.nil?
             else
-              raise 'only local storage allowed in this mode' unless @access_key_self['storage']['type'].eql?('local')
+              assert(@access_key_self['storage']['type'].eql?('local')){'only local storage allowed in this mode'}
               @local_storage_root = @access_key_self['storage']['path']
               # TODO: option to override @local_storage_root='xxx'
               @local_storage_root = @local_storage_root[PVCL_LOCAL_STORAGE.length..-1] if @local_storage_root.start_with?(PVCL_LOCAL_STORAGE)
               # TODO: windows could have "C:" ?
-              raise "not local storage: #{@local_storage_root}" unless @local_storage_root.start_with?('/')
-              raise Cli::Error, "Local storage root folder #{@local_storage_root} does not exist." unless File.directory?(@local_storage_root)
+              assert(@local_storage_root.start_with?('/')){"not local storage: #{@local_storage_root}"}
+              assert(File.directory?(@local_storage_root), exception_class: Cli::Error){"Local storage root folder #{@local_storage_root} does not exist."}
               @local_preview_folder = File.join(@local_storage_root, @option_previews_folder)
               raise Cli::Error, "Folder #{@local_preview_folder} does not exist locally. " \
                 'Please create it, or specify an alternate name.' unless File.directory?(@local_preview_folder)
@@ -435,7 +437,7 @@ module Aspera
               Log.log.debug{"marker file: #{marker_file}"}
               if File.exist?(marker_file)
                 ak = File.read(marker_file).chomp
-                raise "mismatch access key in #{marker_file}: contains #{ak}, using #{@access_key_self['id']}" unless @access_key_self['id'].eql?(ak)
+                assert(@access_key_self['id'].eql?(ak)){"mismatch access key in #{marker_file}: contains #{ak}, using #{@access_key_self['id']}"}
               else
                 File.write(marker_file, @access_key_self['id'])
               end

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

@@ -7,6 +7,8 @@ require 'aspera/fasp/transfer_spec'
 require 'aspera/ascmd'
 require 'aspera/ssh'
 require 'aspera/nagios'
+require 'aspera/log'
+require 'aspera/assert'
 require 'tempfile'
 require 'open3'
 
@@ -148,8 +150,9 @@ module Aspera
           end
           ssh_key_list = options.get_option(:ssh_keys)
           if !ssh_key_list.nil?
-            raise 'Expecting single value or array for ssh_keys' unless ssh_key_list.is_a?(Array) || ssh_key_list.is_a?(String)
             ssh_key_list = [ssh_key_list] if ssh_key_list.is_a?(String)
+            assert_type(ssh_key_list, Array){'ssh_keys'}
+            assert(ssh_key_list.all?(String))
             ssh_key_list.map!{|p|File.expand_path(p)}
             Log.log.debug{"SSH keys=#{ssh_key_list}"}
             if !ssh_key_list.empty?
@@ -225,7 +228,7 @@ module Aspera
               else
                 nagios.add_critical('transfer', statuses.reject{|i|i.eql?(:success)}.first.to_s)
               end
-            else raise 'ERROR'
+            else error_unexpected_value(command_nagios)
             end
             return nagios.result
           when *TRANSFER_COMMANDS
@@ -248,7 +251,7 @@ module Aspera
             rescue Aspera::AsCmd::Error => e
               raise Cli::BadArgument, e.extended_message
             end
-          else raise 'internal error: unexpected action'
+          else error_unreachable_line
           end
         end # execute_action
       end # Server