aspera-cli 4.11.0 → 4.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08292755646ee9ced95363ddb7b109cec20c3826a72d8df12e54cabc9cfab2dd'
-  data.tar.gz: 881782cb6655d6be4783ae34761bb44ffc84cb6972e223ec7cdde8020de6af1d
+  metadata.gz: e7b048647bb937cbea1f3bd8ef7e010c18b97456aa00b45ad8be45656472ae9f
+  data.tar.gz: c0f02324d8916a1ca5247a313da624e8365a57c438aefc58cc1301fd5ca5e0ff
 SHA512:
-  metadata.gz: d222717fdc4632b1d423b4df6479714135469ba2d5ddaa6fb6cac185eeba8f9d96db4adf4484872224c3c5b4e7afe5dcc48d7365e0933954d1eadc80b9951b6b
-  data.tar.gz: ca5b15ae38a0bd0841e5cb1aba74f75de99954d8ee09b8f86b0109bc11e58d4e54862b9c52afdca6da54808be17c6a778ae7000f8d2e6c8947a74eb66aac74a0
+  metadata.gz: fca3097df5295eaf1f3fa67efe04c7d1226c5c050d01f3e3c7319210967addfa01d98fd7a7b67024cae0a085f56b0357cf4b9b7ee4eb7aedd027b7996dc59356
+  data.tar.gz: c45dc8053b73c26b7f0eaac877d35118aad007974ae61cb6b3e19aac373e8713f682513161e1af5250263bf461a03aa71846e4149fed411e81c771a2943c8e57

data/BUGS.md

