pulp_rpm_client 3.27.2 → 3.28.1

data/lib/pulp_rpm_client/api/rpm_copy_api.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3
 Contact: pulp-list@redhat.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.1
+Generator version: 7.10.0
 
 =end
 
@@ -51,23 +51,27 @@ module PulpRpmClient
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
       # HTTP header 'Content-Type'
-      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
+      content_type = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
 
       # form parameters
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] || @api_client.object_to_http_body(copy) 
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(copy)
 
       # return_type
-      return_type = opts[:return_type] || 'AsyncOperationResponse' 
+      return_type = opts[:debug_return_type] || 'AsyncOperationResponse'
 
       # auth_names
-      auth_names = opts[:auth_names] || ['basicAuth']
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
 
       new_options = opts.merge(
+        :operation => :"RpmCopyApi.copy_content",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,

data/lib/pulp_rpm_client/api/rpm_prune_api.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3
 Contact: pulp-list@redhat.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.1
+Generator version: 7.10.0
 
 =end
 
@@ -49,23 +49,27 @@ module PulpRpmClient
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
       # HTTP header 'Content-Type'
-      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
+      content_type = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
 
       # form parameters
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] || @api_client.object_to_http_body(prune_packages) 
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(prune_packages)
 
       # return_type
-      return_type = opts[:return_type] || 'TaskGroupOperationResponse' 
+      return_type = opts[:debug_return_type] || 'TaskGroupOperationResponse'
 
       # auth_names
