aspera-cli 4.12.0 → 4.13.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aspera-cli
 version: !ruby/object:Gem::Version
-  version: 4.12.0
+  version: 4.13.0
 platform: ruby
 authors:
 - Laurent Martin
@@ -10,32 +10,34 @@ bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIEeDCCAuCgAwIBAgIBATANBgkqhkiG9w0BAQsFADA0MTIwMAYDVQQDDClsYXVy
-  ZW50Lm1hcnRpbi5hc3BlcmEvREM9ZnIvREM9aWJtL0RDPWNvbTAeFw0yMjA2MTUy
-  MzQ5NDdaFw0yMzA2MTUyMzQ5NDdaMDQxMjAwBgNVBAMMKWxhdXJlbnQubWFydGlu
-  LmFzcGVyYS9EQz1mci9EQz1pYm0vREM9Y29tMIIBojANBgkqhkiG9w0BAQEFAAOC
-  AY8AMIIBigKCAYEAn4dpdgpX97n2d+jsdQFBlvCLpWluceH+0bJ/UfGEm+3m5nwW
-  Y3TfdcxT45QytqA0cQXu8FeiybkZxSclTK0ozc2r3615y4ssHKI9D37YNTTISeq0
-  ifSYTgtHzqUXEe4TlHJz/babvi94pYFmA8nngJ2WBvMq7x8QPPPxaSi3Eb+e9yEK
-  AH4TiMFAZpJMs8Do8nzaOmWOHzftulLjkdWHmKoFD0S6Fo8hXgQU3XpiReCdKGz3
-  TtIUyMu1rrAewnu4k7ZpFJuNpRqrGQvQZqjCOEvKTyK1YJHiN/A+HbsCaVNcm3Gz
-  +r1O8KCy9tihjVVQvdBKVuhfNuGLiUJSxdvRT/T7RNTXVEFBk6OwVqE2uTTPYQ7X
-  wr/w3/W/BWp5MCbMFdg2GUIzsTaGkdEu5Jwr/8Gn8fUg3NAy4G5k8Il9GiXJ8Ep+
-  vbi508sTE+Fpl9B5FvE4Epez96BCBo52p8alymarH4SJq4Xh77u2XDYXwNhl7grZ
-  fESTXTzcNOLsohf/AgMBAAGjgZQwgZEwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAw
-  HQYDVR0OBBYEFL+Mx+Puf+5IF80dbzB4Pr9NFHQcMCsGA1UdEQQkMCKBIGxhdXJl
-  bnQubWFydGluLmFzcGVyYUBmci5pYm0uY29tMCsGA1UdEgQkMCKBIGxhdXJlbnQu
-  bWFydGluLmFzcGVyYUBmci5pYm0uY29tMA0GCSqGSIb3DQEBCwUAA4IBgQA/BaXr
-  ddNpCMj74ghL92WQjfyzADKIIfhS13QcF2lN6+DzkmQUnirwfdFtk+vJQWVtnyPy
-  gvt6hw9gv+6WbN7YXPMtoHPZesSsgAU6MFaw2x4DGdWH/seXawQaSSVkvNW+8SZl
-  P/8ZbO/X8mRjSa8uGZvQRngdb2ajS+uPto9YAJdilIeWsxs0oxnbJLgYRn8zP98X
-  OGwD0JctNQp7ZIpy164upiZdMnlmLICyzRu3CBuGfzYvD0RTuAfoVA6Pzmm60q42
-  +gbbl+Dt4NNKuyATdKpWOoSshPYWmW6QASbpiPjeHkD3bxq1IlE/Q2Y+AV4fAloy
-  mzeTfE4dv3AXnqn0VpZyiA9hdVsSyPProknfhFwZhjp6eMS38za2UXDJotfDZrBv
-  ZjkOWbUc1aLIsfaQFHWyNfisY9X2RgkFHjX0p5493wnoA7aWh52MUhc145npFh8z
-  v4P9xwkT02Shkert4B4iwNvVjoAUGk+J4090svZCroAyXBjon5LV7MJ4fyw=
+  MIIEzDCCAzSgAwIBAgIBATANBgkqhkiG9w0BAQsFADBeMR4wHAYDVQQDDBVsYXVy
+  ZW50Lm1hcnRpbi5hc3BlcmExEjAQBgoJkiaJk/IsZAEZFgJmcjETMBEGCgmSJomT
+  8ixkARkWA2libTETMBEGCgmSJomT8ixkARkWA2NvbTAeFw0yMzA2MjcwODUwMDRa
+  Fw0yNjA3MDEwODUwMDRaMF4xHjAcBgNVBAMMFWxhdXJlbnQubWFydGluLmFzcGVy
+  YTESMBAGCgmSJomT8ixkARkWAmZyMRMwEQYKCZImiZPyLGQBGRYDaWJtMRMwEQYK
+  CZImiZPyLGQBGRYDY29tMIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIBigKCAYEA
+  1E7e2PvDM1xOXrAQKYzkFG2uZcPC+uAdcq2zqUdfLv2iwAXhGQ/P5f/6uDt/cL5b
+  M9ooUjAbWcSforv2nRjEcTuXor7GOVtQ+oJRQtfr+1LpfLLF8KNEs1kLNlL3fZsJ
+  vmtnusuGx+1sBIOjPkM39RB9OXhGQoeLkU9e1YuXpRsWGj1/L8+XYMzdkoDmNvjR
+  6KDdriTHbis1FFzkoak9tKZbJWJw99oKM346wRfIQLOJk583bucsOimqA9bFYzp7
+  xa0vJyH2gbpfgL5TcKHn3ugrKLDPy+qpW7HCtpo3Ag7LxagM3+YmKEuuNBNiRPDU
+  lCsl1pwGuuYsgEXi9tGP8+GYuhX7GFWLhTZIRXTpsVF+dLkzSPlEEjS9S8hR2hSo
+  KpE9mT2mOr2vplpE7A9j0+BPH99iPgRysqOGn5jmDFhNcrisTpm4jsQp2TcgQCSN
+  j35/BUkRFmkKzGkAoyo7DvgZQFg8qoXYQw2HQhL9Bnhh+souo72gLgHnIYtuK0Y3
+  AgMBAAGjgZQwgZEwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFPZD
+  HBRnWTjzjeZq3Sx/yv7hhY9rMCsGA1UdEQQkMCKBIGxhdXJlbnQubWFydGluLmFz
+  cGVyYUBmci5pYm0uY29tMCsGA1UdEgQkMCKBIGxhdXJlbnQubWFydGluLmFzcGVy
+  YUBmci5pYm0uY29tMA0GCSqGSIb3DQEBCwUAA4IBgQCtbncBw6IjRWDjiaeH6gmQ
+  GrfPX53oAJOMnyjhhgKfLd/PPJIckCxz/Tscsuq9+ZUDTubz2E3ltycdxrz0OOul
+  M8cWfkJ4cvdGAGTtqhmv3GGWZwFN8V8WYmmXrgej4o33vx6o8B6uwBn38hvkkAlB
+  ixQDORrk0ck1GVUYYo2UmDOlqArf6paaqd7rziY0dntYl0DfFWe7eJYA467FKjM6
+  /V3L2mTuHg4nCqC2febbAG+W+n158UrEkIKoOpAvQsykuuRtMaTpSTnYd0kLtQIF
+  qNyjadnjZB8iMIedYmEOKApKUJS/9BN1iXHxVbL03AS4o5xMQO3PPjXcwwaybE8G
+  sqAiwQUoawi1m3fZ8u3Xx+GmWE7tE9oxnPA48Y44EkiiWozq263f4S2Xa449ODoh
+  eTf9kxhVM40wGQOECVNA8UsEEZHD48eF+csUYZtAJOF5oxTI8UyV9T/o6CgO0c9/
+  Gzz+Qm5ULOUcPiJLjSpaiTrkiIVYiDGnqNSr6R1Hb1c=
   -----END CERTIFICATE-----
