aspera-cli 4.25.4 → 4.26.0.pre

data/lib/aspera/cli/main.rb

@@ -12,18 +12,34 @@ require 'aspera/cli/hints'
 require 'aspera/secret_hider'
 require 'aspera/log'
 require 'aspera/assert'
+require 'net/ssh/errors'
+require 'openssl'
 
 module Aspera
   module Cli
     # Global objects shared with plugins
     class Context
+      # @!attribute [rw] options
+      #   @return [Manager] the command line options manager
+      # @!attribute [rw] transfer
+      #   @return [TransferAgent] the transfer agent, used by transfer plugins
+      # @!attribute [rw] config
+      #   @return [Plugins::Config] the configuration plugin, used by plugins to get configuration values and presets
+      # @!attribute [rw] formatter
+      #   @return [Formatter] the formatter, used by plugins to display results and messages
+      # @!attribute [rw] persistency
+      #   @return [Object] # whatever the type is
+      # @!attribute [rw] man_header
+      #   @return [Boolean] whether to display the manual header in plugin help
       MEMBERS = %i[options transfer config formatter persistency man_header].freeze
       attr_accessor(*MEMBERS)
 
+      # Initialize all members to nil, so that they are defined and can be validated later
       def initialize
-        @man_header = true
+        MEMBERS.each{ |i| instance_variable_set(:"@#{i}", nil)}
       end
 
+      # Validate that all members are set, raise exception if not
       def validate
         MEMBERS.each do |i|
           Aspera.assert(instance_variable_defined?(:"@#{i}"))
@@ -35,7 +51,7 @@ module Aspera
         transfer.eql?(:only_manual)
       end
 
-      def only_manual
+      def only_manual!
         @transfer = :only_manual
       end
     end
@@ -89,13 +105,15 @@ module Aspera
           status_table.each do |item|
             worst = TransferAgent.session_status(item[STATUS_FIELD])
             global_status = worst unless worst.eql?(:success)
-            item[STATUS_FIELD] = item[STATUS_FIELD].map(&:to_s).join(',')
+            item[STATUS_FIELD] = item[STATUS_FIELD].join(',')
           end
           raise global_status unless global_status.eql?(:success)
           return result_object_list(status_table)
         end
 
         # Display image for that URL or directly blob
+        #
+        # @param url_or_blob [String] URL or blob to display as image
         def result_image(url_or_blob)
           return {type: :image, data: url_or_blob}
         end
@@ -111,6 +129,9 @@ module Aspera
         end
 
         # A list of values
+        #
+        # @param data [Array] The list of values
+        # @param name [String] The name of the list (used for display)
         def result_value_list(data, name: 'id')
           Aspera.assert_type(data, Array)
           Aspera.assert_type(name, String)
@@ -155,7 +176,9 @@ module Aspera
         execute_command = true
         # Catch exceptions
         begin
-          init_agents_options_plugins
+          init_agents_and_options
+          # Find plugins, shall be after parse! ?
+          Plugins::Factory.instance.add_plugins_from_lookup_folders
           # Help requested without command ? (plugins must be known here)
           show_usage if @option_help && @context.options.command_or_arg_empty?
           generate_bash_completion if @bash_completion
@@ -253,17 +276,11 @@ module Aspera
         return
       end
 
-      def init_agents_options_plugins
-        init_agents_and_options
-        # Find plugins, shall be after parse! ?
-        Plugins::Factory.instance.add_plugins_from_lookup_folders
-      end
-
       def show_usage(all: true, exit: true)
         # Display main plugin options (+config)
         @context.formatter.display_message(:error, @context.options.parser)
         if all
-          @context.only_manual
+          @context.only_manual!
           # List plugins that have a "require" field, i.e. all but main plugin
           Plugins::Factory.instance.plugin_list.each do |plugin_name_sym|
             # Config was already included in the global options
@@ -283,6 +300,7 @@ module Aspera
 
       # This can throw exception if there is a problem with the environment, needs to be caught by execute method
       def init_agents_and_options
+        @context.man_header = true
         # Create formatter, in case there is an exception, it is used to display.
         @context.formatter = Formatter.new
         # Create command line manager with arguments
@@ -336,7 +354,7 @@ module Aspera
           OPTIONS
           #{t}Options begin with a '-' (minus), and value is provided on command line.
           #{t}Special values are supported beginning with special prefix @pfx:, where pfx is one of:
