aspera-cli 4.9.0 → 4.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3e2f918183f0c2eb62309f27271244bfc81ed1c931cfc9d0779e4ed9817fdd6
-  data.tar.gz: cfb19c8d6d746b4fcdea4e2c886ab6a4d8a77fc7c8c0e331909af57f53e697a6
+  metadata.gz: '08292755646ee9ced95363ddb7b109cec20c3826a72d8df12e54cabc9cfab2dd'
+  data.tar.gz: 881782cb6655d6be4783ae34761bb44ffc84cb6972e223ec7cdde8020de6af1d
 SHA512:
-  metadata.gz: 2e31f4ef2df4c1e3fb4856c67431640bbfe0d5ade15c67dfa99dda63e6fb5f453344392e1a071ab26eb8d7167d3d244a7d98a2c33e2f9f3a6b517b4b910c4929
-  data.tar.gz: 9d5e53ac4513a8722cf46953524641f038697cd7c9a1f607e54e67df13275dc438ec33564486f866eb6adedd680b2404660df846e5524202e4a71b40c3072524
+  metadata.gz: d222717fdc4632b1d423b4df6479714135469ba2d5ddaa6fb6cac185eeba8f9d96db4adf4484872224c3c5b4e7afe5dcc48d7365e0933954d1eadc80b9951b6b
+  data.tar.gz: ca5b15ae38a0bd0841e5cb1aba74f75de99954d8ee09b8f86b0109bc11e58d4e54862b9c52afdca6da54808be17c6a778ae7000f8d2e6c8947a74eb66aac74a0

data/BUGS.md

