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 an API client instance.
    client = Pdfcrowd::HtmlToImageClient.new("demo", "demo")

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

    # Run the conversion and save 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 an API client instance.
    client = Pdfcrowd::HtmlToImageClient.new("demo", "demo")

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

    # Run the conversion and store the result in 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 an API client instance.
    client = Pdfcrowd::HtmlToImageClient.new("demo", "demo")

    # 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 to 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 an API client instance.
    client = Pdfcrowd::HtmlToImageClient.new("demo", "demo")

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

    # Run the conversion and save 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 an API client instance.
    client = Pdfcrowd::HtmlToImageClient.new("demo", "demo")

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

    # Run the conversion and store the result in 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 an API client instance.
    client = Pdfcrowd::HtmlToImageClient.new("demo", "demo")

    # 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 to 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 an API client instance.
    client = Pdfcrowd::HtmlToImageClient.new("demo", "demo")

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

    # Run the conversion and save 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 an API client instance.
    client = Pdfcrowd::HtmlToImageClient.new("demo", "demo")

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

    # Run the conversion and store the result in 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 an API client instance.
    client = Pdfcrowd::HtmlToImageClient.new("demo", "demo")

    # 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 to 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 an API client instance.
    client = Pdfcrowd::HtmlToImageClient.new("demo", "demo")

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

    # Run the conversion and save the result to a file.
    client.convertFileToFile("/path/to/MyLayout.html", "MyLayout.png")
    
    # print URL pointing to the debug log for this request.
    puts "Debug log url: #{client.getDebugLogUrl()}"
    
    # print number of conversion credits remaining in your account.
    puts "Remaining credit count: #{client.getRemainingCreditCount()}"
    
    # print number of credits consumed for this conversion.
    puts "Consumed credit count: #{client.getConsumedCreditCount()}"
    
    # print unique identifier assigned to this conversion job.
    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 an API client instance.
    client = Pdfcrowd::HtmlToImageClient.new("demo", "demo")

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

    # Run the conversion and save 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 an API client instance.
    client = Pdfcrowd::HtmlToImageClient.new("demo", "demo")

    # 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 save 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 an API client instance.
    client = Pdfcrowd::HtmlToImageClient.new("demo", "demo")

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

    # Run the conversion and save 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 an API client instance.
    client = Pdfcrowd::HtmlToImageClient.new("demo", "demo")

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

    # Run the conversion and save 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 an API client instance.
            client = Pdfcrowd::HtmlToImageClient.new("demo", "demo")

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

            # Run the conversion and store the result in 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, 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 an API client instance.
            client = Pdfcrowd::HtmlToImageClient.new("demo", "demo")

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

            # Run the conversion and store the result in 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, 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 an API client instance.
            client = Pdfcrowd::HtmlToImageClient.new("demo", "demo")

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

            # Run the conversion and store the result in 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, status: why.getCode()
        end
    end
end