aspera-cli 4.10.0 → 4.12.0

data/bin/ascli

@@ -3,9 +3,9 @@
 
 require 'rubygems'
 require 'securerandom'
-GEM_ROOT=File.realpath(File.join(File.dirname(File.realpath(__FILE__)),'..'))
+GEM_ROOT = File.realpath(File.join(File.dirname(File.realpath(__FILE__)), '..'))
 # coverage for tests
-if ENV.has_key?('ENABLE_COVERAGE')
+if ENV.key?('ENABLE_COVERAGE')
   require 'simplecov'
   SimpleCov.root(GEM_ROOT)
   SimpleCov.enable_for_subprocesses if SimpleCov.respond_to?(:enable_for_subprocesses)
@@ -14,13 +14,13 @@ if ENV.has_key?('ENABLE_COVERAGE')
   SimpleCov.command_name(SecureRandom.uuid)
   SimpleCov.at_exit do
     original_file_descriptor = $stdout
-    $stdout.reopen(File.join(GEM_ROOT,'simplecov.log'))
+    $stdout.reopen(File.join(GEM_ROOT, 'simplecov.log'))
     SimpleCov.result.format!
     $stdout.reopen(original_file_descriptor)
   end
   SimpleCov.start
 end
-$LOAD_PATH.unshift(File.join(GEM_ROOT,'lib'))
+$LOAD_PATH.unshift(File.join(GEM_ROOT, 'lib'))
 require 'aspera/cli/main'
 require 'aspera/environment'
 Encoding.default_internal = Encoding::UTF_8

data/bin/asession

@@ -13,11 +13,11 @@ TS_LOGLEVEL = 'EX_loglevel'
 # by default go to /tmp/username.filelist
 TS_TMP_FILELIST_FOLDER = 'EX_file_list_folder'
 
-SAMPLE_DEMO='"remote_host":"demo.asperasoft.com","remote_user":"asperaweb","ssh_port":33001,"remote_password":"demoaspera"'
-SAMPLE_DEMO2='"direction":"receive","destination_root":"./test.dir"'
-def assert_usage(assertion,errmsg)
+SAMPLE_DEMO = '"remote_host":"demo.asperasoft.com","remote_user":"asperaweb","ssh_port":33001,"remote_password":"demoaspera"'
+SAMPLE_DEMO2 = '"direction":"receive","destination_root":"./test.dir"'
+def assert_usage(assertion, error_message)
   return if assertion
-  $stderr.puts('ERROR: '.red.blink + errmsg) if errmsg
+  $stderr.puts('ERROR: '.red.blink + error_message) if error_message
   $stderr.puts('USAGE')
   $stderr.puts('    asession')
   $stderr.puts('    asession -h|--help')
@@ -48,24 +48,24 @@ if ARGV.empty?
   parameter_source_err_msg = ' (JSON on stdin)'
 end
 # anyway expect only one argument: session information
-assert_usage(ARGV.length.eql?(1),'exactly one argument is expected')
-assert_usage(!['-h','--help'].include?(ARGV.first),nil)
+assert_usage(ARGV.length.eql?(1), 'exactly one argument is expected')
+assert_usage(!['-h', '--help'].include?(ARGV.first), nil)
 # parse transfer spec
 begin
   transfer_spec_arg = ARGV.pop
   transfer_spec = Aspera::Cli::ExtendedValue.instance.evaluate(transfer_spec_arg)
 rescue
-  assert_usage(false,"Cannot extract transfer spec from: #{transfer_spec_arg}")
+  assert_usage(false, "Cannot extract transfer spec from: #{transfer_spec_arg}")
 end
 # ensure right type
-assert_usage(transfer_spec.is_a?(Hash),"the value must be a hash table#{parameter_source_err_msg}")
+assert_usage(transfer_spec.is_a?(Hash), "the value must be a hash table#{parameter_source_err_msg}")
 # additional debug capability
-if transfer_spec.has_key?(TS_LOGLEVEL)
+if transfer_spec.key?(TS_LOGLEVEL)
   Aspera::Log.instance.level = transfer_spec[TS_LOGLEVEL]
   transfer_spec.delete(TS_LOGLEVEL)
 end
 # possibly override temp folder
