aspera-cli 4.25.4 → 4.26.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34cb77d2badea1e3650f2aed72fb3a91c419e6457a08acd62808c9a6d9ab0e74
-  data.tar.gz: 31e1e1a28d99afebd6b6a3f7b9e848bf18256d47fdc7108368a6e964eef03b04
+  metadata.gz: fc6adc843448ed8b76da0786b419be39fe4531daa0da0254f8cdb7503a131f4f
+  data.tar.gz: 217a266117e6a2ac2f0512016d71a7fa4e9a1b67924e3e73ca5b7a29cc54a76a
 SHA512:
-  metadata.gz: e15bfb65919b8b8a6112120eca273dac962ff6d6b29d890df1e9293f4321e557bdd68697c394cb6ef738a3d5bcc3a75a2f7f177494b66542c2e970c4da99e9d0
-  data.tar.gz: 1d3570c590e7bfbda3ce5fc49396637471f48ff6fccce7235ae31adcc23c1e1ccc4a978d6bdbe9a4c1c06f06e02ed5336043267891c0b56a995b4d0199ab0d92
+  metadata.gz: 8977f967425a7a53c585d64902619366c197b6897231515ec84dd1b76e4a70eb767da6ce5cbe32f0f3005e70d222e1dc5d65fcf3bfe2c8044d4cf7349396e692
+  data.tar.gz: 7ac9b790563f1f8d11c1156f337ed4fb81313c64b11e1dc7b85909b91c87f06d0a6024176352a01c51397626d75ec20a66c9311dd8a5f88042cff7b0a23fdc44

data/CHANGELOG.md

@@ -2,6 +2,21 @@
 
 <!-- markdownlint-configure-file { "no-duplicate-heading": { "siblings_only": true } } -->
 
+## 4.26.0.pre
+
+Released: [Place date of release here]
+
+### New Features
+
+* `faspex5`: When sending a package, recipients specified in fields `private_recipients`, `notified_on_upload`, `notified_on_download` and `notified_on_receipt` are now also expanded like field `recipients`.
+
+### Issues Fixed
+
+* `sync`: #251 in `admin` command: Fixed database path on Windows: Use `~private-asp` instead of `.private-asp`.
+* `config`: Fixed `preset update` with dot-path options.
+
+### Breaking Changes
+
 ## 4.25.4
 
 Released: 2026-03-04
@@ -301,7 +316,7 @@ Released: 2025-01-21
 
 * Internal: Basic REST calls now return data directly. (no more `data` key). For advanced calls, use `call`.
 * Internal: Transfer SDK download is now a 2-step procedure: First get the YAML file from GitHub with URLs for the various platforms and versions, and then download the archive from the official IBM repository.
-**global**: Option `format=multi` is replaced with option `multi_table=yes`.
+* **global**: Option `format=multi` is replaced with option `multi_table=yes`.
 * `faspex5`: Removed deprecated option `value` replaced with positional parameter.
   
 ## 4.19.0
@@ -1065,7 +1080,7 @@ Released: 2021-02-03
 
 ### New Features
 
-* The option `value` of command `find`, to filter on name, is not optional.
+* The option `value` of command `find` to filter on name is mandatory.
 * `find` now also reports all types (file, folder, link).
 * `find` now is able to report all fields (type, size, etc...).
 
@@ -1095,7 +1110,7 @@ Released: 2021-02-03
 ### New Features
 
 * Improved wizard (prepare for AoC global client id).
-* Preview generator: Added option : --skip-format=&lt;png,mp4&gt;.
+* Preview generator: Added option : `skip_format` with values `png`, `mp4`.
 * Removed outdated pictures from this doc.
 
 ## 0.9.19
@@ -1163,7 +1178,7 @@ Released: 2021-02-03
 
 ### New Features
 
-* `faspex`: Use option `once_only` set to `yes` to enable cargo like function. id=NEW deprecated.
+* `faspex`: Use option `once_only` set to `yes` to enable cargo like function. `id=NEW` deprecated.
 * `aoc`: Share to share transfer with command `transfer`.
 
 ## 0.9.7
