aspera-cli 4.10.0 → 4.12.0

data/lib/aspera/environment.rb

@@ -10,12 +10,16 @@ module Aspera
     OS_X = :osx
     OS_LINUX = :linux
     OS_AIX = :aix
-    OS_LIST = [OS_WINDOWS,OS_X,OS_LINUX,OS_AIX].freeze
+    OS_LIST = [OS_WINDOWS, OS_X, OS_LINUX, OS_AIX].freeze
     CPU_X86_64 = :x86_64
     CPU_PPC64 = :ppc64
     CPU_PPC64LE = :ppc64le
     CPU_S390 = :s390
-    CPU_LIST = [CPU_X86_64,CPU_PPC64,CPU_PPC64LE,CPU_S390].freeze
+    CPU_LIST = [CPU_X86_64, CPU_PPC64, CPU_PPC64LE, CPU_S390].freeze
+
+    BITS_PER_BYTE = 8
+    MEBI = 1024 * 1024
+    BYTES_PER_MEBIBIT = MEBI / BITS_PER_BYTE
 
     class << self
       def ruby_version
@@ -24,9 +28,9 @@ module Aspera
 
       def os
         case RbConfig::CONFIG['host_os']
-        when /mswin/,/msys/,/mingw/,/cygwin/,/bccwin/,/wince/,/emc/
+        when /mswin/, /msys/, /mingw/, /cygwin/, /bccwin/, /wince/, /emc/
           return OS_WINDOWS
-        when /darwin/,/mac os/
+        when /darwin/, /mac os/
           return OS_X
         when /linux/
           return OS_LINUX
@@ -39,9 +43,9 @@ module Aspera
 
       def cpu
         case RbConfig::CONFIG['host_cpu']
-        when /x86_64/,/x64/
+        when /x86_64/, /x64/
           return CPU_X86_64
-        when /powerpc/,/ppc64/
+        when /powerpc/, /ppc64/
           return CPU_PPC64LE if os.eql?(OS_LINUX)
           return CPU_PPC64
         when /s390/
@@ -65,9 +69,9 @@ module Aspera
       # on Windows, the env var %USERPROFILE% provides the path to user's home more reliably than %HOMEDRIVE%%HOMEPATH%
       # so, tell Ruby the right way
       def fix_home
-        return unless os.eql?(OS_WINDOWS) && ENV.has_key?('USERPROFILE') && Dir.exist?(ENV['USERPROFILE'])
+        return unless os.eql?(OS_WINDOWS) && ENV.key?('USERPROFILE') && Dir.exist?(ENV['USERPROFILE'])
         ENV['HOME'] = ENV['USERPROFILE']
-        Log.log.debug("Windows: set home to USERPROFILE: #{ENV['HOME']}")
+        Log.log.debug{"Windows: set home to USERPROFILE: #{ENV['HOME']}"}
       end
 
       def empty_binding
@@ -76,37 +80,35 @@ module Aspera
 
       # secure execution of Ruby code
       def secure_eval(code)
-        Kernel.send('lave'.reverse,code,empty_binding, __FILE__, __LINE__)
+        Kernel.send('lave'.reverse, code, empty_binding, __FILE__, __LINE__)
       end
 
       # value is provided in block
-      def write_file_restricted(path,force: false)
+      def write_file_restricted(path, force: false)
         raise 'coding error, missing content block' unless block_given?
         if force || !File.exist?(path)
           File.unlink(path) rescue nil # Windows may give error
-          File.write(path,yield)
+          File.write(path, yield)
           restrict_file_access(path)
         end
         return path
       end
 
-      def restrict_file_access(path,mode: nil)
-        begin
-          if mode.nil?
-            # or FileUtils ?
-            if File.file?(path)
-              mode=0600
-            elsif File.directory?(path)
-              mode=0700
-            else
-              Log.log.debug("No restriction can be set for #{path}");
-            end
+      def restrict_file_access(path, mode: nil)
+        if mode.nil?
+          # or FileUtils ?
+          if File.file?(path)
+            mode = 0o600
+          elsif File.directory?(path)
+            mode = 0o700
+          else
+            Log.log.debug{"No restriction can be set for #{path}"}
           end
