aspera-cli 4.26.0 → 4.26.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5dcaa66a7401bb325ae68b4f51ef44e7820332159203a7a5247fc3c2d447d9e5
-  data.tar.gz: cf0a6734797c0803d77daa01b547daccf4dc4af0c17ff7872d186ad3fbffe62f
+  metadata.gz: 3959459dc4ecd6fbc28e485b7665744293691d275d7597375b9ee2e80dfb9477
+  data.tar.gz: 62fe6561296d5a6f35473e7c7e831a3089e54fecdbd364a4042e01f993db180e
 SHA512:
-  metadata.gz: e3c8fb9d31eca016b0c88ef324aa307e73535b34672cd2f42d54c4695b7d12fa8d18e98cdbff7115a65856d161ba5869fb3e3e83eef97293411189d7c8f5a454
-  data.tar.gz: bfee651a574ceaa6c6e10ea54b51d50e3d58cf33e0e89b909ad71bff7969dcb01c45707b3ae2cc4bccd553bb69c42ab0f288a043943df01fd9ca9379d6650872
+  metadata.gz: 95a052413af5c03a31e74c5b71f359b4dcd7f2af34e59be7c5c2fb49af862b45ce76be92d464419da1c9c944e1d140cd5b957a72916f53384e95317faf08fbcf
+  data.tar.gz: ed1aaa7ac2079839f69b506044ca7129e16cc4eb2c371d3311deb598aa91c6ed22c15bac03f8398062768cbdfc8131dc4fcafe84b637ce2a8357fb8c3af5c515

data/CHANGELOG.md

@@ -1,6 +1,38 @@
 # Changes (Release notes)
 
-<!-- markdownlint-configure-file { "no-duplicate-heading": { "siblings_only": true } } -->
+## 4.26.2
+
+Released: 2026-07-17
+
+### New Features
+
+* `faspex5`: New commands `admin file_processing` and `packages file_processing`.
+* `aoc`: Command `user settings` now support `create`, `delete`, `list`, `show`, `modify`.
+* `aoc`: New command `network_policy` and `configuration_policy` in `admin`.
+* `sync` : New command `admin query` to execute an arbitrary SQL command on the snap DB.
+* `sync` : Option `sql` to add arbitrary SQL suffixes to sync actions with snapshot DB.
+
+### Issues Fixed
+
+* `aoc`: Fixed `admin application membership create`.
+
+### Breaking Changes
+
+**global**: Replaced option `--bash-comp` with `config completion bash`.
+
+## 4.26.1
+
+Released: 2026-06-11
+
+### New Features
+
+* `aoc`: Added new command `admin workspace shared_folder <workspace ID> node <shared folder ID>` to provide direct access to node operations from shared folders.
+* **global**: Schema for Extended Value for option or command argument can now be retrieved using the special value `help` (e.g., `--ts=help` or `package send help`). Those are generated from JSON schema descriptions.
+* **doc**: Some tables in documentation are now generated from JSON schema descriptions.
+
+### Issues Fixed
+
+* **global**: Resolved issue where supported enumerated values were not properly listed when no value was provided (e.g., for command parameters).
 
 ## 4.26.0
 
@@ -17,7 +49,7 @@ Released: 2026-05-28
 * `aoc`: Support selection of workspace using percent selectors: `%name:` and `%id:`.
 * **global**: Added download URLs for `transferd` 1.1.8.
 * **global**: New Extended Value modifier: `s` converts to `String`.
-* **global**: Parameter `str_lst_sep` or option `table_style` allows setting separator for list of strings.
+* **global**: Parameter `str_lst_sep` of option `table_style` allows setting separator for list of strings.
 
 ### Issues Fixed
 
@@ -57,7 +89,7 @@ Released: 2026-03-04
 
 ### New Features
 
-* **general**: If `@:` is used, then marker `END` optionally marks the end of collected arguments.
+* **global**: If `@:` is used, then marker `END` optionally marks the end of collected arguments.
 * `format`: `display` defaults to `info` only if `format` is set to `table`, else defaults to `data`.
 * `node`: Parameter `accept_v4` of option `node_api` (boolean, defaults to `true`) allows using gen4 browsing with `Accept-Version: 4.0` for best performance when there are thousands of files.
 
@@ -440,7 +472,7 @@ Released: 2024-07-13
 
 ### Breaking Changes
 
