aspera-cli 4.23.0 → 4.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e7c12c376e7d332f07acaf7632a095c31610170103b27f96eea43667f4fa3b3
-  data.tar.gz: 84f9f1b90a08665b94e0d23016d74b7b54fc1b53855dba544237e908cc3fc49e
+  metadata.gz: f82c20bd2d1eb71e5942cbd45eed6e983770ee8867bd0e403325a1f762e0b667
+  data.tar.gz: d77e927f20370db6dfad42683b74e5fc9e24dea70ed59da26704f911aa5d3361
 SHA512:
-  metadata.gz: 9051ce885074c8df74dc4a8a19fc54463c6f9d1e954bef7f4634a198a443bdd615edd00c018e53d5a4066715b455fdaa0e5de6812b09dded3d1ec5b85a6f455f
-  data.tar.gz: 66fbf7d28bde0998170b9288d6cca9f201a766da99d764c2a72b5ceb64f2d47b76eb48954392f21d10713dbee591e2622c167abe943e32a9529e4c971f8d4be8
+  metadata.gz: f756c074e054ca7ddecdc7fd9bf89e577e42f30480a7868bfda00a259c08d9362f1fc77abab5779cfd62ccdcd1bef067c74152d0f4435f92f0f166d031182f07
+  data.tar.gz: 92cdb44671b44ba5eff6312bfb2212cc6f15bc0d73d0cc9608c135e41ec4ee8ec68ccd486684b075fe03767918da2135e190bc9b018ef36ed93e9416713e2303

data/CHANGELOG.md

@@ -1,6 +1,37 @@
 # Changes (Release notes)
 
+* 4.24.0
+
+  * New Features:
+    * `aoc`: Option `package_folder` allows specification of secondary field.
+    * `config`: New option `invalid_characters` ensures generated file names are valid.
+    * `config`: Added support for **dot-separated** option names, allowing nested hash structures to be specified directly on the command line.
+    * `console`: Added support for extended filters in transfer queries.
+    * `http_options`: New field `ssl_options` allows setting SSL Context options.
+    * `format`: `csv` format now supports option `table_style` for customizable output.
+    * `logger`: New option: `log_format` to control log formatting.
+    * `sync`: New command: `db` for operations on sync database.
+    * `sync`: Sync operations now use options `ts` and `to_folder`.
+  * Issues Fixed:
+    * JRuby: Modified tests and documentation for special SSH options.
+    * `transferd`: Fixed discrepancies in transfer spec resume policies.
+    * `desktop`: Fixed discrepancies in transfer spec resume policies.
+    * `format`: Value of type `list` now properly display column headers.
+    * `select`: Filter is now done on values before enhanced display in table mode.
+    * `aoc`: #221 Fixed package encryption at rest (CSEAR) status.
+  * Breaking Changes:
+    * `config`: Option `silent_insecure` renamed `warn_insecure`. `yes` shows warning (default).
+    * `ts` : Default transfer spec includes `resume_policy=sparse_csum`.
+    * `ssh_options` : Now additive option, like `ts`.
+    * `vault`: When creating an entry, the `label` field is now part of the creation Hash.
+    * `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.
+    * `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 2025-08-11
+
   * New Features:
     * `aoc`: #201: Added `package_folder` option to place each received package in its own subfolder named after a package attribute. Default is `@none:` which means no subfolder will be created.
     * `config`: Added `transferd` version 1.1.6.
@@ -182,7 +213,7 @@
     * `faspex5`: When receiving ALL packages, only get those with status `completed`.
     * `direct` agent: Better support for WSS
   * Breaking Changes:
-    * `shares`: Option `type` for users and groups is replaced with mandatory positional argument with same value.
+    * `shares`: Option `type` for users and groups is replaced with mandatory positional argument with same value. E.g. `user list --type=local` becomes: `user local list`.
     * `aoc`, `faspex`: Package `recv` command changed to `receive`, for consistency with faspex5 (`recv` is now an alias command)
 
 * 4.15.0 2023-11-18

data/CONTRIBUTING.md

@@ -2,62 +2,99 @@
 <!-- cspell:words passin -->
 ## Reporting Issues and Vulnerabilities
 
