HTML to Image Ruby Examples

This page contains various examples of using the HTML to Image API in Ruby. The examples are complete and fully functional. Read more about how to convert HTML to Image in Ruby.

Basic examples
Template rendering examples
Rails examples

Basic examples

Webpage to PNG file

require "pdfcrowd"

begin
    # create the API client instance
    client = Pdfcrowd::HtmlToImageClient.new("demo", "ce544b6ea52a5621fb9d55f8b542d14d")

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

    # run the conversion and write the result to a file
    client.convertUrlToFile("http://www.example.com", "example.png")

rescue Pdfcrowd::Error => why
    STDERR.puts "Pdfcrowd Error: #{why}"
    raise
end

Webpage to in-memory PNG

require "pdfcrowd"

begin
    # create the API client instance
    client = Pdfcrowd::HtmlToImageClient.new("demo", "ce544b6ea52a5621fb9d55f8b542d14d")

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

    # run the conversion and store the result into the "image" variable
    image = client.convertUrl("http://www.example.com")

    # at this point the "image" variable contains PNG raw data and
    # can be sent in an HTTP response, saved to a file, etc.

rescue Pdfcrowd::Error => why
    STDERR.puts "Pdfcrowd Error: #{why}"
    raise
end

Webpage to PNG stream

require "pdfcrowd"

begin
    # create the API client instance
    client = Pdfcrowd::HtmlToImageClient.new("demo", "ce544b6ea52a5621fb9d55f8b542d14d")

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

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

    # run the conversion and write the result into the output stream
    client.convertUrlToStream("http://www.example.com", output_stream)

    # close the output stream
    output_stream.close()

rescue Pdfcrowd::Error => why
    STDERR.puts "Pdfcrowd Error: #{why}"
    raise
end

HTML file to PNG file

require "pdfcrowd"

begin
    # create the API client instance
    client = Pdfcrowd::HtmlToImageClient.new("demo", "ce544b6ea52a5621fb9d55f8b542d14d")

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

    # run the conversion and write the result to a file
    client.convertFileToFile("/path/to/MyLayout.html", "MyLayout.png")

rescue Pdfcrowd::Error => why
    STDERR.puts "Pdfcrowd Error: #{why}"
    raise
end

HTML file to in-memory PNG

require "pdfcrowd"

begin
    # create the API client instance
    client = Pdfcrowd::HtmlToImageClient.new("demo", "ce544b6ea52a5621fb9d55f8b542d14d")

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

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

    # at this point the "image" variable contains PNG raw data and
    # can be sent in an HTTP response, saved to a file, etc.

rescue Pdfcrowd::Error => why
    STDERR.puts "Pdfcrowd Error: #{why}"
    raise
end

HTML file to PNG stream

require "pdfcrowd"

begin
    # create the API client instance
    client = Pdfcrowd::HtmlToImageClient.new("demo", "ce544b6ea52a5621fb9d55f8b542d14d")

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

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

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

    # close the output stream
    output_stream.close()

rescue Pdfcrowd::Error => why
    STDERR.puts "Pdfcrowd Error: #{why}"
    raise
end

HTML string to PNG file

require "pdfcrowd"

begin
    # create the API client instance
    client = Pdfcrowd::HtmlToImageClient.new("demo", "ce544b6ea52a5621fb9d55f8b542d14d")

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

    # run the conversion and write the result to a file
    client.convertStringToFile("<html><body><h1>Hello World!</h1></body></html>", "HelloWorld.png")

rescue Pdfcrowd::Error => why
    STDERR.puts "Pdfcrowd Error: #{why}"
    raise
end

HTML string to in-memory PNG

require "pdfcrowd"

begin
    # create the API client instance
    client = Pdfcrowd::HtmlToImageClient.new("demo", "ce544b6ea52a5621fb9d55f8b542d14d")

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

    # run the conversion and store the result into the "image" variable
    image = client.convertString("<html><body><h1>Hello World!</h1></body></html>")

    # at this point the "image" variable contains PNG raw data and
    # can be sent in an HTTP response, saved to a file, etc.

rescue Pdfcrowd::Error => why
    STDERR.puts "Pdfcrowd Error: #{why}"
    raise
end

HTML string to PNG stream

require "pdfcrowd"

begin
    # create the API client instance
    client = Pdfcrowd::HtmlToImageClient.new("demo", "ce544b6ea52a5621fb9d55f8b542d14d")

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

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

    # run the conversion and write the result into the output stream
    client.convertStringToStream("<html><body><h1>Hello World!</h1></body></html>", output_stream)

    # close the output stream
    output_stream.close()

rescue Pdfcrowd::Error => why
    STDERR.puts "Pdfcrowd Error: #{why}"
    raise
end

Get info about the current conversion

require "pdfcrowd"

begin
    # create the API client instance
    client = Pdfcrowd::HtmlToImageClient.new("demo", "ce544b6ea52a5621fb9d55f8b542d14d")

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

    # run the conversion and write the result to a file
    client.convertFileToFile("/path/to/MyLayout.html", "MyLayout.png")
    
    # print URL of the debug log
    puts "Debug log url: #{client.getDebugLogUrl()}"
    
    # print the number of conversion credits remaining in your account
    puts "Remaining credit count: #{client.getRemainingCreditCount()}"
    
    # print the number of credits used for the conversion
    puts "Consumed credit count: #{client.getConsumedCreditCount()}"
    
    # print the unique identifier for the conversion
    puts "Job id: #{client.getJobId()}"
    
    # print size of the output data in bytes
    puts "Output size: #{client.getOutputSize()}"

