aspera-cli 4.24.0 → 4.24.2

data/lib/aspera/log.rb

@@ -15,14 +15,22 @@ $VERBOSE = nil
 
 # Extend Ruby logger with trace levels
 class Logger
-  # Two additionnal trace levels
+  # Two additional trace levels
   TRACE_MAX = 2
+
   # Add custom level to logger severity, below debug level
   module Severity
     1.upto(TRACE_MAX).each{ |level| const_set(:"TRACE#{level}", - level)}
   end
-  # Quick access to label
+
+  # Hash
+  # key   [Integer] Log level (e.g. 0 for DEBUG)
+  # value [Symbol]  Uppercase log level label (e.g. :DEBUG)
   SEVERITY_LABEL = Severity.constants.each_with_object({}){ |name, hash| hash[Severity.const_get(name)] = name}
+
+  # Override
+  # @param severity [Integer] Log severity as int
+  # @return [String] Log severity upper case label
   def format_severity(severity)
     SEVERITY_LABEL[severity] || 'ANY'
   end
@@ -51,34 +59,23 @@ module Aspera
 
     # Where logs are sent to
     LOG_TYPES = %i[stderr stdout syslog].freeze
-    DEFAULT_FORMATTER = ->(s, _d, _p, m){"#{Log.color_level(s)} #{m}\n"}
-    FORMATTERS = {
-      standard: Logger::Formatter.new,
-      default:  DEFAULT_FORMATTER
-    }.freeze
+
+    # Levels are :trace2,:trace1,:debug,:info,:warn,:error,fatal,:unknown
+    LEVELS = Logger::Severity.constants.sort{ |a, b| Logger::Severity.const_get(a) <=> Logger::Severity.const_get(b)}.map{ |c| c.downcase.to_sym}.freeze
+
     # Class methods
     class << self
-      def color_level(level)
-        case level
-        when :TRACE2 then 'TR2'.dim
-        when :TRACE1 then 'TR1'.blue
-        when :DEBUG then 'DBG'.cyan
-        when :INFO  then 'INF'.green
-        when :WARN  then 'WRN'.bg_brown.black
-        when :ERROR then 'ERR'.bg_red.blink
-        when :FATAL then 'FTL'.magenta
-        when :UNKNOWN then 'UKN'.blink
-        else Aspera.error_unexpected_value(level){'log level'}
-        end
+      # Applies the provided list of string decoration (colors) to the value.
+      # @param value [String]         Value to enhance.
+      # @param colors [Array(Symbol)] List of decorations
+      def apply_colors(value, colors)
+        colors.inject(value){ |s, c| s.send(c)}
       end
 
-      # levels are :debug,:info,:warn,:error,fatal,:unknown
-      def levels; Logger::Severity.constants.sort{ |a, b| Logger::Severity.const_get(a) <=> Logger::Severity.const_get(b)}.map{ |c| c.downcase.to_sym}; end
-
-      # get the logger object of singleton
+      # Get the logger object of singleton
       def log; instance.logger; end
 
-      # Dump object (`Hash`) using specified level
+      # Dump object (`Hash`) to log using specified level
       #
       # @param name   [String, Symbol]  Name of object dumped
       # @param object [Hash, nil]       Data to dump
@@ -90,14 +87,16 @@ module Aspera
         instance.logger.send(level, obj_dump(name, object))
       end
 
+      # @return [String] Dump of object
       def obj_dump(name, object)
-        dump_text = case instance.dump_format
-        when :json
-          JSON.pretty_generate(object) rescue PP.pp(object, +'')
-        when :ruby
-          PP.pp(object, +'')
-        else error_unexpected_value(instance.dump_format){'dump format'}
-        end
+        dump_text =
+          case instance.dump_format
+          when :json
+            JSON.pretty_generate(object) rescue PP.pp(object, +'')
+          when :ruby
+            PP.pp(object, +'')
+          else error_unexpected_value(instance.dump_format){'dump format'}
+          end
         "#{name.to_s.green} (#{instance.dump_format})=\n#{dump_text}"
       end
 
@@ -110,6 +109,31 @@ module Aspera
       ensure
         $stderr = real_stderr
       end
