aspera-cli 4.13.0 → 4.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86109a9ac1ef2f30ea4fd192b5535367d72ca679bcf588f86452289cf451dc72
-  data.tar.gz: 94d5d460d4ed2ab49637119711f03e81f2ab1793e75f8f6c5da098c8d93c26dc
+  metadata.gz: 007b7653b79d11d35c5741fe091d6118204b25521a3ad30082e2c1970124d91a
+  data.tar.gz: a7b763b7f993f414d0ec78b79eeb1607dcb1618697bb4360f05fb39ad159443c
 SHA512:
-  metadata.gz: '05729a6bcf5db7f2831883e2da68c2fc3e3cc542ea3fb7969a5095b87d094b0cc98845ac73f300865f358ff70751cdbde4cab16dc10349076168e5266c62a98a'
-  data.tar.gz: 7ebdeaaf9a8408137f7057665f0b8e12f6314f2328cd235be78cfd531df9ffa422f0574331d3fed2436fd3e97f3aff452c9ce778dc06112fc012f6e48b5adaf8
+  metadata.gz: 176ba1755a5e545b2886b311e7be53c33983c3a8eaf75846801d83dd9dfc498bfd5e44cf0f65c51267374309e1f4ffa2657a793fc659622a9a9ba41d94b71344
+  data.tar.gz: 1e0f022813ba1b6e7cdb90a632811193689ac69175d9eac65a0589128c5d12181f283beb1a973109d9d1768ab770535be77aa9c37220363c8d0090b9139c8196

data/CHANGELOG.md

@@ -1,5 +1,79 @@
 # Changes (Release notes)
 
