Ruby PDF library integration

Welcome to Apryse. Ruby for the Apryse SDK is supported on Linux and macOS. To get started, choose your preferred platform from the tabs below.

macOS

Ruby & macOS PDF library integration

There are two ways to use Apryse with Ruby on macOS:

• Use the precompiled universal library for Ruby 2.6+.

• Use PDFNet bindings to build your own wrappers.

To get started, please choose a tab below.

Ruby 2.6

This guide will help you get started using the precompiled Ruby wrappers. You can run Apryse samples and integrate a free trial of the Apryse SDK into Ruby application on macOS. Your free trial includes unlimited trial usage and support from solution engineers.

Prerequisites

• Ruby 2.6 - 2.7

• Apryse precompiled Python/Ruby SDK for macOS:

curl -L -O https://downloads.apryse.com/downloads/PDFNetWrappersMac.zip
unzip PDFNetWrappersMac.zip

Run Apryse SDK in production

A commercial license key is required for use in a production environment. Please fill out our licensing form if you do not have a valid license key.

Keep your commercial license key confidential.

License keys are uniquely generated. Please make sure that it is not publicly available (e.g. in your public GitHub).

Initial setup

1. Download the Python and Ruby prebuilt binaries.

2. Extract the downloaded zip file and navigate to it.

3. Navigate to the /PDFNetC/Lib directory of the Python SDK download and execute:

sh ./fix_rpaths.sh

1. Get your Apryse trial key.

Run the samples

Run a specific sample

1. Navigate to the RUBY folder in the sample, for example /Samples/RUBY and execute ./RunTest.sh.

Run all samples

1. To run all tests, navigate to /Samples and execute the runall_ruby file:

./runall_ruby.sh

The tests will run one by one.

Output files will be in /Samples/TestFiles/Output

Integrate into your application

This section will show you how to use our SDK to create a simple Apryse "Hello World!" application. It will create a document with one blank page and save it as a linearized PDF in its running directory.

1. Navigate to your /Samples directory and make a new directory called myApp (if it does not exist already). This guide will assume your application is named myApp. For organization, create a new directory inside myApp called RUBY.

2. Navigate inside that RUBY folder and create a new Ruby file called myApp.rb. Open it with your favorite text editor and paste this into it:

require '../../../PDFNetC/Lib/PDFNetRuby'
include PDFNetRuby
$stdout.sync = true
  PDFNet.Initialize("YOUR_APRYSE_LICENSE_KEY")         # PDFNet must be initialized before accessing any Apryse API
  doc = PDFDoc.new()
  page = doc.PageCreate()     # Start a new page
  doc.PagePushBack(page)      # Add the page to the document
  doc.Save("output.pdf", SDFDoc::E_linearized);   # Save the document as a linearized PDF
  puts "Hello World!"

Run your application by executing ruby myApp.rb. If all goes well, your console should output:

PDFNet is running in demo mode.
Permission: write
Hello World!

Check the output.pdf that the program output in the same directory. It should be a PDF with one blank page.

Custom Wrapper

This guide will help you build your own PDFNet Ruby wrappers by binding a free trial of the PDFNetC library to Ruby. It will also show you how to run Apryse samples and integrate the Apryse SDK into Ruby applications on macOS. Your free trial includes unlimited trial usage and support from solution engineers.

Prerequisites

• Ruby version 2.x - 3.2

• CMake version ≥ 2.8

• SWIG 2.0.4 - 2.0.12 or SWIG 3.0.12 or SWIG 4.0.2+ (Ruby 2.7+)

• Download the Apryse PDF library for macOS:

curl -L -O https://downloads.apryse.com/downloads/PDFNetCMac.zip
unzip PDFNetCMac.zip

Run Apryse SDK in production

A commercial license key is required for use in a production environment. Please fill out our licensing form if you do not have a valid license key.

Keep your commercial license key confidential.

License keys are uniquely generated. Please make sure that it is not publicly available (e.g. in your public GitHub).

Initial setup

1. Make a directory to store the wrappers and navigate into that directory.

2. Clone the PDFNet Wrappers project, select the correct branch for your release afterwards. This is typically a numbered release such as 11.11, 11.12, 11.13 and 12.0.

git clone https://github.com/ApryseSDK/
git checkout <SDK Version>

1. Navigate to PDFNetWrappers/PDFNetC. Download the Apryse SDK using the method described in the Prerequisites section, and place the downloaded package in this directory and unzip it.

2. Now, to move the headers in place, make sure you're in the PDFNetWrappers/PDFNetC directory and execute:

mv PDFNetCMac/Headers/ .

and

mv PDFNetCMac/Lib/ .

to move the PDFNet libraries in place.

You can delete PDFNetCMac.zip to free up space.

Your /PDFNetC folder should be laid out like this like this:

PDFNetC
├── Headers
├── Lib
├── PDFNetCMac
└── README.txt

1. Make a build directory inside /PDFNetWrappers and navigate to it. This guide will assume the build directory is called Build.

2. Execute:

cmake -D BUILD_PDFNetRuby=ON ..

If all goes well, you should get a message that reads:

Build files have been written to ~/PDFNetWrappers/Build

1. Execute make followed by sudo make install.

2. Next, we need to fix the rpaths issue on Mac. While still in the same Build directory, execute these lines:

cp ../fix_rpaths.sh ../PDFNetC/Lib/
cd ../PDFNetC/Lib/
sudo sh ./fix_rpaths.sh

1. Get your Apryse trial key.

You are now ready to run the samples or integrate Apryse SDK into your own application.

Run the samples

Run a specific sample

1. Navigate to the RUBY folder in the sample, for example /Samples/AddImageTest/RUBY and execute ./RunTest.sh

