aspera-cli 4.17.0 → 4.18.0

data/bin/ascli

@@ -1,8 +1,13 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
+old_verbose = $VERBOSE
+$VERBOSE = nil
+# internal representation of strings (ruby) is UTF-8
 Encoding.default_internal = Encoding::UTF_8
+# external representation of strings (terminal, files)
 Encoding.default_external = Encoding::UTF_8
+$VERBOSE = old_verbose
 
 begin
   gem_lib_folder = File.join(File.dirname(File.dirname(File.realpath(__FILE__))), 'lib')

data/bin/asession

@@ -41,7 +41,7 @@ def assert_usage(assertion, error_message)
   $stderr.puts('EXAMPLES')
   $stderr.puts(%Q(    asession @json:'{"#{PARAM_SPEC}":{#{SAMPLE_DEMO},#{SAMPLE_DEMO2},"paths":[{"source":"/aspera-test-dir-tiny/200KB.1"}]}}'))
   $stderr.puts(%Q(    echo '{"#{PARAM_SPEC}":{"remote_host":...}}'|asession @json:@stdin))
-  Process.exit(1)
+  Process.exit(0)
 end
 Aspera::Ascp::Installation.instance.sdk_folder = File.join(Dir.home, '.aspera', 'sdk')
 
@@ -78,7 +78,7 @@ session_spec['agent']['management_cb'] = ->(event) do
   puts JSON.generate(Aspera::Ascp::Management.enhanced_event_format(event))
 end
 # get local agent (ascp), disable ascp output on stdout to not mix with JSON events
-client = Aspera::Agent::Direct.new(session_spec['agent'])
+client = Aspera::Agent::Direct.new(**session_spec['agent'].symbolize_keys)
 # start transfer (asynchronous)
 job_id = client.start_transfer(session_spec[PARAM_SPEC])
 # async commands

data/lib/aspera/agent/alpha.rb

@@ -9,6 +9,7 @@ require 'securerandom'
 
 module Aspera
   module Agent
+    # Aspera Desktop Alpha Client
     class Alpha < Base
       # try twice the main init url in sequence
       START_URIS = ['aspera://', 'aspera://', 'aspera://']
@@ -17,9 +18,10 @@ module Aspera
       APP_IDENTIFIER = 'com.ibm.software.aspera.desktop'
       APP_NAME = 'Aspera Desktop Alpha Client'
       private_constant :START_URIS, :SLEEP_SEC_BETWEEN_RETRY
-      def initialize(options)
+      def initialize(**base_options)
         @application_id = SecureRandom.uuid
-        super(options)
+        @xfer_id = nil
+        super(**base_options)
         raise 'Using client requires a graphical environment' if !OpenApplication.default_gui_mode.eql?(:graphical)
         method_index = 0
         begin
@@ -111,7 +113,7 @@ module Aspera
           return [e]
         end
         return [:success]
-      end # wait
-    end # AgentAlpha
+      end
+    end
   end
 end

data/lib/aspera/agent/base.rb

@@ -8,8 +8,14 @@ module Aspera
     class Base
       RUBY_EXT = '.rb'
       class << self
+        def factory_create(agent, options)
+          # Aspera.assert_values(agent, agent_list)
+          require "aspera/agent/#{agent}"
+          Aspera::Agent.const_get(agent.to_s.capitalize).new(**options)
+        end
+
         # compute options from user provided and default options
-        def options(default:, options:)
+        def to_move_options(default:, options:)
           result = options.symbolize_keys
           available = default.map{|k, v|"#{k}(#{v})"}.join(', ')
           result.each_key do |k|
@@ -43,14 +49,11 @@ module Aspera
 
       private
 
-      def initialize(options)
+      def initialize(progress: nil)
         # method `shutdown` is optional
         Aspera.assert(respond_to?(:start_transfer))
         Aspera.assert(respond_to?(:wait_for_transfers_completion))
-        Aspera.assert_type(options, Hash){'transfer agent options'}
-        Log.log.debug{Log.dump(:agent_options, options)}
-        @progress = options[:progress]
-        options.delete(:progress)
+        @progress = progress
       end
 
       def notify_progress(**parameters)

data/lib/aspera/agent/connect.rb

@@ -13,8 +13,8 @@ module Aspera
       # delay between each try to start connect
       SLEEP_SEC_BETWEEN_RETRY = 5
       private_constant :CONNECT_START_URIS, :SLEEP_SEC_BETWEEN_RETRY
-      def initialize(options)
-        super(options)
+      def initialize(**base_options)
+        super(**base_options)
         @connect_settings = {
           'app_id' => SecureRandom.uuid
         }