-* `config`: Command `remote_certificate` now takes a sub-command.
+* `config`: Command `remote_certificate` now takes a command.
 * **global**: Moved a few internal classes in new/renamed modules.
 * **global**: Deprecated pseudo transfer specification parameters starting with `EX_`:
   * `EX_ssh_key_paths`: Use spec `ssh_private_key` or option `transfer_info={"ascp_args":["-i","..."]}`

data/CONTRIBUTING.md

@@ -72,7 +72,7 @@ The `aspera-cli` architecture is designed to be modular and extensible.
 
 - **Entry Point**:
 
-  `lib/aspera/cli/main.rb` contains the core CLI startup logic.
+  `lib/aspera/cli/runner.rb` contains the core CLI startup logic.
 
 - **Plugins**:
 
@@ -112,15 +112,12 @@ The following environment variables and macros control specific build behaviors:
 | `LOG_SECRETS`               | `yes`/`no` | Toggles the logging of secrets in `rake` tasks.              |
 | `LOG_LEVEL`                 | `debug`, ... | Sets the logging verbosity for `rake` tasks.                 |
 | `ENABLE_COVERAGE`           | set/unset  | Enables test coverage analysis when defined.                 |
-| `SIGNING_KEY`               | File path  | Path to the signing key used for building the gem file.      |
-| `SIGNING_KEY_PEM`           | PEM Value  | The PEM content of the signing key.                          |
+| `SIGNING_KEY`               | File path or PEM | Path to the signing key file, or PEM content (starts with `-----BEGIN`). |
 | `DRY_RUN`                   | `1`        | Simulates execution without performing actual operations (`git`, `gh`). |
 | `DEBUG`                     | `1`        | Shows stack trace on errors during documentation generation. |
 
 These values can be set as standard environment variables or passed directly to the `rake` command.
 
-Setting `SIGNING_KEY_PEM` automatically generates a file at `$HOME/.gem/signing_key.pem` and sets the `SIGNING_KEY` variable accordingly.
-
 > [!NOTE]
 > `ASPERA_CLI_TEST_CONF_URL` is typically defined in your shell profile for development, while others are usually for ad-hoc command-line use.
 

data/bin/ascli

@@ -31,6 +31,6 @@ end
 
 require 'aspera/coverage'
 require 'aspera/environment'
-require 'aspera/cli/main'
+require 'aspera/cli/runner'
 Aspera::Environment.instance.fix_home
-Aspera::Cli::Main.new(ARGV).process_command_line
+Aspera::Cli::Runner.new(ARGV).run

data/lib/aspera/agent/direct.rb

@@ -294,7 +294,7 @@ module Aspera
           Log.log.debug{"before select, timeout: #{@spawn_timeout_sec}"}
           readable, _, _ = IO.select([mgt_server_socket], nil, nil, @spawn_timeout_sec)
           Log.log.debug('after select, before accept')
-          Aspera.assert(readable, type: Transfer::Error){'timeout waiting mgt port connect (select not readable)'}
+          Aspera.assert(readable, 'timeout waiting mgt port connect (select not readable)', type: Transfer::Error)
           # There is a connection to accept
           client_socket, _client_addrinfo = mgt_server_socket.accept
           Log.log.debug('after accept')

data/lib/aspera/agent/factory.rb

@@ -6,6 +6,10 @@ require 'aspera/environment'
 module Aspera
   module Agent
     # Factory for Agents
+    #
+    # @!method self.instance
+    #   Returns the singleton instance of Factory
+    #   @return [Factory] the singleton instance
     class Factory
       include Singleton
 

data/lib/aspera/agent/httpgw.rb

@@ -32,7 +32,7 @@ module Aspera
       # HTTP download only supports file list
       # :reek:UnusedParameters token_regenerator
       def start_transfer(transfer_spec, token_regenerator: nil)
-        Aspera.assert(!@gw_api.nil?){'GW URL must be set'}
+        Aspera.assert(!@gw_api.nil?, 'GW URL must be set')
         Aspera.assert_type(transfer_spec['paths'], Array){'paths'}
         Aspera.assert_type(transfer_spec['token'], String){'only token based transfer is supported in GW'}
         Log.dump(:user_spec, transfer_spec)

data/lib/aspera/agent/node.rb

@@ -30,7 +30,7 @@ module Aspera
         @root_id = root_id
         rest_params = {base_url: url}
         if OAuth::Factory.bearer_auth?(password)
