aspera-cli 4.26.1 → 4.27.0

data/lib/aspera/oauth/factory.rb

@@ -7,10 +7,14 @@ require 'base64'
 module Aspera
   module OAuth
     # Factory to create tokens and manage their cache
+    #
+    # @!method self.instance
+    #   Returns the singleton instance of Factory
+    #   @return [Factory] the singleton instance
     class Factory
       include Singleton
 
-      # a prefix for persistency of tokens (simplify garbage collect)
+      # prefix for persistency of tokens (simplify garbage collect)
       PERSIST_CATEGORY_TOKEN = 'token'
       # prefix for bearer authorization when in header
       SPACE_BEARER_AUTH_SCHEME = 'Bearer '
@@ -19,18 +23,23 @@ module Aspera
       private_constant :PERSIST_CATEGORY_TOKEN, :SPACE_BEARER_AUTH_SCHEME
 
       class << self
+        # Format a token for use in Authorization header
         # @param token [String] The token alone
         # @return [String] Value suitable for Authorization header
         def bearer_authorization(token)
           return "#{SPACE_BEARER_AUTH_SCHEME}#{token}"
         end
 
-        # @return true if the authorization contains a bearer token , i.e. auth scheme is bearer
+        # Check if the authorization contains a bearer token
+        # @param authorization [String] The authorization header value
+        # @return [Boolean] true if the authorization contains a bearer token, i.e. auth scheme is bearer
         def bearer_auth?(authorization)
           return authorization.start_with?(SPACE_BEARER_AUTH_SCHEME)
         end
 
         # Extract only token from Authorization (remove scheme)
+        # @param authorization [String] The authorization header value
+        # @return [String] The bearer token without the scheme prefix
         def bearer_token(authorization)
           Aspera.assert(bearer_auth?(authorization)){'not a bearer token, wrong prefix scheme'}
           return authorization.delete_prefix(SPACE_BEARER_AUTH_SCHEME)
@@ -40,12 +49,14 @@ module Aspera
         # @param url           [String] Base URL of the OAuth server
         # @param creator_class [Class]  Class of the token creator
         # @param params        [Array]  List of parameters (can be nested) to uniquely identify the token
-        # @return a unique cache identifier
+        # @return [String] a unique cache identifier
         def cache_id(url, creator_class, *params)
           return IdGenerator.from_list(PERSIST_CATEGORY_TOKEN, url, Factory.class_to_id(creator_class), params)
         end
 
-        # @return snake version of class name
+        # Convert a class name to snake_case symbol
+        # @param creator_class [Class] The class to convert
+        # @return [Symbol] snake_case version of class name
         def class_to_id(creator_class)
           return creator_class.name.split('::').last.capital_to_snake.to_sym
         end
@@ -53,6 +64,7 @@ module Aspera
 
       private
 
+      # Initialize the factory with default parameters and empty collections
       def initialize
         # persistency manager
         @persist = nil
@@ -73,12 +85,16 @@ module Aspera
 
       attr_reader :parameters
 
+      # Set the persistence manager for token caching
+      # @param manager [Object] The persistence manager instance
       def persist_mgr=(manager)
         @persist = manager
         # cleanup expired tokens
         @persist.garbage_collect(PERSIST_CATEGORY_TOKEN, @parameters[:token_cache_max_age])
       end
 
+      # Get or initialize the persistence manager
+      # @return [Object] The persistence manager instance
       def persist_mgr
         if @persist.nil?
           # use OAuth::Factory.instance.persist_mgr=PersistencyFolder.new)
@@ -91,16 +107,19 @@ module Aspera
         return @persist
       end
 
-      # delete all existing tokens
+      # Delete all existing tokens in cache
+      # @return [Array<String>] List of deleted file paths
       def flush_tokens
         persist_mgr.garbage_collect(PERSIST_CATEGORY_TOKEN)
       end
 
+      # Retrieve all persisted tokens with their decoded information
+      # @return [Array<Hash>] Array of token information hashes
       def persisted_tokens
         data = persist_mgr.current_items(PERSIST_CATEGORY_TOKEN)
         data.each.map do |k, v|
           info = {id: k}
-          info.merge!(JSON.parse(v)) rescue nil
+          begin; info.merge!(JSON.parse(v)); rescue StandardError; nil; end
           d = decode_token(info.delete(TOKEN_FIELD))
           info.merge(d) if d
           info