Run all Samples

1. Navigate to /Samples and execute:

./runall_ruby.sh

The tests will run one by one.

Output files will be in /Samples/TestFiles/Output

Integrate into your application

This section will show you how to use our SDK to create a simple Apryse "Hello World!" application. It will create a document with one blank page and save it as a linearized PDF in its running directory.

1. Navigate to your /Samples directory and make a new directory called myApp (if it does not exist already). This guide will assume your application is named myApp. For organization, create a new directory inside myApp called RUBY.

2. Navigate inside that RUBY folder and create a new Ruby file called myApp.rb. Open it with your favorite text editor and paste this into it:

require '../../../PDFNetC/Lib/PDFNetRuby'
include PDFNetRuby
$stdout.sync = true
  PDFNet.Initialize("YOUR_APRYSE_LICENSE_KEY")         # PDFNet must be initialized before accessing any Apryse API
  doc = PDFDoc.new()
  page = doc.PageCreate()     # Start a new page
  doc.PagePushBack(page)      # Add the page to the document
  doc.Save("output.pdf", SDFDoc::E_linearized);   # Save the document as a linearized PDF
  puts "Hello World!"

Run your application by executing ruby myApp.rb. If all goes well, your console should output:

PDFNet is running in demo mode.
Permission: write
Hello World!

Check the output.pdf that the program output in the same directory. It should be a PDF with one blank page.

Linux

Ruby & Linux PDF library integration

This guide will help you build your own PDFNet Ruby wrappers by binding a free trial of the PDFNetC library to Ruby. It will also show you how to run Apryse samples and integrate the Apryse SDK into Ruby applications on Linux. Your free trial includes unlimited trial usage and support from solution engineers.

Prerequisites

• Ruby version 2.x, 3.x

• CMake version ≥ 2.8

• SWIG 2.0.4 - 2.0.12 or SWIG 3.0.12 or SWIG 4.0.2 - 4.2.1 (Ruby 2.7+) or SWIG 4.3.0+ (Ruby 3.2+)

• Download the Apryse Ruby SDK for Linux:

Or download from the command line:

64-bit Ruby SDK

wget https://downloads.apryse.com/downloads/PDFNetC64.tar.gz

32-bit Ruby SDK

wget https://downloads.apryse.com/downloads/PDFNetC.tar.gz

Run Apryse SDK in production

A commercial license key is required for use in a production environment. Please contact sales to purchase a commercial key or if you need any other license key assistance.

Keep your commercial license key confidential.

License keys are uniquely generated. Please make sure that it is not publicly available (e.g. in your public GitHub).

Initial setup

1. Create a directory to store the wrappers, then navigate into it.

2. Clone the PDFNet Wrappers project, then select the correct branch for your release. This is typically a numbered release such as 11.11, 11.12, 11.13, and 12.0.

git clone https://github.com/apryse.com/PDFNetWrappers
git checkout <SDK Version>

1. Navigate to PDFNetWrappers/PDFNetC. Download the Apryse Ruby SDK using one of the methods described in the Prerequisites section, and place the downloaded package in this directory. Ensure the SDK architecture matches your Ruby interpreter (32-bit or 64-bit).

2. Unpack PDFNetC64.tar.gz via tar xvzf PDFNetC64.tar.gz, then execute:

mv PDFNetC64/Headers/ .

and

mv PDFNetC64/Lib/ .

and move the PDFNet libraries in place. You can delete PDFNetC64.tar.gz to free up space. Your /PDFNetC folder should be laid out like this:

PDFNetC
├── Headers
├── Lib
├── PDFNetC64
└── README.txt

1. Make a build directory inside /PDFNetWrappers and navigate to it. This guide will assume the build directory is called Build.

2. Execute:

cmake -D BUILD_PDFNetRuby=ON ..

If all goes well, you should get a message that reads:

Build files have been written to ~/PDFNetWrappers/Build

1. Execute make followed by sudo make install. You are now ready to run the samples or integrate Apryse SDK into your own application.

2. Get your Apryse trial key.

Run the samples

Run a specific sample

1. Navigate to the RUBY folder in the sample, for example /Samples/AddImageTest/RUBY and execute ./RunTest.sh

Run all samples

1. Navigate to /Samples and execute:

./runall_ruby.sh

The tests will run one by one.

Output files will be in /Samples/TestFiles/Output

Integrate into your application

This section will show you how to use our SDK to create a simple Apryse "Hello World!" application. It will create a document with one blank page and save it as a linearized PDF in its running directory.

1. Navigate to your /Samples directory and make a new directory called myApp (if it does not exist already). This guide will assume your application is named myApp. For organization, create a new directory inside myApp called RUBY.

2. Navigate inside that RUBY folder and create a new Ruby file called myApp.rb. Open it with your favorite text editor and paste this into it:

require '../../../PDFNetC/Lib/PDFNetRuby'
include PDFNetRuby

$stdout.sync = true

  PDFNet.Initialize("YOUR_APRYSE_LICENSE_KEY")         # PDFNet must be initialized before accessing any Apryse API
  doc = PDFDoc.new()
  page = doc.PageCreate()     # Start a new page
  doc.PagePushBack(page)      # Add the page to the document
  doc.Save("output.pdf", SDFDoc::E_linearized);   # Save the document as a linearized PDF
  puts "Hello World!"

1. Run your application by executing ruby myApp.rb. If all goes well, your console should output:

PDFNet is running in demo mode.
Permission: write
Hello World!

Check the output.pdf that the program outputs in the same directory. It should be a PDF with one blank page.

Next step

GuidesSamples

Troubleshooting

Check the troubleshooting page and our PDFNetWrappers github if you run into any issues going through this document.