PDFBucket

This gem allows you to integrate easily with the PDFBucket service.

Installation

Add this line to your application's Gemfile:

gem 'pdfbucket'

And then execute:

$ bundle

Usage

To encrypt a URL in your code instantiate a PDFBucket object and use its generate_url method. The new pdf_bucket will use PDF_BUCKET_API_KEY, PDF_BUCKET_API_SECRET, PDF_BUCKET_API_HOST (default is api.pdfbucket.io) ENV vars:

pdf_bucket = PDFBucket::PDFBucket.new

# You can also set any the api params, overwriting then ENV vars like this
other_pdf_bucket = PDFBucket::PDFBucket.new(api_key: '123', api_secret: '321', api_host: 'api.example.com')

# And you get the encrypted_url using the generate_url method taking into account the following order:

# Without pagination: (uri, orientation, page_size, margin, zoom)
encrypted_url = pdf_bucket.generate_url('http://example.com', :landscape, :a4, '2px', '0.7')

# With pagination: (uri, orientation, page_size, margin, zoom, expires_in, pagination, position, alignment, cache)
encrypted_url = pdf_bucket.generate_url('http://example.com', :landscape, :a4, '2px', '0.7', 0, true, :header, :center)

# Also you can pass the plain URL to PDFBucket
plain_url = pdf_bucket.generate_plain_url('http://example.com', :landscape, :a4, '2px', '0.7', 0, true, :header, :center)

Possible values for the different params:

• orientation: :landscape or :portrait
• page size: :letter or :a4
• margin: https://developer.mozilla.org/en-US/docs/Web/CSS/margin#Formal_syntax
• zoom: https://developer.mozilla.org/en-US/docs/Web/CSS/@viewport/zoom#Formal_syntax
• pagination: true or false
• position: :header or :footer
• alignment: :left, :center or :right
• expires_in: integer value in seconds
• cache: 0 to disable cache

Development

After checking out the repo, run bin/setup to install dependencies. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.