-date: 2023-03-20 00:00:00.000000000 Z
+date: 2023-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: execjs
@@ -69,36 +71,30 @@ dependencies:
   name: net-smtp
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.1'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.1'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: net-ssh
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: ruby-progressbar
   requirement: !ruby/object:Gem::Requirement
@@ -367,12 +363,8 @@ files:
 - bin/ascli
 - bin/asession
 - docs/test_env.conf
-- examples/aoc.rb
 - examples/dascli
-- examples/faspex4.rb
-- examples/node.rb
 - examples/proxy.pac
-- examples/server.rb
 - lib/aspera/aoc.rb
 - lib/aspera/ascmd.rb
 - lib/aspera/ats_api.rb
@@ -448,6 +440,7 @@ files:
 - lib/aspera/preview/generator.rb
 - lib/aspera/preview/image_error.png
 - lib/aspera/preview/options.rb
+- lib/aspera/preview/terminal.rb
 - lib/aspera/preview/utils.rb
 - lib/aspera/preview/video_error.png
 - lib/aspera/proxy_auto_config.js
@@ -482,7 +475,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -490,7 +483,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - Read the manual for any requirement
-rubygems_version: 3.4.6
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: 'Execute actions using command line on IBM Aspera Server products: Aspera

data/examples/aoc.rb

@@ -1,30 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'aspera/aoc'
-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)"}
-  Process.exit(1)
-end
-
-aoc_url = ARGV[0]
-aoc_user = ARGV[1]
-aoc_key_value = ARGV[2]
-
-aoc_api = Aspera::AoC.new(
-  url: aoc_url,
-  auth: :jwt,
-  private_key: aoc_key_value,
-  username: aoc_user,
-  scope: 'user:all',
-  subpath: 'api/v1')
-
-self_user_data = aoc_api.read('self')
-
-Aspera::Log.dump('self', self_user_data)

data/examples/faspex4.rb

