aspera-cli 4.4.0 → 4.7.0

data/bin/ascli

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 require 'rubygems'
-$LOAD_PATH.unshift(File.dirname(__FILE__)+"/../lib")
+$LOAD_PATH.unshift(File.realpath(File.dirname(File.realpath(__FILE__))+'/../lib'))
 require 'aspera/cli/main'
 require 'aspera/environment'
 Encoding.default_internal = Encoding::UTF_8

data/bin/asession

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 # Laurent Martin/2017
 $LOAD_PATH.unshift(File.dirname(__FILE__)+"/../lib")
-require 'aspera/fasp/local'
+require 'aspera/fasp/agent_direct'
 require 'aspera/cli/listener/line_dump'
 require 'aspera/cli/extended_value'
 require 'aspera/log'
@@ -65,10 +66,8 @@ if transfer_spec.has_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
-# get local agent (ascp)
-client=Aspera::Fasp::Local.new
-# disable ascp output on stdout to not mix with JSON events
-client.quiet=true
+# get local agent (ascp), disable ascp output on stdout to not mix with JSON events
+client=Aspera::Fasp::AgentDirect.new({quiet: true})
 # display JSON instead of legacy Lines
 client.add_listener(Aspera::Cli::Listener::LineDump.new)
 # start transfer (asynchronous)

data/docs/test_env.conf

@@ -124,6 +124,8 @@ misc:
   faspex_publink_recv_from_fxuser: your value here
   faspex_publink_send_to_fxuser: your value here
   faspex_publink_send_to_dropbox: your value here
+  faspex_dbx: your value here
+  faspex_wkg: your value here
   shares_upload: your value here
   console_smart_id: your value here
   console_smart_file: your value here
@@ -143,6 +145,7 @@ misc:
   aoc_publink_folder: your value here
   aoc_shbx_ws: your value here
   aoc_shbx_name: your value here
+  aoc_shbx_meta: your value here
   aoc_node1_name: your value here
   aoc_node1_secret: your value here
   icos_bucket_key: your value here

data/examples/aoc.rb

@@ -1,13 +1,14 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 require 'aspera/aoc'
 require 'aspera/log'
 
 Aspera::Log.instance.level=:debug
 
-if ! ARGV.length.eql?(3)
+if !ARGV.length.eql?(3)
   Aspera::Log.log.error("wrong number of args: #{ARGV.length}")
-  Aspera::Log.log.error("Usage: #{$0} <aoc URL> <aoc username> <aoc private key content>")
-  Aspera::Log.log.error("Example: #{$0} https://myorg.ibmaspera.com john@example.com $(cat /home/john/my_key.pem)")
+  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
 

data/examples/faspex4.rb

@@ -1,11 +1,12 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 # find Faspex API here: https://developer.ibm.com/apis/catalog/?search=faspex
 # this example makes use of class Aspera::Rest for REST calls, alternatively class RestClient of gem rest-client could be used
-# this example makes use of class Aspera::Fasp::Local for transfers, alternatively the official "Transfer SDK" could be used
+# this example makes use of class Aspera::Fasp::AgentDirect for transfers, alternatively the official "Transfer SDK" could be used
 # Aspera SDK can be downloaded with: `ascli conf ascp install` , it installs in $HOME/.aspera/ascli/sdk
 require 'aspera/rest'
 require 'aspera/log'
-require 'aspera/fasp/local'
+require 'aspera/fasp/agent_direct'
 
 tmpdir=ENV['tmp']||Dir.tmpdir || '.'
 
@@ -17,10 +18,10 @@ Aspera::Log.instance.level=:debug
 # (if data files are not there, they will be created)
 Aspera::Fasp::Installation.instance.folder = tmpdir
 
-if ! ARGV.length.eql?(3)
+if !ARGV.length.eql?(3)
   Aspera::Log.log.error("Wrong number of args: #{ARGV.length}")
-  Aspera::Log.log.error("Usage: #{$0} <faspex URL> <faspex username> <faspex password>")
-  Aspera::Log.log.error("Example: #{$0} https://faspex.com/aspera/faspex john p@sSw0rd")
+  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
 
@@ -36,11 +37,11 @@ Aspera::Rest.insecure=true
 
 # create REST API object
 api_v3=Aspera::Rest.new({
-  :base_url => faspex_url,
-  :auth     => {
-  :type     => :basic,
-  :username => faspex_user,
-  :password => faspex_pass
+  base_url: faspex_url,
+  auth: {
+  type:     :basic,
+  username: faspex_user,
+  password: faspex_pass
   }})
 
 # very simple api call
@@ -51,7 +52,7 @@ api_v3.read('me')
 
 # create a sample file to send
 file_to_send=File.join(tmpdir,'myfile.bin')
-File.open(file_to_send, "w") {|f| f.write("sample data") }
+File.write(file_to_send, 'sample data')
 # package creation parameters
 package_create_params={'delivery'=>{'title'=>'test package','recipients'=>['aspera.user1@gmail.com'],'sources'=>[{'paths'=>[file_to_send]}]}}
 pkg_created=api_v3.create('send',package_create_params)[:data]
@@ -59,31 +60,30 @@ pkg_created=api_v3.create('send',package_create_params)[:data]
 transfer_spec=pkg_created['xfer_sessions'].first
 # set paths of files to send
 transfer_spec['paths']=[{'source'=>file_to_send}]
-# get the local agent (i.e. ascp)
-transfer_client=Aspera::Fasp::Local.new
-# disable ascp output on stdout (optional)
-transfer_client.quiet=true
+# get local agent (ascp), disable ascp output on stdout to not mix with JSON events
+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)
 # wait for all transfer completion (for the example)
 result=transfer_client.wait_for_transfers_completion
 #  notify of any transfer error
