Ruby 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 macOS. Your free trial includes unlimited trial usage and support from solution engineers.

• 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+)
• Apryse's Ruby PDF library for macOS:

Download the SDK

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

2. Clone the uncompiled PDFNet wrappers by executing

1git clone https://github.com/PDFTron/PDFNetWrappers

3. Navigate to PDFNetWrappers/PDFNetC and move the downloaded [PDFNet C/C++ SDK] for macOS(#prerequisites) into that directory and unzip it. Ensure you obtain the right architecture for your Ruby interpreter. This can be done with these two commands:

1curl -L -O http://www.pdftron.com/downloads/PDFNetCMac.zip
2unzip PDFNetCMac.zip

4. Now to move the headers in place, make sure you are in the PDFNetWrappers/PDFNetC directory and execute

1mv PDFNetCMac/Headers/ .

and

1mv 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:

1PDFNetC
2├── Headers
3├── Lib
4├── PDFNetCMac
5└── README.txt

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

6. Execute

1cmake -D BUILD_PDFNetRuby=ON ..

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

1Build files have been written to ~/PDFNetWrappers/Build

7. Execute make followed by sudo make install.

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

1cp ../fix_rpaths.sh ../PDFNetC/Lib/
2cd ../PDFNetC/Lib/
3sudo sh ./fix_rpaths.sh

9. Get your Apryse trial key.

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

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:

1./runall_ruby.sh

The tests will run one by one.

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:

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

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

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

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