@@ -122,7 +122,7 @@ module Aspera
           return [e]
         end
         return [:success]
-      end # wait
-    end # AgentConnect
+      end
+    end
   end
 end

data/lib/aspera/agent/direct.rb

@@ -18,23 +18,10 @@ module Aspera
   module Agent
     # executes a local "ascp", connects mgt port, equivalent of "Fasp Manager"
     class Direct < Base
-      # options for initialize (same as values in option transfer_info)
-      DEFAULT_OPTIONS = {
-        wss:               true, # true: if both SSH and wss in ts: prefer wss
-        ascp_args:         [],
-        spawn_timeout_sec: 2,
-        spawn_delay_sec:   2, # optional delay to start between sessions
-        multi_incr_udp:    true,
-        trusted_certs:     [], # list of files with trusted certificates (stores)
-        resume:            {},
-        quiet:             true, # by default no native ascp progress bar
-        check_ignore_cb:   nil, # callback with host,port
-        management_cb:     nil # callback for management events
-      }.freeze
       LISTEN_LOCAL_ADDRESS = '127.0.0.1'
       ANY_AVAILABLE_PORT = 0 # 0 means any available port
       # spellchecker: enable
-      private_constant :DEFAULT_OPTIONS, :LISTEN_LOCAL_ADDRESS, :ANY_AVAILABLE_PORT
+      private_constant :LISTEN_LOCAL_ADDRESS, :ANY_AVAILABLE_PORT
 
       # method of Base
       # start ascp transfer(s) (non blocking), single or multi-session
@@ -71,7 +58,7 @@ module Aspera
           elsif multi_session_info[:count].eql?(0)
             Log.log.debug('multi_session count is zero: no multi session')
             multi_session_info = nil
-          elsif @options[:multi_incr_udp] # multi_session_info[:count] > 0
+          elsif @multi_incr_udp # multi_session_info[:count] > 0
             # if option not true: keep default udp port for all sessions
             multi_session_info[:udp_base] = transfer_spec.key?('fasp_port') ? transfer_spec['fasp_port'] : Transfer::Spec::UDP_PORT
             # delete from original transfer spec, as we will increment values
@@ -90,19 +77,19 @@ module Aspera
           io:                nil,               # management port server socket
           token_regenerator: token_regenerator, # regenerate bearer token with oauth
           # env vars and args to ascp (from transfer spec)
-          env_args:          Transfer::Parameters.new(transfer_spec, @options).ascp_args
+          env_args:          Transfer::Parameters.new(transfer_spec, **@tr_opts).ascp_args
         }
 
         if multi_session_info.nil?
           Log.log.debug('Starting single session thread')
           # single session for transfer : simple
-          session[:thread] = Thread.new(session) {|s|transfer_thread_entry(s)}
+          session[:thread] = Thread.new(session) {|session_info|transfer_thread_entry(session_info)}
           @sessions.push(session)
         else
           Log.log.debug('Starting multi session threads')
           1.upto(multi_session_info[:count]) do |i|
             # do not delay the first session
-            sleep(@options[:spawn_delay_sec]) unless i.eql?(1)
+            sleep(@spawn_delay_sec) unless i.eql?(1)
             # do deep copy (each thread has its own copy because it is modified here below and in thread)
             this_session = session.clone
             this_session[:ts] = this_session[:ts].clone
@@ -111,14 +98,14 @@ module Aspera
             # set multi session part
             this_session[:env_args][:args].unshift("-C#{i}:#{multi_session_info[:count]}")
             # option: increment (default as per ascp manual) or not (cluster on other side ?)
-            this_session[:env_args][:args].unshift('-O', (multi_session_info[:udp_base] + i - 1).to_s) if @options[:multi_incr_udp]
+            this_session[:env_args][:args].unshift('-O', (multi_session_info[:udp_base] + i - 1).to_s) if @multi_incr_udp
             # finally start the thread
-            this_session[:thread] = Thread.new(this_session) {|s|transfer_thread_entry(s)}
+            this_session[:thread] = Thread.new(this_session) {|session_info|transfer_thread_entry(session_info)}
             @sessions.push(this_session)
           end
         end
         return session[:job_id]
-      end # start_transfer
+      end
 
       # wait for completion of all jobs started
       # @return list of :success or error message
@@ -219,8 +206,8 @@ module Aspera
           notify_progress(session_id: nil, type: :pre_start, info: 'waiting for ascp')
           mgt_server_socket.listen(1)
           # TODO: timeout does not work when Process.spawn is used... until process exits, then it works
