aspera-cli 4.25.4 → 4.25.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34cb77d2badea1e3650f2aed72fb3a91c419e6457a08acd62808c9a6d9ab0e74
-  data.tar.gz: 31e1e1a28d99afebd6b6a3f7b9e848bf18256d47fdc7108368a6e964eef03b04
+  metadata.gz: a886cb3a02f285c84728b216f1cd906b8440db041a8240ed09ed1969d81ec6c3
+  data.tar.gz: a05a7d9fc94a5d748c52d659426a18cf567a9e303231c86d1ec2312abc3465ae
 SHA512:
-  metadata.gz: e15bfb65919b8b8a6112120eca273dac962ff6d6b29d890df1e9293f4321e557bdd68697c394cb6ef738a3d5bcc3a75a2f7f177494b66542c2e970c4da99e9d0
-  data.tar.gz: 1d3570c590e7bfbda3ce5fc49396637471f48ff6fccce7235ae31adcc23c1e1ccc4a978d6bdbe9a4c1c06f06e02ed5336043267891c0b56a995b4d0199ab0d92
+  metadata.gz: 87988d7b4252134e772c7c5420e59471cfb89355627cb3bf49fe6f5cf19382644856dfee3494adb3db2a879fc42b77f5754f8fee995eae8ca45229fc68ccd769
+  data.tar.gz: ace70306ca85a12b17d12dcf146f280d313dcbef491576c265a5a20f70199d1c03ef3834cc62de30b20949f2cfdea39821b09b232c8bd826709f5622c7f631c3

data/CHANGELOG.md

@@ -2,6 +2,22 @@
 
 <!-- markdownlint-configure-file { "no-duplicate-heading": { "siblings_only": true } } -->
 
+## 4.25.5
+
+Released: 2026-03-25
+
+### 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
+
+* `config`: Fixed `preset update` with dot-path options.
+* `sync`: #251 in `admin` command: Fixed database path on Windows: Use `~private-asp` instead of `.private-asp`.
+* `httpgw`: #252 HTTPGW transfer showed success even in case of error code `403`. Now raises error with message.
+
+### Breaking Changes
+
 ## 4.25.4
 
 Released: 2026-03-04
@@ -301,7 +317,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 +1081,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 +1111,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 +1179,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 +1188,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,8 @@ 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.                 |
+| `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 +120,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 +139,28 @@ 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 with:
 
-- To debug the generation process: `ASPERA_CLI_DOC_DEBUG=debug`.
+```shell
+rake doc:check_links
+```
+
+- Debug the generation process: `ASPERA_CLI_DOC_DEBUG=debug`.
 
-- To build the documentation:
+- Build the documentation:
 
-```bash
+```shell
 rake doc:build
 ```
 
@@ -169,14 +172,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 +188,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 +198,7 @@ For more details, see <certs/README.md>.
 
 To update the stubs:
 
-```bash
+```shell
 bundle exec rake tools:grpc
 ```
 
@@ -211,7 +214,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 +237,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:check_links
+```
+
 ### 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
@@ -153,8 +157,8 @@ module Aspera
           Aspera.assert(block_given?)
           # 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(Rest::MAX_ITEMS)
-          max_pages = query.delete(Rest::MAX_PAGES)
+          max_items = query.delete(RestList::MAX_ITEMS)
+          max_pages = query.delete(RestList::MAX_PAGES)
           item_list = []
           total_count = nil
           current_page = query['page']
@@ -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,14 +56,14 @@ 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'
       PATH_HEALTH = 'configuration/ping'
-      private_constant :PATH_AUTH,
-        :PATH_API_V5,
-        :PATH_HEALTH
       RECIPIENT_TYPES = %w[user workgroup external_user distribution_list shared_inbox].freeze
       PACKAGE_TERMINATED = %w[completed failed].freeze
       # list of supported mailbox types (to list packages)
