aspera-cli 4.18.0 → 4.18.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71adcb69e4f2f4bb9db31713c2a5b7f251ddb052418d3a11e6061e55bf4979ce
-  data.tar.gz: af9cc1ab42b8b6f89d2e561becdb07e05e6ca0d6c2275e0834848ab3f2496eb6
+  metadata.gz: 98185fd9f823fc0d85ebf7183d5c88cf6e0aac7cafd8325802bfa0724c52ddf4
+  data.tar.gz: 848811c07aa60060cae1320cd0512e72a73bb78fee9e1837245ef856af3883de
 SHA512:
-  metadata.gz: b48fab716de4e3d3c3a4175c8a5a4139f02d0ff29f2a8e9c1e57b12f1fe6e0bbb1aed85eeb04a894087da6b360675695e0017a97be1ee210b1ff9b3b70beeeff
-  data.tar.gz: e31d43642a703b5b2a9b3f65ce712ed848b174b7dc122e7be760ef51849d292accc104f90acc02e4bc9c6eaae579246f6a68239b204ebb514a6d6783d0a82cb1
+  metadata.gz: ede08e6e6c6ce3ef33d0c402730ee1854b5d0364da3d47ef736f0e7680a9f8cc1098316fe5945c15aab98ed931c26dd625ea7fb9673e70068dfd2755bb7a053a
+  data.tar.gz: 1bf901163167844fbada435d0cbac759075b51e9f2da22f6f2b97e99be53c202d69e83ec38f0ee4cade3f937a29c502e22e75ac4452b5e0bb426b0fafa7d883c

checksums.yaml.gz.sig

@@ -1,2 +1,3 @@
-�ّ���D�����,,KȪ�
�]��Ntw1/�֕[�?O�r����ѹo��;J�Hn��V�Wa��n��s]���B�,$7���v�b㡇�X��y+Ъ)�ey�"A�~8�w����/��ݱ(��HN=s�ЄJc5�|�>��VeW��Ȓ�\��#�[��3/�r�p�I��K��^�����{ f
-/�W&����?�g��9�Y�^/�g�@DsywE�t�t�H�6C�
+
+���	��C��^����2���Bm��Y��.{�I}�_��I�^�0<8#�׼�4���Fn��q�u*�O�9J�f:��rl�`��Ifفaߣ}8����V"z��0JX���Ġ�Ad���6�?���b���	F��=@�*Ϩ�]Rc���z
+�a��P�pXw�4ׅ��7�෣�C��������ӳU
�0��vԟ�m���d��N
�?�T2�����wxjn��oZGf�,�o��F�i1��Wޕ�=D�Y�IKc�j%އ�7x`O��Ąy�o.��{���VS!��a��nsN�|��}���n�c�V�Ά��x��pɗ>�`���Rl,[,Ϥ󦱡������.V�U#6.e|���<�
�dWdcַ�)n]� %G5

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changes (Release notes)
 
+* 4.18.1
+  * New Features:
+    * none
+  * Issues Fixed:
+    * **global**: #146 (@junkimu) Fix problem on Windows WRT terminal detection
+    * **global**: node gen4 (aoc) browsing through link now follows the link correctly
+    * `shares`: #147 Fix problem for `shares files mkdir`
+  * Breaking Changes:
+    * **global**: Removed option `id`, deprecated since 4.14.0
+
 * 4.18.0
   
   * New Features:

data/README.md

@@ -10,7 +10,7 @@
 
 ## Introduction
 
-Version : 4.18.0
+Version : 4.18.1
 
 Laurent/2016-2024
 
@@ -92,7 +92,7 @@ Once the gem is installed, `ascli` shall be accessible:
 
 ```console
 $ ascli --version
-4.18.0
+4.18.1
 ```
 
 ### First use