-          Log.log.debug{"before select, timeout: #{@options[:spawn_timeout_sec]}"}
-          readable, _, _ = IO.select([mgt_server_socket], nil, nil, @options[:spawn_timeout_sec])
+          Log.log.debug{"before select, timeout: #{@spawn_timeout_sec}"}
+          readable, _, _ = IO.select([mgt_server_socket], nil, nil, @spawn_timeout_sec)
           Log.log.debug('after select, before accept')
           Aspera.assert(readable, exception_class: Transfer::Error){'timeout waiting mgt port connect (select not readable)'}
           # There is a connection to accept
@@ -239,7 +226,7 @@ module Aspera
             next unless event
             # event is ready
             Log.log.trace1{Log.dump(:management_port, event)}
-            @options[:management_cb]&.call(event)
+            @management_cb&.call(event)
             process_progress(event)
             Log.log.error((event['Description']).to_s) if event['Type'].eql?('FILEERROR') # cspell:disable-line
           end
@@ -261,7 +248,7 @@ module Aspera
               nil
             else
               raise "unexpected last event type: #{last_event['Type']}"
-            end # case
+            end
           end
         rescue SystemCallError => e
           # Process.spawn failed, or socket error
@@ -286,17 +273,17 @@ module Aspera
               Log.log.error(message)
             end
           end
-        end # begin-ensure
-      end # start_transfer_with_args_env
+        end
+      end
 
       # @return [Array] list of sessions for a job
       def sessions_by_job(job_id)
-        @sessions.select{|s| s[:job_id].eql?(job_id)}
+        @sessions.select{|session_info| session_info[:job_id].eql?(job_id)}
       end
 
       # @return [Hash] session information
       def session_by_id(id)
-        matches = @sessions.select{|s| s[:id].eql?(id)}
+        matches = @sessions.select{|session_info| session_info[:id].eql?(id)}
         raise 'no such session' if matches.empty?
         raise 'more than one session' if matches.length > 1
         return matches.first
@@ -324,13 +311,45 @@ module Aspera
 
       private
 
-      # @param options : keys(symbol): see DEFAULT_OPTIONS
-      def initialize(options={})
-        super(options)
-        # set default options and override if specified
-        @options = Base.options(default: DEFAULT_OPTIONS, options: options)
-        Log.log.debug{Log.dump(:agent_options, @options)}
-        @resume_policy = Resumer.new(@options[:resume].symbolize_keys)
+      # options for initialize (same as values in option transfer_info)
+      # @param wss [Boolean] true: if both SSH and wss in ts: prefer wss
+      # @param ascp_args [Array] additional arguments to ascp
+      # @param spawn_timeout_sec [Integer] timeout for ascp spawn
+      # @param spawn_delay_sec [Integer] optional delay to start between sessions
+      # @param multi_incr_udp [Boolean] true: increment udp port for each session
+      # @param trusted_certs [Array] list of files with trusted certificates (stores)
+      # @param resume [Hash] resume policy
+      # @param quiet [Boolean] by default no native ascp progress bar
+      # @param check_ignore_cb [Proc] callback with host,port
+      # @param management_cb [Proc] callback for management events
+      # @param base_options [Hash] other options for base class
+      def initialize(
+        wss:               true,
+        ascp_args:         [],
+        spawn_timeout_sec: 2,
+        spawn_delay_sec:   2,
+        multi_incr_udp:    true,
+        trusted_certs:     [],
+        resume:            {},
+        quiet:             true,
+        check_ignore_cb:   nil,
+        management_cb:     nil,
+        **base_options
+      )
+        super(**base_options)
+        @tr_opts = {
+          ascp_args:       ascp_args,
+          wss:             wss,
+          quiet:           quiet,
+          trusted_certs:   trusted_certs,
+          check_ignore_cb: check_ignore_cb
+        }
+        @spawn_timeout_sec = spawn_timeout_sec
+        @spawn_delay_sec = spawn_delay_sec
+        @multi_incr_udp = multi_incr_udp
+        @resume = resume
+        @management_cb = management_cb
+        @resume_policy = Resumer.new(@resume.symbolize_keys)
         # all transfer jobs, key = SecureRandom.uuid, protected by mutex, cond var on change
         @sessions = []
         # mutex protects global data accessed by threads
@@ -355,6 +374,6 @@ module Aspera
         end
         Log.log.debug{"EXIT (#{Thread.current[:name]})"}
       end
-    end # AgentDirect
+    end
   end
 end