@@ -1,94 +0,0 @@
-#!/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::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/agent_direct'
-
-tmpdir = ENV['tmp'] || Dir.tmpdir || '.'
-
-# Set high log level for the example, decrease to :warn usually
-Aspera::Log.instance.level = :debug
-
-# Set folder where SDK is installed (mandatory)
-# (if ascp is not there, the lib will try to find in usual locations)
-# (if data files are not there, they will be created)
-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"}
-  Process.exit(1)
-end
-
-faspex_url = ARGV[0] # typically: https://faspex.example.com/aspera/faspex
-faspex_user = ARGV[1]
-faspex_pass = ARGV[2]
-
-# uncomment this if certificate is self signed
-# Rest.session_cb = lambda{|http|http.verify_mode = OpenSSL::SSL::VERIFY_NONE}
-
-# 1: Faspex 4 API v3
-#---------------
-
-# create REST API object
-api_v3 = Aspera::Rest.new({
-  base_url: faspex_url,
-  auth:     {
-    type:     :basic,
-    username: faspex_user,
-    password: faspex_pass
-  }})
-
-# very simple api call
-api_v3.read('me')
-
-# 2: send a package
-#---------------
-
-# create a sample file to send
-file_to_send = File.join(tmpdir, 'myfile.bin')
-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]
-# get transfer specification (normally: only one)
-transfer_spec = pkg_created['xfer_sessions'].first
-# set paths of files to send
-transfer_spec['paths'] = [{'source' => file_to_send}]
-# 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.reject{|i|i.eql?(:success)}.each do |e|
-  Aspera::Log.log.error{"A transfer error occurred: #{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',
-    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 in header
-Aspera::Log.dump('users', api_v4.read('users')[:data])

data/examples/node.rb

@@ -1,96 +0,0 @@
-#!/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/agent_direct'
-require 'aspera/fasp/listener'
-require 'aspera/fasp/installation'
-require 'aspera/log'
-require 'aspera/rest'
-require 'aspera/rest_errors_aspera'
-require 'json'
-require 'tmpdir'
-
-tmpdir = ENV['tmp'] || Dir.tmpdir || '.'
-
-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)
-node_user = ARGV.shift
-node_pass = ENV['PASSWORD']
-
-##############################################################
-# 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
-
-# register aspera REST call error handlers
-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.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')
-# or install:
-#
-
-# get Transfer Agent
-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(...))
-
-##############################################################
-# Optional : register an event listener
-
-# example of event listener that displays events on stdout
-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 # rubocop:disable Style/Semicolon
-end
-
-# register the sample listener to display events
-transfer_agent.add_listener(MyListener.new)
-
-##############################################################
-# Upload with node authorization
-
-# create rest client for Node API on a public demo system, using public demo credentials
-node_api = Aspera::Rest.new({
-  base_url: node_uri.to_s,
-  auth:     {
-    type:     :basic,
-    username: node_user,
-    password: node_pass
-  }})
-# 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!')}
-# 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]
-# 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
-transfer_spec['paths'] = sources.map{|p|{'source' => p}}
-# set authentication type to "token" (will trigger use of bypass SSH key)
-transfer_spec['authentication'] = 'token'
-# from here : same as example 1
-transfer_agent.start_transfer(transfer_spec)
-# optional: wait for transfer completion helper function to get events
-transfer_result = transfer_agent.wait_for_transfers_completion
-errors = transfer_result.reject{|i|i.eql?(:success)}
-# the transfer was not success, as there is at least one error
-raise "Error(s) occurred: #{errors.join(',')}" if !errors.empty?

data/examples/server.rb

@@ -1,93 +0,0 @@
-#!/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/agent_direct'
-require 'aspera/fasp/listener'
-require 'aspera/fasp/installation'
-require 'aspera/log'
-require 'aspera/rest'
-require 'aspera/rest_errors_aspera'
-require 'json'
-require 'tmpdir'
-
-tmpdir = ENV['tmp'] || Dir.tmpdir || '.'
-
-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)
-server_user = ARGV.shift
-server_pass = ENV['PASSWORD']
-
-##############################################################
-# 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
-
-# register aspera REST call error handlers
-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.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')
-# or install:
-#
-
-# get Transfer Agent
-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(...))
-
-##############################################################
-# Optional : register an event listener
-
-# example of event listener that displays events on stdout
-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 # rubocop:disable Style/Semicolon
-end
-
-# register the sample listener to display events
-transfer_agent.add_listener(MyListener.new)
-
-##############################################################
-# first example: download by SSH credentials
-
-# manually build transfer spec
-transfer_spec = {
-  'remote_host'      => server_uri.host,
-  'ssh_port'         => server_uri.port,
-  'remote_user'      => server_user,
-  'remote_password'  => server_pass,
-  'direction'        => 'receive',
-  'destination_root' => tmpdir,
-  'paths'            => [{'source' => 'aspera-test-dir-tiny/200KB.1'}]
-}
-# start transfer in separate thread
-# method returns as soon as transfer thread is created
-# it des not wait for completion, or even for session startup
-transfer_agent.start_transfer(transfer_spec)
-
-# optional: helper method: wait for completion of transfers
-# 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
-$stdout.puts(JSON.generate(transfer_result))
-# get list of errors only
-errors = transfer_result.reject{|i|i.eql?(:success)}
-# the transfer was not success, as there is at least one error
-raise "Error(s) occurred: #{errors.join(',')}" if !errors.empty?