Important: This document is for the beta version of the new Pdfcrowd API. Use this documentation for the stable API version.

Image to PDF - Ruby SDK

Installation

You can install the client library from rubygems.org
 $ gem install pdfcrowd

You can learn more install options here.

The API client library si common for all Pdfcrowd converters.

Authentication

Authentication is needed in order to use the Pdfcrowd API. The credentials used for accessing the API are your Pdfcrowd username and the API key. You can find the API key in your account page.

Getting Started

Local Image to PDF

Convert a local PNG file to a PDF file

require 'pdfcrowd'

begin
    # create the API client instance
    client = Pdfcrowd::ImageToPdfClient.new("username", "apikey")

    # run the conversion and write the result to a file
    client.convertFileToFile("/path/to/logo.png", 'logo.pdf')
rescue Pdfcrowd::Error => why
    # report the error to the standard error stream
    STDERR.puts "Pdfcrowd Error: #{why}"
end

Convert a local PNG file to in-memory PDF

require 'pdfcrowd'

begin
    # create the API client instance
    client = Pdfcrowd::ImageToPdfClient.new("username", "apikey")

    # create output file for conversion result
    output_file = open("logo.pdf", "wb")

    # run the conversion and store the result into a pdf variable
    pdf = client.convertFile("/path/to/logo.png")

    # write the pdf the into the output file
    output_file.write(pdf)

    # close the output file
    output_file.close()
rescue Pdfcrowd::Error => why
    # report the error to the standard error stream
    STDERR.puts "Pdfcrowd Error: #{why}"
end

Convert a local PNG file and write the resulting PDF to an output stream

require 'pdfcrowd'

begin
    # create the API client instance
    client = Pdfcrowd::ImageToPdfClient.new("username", "apikey")

    # create output stream for conversion result
    output_stream = open("logo.pdf", "wb")

    # run the conversion and write the result into the output stream
    client.convertFileToStream("/path/to/logo.png", output_stream)

    # close the output stream
    output_stream.close()
rescue Pdfcrowd::Error => why
    # report the error to the standard error stream
    STDERR.puts "Pdfcrowd Error: #{why}"
end

Image URL to PDF

Convert url with PNG file to a PDF file

require 'pdfcrowd'

begin
    # create the API client instance
    client = Pdfcrowd::ImageToPdfClient.new("username", "apikey")

    # run the conversion and write the result to a file
    client.convertUrlToFile("http://pdfcrowd.com/static/images/logo.png", 'logo.pdf')
rescue Pdfcrowd::Error => why
    # report the error to the standard error stream
    STDERR.puts "Pdfcrowd Error: #{why}"
end

Convert url with PNG file to in-memory PDF

require 'pdfcrowd'

begin
    # create the API client instance
    client = Pdfcrowd::ImageToPdfClient.new("username", "apikey")

    # create output file for conversion result
    output_file = open("logo.pdf", "wb")

    # run the conversion and store the result into a pdf variable
    pdf = client.convertUrl("http://pdfcrowd.com/static/images/logo.png")

    # write the pdf the into the output file
    output_file.write(pdf)

    # close the output file
    output_file.close()
rescue Pdfcrowd::Error => why
    # report the error to the standard error stream
    STDERR.puts "Pdfcrowd Error: #{why}"
end

Convert url with PNG file and write the resulting PDF to an output stream

require 'pdfcrowd'

begin
    # create the API client instance
    client = Pdfcrowd::ImageToPdfClient.new("username", "apikey")

    # create output stream for conversion result
    output_stream = open("logo.pdf", "wb")

    # run the conversion and write the result into the output stream
    client.convertUrlToStream("http://pdfcrowd.com/static/images/logo.png", output_stream)

    # close the output stream
    output_stream.close()
rescue Pdfcrowd::Error => why
    # report the error to the standard error stream
    STDERR.puts "Pdfcrowd Error: #{why}"
end

In-Memory Image to PDF

Convert an in-memory PNG to a PDF file

