aspera-cli 4.26.2 → 4.27.0

data/lib/aspera/rest.rb

@@ -77,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
 
@@ -93,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'}
@@ -118,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
@@ -155,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
@@ -279,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
@@ -334,7 +308,7 @@ 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')
@@ -354,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
@@ -485,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

@@ -32,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]

data/lib/aspera/rest_list.rb

@@ -15,7 +15,7 @@ module Aspera
     # @param value [String] Value of field of searched entity
     # @param field [String] Field of searched entity
     # @param query [Hash] Optional additional search query parameters
-    # @returns [Hash] A single entity matching the search, or an exception if not found or multiple found
+    # @return [Hash] A single entity matching the search, or an exception if not found or multiple found
     def lookup_with_q(entity, value:, field: 'name', query: {})
       Aspera.assert_type(query, Hash){'query'}
       Aspera.assert_type(field, String){'field'}
@@ -35,8 +35,8 @@ module Aspera
         value_matches = matching_items.select{ |i| i[field].casecmp?(value)}
         case value_matches.length
         when 1 then return value_matches.first
-        when 0 then raise %Q(#{entity}: Multiple case insensitive partial match for: "#{value}" in #{matching_items.map{ |i| i[field]}.join(', ')} but no case insensitive full match. Please be more specific or give exact #{field}.)
-        else raise "Two entities cannot have the same case insensitive #{field}: #{value_matches.map{ |i| i[field]}}"
+        when 0 then raise Error, "#{entity}: Multiple case insensitive partial match for: \"#{value}\" in #{matching_items.map{ |i| i[field]}.join(', ')} but no case insensitive full match. Please be more specific or give exact #{field}."
+        else raise Error, "Two entities cannot have the same case insensitive #{field}: #{value_matches.map{ |i| i[field]}}"
         end
       end
     end