@@ -1172,8 +1187,8 @@ Released: 2021-02-03
 
 * Homogeneous transfer spec for `node` and [`direct`](README.md#agt_direct) transfer agents.
 * Preview persistency goes to unique file by default.
-* Catch mxf extension in preview as video.
-* Faspex: Possibility to download all packages by specifying id=ALL.
+* Catch `mxf` extension in preview as video.
+* Faspex: Possibility to download all packages by specifying `id=ALL`.
 * Faspex: To come: Cargo-like function to download only new packages with id=NEW.
 
 ## 0.9.6

data/CONTRIBUTING.md

@@ -12,7 +12,7 @@ To help us diagnose and resolve the issue efficiently, please include the follow
 
 - The `ascli` version you are using:
 
-  ```bash
+  ```shell
   ascli -v
   ```
 
@@ -20,7 +20,7 @@ To help us diagnose and resolve the issue efficiently, please include the follow
 
 - **Your Ruby environment details**:
 
-  ```bash
+  ```shell
   ruby -v
   ```
 
@@ -32,7 +32,7 @@ We welcome contributions to improve the `aspera-cli` project!
 
 Clone the repository to initialize the development environment:
 
-```bash
+```shell
 git clone https://github.com/IBM/aspera-cli.git
 cd aspera-cli
 bundle install
@@ -91,7 +91,7 @@ You can manage your Ruby installation using your preferred tool (e.g., `rbenv`,
 
 To start with a clean state and remove all installed gems:
 
-```bash
+```shell
 bundle exec rake tools:clean_gems
 ```
 
@@ -109,9 +109,9 @@ The following environment variables and macros control specific build behaviors:
 | Environment variable        | Contents   | Description                                                  |
 |-----------------------------|------------| -------------------------------------------------------------|
 | `ASPERA_CLI_TEST_CONF_URL`  | URL        | URL for the configuration file containing secrets for tests. |
-| `ASPERA_CLI_DOC_CHECK_LINKS`| yes/no     | Validates that links exist during documentation generation.  |
-| `LOG_SECRETS`               | yes/no     | Toggles the logging of secrets in `rake` tasks.              |
-| `LOG_LEVEL`                 | debug, ... | Sets the logging verbosity for `rake` tasks.                 |
+| `ASPERA_CLI_DOC_CHECK_LINKS`| `yes`/`no` | Validates that links exist during documentation generation.  |
+| `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.                          |
@@ -121,11 +121,11 @@ These values can be set as standard environment variables or passed directly to
 Setting `SIGNING_KEY_PEM` automatically generates a file at `$HOME/.gem/signing_key.pem` and sets the `SIGNING_KEY` variable accordingly.
 
 > [!NOTE]
-> `ASPERA_CLI_*` variables are typically defined in your shell profile for development, while others are intended for ad-hoc command-line use.
+> `ASPERA_CLI_TEST_CONF_URL` is typically defined in your shell profile for development, while others are usually for ad-hoc command-line use.
 
 To run the CLI directly from your source directory, add the following to your shell profile (adjust the path as necessary):
 
-```bash
+```shell
 dev_ascli=$HOME/github/aspera-cli
 export PATH=$dev_ascli/bin:$PATH
 export RUBYLIB=$dev_ascli/lib:$RUBYLIB
@@ -140,24 +140,24 @@ Installation instructions can be found at [IBM Plex](https://www.ibm.com/plex/).
 
 On macOS, install `lualatex` and required packages via Homebrew:
 
-```bash
+```shell
 brew install texlive
 ```
 
 If using an alternative installation method, ensure the following packages are present:
 
-```bash
+```shell
 tlmgr update --self
 tlmgr install fvextra selnolig lualatex-math
 ```
 
-- To validate URLs during generation: `ASPERA_CLI_DOC_CHECK_LINKS=1`.
+- Validate URLs during generation: `ASPERA_CLI_DOC_CHECK_LINKS=yes`.
 
-- To debug the generation process: `ASPERA_CLI_DOC_DEBUG=debug`.
+- Debug the generation process: `ASPERA_CLI_DOC_DEBUG=debug`.
 
-- To build the documentation:
+- Build the documentation:
 
-```bash
+```shell
 rake doc:build
 ```
 
@@ -169,14 +169,14 @@ Detailed testing information can be found in <tests/README.md>.
 
 To build an unsigned gem:
 
-```bash
+```shell
 bundle install
 bundle exec rake unsigned
 ```
 
 To exclude optional gems from the installation:
 
-```bash
+```shell
 bundle config set without optional
 ```
 
@@ -185,7 +185,7 @@ bundle config set without optional
 Generating a signed gem requires a **private key**, specified via the `SIGNING_KEY` environment variable.
 The gem is signed using the public certificate in `certs` and the **private key**.
 
-```bash
+```shell
 bundle exec rake SIGNING_KEY=/path/to/vault/gem-private_key.pem
 ```
 
@@ -195,7 +195,7 @@ For more details, see <certs/README.md>.
 
 To update the stubs:
 
-```bash
+```shell
 bundle exec rake tools:grpc
 ```
 
@@ -211,7 +211,7 @@ Refer to the [Executable build guide](build/binary/README.md).
 
 To list related `rake` tasks:
 
-```bash
+```shell
 bundle exec rake -T ^binary:
 ```
 
@@ -234,17 +234,23 @@ Before a new release, ensure the following:
 
 - **Pass all tests**:
 
-```bash
+```shell
 bundle exec rake test:run
 ```
 
 - **Verify container builds** (using the local gem):
 
-```bash
+```shell
 bundle exec rake container:build'[local]'
 bundle exec rake container:test
 ```
 
+- **Check documentation links**:
+
+```shell
+bundle exec rake doc:build ASPERA_CLI_DOC_CHECK_LINKS=yes
+```
+
 ### Automated Release Process
 
 Releases are managed through the GitHub Actions UI via the **New Release on GitHub** workflow (`.github/workflows/release.yml`).

data/README.md

@@ -5,6 +5,8 @@
 [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/5861/badge)](https://bestpractices.coreinfrastructure.org/projects/5861)
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
 
+![Hootput the Owl](docs/mascot.svg)
+
 **`ascli`** is the command-line interface for IBM Aspera products.
 Use it from the terminal or in scripts to:
 
@@ -18,8 +20,8 @@ Choose what best suits you:
 
 | Resource | Link |
 | -------- | ---- |
-| **Online manual** | [docs/README.md](docs/README.md) |
-| **PDF manual** | In [releases](https://github.com/IBM/aspera-cli/releases) |
+| **Online manual** | [GitHub docs/README.md](https://github.com/IBM/aspera-cli/blob/main/docs/README.md) |
+| **PDF manual** | In [GitHub Releases](https://github.com/IBM/aspera-cli/releases) |
 | **RubyGems** | [rubygems.org/gems/aspera-cli](https://rubygems.org/gems/aspera-cli) |
 | **RubyDoc** | [rubydoc.info/gems/aspera-cli](https://www.rubydoc.info/gems/aspera-cli) |
 | **Docsify** | [online](https://docsify-this.net/?basePath=https://raw.githubusercontent.com/IBM/aspera-cli/main/docs&homepage=README.md&sidebar=true&browser-tab-title=Aspera%20CLI%20Manual&hide-credits=true&maxLevel=4&externalLinkTarget=_blank&image-captions=true&dark-mode=auto) |
@@ -34,7 +36,7 @@ ascli config transferd install
 ```
 
 The second command installs the **FASP** transfer engine (`ascp`).
-For other install methods (single executable, Docker, Chocolatey, Homebrew), see the [user manual](docs/README.md#installation).
+For other install methods (single executable, Docker, Chocolatey, Homebrew), see the [user manual](https://github.com/IBM/aspera-cli/blob/main/docs/README.md#installation).
 
 **Quick check:**
 
@@ -44,13 +46,13 @@ ascli -v
 
 ## Contributing
 
-- **Bugs & features:** [BUGS.md](BUGS.md)
-- **How to contribute:** [CONTRIBUTING.md](CONTRIBUTING.md)
-- **Release notes:** [CHANGELOG.md](CHANGELOG.md)
+- **Bugs & features:** [BUGS.md](https://github.com/IBM/aspera-cli/blob/main/BUGS.md)
+- **How to contribute:** [CONTRIBUTING.md](https://github.com/IBM/aspera-cli/blob/main/CONTRIBUTING.md)
+- **Release notes:** [CHANGELOG.md](https://github.com/IBM/aspera-cli/blob/main/CHANGELOG.md)
 
 Commands map to Aspera REST APIs; see the manual for options.
 For debugging, use `--log-level=debug`.
 
 ## License
 
-[Apache-2.0](LICENSE)
+[Apache-2.0](https://github.com/IBM/aspera-cli/blob/main/LICENSE)

data/lib/aspera/agent/direct.rb

@@ -25,25 +25,27 @@ module Aspera
       private_constant :LISTEN_LOCAL_ADDRESS, :SELECT_AVAILABLE_PORT
 
       # Options: same as values in option `transfer_info`
-      # @param ascp_args         [Array]   (Params) Optional Additional arguments to ascp
-      # @param wss               [Boolean] (Params) `true`: if both SSH and wss in ts: prefer wss
-      # @param quiet             [Boolean] (Params) By default no native `ascp` progress bar
-      # @param monitor           [Boolean] (Params) Set to `false` to eliminate management port
-      # @param trusted_certs     [Array]   (Params) Optional list of files with trusted certificates (stores)
-      # @param client_ssh_key    [String]  (Params) Client SSH key option (from CLIENT_SSH_KEY_OPTIONS)
-      # @param check_ignore_cb   [Proc]    (Params) Callback with host,port
+      # (Args) : Options that influence `ascp` arguments.
+      #
+      # @param ascp_args         [Array]   (Args) Optional Additional arguments to ascp
+      # @param wss               [Boolean] (Args) `true`: if both SSH and wss in ts: prefer wss
+      # @param quiet             [Boolean] (Args) By default no native `ascp` progress bar
+      # @param client_ssh_key    [String]  (Args) Client SSH key option (from CLIENT_SSH_KEY_OPTIONS)
+      # @param trusted_certs     [Array<String>] (Args) (WSS) Optional list of files with trusted certificates (stores)
+      # @param check_ignore_cb   [Proc]    (Args) (WSS) Callback with host,port to check if WSS connection shall ignore certificate validity
       # @param spawn_timeout_sec [Integer] Timeout for ascp spawn
       # @param spawn_delay_sec   [Integer] Optional delay to start between sessions
       # @param multi_incr_udp    [Boolean] Optional `true`: increment UDP port for each session
       # @param resume            [Hash]    Optional Resume policy
+      # @param monitor           [Boolean] Set to `false` to eliminate management port
       # @param management_cb     [Proc]    callback for management events
       # @param base_options      [Hash]    other options for base class
       def initialize(
         ascp_args:         nil,
         wss:               true,
         quiet:             true,
-        trusted_certs:     nil,
         client_ssh_key:    nil,
+        trusted_certs:     nil,
         check_ignore_cb:   nil,
         spawn_timeout_sec: 2,
         spawn_delay_sec:   2,

data/lib/aspera/agent/factory.rb

@@ -22,11 +22,11 @@ module Aspera
         Dir.children(File.dirname(File.expand_path(__FILE__)))
           .select{ |file| file.end_with?(Environment::RB_EXT)}
           .map{ |file| File.basename(file, Environment::RB_EXT).to_sym}
-          .reject{ |item| IGNORED_ITEMS.include?(item)}.each_with_object({}) do |agent_sym, hash|
-          hash[agent_sym] = {
+          .reject{ |item| IGNORED_ITEMS.include?(item)}.to_h do |agent_sym|
+          [agent_sym, {
             long:  agent_sym.to_s.capitalize,
             short: agent_sym.eql?(:direct) ? :a : agent_sym.to_s[0].to_sym
-          }.freeze
+          }.freeze]
         end.freeze
       private_constant :IGNORED_ITEMS
     end

data/lib/aspera/agent/node.rb

@@ -59,7 +59,7 @@ module Aspera
         ts_tags = transfer_spec['tags']
         ts_tags[Transfer::Spec::TAG_RESERVED]['xfer_retry'] ||= 150 if ts_tags.is_a?(Hash) && ts_tags[Transfer::Spec::TAG_RESERVED].is_a?(Hash)
         # Optimization in case of sending to the same node
-        # TODO: probably remove this, as /etc/hosts shall be used for that
+        # TODO: probably remove this, as /etc/hosts shall be used for that on server side.
         transfer_spec['remote_host'] = '127.0.0.1' if !transfer_spec['wss_enabled'] && transfer_spec['remote_host'].eql?(URI.parse(node_api_.base_url).host)
         resp = node_api_.create('ops/transfers', transfer_spec)
         @transfer_id = resp['id']

data/lib/aspera/api/alee.rb

@@ -3,6 +3,7 @@
 require 'aspera/api/aoc.rb'
 module Aspera
   module Api
+    # Aspera License Entitlement Engine API client
     class Alee < Aspera::Rest
       def initialize(entitlement_id, customer_id, api_domain: AoC::SAAS_DOMAIN_PROD, version: 'v1')
         super(

data/lib/aspera/api/aoc.rb

@@ -7,11 +7,15 @@ require 'aspera/hash_ext'
 require 'aspera/data_repository'
 require 'aspera/transfer/spec'
 require 'aspera/api/node'
+require 'aspera/rest_list'
 require 'base64'
 
 module Aspera
   module Api
+    # Aspera on Cloud API client
     class AoC < Rest
+      include RestList
+
       PRODUCT_NAME = 'Aspera on Cloud'
       # use default workspace if it is set, else none
       DEFAULT_WORKSPACE = ''
@@ -144,7 +148,7 @@ module Aspera
 
         # Call `block` with same query using paging and response information.
         # Block must return a 2 element `Array` with data and http response
-        # @param query    [Hash] Additionnal query parameters
+        # @param query    [Hash] Additional query parameters
         # @return [Hash] Items and total number of items
         # @option return [Array<Hash>] :items The list of items
         # @option return [Integer] :total The total number of items
@@ -209,7 +213,7 @@ module Aspera
           when 'upload' then %w[mkdir write]
           when Array
             Aspera.assert_array_all(levels, String){'access_levels'}
-            levels.each{ |level| Aspera.assert_value(level, Node::ACCESS_LEVELS){'access_level'}}
+            levels.each{ |level| Aspera.assert_values(level, Node::ACCESS_LEVELS){'access_level'}}
             levels
           else Aspera.error_unexpected_value(levels){"access_levels must be a list of #{Node::ACCESS_LEVELS.join(', ')} or one of edit, preview, download, upload"}
           end
@@ -492,7 +496,7 @@ module Aspera
       # in that case, the name is resolved and replaced with {type: , id: }
       # @param package_data    [Hash]   The whole package creation payload
       # @param rcpt_lst_field  [String] The field in structure, i.e. recipients or bcc_recipients
-      # @param new_user_option [Hash]   Additionnal fields for contact creation
+      # @param new_user_option [Hash]   Additional fields for contact creation
       # @return nil, `package_data` is modified
       def resolve_package_recipients(package_data, rcpt_lst_field, new_user_option)
         return unless package_data.key?(rcpt_lst_field)
@@ -510,7 +514,7 @@ module Aspera
             # email: user, else dropbox
             entity_type = short_recipient_info.include?('@') ? 'contacts' : 'dropboxes'
             begin
-              full_recipient_info = lookup_by_name(entity_type, short_recipient_info, query: {'current_workspace_id' => ws_id})
+              full_recipient_info = lookup_by_name(entity_type, 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}"}

data/lib/aspera/api/ats.rb

@@ -5,7 +5,7 @@ require 'aspera/rest'
 
 module Aspera
   module Api
-    # ATS API without authentication
+    # Aspera Transfer Service API client without authentication
     class Ats < Aspera::Rest
       SERVICE_BASE_URL = 'https://ats.aspera.io'
       # currently supported clouds

data/lib/aspera/api/cos_node.rb

@@ -7,6 +7,7 @@ require 'xmlsimple'
 
 module Aspera
   module Api
+    # Cloud Object Storage Node API Client
     class CosNode < Node
       IBM_CLOUD_TOKEN_URL = 'https://iam.cloud.ibm.com/identity'
       TOKEN_FIELD = 'delegated_refresh_token'

data/lib/aspera/api/faspex.rb

@@ -2,10 +2,11 @@
 
 require 'aspera/rest'
 require 'aspera/oauth/base'
+require 'aspera/rest_list'
 require 'digest'
 
 module Aspera
-  # Implement OAuth for Faspex public link
+  # OAuth for Faspex public link
   class FaspexPubLink < OAuth::Base
     class << self
       attr_accessor :additional_info
@@ -55,7 +56,10 @@ module Aspera
   end
   OAuth::Factory.instance.register_token_creator(FaspexPubLink)
   module Api
+    # Aspera Faspex 5 API Client
     class Faspex < Aspera::Rest
+      include RestList
+
       # endpoint for authentication API
       PATH_AUTH = 'auth'
       PATH_API_V5 = 'api/v5'

data/lib/aspera/api/httpgw.rb

@@ -4,6 +4,7 @@ require 'aspera/log'
 require 'aspera/rest'
 require 'aspera/transfer/faux_file'
 require 'aspera/assert'
+require 'net/protocol'
 require 'securerandom'
 require 'websocket'
 require 'base64'
@@ -11,6 +12,7 @@ require 'json'
 
 module Aspera
   module Api
+    # Aspera HTTP Gateway API client
     # Start a transfer using Aspera HTTP Gateway, using web socket secure for uploads
     # ref: https://api.ibm.com/explorer/catalog/aspera/product/ibm-aspera/api/http-gateway-api/doc/guides-toc
     # https://developer.ibm.com/apis/catalog?search=%22aspera%20http%22

data/lib/aspera/api/node.rb

@@ -14,7 +14,8 @@ require 'net/ssh/buffer'
 
 module Aspera
   module Api
-    # Provides additional functions using node API with gen4 extensions (access keys)
+    # Aspera Node API client
+    # with gen4 extensions (access keys)
     class Node < Rest
       # Format of node scope : node.<access key>:<scope>
       module Scope
@@ -508,7 +509,7 @@ module Aspera
           # Get the transfer user from info on access key
           transfer_spec['remote_user'] = info['transfer_user'] if info['transfer_user']
           # Get settings from name.value array to hash key.value
-          settings = info['settings']&.each_with_object({}){ |i, h| h[i['name']] = i['value']}
+          settings = info['settings']&.to_h{ |i| [i['name'], i['value']]}
           # Check WSS ports
           Transfer::Spec::WSS_FIELDS.each do |i|
             transfer_spec[i] = settings[i] if settings.key?(i)

data/lib/aspera/ascp/installation.rb

@@ -83,16 +83,15 @@ module Aspera
 
       # @return [Hash] with key = file name (String), and value = path to file
       def file_paths
-        return SDK_FILES.each_with_object({}) do |v, m|
-          m[v.to_s] =
-            begin
-              path(v)
-            rescue Errno::ENOENT => e
-              e.message.gsub(/.*assertion failed: /, '').gsub(/\): .*/, ')')
-            rescue => e
-              e.message
-            end
-        end
+        return SDK_FILES.to_h do |v|
+                 [v.to_s, begin
+                   path(v)
+                 rescue Errno::ENOENT => e
+                   e.message.gsub(/.*assertion failed: /, '').gsub(/\): .*/, ')')
+                 rescue => e
+                   e.message
+                 end]
+               end
       end
 
       # TODO: if using another product than SDK, should use files from there

data/lib/aspera/cli/error.rb

@@ -9,7 +9,15 @@ module Aspera
     class MissingArgument < Error; end
     class NoSuchElement < Error; end
 
+    # Raised when a lookup for a specific entity fails to return exactly one result.
+    #
+    # Provides a formatted message indicating whether the entity was missing
+    # or if multiple matches were found (ambiguity).
     class BadIdentifier < Error
+      # @param res_type [String] The type of entity being looked up (e.g., 'user').
+      # @param res_id   [String] The value of the identifier that failed.
+      # @param field    [String] The name of the field used for lookup (defaults to 'identifier').
+      # @param count    [Integer] The number of matches found (0 for not found, >1 for ambiguous).
       def initialize(res_type, res_id, field: 'identifier', count: 0)
         msg = count.eql?(0) ? 'not found' : "found #{count}"
         super("#{res_type} with #{field}=#{res_id}: #{msg}")

data/lib/aspera/cli/info.rb

@@ -7,7 +7,8 @@ module Aspera
       CMD_NAME = 'ascli'
       # Name of the containing gem, same as in <gem name>.gemspec
       GEM_NAME = 'aspera-cli'
-      DOC_URL  = "https://www.rubydoc.info/gems/#{GEM_NAME}"
+      DOC_URL  = 'https://ibm.biz/ascli-doc'
+      RUBYDOC_URL = "https://www.rubydoc.info/gems/#{GEM_NAME}"
       GEM_URL  = "https://rubygems.org/gems/#{GEM_NAME}"
       SRC_URL  = 'https://github.com/IBM/aspera-cli'
       CONTAINER = 'docker.io/martinlaurent/ascli'