@@ -11,7 +11,6 @@ Please, make sure to include the following information:
 
 [Use Github (Public Issue Reporting)](https://github.com/IBM/aspera-cli/issues)
 
-
 ## Security Policy
 
 | Version | Supported          |

data/CHANGELOG.md

@@ -1,19 +1,38 @@
 # Changes (Release notes)
 
+* 4.12.0
+
+  * new: docker: build image from official gem version, possibility to deploy beta as well
+  * new: generic: `delete` operation supports option `value` for deletion parameters
+  * new: aoc: command `aoc packages recv` accepts option `query` to specify a shared inbox
+  * new: faspex: (v4) user delete accepts option `value` with value `{"destroy":true}` to delete users permanently
+  * new: faspex: (v4) gateway to faspex 5 for package send
+  * new: faspex5: possibility to change email templates
+  * new: faspex5: shared folder list and browse
+  * new: faspex5: emulate faspex 4 postprocessing, plugin: `faspex5` command: `postprocessing`
+  * new: faspex5: send package from remote source
+  * new: shares: option `type` for command `shares admin user`
+  * new: shares: full support for shares admin operations
+  * change(break): shares: command `shares admin user saml_import` replaced with `shares admin user import --type=saml`
+  * change(break): shares: command `shares admin user ldap_import` replaced with `shares admin user add --type=ldap`
+  * change(break): shares: command `app_authorizations` now has sub commands `show` and `modify`
+  * change(break): shares: similar changes for `shares admin share user show`
+  * change(break): option `ascp_opts` is removed, and replaced with `transfer_info` parameter `ascp_args`
+
 * 4.11.0
 
   * new: vault: secret finder, migration from config file
-  * new: allow removal of transferspec parameter by setting value to `null`
+  * new: allow removal of transfer spec parameter by setting value to `null`
   * new: option `ascp_opts` allows to provide native `ascp` options on command line
   * new: command `sync` added to `node` (gen4) and `server` plugins, also available in `aoc`
   * fix: security: no shell interpolation
   * fix: when WSS and node agent: no localhost (certificate)
   * fix: #99 `aoc file download` for single shared folder
-  * fix: due to change of API in faspex 5 for send pakage (paths is mandatory for any type of transfer now)
+  * fix: due to change of API in faspex 5 for send package (paths is mandatory for any type of transfer now)
   * fix: Oauth web authentication was broken, fixed now
-  * change: (break) container image has entry point
-  * change: (break) `aoc admin res node` commands `v3` and `v4` replaced with `do` and command `v3` moved inside `do`
-  * change: (break) renamed options for `sync`
+  * change(break): container image has entry point
+  * change(break): `aoc admin res node` commands `v3` and `v4` replaced with `do` and command `v3` moved inside `do`
+  * change(break): renamed options for `sync`
   * change: node gen4 operations are moved from aoc plugin to node plugin but made available where gen4 is used
   * change: if wss is enabled on server, use wss
   * lots of cleanup and refactoring
@@ -34,7 +53,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
@@ -46,10 +65,10 @@
   * new: add command `user profile` in `faspex5`
   * new: add config wizard for `faspex5`
   * new: #75 gem is signed
-  * change: (break) removed dependency on gem `grpc` which is used only for the `trsdk` transfer agent. Users can install the gem manually if needed.
-  * change: (break) hash vault keys are string instead of symbol
-  * change: cleanup with rubocop, all strings are immutable now by default, list contants are frozen
-  * change: removed Hash.dig implemetation because it is by default in Ruby >= 2.3
+  * change(break): removed dependency on gem `grpc` which is used only for the `trsdk` transfer agent. Users can install the gem manually if needed.
+  * change(break): hash vault keys are string instead of symbol
+  * change: cleanup with rubocop, all strings are immutable now by default, list constants are frozen
+  * change: removed Hash.dig implementation because it is by default in Ruby >= 2.3
   * change: default is now to hide secrets on command output. Set option `show_secrets` to reveal secrets.
   * change: option `insecure` displays a warning
 
@@ -62,11 +81,11 @@
   * new: added and updated commands for Faspex 5
   * new: option `cache_tokens`
   * new: Faspex4 dropbox packages can now be received by id
-  * change: (break) command `conf gem path` replaces `conf gem_path`
-  * change: (break) option `fpac` expects a value instead of URL
-  * change: (break) option `cipher` in transfer spec must have hyphen
-  * change: (break) renamed option `log_passwords` to `log_secrets`
-  * change: (break) removed plugin `shares2` as products is now EOL
+  * change(break): command `conf gem path` replaces `conf gem_path`
+  * change(break): option `fpac` expects a value instead of URL
+  * change(break): option `cipher` in transfer spec must have hyphen
+  * change(break): renamed option `log_passwords` to `log_secrets`
+  * change(break): removed plugin `shares2` as products is now EOL
   * fix: After AoC version update, wizard did not detect AoC properly
 
 * 4.6.0
@@ -75,12 +94,12 @@
   * new: global option `plugin_folder`
   * new: global option `transpose_single`
   * new: simplified metadata passing for shared inbox package creation in AoC
-  * change: (break) command `aoc packages shared_inboxes list` replaces `aoc user shared_inboxes`
-  * change: (break) command `aoc user profile` replaces `aoc user info`
-  * change: (break) command `aoc user workspaces list` replaces `aoc user workspaces`
-  * change: (break) command `aoc user workspaces current` replaces `aoc workspace`
-  * change: (break) command `conf plugin list` replaces `conf plugins`
-  * change: (break) command `conf connect` simplified
+  * change(break): command `aoc packages shared_inboxes list` replaces `aoc user shared_inboxes`
+  * change(break): command `aoc user profile` replaces `aoc user info`
+  * change(break): command `aoc user workspaces list` replaces `aoc user workspaces`
+  * change(break): command `aoc user workspaces current` replaces `aoc workspace`
+  * change(break): command `conf plugin list` replaces `conf plugins`
+  * change(break): command `conf connect` simplified
   * fix: #60 ascli executable was not installed by default in 4.5.0
   * fix: add password hiding case in logs
 
@@ -94,9 +113,9 @@
   * new: identifier can be provided using either option `id` or directly after the command, e.g. `delete 123` is the same as `delete --id=123`
   * change: when using wss, use [ruby's CA certs](README.md#certificates)
   * change: unexpected parameter makes exit code not zero
-  * change: (break) options `id` and `name` cannot be specified at the same time anymore, use [positional identifer or name selection](README.md#res_select)
-  * change: (break) `aoc admin res node` does not take workspace main node as default node if no `id` specified.
-  * change: (break): `orchestrator workflow status` requires id, and supports special id `ALL`
+  * change(break): options `id` and `name` cannot be specified at the same time anymore, use [positional identifier or name selection](README.md#res_select)
+  * change(break): `aoc admin res node` does not take workspace main node as default node if no `id` specified.
+  * change(break): : `orchestrator workflow status` requires id, and supports special id `ALL`
   * fix: various smaller fixes and renaming of some internal classes (transfer agents and few other)
 
 * 4.4.0
@@ -107,7 +126,7 @@
   * new: `node` plugin accepts bearer token and access key as credential
   * new: `node` option `token_type` allows using basic token in addition to aspera type.
   * change: `server`: option `username` not mandatory anymore: xfer user is by default. If transfer spec token is provided, password or keys are optional, and bypass keys are used by default.
-  * change: (break) resource `apps_new` of `aoc` replaced with `application` (more clear)
+  * change(break): resource `apps_new` of `aoc` replaced with `application` (more clear)
 
 * 4.3.0
 
@@ -121,10 +140,10 @@
   * new: the error "Remote host is not who we expected" displays a special remediation message
   * new: `conf ascp spec` displays supported transfer spec
   * new: options `notif_to` and `notif_template` to send email notifications on transfer (and other events)
-  * fix: space character in `faspe:` url are precent encoded if needed
+  * fix: space character in `faspe:` url are percent encoded if needed
   * fix: `preview scan`: if file_id is unknown, ignore and continue scan
   * change: for commands that potentially execute several transfers (`package recv --id=ALL`), if one transfer fails then ascli exits with code 1 (instead of zero=success)
-  * change: (break) option `notify` or `aoc` replaced with `notif_to` and `notif_template`
+  * change(break): option `notify` or `aoc` replaced with `notif_to` and `notif_template`
 
 * 4.2.1
 
@@ -141,8 +160,8 @@
   * fix: (break) multi_session_threshold is Integer, not String
   * fix: `conf ascp install` renames sdk folder if it already exists (leftover shared lib may make fail)
   * fix: removed replace_illegal_chars from default aspera.conf causing "Error creating illegal char conversion table"
-  * change: (break) `aoc apiinfo` is removed, use `aoc servers` to provide the list of cloud systems
-  * change: (break) parameters for resume in `transfer-info` for [`direct`](README.md#agt_direct) are now in sub-key `"resume"`
+  * change(break): `aoc apiinfo` is removed, use `aoc servers` to provide the list of cloud systems
+  * change(break): parameters for resume in `transfer-info` for [`direct`](README.md#agt_direct) are now in sub-key `"resume"`
 
 * 4.1.0
 
@@ -173,7 +192,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
 
@@ -294,7 +313,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
 
@@ -383,7 +402,7 @@
 * 0.9.20
 
   * improved wizard (prepare for AoC global client id)
-  * preview generator: addedoption : --skip-format=<png,mp4>
+  * preview generator: added option : --skip-format=<png,mp4>
   * removed outdated pictures from this doc
 
 * 0.9.19
@@ -411,19 +430,19 @@
 
 * 0.9.11
 
-  * Breaking change: @stdin is now @stdin:
+  * change(break): @stdin is now @stdin:
   * support of ATS for IBM Cloud, removed old version based on aspera id
 
 * 0.9.10
 
-  * Breaking change: parameter transfer-node becomes more generic: transfer-info
+  * change(break): parameter transfer-node becomes more generic: transfer-info
   * Display SaaS storage usage with command: aspera admin res node --id=nn info
   * cleaner way of specifying source file list for transfers
-  * Breaking change: replaced download_mode option with http_download action
+  * change(break): replaced download_mode option with http_download action
 
 * 0.9.9
 
-  * Breaking change: "aspera package send" parameter deprecated, use the --value option instead with "recipients" value. See example.
+  * change(break): "aspera package send" parameter deprecated, use the --value option instead with "recipients" value. See example.
   * Now supports "cargo" for Aspera on Cloud (automatic package download)
 
 * 0.9.8
@@ -441,7 +460,7 @@
 
 * 0.9.6
 
-  * Breaking change: `@param:`is now `@preset:` and is generic
+  * change(break): `@param:`is now `@preset:` and is generic
   * AoC: added command to display current workspace information
 
 * 0.9.5
@@ -451,7 +470,7 @@
 
 * 0.9.4
 
-  * Breaking change: 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).
+  * change(break): 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).
   * AoC Package send supports external users
   * new command to export AoC config to Aspera CLI config
 
@@ -462,15 +481,15 @@
   * modified transfer interface and allow token re-generation on error
   * async add admin command
   * async add db parameters
-  * Breaking change: new option "sources" to specify files to transfer
+  * change(break): new option "sources" to specify files to transfer
 
 * 0.9.2
 
-  * Breaking change: changed AoC package creation to match API, see AoC section
+  * change(break): changed AoC package creation to match API, see AoC section
 
 * 0.9.1
 
-  * Breaking change: changed faspex package creation to match API, see Faspex section
+  * change(break): changed faspex package creation to match API, see Faspex section
 
 * 0.9
 
@@ -483,22 +502,22 @@
 
 * 0.7
 
-  * Breaking change: AoC package recv take option if for package instead of argument.
-  * Breaking change: Rest class and Oauth class changed init parameters
+  * change(break): AoC package recv take option if for package instead of argument.
+  * change(break): Rest class and Oauth class changed init parameters
   * AoC: receive package from public link
   * select by col value on output
   * added rename (AoC, node)
 
 * 0.6.19
 
-  * change: (break) ats server list provisioned → ats cluster list
-  * change: (break) ats server list clouds → ats cluster clouds
-  * change: (break) ats server list instance --cloud=x --region=y → ats cluster show --cloud=x --region=y
-  * change: (break) ats server id xxx → ats cluster show --id=xxx
-  * change: (break) ats subscriptions → ats credential subscriptions
-  * change: (break) ats api_key repository list → ats credential cache list
-  * change: (break) ats api_key list → ats credential list
-  * change: (break) ats access_key id xxx → ats access_key --id=xxx
+  * change(break): ats server list provisioned → ats cluster list
+  * change(break): ats server list clouds → ats cluster clouds
+  * change(break): ats server list instance --cloud=x --region=y → ats cluster show --cloud=x --region=y
+  * change(break): ats server id xxx → ats cluster show --id=xxx
+  * change(break): ats subscriptions → ats credential subscriptions
+  * change(break): ats api_key repository list → ats credential cache list
+  * change(break): ats api_key list → ats credential list
+  * change(break): ats access_key id xxx → ats access_key --id=xxx
 
 * 0.6.18
 
@@ -506,4 +525,4 @@
 
 * 0.6.15
 
-  * Breaking change: "files" application renamed to "aspera" (for "Aspera on Cloud"). "repository" renamed to "files". Default is automatically reset, e.g. in config files and change key "files" to "aspera" in preset "default".
+  * change(break): "files" application renamed to "aspera" (for "Aspera on Cloud"). "repository" renamed to "files". Default is automatically reset, e.g. in config files and change key "files" to "aspera" in preset "default".

data/CONTRIBUTING.md

@@ -8,7 +8,7 @@ Before you go ahead please search existing issues for your problem.
 
 To make sure that we can help you quickly please include and check the following information:
 
-- Include the ascli version you are running in your report.
+- Include the `ascli` version you are running in your report.
 - If you are not running the latest version (please check), update.
 - Include your `ruby -e "puts RUBY_DESCRIPTION"`.
 
@@ -101,13 +101,38 @@ gem install -P HighSecurity aspera-cli
 
 ## Docker image build
 
-### on MacOS using ubuntu multipass
+The default docker image build installs the official gem version directly from <rubygems.org>.
 
-Install [multipass](https://multipass.run/docs) with [brew](https://multipass.run/docs/installing-on-macos#heading--use-brew):
+By default it will build the image for the version in the current repository:
 
-[Initialize the docker environment](https://multipass.run/docs/docker-tutorial).
+```bash
+make docker
+```
+
+> **Note:** This target creates the `Dockerfile` from an `ERB` (embedded Ruby) template (Makefile target `dockerfile`).
+A template is used as it allows some level of customization to tell where to take the gem from, as as for the SDK file.
+
+Then, to push to the image registry:
+
+```bash
+make dpush
+```
+
+It is possible to build a specific version by setting envvar `GEMVERS` and `make` with option `-e`:
+
+```bash
+GEMVERS=4.11.0 make -e docker
+GEMVERS=4.11.0 make -e dpush
+```
+
+To build/push a beta/development container:
+
+```bash
+make dockerbeta
+make dpushversion
+```
 
-Make sure the ubuntu user in container is part of the docker group.
+The Dockerfile template allows customizing the optional copy of gem file , versus install from rubygems,org as well as customizing the retrieval of the SDK.
 
 ## Long Term Implementation and delivery improvements
 
@@ -115,4 +140,4 @@ Make sure the ubuntu user in container is part of the docker group.
   - <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 with <https://github.com/pmq20/ruby-packer> (rubyc)
+- Package a single-file executable for various architectures with <https://github.com/pmq20/ruby-packer> (rubyc)