-          #{t}#{ExtendedValue.instance.modifiers.map(&:to_s).join(', ')}
+          #{t}#{ExtendedValue.instance.modifiers.join(', ')}
           #{t}Dates format is 'DD-MM-YY HH:MM:SS', or 'now' or '-<num>h'
 
           ARGS

data/lib/aspera/cli/manager.rb

@@ -194,7 +194,9 @@ module Aspera
           [error_msg, 'Use:'].concat(accept_list.map{ |c| "- #{c}"}.sort).join("\n")
         end
 
-        # change option name with dash to name with underscore
+        # Change option name with dash to name with underscore
+        # @param name [String] option name
+        # @return [String]
         def option_line_to_name(name)
           return name.gsub(OPTION_SEP_LINE, OPTION_SEP_SYMBOL)
         end
@@ -211,7 +213,7 @@ module Aspera
       def initialize(program_name, argv = nil)
         # command line values *not* starting with '-'
         @unprocessed_cmd_line_arguments = []
-        # command line values starting with '-'
+        # command line values starting with at least one '-'
         @unprocessed_cmd_line_options = []
         # a copy of all initial options
         @initial_cli_options = []
@@ -330,7 +332,7 @@ module Aspera
 
       # @param descr       [String] description for help
       # @param mandatory   [Boolean] if true, raise error if option not set
-      # @param multiple    [Boolean] if true, return remaining arguments (Array) unil END
+      # @param multiple    [Boolean] if true, return remaining arguments (Array) until END
       # @param accept_list [Array, NilClass] list of allowed values (Symbol)
       # @param validation  [Class, Array, NilClass] Accepted value type(s) or list of Symbols
       # @param aliases     [Hash] map of aliases: key = alias, value = real value
@@ -466,21 +468,17 @@ module Aspera
       # @return [Hash] options as taken from config file and command line just before command execution
       def unprocessed_options_with_value
         result = {}
-        @initial_cli_options.each do |option_value|
-          case option_value
-          when /^#{OPTION_PREFIX}([^=]+)$/o
-            # ignore
-          when /^#{OPTION_PREFIX}([^=]+)=(.*)$/o
-            name = Regexp.last_match(1)
-            value = Regexp.last_match(2)
-            name.gsub!(OPTION_SEP_LINE, OPTION_SEP_SYMBOL)
-            value = ExtendedValue.instance.evaluate(value, context: "option: #{name}")
-            Log.log.debug{"option #{name}=#{value}"}
-            result[name] = value
-            @unprocessed_cmd_line_options.delete(option_value)
-          else
-            raise Cli::BadArgument, "wrong option format: #{option_value}"
-          end
+        @initial_cli_options.each do |option_argument|
+          # ignore short options
+          next unless option_argument.start_with?(OPTION_PREFIX)
+          name, value = option_argument[OPTION_PREFIX.length..-1].split(OPTION_VALUE_SEPARATOR, 2)
+          # ignore options without value
+          next if value.nil?
+          Log.log.debug{"option #{name}=#{value}"}
+          path = name.split(DotContainer::SEPARATOR)
+          path[0] = self.class.option_line_to_name(path[0])
+          DotContainer.dotted_to_container(path, smart_convert(value), result)
+          @unprocessed_cmd_line_options.delete(option_argument)
         end
         return result
       end
@@ -516,20 +514,25 @@ module Aspera
         rescue OptionParser::InvalidOption => e
           Log.log.trace1{"InvalidOption #{e}".red}
           # An option like --a.b.c=d does: a={"b":{"c":ext_val(d)}}
-          if (m = e.args.first.match(/^--([a-z\-]+)\.([^=]+)=(.+)$/))
-            option, path, value = m.captures
-            option_sym = self.class.option_line_to_name(option).to_sym
-            if @declared_options.key?(option_sym)
-              set_option(option_sym, DotContainer.dotted_to_container(path, smart_convert(value), get_option(option_sym)), where: 'dotted')
-              retry
+          if e.args.first.start_with?(OPTION_PREFIX)
+            name, value = e.args.first[OPTION_PREFIX.length..-1].split(OPTION_VALUE_SEPARATOR, 2)
+            if !value.nil?
+              path = name.split(DotContainer::SEPARATOR)
+              option_sym = self.class.option_line_to_name(path.shift)
+              if @declared_options.key?(option_sym)
+                # it's a known option, so let's process it
+                set_option(option_sym, DotContainer.dotted_to_container(path, smart_convert(value), get_option(option_sym)), where: 'dotted')
+                # resume to next
+                retry
+              end
             end
           end
