aspera-cli 4.21.1 → 4.22.0

data/bin/ascli

@@ -9,17 +9,8 @@ Encoding.default_internal = Encoding::UTF_8
 Encoding.default_external = Encoding::UTF_8
 $VERBOSE = old_verbose
 
-begin
-  gem_lib_folder = File.join(File.dirname(File.dirname(File.realpath(__FILE__))), 'lib')
-  Kernel.load(File.join(gem_lib_folder, 'aspera/coverage.rb'))
-  begin
-    require 'aspera/cli/main'
-  rescue LoadError
-    # if in development, add path toward gem
-    $LOAD_PATH.unshift(gem_lib_folder)
-    require 'aspera/cli/main'
-  end
-  require 'aspera/environment'
-  Aspera::Environment.fix_home
-  Aspera::Cli::Main.new(ARGV).process_command_line
-end
+require 'aspera/coverage'
+require 'aspera/environment'
+require 'aspera/cli/main'
+Aspera::Environment.fix_home
+Aspera::Cli::Main.new(ARGV).process_command_line

data/bin/asession

@@ -1,9 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-gem_lib_folder = File.join(File.dirname(File.dirname(File.realpath(__FILE__))), 'lib')
-Kernel.load(File.join(gem_lib_folder, 'aspera/coverage.rb'))
-$LOAD_PATH.unshift(gem_lib_folder)
+require 'aspera/coverage'
 require 'aspera/agent/direct'
 require 'aspera/cli/extended_value'
 require 'aspera/products/transferd'

data/examples/get_proto_file.rb

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-# Retrieve `transfer.proto` from the web
-$LOAD_PATH.unshift(File.join(File.dirname(File.dirname(File.realpath(__FILE__))), 'lib'))
 require 'aspera/ascp/installation'
-Aspera::Ascp::Installation.instance.install_sdk(folder: ARGV.first, backup: false, with_exe: false) {|name| '/' if name.end_with?('transferd.proto')}
+require 'aspera/cli/transfer_progress'
+Aspera::RestParameters.instance.progress_bar = Aspera::Cli::TransferProgress.new
+# Retrieve `transfer.proto` from the web
+Aspera::Ascp::Installation.instance.install_sdk(folder: ARGV.first, backup: false, with_exe: false){ |name| name.end_with?('.proto') ? '/' : nil}

data/examples/proxy.pac