-      auth_names = opts[:auth_names] || ['basicAuth']
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
 
       new_options = opts.merge(
+        :operation => :"RpmPruneApi.prune_packages",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,

data/lib/pulp_rpm_client/api_client.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3
 Contact: pulp-list@redhat.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.1
+Generator version: 7.10.0
 
 =end
 
@@ -14,7 +14,12 @@ require 'date'
 require 'json'
 require 'logger'
 require 'tempfile'
+require 'time'
 require 'faraday'
+require 'faraday/multipart' if Gem::Version.new(Faraday::VERSION) >= Gem::Version.new('2.0')
+require 'marcel'
+require 'pathname'
+
 
 module PulpRpmClient
   class ApiClient
@@ -46,51 +51,38 @@ module PulpRpmClient
     # @return [Array<(Object, Integer, Hash)>] an array of 3 elements:
     #   the data deserialized from response body (could be nil), response status code and response headers.
     def call_api(http_method, path, opts = {})
-      ssl_options = {
-        :ca_file => @config.ssl_ca_file,
-        :verify => @config.ssl_verify,
-        :verify_mode => @config.ssl_verify_mode,
-        :client_cert => @config.ssl_client_cert,
-        :client_key => @config.ssl_client_key
-      }
-      request_options = {
-        :params_encoder => @config.params_encoder
-      }
-      connection = Faraday.new(:url => config.base_url, :ssl => ssl_options, :request => request_options) do |conn|
-        conn.basic_auth(config.username, config.password)
-        if opts[:header_params]["Content-Type"] == "multipart/form-data"
-          conn.request :multipart
-          conn.request :url_encoded
-        end
-        conn.adapter(Faraday.default_adapter)
-      end
-
+      stream = nil
       begin
-        response = connection.public_send(http_method.to_sym.downcase) do |req|
-          build_request(http_method, path, req, opts)
+        response = connection(opts).public_send(http_method.to_sym.downcase) do |req|
+          request = build_request(http_method, path, req, opts)
+          stream = download_file(request) if opts[:return_type] == 'File' || opts[:return_type] == 'Binary'
         end
 
-        if @config.debugging
-          @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
+        if config.debugging
+          config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
         end
 
         unless response.success?
-          if response.status == 0
+          if response.status == 0 && response.respond_to?(:return_message)
             # Errors from libcurl will be made visible here
-            fail ApiError.new(:code => 0,
-                              :message => response.return_message)
+            fail ApiError.new(code: 0,
+                              message: response.return_message)
           else
-            fail ApiError.new(:code => response.status,
-                              :response_headers => response.headers,
-                              :response_body => response.body),
+            fail ApiError.new(code: response.status,
+                              response_headers: response.headers,
+                              response_body: response.body),
                  response.reason_phrase
           end
         end
       rescue Faraday::TimeoutError
         fail ApiError.new('Connection timed out')
+      rescue Faraday::ConnectionFailed
+        fail ApiError.new('Connection failed')
       end
 
-      if opts[:return_type]
+      if opts[:return_type] == 'File' || opts[:return_type] == 'Binary'
+        data = deserialize_file(response, stream)
+      elsif opts[:return_type]
         data = deserialize(response, opts[:return_type])
       else
         data = nil
@@ -106,9 +98,9 @@ module PulpRpmClient
     # @option opts [Hash] :query_params Query parameters
     # @option opts [Hash] :form_params Query parameters
     # @option opts [Object] :body HTTP body (JSON/XML)
-    # @return [Typhoeus::Request] A Typhoeus Request
+    # @return [Faraday::Request] A Faraday Request
     def build_request(http_method, path, request, opts = {})
-      url = build_request_url(path)
+      url = build_request_url(path, opts)
       http_method = http_method.to_sym.downcase
 
       header_params = @default_headers.merge(opts[:header_params] || {})
@@ -117,24 +109,21 @@ module PulpRpmClient
 
       update_params_for_auth! header_params, query_params, opts[:auth_names]
 
-      req_opts = {
-        :params_encoding => @config.params_encoding,
-        :timeout => @config.timeout,
-        :verbose => @config.debugging
-      }
-
       if [:post, :patch, :put, :delete].include?(http_method)
         req_body = build_request_body(header_params, form_params, opts[:body])
-        if @config.debugging
-          @config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
+        if config.debugging
+          config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
         end
       end
       request.headers = header_params
       request.body = req_body
-      request.options = OpenStruct.new(req_opts)
+
+      # Overload default options only if provided
+      request.options.params_encoder = config.params_encoder if config.params_encoder
+      request.options.timeout        = config.timeout        if config.timeout
+
       request.url url
       request.params = query_params
-      download_file(request) if opts[:return_type] == 'File'
       request
     end
 
@@ -153,8 +142,7 @@ module PulpRpmClient
         form_params.each do |key, value|
           case value
           when ::File, ::Tempfile
-            # TODO hardcode to application/octet-stream, need better way to detect content type
-            data[key] = Faraday::FilePart.new(value.path, 'application/octet-stream', value.path)
+            data[key] = Faraday::FilePart.new(value.path, Marcel::MimeType.for(Pathname.new(value.path)))
           when ::Array, nil
             # let Faraday handle Array and nil parameters
             data[key] = value
@@ -170,6 +158,95 @@ module PulpRpmClient
       data
     end
 
+    def download_file(request)
+      stream = []
+
+      # handle streaming Responses
+      request.options.on_data = Proc.new do |chunk, overall_received_bytes|
+        stream << chunk
+      end
+
+      stream
+    end
+
+    def deserialize_file(response, stream)
+      body     = response.body
+      encoding = body.encoding
+
+      # reconstruct content
+      content = stream.join
+      content = content.unpack('m').join if response.headers['Content-Transfer-Encoding'] == 'binary'
+      content = content.force_encoding(encoding)
+
+      # return byte stream
+      return content if @config.return_binary_data == true
+
+      # return file instead of binary data
+      content_disposition = response.headers['Content-Disposition']
+      if content_disposition && content_disposition =~ /filename=/i
+        filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
+        prefix = sanitize_filename(filename)
+      else
+        prefix = 'download-'
+      end
+      prefix = prefix + '-' unless prefix.end_with?('-')
+
+      tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
+      tempfile.write(content)
+      tempfile.close
+
+      config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
+                          "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
+                          "will be deleted automatically with GC. It's also recommended to delete the temp file "\
+                          "explicitly with `tempfile.delete`"
+      tempfile
+    end
+
+    def connection(opts)
+      opts[:header_params]['Content-Type'] == 'multipart/form-data' ? connection_multipart : connection_regular
+    end
+
+    def connection_multipart
+      @connection_multipart ||= build_connection do |conn|
+        conn.request :multipart
+        conn.request :url_encoded
+      end
+    end
+
+    def connection_regular
+      @connection_regular ||= build_connection
+    end
+
+    def build_connection
+      Faraday.new(url: config.base_url, ssl: ssl_options, proxy: config.proxy) do |conn|
+        basic_auth(conn)
+        config.configure_middleware(conn)
+        yield(conn) if block_given?
+        conn.adapter(Faraday.default_adapter)
+        config.configure_connection(conn)
+      end
+    end
+
+    def ssl_options
+      {
+        ca_file: config.ssl_ca_file,
+        verify: config.ssl_verify,
+        verify_mode: config.ssl_verify_mode,
+        client_cert: config.ssl_client_cert,
+        client_key: config.ssl_client_key
+      }
+    end
+
+    def basic_auth(conn)
+      if config.username && config.password
+        if Gem::Version.new(Faraday::VERSION) >= Gem::Version.new('2.0')
+          conn.request(:authorization, :basic, config.username, config.password)
+        else
+          conn.request(:basic_auth, config.username, config.password)
+        end
+      end
+    end
+
     # Check if the given MIME is a JSON MIME.
     # JSON MIME examples:
     #   application/json
@@ -179,7 +256,7 @@ module PulpRpmClient
     # @param [String] mime MIME
     # @return [Boolean] True if the MIME is application/json
     def json_mime?(mime)
-      (mime == '*/*') || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil?
+      (mime == '*/*') || !(mime =~ /^Application\/.*json(?!p)(;.*)?/i).nil?
     end
 
     # Deserialize the response to the given return type.
@@ -188,15 +265,10 @@ module PulpRpmClient
     # @param [String] return_type some examples: "User", "Array<User>", "Hash<String, Integer>"
     def deserialize(response, return_type)
       body = response.body
-
-      # handle file downloading - return the File instance processed in request callbacks
-      # note that response body is empty when the file is written in chunks in request on_body callback
-      return @tempfile if return_type == 'File'
-
       return nil if body.nil? || body.empty?
 
       # return response body directly for String return type
-      return body if return_type == 'String'
+      return body.to_s if return_type == 'String'
 
       # ensuring a default content type
       content_type = response.headers['Content-Type'] || 'application/json'
@@ -206,7 +278,7 @@ module PulpRpmClient
       begin
         data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
       rescue JSON::ParserError => e
-        if %w(String Date DateTime).include?(return_type)
+        if %w(String Date Time).include?(return_type)
           data = body
         else
           raise e
@@ -231,9 +303,9 @@ module PulpRpmClient
         data.to_f
       when 'Boolean'
         data == true
-      when 'DateTime'
+      when 'Time'
         # parse date time (expecting ISO 8601 format)
-        DateTime.parse data
+        Time.parse data
       when 'Date'
         # parse date time (expecting ISO 8601 format)
         Date.parse data
@@ -251,46 +323,9 @@ module PulpRpmClient
           data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
         end
       else
-        # models, e.g. Pet
-        PulpRpmClient.const_get(return_type).build_from_hash(data)
-      end
-    end
-
-    # Save response body into a file in (the defined) temporary folder, using the filename
-    # from the "Content-Disposition" header if provided, otherwise a random filename.
-    # The response body is written to the file in chunks in order to handle files which
-    # size is larger than maximum Ruby String or even larger than the maximum memory a Ruby
-    # process can use.
-    #
-    # @see Configuration#temp_folder_path
-    def download_file(request)
-      tempfile = nil
-      encoding = nil
-      request.on_headers do |response|
-        content_disposition = response.headers['Content-Disposition']
-        if content_disposition && content_disposition =~ /filename=/i
-          filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
-          prefix = sanitize_filename(filename)
-        else
-          prefix = 'download-'
-        end
-        prefix = prefix + '-' unless prefix.end_with?('-')
-        encoding = response.body.encoding
-        tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
-        @tempfile = tempfile
-      end
-      request.on_body do |chunk|
-        chunk.force_encoding(encoding)
-        tempfile.write(chunk)
-      end
-      request.on_complete do |response|
-        if tempfile
-          tempfile.close
-          @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
-                              "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
-                              "will be deleted automatically with GC. It's also recommended to delete the temp file "\
-                              "explicitly with `tempfile.delete`"
-        end
+        # models (e.g. Pet) or oneOf
+        klass = PulpRpmClient.const_get(return_type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(data) : klass.build_from_hash(data)
       end
     end
 
@@ -300,16 +335,16 @@ module PulpRpmClient
     # @param [String] filename the filename to be sanitized
     # @return [String] the sanitized filename
     def sanitize_filename(filename)
-      filename.gsub(/.*[\/\\]/, '')
+      filename.split(/[\/\\]/).last
     end
 
-    def build_request_url(path)
+    def build_request_url(path, opts = {})
       # Add leading and trailing slashes to path
       path = "/#{path}".gsub(/\/+/, '/')
-      @config.base_url + path
+      @config.base_url(opts[:operation]) + path
     end
 
-    # Update hearder and query params based on authentication settings.
+    # Update header and query params based on authentication settings.
     #
     # @param [Hash] header_params Header parameters
     # @param [Hash] query_params Query parameters
@@ -321,7 +356,7 @@ module PulpRpmClient
         case auth_setting[:in]
         when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
         when 'query'  then query_params[auth_setting[:key]] = auth_setting[:value]
-        else fail ArgumentError, 'Authentication token must be in `query` of `header`'
+        else fail ArgumentError, 'Authentication token must be in `query` or `header`'
         end
       end
     end
@@ -348,8 +383,8 @@ module PulpRpmClient
     # @param [Array] content_types array for Content-Type
     # @return [String] the Content-Type header  (e.g. application/json)
     def select_header_content_type(content_types)
-      # use application/json by default
-      return 'application/json' if content_types.nil? || content_types.empty?
+      # return nil by default
+      return if content_types.nil? || content_types.empty?
       # use JSON when present, otherwise use the first one
       json_content_type = content_types.find { |s| json_mime?(s) }
       json_content_type || content_types.first

data/lib/pulp_rpm_client/api_error.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3
 Contact: pulp-list@redhat.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.1
+Generator version: 7.10.0
 
 =end
 
@@ -32,6 +32,7 @@ module PulpRpmClient
         end
       else
         super arg
+        @message = arg
       end
     end