Docs generation fails image is returned as part of a spec

[nicolo]

I'm getting the following error when trying to create documentation for a route that returns a file.
write': "\xFF" from ASCII-8BIT to UTF-8 (Encoding::UndefinedConversionError) when trying to return a jpeg from my api.

This seems to be related
#39

[amedrz]

Same here, I have:

post "api/attachments" do                                      
  header 'Accept', '*/*'                                                          
  header 'Content-Type', 'multipart/form-data'                                    

  parameter :attachment, "Attachment", "Type" => "Multipart/Form-data"            

  example "add an attachment" do                                                  
    do_request(attachments: { attachment: attachment })
    expect(response_status).to eq(201)                                            
  end                                                                             
end

Where attachment is an instance of Rack::Test::UploadedFile

And I'm getting:

Failure/Error: do_request(attachments:
     Encoding::UndefinedConversionError:
       "\x89" from ASCII-8BIT to UTF-8

Any hints? @nicolo @oestrich

I'm on Rails 4.1.9 and rspec_api_documentation 4.4.0

Thanks!

[bforma]

As a workaround, I've replaced the contents of binaries files with a string like "Contents of a JPEG image". This also documents quite well. Perhaps you can use this.

[risinglf]

Hi @bforma can I ask you have did you do that? Thank you so much.

[bforma]

Hi @risinglf, just create a .jpg file with the following contents: Contents of a JPEG image. Hope this helps.

[risinglf]

thanks @bforma my problem is on the response, that it's a PDF file. Any ideas how to handle it? Thank you.

[oestrich]

@risinglf Last week I pushed up changes that should sniff out binary data and replace it with [binary data], can you update your Gemfile to master and see if that fixes your problem? If it does I'll go ahead and release a new version.

[oestrich]

Closing because this should be fixed in newer versions. See client_base.rb