@@ -11,20 +11,20 @@ function FindProxyForURL(url, host) {
 
 	/* Don't proxy local domains */
 	if (dnsDomainIs(host, ".example1.com") || (host == "example1.com")
-			|| dnsDomainIs(host, ".example2.com") || (host == "example2.com")
-			|| dnsDomainIs(host, ".example3.com") || (host == "example3.com")) {
+		|| dnsDomainIs(host, ".example2.com") || (host == "example2.com")
+		|| dnsDomainIs(host, ".example3.com") || (host == "example3.com")) {
 		return 'DIRECT';
 	}
 
 	/* Don't proxy Windows Update */
 	if ((host == "download.microsoft.com")
-			|| (host == "ntservicepack.microsoft.com")
-			|| (host == "cdm.microsoft.com") || (host == "wustat.windows.com")
-			|| (host == "windowsupdate.microsoft.com")
-			|| (dnsDomainIs(host, ".windowsupdate.microsoft.com"))
-			|| (host == "update.microsoft.com")
-			|| (dnsDomainIs(host, ".update.microsoft.com"))
-			|| (dnsDomainIs(host, ".windowsupdate.com"))) {
+		|| (host == "ntservicepack.microsoft.com")
+		|| (host == "cdm.microsoft.com") || (host == "wustat.windows.com")
+		|| (host == "windowsupdate.microsoft.com")
+		|| (dnsDomainIs(host, ".windowsupdate.microsoft.com"))
+		|| (host == "update.microsoft.com")
+		|| (dnsDomainIs(host, ".update.microsoft.com"))
+		|| (dnsDomainIs(host, ".windowsupdate.com"))) {
 		return 'DIRECT';
 	}
 
@@ -33,22 +33,22 @@ function FindProxyForURL(url, host) {
 
 		/* Don't proxy private addresses (RFC 3330) */
 		if (isInNet(hostIP, '0.0.0.0', '255.0.0.0')
-				|| isInNet(hostIP, '10.0.0.0', '255.0.0.0')
-				|| isInNet(hostIP, '127.0.0.0', '255.0.0.0')
-				|| isInNet(hostIP, '169.254.0.0', '255.255.0.0')
-				|| isInNet(hostIP, '172.16.0.0', '255.240.0.0')
-				|| isInNet(hostIP, '192.0.2.0', '255.255.255.0')
-				|| isInNet(hostIP, '192.88.99.0', '255.255.255.0')
-				|| isInNet(hostIP, '192.168.0.0', '255.255.0.0')
-				|| isInNet(hostIP, '198.18.0.0', '255.254.0.0')
-				|| isInNet(hostIP, '224.0.0.0', '240.0.0.0')
-				|| isInNet(hostIP, '240.0.0.0', '240.0.0.0')) {
+			|| isInNet(hostIP, '10.0.0.0', '255.0.0.0')
+			|| isInNet(hostIP, '127.0.0.0', '255.0.0.0')
+			|| isInNet(hostIP, '169.254.0.0', '255.255.0.0')
+			|| isInNet(hostIP, '172.16.0.0', '255.240.0.0')
+			|| isInNet(hostIP, '192.0.2.0', '255.255.255.0')
+			|| isInNet(hostIP, '192.88.99.0', '255.255.255.0')
+			|| isInNet(hostIP, '192.168.0.0', '255.255.0.0')
+			|| isInNet(hostIP, '198.18.0.0', '255.254.0.0')
+			|| isInNet(hostIP, '224.0.0.0', '240.0.0.0')
+			|| isInNet(hostIP, '240.0.0.0', '240.0.0.0')) {
 			return 'DIRECT';
 		}
 	}
 
 	if (url.substring(0, 5) == 'http:' || url.substring(0, 6) == 'https:'
-			|| url.substring(0, 4) == 'ftp:') {
+		|| url.substring(0, 4) == 'ftp:') {
 		return 'PROXY proxy.example.com:8080';
 	}
 

data/lib/aspera/agent/base.rb

@@ -7,6 +7,7 @@ module Aspera
     # Base class for transfer agents
     class Base
       RUBY_EXT = '.rb'
+      private_constant :RUBY_EXT
       class << self
         def factory_create(agent, options)
           # Aspera.assert_values(agent, agent_list)
@@ -15,11 +16,12 @@ module Aspera
         end
 
         # discover available agents
+        # @return [Array] list of symbols of agents
         def agent_list
           base_class = File.basename(__FILE__)
           Dir.entries(File.dirname(File.expand_path(__FILE__))).select do |file|
             file.end_with?(RUBY_EXT) && !file.eql?(base_class)
-          end.map{|file|file[0..(-1 - RUBY_EXT.length)].to_sym}
+          end.map{ |file| file[0..(-1 - RUBY_EXT.length)].to_sym}
         end
       end
 
@@ -29,16 +31,20 @@ module Aspera
         statuses = wait_for_transfers_completion
         @progress&.reset
         Aspera.assert_type(statuses, Array)
-        Aspera.assert(statuses.none?{|i|!i.eql?(:success) && !i.is_a?(StandardError)}){"bad statuses content: #{statuses}"}
+        Aspera.assert(statuses.none?{ |i| !i.eql?(:success) && !i.is_a?(StandardError)}){"bad statuses content: #{statuses}"}
         return statuses
       end
 
       private
 
+      Aspera.require_method!(:start_transfer)
+      Aspera.require_method!(:wait_for_transfers_completion)
+      # method `shutdown` is optional
+      def shutdown
+        nil
+      end
+
       def initialize(progress: nil)
-        # method `shutdown` is optional
-        Aspera.assert(respond_to?(:start_transfer))
-        Aspera.assert(respond_to?(:wait_for_transfers_completion))
         @progress = progress
       end
 

data/lib/aspera/agent/connect.rb

@@ -17,6 +17,7 @@ module Aspera
       private_constant :CONNECT_START_URIS, :SLEEP_SEC_BETWEEN_RETRY
       def initialize(**base_options)
         super
+        @transfer_id = nil
         @connect_settings = {
           'app_id' => SecureRandom.uuid
         }
@@ -46,21 +47,7 @@ module Aspera
         end
       end
 
-      # @return the file path of local connect where API's URI can be read
-      def connect_api_url
-        connect_locations = Products::Other.find(Products::Connect.locations).first
-        raise "Product: #{name} not found, please install." if connect_locations.nil?
-        folder = File.join(connect_locations[:run_root], 'var', 'run')
-        ['', 's'].each do |ext|
-          uri_file = File.join(folder, "http#{ext}.uri")
-          Log.log.debug{"checking connect port file: #{uri_file}"}
-          if File.exist?(uri_file)
-            return File.open(uri_file, &:gets).strip
-          end
-        end
-        raise "no connect uri file found in #{folder}"
-      end
-
+      # :reek:UnusedParameters token_regenerator
       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}
@@ -71,15 +58,14 @@ module Aspera
             'suggestedName'           => '',
             'allowMultipleSelection'  => true,
             'allowedFileTypes'        => ''})