require 'pdfcrowd'

begin
    # create the API client instance
    client = Pdfcrowd::ImageToPdfClient.new("username", "apikey")

    # run the conversion and write the result to a file
    client.convertRawDataToFile(open('/path/to/logo.png', 'rb').read(), 'logo.pdf')
rescue Pdfcrowd::Error => why
    # report the error to the standard error stream
    STDERR.puts "Pdfcrowd Error: #{why}"
end

Convert an in-memory PNG to in-memory PDF

require 'pdfcrowd'

begin
    # create the API client instance
    client = Pdfcrowd::ImageToPdfClient.new("username", "apikey")

    # create output file for conversion result
    output_file = open("logo.pdf", "wb")

    # run the conversion and store the result into a pdf variable
    pdf = client.convertRawData(open('/path/to/logo.png', 'rb').read())

    # write the pdf the into the output file
    output_file.write(pdf)

    # close the output file
    output_file.close()
rescue Pdfcrowd::Error => why
    # report the error to the standard error stream
    STDERR.puts "Pdfcrowd Error: #{why}"
end

Convert an in-memory PNG and write the resulting PDF to an output stream

require 'pdfcrowd'

begin
    # create the API client instance
    client = Pdfcrowd::ImageToPdfClient.new("username", "apikey")

    # create output stream for conversion result
    output_stream = open("logo.pdf", "wb")

    # run the conversion and write the result into the output stream
    client.convertRawDataToStream(open('/path/to/logo.png', 'rb').read(), output_stream)

    # close the output stream
    output_stream.close()
rescue Pdfcrowd::Error => why
    # report the error to the standard error stream
    STDERR.puts "Pdfcrowd Error: #{why}"
end

Conversion Info

Get info about the current conversion

require 'pdfcrowd'

begin
    # create the API client instance
    client = Pdfcrowd::ImageToPdfClient.new("username", "apikey")

    # configure the conversion
    client.setDebugLog(true)

    # run the conversion and write the result to a file
    client.convertFileToFile("/path/to/logo.png", 'logo.pdf')
    
    # print URL to the debug log
    puts "Debug log url: #{client.getDebugLogUrl()}"
    
    # print the number of available conversion credits in your account
    puts "Remaining credit count: #{client.getRemainingCreditCount()}"
    
    # print the number of credits consumed by the conversion
    puts "Consumed credit count: #{client.getConsumedCreditCount()}"
    
    # print the unique ID of the conversion
    puts "Job id: #{client.getJobId()}"
    
    # print the size of the output in bytes
    puts "Output size: #{client.getOutputSize()}"
rescue Pdfcrowd::Error => why
    # report the error to the standard error stream
    STDERR.puts "Pdfcrowd Error: #{why}"
end

API Reference - class ImageToPdfClient

Conversion from an image to PDF.

Constructor

def initialize(user_name, api_key)
Constructor for the Pdfcrowd API client.
Parameter Description Default
user_name
Your username at Pdfcrowd.
api_key
Your API key.

 

Conversion Input

def convertUrl(url)
Convert an image.
Parameter Description Default
url
The address of the image to convert.
The supported protocols are http:// and https://.
Returns
  • byte[] - Byte array containing the conversion output.
def convertUrlToStream(url, out_stream)
Convert an image and write the result to an output stream.
Parameter Description Default
url
The address of the image to convert.
The supported protocols are http:// and https://.
out_stream
The output stream that will contain the conversion output.
def convertUrlToFile(url, file_path)
Convert an image and write the result to a local file.
Parameter Description Default
url
The address of the image to convert.
The supported protocols are http:// and https://.
file_path
The output file path.
The string must not be empty.
def convertFile(file)
Convert a local file.
Parameter Description Default
file
The path to a local file to convert.
The file can be either a single file or an archive (.tar.gz, .tar.bz2, or .zip).
The file must exist and not be empty.
Returns
  • byte[] - Byte array containing the conversion output.