-if transfer_spec.has_key?(TS_TMP_FILELIST_FOLDER)
+if transfer_spec.key?(TS_TMP_FILELIST_FOLDER)
   Aspera::Fasp::Parameters.file_list_folder = transfer_spec[TS_TMP_FILELIST_FOLDER]
   transfer_spec.delete(TS_TMP_FILELIST_FOLDER)
 end
@@ -77,10 +77,10 @@ client.add_listener(Aspera::Cli::Listener::LineDump.new)
 job_id = client.start_transfer(transfer_spec)
 # async commands
 Thread.new do
-  begin
+  begin # rubocop:disable Style/RedundantBegin
     loop do
       data = JSON.parse($stdin.gets)
-      client.send_command(job_id,0,data)
+      client.send_command(job_id, 0, data)
     end
   rescue
     Process.exit(1)

data/docs/test_env.conf

@@ -3,11 +3,11 @@ config:
   version: 4.0.0
 default:
   config: cli_default
-  aoc: tst_aoc1
+  aoc: tst_aoc_jwt
   faspex: tst_faspex
-  faspex5: tst_faspex5
+  faspex5: tst_faspex5_jwt
   shares: tst_shares
-  node: tst_node
+  node: tst_node_simple
   server: tst_server
   orchestrator: tst_orch
   console: tst_console
@@ -18,7 +18,6 @@ default:
 cli_default:
   interactive: your value here
   smtp: your value here
-  secrets: your value here
 local_user:
   ssh_keys: your value here
 smtp_config:
@@ -30,11 +29,17 @@ smtp_config:
   from_name: your value here
   username: your value here
   password: your value here
-tst_aoc1:
+tst_aoc_jwt:
   url: your value here
   username: your value here
   auth: your value here
   private_key: your value here
+tst_aoc_web:
+  url: your value here
+  auth: your value here
+  redirect_uri: your value here
+  client_id: your value here
+  client_secret: your value here
 tst_faspex:
   url: your value here
   username: your value here
@@ -43,10 +48,6 @@ tst_faspex:
 tst_hstsfaspex_ssh:
   url: your value here
   username: your value here
-tst_node_faspex:
-  url: your value here
-  username: your value here
-  password: your value here
 tst_faspex5_boot:
   url: your value here
   auth: your value here
@@ -57,8 +58,7 @@ tst_faspex5_web:
   auth: your value here
   redirect_uri: your value here
   client_id: your value here
-  client_secret: your value here
-tst_faspex5:
+tst_faspex5_jwt:
   url: your value here
   auth: your value here
   client_id: your value here
@@ -73,11 +73,23 @@ tst_shares_1:
   url: your value here
   username: your value here
   password: your value here
-tst_node:
+tst_node_simple:
   url: your value here
   username: your value here
   password: your value here
-node_srv:
+tst_node_ak:
+  url: your value here
+  username: your value here
+  password: your value here
+tst_node_faspex:
+  url: your value here
+  username: your value here
+  password: your value here
+tst_node_admak:
+  url: your value here
+  username: your value here
+  password: your value here
+tst_node_preview:
   url: your value here
   username: your value here
   password: your value here
@@ -108,10 +120,6 @@ tst_ak_preview:
   username: your value here
   password: your value here
   mimemagic: your value here
-tst_node_preview:
-  url: your value here
-  username: your value here
-  password: your value here
 tst_cos:
   apikey: your value here
   crn: your value here
@@ -120,6 +128,8 @@ tst_cos:
 sync:
   local_path: your value here
   remote_path: your value here
+nowss:
+  ts: your value here
 misc:
   upload_folder: your value here
   syncuser: your value here
@@ -129,6 +139,7 @@ misc:
   faspex_dbx: your value here
   faspex_wkg: your value here
   faspex_src: your value here
+  faspex5_shinbox: your value here
   faspex5_meta: your value here
   shares_upload: your value here
   console_smart_id: your value here
@@ -152,6 +163,7 @@ misc:
   aoc_shbx_meta: your value here
   aoc_ak_name: your value here
   aoc_ak_secret: your value here
+  aoc_test_folder: your value here
   icos_bucket_key: your value here
   icos_bucket_secret: your value here
   icos_bucket_name: your value here
