aspera-cli 4.25.5 → 4.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a886cb3a02f285c84728b216f1cd906b8440db041a8240ed09ed1969d81ec6c3
-  data.tar.gz: a05a7d9fc94a5d748c52d659426a18cf567a9e303231c86d1ec2312abc3465ae
+  metadata.gz: 5dcaa66a7401bb325ae68b4f51ef44e7820332159203a7a5247fc3c2d447d9e5
+  data.tar.gz: cf0a6734797c0803d77daa01b547daccf4dc4af0c17ff7872d186ad3fbffe62f
 SHA512:
-  metadata.gz: 87988d7b4252134e772c7c5420e59471cfb89355627cb3bf49fe6f5cf19382644856dfee3494adb3db2a879fc42b77f5754f8fee995eae8ca45229fc68ccd769
-  data.tar.gz: ace70306ca85a12b17d12dcf146f280d313dcbef491576c265a5a20f70199d1c03ef3834cc62de30b20949f2cfdea39821b09b232c8bd826709f5622c7f631c3
+  metadata.gz: e3c8fb9d31eca016b0c88ef324aa307e73535b34672cd2f42d54c4695b7d12fa8d18e98cdbff7115a65856d161ba5869fb3e3e83eef97293411189d7c8f5a454
+  data.tar.gz: bfee651a574ceaa6c6e10ea54b51d50e3d58cf33e0e89b909ad71bff7969dcb01c45707b3ae2cc4bccd553bb69c42ab0f288a043943df01fd9ca9379d6650872

data/CHANGELOG.md

@@ -2,6 +2,41 @@
 
 <!-- markdownlint-configure-file { "no-duplicate-heading": { "siblings_only": true } } -->
 
+## 4.26.0
+
+Released: 2026-05-28
+
+### New Features
+
+* `preview`: New option `root_url` (replaces `file_access`), to override how to access files on storage.
+* `node`: (also `aoc files`) Operation `modify` added to `permissions`.
+* `node`: (also `aoc files`) Operation `list` now uses paging.
+* `aoc`: When creating a shared inbox, the value of option `workspace` is now used as default value to set field `workspace_id`.
+* `aoc`: Support additional operations on `admin application`, like activate/deactivate app in workspace.
+* `aoc`: Support additional operations on `admin user` and `user`: `preferences` and `notifications`.
+* `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.
+
+### Issues Fixed
+
+* `format`: In `table` format with option `flat_hash=yes`, fixed that some parameters were not shown. Moreover, (Node API: /info), if an array of hash with name/value keys is returned with one extra key, still apply simplification.
+* **global**: Fixed #254.
+
+### Breaking Changes
+
+* `preview`: Removed option `file_access`, replaced with option `root_url`.
+* `aoc`: Command `resource` in `admin`is now removed. It was deprecated since 4.18. Use the same command without `resource`. Place the resource name directly after `admin`.
+
+## 4.25.6
+
+Released: 2026-04-08
+
+### Issues Fixed
+
+* `node`: #253 fix `node transfer list` infinite loop with `once_only`.
+
 ## 4.25.5
 
 Released: 2026-03-25
@@ -14,9 +49,7 @@ Released: 2026-03-25
 
 * `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
+* `httpgw`: #252 HTTPGW transfer showed success even when error code `403` was returned. Now raises error with message.
 
 ## 4.25.4
 
@@ -115,7 +148,7 @@ Released: 2026-01-21
 ### Issues Fixed
 
 * `aoc`: Restored command `admin workspace shared_folder :id list` which was since 4.11.0.
-* `direct`: When using `ascp4` do not set env var: `ASPERA_TEST_REDIS_DISABLE`, else it fails with: `Failed to initialize application`.
+* `direct`: When using `ascp4`, do not set env var: `ASPERA_TEST_REDIS_DISABLE`, else it fails with: `Failed to initialize application`.
 * `shares`: Properly detect using `/node_api/ping` endpoint instead of `/app`.
 
 ### Breaking Changes
@@ -194,7 +227,7 @@ Released: 2025-09-30
 * `console`: Removed options `filter_from` and `filter_to`. Use standard option `query` instead.
 * `sync`: Removed option `sync_info`. Replaced with positional parameters. Streamlined command line interface. Applies to all plugins with `sync` command.
 * `async`: Removed option `sync_name`. Replaced with percent selector `%name:`.
