aspera-cli 4.4.0 → 4.7.0

data/lib/aspera/environment.rb

@@ -1,66 +1,71 @@
+# frozen_string_literal: true
 require 'aspera/log'
 require 'rbconfig'
 
 module Aspera
-  # detect OS, architecture, and OS specific stuff
+  # detect OS, architecture, and specific stuff
   class Environment
     OS_WINDOWS = :windows
     OS_X = :osx
     OS_LINUX = :linux
     OS_AIX = :aix
-    OS_LIST=[OS_WINDOWS,OS_X,OS_LINUX,OS_AIX]
-
-    def self.os
-      case RbConfig::CONFIG['host_os']
-      when /mswin/,/msys/,/mingw/,/cygwin/,/bccwin/,/wince/,/emc/
-        return OS_WINDOWS
-      when /darwin/,/mac os/
-        return OS_X
-      when /linux/
-        return OS_LINUX
-      when /aix/
-        return OS_AIX
-      else
-        raise "Unknown OS: #{RbConfig::CONFIG['host_os']}"
-      end
-    end
-    CPU_X86_64=:x86_64
+    OS_LIST=[OS_WINDOWS,OS_X,OS_LINUX,OS_AIX].freeze
+    CPU_X86_64=:x86_64 # rubocop:disable Naming/VariableNumber
     CPU_PPC64=:ppc64
     CPU_PPC64LE=:ppc64le
     CPU_S390=:s390
-    CPU_LIST=[CPU_X86_64,CPU_PPC64,CPU_PPC64LE,CPU_S390]
+    CPU_LIST=[CPU_X86_64,CPU_PPC64,CPU_PPC64LE,CPU_S390].freeze
 
-    def self.cpu
-      case RbConfig::CONFIG['host_cpu']
-      when /x86_64/,/x64/
-        return :x86_64
-      when /powerpc/
-        return :ppc64le if os.eql?(OS_LINUX)
-        return :ppc64
-      when /s390/
-        return :s390
-      else # other
-        raise "Unknown CPU: #{RbConfig::CONFIG['host_cpu']}"
+    class<<self
+      def ruby_version
+        return RbConfig::CONFIG['RUBY_PROGRAM_VERSION']
       end
-    end
 
-    def self.architecture
-      return "#{os}-#{cpu}"
-    end
-
-    def self.exe_extension
-      return '.exe' if os.eql?(OS_WINDOWS)
-      return ''
-    end
+      def os
+        case RbConfig::CONFIG['host_os']
+        when /mswin/,/msys/,/mingw/,/cygwin/,/bccwin/,/wince/,/emc/
+          return OS_WINDOWS
+        when /darwin/,/mac os/
+          return OS_X
+        when /linux/
+          return OS_LINUX
+        when /aix/
+          return OS_AIX
+        else
+          raise "Unknown OS: #{RbConfig::CONFIG['host_os']}"
+        end
+      end
 
-    # on Windows, the env var %USERPROFILE% provides the path to user's home more reliably than %HOMEDRIVE%%HOMEPATH%
-    def self.fix_home
-      if os.eql?(OS_WINDOWS)
-        if ENV.has_key?('USERPROFILE') and Dir.exist?(ENV['USERPROFILE'])
-          ENV['HOME']=ENV['USERPROFILE']
-          Log.log.debug("Windows: set home to USERPROFILE: #{ENV['HOME']}")
+      def cpu
+        case RbConfig::CONFIG['host_cpu']
+        when /x86_64/,/x64/
+          return CPU_X86_64
+        when /powerpc/,/ppc64/
+          return CPU_PPC64LE if os.eql?(OS_LINUX)
+          return CPU_PPC64
+        when /s390/
+          return CPU_S390
+        else # other
+          raise "Unknown CPU: #{RbConfig::CONFIG['host_cpu']}"
         end
       end
+
+      def architecture
+        return "#{os}-#{cpu}"
+      end
+
+      def exe_extension
+        return '.exe' if os.eql?(OS_WINDOWS)
+        return ''
+      end
+
+      # 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'])
+        ENV['HOME']=ENV['USERPROFILE']
+        Log.log.debug("Windows: set home to USERPROFILE: #{ENV['HOME']}")
+      end
     end
   end
 end

data/lib/aspera/fasp/{manager.rb → agent_base.rb}

