Project

pdf_meta

0.0
No commit activity in last 3 years
No release in over 3 years
A gem for reading file data from poppler pdfinfo
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 Dependencies

Development

~> 1.9
>= 0
~> 10.0

Runtime

 Project Readme

PDFMeta

PDFMeta is a gem designed to resiliantly return metadata from a PDF, using poppler/xpdf command line tools

Installation

Install the poppler command line tools:

###OSX

brew install poppler

###Debian Based

apt-get install poppler-utils

Add this line to your application's Gemfile:

gem 'pdf_meta'

And then execute:

$ bundle

Or install it yourself as:

$ gem install pdf_meta

Configuration

You shouldn't need to configure the gem, however if you've installed pdfinfo in a custom location then pass it here

PDFMeta.configure do |config|
  config[:command_path] = '/path/to/pdfinfo' #=> Default is just 'pdfinfo' in path
end

Usage

There's only one call to the API, it takes either a string path to a file, or an open file handle

PDFMeta.read('path/to/file')

PDFMeta.read(File.open('path/to/file'))

It will return either a PDFMeta::Results or raise one of the following errors:

  • PopplerMissingError
  • UnknownError
  • UnableToReadFileError
  • UnableOpenOutputFileError
  • PDFPermissionError
  • UnknownPopplerError

Development

After checking out the repo, run bin/setup to install dependencies. Then, 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 to create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

  1. Fork it ( https://github.com/boardiq/pdf_meta/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request