-          File.chmod(mode,path) unless mode.nil?
-        rescue => e
-          Log.log.warn(e.message)
         end
+        File.chmod(mode, path) unless mode.nil?
+      rescue => e
+        Log.log.warn(e.message)
       end
-    end
-  end
-end
+    end # self
+  end # Environment
+end # Aspera

data/lib/aspera/fasp/agent_base.rb

@@ -6,6 +6,7 @@ module Aspera
     # sub classes shall implement start_transfer and shutdown
     class AgentBase
       # fields description for JSON generation
+      # spellchecker: disable
       INTEGER_FIELDS = %w[Bytescont FaspFileArgIndex StartByte Rate MinRate Port Priority RateCap MinRateCap TCPPort CreatePolicy TimePolicy
                           DatagramSize XoptFlags VLinkVersion PeerVLinkVersion DSPipelineDepth PeerDSPipelineDepth ReadBlockSize WriteBlockSize
                           ClusterNumNodes ClusterNodeId Size Written Loss FileBytes PreTransferBytes TransferBytes PMTU Elapsedusec ArgScansAttempted
@@ -13,7 +14,8 @@ module Aspera
       BOOLEAN_FIELDS = %w[Encryption Remote RateLock MinRateLock PolicyLock FilesEncrypt FilesDecrypt VLinkLocalEnabled VLinkRemoteEnabled
                           MoveRange Keepalive TestLogin UseProxy Precalc RTTAutocorrect].freeze
       EXPECTED_METHODS = %i[text struct enhanced].freeze
-      private_constant :INTEGER_FIELDS,:BOOLEAN_FIELDS,:EXPECTED_METHODS
+      private_constant :INTEGER_FIELDS, :BOOLEAN_FIELDS, :EXPECTED_METHODS
+      # spellchecker: enable
 
       class << self
         # This checks the validity of the value returned by wait_for_transfers_completion
@@ -28,13 +30,13 @@ module Aspera
 
       # translates legacy event into enhanced (JSON) event
       def enhanced_event_format(event)
-        return event.keys.each_with_object({}) do |e,h|
+        return event.keys.each_with_object({}) do |e, h|
           # capital_to_snake_case
-          new_name = e.
-              gsub(/([a-z\d])([A-Z])/,'\1_\2').
-              gsub(/([a-z\d])(usec)$/,'\1_\2').
-              gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
-              downcase
+          new_name = e
+              .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+              .gsub(/([a-z\d])(usec)$/, '\1_\2')
+              .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+              .downcase
           value = event[e]
           value = value.to_i if INTEGER_FIELDS.include?(e)
           value = value.eql?('Yes') if BOOLEAN_FIELDS.include?(e)
@@ -46,7 +48,7 @@ module Aspera
         @listeners = []
       end
 
-      def notify_listeners(current_event_text,current_event_data)
+      def notify_listeners(current_event_text, current_event_data)
         Log.log.debug('send event to listeners')
         enhanced_event = nil
         @listeners.each do |listener|
@@ -59,16 +61,16 @@ module Aspera
         end
       end # notify_listeners
 
-      def notify_begin(id,size)
-        notify_listeners('emulated',{LISTENER_SESSION_ID_B => id,'Type' => 'NOTIFICATION','PreTransferBytes' => size})
+      def notify_begin(id, size)
+        notify_listeners('emulated', {LISTENER_SESSION_ID_B => id, 'Type' => 'NOTIFICATION', 'PreTransferBytes' => size})
       end
 
-      def notify_progress(id,size)
-        notify_listeners('emulated',{LISTENER_SESSION_ID_B => id,'Type' => 'STATS','Bytescont' => size})
+      def notify_progress(id, size)
+        notify_listeners('emulated', {LISTENER_SESSION_ID_B => id, 'Type' => 'STATS', 'Bytescont' => size})
       end
 
       def notify_end(id)
-        notify_listeners('emulated',{LISTENER_SESSION_ID_B => id,'Type' => 'DONE'})
+        notify_listeners('emulated', {LISTENER_SESSION_ID_B => id, 'Type' => 'DONE'})
       end
 
       public
@@ -78,13 +80,13 @@ module Aspera
 
       # listener receives events
       def add_listener(listener)
-        raise "expect one of #{EXPECTED_METHODS}" if EXPECTED_METHODS.inject(0){|m,e|m += listener.respond_to?("event_#{e}") ? 1 : 0;m}.eql?(0)
+        raise "expect one of #{EXPECTED_METHODS}" if EXPECTED_METHODS.inject(0){|m, e|m + (listener.respond_to?("event_#{e}") ? 1 : 0)}.eql?(0)
         @listeners.push(listener)
         self
       end
 
       # the following methods must be implemented by subclass:
-      # start_transfer(transfer_spec,options) : start and wait for completion
+      # start_transfer(transfer_spec, token_regenerator: nil) : start transfer
       # wait_for_transfers_completion : wait for termination of all transfers, @return list of : :success or error message
       # optional: shutdown
     end

data/lib/aspera/fasp/agent_connect.rb

@@ -8,52 +8,54 @@ require 'tty-spinner'
 
 module Aspera
   module Fasp
-    class AgentConnect < AgentBase
-      MAX_CONNECT_START_RETRY = 3
-      SLEEP_SEC_BETWEEN_RETRY = 2
-      private_constant :MAX_CONNECT_START_RETRY,:SLEEP_SEC_BETWEEN_RETRY
+    class AgentConnect < Aspera::Fasp::AgentBase
+      CONNECT_START_URIS = ['fasp://initialize', 'fasp://initialize', 'aspera-drive://initialize', 'https://test-connect.ibmaspera.com/']
+      SLEEP_SEC_BETWEEN_RETRY = 3
+      private_constant :CONNECT_START_URIS, :SLEEP_SEC_BETWEEN_RETRY
       def initialize(_options)
         super()
         @connect_settings = {
           'app_id' => SecureRandom.uuid
         }
         raise 'Using connect requires a graphical environment' if !OpenApplication.default_gui_mode.eql?(:graphical)
-        trynumber = 0
+        method_index = 0
         begin
           connect_url = Installation.instance.connect_uri
-          Log.log.debug("found: #{connect_url}")
-          @connect_api = Rest.new({base_url: "#{connect_url}/v5/connect",headers: {'Origin' => Rest.user_agent}}) # could use v6 also now
-          cinfo = @connect_api.read('info/version')[:data]
-          Log.dump(:connect_version,cinfo)
+          Log.log.debug{"found: #{connect_url}"}
+          @connect_api = Rest.new({base_url: "#{connect_url}/v5/connect", headers: {'Origin' => Rest.user_agent}}) # could use v6 also now
+          connect_info = @connect_api.read('info/version')[:data]
+          Log.log.info('Connect was reached') if method_index > 0
+          Log.dump(:connect_version, connect_info)
         rescue StandardError => e # Errno::ECONNREFUSED
-          raise StandardError,"Unable to start connect after #{trynumber} try" if trynumber >= MAX_CONNECT_START_RETRY
-          Log.log.warn("connect is not started. Retry ##{trynumber}, err=#{e}")
-          trynumber += 1
-          if !OpenApplication.uri_graphical('fasp://initialize')
+          start_url = CONNECT_START_URIS[method_index]
+          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://downloads.asperasoft.com/connect2/')
-            raise StandardError,'Connect is not installed'
+            raise StandardError, 'Connect is not installed'
           end
           sleep(SLEEP_SEC_BETWEEN_RETRY)
           retry
         end
       end
 
-      def start_transfer(transfer_spec,_options=nil)
+      def start_transfer(transfer_spec, token_regenerator: nil)
         if transfer_spec['direction'] == 'send'
-          Log.log.warn("Connect requires upload selection using GUI, ignoring #{transfer_spec['paths']}".red)
+          Log.log.warn{"Connect requires upload selection using GUI, ignoring #{transfer_spec['paths']}".red}
           transfer_spec.delete('paths')
-          resdata = @connect_api.create('windows/select-open-file-dialog/',{
+          selection = @connect_api.create('windows/select-open-file-dialog/', {
             'aspera_connect_settings' => @connect_settings,
             'title'                   => 'Select Files',
             'suggestedName'           => '',
             'allowMultipleSelection'  => true,
             'allowedFileTypes'        => ''})[:data]
-          transfer_spec['paths'] = resdata['dataTransfer']['files'].map { |i| {'source' => i['name']}}
+          transfer_spec['paths'] = selection['dataTransfer']['files'].map { |i| {'source' => i['name']}}
         end
         @request_id = SecureRandom.uuid
         # if there is a token, we ask connect client to use well known ssh private keys
         # instead of asking password
-        transfer_spec['authentication'] = 'token' if transfer_spec.has_key?('token')
+        transfer_spec['authentication'] = 'token' if transfer_spec.key?('token')
         connect_transfer_args = {
           'aspera_connect_settings' => @connect_settings.merge({
             'request_id'    => @request_id,
@@ -63,7 +65,7 @@ module Aspera
             'transfer_spec' => transfer_spec
           }]}
         # asynchronous anyway
-        res = @connect_api.create('transfers/start',connect_transfer_args)[:data]
+        res = @connect_api.create('transfers/start', connect_transfer_args)[:data]
         @xfer_id = res['transfer_specs'].first['transfer_spec']['tags']['aspera']['xfer_id']
       end
 
@@ -73,39 +75,39 @@ module Aspera
         spinner = nil
         begin
           loop do
-            tr_info = @connect_api.create("transfers/info/#{@xfer_id}",connect_activity_args)[:data]
+            tr_info = @connect_api.create("transfers/info/#{@xfer_id}", connect_activity_args)[:data]
             if tr_info['transfer_info'].is_a?(Hash)
-              trdata = tr_info['transfer_info']
-              if trdata.nil?
+              transfer = tr_info['transfer_info']
+              if transfer.nil?
                 Log.log.warn('no session in Connect')
                 break
               end
               # TODO: get session id
-              case trdata['status']
+              case transfer['status']
               when 'completed'
                 notify_end(@connect_settings['app_id'])
                 break
-              when 'initiating','queued'
+              when 'initiating', 'queued'
                 if spinner.nil?
                   spinner = TTY::Spinner.new('[:spinner] :title', format: :classic)
                   spinner.start
                 end
-                spinner.update(title: trdata['status'])
+                spinner.update(title: transfer['status'])
                 spinner.spin
               when 'running'
-                #puts "running: sessions:#{trdata['sessions'].length}, #{trdata['sessions'].map{|i| i['bytes_transferred']}.join(',')}"
-                if !started && (trdata['bytes_expected'] != 0)
+                # puts "running: sessions:#{transfer['sessions'].length}, #{transfer['sessions'].map{|i| i['bytes_transferred']}.join(',')}"
+                if !started && (transfer['bytes_expected'] != 0)
                   spinner&.success
-                  notify_begin(@connect_settings['app_id'],trdata['bytes_expected'])
+                  notify_begin(@connect_settings['app_id'], transfer['bytes_expected'])
                   started = true
                 else
-                  notify_progress(@connect_settings['app_id'],trdata['bytes_written'])
+                  notify_progress(@connect_settings['app_id'], transfer['bytes_written'])
                 end
               when 'failed'
                 spinner&.error
-                raise Fasp::Error, trdata['error_desc']
+                raise Fasp::Error, transfer['error_desc']
               else
-                raise Fasp::Error, "unknown status: #{trdata['status']}: #{trdata['error_desc']}"
+                raise Fasp::Error, "unknown status: #{transfer['status']}: #{transfer['error_desc']}"
               end
             end
             sleep(1)