@@ -0,0 +1,20 @@
+# Reporting bugs and security vulnerabilities
+
+Report bug, including vulnerability issues following this:
+
+Please, make sure to include the following information:
+
+* aspera-cli version number.
+* Operating system name/version (uname -a if Unix)
+* relevant section of output of error with option --log-level=debug
+* Any other relevant information.
+
+[Use Github (Public Issue Reporting)](https://github.com/IBM/aspera-cli/issues)
+
+
+## Security Policy
+
+| Version | Supported          |
+| ------- | ------------------ |
+| >= 4.0  | :white_check_mark: |
+| < 4.0   | :x:                |

data/CHANGELOG.md

@@ -0,0 +1,509 @@
+# Changes (Release notes)
+
+* 4.11.0
+
+  * new: vault: secret finder, migration from config file
+  * new: allow removal of transferspec 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: 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: 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
+
+* 4.10.0
+
+  * new: httpgw transfer agent: support api v2, support transfer through http proxy, including proxy password
+  * new: faspex5: get bearer token
+  * updates: for docker container version
+  * break: option `secrets` is renamed to `vault`
+
+* 4.9.0
+
+  * new: shares: import of SAML users and LDAP users
+  * new: M1 apple silicon support SDK install (uses x86 ascp)
+  * new: support bulk operation more globally (create/delete), not all ops , though
+  * new: added missing transfer spec parameters, e.g. `src_base`, `password`
+  * 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`
+    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
+
+* 4.8.0
+
+  * new: #76 add resource `group_membership` in `aoc`
+  * new: add resource `metadata_profile` in `faspex5`
+  * 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: default is now to hide secrets on command output. Set option `show_secrets` to reveal secrets.
+  * change: option `insecure` displays a warning
+
+* 4.7.0
+
+  * new: option to specify font used to generate image of text file in `preview`
+  * new: #66 improvement for content protection (support standard transfer spec options for direct agent)
+  * new: option `fpac` is now applicable to all ruby based HTTP connections, i.e. API calls
+  * new: option `show_secrets` to reveal secrets in command output
+  * 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
+  * fix: After AoC version update, wizard did not detect AoC properly
+
+* 4.6.0
+
+  * new: command `conf plugin create`
+  * 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
+  * fix: #60 ascli executable was not installed by default in 4.5.0
+  * fix: add password hiding case in logs
+
+* 4.5.0
+
+  * new: support transfer agent: [Transfer SDK](README.md#agt_trsdk)
+  * new: support [http socket options](README.md#http_options)
+  * new: logs hide passwords and secrets, option `log_passwords` to enable logging secrets
+  * new: `config vault` supports encrypted passwords, also macos keychain
+  * new: `config preset` command for consistency with id
+  * 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`
+  * fix: various smaller fixes and renaming of some internal classes (transfer agents and few other)
+
+* 4.4.0
+
+  * new: `aoc packages list` add possibility to add filter with option `query`
+  * new: `aoc admin res xxx list` now get all items by default #50
+  * new: `preset` option can specify name or hash value
+  * 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)
+
+* 4.3.0
+
+  * new: parameter `multi_incr_udp` for option `transfer_info`: control if UDP port is incremented when multi-session is used on [`direct`](README.md#agt_direct) transfer agent.
+  * new: command `aoc files node_info` to get node information for a given folder in the Files application of AoC. Allows cross-org or cross-workspace transfers.
+
+* 4.2.2
+
+  * new: `faspex package list` retrieves the whole list, not just first page
+  * new: support web based auth to aoc and faspex 5 using HTTPS, new dependency on gem `webrick`
+  * 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: `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`
+
+* 4.2.1
+
+  * new: command `faspex package recv` supports link of type: `faspe:`
+  * new: command `faspex package recv` supports option `recipient` to specify dropbox with leading `*`
+
+* 4.2.0
+
+  * new: command `aoc remind` to receive organization membership by email
+  * new: in `preview` option `value` to filter out on file name
+  * new: `initdemo` to initialize for demo server
+  * new: [`direct`](README.md#agt_direct) transfer agent options: `spawn_timeout_sec` and `spawn_delay_sec`
+  * fix: on Windows `conf ascp use` expects ascp.exe
+  * 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"`
+
+* 4.1.0
+
+  * fix: remove keys from transfer spec and command line when not needed
+  * fix: default to create_dir:true so that sending single file to a folder does not rename file if folder does not exist
+  * new: update documentation with regard to offline and docker installation
+  * new: renamed command `nagios_check` to `health`
+  * 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: 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: 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
+
+* 4.0.0
+
+  * now available as open source (github) with general cleanup
+  * changed default tool name from `mlia` to `ascli`
+  * changed `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`
+  * persistency files go to sub folder instead of main folder
+  * added possibility to install SDK: `config ascp install`
+
+* 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
+
+* 0.11.7
+
+  * rework on rest call error handling
+  * use option `display` with value `data` to remove out of extraneous information
+  * 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
+
+* 0.11.6
+
+  * orchestrator : added more choice in auth type
+  * preview: cleanup in generator (removed and renamed parameters)
+  * preview: better documentation
+  * preview: animated thumbnails for video (option: `video_png_conv=animated`)
+  * preview: new event trigger: `trevents` (`events` seems broken)
+  * preview: unique tmp folder to avoid clash of multiple instances
+  * repo: added template for secrets used for testing
+
+* 0.11.5
+
+  * 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)
+
+* 0.11.4
+
+  * possibility to give shared inbox name when sending a package (else use id and type)
+
+* 0.11.3
+
+  * minor fixes on multi-session: avoid exception on progress bar
+
+* 0.11.2
+
+  * fixes on multi-session: progress bat and transfer spec param for "direct"
+
+* 0.11.1
+
+  * enhanced short_link creation commands (see examples)
+
+* 0.11
+
+  * add transfer spec option (agent `direct` only) to provide file list directly to ascp: `EX_file_list`.
+
+* 0.10.18
+
+  * new option in. `server` : `ssh_options`
+
+* 0.10.17
+
+  * fixed problem on `server` for option `ssh_keys`, now accepts both single value and list.
+  * new modifier: `@list:<separator>val1<separator>...`
+
+* 0.10.16
+
+  * added list of shared inboxes in workspace (or global), use `--query=@json:'{}'`
+
+* 0.10.15
+
+  * in case of command line error, display the error cause first, and non-parsed argument second
+  * AoC : Activity / Analytics
+
+* 0.10.14
+
+  * added missing bss plugin
+
+* 0.10.13
+
+  * added Faspex5 (use option `value` to give API arguments)
+
+* 0.10.12
+
+  * added support for AoC node registration keys
+  * replaced option : `local_resume` with `transfer_info` for agent [`direct`](README.md#agt_direct)
+  * Transfer agent is no more a Singleton instance, but only one is used in CLI
+  * `@incps` : new extended value modifier
+  * ATS: no more provides access keys secrets: now user must provide it
+  * begin work on "aoc" transfer agent
+
+* 0.10.11
+
+  * minor refactor and fixes
+
+* 0.10.10
+
+  * fix on documentation
+
+* 0.10.9.1
+
+  * add total number of items for AoC resource list
+  * better gem version dependency (and fixes to support Ruby 2.0.0)
+  * removed aoc search_nodes
+
+* 0.10.8
+
+  * removed option: `fasp_proxy`, use pseudo transfer spec parameter: `EX_fasp_proxy_url`
+  * removed option: `http_proxy`, use pseudo transfer spec parameter: `EX_http_proxy_url`
+  * several other changes..
+
+* 0.10.7
+
+  * fix: ascli fails when username cannot be computed on Linux.
+
+* 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.
+  * gem version requirements made more open
+
+* 0.10.5
+
+  * fix faspex package receive command not working
+
+* 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
+
+* 0.10.3
+
+  * included user name in oauth bearer token cache for AoC when JWT is used.
+
+* 0.10.2
+
+  * updated `search_nodes` to be more generic, so it can search not only on access key, but also other queries.
+  * added doc for "cargo" like actions
+  * added doc for multi-session
+
+* 0.10.1
+
+  * AoC and node v4 "browse" works now on non-folder items: file, link
+  * initial support for AoC automation (do not use yet)
+
+* 0.10
+
+  * support for transfer using IBM Cloud Object Storage
+  * improved `find` action using arbitrary expressions
+
+* 0.9.36
+
+  * added option to specify file pair lists
+
+* 0.9.35
+
+  * updated plugin `preview` , changed parameter names, added documentation
+  * fix in `ats` plugin : instance id needed in request header
+
+* 0.9.34
+
+  * parser "@preset" can be used again in option "transfer_info"
+  * some documentation re-organizing
+
+* 0.9.33
+
+  * 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
+  * many small changes
+
+* 0.9.32
+
+  * all Faspex public links are now supported
+  * removed faspex operation recv_publink
+  * replaced with option `link` (consistent with AoC)
+
+* 0.9.31
+
+  * added more support for public link: receive and send package, to user or dropbox and files view.
+  * delete expired file lists
+  * changed text table gem from text-table to terminal-table because it supports multiline values
+
+* 0.9.27
+
+  * basic email support with SMTP
+  * basic proxy auto config support
+
+* 0.9.26
+
+  * table display with --fields=ALL now includes all column names from all lines, not only first one
+  * unprocessed argument shows error even if there is an error beforehand
+
+* 0.9.25
+
+  * the option `value` of command `find`, to filter on name, is not optional
+  * `find` now also reports all types (file, folder, link)
+  * `find` now is able to report all fields (type, size, etc...)
+
+* 0.9.24
+
+  * fix bug where AoC node to node transfer did not work
+  * fix bug on error if ED25519 private key is defined in .ssh
+
+* 0.9.23
+
+  * defined REST error handlers, more error conditions detected
+  * commands to select specific ascp location
+
+* 0.9.21
+
+  * supports simplified wizard using global client
+  * only ascp binary is required, other SDK (keys) files are now generated
+
+* 0.9.20
+
+  * improved wizard (prepare for AoC global client id)
+  * preview generator: addedoption : --skip-format=&lt;png,mp4&gt;
+  * removed outdated pictures from this doc
+
+* 0.9.19
+
+  * added command aspera bearer --scope=xx
+
+* 0.9.18
+
+  * enhanced aspera admin events to support query
+
+* 0.9.16
+
+  * AoC transfers are now reported in activity app
+  * new interface for Rest class authentication (keep backward compatibility)
+
+* 0.9.15
+
+  * new feature: "find" command in aspera files
+  * sample code for transfer API
+
+* 0.9.12
+
+  * add nagios commands
+  * support of ATS for IBM Cloud, removed old version based on aspera id
+
+* 0.9.11
+
+  * Breaking change: @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
+  * 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
+
+* 0.9.9
+
+  * Breaking change: "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
+
+  * 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
+
+  * 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
+  * Faspex: to come: cargo-like function to download only new packages with id=NEW
+
+* 0.9.6
+
+  * Breaking change: `@param:`is now `@preset:` and is generic
+  * AoC: added command to display current workspace information
+
+* 0.9.5
+
+  * new parameter: new_user_option used to choose between public_link and invite of external users.
+  * fixed bug in wizard, and wizard uses now product detection
+
+* 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).
+  * AoC Package send supports external users
+  * new command to export AoC config to Aspera CLI config
+
+* 0.9.3
+
+  * REST error message show host and code
+  * option for quiet display
+  * 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
+
+* 0.9.2
+
+  * Breaking change: 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
+
+* 0.9
+
+  * Renamed the CLI from aslmcli to ascli
+  * Automatic rename and conversion of former config folder from aslmcli to ascli
+
+* 0.7.6
+
+  * add "sync" plugin
+
+* 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
+  * 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 &rarr; ats cluster list
+  * change: (break) ats server list clouds &rarr; ats cluster clouds
+  * change: (break) ats server list instance --cloud=x --region=y &rarr; ats cluster show --cloud=x --region=y
+  * change: (break) ats server id xxx &rarr; ats cluster show --id=xxx
+  * change: (break) ats subscriptions &rarr; ats credential subscriptions
+  * change: (break) ats api_key repository list &rarr; ats credential cache list
+  * change: (break) ats api_key list &rarr; ats credential list
+  * change: (break) ats access_key id xxx &rarr; ats access_key --id=xxx
+
+* 0.6.18
+
+  * some commands take now --id option instead of id command.
+
+* 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".

data/CONTRIBUTING.md

@@ -0,0 +1,118 @@
+# Contributing
+
+## Reporting Issues and Vulnerabilities
+
+You can report issues at <https://github.com/IBM/aspera-cli/issues>
+
+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.
+- If you are not running the latest version (please check), update.
+- Include your `ruby -e "puts RUBY_DESCRIPTION"`.
+
+Thanks!
+
+## Making Contributions
+
+To fetch & test the gem for development, do:
+
+```bash
+git clone https://github.com/IBM/aspera-cli.git
+cd aspera-cli
+bundle install
+make test
+```
+
+If you want to contribute, please:
+
+- Fork the project.
+- Make your feature addition or bug fix.
+- 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
+
+## Running Tests
+
+First, a testing environment must be created:
+
+```bash
+mkdir local
+cp docs/test_env.conf local/.
+```
+
+Fill `local/test_env.conf` with system URLs and credentials for tests.
+
+This project uses a Makefile for tests:
+
+```bash
+cd tests
+make
+```
+
+When new commands are added to the CLI, new tests shall be added to the test suite.
+
+## Coverage
+
+A coverage report can be generated in folder `coverage` using gem `SimpleCov`.
+Enable coverage monitoring using env var `ENABLE_COVERAGE`.
+
+```bash
+ENABLE_COVERAGE=1 make test
+```
+
+Once tests are completed, or during test, consult the page: [coverage/index.html](coverage/index.html)
+
+## Build
+
+By default the gem is built signed: `make`.
+The appropriate signing key is required, and its path must be set to env var `SIGNING_KEY`.
+It is also possible to build a non-signed version for development purpose: `make unsigned_gem`.
+
+### Gem Signature
+
+Refer to: <https://guides.rubygems.org/security/>
+
+The gem is signed with the public certificate found in `certs` and a secret key (kept secret by maintainer).
+
+To build the signed gem:
+
+```bash
+SIGNING_KEY=/path/to/signing_key.pem make
+```
+
+The user can activate gem signature verification on installation:
+
+- Add the certificate to gem trusted certificates:
+
+```bash
+curl https://raw.githubusercontent.com/IBM/aspera-cli/main/certs/aspera-cli-public-cert.pem -so aspera-cli-certificate.pem
+gem cert --add aspera-cli-certificate.pem
+rm aspera-cli-certificate.pem
+```
+
+- Install the gem with `HighSecurity` or `MediumSecurity`: this will succeed only of the gem is trusted.
+
+```bash
+gem install -P HighSecurity aspera-cli
+```
+
+## Docker image build
+
+### on MacOS using ubuntu multipass
+
+Install [multipass](https://multipass.run/docs) with [brew](https://multipass.run/docs/installing-on-macos#heading--use-brew):
+
+[Initialize the docker environment](https://multipass.run/docs/docker-tutorial).
+
+Make sure the ubuntu user in container is part of the docker group.
+
+## 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 with <https://github.com/pmq20/ruby-packer> (rubyc)