-result.select{|i|!i.eql?(:success)}.each do |e|
+result.reject{|i|i.eql?(:success)}.each do |e|
   Aspera::Log.log.error("A transfer error occured: #{e.message}")
 end
 
 # 3: Faspex 4 API v4
 #---------------
 api_v4=Aspera::Rest.new({
-  :base_url  => faspex_url+'/api',
-  :auth      => {
-  :type      => :oauth2,
-  :base_url  => faspex_url+'/auth/oauth2',
-  :grant     => :header_userpass,
-  :user_name => faspex_user,
-  :user_pass => faspex_pass,
-  :scope     => 'admin'
-  }})
+  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'
+    }})
 
 # 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])

data/examples/proxy.pac

@@ -1,4 +1,4 @@
-/* demo proxy pac for Amelia */
+/* demo proxy pac for ascli */
 function FindProxyForURL(url, host) {
 	/* Normalize the URL for pattern matching */
 	url = url.toLowerCase();

data/examples/transfer.rb

@@ -1,8 +1,9 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 # Example: transfer a file using one of the provided transfer agents
 # location of ascp can be specified with env var "ascp"
 # temp folder can be specified with env var "tmp"
-require 'aspera/fasp/local'
+require 'aspera/fasp/agent_direct'
 require 'aspera/fasp/listener'
 require 'aspera/fasp/installation'
 require 'aspera/log'
@@ -16,7 +17,7 @@ tmpdir=ENV['tmp']||Dir.tmpdir || '.'
 DEMO_CONFIG=[
   'ssh://asperaweb@eudemo.asperademo.com:33001',
   'https://node_asperaweb@eudemo.asperademo.com:9092',
-  'demoaspera',
+  'demoaspera'
 ]
 
 ##############################################################
@@ -26,7 +27,7 @@ DEMO_CONFIG=[
 Aspera::Log.instance.level=:debug
 
 # register aspera REST call error handlers
-Aspera::RestErrorsAspera.registerHandlers
+Aspera::RestErrorsAspera.register_handlers
 
 # some required files are generated here (keys, certs)
 Aspera::Fasp::Installation.instance.folder = tmpdir
@@ -36,10 +37,10 @@ Aspera::Fasp::Installation.instance.ascp_path=ENV['ascp'] if ENV.has_key?('ascp'
 #Aspera::Fasp::Installation.instance.installed_products.each{|p|puts("found: #{p[:name]}")}
 #Aspera::Fasp::Installation.instance.use_ascp_from_product('Aspera Connect')
 # or install:
-# 
+#
 
 # get FASP Manager singleton based on above ascp location
-fasp_manager=Aspera::Fasp::Local.new
+fasp_manager=Aspera::Fasp::AgentDirect.new
 
 # Note that it would also be possible to start transfers using other agents
 #require 'aspera/fasp/connect'
@@ -54,7 +55,7 @@ fasp_manager=Aspera::Fasp::Local.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
 end
 
 # register the sample listener to display events
@@ -84,9 +85,9 @@ fasp_manager.start_transfer(transfer_spec)
 # get array of status, one for each session (so, a single value array)
 # each status is either :success or "error message"
 transfer_result=fasp_manager.wait_for_transfers_completion
-STDOUT.puts(JSON.generate(transfer_result))
+$stdout.puts(JSON.generate(transfer_result))
 # get list of errors only
-errors=transfer_result.select{|i|!i.eql?(:success)}
+errors=transfer_result.reject{|i|i.eql?(:success)}
 # the transfer was not success, as there is at least one error
 raise "Error(s) occured: #{errors.join(',')}" if !errors.empty?
 
@@ -95,19 +96,19 @@ raise "Error(s) occured: #{errors.join(',')}" if !errors.empty?
 
 # create rest client for Node API on a public demo system, using public demo credentials
 node_api=Aspera::Rest.new({
-  :base_url => DEMO_CONFIG[1],
-  :auth     => {
-  :type     => :basic,
-  :username => URI.parse(DEMO_CONFIG[1]).user,
-  :password => DEMO_CONFIG[2]
+  base_url: DEMO_CONFIG[1],
+  auth: {
+  type:     :basic,
+  username: URI.parse(DEMO_CONFIG[1]).user,
+  password: DEMO_CONFIG[2]
   }})
 # define sample file(s) and destination folder
 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
@@ -118,7 +119,6 @@ transfer_spec['authentication']='token'
 fasp_manager.start_transfer(transfer_spec)
 # optional: wait for transfer completion helper function to get events
 transfer_result=fasp_manager.wait_for_transfers_completion
-errors=transfer_result.select{|i|!i.eql?(:success)}
+errors=transfer_result.reject{|i|i.eql?(:success)}
 # the transfer was not success, as there is at least one error
 raise "Error(s) occured: #{errors.join(',')}" if !errors.empty?
-