-          # save for later processing
+          # Save for later processing
           unknown_options.push(e.args.first)
           retry
         end
         Log.log.trace1{"remains: #{unknown_options}"}
-        # set unprocessed options for next time
+        # Set unprocessed options for next time
         @unprocessed_cmd_line_options = unknown_options
       end
 
@@ -596,9 +599,9 @@ module Aspera
         ExtendedValue.assert_no_value(arg, :p)
         result = nil
         get_next_argument(:args, multiple: true).each do |arg|
-          Aspera.assert(arg.include?(OPTION_VALUE_SEPARATOR)){"Positional argument: #{arg} does not inlude #{OPTION_VALUE_SEPARATOR}"}
+          Aspera.assert(arg.include?(OPTION_VALUE_SEPARATOR)){"Positional argument: #{arg} does not include #{OPTION_VALUE_SEPARATOR}"}
           path, value = arg.split(OPTION_VALUE_SEPARATOR, 2)
-          result = DotContainer.dotted_to_container(path, smart_convert(value), result)
+          result = DotContainer.dotted_to_container(path.split(DotContainer::SEPARATOR), smart_convert(value), result)
         end
         result
       end

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

@@ -744,7 +744,7 @@ module Aspera
         # Short link entity: `short_links` have:
         # - a numerical id, e.g. `764412`
         # - a resource type, e.g. `UrlToken`
-        # - a ressource id, e.g. `scQ7uXPbvQ`
+        # - a resource id, e.g. `scQ7uXPbvQ`
         # - a short URL path, e.g. `dxyRpT9`
         # @param shared_data [Hash] Information for shared data: dropbox_id+name or file_id+node_id
         # @param &perm_block [Proc] Optional: create/modify/delete permissions on node
@@ -887,7 +887,7 @@ module Aspera
 
         def reject_packages_from_persistency(all_packages, skip_ids_persistency)
           return if skip_ids_persistency.nil?
-          skip_package = skip_ids_persistency.data.each_with_object({}){ |i, m| m[i] = true}
+          skip_package = skip_ids_persistency.data.to_h{ |i| [i, true]}
           all_packages.reject!{ |pkg| skip_package[pkg['id']]}
         end
 

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

@@ -190,7 +190,7 @@ module Aspera
             return Main.result_single_object(api.read(one_res_path), fields: display_fields)
           when :list
             if tclo
-              data, total = list_entities_limit_offset_total_count(api: api, entity:, items_key: items_key, query: query_read_delete(default: list_query))
+              data, total = api.list_entities_limit_offset_total_count(entity:, items_key: items_key, query: query_read_delete(default: list_query))
               return Main.result_object_list(data, total: total, fields: display_fields)
             end
             data, http = api.read(entity, query_read_delete, ret: :both)
@@ -259,86 +259,9 @@ module Aspera
           return value
         end
 
