PDF to PDF Ruby Examples

Complete Ruby examples for common PDF to PDF tasks. See the Ruby SDK guide for installation and result handling.

You can run the examples below with the displayed API credentials. Update the input URLs and filenames as needed. Each Ruby example can be copied and run independently.

Merging

Add PDFs in the order they should appear in the merged document. Choose file, in-memory, or output-stream handling for the result. The stream example uses a binary file stream as its destination.

Merge PDF files

Merge first.pdf and second.pdf in that order.

Save to a file

require 'pdfcrowd'

client = Pdfcrowd::PdfToPdfClient.new('demo', 'demo')

client.addPdfFile('first.pdf')
client.addPdfFile('second.pdf')
client.convertToFile('merged.pdf')

Keep in memory

require 'pdfcrowd'

client = Pdfcrowd::PdfToPdfClient.new('demo', 'demo')

client.addPdfFile('first.pdf')
client.addPdfFile('second.pdf')
pdf = client.convert() # binary String
puts pdf.bytesize

Write to a stream

require 'pdfcrowd'

client = Pdfcrowd::PdfToPdfClient.new('demo', 'demo')

File.open('merged.pdf', 'wb') do |output_stream|
  client.addPdfFile('first.pdf')
  client.addPdfFile('second.pdf')
  client.convertToStream(output_stream)
end

Merge raw PDF bytes

Read first.pdf and second.pdf as binary data. In an application, pass the bytes you already hold in memory instead.

Save to a file

require 'pdfcrowd'

client = Pdfcrowd::PdfToPdfClient.new('demo', 'demo')

pdf_data_1 = File.binread('first.pdf') # binary String
pdf_data_2 = File.binread('second.pdf') # binary String
client.addPdfRawData(pdf_data_1)
client.addPdfRawData(pdf_data_2)
client.convertToFile('merged.pdf')

Keep in memory

require 'pdfcrowd'

client = Pdfcrowd::PdfToPdfClient.new('demo', 'demo')

pdf_data_1 = File.binread('first.pdf') # binary String
pdf_data_2 = File.binread('second.pdf') # binary String
client.addPdfRawData(pdf_data_1)
client.addPdfRawData(pdf_data_2)
pdf = client.convert() # binary String
puts pdf.bytesize

Merge bytes with a file

Add the bytes from first.pdf, followed by second.pdf, and save the result to merged.pdf.

require 'pdfcrowd'

client = Pdfcrowd::PdfToPdfClient.new('demo', 'demo')

pdf_data_1 = File.binread('first.pdf') # binary String
client.addPdfRawData(pdf_data_1)
client.addPdfFile('second.pdf')
client.convertToFile('merged.pdf')

PDF operations

Add a watermark

Apply watermark.pdf to proposal.pdf and save company_offer.pdf.

require 'pdfcrowd'

client = Pdfcrowd::PdfToPdfClient.new('demo', 'demo')

client.setPageWatermark('watermark.pdf')
client.addPdfFile('proposal.pdf')
client.convertToFile('company_offer.pdf')

Linearize a PDF

Optimize not_linearized.pdf for progressive loading in a browser and save it as linearized.pdf.

require 'pdfcrowd'

client = Pdfcrowd::PdfToPdfClient.new('demo', 'demo')

client.setLinearize(true)
client.addPdfFile('not_linearized.pdf')
client.convertToFile('linearized.pdf')

Extract pages

Extract page 3 and pages 7 through the end of 13_pages.pdf into output.pdf.

require 'pdfcrowd'

client = Pdfcrowd::PdfToPdfClient.new('demo', 'demo')

client.setAction('extract')
client.setPageRange('3,7-')
client.addPdfFile('13_pages.pdf')
client.convertToFile('output.pdf')

Delete pages

Remove pages 1–3 and page 10 from 13_pages.pdf and save the remaining pages to output.pdf.

require 'pdfcrowd'

client = Pdfcrowd::PdfToPdfClient.new('demo', 'demo')

client.setAction('delete')
client.setPageRange('1-3,10')
client.addPdfFile('13_pages.pdf')
client.convertToFile('output.pdf')

Split a PDF

Split 13_pages.pdf into two documents: pages 1–10 in pages1-10.pdf, and the remaining pages in pages11-end.pdf.

require 'pdfcrowd'

client = Pdfcrowd::PdfToPdfClient.new('demo', 'demo')

client.addPdfFile('13_pages.pdf')
client.setAction('extract')
client.setPageRange('1-10')
client.convertToFile('pages1-10.pdf')
client.setPageRange('11-')
client.convertToFile('pages11-end.pdf')