Image to Image in Ruby

This page describes how to convert between images formats in Ruby using the Pdfcrowd API. The API is easy to use and the integration takes only a few of lines of code.

Samples

Installation

Install the client library from rubygems.org
gem install pdfcrowd

We also offer other installation options.

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.

To get your personal API credentials, you can start a free API trial or buy the API license.

Examples

require "pdfcrowd"

begin
    # create the API client instance
    client = Pdfcrowd::ImageToImageClient.new("your_username", "your_apikey")

    # configure the conversion
    client.setOutputFormat("jpg")

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

    # rethrow or handle the exception
    raise
end
require "pdfcrowd"

begin
    # create the API client instance
    client = Pdfcrowd::ImageToImageClient.new("your_username", "your_apikey")

    # configure the conversion
    client.setOutputFormat("jpg")

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

    # at this point the "image" variable contains JPG raw data and
    # can be sent in an HTTP response, saved to a file, etc.
rescue Pdfcrowd::Error => why
    # report the error
    STDERR.puts "Pdfcrowd Error: #{why}"

    # rethrow or handle the exception
    raise
end
require "pdfcrowd"

begin
    # create the API client instance
    client = Pdfcrowd::ImageToImageClient.new("your_username", "your_apikey")

    # configure the conversion
    client.setOutputFormat("jpg")

    # create an output stream for the conversion result
    output_stream = open("logo.jpg", "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
    STDERR.puts "Pdfcrowd Error: #{why}"

    # rethrow or handle the exception
    raise
end
require "pdfcrowd"

begin
    # create the API client instance
    client = Pdfcrowd::ImageToImageClient.new("your_username", "your_apikey")

    # configure the conversion
    client.setOutputFormat("jpg")

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

    # rethrow or handle the exception
    raise
end
require "pdfcrowd"

begin
    # create the API client instance
    client = Pdfcrowd::ImageToImageClient.new("your_username", "your_apikey")

    # configure the conversion
    client.setOutputFormat("jpg")

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

    # at this point the "image" variable contains JPG raw data and
    # can be sent in an HTTP response, saved to a file, etc.
rescue Pdfcrowd::Error => why
    # report the error
    STDERR.puts "Pdfcrowd Error: #{why}"

    # rethrow or handle the exception
    raise
end
require "pdfcrowd"

begin
    # create the API client instance
    client = Pdfcrowd::ImageToImageClient.new("your_username", "your_apikey")

    # configure the conversion
    client.setOutputFormat("jpg")

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

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

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

    # rethrow or handle the exception
    raise
end
require "pdfcrowd"

begin
    # create the API client instance
    client = Pdfcrowd::ImageToImageClient.new("your_username", "your_apikey")

    # configure the conversion
    client.setOutputFormat("jpg")

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

    # rethrow or handle the exception
    raise
end
require "pdfcrowd"

begin
    # create the API client instance
    client = Pdfcrowd::ImageToImageClient.new("your_username", "your_apikey")

    # configure the conversion
    client.setOutputFormat("jpg")

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

    # at this point the "image" variable contains JPG raw data and
    # can be sent in an HTTP response, saved to a file, etc.
rescue Pdfcrowd::Error => why
    # report the error
    STDERR.puts "Pdfcrowd Error: #{why}"

    # rethrow or handle the exception
    raise
end
require "pdfcrowd"

begin
    # create the API client instance
    client = Pdfcrowd::ImageToImageClient.new("your_username", "your_apikey")

    # configure the conversion
    client.setOutputFormat("jpg")

    # create an output stream for the conversion result
    output_stream = open("logo.jpg", "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
    STDERR.puts "Pdfcrowd Error: #{why}"

    # rethrow or handle the exception
    raise
end
require "pdfcrowd"

begin
    # create the API client instance
    client = Pdfcrowd::ImageToImageClient.new("your_username", "your_apikey")

    # configure the conversion
    client.setOutputFormat("jpg")
    client.setDebugLog(true)

    # run the conversion and write the result to a file
    client.convertFileToFile("/path/to/logo.png", "logo.jpg")
    
    # 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
    STDERR.puts "Pdfcrowd Error: #{why}"

    # rethrow or handle the exception
    raise
end

Troubleshooting

API Method Reference

Refer for details to the API Method Reference.