-        # Get a (full or partial) list of all entities of a given type with query: offset/limit
-        # @param api       [Rest]          API object
-        # @param entity    [String,Symbol] API endpoint of entity to list
-        # @param items_key [String]        Key in the result to get the list of items (Default: same as `entity`)
-        # @param query     [Hash,nil]      Additional query parameters
-        # @return [Array<(Array<Hash>, Integer)>] items, total_count
-        def list_entities_limit_offset_total_count(
-          api:,
-          entity:,
-          items_key: nil,
-          query: nil
-        )
-          entity = entity.to_s if entity.is_a?(Symbol)
-          items_key = entity.split('/').last if items_key.nil?
-          query = {} if query.nil?
-          Aspera.assert_type(entity, String)
-          Aspera.assert_type(items_key, String)
-          Aspera.assert_type(query, Hash)
-          Log.log.debug{"list_entities t=#{entity} k=#{items_key} q=#{query}"}
-          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'=> PER_PAGE_DEFAULT}.merge(query)
-          total_count = nil
-          loop do
-            query['offset'] = offset
-            page_result = api.read(entity, query)
-            Aspera.assert_type(page_result[items_key], Array)
-            result.concat(page_result[items_key])
-            # Reach the limit set by user ?
-            if !max_items.nil? && (result.length >= max_items)
-              result = result.slice(0, max_items)
-              break
-            end
-            total_count ||= page_result['total_count']
-            break if result.length >= total_count
-            remain_pages -= 1 unless remain_pages.nil?
-            break if remain_pages == 0
-            offset += page_result[items_key].length
-            RestParameters.instance.spinner_cb.call("#{result.length} / #{total_count || '?'}")
-          end
-          RestParameters.instance.spinner_cb.call(action: :success)
-          return result, total_count
-        end
-
-        # Lookup an entity id from its name.
-        # Uses query `q` if `query` is `:default` and `field` is `name`.
-        # @param entity    [String] Type of entity to lookup, by default it is the path, and it is also the field name in result
-        # @param value     [String] Value to lookup
-        # @param field     [String] Field to match, by default it is `'name'`
-        # @param items_key [String] Key in the result to get the list of items (override entity)
-        # @param query     [Hash]   Additional query parameters (Default: `:default`)
-        def lookup_entity_by_field(api:, entity:, value:, field: 'name', items_key: nil, query: :default)
-          if query.eql?(:default)
-            Aspera.assert(field.eql?('name')){'Default query is on name only'}
-            query = {'q'=> value}
-          end
-          lookup_entity_generic(entity: entity, field: field, value: value){list_entities_limit_offset_total_count(api: api, entity: entity, items_key: items_key, query: query).first}
-        end
-
-        # Lookup entity by field and value. Extract single result from list of result returned by block.
-        # @param entity    [String] Type of entity to lookup, by default it is the path, and it is also the field name in result
-        # @param value     [String] Value to lookup
-        # @param field     [String] Field to match, by default it is `'name'`
-        # @param block     [Proc]   Get list of entity matching query.
-        def lookup_entity_generic(entity:, value:, field: 'name', &block)
-          Aspera.assert(block_given?)
-          found = yield
-          Aspera.assert_array_all(found, Hash)
-          found = found.select{ |i| i[field].eql?(value)}
-          return found.first if found.length.eql?(1)
-          raise Cli::BadIdentifier.new(entity, value, field: field, count: found.length)
-        end
-
-        PER_PAGE_DEFAULT = 1000
         # Percent selector: select by this field for this value
         REGEX_LOOKUP_ID_BY_FIELD = /^%([^:]+):(.*)$/
-        private_constant :PER_PAGE_DEFAULT, :REGEX_LOOKUP_ID_BY_FIELD
+        private_constant :REGEX_LOOKUP_ID_BY_FIELD
       end
     end
   end

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

@@ -211,7 +211,7 @@ module Aspera
                 end
               # add special key
               package['items'] = package['link'].is_a?(Array) ? package['link'].length : 0
-              package['metadata'] = package['metadata']['field'].each_with_object({}){ |i, m| m[i['name']] = i['content']}
+              package['metadata'] = package['metadata']['field'].to_h{ |i| [i['name'], i['content']]}
               # if we look for a specific package
               stop_condition = true if !stop_at_id.nil? && stop_at_id.eql?(package[PACKAGE_MATCH_FIELD])
               # keep only those for the specified recipient

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

@@ -108,16 +108,17 @@ module Aspera
         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')
-          Aspera.assert_type(parameters['recipients'], Array){'recipients'}
+        def normalize_recipients(parameters, type)
+          type = type.to_s
+          return unless parameters.key?(type)
+          Aspera.assert_type(parameters[type], Array){type}
           recipient_types = Api::Faspex::RECIPIENT_TYPES
           if parameters.key?('recipient_types')
             recipient_types = parameters['recipient_types']
             parameters.delete('recipient_types')
             recipient_types = [recipient_types] unless recipient_types.is_a?(Array)
           end
-          parameters['recipients'].map! do |recipient_data|
+          parameters[type].map! do |recipient_data|
             # If just a string, make a general lookup and build expected name/type hash
             if recipient_data.is_a?(String)
               matched = @api_v5.lookup_by_name('contacts', recipient_data, query: Rest.php_style({context: 'packages', type: recipient_types}))
@@ -157,7 +158,7 @@ module Aspera
           end
         end
 