-You can report issues at <https://github.com/IBM/aspera-cli/issues>
+If you encounter a problem or vulnerability, please report it at [GitHub Issues](https://github.com/IBM/aspera-cli/issues).
 
-Before you go ahead please search existing issues for your problem.
+Before submitting a new issue:
 
-To make sure that we can help you quickly please include and check the following information:
+- Search existing issues to see if your problem has already been reported or resolved.
 
-- Include the `ascli` version you are running in your report.
-- If you are not running the latest version (please check) then update.
-- Include your `ruby -e "puts RUBY_DESCRIPTION"`.
+To help us assist you efficiently, include the following in your report:
 
-Thanks!
+- The version of ascli you are using:
+
+  ```bash
+  ascli version
+  ```
+
+- Confirmation that you're using the latest version (update if not).
+- The output of your Ruby environment:
+
+  ```bash
+  ruby -e "puts RUBY_DESCRIPTION"
+  ```
 
 ## Making Contributions
 
-To fetch and test the gem for development, do:
+We welcome contributions to improve the aspera-cli project!
+
+### Getting Started
+
+Clone the repository and navigate to the project folder:
 
 ```bash
 git clone https://github.com/IBM/aspera-cli.git
 cd aspera-cli
 ```
 
-Then see [Running Tests](#running-tests).
+For testing instructions, refer to [Running Tests](#running-tests).
 
-If you want to contribute, please:
+### How to Contribute
 
-- Fork the project.
-- Make your feature addition or bug fix.
-- Add tests for it. This is important, so it doesn't break in a future version unintentionally.
-- Run `rubocop` to comply for coding standards
-- Update `CHANGELOG.md`
-- Send a pull request on GitHub.
+To submit a contribution:
 
-## Architecture
+1. **Fork** the repository on GitHub.
 
-A list of classes are provided in <docs/uml.png>
+1. **Create a feature branch** for your changes.
+
+1. **Implement** your feature or bug fix.
+
+1. **Write tests** to ensure your changes are robust and won’t break future versions.
+
+1. Run `rubocop` to ensure your code follows the Ruby style guide.
+
+1. Update `CHANGELOG.md` with a summary of your changes.
+
+1. Submit a **pull request** with a clear description of your contribution.
+
+> [!TIP]
+> Make sure your pull request is focused and includes only relevant changes.
+
+## Architecture
 
-Architecture:
+The overall architecture of aspera-cli is modular and extensible.
 
 ![Architecture](docs/architecture.png)
 
-The entry point is: `lib/aspera/cli/main.rb`.
+Structure Highlights:
 
-Plugins are located in: `lib/aspera/cli/plugins`.
+- Entry Point:
 
-Transfer agents, in: `lib/aspera/agent`.
+  `lib/aspera/cli/main.rb` - This is where the CLI execution begins.
+
+- Plugins:
+
+  Located in `lib/aspera/cli/plugins`, plugins extend CLI functionality and encapsulate specific features.
+
+- Transfer Agents:
+
+  Found in `lib/aspera/agent`, these handle data transfers operations.
+
+A list of classes are provided in <docs/uml.png>
 
 ## Ruby version
 
-Install Ruby using your preferred method.
+`aspera-cli` is built with Ruby.
+You can install Ruby using any method you prefer (e.g., rbenv, rvm, system package manager).
 
-To clean up installed gems to start fresh:
+To start with a clean slate and remove all installed gems:
 
 ```bash
 make clean_gems
 ```
 
+> [!TIP]
+> This is especially useful before testing across different Ruby versions or preparing for a release.
+
 ## Tool chain
 
 TODO: document installation of tool chain.
@@ -66,20 +103,24 @@ Build system uses GNU Make.
 
 ### Environment
 
-A few macros/envvars control some aspects:
+A few macros/env vars control some aspects:
 
-| macro                       | description                          |
+| `make` macro or Env var     | Description                          |
 |-----------------------------|--------------------------------------|
 | `ASPERA_CLI_TEST_CONF_FILE` | Path to configuration file with secrets for tests |
 | `ASPERA_CLI_TEST_MACOS`     | Set to `true` if local HSTS running on macOS      |
 | `ASPERA_CLI_TEST_PRIVATE`   | Path to private folder               |
+| `ASPERA_CLI_DOC_CHECK_LINKS`| Check links still exist during doc generation.    |
+| `ASPERA_CLI_DOC_DEBUG`      | Enable debug in doc generation.      |
 | `ENABLE_COVERAGE`           | Tests with coverage analysis if set. |
 | `SIGNING_KEY`               | Path to signing key to build Gem.    |
 | `GEM_VERSION`               | Gem version to build container       |
 
 Those macros can be set either in an env var, or on the `make` command line.
 
-> **Note:** vars `ASPERA_CLI_TEST_` are typically set in user's shell profile.
+> [!NOTE]
+> Env vars `ASPERA_CLI_TEST_*` are typically set in user's shell profile for development.
+> Others are more for "one shot" use.
 
 To use the CLI directly from the development environment, add this to your shell profile:
 
@@ -108,6 +149,10 @@ tlmgr update --self
 tlmgr install fvextra selnolig lualatex-math
 ```
 
+To check URL during doc generation, set env var: `ASPERA_CLI_DOC_CHECK_LINKS=1`.
+
+To debug doc generation, set env var: `ASPERA_CLI_DOC_DEBUG=debug`.
+
 ## Running Tests
 
 First, a testing configuration file must be created.
@@ -120,13 +165,13 @@ cp docs/test_env.conf ~/some_secure_folder/.
 
 Fill `~/some_secure_folder/test_env.conf` with system URLs and credentials for tests.
 
-Then tell where this file is located:
+Then, tell where this file is located:
 
 ```bash
 export ASPERA_CLI_TEST_CONF_FILE=~/some_secure_folder/test_env.conf
 ```
 
-This project uses a `Makefile` for tests:
+This project uses a `Makefile` for tests, in main folder:
 
 ```bash
 make test
@@ -134,6 +179,18 @@ make test
 
 When new commands are added to the CLI, new tests shall be added to the test suite in `tests/Makefile`.
 
+One can also go to the `tests` folder:
+
+```bash
+cd tests
+make
+make full
+make list
+make torc
+make skip_torc
+make skip T=orch_wizard
+```
+
 ### Special tests
 
 Some gems are optional: `rmagick` and `grpc`, as they require compilation of native code which may cause problems.