+* 4.15.0
+
+  * General: removed many redundant options, more consistency between plugins, see below in "break".
+  * New Features:
+    * global: added resolution hints for well known issues.
+    * global: extended value expression `@extend:` finds and replace extended values in a string (e.g. for JSON)
+    * global: option `fields` now supports `RegExp`
+    * global: option `home` to set the main folder for configuration and cache
+    * global: option `ignore_certificate` to specify specific URLs instead of global option `insecure`
+    * global: option `cert_stores` to specify alternate certificate stores
+    * global: uniform progress bar for any type of transfer.
+    * global: add extended value types: `re` and `yaml`
+    * global: option `pid_file` to write tool's PID during execution, deleted on exit
+    * config: command `remote_certificate` to retrieve a remote certificate
+    * config: added logger level `trace1` and `trace2`
+    * wizard: can detect multiple applications at the same address or url.
+    * aoc: wizard accepts public links
+    * aoc: support private links, and possibility to list shared folder with workspace `@json:null`
+    * orchestrator: error analysis for workflow start
+    * httpgw: now supports pseudo file for testing: e.g. `faux:///testfile?1k`
+    * node: added command `transfer sessions` to list all sessions of all transfers
+    * node: generate bearer token from private key and user information
+    * node: access node API with bearer token as credentials
+    * agent: `direct` allows ignoring certificate for wss using http options
+    * preview: command `show` generates a preview and displays it in terminal
+  * Issues Fixed:
+    * Ruby warning: `net/protocol.rb:68: warning: already initialized constant Net::ProtocRetryError` solved by removing dependency on `net-smtp` from gem spec (already in base ruby).
+  * Breaking Changes:
+    * global: commands `detect` and `wizard` takes now a mandatory argument: address or url instead of option `url`.
+    * global: renamed option `pkeypath` to `key_path`
+    * 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: 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`
+    * faspex: remote source selection now uses percent selector instead of parameter `id` or `name`
+    * faspex: option `source_name` is now `remote_source`
+    * aoc: selection by name uses percent selector instead of option or parameter `name`
+    * aoc: removed option `link`: use `url` instead
+    * aoc: in command `short_link`, place type before command, e.g. `short_link private create /blah`
+    * aoc: replaced option `operation` with mandatory positional parameter for command `files transfer`
+    * aoc: replaced option `from_folder` with mandatory positional parameter for command `files transfer`
+    * orchestrator: workflow start takes arguments as optional positional extended value instead of option `param`
+    * node: `find` command now takes an optional `@ruby:` extended value instead of option `query` with prefix: `exec:`
+    * sync: plugin `sync` is removed: actions are available through `server` and `node` plugins.
+    * sync: replaced option `sync_session` with optional positional parameter.
+    * preview: command `scan`, `events` and `trevents` replaced option `query` with optional positional parameter for filter (like `find`).
+    * trsdk: parameters `host` and `port` in option `transfer_info` are replaced with parameter `url`, like `grpc://host:port`
+
+* 4.14.0
+
+  * new: server: option `passphrase` for simpler command line (#114)
+  * new: percent selector for entities identifier
+  * new: faspex5: shared inbox and workgroup membership management
+  * new: faspex5: invite external user to shared inbox
+  * new: faspex5: package list and receive from workgroup and shared inbox
+  * new: config: Command `ascp info` shows default transfer spec.
+  * new: httpgw: synchronous and asynchronous upload modes
+  * new: node: command `bandwidth_average` to get average bandwidth of node, per periods
+  * fix: option `ts`: deep add and remove of keys. (#117)
+  * fix: faspex5: user lookup for `packages send` shall be exact match (#120)
+  * fix: direct: if transfer spec contains "paths" and elements with "destination", but first element has only "source", then destinations were ignored. Now "destination" all or none is enforced.
+  * change: using `aoc files` or node gen4 operations (`browse`, `delete`) on a link will follow the link only if path ends with /
+  * change: shares: command `repository` is changed to `files` for consistency with aoc and upcoming faspex5, but is still available as alias
+  * change: aoc: better handling of shared links
+  * change: global: option `value` is deprecated. Use positional parameter for creation data and option `query` for list/delete operations.
+  * change: config: remove deprecated command: `export_to_cli`
+  * change: config: removed all legacy preset command, newer command `preset` shall be used now.
+  * change: config: SDK is now installed in $HOME/.aspera/sdk instead of $HOME/.aspera/ascli/sdk
+  * change(break): aoc/node: Simplification: gen4 operations: show modify permission thumbnail are now directly under node gen 4 command. Command `file` is suppressed. Option `path` is suppressed. The default expected argument is a path. To provide a file id, use selector syntax: %id:_file_id_
+  * change(break): node: option `token_type` is removed, as starting with HSTS 4.3 basic token is only allowed with access keys, so use gen4 operations: `acc do self`
+
 * 4.13.0
 
   * new: preview: option `reencode_ffmpeg` allows overriding all re-encoding options
@@ -70,7 +144,7 @@
   * new: improved documentation on faspex and aoc package send
   * fix: `node do` command fixed
   * fix: improved secret hiding from logs
-  * change(break): removed rarely commands nodeadmin, configuration, userdata, ctl from plugin `server`
+  * change(break): removed rarely commands `nodeadmin`, `configuration`, `userdata`, `ctl` from plugin `server`
     as well as option `cmd_prefix`
   * change: `ascli` runs as user `cliuser` instead of `root` in container
   * change: default access right for config folder is now user only, including private keys
@@ -189,9 +263,9 @@
   * new: agent `http_gw` now supports upload
   * new: added option `sdk_url` to install SDK from local file for offline install
   * new: check new gem version periodically
-  * new: the --fields= option, support -_fieldname_ to remove a field from default fields
+  * new: the --fields= option, support -_field_name_ to remove a field from default fields
   * new: Oauth tokens are discarded automatically after 30 minutes (useful for COS delegated refresh tokens)
-  * new: mimemagic is now optional, needs manual install for `preview`, compatible with version 0.4.x
+  * new: `mimemagic` is now optional, needs manual install for `preview`, compatible with version 0.4.x
   * new: AoC a password can be provided for a public link
   * new: `conf doc` take an optional parameter to go to a section
   * new: initial support for Faspex 5 Beta 1
@@ -209,7 +283,7 @@
 
 * 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 a X server (previously using `Xvfb`)
 
 * 0.11.7
 
@@ -330,7 +404,7 @@
 * 0.10.4
 
   * new options for AoC : `secrets`
-  * ACLI-533 temp file list folder to use file lists is set by default, and used by `asession`
+  * `ACLI-533` temp file list folder to use file lists is set by default, and used by `asession`
 
 * 0.10.3
 
@@ -370,13 +444,13 @@
 
   * new command to display basic token of node
   * new command to display bearer token of node in AoC
-  * the --fields= option, support +_fieldname_ to add a field to default fields
+  * the --fields= option, support +_field_name_ to add a field to default fields
   * many small changes
 
 * 0.9.32
 
   * all Faspex public links are now supported
-  * removed faspex operation recv_publink
+  * removed faspex operation `recv_publink`
   * replaced with option `link` (consistent with AoC)
 
 * 0.9.31

data/CONTRIBUTING.md

@@ -1,5 +1,5 @@
 # Contributing
-
+<!-- cspell:words passin -->
 ## Reporting Issues and Vulnerabilities
 
 You can report issues at <https://github.com/IBM/aspera-cli/issues>
@@ -32,7 +32,7 @@ If you want to contribute, please:
 - Add tests for it. This is important so I don't break it in a future version unintentionally.
 - **Bonus Points** go out to anyone who also updates `CHANGELOG.md` :)
 - Send a pull request on GitHub.
-- run Rubocop to comply for coding standards
+- run `rubocop` to comply for coding standards
 
 ## Architecture
 
@@ -192,11 +192,11 @@ make dpush
 
 ### Specific version image build
 
-It is possible to build a specific version by setting envvar `GEMVERS` and `make` with option `-e`:
+It is possible to build a specific version by setting envvar `GEM_VERSION` and `make` with option `-e`:
 
 ```bash
-GEMVERS=4.11.0 make -e docker
-GEMVERS=4.11.0 make -e dpush
+GEM_VERSION=4.11.0 make -e docker
+GEM_VERSION=4.11.0 make -e dpush
 ```
 
 ### Development version image build
@@ -209,10 +209,26 @@ make dockerbeta
 make dpushversion
 ```
 
+## Single executable build
+
+It is possible to build `ascli` as a single native executable using `rubyc` (gem `ruby-packer`).
+
+```bash
+make single
+```
+
+This is based on tool `rubyc` (gem `ruby-packer`): either place the executable in folder `tmp`, or the architecture-specific version will be automatically downloaded.
+
+> **Note:** Perl `Findbin` is needed, install on Linux with:
+
+```bash
+sudo dnf install -y perl perl-FindBin perl-IPC-Cmd
+```
+
 ## Long Term Implementation and delivery improvements
 
 - replace rest and oauth classes with ruby standard gems:
   - <https://github.com/rest-client/rest-client>
   - <https://github.com/oauth-xx/oauth2>
 - use gem Thor <http://whatisthor.com/> (or other standard Ruby CLI manager)
-- Package a single-file executable for various architectures with <https://github.com/pmq20/ruby-packer> (rubyc)
+- Package a single-file executable for various architectures with <https://github.com/pmq20/ruby-packer> (`rubyc`)