-        # @param [Srting] job identifier
+        # @param [String] job identifier
         # @return [Hash] result of API call for job status
         def wait_for_job(job_id)
           result = nil
@@ -182,13 +183,9 @@ module Aspera
             when *Api::Faspex::API_LIST_MAILBOX_TYPES then "#{box}/packages"
             else
               group_type = options.get_option(:group_type)
-              "#{group_type}/#{lookup_entity_by_field(api: @api_v5, entity: group_type, value: box)['id']}/packages"
+              "#{group_type}/#{@api_v5.lookup_entity_by_field(entity: group_type, value: box)['id']}/packages"
             end
-          list, total = list_entities_limit_offset_total_count(
-            api: @api_v5,
-            entity: entity,
-            query:  query_read_delete(default: query)
-          )
+          list, total = @api_v5.list_entities_limit_offset_total_count(entity: entity, query: query_read_delete(default: query))
           return list.select(&filter), total
         end
 
@@ -251,7 +248,7 @@ module Aspera
             type:          Api::Faspex.box_type(box),
             transfer_type: Api::Faspex::TRANSFER_CONNECT
           }
-          # download_params[:recipient_workgroup_id] = lookup_entity_by_field(api: @api_v5, entity: options.get_option(:group_type), value: box)['id'] if !Api::Faspex::API_LIST_MAILBOX_TYPES.include?(box) && box != SpecialValues::ALL
+          # download_params[:recipient_workgroup_id] = @api_v5.lookup_entity_by_field(entity: options.get_option(:group_type), value: box)['id'] if !Api::Faspex::API_LIST_MAILBOX_TYPES.include?(box) && box != SpecialValues::ALL
           packages.each do |package|
             pkg_id = package['id']
             formatter.display_status("Receiving package #{pkg_id}")
@@ -286,7 +283,7 @@ module Aspera
               recipient_type: @api_v5.pub_link_context['recipient_type']
             }]
           end
-          normalize_recipients(parameters)
+          PACKAGE_RECIPIENT_TYPES.each{ |type| normalize_recipients(parameters, type)}
           # User specified content prot in tspec, but faspex requires in package creation
           # `transfer_spec/upload` will set `content_protection`
           if transfer.user_transfer_spec['content_protection'] && !parameters.key?('ear_enabled')
@@ -308,8 +305,7 @@ module Aspera
           else
             # send from remote shared folder
             if (m = Base.percent_selector(shared_folder))