-          transfer_spec['paths'] = selection['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.key?('token')
         connect_transfer_args = {
           'aspera_connect_settings' => @connect_settings.merge({
-            'request_id'    => @request_id,
+            'request_id'    => SecureRandom.uuid,
             'allow_dialogs' => true
           }),
           'transfer_specs'          => [{
@@ -87,17 +73,16 @@ module Aspera
           }]}
         # asynchronous anyway
         res = @connect_api.create('transfers/start', connect_transfer_args)
-        @xfer_id = res['transfer_specs'].first['transfer_spec']['tags'][Transfer::Spec::TAG_RESERVED]['xfer_id']
+        @transfer_id = res['transfer_specs'].first['transfer_spec']['tags'][Transfer::Spec::TAG_RESERVED]['xfer_id']
       end
 
       def wait_for_transfers_completion
         connect_activity_args = {'aspera_connect_settings' => @connect_settings}
         started = false
         pre_calc = false
-        session_id = @xfer_id
         begin
           loop do
-            tr_info = @connect_api.create("transfers/info/#{@xfer_id}", connect_activity_args)
+            tr_info = @connect_api.create("transfers/info/#{@transfer_id}", connect_activity_args)
             Log.log.trace1{Log.dump(:tr_info, tr_info)}
             if tr_info['transfer_info'].is_a?(Hash)
               transfer = tr_info['transfer_info']
@@ -111,26 +96,26 @@ module Aspera
                 notify_progress(:pre_start, session_id: nil, info: transfer['status'])
               when 'running'
                 if !started
-                  notify_progress(:session_start, session_id: session_id)
+                  notify_progress(:session_start, session_id: @transfer_id)
                   started = true
                 end
                 if !pre_calc && (transfer['bytes_expected'] != 0)
-                  notify_progress(:session_size, session_id: session_id, info: transfer['bytes_expected'])
+                  notify_progress(:session_size, session_id: @transfer_id, info: transfer['bytes_expected'])
                   pre_calc = true
                 else
-                  notify_progress(:transfer, session_id: session_id, info: transfer['bytes_written'])
+                  notify_progress(:transfer, session_id: @transfer_id, info: transfer['bytes_written'])
                 end
               when 'completed'
-                notify_progress(:end, session_id: session_id)
+                notify_progress(:end, session_id: @transfer_id)
                 break
               when 'failed'
-                notify_progress(:end, session_id: session_id)
+                notify_progress(:end, session_id: @transfer_id)
                 raise Transfer::Error, transfer['error_desc']
               when 'cancelled'
-                notify_progress(:end, session_id: session_id)
+                notify_progress(:end, session_id: @transfer_id)
                 raise Transfer::Error, 'Transfer cancelled by user'
               else
-                notify_progress(:end, session_id: session_id)
+                notify_progress(:end, session_id: @transfer_id)
                 raise Transfer::Error, "unknown status: #{transfer['status']}: #{transfer['error_desc']}"
               end
             end
@@ -141,6 +126,23 @@ module Aspera
         end
         return [:success]
       end
+
+      private
+
+      # @return the file path of local connect where API's URI can be read
+      def connect_api_url
+        connect_locations = Products::Other.find(Products::Connect.locations).first
+        raise "Product: #{name} not found, please install." if connect_locations.nil?
+        folder = File.join(connect_locations[:run_root], 'var', 'run')
+        ['', 's'].each do |ext|
+          uri_file = File.join(folder, "http#{ext}.uri")
+          Log.log.debug{"checking connect port file: #{uri_file}"}
+          if File.exist?(uri_file)
+            return File.open(uri_file, &:gets).strip
+          end
+        end
+        raise "no connect uri file found in #{folder}"
+      end
     end
   end
 end

data/lib/aspera/agent/{alpha.rb → desktop.rb}

@@ -4,13 +4,13 @@ require 'aspera/agent/base'
 require 'aspera/rest'
 require 'aspera/environment'
 require 'aspera/json_rpc'
-require 'aspera/products/alpha'
+require 'aspera/products/desktop'
 require 'securerandom'
 
 module Aspera
   module Agent
-    # Aspera Desktop Alpha Client
-    class Alpha < Base
+    # Client: Aspera for Desktop
+    class Desktop < Base
       # try twice the main init url in sequence
       START_URIS = ['aspera://', 'aspera://', 'aspera://']
       # delay between each try to start the app
@@ -19,7 +19,7 @@ module Aspera
 
       def initialize(**base_options)
         @application_id = SecureRandom.uuid
-        @xfer_id = nil
+        @transfer_id = nil
         super
         raise 'Using client requires a graphical environment' if !Environment.default_gui_mode.eql?(:graphical)
         method_index = 0
@@ -33,39 +33,25 @@ module Aspera
         rescue Errno::ECONNREFUSED => e
           start_url = START_URIS[method_index]
           method_index += 1
-          raise StandardError, "Unable to start #{Products::Alpha::APP_NAME} #{method_index} times" if start_url.nil?
-          Log.log.warn{"#{Products::Alpha::APP_NAME} is not started (#{e}). Trying to start it ##{method_index}..."}
+          raise StandardError, "Unable to start #{Products::Desktop::APP_NAME} #{method_index} times" if start_url.nil?
+          Log.log.warn{"#{Products::Desktop::APP_NAME} is not started (#{e}). Trying to start it ##{method_index}..."}
           if !Environment.open_uri_graphical(start_url)
             Environment.open_uri_graphical('https://www.ibm.com/aspera/connect/')
-            raise StandardError, "#{Products::Alpha::APP_NAME} is not installed"
+            raise StandardError, "#{Products::Desktop::APP_NAME} is not installed"
           end
           sleep(SLEEP_SEC_BETWEEN_RETRY)
           retry
         end
       end
 
-      def aspera_client_api_url
-        log_file = Products::Alpha.log_file
-        url = 'http://127.0.0.1:33024'
-        File.open(log_file, 'r') do |file|
-          file.each_line do |line|
-            line = line.chomp
-            if (m = line.match(/JSON-RPC server listening on (.*)/))
-              url = "http://#{m[1]}"
-            end
-          end
-        end
-        # raise StandardError, "Unable to find the JSON-RPC server URL in #{log_file}" if url.nil?
-        return url
-      end
-
+      # :reek:UnusedParameters token_regenerator
       def start_transfer(transfer_spec, token_regenerator: nil)
         @request_id = SecureRandom.uuid
         # if there is a token, we ask the client app to use well known ssh private keys
         # instead of asking password
         transfer_spec['authentication'] = 'token' if transfer_spec.key?('token')
         result = @client_app_api.start_transfer(app_id: @application_id, desktop_spec: {}, transfer_spec: transfer_spec)
-        @xfer_id = result['uuid']
+        @transfer_id = result['uuid']
       end
 
       def wait_for_transfers_completion
@@ -73,32 +59,32 @@ module Aspera
         pre_calc = false
         begin
           loop do
-            transfer = @client_app_api.get_transfer(app_id: @application_id, transfer_id: @xfer_id)
+            transfer = @client_app_api.get_transfer(app_id: @application_id, transfer_id: @transfer_id)
             case transfer['status']
             when 'initiating', 'queued'
               notify_progress(:pre_start, session_id: nil, info: transfer['status'])
             when 'running'
               if !started
-                notify_progress(:session_start, session_id: @xfer_id)
+                notify_progress(:session_start, session_id: @transfer_id)
                 started = true
               end
               if !pre_calc && (transfer['bytes_expected'] != 0)
-                notify_progress(:session_size, session_id: @xfer_id, info: transfer['bytes_expected'])
+                notify_progress(:session_size, session_id: @transfer_id, info: transfer['bytes_expected'])
                 pre_calc = true
               else
-                notify_progress(:transfer, session_id: @xfer_id, info: transfer['bytes_written'])
+                notify_progress(:transfer, session_id: @transfer_id, info: transfer['bytes_written'])
               end
             when 'completed'
-              notify_progress(:end, session_id: @xfer_id)
+              notify_progress(:end, session_id: @transfer_id)
               break
             when 'failed'
-              notify_progress(:end, session_id: @xfer_id)
+              notify_progress(:end, session_id: @transfer_id)
               raise Transfer::Error, transfer['error_desc']
             when 'cancelled'
-              notify_progress(:end, session_id: @xfer_id)
+              notify_progress(:end, session_id: @transfer_id)
               raise Transfer::Error, 'Transfer cancelled by user'
             else
-              notify_progress(:end, session_id: @xfer_id)
+              notify_progress(:end, session_id: @transfer_id)
               raise Transfer::Error, "unknown status: #{transfer['status']}: #{transfer['error_desc']}"
             end
             sleep(1)
@@ -108,6 +94,24 @@ module Aspera
         end
         return [:success]
       end
+
+      private
+
+      # @return [String] the url where transferd is listening
+      def aspera_client_api_url
+        log_file = Products::Desktop.log_file
+        url = 'http://127.0.0.1:33024'
+        File.open(log_file, 'r') do |file|
+          file.each_line do |line|
+            line = line.chomp
+            if (m = line.match(/JSON-RPC server listening on (.*)/))
+              url = "http://#{m[1]}"
+            end
+          end
+        end
+        # raise StandardError, "Unable to find the JSON-RPC server URL in #{log_file}" if url.nil?
+        return url
+      end
     end
   end
 end