rescue Pdfcrowd::Error => why
    STDERR.puts "Pdfcrowd Error: #{why}"
    raise
end

Template rendering examples

Create Image from JSON data

require "pdfcrowd"

begin
    # create the API client instance
    client = Pdfcrowd::HtmlToImageClient.new("demo", "ce544b6ea52a5621fb9d55f8b542d14d")

    # configure the conversion
    client.setOutputFormat("png")
    client.setDataString('{
            "name": "World",
            "product": "Pdfcrowd API"
        }')

    # run the conversion and write the result to a file
    client.convertStringToFile("Hello {{ name }} from {{ product }}", "output.pdf")

rescue Pdfcrowd::Error => why
    STDERR.puts "Pdfcrowd Error: #{why}"
    raise
end

Create Image from XML data

require "pdfcrowd"

begin
    # create the API client instance
    client = Pdfcrowd::HtmlToImageClient.new("demo", "ce544b6ea52a5621fb9d55f8b542d14d")

    # configure the conversion
    client.setOutputFormat("png")
    client.setDataString('<?xml version="1.0" encoding="UTF-8"?>
        <data>
          <name>World</name>
          <product>Pdfcrowd API</product>
        </data>')

    # run the conversion and write the result to a file
    client.convertStringToFile("Hello {{ data.name }} from {{ data.product }}", "output.pdf")

rescue Pdfcrowd::Error => why
    STDERR.puts "Pdfcrowd Error: #{why}"
    raise
end

Create Image from YAML data

require "pdfcrowd"

begin
    # create the API client instance
    client = Pdfcrowd::HtmlToImageClient.new("demo", "ce544b6ea52a5621fb9d55f8b542d14d")

    # configure the conversion
    client.setOutputFormat("png")
    client.setDataString("name: World
product: Pdfcrowd API")

    # run the conversion and write the result to a file
    client.convertStringToFile("Hello {{ name }} from {{ product }}", "output.pdf")

rescue Pdfcrowd::Error => why
    STDERR.puts "Pdfcrowd Error: #{why}"
    raise
end

Create Image from CSV data

require "pdfcrowd"

begin
    # create the API client instance
    client = Pdfcrowd::HtmlToImageClient.new("demo", "ce544b6ea52a5621fb9d55f8b542d14d")

    # configure the conversion
    client.setOutputFormat("png")
    client.setDataString("name,product
World,Pdfcrowd API")

    # run the conversion and write the result to a file
    client.convertStringToFile("Hello {{ name }} from {{ product }}", "output.pdf")

rescue Pdfcrowd::Error => why
    STDERR.puts "Pdfcrowd Error: #{why}"
    raise
end

Rails examples

Webpage to PNG in Rails

require "pdfcrowd"

class DemoController < ApplicationController
    def convert
        # the recommended method is POST
        # may be restricted by ":via => :post" in your routes.rb
        if ! request.post?
            return render text: "POST is allowed only", status: 400
        end

        begin
            # create the API client instance
            client = Pdfcrowd::HtmlToImageClient.new("demo", "ce544b6ea52a5621fb9d55f8b542d14d")

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

            # run the conversion and store the result into the "image" variable
            image = client.convertUrl("http://www.example.com")

            # send the result and set HTTP response headers
            send_data image,
                      :type => "image/png",
                      :disposition => "attachment; filename*=UTF-8''#{ERB::Util.url_encode('example.png')}"
        rescue Pdfcrowd::Error => why
            # send the error in the HTTP response
            render plain: why.getMessage(), status: why.getCode()
        end
    end
end

HTML file to PNG in Rails

require "pdfcrowd"

class DemoController < ApplicationController
    def convert
        # the recommended method is POST
        # may be restricted by ":via => :post" in your routes.rb
        if ! request.post?
            return render text: "POST is allowed only", status: 400
        end

        begin
            # create the API client instance
            client = Pdfcrowd::HtmlToImageClient.new("demo", "ce544b6ea52a5621fb9d55f8b542d14d")

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

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

            # send the result and set HTTP response headers
            send_data image,
                      :type => "image/png",
                      :disposition => "attachment; filename*=UTF-8''#{ERB::Util.url_encode('MyLayout.png')}"
        rescue Pdfcrowd::Error => why
            # send the error in the HTTP response
            render plain: why.getMessage(), status: why.getCode()
        end
    end
end

HTML string to PNG in Rails

require "pdfcrowd"

class DemoController < ApplicationController
    def convert
        # the recommended method is POST
        # may be restricted by ":via => :post" in your routes.rb
        if ! request.post?
            return render text: "POST is allowed only", status: 400
        end

        begin
            # create the API client instance
            client = Pdfcrowd::HtmlToImageClient.new("demo", "ce544b6ea52a5621fb9d55f8b542d14d")

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

            # run the conversion and store the result into the "image" variable
            image = client.convertString("<html><body><h1>Hello World!</h1></body></html>")

            # send the result and set HTTP response headers
            send_data image,
                      :type => "image/png",
                      :disposition => "attachment; filename*=UTF-8''#{ERB::Util.url_encode('HelloWorld.png')}"
        rescue Pdfcrowd::Error => why
            # send the error in the HTTP response
            render plain: why.getMessage(), status: why.getCode()
        end
    end
end