Convert an HTML document to PDF from raw HTML in Ruby with HttpParty

In this guide, we'll show you how to convert an HTML document to PDF using Ruby and the HttpParty library. Providing the HTML document as raw as a lot of great advantages :

It avoids PDFShift to make a network request to fetch the HTML document.
It allows you to convert HTML documents that are not publicly accessible.
It improves the speed of the conversion

If, on top of that, you can provide the styles and javascript also inline in the document (<style> and <script> tags), it will also drastically reduce the duration of the conversion.

For converting a raw document, we use the same parameter as for the URL, which is the source parameter. All you have to do is provide an HTML document.

Here's an example:

require 'httparty'
require 'json'

# You can get an API key at https://pdfshift.io
api_key = 'sk_xxxxxxxxxxxx'

params = {
    'source' => '<html><body><h1>This will be a PDF document</h1><p>This will generate a basic PDF to show how you can add raw HTML</body></html>',
}

response = HTTParty.post(
    "https://api.pdfshift.io/v3/convert/pdf",
    body: params.to_json,
    headers: {
        'Content-Type' => 'application/json',
        'Authorization' => "Basic #{Base64.strict_encode64("api:#{api_key}")}"
    }
)

# Check for successful response
unless response.success?
    raise "Request failed with status code #{response.code}: #{response.body}"
end

# write response to a file nammed "result.pdf"
File.open('result.pdf', 'wb') { |f| f.write(response.body) }

# Print a success message
puts 'The PDF document was generated and saved to result.pdf'

Providing the source parameter as a raw HTML document is by far the best recommended method to convert HTML documents in PDFShift as it reduce the amount of network requests, loading time of each documents (image, css, javascript, etc) and thus improve the conversion time.

For further details on the property and its usage, please refer to our dedicated documentation.

We hope this guide was helpful. If you have any questions or noticed any issues on the code above,
feel free to drop us a line.