@@ -134,32 +153,39 @@ module Aspera
         return info
       end
 
-      # register a bearer token decoder, mainly to inspect expiry date
+      # Register a bearer token decoder for inspecting token properties
+      # @param method [Proc] The decoder lambda/proc to register
+      # @return [nil]
       def register_decoder(method)
         @decoders.push(method)
+        nil
       end
 
-      # decode token using all registered decoders
+      # Decode a token using all registered decoders
+      # @param token [String] The token to decode
+      # @return [Hash, nil] Decoded token data or nil if no decoder succeeded
       def decode_token(token)
         @decoders.each do |decoder|
-          result = decoder.call(token) rescue nil
+          result = begin; decoder.call(token); rescue StandardError; nil; end
           return result unless result.nil?
         end
         return
       end
 
-      # register a token creation method
-      # @param id creation type from field :grant_method in constructor
-      # @param lambda_create called to create token
-      # @param id_create called to generate unique id for token, for cache
+      # Register a token creation method
+      # @param creator_class [Class] The token creator class to register
+      # @return [nil]
       def register_token_creator(creator_class)
         Aspera.assert_type(creator_class, Class)
         id = Factory.class_to_id(creator_class)
         Log.log.debug{"registering creator for #{id}"}
         @token_type_classes[id] = creator_class
+        nil
       end
 
-      # @return one of the registered creators for the given create type
+      # Create a token creator instance for the specified grant method
+      # @param parameters [Hash] Parameters including :grant_method and creator-specific options
+      # @return [Object] An instance of the registered token creator class
       def create(**parameters)
         Aspera.assert_type(parameters, Hash)
         id = parameters[:grant_method]
@@ -169,6 +195,6 @@ module Aspera
       end
     end
     # JSON Web Signature (JWS) compact serialization: https://datatracker.ietf.org/doc/html/rfc7515
-    Factory.instance.register_decoder(lambda{ |token| parts = token.split('.'); Aspera.assert(parts.length.eql?(3)){'not JWS token'}; JSON.parse(Base64.decode64(parts[1]))}) # rubocop:disable Style/Semicolon
+    Factory.instance.register_decoder(lambda{ |token| parts = token.split('.'); Aspera.assert_values(parts.length, [3]){'JWS token parts'}; JSON.parse(Base64.decode64(parts[1]))}) # rubocop:disable Style/Semicolon
   end
 end

data/lib/aspera/oauth/jwt.rb

@@ -26,9 +26,9 @@ module Aspera
       end
       DEFAULT_PRIV_KEY_LENGTH = 4096
       GRANT_TYPE = 'urn:ietf:params:oauth:grant-type:jwt-bearer'
