View all our articles

Define a time limit in Ruby with Faraday

In this guide, we'll show you how you can set a conversion time limit at PDFShift. This will allow you to define a maximum time for the conversion process to complete, and if the process takes longer than the defined time, the conversion will be aborted.

In some cases, this can be useful if you want the request to not be too long and then handle failure on your end depending on the result.

To do so, we use the timeout property, which is the maximum time in seconds that the request is allowed to take. If the request takes longer than the defined time, the conversion will be aborted.

require 'faraday'
require 'json'

# You can get an API key at
api_key = 'sk_xxxxxxxxxxxx'

params = {
    'source' => '',
    'timeout' => 10

# Create a Faraday connection
conn = "") do |faraday|
    faraday.request :url_encoded
    faraday.adapter Faraday.default_adapter

# Make the POST request
response = do |req|
    req.headers['Content-Type'] = 'application/json'
    req.headers['Authorization'] = "Basic #{Base64.strict_encode64("api:#{api_key}")}"
    req.body = params.to_json

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

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

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

In the above example, the conversion could fail if the conversion takes longer than 10 seconds.

For further details on the timeout 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.