-              shared_folder = lookup_entity_by_field(
-                api: @api_v5,
+              shared_folder = @api_v5.lookup_entity_by_field(
                 entity: 'shared_folders',
                 field: m[:field],
                 value: m[:value]
@@ -464,12 +460,12 @@ module Aspera
           case res_command
           when *ALL_OPS
             return entity_execute(command: res_command, **exec_args) do |field, value|
-                     lookup_entity_by_field(api: @api_v5, entity: exec_args[:entity], value: value, field: field, items_key: exec_args[:items_key], query: res_id_query)['id']
+                     @api_v5.lookup_entity_by_field(entity: exec_args[:entity], value: value, field: field, items_key: exec_args[:items_key], query: res_id_query)['id']
                    end
           when :shared_folders
             # nodes
             node_id = instance_identifier do |field, value|
-              lookup_entity_by_field(api: @api_v5, entity: 'nodes', field: field, value: value)['id']
+              @api_v5.lookup_entity_by_field(entity: 'nodes', field: field, value: value)['id']
             end
             shfld_entity = "nodes/#{node_id}/shared_folders"
             sh_command = options.get_next_command(ALL_OPS + [:user])
@@ -480,33 +476,32 @@ module Aspera
                 entity: shfld_entity,
                 command: sh_command
               ) do |field, value|
-                       lookup_entity_by_field(api: @api_v5, entity: shfld_entity, field: field, value: value)['id']
+                       @api_v5.lookup_entity_by_field(entity: shfld_entity, field: field, value: value)['id']
                      end
             when :user
               sh_id = instance_identifier do |field, value|
-                lookup_entity_by_field(api: @api_v5, entity: shfld_entity, field: field, value: value)['id']
+                @api_v5.lookup_entity_by_field(entity: shfld_entity, field: field, value: value)['id']
               end
               user_path = "#{shfld_entity}/#{sh_id}/custom_access_users"
               return entity_execute(api: @api_v5, entity: user_path, items_key: 'users') do |field, value|
-                       lookup_entity_by_field(api: @api_v5, entity: user_path, items_key: 'users', field: field, value: value)['id']
+                       @api_v5.lookup_entity_by_field(entity: user_path, items_key: 'users', field: field, value: value)['id']
                      end
 
             end
           when :browse
             # nodes
             node_id = instance_identifier do |field, value|
-              lookup_entity_by_field(api: @api_v5, entity: 'nodes', value: value, field: field)['id']
+              @api_v5.lookup_entity_by_field(entity: 'nodes', value: value, field: field)['id']
             end
             return browse_folder("nodes/#{node_id}/browse")
           when :invite_external_collaborator
             # :shared_inboxes, :workgroups
-            shared_inbox_id = instance_identifier{ |field, value| lookup_entity_by_field(api: @api_v5, entity: res_sym.to_s, field: field, value: value, query: res_id_query)['id']}
+            shared_inbox_id = instance_identifier{ |field, value| @api_v5.lookup_entity_by_field(entity: res_sym.to_s, field: field, value: value, query: res_id_query)['id']}
             creation_payload = value_create_modify(command: res_command, type: [Hash, String])
             creation_payload = {'email_address' => creation_payload} if creation_payload.is_a?(String)
             result = @api_v5.create("#{res_sym}/#{shared_inbox_id}/external_collaborator", creation_payload)
             formatter.display_status(result['message'])
-            result = lookup_entity_by_field(
-              api: @api_v5,
+            result = @api_v5.lookup_entity_by_field(
               entity: "#{res_sym}/#{shared_inbox_id}/members",
               items_key: 'members',
               value: creation_payload['email_address'],
@@ -515,7 +510,7 @@ module Aspera
             return Main.result_single_object(result)
           when :members, :saml_groups
             # res_command := :shared_inboxes, :workgroups
-            res_id = instance_identifier{ |field, value| lookup_entity_by_field(api: @api_v5, entity: res_sym.to_s, field: field, value: value, query: res_id_query)['id']}
+            res_id = instance_identifier{ |field, value| @api_v5.lookup_entity_by_field(entity: res_sym.to_s, field: field, value: value, query: res_id_query)['id']}
             res_path = "#{res_sym}/#{res_id}/#{res_command}"
             list_key = res_command.to_s
             list_key = 'groups' if res_command.eql?(:saml_groups)
@@ -526,8 +521,7 @@ module Aspera
               users = [users] unless users.is_a?(Array)
               users = users.map do |user|
                 if (m = Base.percent_selector(user))
-                  lookup_entity_by_field(
-                    api: @api_v5,
+                  @api_v5.lookup_entity_by_field(
                     entity: 'accounts',
                     field: m[:field],
                     value: m[:value],
@@ -548,8 +542,7 @@ module Aspera
               command: sub_command,
               items_key: list_key
             ) do |field, value|
-                     lookup_entity_by_field(
-                       api: @api_v5,
+                     @api_v5.lookup_entity_by_field(
                        entity: res_path,
                        field: field,
                        value: value,
@@ -558,7 +551,7 @@ module Aspera
                    end
           when :reset_password
             # :accounts
-            contact_id = instance_identifier{ |field, value| lookup_entity_by_field(api: @api_v5, entity: 'accounts', field: field, value: value, query: res_id_query)['id']}
+            contact_id = instance_identifier{ |field, value| @api_v5.lookup_entity_by_field(entity: 'accounts', field: field, value: value, query: res_id_query)['id']}
             @api_v5.create("accounts/#{contact_id}/reset_password", {})
             return Main.result_status('password reset, user shall check email')
           end
@@ -579,16 +572,10 @@ module Aspera
             event_type = options.get_next_command(%i[application webhook])
             case event_type
             when :application
-              list, total = list_entities_limit_offset_total_count(
-                api: @api_v5,
-                entity: 'application_events',
-                query: query_read_delete
-              )
-
+              list, total = @api_v5.list_entities_limit_offset_total_count(entity: 'application_events', query: query_read_delete)
               return Main.result_object_list(list, total: total, fields: %w[event_type created_at application user.name])
             when :webhook
-              list, total = list_entities_limit_offset_total_count(
-                api: @api_v5,
+              list, total = @api_v5.list_entities_limit_offset_total_count(
                 entity: 'all_webhooks_events',
                 query: query_read_delete,
                 items_key: 'events'
@@ -705,7 +692,7 @@ module Aspera
                 items_key: invitation_endpoint,
                 display_fields: %w[id public recipient_type recipient_name email_address]
               ) do |field, value|
-                lookup_entity_by_field(api: @api_v5, entity: invitation_endpoint, field: field, value: value, query: {})['id']
+                @api_v5.lookup_entity_by_field(entity: invitation_endpoint, field: field, value: value, query: {})['id']
               end
             end
           when :gateway
@@ -732,7 +719,8 @@ module Aspera
         ACCOUNT_TYPES = %w{local_user saml_user self_registered_user external_user}.freeze
         WORKGROUP_TYPES = %w{workgroup shared_inbox}.freeze
         CONTACT_TYPES = (WORKGROUP_TYPES + %w{distribution_list user external_user}).freeze
-        private_constant :SHARED_INBOX_MEMBER_LEVELS, :ACCOUNT_TYPES, :CONTACT_TYPES
+        PACKAGE_RECIPIENT_TYPES = %i{recipients private_recipients notified_on_upload notified_on_download notified_on_receipt}
+        private_constant :SHARED_INBOX_MEMBER_LEVELS, :ACCOUNT_TYPES, :CONTACT_TYPES, :PACKAGE_RECIPIENT_TYPES
       end
     end
   end

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

@@ -928,10 +928,8 @@ module Aspera
                 # do not process last one
                 break if end_date.nil?
                 # init data for this period
-                period_bandwidth = Transfer::Spec::DIRECTION_ENUM_VALUES.map(&:to_sym).each_with_object({}) do |direction, h|
-                  h[direction] = dir_info.each_with_object({}) do |k2, h2|
-                    h2[k2] = 0
-                  end
+                period_bandwidth = Transfer::Spec::DIRECTION_ENUM_VALUES.map(&:to_sym).to_h do |direction|
+                  [direction, dir_info.to_h{ |k2| [k2, 0]}]
                 end
                 # find all transfers that were active at this time
                 transfers_data.each do |transfer|

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

@@ -3,6 +3,8 @@
 require 'aspera/cli/plugins/basic_auth'
 require 'aspera/cli/plugins/node'
 require 'aspera/assert'
+require 'aspera/rest_list'
+
 module Aspera
   module Cli
     module Plugins
@@ -128,7 +130,7 @@ module Aspera
           when :admin
             api_shares_admin = basic_auth_api(ADMIN_API_PATH)
             admin_command = options.get_next_command(%i[node share transfer_settings user group].freeze)
-            lookup_share = ->(field, value){lookup_entity_generic(entity: 'share', field: field, value: value){api_shares_admin.read('data/shares')}['id']}
+            lookup_share = ->(field, value){RestList.lookup_entity_generic(entity: 'share', field: field, value: value){api_shares_admin.read('data/shares')}['id']}
             case admin_command
             when :node
               return entity_execute(api: api_shares_admin, entity: 'data/nodes')
@@ -177,7 +179,7 @@ module Aspera
                 entity_commands = %i[import].freeze
               end
               entity_verb = options.get_next_command(entity_commands)
-              lookup_block = ->(field, value){lookup_entity_generic(entity: entity_type, field: field, value: value){api_shares_admin.read(entities_path)}['id']}
+              lookup_block = ->(field, value){RestList.lookup_entity_generic(entity: entity_type, field: field, value: value){api_shares_admin.read(entities_path)}['id']}
               case entity_verb
               when *ALL_OPS # list, show, delete, create, modify
                 display_fields = entity_type.eql?(:user) ? %w[id user_id username first_name last_name email] : nil

data/lib/aspera/cli/transfer_agent.rb

@@ -33,6 +33,9 @@ module Aspera
         :DEFAULT_TRANSFER_NOTIFY_TEMPLATE
 
       class << self
+        # Analyze transfer session statuses and return a global status
+        #
+        # @param statuses [Array] list of session status, each status is :success or an error message string
         # @return [:success]  if all sessions statuses returned by "start" are success
         # @return [Exception] if one sessions statuses returned by "start" is failed
         def session_status(statuses)

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.25.4'
+    VERSION = '4.26.0.pre'
   end
 end