-* `aoc`: `files download` using gen4 API do not require anymore to provide the containing folder in first position, and then only file names. Now, directly provide the path to all files.
+* `aoc`: `files download` using gen4 API no longer requires providing the containing folder in first position, and then only file names. Now, directly provide the path to all files.
 * `logger`: Log is simplified, date is removed by default. Use `--log_format=standard` to revert to standard Ruby logger. See option `log_format` for details.
 
 ## 4.23.0
@@ -208,7 +241,7 @@ Released: 2025-08-11
 
 ### Issues Fixed
 
-* `server`: #209: missing home folder for transfer user shall not cause an error.
+* `server`: #209: a missing home folder for the transfer user shall not cause an error.
 * `direct`: #205: `kill` blocks `cmd` on Windows.
 
 ### Breaking Changes
@@ -303,7 +336,7 @@ Released: 2025-01-21
 ### New Features
 
 * `aoc`: Improved usability for creation of Admin shared folders.
-* `node`: New option `node_cache` (bool) for gen4 operations.
+* `node`: New option `node_cache` (boolean) for gen4 operations.
 * `node`: Option `root_id` now always works for node gen4, as well as `%id:` for file selection in addition to path.
 * `node`: `transfer list` now uses the `iteration_token` to retrieve all values. Option `once_only` is now supported.
 * **global**: Option `http_options` now include retry options.
@@ -407,7 +440,7 @@ Released: 2024-07-13
 
 ### Breaking Changes
 
-* `config`: Command `remote_certificate` now takes a subcommand.
+* `config`: Command `remote_certificate` now takes a sub-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","..."]}`
@@ -492,7 +525,7 @@ General: Removed many redundant options, more consistency between plugins, see b
 * **global**: Renamed option `notif_to` to `notify_to` and `notif_template` to `notify_template`.
 * **global**: Removed extended value handler `incps`, as it is never used (use `extend` instead).
 * **global**: Option `fields`: `+prop` is replaced with: `DEF,prop` and `-field` is replaced with: `DEF,-field`, and whole list is evaluated.
-* **global**: Replaced option `progress` with option `progressbar` (bool).
+* **global**: Replaced option `progress` with option `progressbar` (boolean).
 * **global**: Removed option `rest_debug` and `-r`, replaced with `--log-level=trace2`.
 * **global**: The default file name for private key when using wizard is change from `aspera_aoc_key` to `my_private_key.pem`.
 * `faspex5`: Removed option and `auth` type `link`: simply provide the public link as `url`.
@@ -620,8 +653,8 @@ Released: 2023-01-26
 * **container**: Image has entry point.
 * `aoc`: `admin res node` commands `v3` and `v4` replaced with `do` and command `v3` moved inside `do`.
 * Renamed options for `sync`.
-* Node gen4 operations are moved from aoc plugin to node plugin but made available where gen4 is used.
-* If wss is enabled on server, use wss.
+* Node gen4 operations are moved from `aoc` plugin to node plugin but made available where gen4 is used.
+* If WSS is enabled on server, use WSS.
 * Lots of cleanup and refactoring.
 
 ## 4.10.0
@@ -671,9 +704,9 @@ Released: 2022-06-16
 ### New Features
 
 * #76 add resource `group_membership` in `aoc`.
-* Add resource `metadata_profile` in `faspex5`.
-* Add command `user profile` in `faspex5`.
-* Add config wizard for `faspex5`.
+* New resource `metadata_profile` in `faspex5`.
+* New command `user profile` in `faspex5`.
+* Config wizard for `faspex5`.
 * #75 gem is signed.
 
 ### Breaking Changes
@@ -697,7 +730,7 @@ Released: 2022-03-23
 * Option `show_secrets` to reveal secrets in command output.
 * Added and updated commands for Faspex 5.
 * Option `cache_tokens`.
-* Faspex4 dropbox packages can now be received by id.
+* Faspex4 dropbox packages can now be received by ID.
 
 ### Issues Fixed
 
@@ -707,7 +740,7 @@ Released: 2022-03-23
 
 * Command `conf gem path` replaces `conf gem_path`.
 * Option `fpac` expects a value instead of URL.
-* Option `cipher` in transfer spec must have hyphen.
+* Option `cipher` in transfer spec must be hyphened.
 * Renamed option `log_passwords` to `log_secrets`.
 * Removed plugin `shares2` as products is now EOL.
 