@@ -1,30 +1,32 @@
+# frozen_string_literal: true
 module Aspera
   module Fasp
     # Base class for FASP transfer agents
     # sub classes shall implement start_transfer and shutdown
-    class Manager
+    class AgentBase
+      # fields description for JSON generation
+      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 ArgScansCompleted PathScansAttempted FileScansCompleted TransfersAttempted TransfersPassed Delay].freeze
+      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
 
-      # fields description for JSON generation
-      IntegerFields=['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','ArgScansCompleted','PathScansAttempted','FileScansCompleted','TransfersAttempted','TransfersPassed','Delay']
-      BooleanFields=['Encryption','Remote','RateLock','MinRateLock','PolicyLock','FilesEncrypt','FilesDecrypt','VLinkLocalEnabled','VLinkRemoteEnabled','MoveRange','Keepalive','TestLogin','UseProxy','Precalc','RTTAutocorrect']
-      ExpectedMethod=[:text,:struct,:enhanced]
-
       # translates legacy event into enhanced (JSON) event
       def enhanced_event_format(event)
-        return event.keys.inject({}) do |h,e|
+        return event.keys.each_with_object({}) do |e,h|
           # capital_to_snake_case
           new_name=e.
-          gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
-          gsub(/([a-z\d])([A-Z])/,'\1_\2').
-          gsub(/([a-z\d])(usec)$/,'\1_\2').
-          downcase
+            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 IntegerFields.include?(e)
-          value=value.eql?('Yes') ? true : false if BooleanFields.include?(e)
+          value=value.to_i if INTEGER_FIELDS.include?(e)
+          value=value.eql?('Yes') if BOOLEAN_FIELDS.include?(e)
           h[new_name]=value
-          h
         end
       end
 
@@ -33,14 +35,14 @@ module Aspera
       end
 
       def notify_listeners(current_event_text,current_event_data)
-        Log.log.debug("send event to listeners")
+        Log.log.debug('send event to listeners')
         enhanced_event=nil
         @listeners.each do |listener|
-          listener.send(:event_text,current_event_text) if listener.respond_to?(:event_text)
-          listener.send(:event_struct,current_event_data) if listener.respond_to?(:event_struct)
+          listener.event_text(current_event_text) if listener.respond_to?(:event_text)
+          listener.event_struct(current_event_data) if listener.respond_to?(:event_struct)
           if listener.respond_to?(:event_enhanced)
             enhanced_event=enhanced_event_format(current_event_data) if enhanced_event.nil?
-            listener.send(:event_enhanced,enhanced_event)
+            listener.event_enhanced(enhanced_event)
           end
         end
       end # notify_listeners
@@ -58,27 +60,28 @@ module Aspera
       end
 
       public
+
       LISTENER_SESSION_ID_B='ListenerSessionId'
       LISTENER_SESSION_ID_S='listener_session_id'
 
       # listener receives events
       def add_listener(listener)
-        raise "expect one of #{ExpectedMethod}" if ExpectedMethod.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;m}.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
-      # wait_for_transfers_completion : wait for termination of all transfers, @return list of : :success or error message
-      # optional: shutdown
-      
       # This checks the validity of the value returned by wait_for_transfers_completion
       # it must be a list of :success or exception
       def self.validate_status_list(statuses)
         raise "internal error: bad statuses type: #{statuses.class}" unless statuses.is_a?(Array)
-        raise "internal error: bad statuses content: #{statuses}" unless statuses.select{|i|!i.eql?(:success) and !i.is_a?(StandardError)}.empty?
+        raise "internal error: bad statuses content: #{statuses}" unless statuses.select{|i|!i.eql?(:success) && !i.is_a?(StandardError)}.empty?
       end
+
+      # the following methods must be implemented by subclass:
+      # start_transfer(transfer_spec,options) : start and wait for completion
+      # wait_for_transfers_completion : wait for termination of all transfers, @return list of : :success or error message
+      # optional: shutdown
     end
   end
 end

data/lib/aspera/fasp/{connect.rb → agent_connect.rb}

@@ -1,4 +1,5 @@
-require 'aspera/fasp/manager'
+# frozen_string_literal: true
+require 'aspera/fasp/agent_base'
 require 'aspera/rest'
 require 'aspera/open_application'
 require 'securerandom'