@@ -148,6 +149,7 @@ module Aspera
       def initialize(
         url:,
         auth:,
+        root: PATH_API_V5,
         password: nil,
         client_id: nil,
         client_secret: nil,
@@ -161,23 +163,23 @@ module Aspera
         super(**
           case auth
           when :public_link
-            # Get URL of final redirect of public link
-            redir_url = Rest.new(base_url: url, redirect_max: 3).call(operation: 'GET', ret: :resp).uri.to_s
-            Log.dump(:redir_url, redir_url, level: :trace1)
-            # get context from query
-            encoded_context = Rest.query_to_h(URI.parse(redir_url).query)['context']
+            # Get URL of final redirect of provided public link
+            final_url = Rest.new(base_url: url, redirect_max: 3).call(operation: 'GET', ret: :resp).uri.to_s
+            Log.dump(:final_url, final_url, level: :trace1)
+            # Get context from query
+            encoded_context = Rest.query_to_h(URI.parse(final_url).query)['context']
             raise ParameterError, 'Bad faspex5 public link, missing context in query' if encoded_context.nil?
             # public link information (contains passcode and allowed usage)
             @pub_link_context = JSON.parse(Base64.decode64(encoded_context))
             Log.dump(:pub_link_context, @pub_link_context, level: :trace1)
             # Get the base url, i.e. .../aspera/faspex
-            base_url = redir_url.gsub(%r{/public/.*}, '').gsub(/\?.*/, '')
+            base_url = final_url.gsub(%r{/public/.*}, '').gsub(/\?.*/, '')
             # Get web UI client_id and redirect_uri
             # TODO: change this for something more reliable
             config = JSON.parse(Rest.new(base_url: "#{base_url}/config.js", redirect_max: 3).call(operation: 'GET').sub(/^[^=]+=/, '').gsub(/([a-z_]+):/, '"\1":').delete("\n ").tr("'", '"')).symbolize_keys
-            Log.dump(:configjs, config)
+            Log.dump(:config_js, config)
             {
-              base_url: "#{base_url}/#{PATH_API_V5}",
+              base_url: "#{base_url}/#{root}",
               auth:     {
                 type:         :oauth2,
                 base_url:     "#{base_url}/#{PATH_AUTH}",
@@ -194,7 +196,7 @@ module Aspera
             Aspera.assert(password, type: ParameterError){'Missing password'}
             # the password here is the token copied directly from browser in developer mode
             {
-              base_url: "#{url}/#{PATH_API_V5}",
+              base_url: "#{url}/#{root}",
               headers:  {'Authorization' => password}
             }
           when :web
@@ -202,7 +204,7 @@ module Aspera
             Aspera.assert(redirect_uri, type: ParameterError){'Missing redirect_uri'}
             # opens a browser and ask user to auth using web
             {
-              base_url: "#{url}/#{PATH_API_V5}",
+              base_url: "#{url}/#{root}",
               auth:     {
                 type:         :oauth2,
                 base_url:     "#{url}/#{PATH_AUTH}",
@@ -217,7 +219,7 @@ module Aspera
             Aspera.assert(client_id, type: ParameterError){'Missing client_id'}
             Aspera.assert(private_key, type: ParameterError){'Missing private_key'}
             {
-              base_url: "#{url}/#{PATH_API_V5}",
+              base_url: "#{url}/#{root}",
               auth:     {
                 type:            :oauth2,
                 base_url:        "#{url}/#{PATH_AUTH}",
@@ -238,10 +240,6 @@ module Aspera
           end
         )
       end
-
-      def auth_api
-        Rest.new(**params, base_url: base_url.sub(PATH_API_V5, PATH_AUTH))
-      end
     end
   end
 end

data/lib/aspera/api/httpgw.rb

@@ -4,13 +4,18 @@ require 'aspera/log'
 require 'aspera/rest'
 require 'aspera/transfer/faux_file'
 require 'aspera/assert'
+require 'net/protocol'
 require 'securerandom'
 require 'websocket'
 require 'base64'
 require 'json'
 
+# throw exception on error, instead of error code
+WebSocket.should_raise = true
+
 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
@@ -75,6 +80,15 @@ module Aspera
         Log.log.trace2{"#{LOG_WS_SEND}counts: #{@shared_info[:count]}"}
       end
 
+      # Check header ourself and give precise error message, as websocket will only throw error without details
+      # @param [String] Response Header
+      # @return [String] Response Header
+      def validated_ws_response_header(header)
+        first_line = header.split("\r\n").first
+        raise RestCallError.new({messages: ["Unexpected: #{first_line}", 'Expected: 101 Switching Protocols']}) unless first_line.split(/\s+/, 3)[1].eql?('101')
+        header
+      end
+
       # message processing for read thread
       def process_received_message(message)
         Log.log.debug{"#{LOG_WS_RECV}message: [#{message}] (#{message.class})"}
@@ -153,8 +167,9 @@ module Aspera
         @ws_handshake = ::WebSocket::Handshake::Client.new(url: upload_url, headers: {})
         @ws_io.write(@ws_handshake.to_s)
         sleep(0.1)
-        @ws_handshake << @ws_io.readuntil("\r\n\r\n")
-        Aspera.assert(@ws_handshake.finished?){'Error in websocket handshake'}
+        # Get whole HTTP response header, Check and process
+        # no need to check `finished?` or result of `<<` (true), as we give the whole header at once
+        @ws_handshake << validated_ws_response_header(@ws_io.readuntil("\r\n\r\n"))
         Log.log.debug{"#{LOG_WS_SEND}handshake success"}
         # data shared between main thread and read thread
         @shared_info = {
@@ -232,14 +247,15 @@ module Aspera
         # throttling may have skipped last one
         @notify_cb&.call(:transfer, session_id: session_id, info: session_sent_bytes)
         @notify_cb&.call(:session_end, session_id: session_id)
-        @notify_cb&.call(:end)
         ws_send(ws_type: :close, data: nil)
         Log.log.debug("Finished upload, waiting for end of #{THR_RECV} thread.")
         @ws_read_thread.join
         Log.log.debug{'Read thread joined'}
+      ensure
         # session no more used
         @ws_io = nil
         http_session&.finish
+        @notify_cb&.call(:end)
       end
 
       def download(transfer_spec)