@@ -724,7 +757,7 @@ Released: 2022-02-04
 
 ### Issues Fixed
 
-* #60 ascli executable was not installed by default in 4.5.0.
+* #60 `ascli` executable was not installed by default in 4.5.0.
 * Add password hiding case in logs.
 
 ### Breaking Changes
@@ -743,9 +776,9 @@ Released: 2021-12-27
 ### New Features
 
 * Support transfer agent: [Transfer SDK](README.md#agt_trsdk).
-* Support [http socket options](README.md#http_options).
+* Support [HTTP socket options](README.md#http_options).
 * Logs hide passwords and secrets, option `log_passwords` to enable logging secrets.
-* `config vault` supports encrypted passwords, also macos keychain.
+* `config vault` supports encrypted passwords, also macOS keychain.
 * `config preset` command for consistency with macOS.
 * Identifier can be provided using either option `id` or directly after the command, e.g. `delete 123` is the same as `delete --id=123`.
 
@@ -771,7 +804,7 @@ Released: 2021-11-13
 * `aoc admin res xxx list` now get all items by default #50.
 * `preset` option can specify name or hash value.
 * `node` plugin accepts bearer token and access key as credential.
-* `node` option `token_type` allows using basic token in addition to aspera type.
+* `node` option `token_type` allows using basic token in addition to Aspera type.
 
 ### Breaking Changes
 
@@ -794,14 +827,14 @@ Released: 2021-09-23
 ### New Features
 
 * `faspex package list` retrieves the whole list, not just first page.
-* Support web based auth to aoc and faspex 5 using HTTPS, new dependency on gem `webrick`.
+* Support web based auth to `aoc` and `faspex5` using HTTPS, new dependency on gem `webrick`.
 * The error "Remote host is not who we expected" displays a special remediation message.
 * `conf ascp spec` displays supported transfer spec.
 * Options `notif_to` and `notif_template` to send email notifications on transfer (and other events).
 
 ### Issues Fixed
 
-* Space character in `faspe:` url are percent encoded if needed.
+* Space character in `faspe:` URL are percent encoded if needed.
 * `preview scan`: If file_id is unknown, ignore and continue scan.
 
 ### Breaking Changes
@@ -833,7 +866,7 @@ Released: 2021-08-24
 
 * On Windows `conf ascp use` expects ascp.exe.
 * (break) multi_session_threshold is Integer, not String.
-* `conf ascp install` renames sdk folder if it already exists (leftover shared lib may make fail).
+* `conf ascp install` renames `sdk` folder if it already exists (leftover shared lib may make fail).
 * Removed `replace_illegal_chars` from default `aspera.conf` causing "Error creating illegal char conversion table".
 
 ### Breaking Changes
@@ -853,8 +886,8 @@ Released: 2021-06-23
 * Added option `sdk_url` to install SDK from local file for offline install.
 * Check new gem version periodically.
 * The --fields= option, support -_field_name_ to remove a field from default fields.
-* Oauth tokens are discarded automatically after 30 minutes (useful for COS delegated refresh tokens).
-* `mimemagic` is now optional, needs manual install for `preview`, compatible with version 0.4.x.
+* OAuth's tokens are discarded automatically after 30 minutes (useful for COS delegated refresh tokens).
+* `mimemagic` is now optional, needs manual installation for `preview`, compatible with version 0.4.x.
 * AoC a password can be provided for a public link.
 * `conf doc` take an optional parameter to go to a section.
 * Initial support for Faspex 5 Beta 1.
@@ -876,7 +909,7 @@ Released: 2021-02-03
 ### Breaking Changes
 
 * Changed default tool name from `mlia` to `ascli`.
-* Changed `aspera` command to `aoc`.
+* Renamed `aspera` command to `aoc`.
 * Changed gem name from `asperalm` to `aspera-cli`.
 * Changed module name from `Asperalm` to `Aspera`.
 * Removed command `folder` in `preview`, merged to `scan`.
@@ -884,7 +917,7 @@ Released: 2021-02-03
 
 ## 0.11.8
 
-* Simplified to use `unoconv` instead of bare `libreoffice` for office conversion, as `unoconv` does not require a X server (previously using `Xvfb`).
+* Simplified to use `unoconv` instead of bare `libreoffice` for office conversion, as `unoconv` does not require an X server (previously using `Xvfb`).
 
 ## 0.11.7
 
@@ -893,7 +926,7 @@ Released: 2021-02-03
 * Fixed option `lock_port` not working.
 * Generate special icon if preview failed.
 * Possibility to choose transfer progress bar type with option `progress`.
-* AoC package creation now output package id.
+* AoC package creation now output package ID.
 
 ## 0.11.6
 
@@ -910,13 +943,13 @@ Released: 2021-02-03
 * Added option `default_ports` for AoC (see manual).
 * Allow bulk delete in `aspera files` with option `bulk=yes`.
 * Fix getting connect versions.
-* Added section for Aix.
-* Support all ciphers for [`direct`](README.md#agt_direct) agent (including gcm, etc..).
-* Added transfer spec param `apply_local_docroot` for [`direct`](README.md#agt_direct).
+* Added section for AIX.
+* Support all ciphers for [`direct`](README.md#agt_direct) agent (including GCM, etc.).
+* Added transfer spec parameter `apply_local_docroot` for [`direct`](README.md#agt_direct).
 
 ## 0.11.4
 
-* Possibility to give shared inbox name when sending a package (else use id and type).
+* Possibility to give shared inbox name when sending a package (else use ID and type).
 
 ## 0.11.3
 
@@ -924,7 +957,7 @@ Released: 2021-02-03
 
 ## 0.11.2
 
-* Fixes on multi-session: Progress bat and transfer spec param for "direct".
+* Fixes on multi-session: Progress bar and transfer spec parameter for `direct`.
 
 ## 0.11.1
 
@@ -932,7 +965,7 @@ Released: 2021-02-03
 
 ## 0.11
 
-* Add transfer spec option (agent `direct` only) to provide file list directly to ascp: `EX_file_list`.
+* Add transfer spec option (agent `direct` only) to provide file list directly to `ascp`: `EX_file_list`.
 
 ## 0.10.18
 
@@ -954,7 +987,7 @@ Released: 2021-02-03
 
 ## 0.10.14
 
-* Added missing bss plugin.
+* Added missing `bss` plugin.
 
 ## 0.10.13
 
@@ -995,12 +1028,12 @@ Released: 2021-02-03
 
 ## 0.10.6
 
-* FaspManager: Transfer spec `authentication` no more needed for local transfer to use Aspera public keys. public keys will be used if there is a token and no key or password is provided.
+* FaspManager: Transfer spec `authentication` is no longer needed for local transfer to use Aspera public keys. Public keys will be used if there is a token and no key or password is provided.
 * Gem version requirements made more open.
 
 ## 0.10.5
 
-* Fix faspex package receive command not working.
+* Fix Faspex package receive command not working.
 
 ## 0.10.4
 
@@ -1009,7 +1042,7 @@ Released: 2021-02-03
 
 ## 0.10.3
 
-* Included user name in oauth bearer token cache for AoC when JWT is used.
+* Included username in OAuth bearer token cache for AoC when JWT is used.
 
 ## 0.10.2
 
@@ -1038,7 +1071,7 @@ Released: 2021-02-03
 
 ## 0.9.34
 
-* Parser "@preset" can be used again in option "transfer_info".
+* Parser `@preset` can be used again in option `transfer_info`.
 * Some documentation re-organizing.
 
 ## 0.9.33
@@ -1053,7 +1086,7 @@ Released: 2021-02-03
 ### New Features
 
 * All Faspex public links are now supported.
-* Removed faspex operation `recv_publink`. Replaced with option `link` (consistent with AoC).
+* Removed Faspex operation `recv_publink`. Replaced with option `link` (consistent with AoC).
 
 ## 0.9.31
 
@@ -1097,7 +1130,7 @@ Released: 2021-02-03
 ### New Features
 
 * Defined REST error handlers, more error conditions detected.
-* Commands to select specific ascp location.
+* Commands to select specific `ascp` location.
 
 ## 0.9.21
 
@@ -1110,7 +1143,7 @@ Released: 2021-02-03
 
 ### New Features
 
-* Improved wizard (prepare for AoC global client id).
+* Improved wizard (prepare for AoC global client ID).
 * Preview generator: Added option : `skip_format` with values `png`, `mp4`.
 * Removed outdated pictures from this doc.
 
@@ -1124,7 +1157,7 @@ Released: 2021-02-03
 
 ### New Features
 
-* Enhanced aspera admin events to support query.
+* Enhanced Aspera admin events to support query.
 
 ## 0.9.16
 
@@ -1137,19 +1170,19 @@ Released: 2021-02-03
 
 ### New Features
 
-* New feature: "find" command in aspera files.
+* New feature: `find` command in Aspera Files.
 * Sample code for transfer API.
 
 ## 0.9.12
 
 ### New Features
 
-* Add nagios commands.
-* Support of ATS for IBM Cloud, removed old version based on aspera id.
+* Add `nagios` commands.
+* Support of ATS for IBM Cloud, removed old version based on Aspera ID.
 
 ## 0.9.11
 
-* Support of ATS for IBM Cloud, removed old version based on aspera id.
+* Support of ATS for IBM Cloud, removed old version based on Aspera ID.
 
 ### Breaking Changes
 
@@ -1163,7 +1196,7 @@ Released: 2021-02-03
 ### Breaking Changes
 
 * **global**: Parameter transfer-node becomes more generic: `transfer-info`.
-* **global**: Replaced download_mode option with http_download action.
+* **global**: Replaced `download_mode` option with `http_download` action.
 
 ## 0.9.9
 
@@ -1173,7 +1206,7 @@ Released: 2021-02-03
 
 ### Breaking Changes
 
-* **global**: "aspera package send" parameter deprecated, use the --value option instead with "recipients" value. See example.
+* **global**: `aspera package send` parameter deprecated, use the --value option instead with "recipients" value. See example.
 
 ## 0.9.8
 
@@ -1218,7 +1251,7 @@ Released: 2021-02-03
 
 ### Breaking Changes
 
-* `oncloud`: `oncloud file list` follow `--source` convention as well (plus specific case for download when first path is source folder, and other are source file names).
+* `oncloud`: `oncloud file list` follow `--source` convention as well (plus specific case for download when first path is source folder, and others are source file names).
 
 ## 0.9.3
 
@@ -1244,17 +1277,17 @@ Released: 2021-02-03
 
 ### Breaking Changes
 
-* `faspex`: Changed faspex package creation to match API, see Faspex section.
+* `faspex`: Changed Faspex package creation to match API, see Faspex section.
 
 ## 0.9
 
 ### New Features
 
-* Automatic rename and conversion of former config folder from aslmcli to ascli.
+* Automatic rename and conversion of former config folder from `aslmcli` to `ascli`.
 
 ### Breaking Changes
 
-* Renamed the CLI from aslmcli to ascli.
+* Renamed the CLI from `aslmcli` to `ascli`.
 
 ## 0.7.6
 
@@ -1273,7 +1306,7 @@ Released: 2021-02-03
 ### Breaking Changes
 
 * `aoc`: AoC `package recv` take option if for package instead of argument.
-* **global**: Rest class and Oauth class changed init parameters.
+* **global**: Rest class and OAuth class changed initialization parameters.
 
 ## 0.6.19
 

data/CONTRIBUTING.md

@@ -114,6 +114,8 @@ The following environment variables and macros control specific build behaviors:
 | `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.                          |
+| `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.
 
@@ -156,7 +158,7 @@ tlmgr install fvextra selnolig lualatex-math
 rake doc:check_links
 ```
 
-- Debug the generation process: `ASPERA_CLI_DOC_DEBUG=debug`.
+- Debug the generation process: `DEBUG=1`.
 
 - Build the documentation:
 
@@ -254,6 +256,13 @@ bundle exec rake container:test
 bundle exec rake doc:check_links
 ```
 
+- **Check release procedure**:
+
+```shell
+bundle exec rake release:run DRY_RUN=1
+git restore lib/aspera/cli/version.rb CHANGELOG.md docs/README.md
+```
+
 ### Automated Release Process
 
 Releases are managed through the GitHub Actions UI via the **New Release on GitHub** workflow (`.github/workflows/release.yml`).
@@ -313,4 +322,4 @@ This triggers the `.github/workflows/deploy.yml` action to publish to RubyGems.
   - [rest-client](https://github.com/rest-client/rest-client)
   - [oauth2](https://github.com/oauth-xx/oauth2)
 - Integrate `thor` <http://whatisthor.com/> or another standard Ruby CLI framework.
-- Explore [Traveling Ruby](https://github.com/phusion/traveling-ruby) for distribution.
+- Explore [Traveling Ruby](https://github.com/phusion/traveling-ruby) for distribution, or [truby Traveling Ruby](https://github.com/trubygems/traveling-ruby).