aspera-cli 4.26.0 → 4.26.2

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
 

data/lib/aspera/products/transferd.rb

@@ -29,7 +29,7 @@ module Aspera
 
         # @return 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

@@ -10,8 +10,11 @@ module URI
     # save original method that finds proxy in URI::Generic, it uses env var http_proxy
     alias_method :find_proxy_orig, :find_proxy
     class << self
+      # Register a custom proxy finder block
+      # @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
@@ -113,12 +116,12 @@ END_OF_JAVASCRIPT
         parts = item.strip.split
         case parts.shift
         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)

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
 
@@ -102,7 +106,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=', '[]=')
@@ -166,7 +170,7 @@ module Aspera
           next unless url_match
           url = url_match[1]
           # Extract parameters after the URL
-          params_str = link_part[url_match.end(0)..-1]
+          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
@@ -316,7 +320,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
@@ -333,7 +337,7 @@ module Aspera
     # @return 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)
@@ -374,7 +378,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

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
 

data/lib/aspera/rest_list.rb

@@ -50,6 +50,7 @@ module Aspera
     # @return [Array<(Array<Hash>, Integer)>] items, total_count
     def list_entities_limit_offset_total_count(
       entity:,
+      operation: 'GET',
       items_key: nil,
       query: nil
     )
@@ -67,9 +68,15 @@ module Aspera
       # Merge default parameters, by default 100 per page
       query = {'limit'=> PER_PAGE_DEFAULT}.merge(query)
       total_count = nil
+      call_args = {
+        operation: operation,
+        subpath:   entity,
+        query:     query,
+        headers:   {'Accept' => Mime::JSON}
+      }
       loop do
         query['offset'] = offset
-        page_result = read(entity, query)
+        page_result = call(**call_args)
         Aspera.assert_type(page_result[items_key], Array)
         result.concat(page_result[items_key])
         # Reach the limit set by user ?
@@ -97,7 +104,7 @@ module Aspera
     # @param query     [Hash]   Additional query parameters (Default: `:default`)
     def lookup_entity_by_field(entity:, value:, field: 'name', items_key: nil, query: :default)
       if query.eql?(:default)
-        Aspera.assert(field.eql?('name')){'Default query is on name only'}
+        Aspera.assert_values(field, ['name']){'Default query field'}
         query = {'q'=> value}
       end
       lookup_entity_generic(entity: entity, field: field, value: value){list_entities_limit_offset_total_count(entity: entity, items_key: items_key, query: query).first}
@@ -113,7 +120,7 @@ module Aspera
     # @return [Hash] The unique matching object.
     # @raise  [Cli::BadIdentifier] If 0 or >1 matches are found.
     def lookup_entity_generic(entity:, value:, field: 'name')
-      Aspera.assert(block_given?)
+      Aspera.assert(block_given?, 'block required for lookup_entity_generic')
       found = yield
       Aspera.assert_array_all(found, Hash)
       found = found.select{ |i| i[field].eql?(value)}