-      # @param private_key_obj private key object
-      # @param payload payload to be included in the JWT
-      # @param headers headers to be included in the JWT
+      # @param private_key_obj [OpenSSL::PKey::RSA] private key object
+      # @param payload         [Hash] payload to be included in the JWT
+      # @param headers         [Hash] headers to be included in the JWT
       def initialize(
         private_key_obj:,
         payload:,
@@ -49,7 +49,7 @@ module Aspera
 
       def create_token
         require 'jwt'
-        seconds_since_epoch = Time.new.to_i
+        seconds_since_epoch = Time.now.to_i
         Log.log.debug{"seconds_since_epoch=#{seconds_since_epoch}"}
         jwt_payload = {
           exp: seconds_since_epoch + OAuth::Factory.instance.parameters[:jwt_expiry_offset_sec], # expiration time

data/lib/aspera/oauth/web.rb

@@ -11,8 +11,8 @@ module Aspera
       class << self
         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
+      # @param redirect_uri   [String] url to receive the code after auth (to be exchanged for token)
+      # @param path_authorize [String] path to login page on web app
       def initialize(
         redirect_uri:,
         path_authorize: 'authorize',
@@ -22,8 +22,8 @@ module Aspera
         @redirect_uri = redirect_uri
         @path_authorize = path_authorize
         uri = URI.parse(@redirect_uri)
-        Aspera.assert(%w[http https].include?(uri.scheme)){'redirect_uri scheme must be http or https'}
-        Aspera.assert(!uri.port.nil?){'redirect_uri must have a port'}
+        Aspera.assert_values(uri.scheme, %w[http https]){'redirect_uri scheme must be http or https'}
+        Aspera.assert(!uri.port.nil?, 'redirect_uri must have a port')
         # TODO: we could check that host is localhost or local address, as we are going to listen locally
       end
 

data/lib/aspera/oauth.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'aspera/oauth/factory'
+require 'aspera/oauth/boot'
 require 'aspera/oauth/generic'
 require 'aspera/oauth/jwt'
 require 'aspera/oauth/web'

data/lib/aspera/persistency_action_once.rb

@@ -14,18 +14,18 @@ module Aspera
     MANAGER_METHODS = %i[get put delete]
     private_constant :DELETE_DEFAULT, :PARSE_DEFAULT, :FORMAT_DEFAULT, :MERGE_DEFAULT, :MANAGER_METHODS
 
-    # @param :manager  Mandatory Database
-    # @param :data     Mandatory object to persist, must be same object from begin to end (assume array by default)
-    # @param :id       Mandatory identifiers
-    # @param :delete   Optional  delete persistency condition
-    # @param :parse    Optional  parse method (default to JSON)
-    # @param :format   Optional  dump method (default to JSON)
-    # @param :merge    Optional  merge data from file to current data
+    # @param manager [Object]  Mandatory Database (must respond to get/put/delete)
+    # @param data    [Object]  Mandatory object to persist, must be same object from begin to end (assume array by default)
+    # @param id      [String]  Mandatory identifier
+    # @param delete  [Proc]    Optional delete persistency condition
+    # @param parse   [Proc]    Optional parse method (default to JSON)
+    # @param format  [Proc]    Optional dump method (default to JSON)
+    # @param merge   [Proc]    Optional merge data from file to current data
     def initialize(manager:, data:, id:, delete: DELETE_DEFAULT, parse: PARSE_DEFAULT, format: FORMAT_DEFAULT, merge: MERGE_DEFAULT)
       Aspera.assert(MANAGER_METHODS.all?{ |i| manager.respond_to?(i)}){"Manager must answer to #{MANAGER_METHODS}"}
-      Aspera.assert(!data.nil?)
+      Aspera.assert(!data.nil?, 'data must not be nil')
       Aspera.assert_type(id, String)
-      Aspera.assert(!id.empty?)
+      Aspera.assert(!id.empty?, 'id must not be empty')
       Aspera.assert_type(delete, Proc)
       Aspera.assert_type(parse, Proc)
       Aspera.assert_type(format, Proc)
@@ -48,7 +48,7 @@ module Aspera
       end
     end
 
-    # @return internal persisted object, in order to modify its content
+    # @return [Array, Hash] internal persisted object, in order to modify its content
     def data
       return @persisted_object
     end

data/lib/aspera/persistency_folder.rb

@@ -19,7 +19,8 @@ module Aspera
     end
 
     # Get value of persisted item
-    # @return [String,nil] Value of persisted id
+    # @param object_id [String] Identifier of persisted item
+    # @return [String, nil] Persisted value, or nil if not found
     def get(object_id)
       Log.log.debug{"persistency get: #{object_id}"}
       if @cache.key?(object_id)
@@ -59,7 +60,10 @@ module Aspera
       @cache.delete(object_id)
     end
 
-    # Delete persisted items
+    # Delete persisted items matching the given category, optionally older than a given age
+    # @param persist_category [String]       Prefix used to identify files belonging to the category
+    # @param max_age_seconds  [Integer, nil] If set, only delete files older than this many seconds
+    # @return [Array<String>] List of deleted file paths
     def garbage_collect(persist_category, max_age_seconds = nil)
       garbage_files = current_files(persist_category)
       if !max_age_seconds.nil?
@@ -74,6 +78,9 @@ module Aspera
       return garbage_files
     end
 
+    # List all persisted files matching the given category prefix
+    # @param persist_category [String] Prefix identifying the category
+    # @return [Array<String>] List of matching file paths
     def current_files(persist_category)
       Dir[File.join(@folder, "#{persist_category}*#{FILE_SUFFIX}")]
     end
@@ -84,7 +91,7 @@ module Aspera
 
     private
 
-    # @param object_id String or Array
+    # @param object_id [String, Array] identifier or list of identifiers
     def id_to_filepath(object_id)
       Aspera.assert_type(object_id, String)
       FileUtils.mkdir_p(@folder)

data/lib/aspera/preview/file_types.rb

@@ -8,6 +8,10 @@ require 'marcel'
 module Aspera
   module Preview
     # function conversion_type returns one of the types: CONVERSION_TYPES
+    #
+    # @!method self.instance
+    #   Returns the singleton instance of FileTypes
+    #   @return [FileTypes] the singleton instance
     class FileTypes
       include Singleton
 
@@ -74,7 +78,7 @@ module Aspera
 
       # @param filepath [String] Full path to file
       # @param mimetype [String] MIME typre provided by node API
-      # @return file type, one of enum CONVERSION_TYPES
+      # @return [Symbol] file type, one of enum CONVERSION_TYPES
       # @raise [RuntimeError] if no conversion type found
       def conversion_type(filepath, mimetype)
         Log.log.debug{"conversion_type(#{filepath},mime=#{mimetype},magic=#{@use_mimemagic})"}
@@ -82,9 +86,9 @@ module Aspera
         mimetype = TYPE_NOT_FOUND if mimetype.nil? || (mimetype.is_a?(String) && mimetype.empty?)
         mimetype = Marcel::MimeType.for(Pathname.new(filepath), name: File.basename(filepath), declared_type: mimetype)
         mimetype = 'text/plain' if mimetype.eql?(TYPE_NOT_FOUND) && ascii_text_file?(filepath)
-        raise "no MIME type found for #{File.basename(filepath)}" if mimetype.eql?(TYPE_NOT_FOUND)
+        Aspera.assert(!mimetype.eql?(TYPE_NOT_FOUND)){"no MIME type found for #{File.basename(filepath)}"}
         conversion_type = mime_to_type(mimetype)
-        raise "no conversion type found for #{File.basename(filepath)}" if conversion_type.nil?
+        Aspera.assert(!conversion_type.nil?){"no conversion type found for #{File.basename(filepath)}"}
         Log.log.trace1{"conversion_type(#{File.basename(filepath)}): #{conversion_type.class.name} [#{conversion_type}]"}
         return conversion_type
       end

data/lib/aspera/preview/generator.rb

@@ -27,10 +27,10 @@ module Aspera
       # Node API MIME types are from: http://svn.apache.org/repos/asf/httpd/httpd/trunk/docs/conf/mime.types.
       # The resulting preview file type is taken from destination file extension.
       # Conversion methods are provided by private methods: convert_<conversion_type>_to_<preview_format>.
-      #   -> conversion_type is one of FileTypes::CONVERSION_TYPES.
-      #   -> preview_format is one of Generator::PREVIEW_FORMATS.
+      #   conversion_type: one of FileTypes::CONVERSION_TYPES.
+      #   preview_format: one of Generator::PREVIEW_FORMATS.
       # The conversion video->mp4 is implemented in methods: convert_video_to_mp4_using_<video_conversion>.
-      #  -> conversion method is one of Generator::VIDEO_CONVERSION_METHODS.
+      #   conversion method: one of Generator::VIDEO_CONVERSION_METHODS.
       # @param src [String] Source file path.
       # @param dst [String] Destination file path.
       # @param options [Options] All conversion options.

data/lib/aspera/preview/utils.rb

@@ -64,7 +64,7 @@ module Aspera
           silent_execute(:ffmpeg, *gl_p, *in_p, '-i', in_f, *out_p, out_f)
         end
 
-        # @return Float in seconds
+        # @return [Float] duration in seconds
         def video_get_duration(input_file)
           return execute(
             :ffprobe,

data/lib/aspera/products/connect.rb

@@ -5,6 +5,9 @@ require 'singleton'
 
 module Aspera
   module Products
+    # @!method self.instance
+    #   Returns the singleton instance of Connect
+    #   @return [Connect] the singleton instance
     class Connect
       include Singleton
 
@@ -62,7 +65,7 @@ module Aspera
           Log.dump(:javascript, connect_versions_javascript)
           # get javascript object only
           found = connect_versions_javascript.match(/^.*? = (.*);/)
-          raise Cli::Error, 'Problem when getting connect versions from internet' if found.nil?
+          Aspera.assert(!found.nil?, type: Cli::Error){'Problem when getting connect versions from internet'}
           all_data = JSON.parse(found[1])
           @connect_versions = all_data['entries']
         end

data/lib/aspera/products/other.rb

@@ -57,7 +57,7 @@ module Aspera
         # 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
+        # @raise [RuntimeError] if no installed product found
         def find(scan_locations)
           product_names = []
           found = scan_locations.select do |item|

data/lib/aspera/products/transferd.rb

@@ -27,9 +27,9 @@ module Aspera
           sdk_directory
         end
 
-        # @return the path to folder where SDK is or should be installed
+        # @return [String] the path to folder where SDK is or should be installed
         def sdk_directory
-          Aspera.assert(!@sdk_dir.nil?){'SDK path was not initialized'}
+          Aspera.assert(!@sdk_dir.nil?, 'SDK path was not initialized')
           @sdk_dir
         end
 
@@ -52,7 +52,7 @@ module Aspera
               end
             end
           end
-          Aspera.assert(!result.nil?){'Port not found in daemon logs'}
+          Aspera.assert(!result.nil?, 'Port not found in daemon logs')
           Log.log.debug{"Got port #{result} from log"}
           return result
         end

data/lib/aspera/proxy_auto_config.rb

@@ -14,7 +14,7 @@ module URI
       # @yieldparam url [String] The URL to find proxy for
       # @yieldreturn [String, nil] Proxy URL or nil to fallback to original method
       def register_proxy_finder
-        Aspera.assert(block_given?)
+        Aspera.assert(block_given?, 'block required for register_proxy_finder')
         # overload the method in URI : call user's provided block and fallback to original method
         define_method(:find_proxy){ |env_vars = ENV| yield(to_s) || find_proxy_orig(env_vars)}
       end
@@ -44,7 +44,7 @@ module Aspera
           context_ip = r_addr.to_s if r_addr.is_a?(Resolv::IPv4)
         end
       end
-      raise "DNS name not found: #{context_host}" if context_ip.nil?
+      Aspera.assert(!context_ip.nil?){"DNS name not found: #{context_host}"}
       # NOTE: Javascript code here with string inclusions
       javascript = <<END_OF_JAVASCRIPT
       function dnsResolve(host) {
@@ -63,7 +63,7 @@ END_OF_JAVASCRIPT
 
     attr_writer :proxy_user, :proxy_pass
 
-    # @param proxy_auto_config the proxy auto config script to be evaluated
+    # @param proxy_auto_config [String] the proxy auto config script to be evaluated
     def initialize(proxy_auto_config)
       # user provided javascript with FindProxyForURL function
       @proxy_auto_config = proxy_auto_config
@@ -79,7 +79,7 @@ END_OF_JAVASCRIPT
     end
 
     # execute proxy auto config script for the given URL : https://en.wikipedia.org/wiki/Proxy_auto-config
-    # @return either nil, or a String formatted following PAC standard
+    # @return [String, nil] either nil, or a String formatted following PAC standard
     def find_proxy_for_url(service_url)
       uri = URI.parse(service_url)
       simple_url = "#{uri.scheme}://#{uri.host}"
@@ -99,7 +99,7 @@ END_OF_JAVASCRIPT
     end
 
     # used to replace URI::Generic.find_proxy
-    # @return Array of URI, possibly empty
+    # @return [Array<URI>] list of URIs, possibly empty
     def get_proxies(service_url)
       # prepare result
       uri_list = []
@@ -114,14 +114,15 @@ END_OF_JAVASCRIPT
       proxy_list_str.split(';').each do |item|
         # strip and split by space
         parts = item.strip.split
-        case parts.shift
+        proxy_type = parts.shift
+        case proxy_type
         when 'DIRECT'
-          Aspera.assert(parts.empty?){'DIRECT has no param'}
+          Aspera.assert(parts.empty?, 'DIRECT has no param')
           Log.log.debug('ignoring proxy DIRECT')
         when 'PROXY'
           addr_port = parts.shift
           Aspera.assert_type(addr_port, String)
-          Aspera.assert(parts.empty?){'PROXY shall have one param'}
+          Aspera.assert(parts.empty?, 'PROXY shall have one param')
           begin
             # PAC proxy addresses are <host>:<port>
             if /:[0-9]+$/.match?(addr_port)
@@ -136,7 +137,7 @@ END_OF_JAVASCRIPT
           rescue StandardError => e
             Log.log.warn{"PAC: cannot parse #{addr_port} #{e}"}
           end
-        else Log.log.warn{"PAC: ignoring proxy type #{parts.first}: not supported"}
+        else Log.log.warn{"PAC: ignoring proxy type #{proxy_type}: not supported"}
         end
       end
       Log.log.debug{"Proxies: #{uri_list}"}

data/lib/aspera/rest.rb

@@ -30,6 +30,10 @@ module Aspera
   # @param download_partial_suffix [String] suffix for partial download
   # @param session_cb [lambda] lambda called on new HTTP session. Takes the Net::HTTP as arg. Used to change parameters on creation.
   # @param progress_bar [Object] progress bar object called for file transfer
+  #
+  # @!method self.instance
+  #   Returns the singleton instance of RestParameters
+  #   @return [RestParameters] the singleton instance
   class RestParameters
     include Singleton
 
@@ -73,6 +77,9 @@ module Aspera
   # and error are analyzed in RestErrorAnalyzer
   class Rest
     class << self
+      # Build a Basic authentication header value
+      # @param user [String] Username
+      # @param pass [String] Password
       # @return [String] Basic auth token
       def basic_authorization(user, pass); return "Basic #{Base64.strict_encode64("#{user}:#{pass}")}"; end
 
@@ -89,7 +96,8 @@ module Aspera
       # Check if php style is specified.
       # `nil` values in query result in key without value, e.g. `?a`, while empty string values result in `?a=`.
       # @param url   [String]            The URL without query.
-      # @param query [Hash,Array,String] The query.
+      # @param query [Hash,Array,String] The query parameters.
+      # @return [URI] The built URI.
       def build_uri(url, query)
         uri = URI.parse(url)
         Aspera.assert_values(uri.scheme, %w[http https]){'URI scheme'}
@@ -102,7 +110,7 @@ module Aspera
           when Hash
             URI.encode_www_form(h_to_query_array(query))
           when Array
-            Aspera.assert(query.all?{ |i| i.is_a?(Array) && i.length.eql?(2)}){'Query must be array of arrays of 2 elements'}
+            Aspera.assert(query.all?{ |i| i.is_a?(Array) && i.length.eql?(2)}, 'Query must be array of arrays of 2 elements')
             URI.encode_www_form(query) # remove nil values
           else Aspera.error_unexpected_value(query.class){'query type'}
           end.gsub('%5B%5D=', '[]=')
@@ -114,6 +122,7 @@ module Aspera
       # Either p=1&p=2 (default)
       # or p[]=1&p[]=2 (if `:x_array_php_style` is set to true in query)
       # @param query [Hash] HTTP query as hash
+      # @return [Array<Array>] Array of [key, value] pairs suitable for URI.encode_www_form
       def h_to_query_array(query)
         Aspera.assert_type(query, Hash)
         suffix = query.delete(:x_array_php_style) ? '[]' : nil
@@ -151,37 +160,6 @@ module Aspera
         end
       end
 
-      # Parse Link header according to RFC 8288 to extract a specific relation
-      # @param link_header [String, nil] The Link header value
-      # @param rel [String] The relation to look for (default: 'next')
-      # @return [String, nil] The URL of the link with the specified relation, or nil
-      def parse_link_header(link_header, rel: 'next')
-        return if link_header.nil? || link_header.empty?
-        # RFC 8288: Link header format is: <URI>; param1=value1; param2=value2, <URI2>; ...
-        # We look for the link with the specified rel
-        link_header.split(',').each do |link_part|
-          link_part = link_part.strip
-          # Extract URL between < and >
-          url_match = link_part.match(/<([^>]+)>/)
-          next unless url_match
-          url = url_match[1]
-          # Extract parameters after the URL
-          params_str = link_part[url_match.end(0)..]
-          # Check if this link has the specified rel (with or without quotes, case insensitive)
-          next unless /;\s*rel\s*=\s*"?#{Regexp.escape(rel)}"?/i.match?(params_str)
-          return url
-        end
-        # Fallback: if no rel found and looking for 'next', try the first link (backward compatibility)
-        if rel.eql?('next')
-          first_link = link_header.split(',').first&.strip
-          if first_link
-            url_match = first_link.match(/<([^>]+)>/)
-            return url_match[1] if url_match
-          end
-        end
-        nil
-      end
-
       # Start a HTTP/S session, also used for web sockets
       # @param base_url [String] Base url of HTTP/S session
       # @return [Net::HTTP] A started HTTP session
@@ -275,7 +253,7 @@ module Aspera
     # Base common headers of API
     attr_reader :headers
 
-    # @return creation parameters
+    # @return [Hash] creation parameters
     def params
       return {
         base_url:       @base_url,       # String
@@ -316,7 +294,7 @@ module Aspera
       # default is no auth
       @auth_params = auth
       Aspera.assert_type(@auth_params, Hash)
-      Aspera.assert(@auth_params.key?(:type)){'no auth type defined'}
+      Aspera.assert(@auth_params.key?(:type), 'no auth type defined')
       @not_auth_codes = not_auth_codes
       Aspera.assert_type(@not_auth_codes, Array)
       # persistent session
@@ -330,10 +308,10 @@ module Aspera
       @oauth = nil
     end
 
-    # @return the OAuth object (create, or cached if already created)
+    # @return [OAuth::Base] the OAuth object (create, or cached if already created)
     def oauth
       if @oauth.nil?
-        Aspera.assert(@auth_params[:type].eql?(:oauth2)){'no OAuth defined'}
+        Aspera.assert(@auth_params[:type].eql?(:oauth2), 'no OAuth defined')
         oauth_parameters = @auth_params.reject{ |k, _v| k.eql?(:type)}
         Log.dump(:oauth_parameters, oauth_parameters)
         @oauth = OAuth::Factory.instance.create(**oauth_parameters)
@@ -350,7 +328,7 @@ module Aspera
     # @param headers      [Hash{String => String}] Additional headers (override Content-Type)
     # @param save_to_file [String, nil] File path to save response body
     # @param exception    [Boolean] Whether to raise an exception on HTTP error
-    # @param ret          [Symbol] One of :data, :resp, :both — controls return value
+    # @param ret          [Symbol] One of :data, :resp, :both - controls return value
     # @return [Array(Hash, Net::HTTPResponse)] When `ret` is :both
     # @return [Net::HTTPResponse] When `ret` is :resp
     # @return [Hash] When `ret` is :data
@@ -374,7 +352,7 @@ module Aspera
       Log.dump(:headers, headers, level: :trace1)
       Aspera.assert_type(subpath, String)
       # We must have a way to check return code
-      Aspera.assert(exception || !ret.eql?(:data))
+      Aspera.assert(exception || !ret.eql?(:data), 'ret: :data requires exception handler')
       if headers.nil?
         headers = @headers.clone
       else
@@ -481,7 +459,7 @@ module Aspera
           end
         end
         Log.log.debug{"result: code=#{result_http.code} mime=#{result_mime}"}
-        # sometimes there is a UTF8 char (e.g. © )
+        # sometimes there is a UTF8 char (e.g. (c) )
         # TODO : related to mime type encoding ?
         # result_http.body.force_encoding('UTF-8') if result_http.body.is_a?(String)
         # Log.log.debug{"result: body=#{result_http.body}"}

data/lib/aspera/rest_error_analyzer.rb

@@ -7,6 +7,10 @@ require 'net/http'
 
 module Aspera
   # analyze error codes returned by REST calls and raise ruby exception
+  #
+  # @!method self.instance
+  #   Returns the singleton instance of RestErrorAnalyzer
+  #   @return [RestErrorAnalyzer] the singleton instance
   class RestErrorAnalyzer
     include Singleton
 
@@ -28,9 +32,9 @@ module Aspera
     # Use this method to analyze a EST result and raise an exception
     # Analyzes REST call response and raises a RestCallError exception
     # if HTTP result code is not 2XX
-    # @param req  [Net::HTTPRequest]
-    # @param data [Object]
-    # @param http [Net::HTTPResponse]
+    # @param req  [Net::HTTPRequest]  the HTTP request
+    # @param data [Object]            the parsed response body
+    # @param http [Net::HTTPResponse] the raw HTTP response
     def raise_on_error(req, data, http)
       Log.log.debug{"raise_on_error #{req.method} #{req.path} #{http.code}"}
       context = {

data/lib/aspera/rest_errors_aspera.rb

@@ -41,16 +41,6 @@ module Aspera
         end
         RestErrorAnalyzer.instance.add_simple_handler(name: 'T9:IBM cloud IAM', path: ['errorMessage'])
         RestErrorAnalyzer.instance.add_simple_handler(name: 'T10:faspex v4', path: ['user_message'])
-        RestErrorAnalyzer.instance.add_handler('bss graphql') do |type, context|
-          next unless context[:data].is_a?(Hash)
-          d_t_s = context[:data]['errors']
-          next unless d_t_s.is_a?(Array)
-          d_t_s.each do |res|
-            r_err = res['message']
-            next unless r_err.is_a?(String)
-            RestErrorAnalyzer.add_error(context, type, r_err)
-          end
-        end
         RestErrorAnalyzer.instance.add_handler('Orchestrator') do |type, context|
           next if context[:response].code.start_with?('2')
           data = context[:data]