@@ -300,52 +300,6 @@ Download the Ruby installer executable from <https://rubyinstaller.org/downloads
 rubyinstaller-devkit-3.2.2-1-x64.exe /silent /currentuser /noicons /dir=C:\aspera-cli
 ```
 
-Installation without network:
-
-It is essentially the same procedure, but instead of retrieving files from internet, copy the files from a machine with internet access, and then install from those archives:
-
-- Download the `exe` Ruby installer from <https://rubyinstaller.org/downloads/>
-
-  ```bash
-  v=$(curl -s https://rubyinstaller.org/downloads/|sed -nEe 's|.*(https://.*/releases/download/.*exe).*|\1|p'|head -n 1)
-  curl -o ${v##*/} $v
-  ```
-
-- Create an archive with necessary gems: <https://help.rubygems.org/kb/rubygems/installing-gems-with-no-network>
-
-  ```bat
-  gem install aspera-cli -N -i my_gems
-  ```
-
-  Zip the files `*.gem` from folder `repo/my_gems`
-
-- Download the SDK from: <https://ibm.biz/aspera_sdk>
-
-Create a Zip with all those files, and transfer to the target system.
-
-Then, on the target system:
-
-- Unzip the archive
-- Execute the installer:
-
-```bat
-rubyinstaller-devkit-3.2.2-1-x64.exe /silent /currentuser /noicons /dir=C:\aspera-cli
-```
-
-- Install the gems:
-
-```bat
-gem install --force --local *.gem
-```
-
-- Install the SDK
-
-```bash
-ascli config ascp install --sdk-url=file:///sdk.zip
-```
-
-> **Note:** An example of installation script is provided: [docs/install.bat](docs/install.bat)
-
 #### macOS: `brew`
 
 **macOS** come with Ruby.
@@ -410,6 +364,26 @@ One can remove all installed gems, for example to start fresh:
 gem uninstall -axI $(ls $(gem env gemdir)/gems/|sed -e 's/-[^-]*$//'|sort -u)
 ```
 
+#### Linux as simple user
+
+If you don't have root access, you can install Ruby in your home directory using `rbenv` see [rbenv-installer](https://github.com/rbenv/rbenv-installer#rbenv-installer):
+
+```bash
+curl -fsSL https://github.com/rbenv/rbenv-installer/raw/HEAD/bin/rbenv-installer | bash
+```
+
+Then open a new terminal, or "source" the shell initialization script:
+
+```bash
+source ~/.bashrc
+```
+
+Then install Ruby:
+
+```bash
+rbenv install 3.2.2
+```
+
 #### Other Unixes (AIX)
 
 Ruby is sometimes made available as an installable package through third party providers.
@@ -544,7 +518,7 @@ ascli config ascp install
 If a local SDK installation is preferred instead of fetching from internet: one can specify the location of the SDK file:
 
 ```bash
-curl -Lso sdk.zip https://ibm.biz/aspera_sdk
+curl -Lso sdk.zip https://ibm.biz/aspera_transfer_sdk
 ```
 
 ```bash
@@ -574,6 +548,18 @@ Refer to section: [Transfer Agents](#transfer-clients-agents)
 
 > **Note:** No pre-packaged version is provided yet.
 
+#### Gem files and dependencies
+
+The sample script: [examples/build_package.sh](examples/build_package.sh) can be used to download all necessary gems and dependencies in a tar gz.
+
+```console
+$ ./build_package.sh aspera-cli 4.18.0
+
+Archive: aspera-cli-4.18.0-gems.tgz
+```
+
+#### Unix-like
+
 A method to build one is provided here:
 
 The procedure:
@@ -595,7 +581,7 @@ ascli --show-config --fields=sdk_url
 - Download the SDK archive from that URL
 
 ```bash
-curl -Lso sdk.zip https://ibm.biz/aspera_sdk
+curl -Lso sdk.zip https://ibm.biz/aspera_transfer_sdk
 ```
 
 - Transfer those 2 files to the target system
@@ -618,12 +604,48 @@ ascli config ascp install --sdk-url=file:///sdk.zip
 source ~/.rvm/scripts/rvm
 ```
 
-> **Note:** Alternatively, to download all necessary gems in folder `my_gems`, execute:
+#### Windows
+
+Installation without network:
+
+It is essentially the same procedure as installation for Windows with internet, but instead of retrieving files from internet, copy the files from a machine with internet access, and then install from those archives:
+
+- Download the `exe` Ruby installer from <https://rubyinstaller.org/downloads/>
+
+  ```bash
+  v=$(curl -s https://rubyinstaller.org/downloads/|sed -nEe 's|.*(https://.*/releases/download/.*exe).*|\1|p'|head -n 1)
+  curl -o ${v##*/} $v
+  ```
+
+- Create an archive with necessary gems like in previous section
+
+- Download the SDK from: <https://ibm.biz/aspera_transfer_sdk>
+
+- Create a Zip with all those files, and transfer to the target system.
+
+Then, on the target system:
+
+- Unzip the archive
+- Execute the installer:
+
+```bat
+rubyinstaller-devkit-3.2.2-1-x64.exe /silent /currentuser /noicons /dir=C:\aspera-cli
+```
+
+- Install the gems: Extract the gem archive, and then:
+
+```bat
+gem install --force --local *.gem
+```
+
+- Install the SDK
 
 ```bash
-gem install aspera-cli -N -i my_gems
+ascli config ascp install --sdk-url=file:///sdk.zip
 ```
 
+> **Note:** An example of installation script is provided: [docs/install.bat](docs/install.bat)
+
 ### Container
 
 The container image is: [`docker.io/martinlaurent/ascli`](https://hub.docker.com/r/docker.io/martinlaurent/ascli).
@@ -684,7 +706,7 @@ ascli -v
 ```
 
 ```text
-4.18.0
+4.18.1
 ```
 
 In order to keep persistency of configuration on the host, you should specify your user's configuration folder as a volume for the container.
@@ -1937,8 +1959,8 @@ genkey my_key 4096
 image https://eudemo.asperademo.com/wallpaper.jpg
 initdemo
 open
-plugin create my_command
-plugin list
+plugins create my_command
+plugins list
 preset delete conf_name
 preset initialize conf_name @json:'{"p1":"v1","p2":"v2"}'
 preset list
@@ -3032,7 +3054,7 @@ Columns:
 | fasp_port | int | Y | Y | Y | Y | Y | Specifies fasp (UDP) port.<br/>(-O {int}) |
 | fasp_url | string | &nbsp; | &nbsp; | &nbsp; | &nbsp; | &nbsp; | Only used in Faspex.<br/>(&lt;ignored&gt;) |
 | file_checksum | string | Y | Y | &nbsp; | &nbsp; | &nbsp; | Enable checksum reporting for transferred files by specifying the hash to use.<br/>Allowed values: sha-512, sha-384, sha-256, sha1, md5, none<br/>(&lt;ignored&gt;) |
-| http_fallback | bool<br/>string | Y | Y | Y | Y | Y | When true(1), attempts to perform an HTTP transfer if a FASP transfer cannot be performed.<br/>(-y (conversion){bool}|{string}) |
+| http_fallback | bool<br/>string | Y | Y | Y | Y | Y | When true(1), attempts to perform an HTTP transfer if a FASP transfer cannot be performed.<br/>(-y (conversion){bool}\|{string}) |
 | http_fallback_port | int | Y | &nbsp; | &nbsp; | &nbsp; | &nbsp; | Specifies http port when no cipher is used<br/>(-t {int}) |
 | https_fallback_port | int | Y | Y | Y | Y | Y | Specifies https port when cipher is used<br/>(-t {int}) |
 | keepalive | bool | Y | &nbsp; | &nbsp; | &nbsp; | &nbsp; | The session is running in persistent session mode.<br/>(--keepalive) |
@@ -3539,7 +3561,7 @@ ascli server upload "faux:///mydir?file=testfile&count=1m&size=0&inc=2&seq=seque
 ```text
 ascli -h
 NAME
-        ascli -- a command line tool for Aspera Applications (v4.18.0)
+        ascli -- a command line tool for Aspera Applications (v4.18.1)
 
 SYNOPSIS
         ascli COMMANDS [OPTIONS] [ARGS]
@@ -3570,6 +3592,7 @@ ARGS
 OPTIONS: global
         --interactive=ENUM           Use interactive input of missing params: [no], yes
         --ask-options=ENUM           Ask even optional options: [no], yes
+        --struct-parser=ENUM         Default parser when expected value is a struct: json, ruby
         --format=ENUM                Output format: text, nagios, ruby, json, jsonpp, yaml, [table], csv, image
         --output=VALUE               Destination for results (String)
         --display=ENUM               Output only some information: [info], data, error
@@ -3604,7 +3627,6 @@ OPTIONS:
         --query=VALUE                Additional filter for for some commands (list/delete) (Hash)
         --value=VALUE                Value for create, update, list filter (Hash) (deprecated: (4.14) Use positional value for create/modify or option: query for list/delete)
         --property=VALUE             Name of property to set (modify operation)
-        --id=VALUE                   Resource identifier (deprecated: (4.14) Use positional identifier after verb (modify,delete,show))
         --bulk=ENUM                  Bulk operation (only some): [no], yes
         --bfail=ENUM                 Bulk operation error handling: no, [yes]
     -N, --no-default                 Do not load default configuration for plugin
@@ -5019,6 +5041,9 @@ files browse /
 files browse / --url=my_private_link
 files browse / --url=my_public_link_folder_no_pass
 files browse / --url=my_public_link_folder_pass --password=my_public_link_password
+files browse my_remote_file
+files browse my_remote_folder
+files browse my_remote_folder/
 files delete /testsrc
 files download --transfer=alpha testdst/test_file.bin
 files download --transfer=connect testdst/test_file.bin
@@ -5389,7 +5414,7 @@ Example:
 - `ascli node browse /` : list files with **gen3/node user** API
 - `ascli node access_key do self browse /` : list files with **gen4/access key** API
 
-## Browse
+#### Browse
 
 Native API parameters can be placed in option `query`.
 
@@ -6337,6 +6362,14 @@ Then, the postprocessing script executed will be `script1.sh`.
 
 Environment variables at set to the values provided by the web hook which are the same as Faspex 4 postprocessing.
 
+### Faspex 5: Missing commands
+
+If a command is missing, then it is still possible to execute command by calling directly the API on the command line using `curl`:
+
+```bash
+curl -H "Authorization: $(ascli ascli bearer)" https://faspex5.example.com/aspera/faspex/api/v5/api_endpoint_here
+```
+
 ## Plugin: `faspex`: IBM Aspera Faspex v4
 
 > **Note:** For full details on Faspex API, refer to: [Reference on Developer Site](https://developer.ibm.com/apis/catalog/?search=faspex)
@@ -6573,9 +6606,11 @@ admin user ldap add the_name
 admin user local list
 admin user saml import @json:'{"id":"the_id","name_id":"the_name"}'
 files browse /
+files delete my_share1/new_folder
 files delete my_share1/test_file.bin
 files download --to-folder=. my_share1/test_file.bin
 files download --to-folder=. my_share1/test_file.bin --transfer=httpgw --transfer-info=@json:'{"url":"https://tst.example.com/path@"}'
+files mkdir my_share1/new_folder
 files upload --to-folder=https://shares.share1 'faux:///testfile?1m' --transfer=httpgw --transfer-info=@json:'{"url":"my_example.com/path@","synchronous":true,"api_version":"v1","upload_chunk_size":100000}'
 files upload --to-folder=my_share1 test_file.bin
 files upload --to-folder=my_share1 test_file.bin --transfer=httpgw --transfer-info=@json:'{"url":"https://tst.example.com/path@"}'
@@ -6749,6 +6784,8 @@ health
 > **Note:** Add `ascli faspio` in front of the commands:
 
 ```bash
+bridges create @json:'{"name":"test1","local":{"protocol":"tcp","tls_enabled":false,"port":"3000","bind_address":"127.0.0.1"},"forward":{"protocol":"fasp","tls_enabled":false,"port":"3994","bind_address":"127.0.0.1","host":["10.0.0.1"]}}'
+bridges delete --bulk=yes @json:@stdin:
 bridges list
 health
 ```

data/examples/build_package.sh

@@ -0,0 +1,28 @@
+#!/bin/bash
+# Usage: ./build_package.sh <gem_name> <gem_version>
+# Example: ./build_package.sh aspera-cli 4.18.0
+set -e
+if [ "$#" -ne 2 ]; then
+    echo "Usage: $0 <gem_name> <gem_version>"
+    exit 1
+fi
+gem_name=$1
+gem_version=$2
+# on macOS, GNU tar is gtar
+GNU_TAR=tar
+if [ "$(uname)" == "Darwin" ]; then
+    GNU_TAR=gtar
+fi
+# temp folder to install gems
+tmp_dir_install=.tmp_install
+# clean, if there were left overs
+rm -fr $tmp_dir_install
+# retrieve list of necessary gems
+echo "Getting gems $gem_name $gem_version"
+# install gems in a temporary folder
+gem install $gem_name:$gem_version --no-document --install-dir $tmp_dir_install
+archive=$gem_name-$gem_version-gems.tgz
+# .gem files are located in cache folder
+$GNU_TAR -zcf $archive --directory=$tmp_dir_install/cache/. .
+rm -fr $tmp_dir_install
+echo "Archive: $archive"

data/lib/aspera/agent/alpha.rb

@@ -4,7 +4,7 @@ require 'aspera/agent/base'
 require 'aspera/rest'
 require 'aspera/log'
 require 'aspera/json_rpc'
-require 'aspera/open_application'
+require 'aspera/environment'
 require 'securerandom'
 
 module Aspera
@@ -22,7 +22,7 @@ module Aspera
         @application_id = SecureRandom.uuid
         @xfer_id = nil
         super(**base_options)
-        raise 'Using client requires a graphical environment' if !OpenApplication.default_gui_mode.eql?(:graphical)
+        raise 'Using client requires a graphical environment' if !Environment.default_gui_mode.eql?(:graphical)
         method_index = 0
         begin
           # curl 'http://127.0.0.1:33024/' -X POST -H 'content-type: application/json' --data-raw '{"jsonrpc":"2.0","params":[],"id":999999,"method":"rpc.discover"}'
@@ -36,8 +36,8 @@ module Aspera
           method_index += 1
           raise StandardError, "Unable to start #{APP_NAME} #{method_index} times" if start_url.nil?
           Log.log.warn{"#{APP_NAME} is not started (#{e}). Trying to start it ##{method_index}..."}
-          if !OpenApplication.uri_graphical(start_url)
-            OpenApplication.uri_graphical('https://www.ibm.com/aspera/connect/')
+          if !Environment.open_uri_graphical(start_url)
+            Environment.open_uri_graphical('https://www.ibm.com/aspera/connect/')
             raise StandardError, "#{APP_NAME} is not installed"
           end
           sleep(SLEEP_SEC_BETWEEN_RETRY)

data/lib/aspera/agent/connect.rb

@@ -2,7 +2,6 @@
 
 require 'aspera/agent/base'
 require 'aspera/rest'
-require 'aspera/open_application'
 require 'securerandom'
 
 module Aspera
@@ -18,7 +17,7 @@ module Aspera
         @connect_settings = {
           'app_id' => SecureRandom.uuid
         }
-        raise 'Using connect requires a graphical environment' if !OpenApplication.default_gui_mode.eql?(:graphical)
+        raise 'Using connect requires a graphical environment' if !Environment.default_gui_mode.eql?(:graphical)
         method_index = 0
         begin
           connect_url = Ascp::Products.connect_uri
@@ -34,8 +33,8 @@ module Aspera
           method_index += 1
           raise StandardError, "Unable to start connect #{method_index} times" if start_url.nil?
           Log.log.warn{"Aspera Connect is not started (#{e}). Trying to start it ##{method_index}..."}
-          if !OpenApplication.uri_graphical(start_url)
-            OpenApplication.uri_graphical('https://www.ibm.com/aspera/connect/')
+          if !Environment.open_uri_graphical(start_url)
+            Environment.open_uri_graphical('https://www.ibm.com/aspera/connect/')
             raise StandardError, 'Connect is not installed'
           end
           sleep(SLEEP_SEC_BETWEEN_RETRY)

data/lib/aspera/agent/httpgw.rb

@@ -50,7 +50,7 @@ module Aspera
         super(**base_options)
         @gw_api = Api::Httpgw.new(
           # remove /v1 from end of user-provided GW url: we need the base url only
-          url:               url.gsub(%r{/#{Api::Httpgw::API_V1}/*$}o, ''),
+          url:               url,
           api_version:       api_version,
           upload_chunk_size: upload_chunk_size,
           synchronous:       synchronous,

data/lib/aspera/api/httpgw.rb

@@ -310,11 +310,14 @@ module Aspera
         notify_cb:         nil,
         **opts
       )
+        Log.log.debug{Log.dump(:gw_url, url)}
         # add scheme if missing
         url = "https://#{url}" unless url.match?(%r{^[a-z]{1,6}://})
         raise 'GW URL shall be with scheme https' unless url.start_with?('https://')
-        # remove trailing slash and version if any
+        # remove trailing slash and version (o=only once) if present
+        # TODO: issue warning ?
         url = url.gsub(%r{/+$}, '').gsub(%r{/#{API_V1}$}o, '')
+        # assume GW is always under specific path (TODO: remove this ?)
         url = File.join(url, DEFAULT_BASE_PATH) unless url.end_with?(DEFAULT_BASE_PATH)
         @gw_root_url = url
         super(base_url: "#{@gw_root_url}/#{API_V1}", **opts)