@@ -165,5 +177,3 @@ misc:
   aoc_user_email: your value here
   aoc_workspace2: your value here
   http_gw_fqdn_port: your value here
-tst_secrets:
-  eudemo-sedemo: your value here

data/examples/aoc.rb

@@ -7,9 +7,9 @@ require 'aspera/log'
 Aspera::Log.instance.level = :debug
 
 if !ARGV.length.eql?(3)
-  Aspera::Log.log.error("wrong number of args: #{ARGV.length}")
-  Aspera::Log.log.error("Usage: #{$PROGRAM_NAME} <aoc URL> <aoc username> <aoc private key content>")
-  Aspera::Log.log.error("Example: #{$PROGRAM_NAME} https://myorg.ibmaspera.com john@example.com $(cat /home/john/my_key.pem)")
+  Aspera::Log.log.error{"wrong number of args: #{ARGV.length}"}
+  Aspera::Log.log.error{"Usage: #{$PROGRAM_NAME} <aoc URL> <aoc username> <aoc private key content>"}
+  Aspera::Log.log.error{"Example: #{$PROGRAM_NAME} https://myorg.ibmaspera.com john@example.com $(cat /home/john/my_key.pem)"}
   Process.exit(1)
 end
 
@@ -17,7 +17,7 @@ aoc_url = ARGV[0]
 aoc_user = ARGV[1]
 aoc_key_value = ARGV[2]
 
