[BUG] [Ruby] Client does not form-encode PUT requests

[dkliban]

Bug Report Checklist

• Have you provided a full/minimal spec to reproduce the issue?
• Have you validated the input using an OpenAPI validator (example)?
• What's the version of OpenAPI Generator used?
• Have you search for related issues/PRs?
• What's the actual output vs expected output?
• [Optional] Bounty to sponsor the fix (example)

Description

The Ruby client relies on Typhoeus to make http requests. Due to typhoeus/typhoeus#389 the generated Ruby client does not form encode PUT requests even when the Content-Type is supposed to be 'multipart/form-data'. POST requests are form-encoded just fine.

openapi-generator version

latest master branch

OpenAPI declaration file content or url

https://docs.pulpproject.org/en/3.0/nightly/api.json

Command line used for generation

docker run -u $(id -u) --rm -v ${PWD}:/local openapitools/openapi-generator-cli generate \
    -i /local/api.json \
    -g ruby \
    -o /local/pulpcore-client \
    -DgemName=pulpcore_client \
    -DgemLicense="GPLv2" \
    -DgemVersion=3.0.0rc2 \
    --skip-validate-spec \
    --strict-spec=false

Steps to reproduce

require 'pulpcore_client'
PulpcoreClient.configure do |config|
          config.host= "http://localhost:24817"
          config.username= 'admin'
          config.password= 'admin'
end

api_instance = PulpcoreClient::UploadsApi.new
content_range = "bytes 0-2373/2373" # String | The Content-Range header specifies the location of the file chunk within the file.

file = File.new('katello.gemspec') # File | A chunk of a file to upload.

begin
  #Start Upload
  result = api_instance.uploads_create(content_range, file)
  p result
rescue PulpcoreClient::ApiError => e
  puts "Exception when calling UploadsApi->uploads_create: #{e}"
end

Related issues/PRs

swagger-api/swagger-codegen#7889
typhoeus/typhoeus#389

Suggest a fix

Add ability to use a different library to perform requests.

[auto-labeler]

👍 Thanks for opening this issue!
🏷 I have applied any labels matching special text in your issue.

The team will review the labels and make any necessary changes.

[ackintosh]

@dkliban Thanks for reporting this issue!

FYI
related issue: #1422

cc: @meganemura

[ndbroadbent]

Hi all, I've just submitted a PR that fixes this issue in the ethon gem, which is a dependency of Typhoeus: typhoeus/ethon#245

In the meantime, here's a monkeypatch that will fix the multipart PUT issue immediately if included in your generated clients:

# Monkeypatch to fix multipart PUT requests in Ethon
# This addresses the issue where PUT requests don't properly handle multipart form data
# See: https://github.com/typhoeus/typhoeus/issues/389
# PR: https://github.com/typhoeus/ethon/pull/245

module Ethon
  class Easy
    module Http
      module Putable
        # Override set_form to handle multipart forms like POST does
        def set_form(easy)
          easy.url ||= url
          form.params_encoding = params_encoding
          if form.multipart?
            # Use httppost for multipart forms (like POST does)
            form.escape = false
            form.materialize
            easy.httppost = form.first.read_pointer
            # Override libcurl's default POST method when using httppost
            easy.customrequest = 'PUT'
          else
            # Keep existing behavior for non-multipart forms
            easy.upload = true
            form.escape = true
            easy.infilesize = form.to_s.bytesize
            easy.set_read_callback(form.to_s)
          end
        end
      end
    end
  end
end