def convertFileToStream(file, out_stream)
Convert a local file and write the result to an output stream.
Parameter Description Default
file
The path to a local file to convert.
The file can be either a single file or an archive (.tar.gz, .tar.bz2, or .zip).
The file must exist and not be empty.
out_stream
The output stream that will contain the conversion output.
def convertFileToFile(file, file_path)
Convert a local file and write the result to a local file.
Parameter Description Default
file
The path to a local file to convert.
The file can be either a single file or an archive (.tar.gz, .tar.bz2, or .zip).
The file must exist and not be empty.
file_path
The output file path.
The string must not be empty.
def convertRawData(data)
Convert raw data.
Parameter Description Default
data
The raw content to be converted.
Returns
  • byte[] - Byte array with the output.
def convertRawDataToStream(data, out_stream)
Convert raw data and write the result to an output stream.
Parameter Description Default
data
The raw content to be converted.
out_stream
The output stream that will contain the conversion output.
def convertRawDataToFile(data, file_path)
Convert raw data to a file.
Parameter Description Default
data
The raw content to be converted.
file_path
The output file path.
The string must not be empty.

 

Image operations

Settings used for operations with images.

def setResize(resize)
Resize the image.
Parameter Description Default
resize
The resize percentage or new image dimensions.
100%
Returns
  • ImageToPdfClient - The converter object.
Examples:
  • setResize("200%")
  • setResize("1024x768")
def setRotate(rotate)
Rotate the image.
Parameter Description Default
rotate
The rotation specified in degrees.
0
Returns
  • ImageToPdfClient - The converter object.

 

Miscellaneous

def setDebugLog(debug_log)
Turn on the debug logging.
Parameter Description Default
debug_log
Set to true to enable the debug logging.
false
Returns
  • ImageToPdfClient - The converter object.
def getDebugLogUrl()
Get the URL of the debug log for the last conversion.
Returns
  • string - The link to the debug log.
def getRemainingCreditCount()
Get the number of conversion credits available in your account.
The returned value can differ from the actual count if you run parallel conversions.
The special value 999999 is returned if the information is not available.
Returns
  • int - The number of credits.
def getConsumedCreditCount()
Get the number of credits consumed by the last conversion.
Returns
  • int - The number of credits.
def getJobId()
Get the job id.
Returns
  • string - The unique job identifier.
def getOutputSize()
Get the size of the output in bytes.
Returns
  • int - The count of bytes.

 

API Client Options

def setUseHttp(use_http)
Specifies if the client communicates over HTTP or HTTPS with Pdfcrowd API.
Parameter Description Default
use_http
Set to true to use HTTP.
false
Returns
  • ImageToPdfClient - The converter object.
def setUserAgent(user_agent)
Set a custom user agent HTTP header. It can be usefull if you are behind some proxy or firewall.
Parameter Description Default
user_agent
The user agent string.
pdfcrowd_ruby_client/4.2 (http://pdfcrowd.com)
Returns
  • ImageToPdfClient - The converter object.
def setProxy(host, port, user_name, password)
Specifies an HTTP proxy that the API client library will use to connect to the internet.
Parameter Description Default
host
The proxy hostname.
port
The proxy port.
user_name
The username.
password
The password.
Returns
  • ImageToPdfClient - The converter object.
def setRetryCount(retry_count)
Specifies the number of retries when the 502 HTTP status code is received. The 502 status code indicates a temporary network issue. This feature can be disabled by setting to 0.
Parameter Description Default
retry_count
Number of retries wanted.
1
Returns
  • ImageToPdfClient - The converter object.

 

Error Handling

begin 
    # call the API 
rescue Pdfcrowd::Error => why 
    # print error
    STDERR.puts "Pdfcrowd Error: #{why}"

    # print just error code
    STDERR.puts "Pdfcrowd Error Code: #{why.getCode()}"

    # print just error message
    STDERR.puts "Pdfcrowd Error Message: #{why.getMessage()}"

    # or handle the error by your way
end