PDF to PDF Ruby Examples

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

Basic examples
Rails examples

Basic examples

Multiple PDFs to PDF file

require "pdfcrowd"

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

    # configure the conversion
    client.addPdfFile("/path/to/cover.pdf")
    client.addPdfFile("/path/to/proposal.pdf")
    client.addPdfFile("/path/to/price.pdf")
    client.addPdfFile("/path/to/contact.pdf")

    # run the conversion and write the result to a file
    client.convertToFile("offer.pdf")

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

Multiple PDFs to in-memory PDF

require "pdfcrowd"

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

    # configure the conversion
    client.addPdfFile("/path/to/cover.pdf")
    client.addPdfFile("/path/to/proposal.pdf")
    client.addPdfFile("/path/to/price.pdf")
    client.addPdfFile("/path/to/contact.pdf")

    # run the conversion and store the result into the "pdf" variable
    pdf = client.convert()

    # at this point the "pdf" variable contains PDF 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

Multiple PDFs to PDF stream

require "pdfcrowd"

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

    # configure the conversion
    client.addPdfFile("/path/to/cover.pdf")
    client.addPdfFile("/path/to/proposal.pdf")
    client.addPdfFile("/path/to/price.pdf")
    client.addPdfFile("/path/to/contact.pdf")

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

    # run the conversion and write the result into the output stream
    client.convertToStream(output_stream)

    # close the output stream
    output_stream.close()

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

Multiple in-memory PDFs to PDF file

require "pdfcrowd"

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

    # configure the conversion
    client.addPdfRawData(open('/path/to/cover.pdf', 'rb').read())
    client.addPdfRawData(open('/path/to/proposal.pdf', 'rb').read())
    client.addPdfRawData(open('/path/to/price.pdf', 'rb').read())
    client.addPdfRawData(open('/path/to/contact.pdf', 'rb').read())

    # run the conversion and write the result to a file
    client.convertToFile("offer.pdf")

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

Join 2 in-memory PDFs together with 2 local PDF files to PDF file

require "pdfcrowd"

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

    # configure the conversion
    client.addPdfRawData(open('/path/to/cover.pdf', 'rb').read())
    client.addPdfFile("/path/to/proposal.pdf")
    client.addPdfRawData(open('/path/to/price.pdf', 'rb').read())
    client.addPdfFile("/path/to/contact.pdf")

    # run the conversion and write the result to a file
    client.convertToFile("offer.pdf")

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

Watermark a PDF file

require "pdfcrowd"

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

    # configure the conversion
    client.addPdfFile("/path/to/proposal.pdf")
    client.setPageWatermark("/path/to/watermark.pdf")

    # run the conversion and write the result to a file
    client.convertToFile("company_offer.pdf")

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

Linearize a PDF file

require "pdfcrowd"

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

    # configure the conversion
    client.addPdfFile("/path/to/not_linearized.pdf")
    client.setLinearize(true)

    # run the conversion and write the result to a file
    client.convertToFile("linearized.pdf")

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::PdfToPdfClient.new("demo", "ce544b6ea52a5621fb9d55f8b542d14d")

    # configure the conversion
    client.setDebugLog(true)
    client.addPdfRawData(open('/path/to/cover.pdf', 'rb').read())
    client.addPdfRawData(open('/path/to/proposal.pdf', 'rb').read())

    # run the conversion and write the result to a file
    client.convertToFile("offer.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 total number of pages in the output document
    puts "Page count: #{client.getPageCount()}"
    
    # print the size of the output in bytes
    puts "Output size: #{client.getOutputSize()}"

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

Rails examples

Multiple PDFs to PDF 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::PdfToPdfClient.new("demo", "ce544b6ea52a5621fb9d55f8b542d14d")

            # configure the conversion
            client.addPdfFile("/path/to/cover.pdf")
            client.addPdfFile("/path/to/proposal.pdf")
            client.addPdfFile("/path/to/price.pdf")
            client.addPdfFile("/path/to/contact.pdf")

            # run the conversion and store the result into the "pdf" variable
            pdf = client.convert()

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

Multiple in-memory PDFs to PDF 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::PdfToPdfClient.new("demo", "ce544b6ea52a5621fb9d55f8b542d14d")

            # configure the conversion
            client.addPdfRawData(open('/path/to/cover.pdf', 'rb').read())
            client.addPdfRawData(open('/path/to/proposal.pdf', 'rb').read())
            client.addPdfRawData(open('/path/to/price.pdf', 'rb').read())
            client.addPdfRawData(open('/path/to/contact.pdf', 'rb').read())

            # run the conversion and store the result into the "pdf" variable
            pdf = client.convert()

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