@@ -6,19 +7,15 @@ require 'tty-spinner'
 
 module Aspera
   module Fasp
-    class Connect < Manager
+    class AgentConnect < AgentBase
       MAX_CONNECT_START_RETRY=3
       SLEEP_SEC_BETWEEN_RETRY=2
       private_constant :MAX_CONNECT_START_RETRY,:SLEEP_SEC_BETWEEN_RETRY
-      def initialize
-        super
+      def initialize(_options)
+        super()
         @connect_settings={
           'app_id' => SecureRandom.uuid
         }
-        # TODO: start here and create monitor
-      end
-
-      def start_transfer(transfer_spec,options=nil)
         raise 'Using connect requires a graphical environment' if !OpenApplication.default_gui_mode.eql?(:graphical)
         trynumber=0
         begin
@@ -26,7 +23,8 @@ module Aspera
           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]
-        rescue => e # Errno::ECONNREFUSED
+          Log.dump(:connect_version,cinfo)
+        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
@@ -37,24 +35,27 @@ module Aspera
           sleep(SLEEP_SEC_BETWEEN_RETRY)
           retry
         end
+      end
+
+      def start_transfer(transfer_spec,_options=nil)
         if transfer_spec['direction'] == 'send'
           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/',{'aspera_connect_settings'=>@connect_settings,'title'=>'Select Files','suggestedName'=>'','allowMultipleSelection'=>true,'allowedFileTypes'=>''})[:data]
+          resdata=@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']}}
         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')
-        connect_settings=
         connect_transfer_args={
           'aspera_connect_settings'=>@connect_settings.merge({
           'request_id'               =>@request_id,
-          'allow_dialogs'            =>true,
+          'allow_dialogs'            =>true
           }),
           'transfer_specs'         =>[{
-          'transfer_spec'            =>transfer_spec,
+          'transfer_spec'            =>transfer_spec
           }]}
         # asynchronous anyway
         res=@connect_api.create('transfers/start',connect_transfer_args)[:data]
@@ -65,42 +66,50 @@ module Aspera
         connect_activity_args={'aspera_connect_settings'=>@connect_settings}
         started=false
         spinner=nil
-        loop do
-          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?
-              Log.log.warn("no session in Connect")
-              break
-            end
-            # TODO: get session id
-            case trdata['status']
-            when 'completed'
-              notify_end(@connect_settings['app_id'])
-              break
-            when 'initiating','queued'
-              if spinner.nil?
-                spinner = TTY::Spinner.new('[:spinner] :title', format: :classic)
-                spinner.start
+        begin
+          loop do
+            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?
+                Log.log.warn('no session in Connect')
+                break
               end
-              spinner.update(title: trdata['status'])
-              spinner.spin
-            when 'running'
-              #puts "running: sessions:#{trdata['sessions'].length}, #{trdata['sessions'].map{|i| i['bytes_transferred']}.join(',')}"
-              if !started and trdata['bytes_expected'] != 0
-                notify_begin(@connect_settings['app_id'],trdata['bytes_expected'])
-                started=true
+              # TODO: get session id
+              case trdata['status']
+              when 'completed'
+                notify_end(@connect_settings['app_id'])
+                break
+              when 'initiating','queued'
+                if spinner.nil?
+                  spinner = TTY::Spinner.new('[:spinner] :title', format: :classic)
+                  spinner.start
+                end
+                spinner.update(title: trdata['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)
+                  spinner.success unless spinner.nil?
+                  notify_begin(@connect_settings['app_id'],trdata['bytes_expected'])
+                  started=true
+                else
+                  notify_progress(@connect_settings['app_id'],trdata['bytes_written'])
+                end
+              when 'failed'
+                spinner.error unless spinner.nil?
+                raise Fasp::Error, trdata['error_desc']
               else
-                notify_progress(@connect_settings['app_id'],trdata['bytes_written'])
+                raise Fasp::Error, "unknown status: #{trdata['status']}: #{trdata['error_desc']}"
               end
-            else
-              raise Fasp::Error.new("unknown status: #{trdata['status']}: #{trdata['error_desc']}")
             end
+            sleep 1
           end
-          sleep 1
+        rescue StandardError => e
+          return [e]
         end
-        return [] #TODO
+        return [:success]
       end # wait
-    end # Connect
+    end # AgentConnect
   end
 end