-          Aspera.assert(!@root_id.nil?){'root_id not allowed for access key'}
+          Aspera.assert(!@root_id.nil?, 'root_id not allowed for access key')
           rest_params[:headers] = Api::Node.bearer_headers(password, access_key: username)
         else
           rest_params[:auth] = {
@@ -117,7 +117,7 @@ module Aspera
 
       # used internally to ensure node api is set before using.
       def node_api_
-        Aspera.assert(!@node_api.nil?){'Before using this object, set the node_api attribute to a Aspera::Rest object'}
+        Aspera.assert(!@node_api.nil?, 'Before using this object, set the node_api attribute to a Aspera::Rest object')
         return @node_api
       end
     end

data/lib/aspera/api/aoc.rb

@@ -113,8 +113,10 @@ module Aspera
           return client_key, DataRepository.instance.item(client_key)
         end
 
-        # base API url depends on domain, which could be "qa.xxx" or self-managed domain
-        def api_base_url(api_domain: SAAS_DOMAIN_PROD)
+        # Base API url depends on domain, which could be "qa.xxx" or self-managed domain
+        # @param api_domain [String] the AoC domain (e.g. "ibmaspera.com" (SAAS_DOMAIN_PROD) or a self-managed domain)
+        # @return [String] the base URL for the AoC API
+        def api_base_url(api_domain)
           return "https://api.#{api_domain}"
         end
 
@@ -197,7 +199,7 @@ module Aspera
         # @option return [Integer] :total The total number of items
         def call_paging(query: {})
           Aspera.assert_type(query, Hash){'query'}
-          Aspera.assert(block_given?)
+          Aspera.assert(block_given?, 'block required for call_paging')
           # set default large page if user does not specify own parameters. AoC Caps to 1000 anyway
           query['per_page'] = 1000 unless query.key?('per_page')
           max_items = query.delete(RestList::MAX_ITEMS)
@@ -211,7 +213,7 @@ module Aspera
             new_query = query.clone
             new_query['page'] = current_page
             result_data, result_http = yield(new_query)
-            Aspera.assert(result_http)
+            Aspera.assert(result_http, 'expected HTTP result from paging block')
             total_count = result_http[HEADER_X_TOTAL_COUNT]&.to_i
             page_count += 1
             current_page += 1
@@ -267,11 +269,12 @@ module Aspera
       attr_accessor :ws_ids
 
       # By default: no workspace
+      # @param
       def initialize(
         scope: nil,
         subpath: API_V1,
         secret_finder: nil,
-        # below: OAuth::AUTH_OPTIONS
+        # parameters below: OAuth::AUTH_OPTIONS
         url:,
         auth:,
         client_id: nil,
@@ -284,7 +287,14 @@ module Aspera
       )
         # Test here because link may set url
         Aspera.assert(url, 'Missing mandatory option: url', type: ParameterError)
-        Aspera.assert(scope, 'Missing mandatory option: scope', type: ParameterError)
+        # analyze type of url
+        url_info = self.class.link_info(url)
+        Log.dump(:url_info, url_info)
+        @private_link = url_info[:private_link]
+        Aspera.assert(auth, 'Missing mandatory option: auth', type: ParameterError) unless url_info.key?(:token)
+        # this is the base API url
+        api_url_base = self.class.api_base_url(url_info[:instance_domain])
+        Aspera.assert(scope, 'Missing mandatory option: scope', type: ParameterError) unless auth.eql?(:none)
         # default values for client id
         client_id, client_secret = self.class.get_client_info if client_id.nil?
         # access key secrets are provided out of band to get node api access
@@ -298,28 +308,21 @@ module Aspera
         # Used only for init: provided by user
         @ws_ids = {id: nil, name: nil}
         @home_info = nil
-        auth_params = {
-          type:   :oauth2,
-          params: {
-            client_id:     client_id,
-            client_secret: client_secret,
-            scope:         scope
+        base_args = {
+          base_url: "#{api_url_base}/#{subpath}",
+          auth:     {
+            type:         :oauth2,
+            grant_method: url_info.key?(:token) ? :url_json : auth,
+            base_url:     "#{api_url_base}/#{OAUTH_API_SUBPATH}/#{url_info[:organization]}",
+            params:       {
+              client_id:     client_id,
+              client_secret: client_secret,
+              scope:         scope
+            }
           }
         }
-        # analyze type of url
-        url_info = AoC.link_info(url)
-        Log.dump(:url_info, url_info)
-        @private_link = url_info[:private_link]
-        auth_params[:grant_method] = if url_info.key?(:token)
-          :url_json
-        else
-          Aspera.assert(auth, 'Missing mandatory option: auth', type: ParameterError)
-          auth
-        end
-        # this is the base API url
-        api_url_base = self.class.api_base_url(api_domain: url_info[:instance_domain])
-        # auth URL
-        auth_params[:base_url] = "#{api_url_base}/#{OAUTH_API_SUBPATH}/#{url_info[:organization]}"
+        # shortcut alias
+        auth_params = base_args[:auth]
         # fill other auth parameters based on OAuth method
         case auth_params[:grant_method]
         when :web
@@ -344,12 +347,16 @@ module Aspera
           auth_params[:json][:password] = password unless password.nil?
           # basic auth required for /token
           auth_params[:auth] = {type: :basic, username: client_id, password: client_secret}
-        else Aspera.error_unexpected_value(auth_params[:grant_method]){'auth, use one of: :web, :jwt'}
+        when :boot
+          # cookie is optional: if absent, existing cache is used
+          auth_params[:cookie] = password unless password.nil?
+          auth_params[:username] = username unless username.nil?
+        when :none
+          auth_params.clear
+          auth_params[:type] = :none
+        else Aspera.error_unexpected_value(auth_params[:grant_method]){'auth, use one of: web, jwt, boot'}
         end
-        super(
-          base_url: "#{api_url_base}/#{subpath}",
-          auth: auth_params
-          )
+        super(**base_args)
       end
 
       # Read using the query and paging
@@ -362,6 +369,7 @@ module Aspera
         end
       end
 
+      # @param expected [Array<String>] Link types
       def assert_public_link_types(expected)
         Aspera.assert_values(public_link['purpose'], expected){'public link type'}
       end
@@ -482,7 +490,7 @@ module Aspera
         ak_secret = @secret_finder&.lookup_secret(url: node_info['url'], username: node_info['access_key'])
         # If secret is available, or no scope, use basic auth
         if scope.nil? || ak_secret
-          Aspera.assert(ak_secret, "Secret not found for access key #{node_info['access_key']}@#{node_info['url']}", type: Error)
+          Aspera.assert(ak_secret, type: Error){"Secret not found for access key #{node_info['access_key']}@#{node_info['url']}"}
           node_params[:auth] = {
             type:     :basic,
             username: node_info['access_key'],
@@ -519,10 +527,10 @@ module Aspera
         Log.dump(:metadata, pkg_meta)
         pkg_meta.each do |field|
           Aspera.assert_type(field, Hash){'metadata field'}
-          Aspera.assert(field.key?('name')){'metadata field must have name'}
-          Aspera.assert(field.key?('values')){'metadata field must have values'}
+          Aspera.assert(field.key?('name'), 'metadata field must have name')
+          Aspera.assert(field.key?('values'), 'metadata field must have values')
           Aspera.assert_type(field['values'], Array){'metadata field values'}
-          Aspera.assert(!meta_schema.none?{ |i| i['name'].eql?(field['name'])}){"unknown metadata field: #{field['name']}"}
+          Aspera.assert(meta_schema.any?{ |i| i['name'].eql?(field['name'])}){"unknown metadata field: #{field['name']}"}
         end
         meta_schema.each do |field|
           provided = pkg_meta.select{ |i| i['name'].eql?(field['name'])}
@@ -557,7 +565,7 @@ module Aspera
               full_recipient_info = lookup_with_q(entity_type, value: short_recipient_info, query: {'workspace_id' => ws_id})
             rescue EntityNotFound
               # dropboxes cannot be created on the fly
-              Aspera.assert_values(entity_type, 'contacts', type: Error){"No such shared inbox in workspace #{ws_id}"}
+              Aspera.assert_values(entity_type, %w[contacts], type: Error){"No such shared inbox in workspace #{ws_id}"}
               # unknown user: create it as external user
               full_recipient_info = create('contacts', {
                 'current_workspace_id' => ws_id,
@@ -748,7 +756,7 @@ module Aspera
       # @param types [Array] event types
       def permissions_send_event(event_data:, app_info:, types: PERMISSIONS_CREATED)
         Aspera.assert_type(types, Array)
-        Aspera.assert(!types.empty?)
+        Aspera.assert(!types.empty?, 'types must not be empty')
         event_creation = {
           'types'        => types,
           'node_id'      => app_info.node_info['id'],

data/lib/aspera/api/cos_node.rb

@@ -63,7 +63,7 @@ module Aspera
         ats_info = XmlSimple.xml_in(xml_result_text, {'ForceArray' => false})
         Log.dump(:ats_info, ats_info)
         Aspera.assert_hash_all(ats_info, String, nil){'ats_info'}
-        Aspera.assert((FASP_INFO_KEYS - ats_info.keys).empty?){'ats_info missing required keys'}
+        Aspera.assert((FASP_INFO_KEYS - ats_info.keys).empty?, 'ats_info missing required keys')
         Aspera.assert_hash_all(ats_info['AccessKey'], String, String){'ats_info'}
         @storage_credentials = {
           'type'  => 'token',

data/lib/aspera/api/faspex.rb

@@ -45,7 +45,7 @@ module Aspera
       info = Rest.query_to_h(URI.parse(http['Location']).query)
       Log.dump(:info, info)
       raise Error, info['action_message'] if info['action_message']
-      Aspera.assert(info['code']){'Missing code in answer'}
+      Aspera.assert(info['code'], 'Missing code in answer')
       # Exchange code for token
       return create_token_call(base_params.merge(
         grant_type:   'authorization_code',
@@ -87,6 +87,7 @@ module Aspera
         email_notifications
         alternate_addresses
         webhooks
+        file_processing
       ].freeze
       # states for jobs not in final state
       JOB_RUNNING = %w[queued working].freeze
@@ -193,15 +194,15 @@ module Aspera
             }
           # old: headers:  {'Passcode' => @pub_link_context['passcode']}
           when :boot
-            Aspera.assert(password, type: ParameterError){'Missing password'}
+            Aspera.assert(password, 'Missing password', type: ParameterError)
             # the password here is the token copied directly from browser in developer mode
             {
               base_url: "#{url}/#{root}",
               headers:  {'Authorization' => password}
             }
           when :web
-            Aspera.assert(client_id, type: ParameterError){'Missing client_id'}
-            Aspera.assert(redirect_uri, type: ParameterError){'Missing redirect_uri'}
+            Aspera.assert(client_id, 'Missing client_id', type: ParameterError)
+            Aspera.assert(redirect_uri, 'Missing redirect_uri', type: ParameterError)
             # opens a browser and ask user to auth using web
             {
               base_url: "#{url}/#{root}",
@@ -216,8 +217,8 @@ module Aspera
               }
             }
           when :jwt
-            Aspera.assert(client_id, type: ParameterError){'Missing client_id'}
-            Aspera.assert(private_key, type: ParameterError){'Missing private_key'}
+            Aspera.assert(client_id, 'Missing client_id', type: ParameterError)
+            Aspera.assert(private_key, 'Missing private_key', type: ParameterError)
             {
               base_url: "#{url}/#{root}",
               auth:     {

data/lib/aspera/api/node.rb

@@ -165,7 +165,7 @@ module Aspera
           items = scope.split(Scope::SEPARATOR, 2)
           Aspera.assert(items.length.eql?(2)){"invalid scope: #{scope}"}
           Aspera.assert(items[0].start_with?(Scope::NODE_PREFIX)){"invalid scope: #{scope}"}
-          return {access_key: items[0][Scope::NODE_PREFIX.length..-1], scope: items[1]}
+          return {access_key: items[0].delete_prefix(Scope::NODE_PREFIX), scope: items[1]}
         end
 
         # Create an Aspera Node bearer token
@@ -174,9 +174,9 @@ module Aspera
         # @param private_key [OpenSSL::PKey::RSA] Private key to sign the token
         def bearer_token(access_key:, payload:, private_key:)
           Aspera.assert_type(payload, Hash)
-          Aspera.assert(payload.key?('user_id'))
+          Aspera.assert(payload.key?('user_id'), 'payload must have user_id')
           Aspera.assert_type(payload['user_id'], String)
-          Aspera.assert(!payload['user_id'].empty?)
+          Aspera.assert(!payload['user_id'].empty?, 'user_id must not be empty')
           Aspera.assert_type(private_key, OpenSSL::PKey::RSA)
           # Manage convenience parameters
           expiration_sec = payload['_validity'] || BEARER_TOKEN_VALIDITY_DEFAULT
@@ -205,7 +205,7 @@ module Aspera
           # If username is not provided, use the access key from the token
           if access_key.nil?
             access_key = Node.decode_scope(Node.decode_bearer_token(OAuth::Factory.bearer_token(bearer_auth))['scope'])[:access_key]
-            Aspera.assert(!access_key.nil?)
+            Aspera.assert(!access_key.nil?, 'access_key could not be determined from token')
           end
           return {
             HEADER_X_ASPERA_ACCESS_KEY => access_key,
@@ -337,7 +337,7 @@ module Aspera
       # @param top_file_path [String] path of top folder (default = /)
       # @para query [Hash, nil] optional query for `read`
       def process_folder_tree(method_sym:, state:, top_file_id:, top_file_path: '/', query: nil)
-        Aspera.assert(!top_file_path.nil?){'top_file_path not set'}
+        Aspera.assert(!top_file_path.nil?, 'top_file_path not set')
         Log.log.debug{"process_folder_tree: node=#{@app_info ? @app_info.node_info['id'] : 'nil'}, file id=#{top_file_id},  path=#{top_file_path}"}
         # Start at top folder
         folders_to_explore = [{id: top_file_id, path: top_file_path}]
@@ -405,7 +405,7 @@ module Aspera
       #     - 'destination' [String]: Destination path (optional)
       def resolve_api_fid_paths(top_file_id, paths)
         Aspera.assert_type(paths, Array)
-        Aspera.assert(paths.size.positive?)
+        Aspera.assert(paths.size.positive?, 'paths must not be empty')
         split_sources = paths.map{ |p| Pathname(p['source']).each_filename.to_a}
         root = []
         split_sources.map(&:size).min.times do |i|
@@ -490,7 +490,7 @@ module Aspera
         case auth_params[:type]
         when :basic
           ak_name = auth_params[:username]
-          Aspera.assert(auth_params[:password]){'no secret in node object'}
+          Aspera.assert(auth_params[:password], 'no secret in node object')
           ak_token = Rest.basic_authorization(auth_params[:username], auth_params[:password])
         when :oauth2
           ak_name = params[:headers][HEADER_X_ASPERA_ACCESS_KEY]
@@ -540,7 +540,7 @@ module Aspera
         else
           transfer_spec.merge!(transport_params)
         end
-        Aspera.assert_values(transfer_spec['remote_user'], Transfer::Spec::ACCESS_KEY_TRANSFER_USER, type: :warn){'transfer user'}
+        Aspera.assert_values(transfer_spec['remote_user'], [Transfer::Spec::ACCESS_KEY_TRANSFER_USER], type: :warn){'transfer user'}
         return transfer_spec
       end
 
@@ -551,7 +551,7 @@ module Aspera
       def read_with_paging(subpath, query = nil, iteration: nil, **call_args)
         Aspera.assert_type(iteration, Array, NilClass){'iteration'}
         Aspera.assert_type(query, Hash, NilClass){'query'}
-        Aspera.assert(!call_args.key?(:query))
+        Aspera.assert(!call_args.key?(:query), ':query must not be in call_args (use query parameter)')
         query = {} if query.nil?
         query[:iteration_token] = iteration[0] unless iteration.nil? || iteration[0].nil?
         max = query.delete(RestList::MAX_ITEMS)

data/lib/aspera/ascmd.rb

@@ -129,10 +129,10 @@ module Aspera
       Log.log.trace1{"execute_single:#{stdin_input}"}
       # execute, get binary output
       byte_buffer = @command_executor.execute(remote_cmd, input: stdin_input).unpack('C*')
-      Aspera.assert(!byte_buffer.empty?){'empty answer from server'}
+      Aspera.assert(!byte_buffer.empty?, 'empty answer from server')
       # get hash or table result
       result = self.class.parse(byte_buffer, :result)
-      Aspera.assert(byte_buffer.empty?){'unparsed bytes remaining'}
+      Aspera.assert(byte_buffer.empty?, 'unparsed bytes remaining')
       # get and delete info,always present in results
       system_info = result[:info]
       result.delete(:info)
@@ -187,7 +187,7 @@ module Aspera
         case type_descr[:decode]
         when :base
           num_bytes = type_name.eql?(:zstr) ? buffer.length : type_descr[:size]
-          Aspera.assert(buffer.length >= num_bytes){'not enough bytes'}
+          Aspera.assert(buffer.length >= num_bytes, 'not enough bytes')
           byte_array = buffer.shift(num_bytes)
           byte_array = [byte_array] unless byte_array.is_a?(Array)
           result = byte_array.pack('C*').unpack1(type_descr[:unpack])
@@ -200,7 +200,7 @@ module Aspera
           until buffer.empty?
             btype = parse(buffer, :int8, indent_level)
             length = parse(buffer, :int32, indent_level)
-            Aspera.assert(buffer.length >= length){'not enough bytes'}
+            Aspera.assert(buffer.length >= length, 'not enough bytes')
             value = buffer.shift(length)
             result.push({btype: btype, buffer: value})
             Log.log.trace1{"#{'   .' * indent_level}:buffer_list[#{result.length - 1}] #{result.last}"}

data/lib/aspera/ascp/installation.rb

@@ -27,6 +27,10 @@ module Aspera
     # It is used by object : AgentDirect to find necessary resources
     # By default it takes the first Aspera product found
     # The user can specify `ascp` location by calling: `sdk_folder=` method
+    #
+    # @!method self.instance
+    #   Returns the singleton instance of Installation
+    #   @return [Installation] the singleton instance
     class Installation
       include Singleton
 
@@ -57,10 +61,10 @@ module Aspera
       # - "product:FIRST" to use ascp from first found product
       def sdk_folder=(ascp_location)
         Aspera.assert_type(ascp_location, String){'ascp_location'}
-        Aspera.assert(!ascp_location.empty?){'ascp location cannot be empty: check your config file'}
+        Aspera.assert(!ascp_location.empty?, 'ascp location cannot be empty: check your config file')
         folder =
           if ascp_location.start_with?(USE_PRODUCT_PREFIX)
-            product_name = ascp_location[USE_PRODUCT_PREFIX.length..-1]
+            product_name = ascp_location.delete_prefix(USE_PRODUCT_PREFIX)
             if product_name.eql?(FIRST_FOUND)
               pl = installed_products.first
               raise "No Aspera transfer module or SDK found.\nRefer to the manual or install SDK with command:\nascli conf transferd install" if pl.nil?
@@ -113,7 +117,7 @@ module Aspera
           file = File.join(File.dirname(file), Environment.instance.exe_file(k.to_s)) unless k.eql?(:transferd)
         when :ssh_private_dsa, :ssh_private_rsa
           # assume last 3 letters are type
-          type = k.to_s[-3..-1].to_sym
+          type = k.to_s[-3..].to_sym
           file = check_or_create_sdk_file("aspera_bypass_#{type}.pem"){DataRepository.instance.item(type)}
         when :aspera_license
           file = check_or_create_sdk_file('aspera-license'){DataRepository.instance.item(:license)}
@@ -243,9 +247,11 @@ module Aspera
       end
 
       # @param sdk_archive_path [String] path to SDK archive
-      # @param &block called with: file path, data stream, link target if link?
+      # @yieldparam entry_name [String] File path in archive
+      # @yieldparam entry_stream [IO, Gem::Package::TarReader::Entry] Data stream
+      # @yieldparam link_target [String, nil] Link target if symlink, nil otherwise
       def extract_archive_files(sdk_archive_path)
-        Aspera.assert(block_given?){'missing block'}
+        Aspera.assert(block_given?, 'missing block')
         case sdk_archive_path
         # Windows and Mac use zip
         when /\.zip$/
@@ -281,7 +287,8 @@ module Aspera
       # @param url     [nil, String] URL to SDK archive, if nil: default url for version
       # @param version [nil, String] Specific version, if nil: latest version
       # @param backup  [Boolean]     If destination folder exists, then rename
-      # @param &block  [nil, Proc]   A lambda that receives a file path from archive and tells destination sub folder(end with /) or file, or nil to not extract
+      # @yieldparam entry_name [String] File path from archive
+      # @yieldreturn [String, nil] Destination sub folder (end with /) or file, or nil to not extract
       # @return [Array] name, ascp version (from execution), folder
       def install_sdk(folder:, url: nil, version: nil, backup: true)
         url ||= sdk_url_for_platform(version: version)

data/lib/aspera/assert.rb

@@ -20,21 +20,24 @@ module Aspera
   class << self
     # Replaces `raise` in assertion
     # Allows sending exception, or just error log, when type is `:error`
-    # @param type [Exception,Symbol] Send to log if symbol, else raise exception
+    # @param type [Exception, Symbol] Send to log if symbol, else raise exception
     # @param message [String] Message for error.
+    # @raise [Exception]
+    # @return [nil]
     def report_error(type, message)
       if type.is_a?(Symbol)
         Log.log.send(type, message)
       else
         raise type, message
       end
+      nil
     end
 
     # Assert that a condition is true, else raise exception
     # @param assertion [TrueClass, FalseClass]       Must be true
-    # @param info      [String,nil] Fixed message in case assert fails, else use `block`
+    # @param info      [String,nil] Fixed message in case assert fails, else use block
     # @param type      [Exception,Symbol] Exception to raise, or Symbol for Log.log
-    # @param block     [Proc]       Produces a string that describes the problem for complex messages
+    # @yieldreturn [String] A string that describes the problem for complex messages
     # The block is executed in the context of the Aspera module
     def assert(assertion, info = nil, type: AssertError)
       raise InternalError, 'bad assert: both info and block given' unless info.nil? || !block_given?
@@ -50,18 +53,18 @@ module Aspera
     # @param value   [Object]           The value to check
     # @param classes [Class, Array]     The expected type(s)
     # @param type    [Exception,Symbol] Exception to raise, or Symbol for Log.log
-    # @param block   [Proc]             Additional description in front of message
+    # @yieldreturn [String] Additional description to prepend to the error message
     def assert_type(value, *classes, type: AssertError)
-      assert(classes.any?{ |k| value.is_a?(k)}, type: type){"#{"#{yield}: " if block_given?}expecting #{classes.join(', ')}, but have (#{value.class})#{value.inspect}"}
+      assert(classes.any?{ |k| value.is_a?(k)}, type: type){"#{"#{yield}: " if block_given?}expecting type #{classes.join(', ')}, but have (#{value.class})#{value.inspect}"}
     end
 
     # Assert that all value of array are of the same specified type.
     # @param array   [Array]            The array to check
     # @param klass   [Class]            The expected type of elements
     # @param type    [Exception,Symbol] Exception to raise, or Symbol for Log.log
-    # @param block   [Proc]             Additional description in front of message
+    # @yieldreturn [String] Additional description to prepend to the error message
     def assert_array_all(array, klass, type: AssertError)
-      assert_type(array, Array, type: type)
+      assert_type(array, Array, type: AssertError){'array'}
       assert(array.all?(klass), type: type){"#{"#{yield}: " if block_given?}expecting all as #{klass}, but have #{array.map(&:class).uniq}"}
     end
 
@@ -70,19 +73,20 @@ module Aspera
     # @param key_class   [Class]            The expected type of keys (or nil)
     # @param value_class [Class]            The expected type of values (or nil)
     # @param type        [Exception,Symbol] Exception to raise, or Symbol for Log.log
-    # @param block       [Proc]             Additional description in front of message
+    # @yieldreturn [String] Additional description to prepend to the error message
     def assert_hash_all(hash, key_class, value_class, type: AssertError)
-      assert_type(hash, Hash, type: type)
-      assert_array_all(hash.keys, key_class, type: AssertError){"#{"#{yield}: " if block_given?}keys"} unless key_class.nil?
-      assert_array_all(hash.values, value_class, type: AssertError){"#{"#{yield}: " if block_given?}values"} unless value_class.nil?
+      assert_type(hash, Hash, type: AssertError){'hash'}
+      assert_array_all(hash.keys, key_class, type: type){"#{"#{yield}: " if block_given?}keys"} unless key_class.nil?
+      assert_array_all(hash.values, value_class, type: type){"#{"#{yield}: " if block_given?}values"} unless value_class.nil?
     end
 
     # Assert that value is one of the given values
     # @param value  [Object]           Value to check
     # @param values [Array]            Accepted values
     # @param type   [Exception,Symbol] Exception to raise, or Symbol for Log.log
-    # @param block  [Proc]             Additional description in front of message
+    # @yieldreturn [String] Additional description to prepend to the error message
     def assert_values(value, values, type: AssertError)
+      assert_type(values, Array, type: AssertError){'values'}
       assert(values.include?(value), type: type) do
         val_list = values.inspect
         val_list = "one of #{val_list}" if values.is_a?(Array)
@@ -93,7 +97,7 @@ module Aspera
     # The value is not one of the expected values
     # @param value  [Object]           The wrong value
     # @param type   [Exception,Symbol] Exception to raise, or Symbol for Log.log
-    # @param &block [Proc]             Additional description in front of message
+    # @yieldreturn [String] Additional description to prepend to the error message
     def error_unexpected_value(value, type: InternalError)
       report_error(type, "#{"#{yield}: " if block_given?}unexpected value: #{value.inspect}")
     end