+
+      # Returns the last 2 containers (module/class) and method caller
+      def caller_method
+        stack = caller
+        i = stack.rindex{ |line| line.include?('Logger')}
+        frame = stack[i + 1] if i && stack[i + 1]
+        return '???' unless frame
+        # Extract the "Class::Module::Method" or "Class#method" part
+        full = frame[/'([^']+)'/, 1]
+        return '???' unless full
+        # Split into class/module and method parts
+        parts = full.split(/(::|#)/)
+        # Reconstruct keeping only last two class/module names + separator + method
+        if parts.include?('#')
+          sep_index = parts.index('#')
+          classes = parts[0...sep_index].join
+          method = parts[sep_index + 1]
+        else
+          classes = parts[0..-2].join
+          method = parts.last
+        end
+        class_parts = classes.split('::')
+        selected_classes = class_parts.last(2).join('::')
+        "#{selected_classes}.#{method}"
+      end
     end
 
     attr_reader :logger_type, :logger
@@ -121,7 +145,9 @@ module Aspera
     end
 
     # Set log level of underlying logger given symbol level
+    # @param new_level [Symbol] One of LEVELS
     def level=(new_level)
+      Aspera.assert_values(new_level, LEVELS)
       @logger.level = Logger::Severity.const_get(new_level.to_sym.upcase)
     end
 
@@ -141,11 +167,10 @@ module Aspera
     end
 
     # Get symbol of debug level of underlying logger
+    # @return [Symbol] One of LEVELS
     def level
-      Logger::Severity.constants.each do |name|
-        return name.downcase.to_sym if @logger.level.eql?(Logger::Severity.const_get(name))
-      end
-      Aspera.error_unexpected_value(@logger.level){'log level'}
+      Aspera.assert(Logger::SEVERITY_LABEL.key?(@logger.level))
+      Logger::SEVERITY_LABEL[@logger.level].downcase
     end
 
     # Change underlying logger, but keep log level
@@ -160,8 +185,8 @@ module Aspera
         @logger = Logger.new($stdout, progname: @program_name, formatter: DEFAULT_FORMATTER)
       when :syslog
         require 'syslog/logger'
-        # the syslog class automatically creates methods from the severity names
-        # we just need to add the mapping (but syslog lowest is DEBUG)
+        # The syslog class automatically creates methods from the severity names.
+        # We just need to add the mapping (but syslog lowest is DEBUG)
         1.upto(Logger::TRACE_MAX).each do |level|
           Syslog::Logger.const_get(:LEVEL_MAP)[Logger.const_get("TRACE#{level}")] = Syslog::LOG_DEBUG
         end
@@ -188,5 +213,31 @@ module Aspera
       # This sets @logger and @logger_type (self needed to call method instead of local var)
       self.logger_type = @logger_type
     end
+
+    # Define decoration of levels
+    LVL_DECO = {
+      TRACE2:  %i{dim},
+      TRACE1:  %i{blue},
+      DEBUG:   %i{cyan},
+      INFO:    %i{green},
+      WARN:    %i{bg_brown black},
+      ERROR:   %i{bg_red blink},
+      FATAL:   %i{magenta},
+      UNKNOWN: %i{blink}
+    }.freeze
+
+    # Short levels with color
+    LVL_COLOR = LVL_DECO.map{ |k, v| [k, apply_colors("#{k[..2]}#{k[-1]}", v)]}.to_h.freeze
+
+    DEFAULT_FORMATTER = ->(s, _d, _p, m){"#{LVL_COLOR[s]} #{m}\n"}
+
+    # pre-defined formatters
+    FORMATTERS = {
+      standard: Logger::Formatter.new,
+      default:  DEFAULT_FORMATTER,
+      caller:   ->(s, _d, _p, m){"#{LVL_COLOR[s]} #{Log.caller_method}\n#{m}\n"}
+    }.freeze
+
+    private_constant :LVL_DECO, :LVL_COLOR, :DEFAULT_FORMATTER, :FORMATTERS
   end
 end

data/lib/aspera/nagios.rb

@@ -57,7 +57,7 @@ module Aspera
     # compare remote time with local time
     def check_time_offset(remote_date, component)
       # check date if specified : 2015-10-13T07:32:01Z
-      remote_time = Time.strptime(remote_date)
+      remote_time = Time.parse(remote_date)
       diff_time = (remote_time - Time.now).abs
       diff_rounded = diff_time.round(-2)
       Log.log.debug{"DATE: #{remote_date} #{remote_time} diff=#{diff_rounded}"}

data/lib/aspera/oauth/base.rb

@@ -13,6 +13,7 @@ module Aspera
     # OAuth 2.0 Authorization Framework: https://tools.ietf.org/html/rfc6749
     # Bearer Token Usage: https://tools.ietf.org/html/rfc6750
     class Base
+      Aspera.require_method!(:create_token)
       # @param **             Parameters for REST
       # @param client_id      [String, nil]
       # @param client_secret  [String, nil]
@@ -31,8 +32,7 @@ module Aspera
         cache_ids: nil,
         **rest_params
       )
-        Aspera.assert(respond_to?(:create_token), 'create_token method must be defined', type: InternalError)
-        # this is the OAuth API
+        # This is the OAuth API
         @api = Rest.new(**rest_params)
         @scope = nil
         @token_cache_id = nil
@@ -43,6 +43,7 @@ module Aspera
         @use_query = use_query
         @base_cache_ids = cache_ids.nil? ? [] : cache_ids.clone
         Aspera.assert_type(@base_cache_ids, Array)
+        # TODO: this shall be done in class, using cache_ids
         @base_cache_ids.push(@api.auth_params[:username]) if @api.auth_params.key?(:username)
         @base_cache_ids.compact!
         @base_cache_ids.freeze
@@ -56,16 +57,20 @@ module Aspera
         @token_cache_id = Factory.cache_id(@api.base_url, self.class, @base_cache_ids, @scope)
       end
 
-      attr_reader :scope, :api, :path_token
+      attr_reader :scope, :api, :path_token, :client_id
 
       # helper method to create token as per RFC
       def create_token_call(creation_params)
         Log.log.debug{'Generating a new token'.bg_green}
-        payload = {content_type: Rest::MIME_WWW}
-        if @use_query
-          payload[:query] = creation_params
+        payload = if @use_query
+          {
+            query: creation_params
+          }
         else
-          payload[:body] = creation_params
+          {
+            content_type: Rest::MIME_WWW,
+            body:         creation_params
+          }
         end
         return @api.call(
           operation: 'POST',
@@ -75,12 +80,13 @@ module Aspera
         )
       end
 
-      # @return Hash with optional general parameters
+      # @param add_secret [Boolean] Add secret in default call parameters
+      # @return [Hash] Optional general parameters
       def optional_scope_client_id(add_secret: false)
         call_params = {}
         call_params[:scope] = @scope unless @scope.nil?
         call_params[:client_id] = @client_id unless @client_id.nil?
-        call_params[:client_secret] = @client_secret if add_secret && !@client_id.nil?
+        call_params[:client_secret] = @client_secret unless !add_secret || @client_id.nil? || @client_secret.nil?
         return call_params
       end
 
@@ -106,6 +112,7 @@ module Aspera
           # `direct` agent is equipped with refresh code
           # an API was already called, but failed, we need to regenerate or refresh
           if refresh || token_info[:expired]
+            Log.log.trace1{"refresh: #{refresh} expired: #{token_info[:expired]}"}
             refresh_token = nil
             if token_data.key?('refresh_token') && !token_data['refresh_token'].eql?('not_supported')
               # save possible refresh token, before deleting the cache
@@ -118,7 +125,7 @@ module Aspera
             if !refresh_token.nil?
               Log.log.info{"refresh=[#{refresh_token}]".bg_green}
               # NOTE: AoC admin token has no refresh, and lives by default 1800secs
-              resp = create_token_call(optional_scope_client_id.merge(grant_type: 'refresh_token', refresh_token: refresh_token))
+              resp = create_token_call(optional_scope_client_id(add_secret: true).merge(grant_type: 'refresh_token', refresh_token: refresh_token))
               if resp[:http].code.start_with?('2')
                 # save only if success
                 json_data = resp[:http].body

data/lib/aspera/oauth/factory.rb

@@ -63,10 +63,10 @@ module Aspera
         @decoders = []
         # default parameters, others can be added by handlers
         @parameters = {
-          # tokens older than 30 minutes will be discarded from cache
-          token_cache_expiry_sec:     1800,
-          # tokens valid for less than this duration will be regenerated
-          token_expiration_guard_sec: 120
+          # tokens older than this duration in sec. will be discarded from cache
+          token_cache_max_age:     1800,
+          # tokens valid for less than this duration in sec. will be regenerated
+          token_refresh_threshold: 120
         }
       end
 
@@ -77,7 +77,7 @@ module Aspera
       def persist_mgr=(manager)
         @persist = manager
         # cleanup expired tokens
-        @persist.garbage_collect(PERSIST_CATEGORY_TOKEN, @parameters[:token_cache_expiry_sec])
+        @persist.garbage_collect(PERSIST_CATEGORY_TOKEN, @parameters[:token_cache_max_age])
       end
 
       def persist_mgr
@@ -108,7 +108,7 @@ module Aspera
         end
       end
 
-      # get token information from cache
+      # Get token information from cache
       # @param id [String] identifier of token
       # @return [Hash] token internal information , including Date object for `expiration_date`
       def get_token_info(id)
@@ -118,7 +118,6 @@ module Aspera
         Aspera.assert_type(token_data, Hash)
         decoded_token = decode_token(token_data[TOKEN_FIELD])
         info = {data: token_data}
-        Log.dump(:decoded_token, decoded_token)
         if decoded_token.is_a?(Hash)
           info[:decoded] = decoded_token
           # TODO: move date decoding to token decoder ?
@@ -129,9 +128,10 @@ module Aspera
           unless expiration_date.nil?
             info[:expiration] = expiration_date
             info[:ttl_sec] = expiration_date - Time.now
-            info[:expired] = info[:ttl_sec] < @parameters[:token_expiration_guard_sec]
+            info[:expired] = info[:ttl_sec] < @parameters[:token_refresh_threshold]
           end
         end
+        Log.dump(:token_info, info)
         return info
       end
 

data/lib/aspera/oauth/web.rb

@@ -9,7 +9,7 @@ module Aspera
     # Authentication using Web browser
     class Web < Base
       class << self
-        attr_accessor :additionnal_info
+        attr_accessor :additional_info
       end
       # @param redirect_uri    url to receive the code after auth (to be exchanged for token)
       # @param path_authorize  path to login page on web app
@@ -37,7 +37,7 @@ module Aspera
         # here, we need a human to authorize on a web page
         Log.log.info{"login_page_url=#{login_page_url}".bg_red.gray}
         # start a web server to receive request code
-        web_server = WebAuth.new(@redirect_uri, self.class.additionnal_info)
+        web_server = WebAuth.new(@redirect_uri, self.class.additional_info)
         # start browser on login page
         Environment.instance.open_uri(login_page_url)
         # wait for code in request

data/lib/aspera/products/connect.rb

@@ -48,11 +48,12 @@ module Aspera
         end
       end
 
+      # Base URL for CDN of Connect
       def cdn_api
         Rest.new(base_url: CDN_BASE_URL)
       end
 
-      # retrieve structure from cloud (CDN) with all versions available
+      # Retrieve structure from cloud (CDN) with all versions available
       def versions
         if @connect_versions.nil?
           javascript = cdn_api.call(operation: 'GET', subpath: VERSION_INFO_FILE)
@@ -74,10 +75,10 @@ module Aspera
         @connect_versions = nil
       end
 
-      VERSION_INFO_FILE = 'connectversions.js' # cspell: disable-line
       CDN_BASE_URL = 'https://d3gcli72yxqn2z.cloudfront.net/connect'
+      VERSION_INFO_FILE = 'connectversions.js' # cspell: disable-line
 
-      private_constant :VERSION_INFO_FILE, :CDN_BASE_URL
+      private_constant :CDN_BASE_URL, :VERSION_INFO_FILE
     end
   end
 end

data/lib/aspera/products/desktop.rb

@@ -8,6 +8,7 @@ module Aspera
     class Desktop
       APP_NAME = 'IBM Aspera for Desktop'
       APP_IDENTIFIER = 'com.ibm.software.aspera.desktop'
+      LOG_FILENAME = 'ibm-aspera-desktop.log'
       class << self
         # standard folder locations
         def locations
@@ -20,10 +21,6 @@ module Aspera
           else []
           end.map{ |i| i.merge({expected: APP_NAME})}
         end
-
-        def log_file
-          File.join(Dir.home, 'Library', 'Logs', APP_IDENTIFIER, 'ibm-aspera-desktop.log')
-        end
       end
     end
   end

data/lib/aspera/products/other.rb

@@ -54,8 +54,14 @@ module Aspera
       }]
       end
       class << self
+        # Find installed products and provide paths for it.
+        # @param scan_locations [Array] Array of Hash with keys: expected, app_root, sub_bin, ascp_path, name, version
+        # @return [Array] of products found, with filled missing fields
+        # @raise Exception if no installed product found
         def find(scan_locations)
-          scan_locations.select do |item|
+          product_names = []
+          found = scan_locations.select do |item|
+            product_names.push(item[:expected]) unless product_names.include?(item[:expected])
             # skip if not main folder
             Log.log.trace1{"Checking #{item[:app_root]}"}
             next false unless Dir.exist?(item[:app_root])
@@ -75,6 +81,8 @@ module Aspera
             end
             true # select this version
           end
+          raise "Product: #{product_names.join(', ')} not found, please install." if found.empty?
+          found
         end
       end
     end

data/lib/aspera/products/transferd.rb

@@ -30,7 +30,6 @@ module Aspera
         # @return the path to folder where SDK is installed
         def sdk_directory
           Aspera.assert(!@sdk_dir.nil?){'SDK path was not initialized'}
-          FileUtils.mkdir_p(@sdk_dir)
           @sdk_dir
         end