-aocapi = Aspera::AoC.new(
+aoc_api = Aspera::AoC.new(
   url: aoc_url,
   auth: :jwt,
   private_key: aoc_key_value,
@@ -25,6 +25,6 @@ aocapi = Aspera::AoC.new(
   scope: 'user:all',
   subpath: 'api/v1')
 
-self_user_data = aocapi.read('self')
+self_user_data = aoc_api.read('self')
 
-Aspera::Log.dump('self',self_user_data)
+Aspera::Log.dump('self', self_user_data)

data/examples/dascli

@@ -1,20 +1,20 @@
 #!/usr/bin/env bash
 # set env var image to specify another docker image
-# set env var version to specify another image version
-# set env var docker_args to add options to docker run
-: ${image:=martinlaurent/ascli}
-# by default take latest version
-: ${version:=latest}
-: ${docker:=docker}
-: ${imgtag=$image:$version}
-# transform var into array
-add_dock_args=( $docker_args )
-# same location as in Dockerfile: main config folder for ascli in container
+: "${image:=martinlaurent/ascli}"
+# set env var version to specify another image version (default: latest version)
+: "${version:=latest}"
+# set env var imgtag to specify a specific image/version
+: "${imgtag=$image:$version}"
+# set env var `docker` to podman, to use podman
+: "${docker:=docker}"
+# set env var docker_args to add options to docker run (transform var into array) # spellcheck disable=SC2086
+read -a add_dock_args <<< $docker_args
+# set env var ASCLI_HOME to set the config folder on host
+: "${ASCLI_HOME:=$HOME/.aspera/ascli}"
+# main config folder for ascli in container (same value as in `Dockerfile`)
 ascli_home_container=/home/cliuser/.aspera/ascli
-# set default location for config folder on host if necessary
-: ${ASCLI_HOME:=$HOME/.aspera/ascli}
-if test ! -d $ASCLI_HOME;then
-	echo "creating foder: $ASCLI_HOME"
+if test ! -d "$ASCLI_HOME";then
+	echo "creating folder: $ASCLI_HOME"
 	# create it if necessary to allow mounting the volume in container
 	mkdir -p "$ASCLI_HOME"
 fi
@@ -22,7 +22,9 @@ exec $docker run \
 --rm \
 --tty \
 --interactive \
+--user root \
+--env ASCLI_HOME="$ascli_home_container" \
 --volume "$ASCLI_HOME:$ascli_home_container" \
 "${add_dock_args[@]}" \
-$imgtag \
-ascli "$@"
+"$imgtag" \
+"$@"

data/examples/faspex4.rb

@@ -20,9 +20,9 @@ Aspera::Log.instance.level = :debug
 Aspera::Fasp::Installation.instance.folder = tmpdir
 
 if !ARGV.length.eql?(3)
-  Aspera::Log.log.error("Wrong number of args: #{ARGV.length}")
-  Aspera::Log.log.error("Usage: #{$PROGRAM_NAME} <faspex URL> <faspex username> <faspex password>")
-  Aspera::Log.log.error("Example: #{$PROGRAM_NAME} https://faspex.com/aspera/faspex john p@sSw0rd")
+  Aspera::Log.log.error{"Wrong number of args: #{ARGV.length}"}
+  Aspera::Log.log.error{"Usage: #{$PROGRAM_NAME} <faspex URL> <faspex username> <faspex password>"}
+  Aspera::Log.log.error{"Example: #{$PROGRAM_NAME} https://faspex.com/aspera/faspex john p@sSw0rd"}
   Process.exit(1)
 end
 
@@ -52,7 +52,7 @@ api_v3.read('me')
 #---------------
 
 # create a sample file to send
-file_to_send = File.join(tmpdir,'myfile.bin')
+file_to_send = File.join(tmpdir, 'myfile.bin')
 File.write(file_to_send, 'sample data')
 # package creation parameters
 package_create_params = {'delivery' => {
@@ -60,7 +60,7 @@ package_create_params = {'delivery' => {
   'recipients' => ['aspera.user1@gmail.com'],
   'sources'    => [{'paths' => [file_to_send]}]
 }}
-pkg_created = api_v3.create('send',package_create_params)[:data]
+pkg_created = api_v3.create('send', package_create_params)[:data]
 # get transfer specification (normally: only one)
 transfer_spec = pkg_created['xfer_sessions'].first
 # set paths of files to send
@@ -69,12 +69,12 @@ transfer_spec['paths'] = [{'source' => file_to_send}]
 transfer_client = Aspera::Fasp::AgentDirect.new({quiet: true})
 # start transfer (asynchronous)
 job_id = transfer_client.start_transfer(transfer_spec)
-Aspera::Log.dump('job_id',job_id)
+Aspera::Log.dump('job_id', job_id)
 # wait for all transfer completion (for the example)
 result = transfer_client.wait_for_transfers_completion
 #  notify of any transfer error
 result.reject{|i|i.eql?(:success)}.each do |e|
-  Aspera::Log.log.error("A transfer error occurred: #{e.message}")
+  Aspera::Log.log.error{"A transfer error occurred: #{e.message}"}
 end
 
 # 3: Faspex 4 API v4
@@ -82,13 +82,13 @@ end
 api_v4 = Aspera::Rest.new({
   base_url: faspex_url + '/api',
   auth:     {
-    type:     :oauth2,
-    base_url: faspex_url + '/auth/oauth2',
-    auth:     {type: :basic, username: faspex_user, password: faspex_pass},
-    crtype:   :generic,
-    generic:  {grant_type: 'password'},
-    scope:    'admin'
+    type:         :oauth2,
+    base_url:     faspex_url + '/auth/oauth2',
+    auth:         {type: :basic, username: faspex_user, password: faspex_pass},
+    grant_method: :generic,
+    generic:      {grant_type: 'password'},
+    scope:        'admin'
   }})
 
-# Use it. Note that Faspex 4 API v4 is totally different from Faspex 4 v3 APIs, see ref on line 2
-Aspera::Log.dump('users',api_v4.read('users')[:data])
+# Use it. Note that Faspex 4 API v4 is totally different from Faspex 4 v3 APIs, see ref in header
+Aspera::Log.dump('users', api_v4.read('users')[:data])

data/examples/node.rb

@@ -15,7 +15,7 @@ require 'tmpdir'
 
 tmpdir = ENV['tmp'] || Dir.tmpdir || '.'
 
-raise 'Usage: PASSWORD=<password> $0 https://<address>:<port> <node user>' unless ARGV.length.eql?(2) && ENV.has_key?('PASSWORD')
+raise 'Usage: PASSWORD=<password> $0 https://<address>:<port> <node user>' unless ARGV.length.eql?(2) && ENV.key?('PASSWORD')
 
 # example : https://node_asperaweb@eudemo.asperademo.com:9092
 node_uri = URI.parse(ARGV.shift)
@@ -23,7 +23,7 @@ node_user = ARGV.shift
 node_pass = ENV['PASSWORD']
 
 ##############################################################
-# generic initialisation : configuration of FaspManager
+# generic initialization : configuration of FaspManager
 
 # set trace level for sample, set to :debug to see complete list of debug information
 Aspera::Log.instance.level = :debug
@@ -34,10 +34,10 @@ Aspera::RestErrorsAspera.register_handlers
 # some required files are generated here (keys, certs)
 Aspera::Fasp::Installation.instance.folder = tmpdir
 # set path to your copy of ascp binary (else, let the system find)
-Aspera::Fasp::Installation.instance.ascp_path = ENV['ascp'] if ENV.has_key?('ascp')
+Aspera::Fasp::Installation.instance.ascp_path = ENV['ascp'] if ENV.key?('ascp')
 # another way is to detect installed products and use one of them
-#Aspera::Fasp::Installation.instance.installed_products.each{|p|puts("found: #{p[:name]}")}
-#Aspera::Fasp::Installation.instance.use_ascp_from_product('Aspera Connect')
+# Aspera::Fasp::Installation.instance.installed_products.each{|p|puts("found: #{p[:name]}")}
+# Aspera::Fasp::Installation.instance.use_ascp_from_product('Aspera Connect')
 # or install:
 #
 
@@ -45,10 +45,10 @@ Aspera::Fasp::Installation.instance.ascp_path = ENV['ascp'] if ENV.has_key?('asc
 transfer_agent = Aspera::Fasp::AgentDirect.new
 
 # Note that it would also be possible to start transfers using other agents
-#require 'aspera/fasp/connect'
-#transfer_agent=Aspera::Fasp::Connect.new
-#require 'aspera/fasp/node'
-#transfer_agent=Aspera::Fasp::Node.new(Aspera::Rest.new(...))
+# require 'aspera/fasp/connect'
+# transfer_agent=Aspera::Fasp::Connect.new
+# require 'aspera/fasp/node'
+# transfer_agent=Aspera::Fasp::Node.new(Aspera::Rest.new(...))
 
 ##############################################################
 # Optional : register an event listener
@@ -57,7 +57,7 @@ transfer_agent = Aspera::Fasp::AgentDirect.new
 class MyListener < Aspera::Fasp::Listener
   # this is the callback called during transfers, here we only display the received information
   # but it could be used to get detailed error information, check "type" field is "ERROR"
-  def event_enhanced(data);$stdout.puts(JSON.generate(data));$stdout.flush;end
+  def event_enhanced(data); $stdout.puts(JSON.generate(data)); $stdout.flush; end # rubocop:disable Style/Semicolon
 end
 
 # register the sample listener to display events
@@ -78,9 +78,9 @@ node_api = Aspera::Rest.new({
 sources = ["#{tmpdir}/sample_file.txt"]
 destination = '/Upload'
 # create sample file(s)
-sources.each{|p|File.write(p,'Hello World!')}
+sources.each{|p|File.write(p, 'Hello World!')}
 # request transfer authorization to node for a single transfer (This is a node api v3 call)
-send_result = node_api.create('files/upload_setup',{ transfer_requests: [{ transfer_request: { paths: [{ destination: destination }] } }] })[:data]
+send_result = node_api.create('files/upload_setup', { transfer_requests: [{ transfer_request: { paths: [{ destination: destination }] } }] })[:data]
 # we normally have only one transfer spec in list, so just get the first transfer_spec
 transfer_spec = send_result['transfer_specs'].first['transfer_spec']
 # add list of files to upload

data/examples/proxy.pac

@@ -4,7 +4,7 @@ function FindProxyForURL(url, host) {
 	url = url.toLowerCase();
 	host = host.toLowerCase();
 
-	/* Don't proxy local hostnames */
+	/* Don't proxy local host names */
 	if (isPlainHostName(host)) {
 		return 'DIRECT';
 	}
@@ -31,7 +31,7 @@ function FindProxyForURL(url, host) {
 	if (isResolvable(host)) {
 		var hostIP = dnsResolve(host);
 
-		/* Don't proxy non-routable addresses (RFC 3330) */
+		/* Don't proxy private addresses (RFC 3330) */
 		if (isInNet(hostIP, '0.0.0.0', '255.0.0.0')
 				|| isInNet(hostIP, '10.0.0.0', '255.0.0.0')
 				|| isInNet(hostIP, '127.0.0.0', '255.0.0.0')

data/examples/server.rb

@@ -15,7 +15,7 @@ require 'tmpdir'
 
 tmpdir = ENV['tmp'] || Dir.tmpdir || '.'
 
-raise 'Usage: PASSWORD=<password> $0 ssh://<address>:<port> <transfer user>' unless ARGV.length.eql?(2) && ENV.has_key?('PASSWORD')
+raise 'Usage: PASSWORD=<password> $0 ssh://<address>:<port> <transfer user>' unless ARGV.length.eql?(2) && ENV.key?('PASSWORD')
 
 # example : ssh://asperaweb@eudemo.asperademo.com:33001
 server_uri = URI.parse(ARGV.shift)
@@ -23,7 +23,7 @@ server_user = ARGV.shift
 server_pass = ENV['PASSWORD']
 
 ##############################################################
-# generic initialisation : configuration of FaspManager
+# generic initialization : configuration of FaspManager
 
 # set trace level for sample, set to :debug to see complete list of debug information
 Aspera::Log.instance.level = :debug
@@ -34,10 +34,10 @@ Aspera::RestErrorsAspera.register_handlers
 # some required files are generated here (keys, certs)
 Aspera::Fasp::Installation.instance.folder = tmpdir
 # set path to your copy of ascp binary (else, let the system find)
-Aspera::Fasp::Installation.instance.ascp_path = ENV['ascp'] if ENV.has_key?('ascp')
+Aspera::Fasp::Installation.instance.ascp_path = ENV['ascp'] if ENV.key?('ascp')
 # another way is to detect installed products and use one of them
-#Aspera::Fasp::Installation.instance.installed_products.each{|p|puts("found: #{p[:name]}")}
-#Aspera::Fasp::Installation.instance.use_ascp_from_product('Aspera Connect')
+# Aspera::Fasp::Installation.instance.installed_products.each{|p|puts("found: #{p[:name]}")}
+# Aspera::Fasp::Installation.instance.use_ascp_from_product('Aspera Connect')
 # or install:
 #
 
@@ -45,10 +45,10 @@ Aspera::Fasp::Installation.instance.ascp_path = ENV['ascp'] if ENV.has_key?('asc
 transfer_agent = Aspera::Fasp::AgentDirect.new
 
 # Note that it would also be possible to start transfers using other agents
-#require 'aspera/fasp/connect'
-#transfer_agent=Aspera::Fasp::Connect.new
-#require 'aspera/fasp/node'
-#transfer_agent=Aspera::Fasp::Node.new(Aspera::Rest.new(...))
+# require 'aspera/fasp/connect'
+# transfer_agent=Aspera::Fasp::Connect.new
+# require 'aspera/fasp/node'
+# transfer_agent=Aspera::Fasp::Node.new(Aspera::Rest.new(...))
 
 ##############################################################
 # Optional : register an event listener
@@ -57,7 +57,7 @@ transfer_agent = Aspera::Fasp::AgentDirect.new
 class MyListener < Aspera::Fasp::Listener
   # this is the callback called during transfers, here we only display the received information
   # but it could be used to get detailed error information, check "type" field is "ERROR"
-  def event_enhanced(data);$stdout.puts(JSON.generate(data));$stdout.flush;end
+  def event_enhanced(data); $stdout.puts(JSON.generate(data)); $stdout.flush; end # rubocop:disable Style/Semicolon
 end
 
 # register the sample listener to display events
@@ -66,7 +66,7 @@ transfer_agent.add_listener(MyListener.new)
 ##############################################################
 # first example: download by SSH credentials
 
-# manually build teansfer spec
+# manually build transfer spec
 transfer_spec = {
   'remote_host'      => server_uri.host,
   'ssh_port'         => server_uri.port,
@@ -82,7 +82,7 @@ transfer_spec = {
 transfer_agent.start_transfer(transfer_spec)
 
 # optional: helper method: wait for completion of transfers
-# here we started a single transfer session (no multisession parameter)
+# here we started a single transfer session (no multi session parameter)
 # get array of status, one for each session (so, a single value array)
 # each status is either :success or "error message"
 transfer_result = transfer_agent.wait_for_transfers_completion