pdf_meta 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9e9f12db955d00234ed51e48f58b1800e13ca3f2
+  data.tar.gz: 0f243667baf7db768ab67a67abab28802ffe66b7
+SHA512:
+  metadata.gz: b42fd05c5a5d38c6be7374e204b32df299a884522335de7d9836cc49659ec46a8367bdcab208e05bcffeabcdecf48a1fb107ea1a42c6b021600c447a6d9d08e7
+  data.tar.gz: c35a3ce898f7b30c066812f0aca5523c1ee5931be6a2dd1772c7a0d2f51ce46f85a94ec60397de249d338f4d282bfe110c3f3b5d6dcbcb8403dc5b68cb788176

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pdf_meta.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Adam Carlile
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# PdfMeta
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/pdf_meta`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pdf_meta'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pdf_meta
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/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

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'spec'
+  t.pattern = "spec/*_spec.rb"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pdf_meta"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/pdf_meta/command.rb

@@ -0,0 +1,34 @@
+module PDFMeta
+  class Command
+
+    def initialize(path='', options={})
+      raise ArgumentError  if path.empty?
+
+      @path    = path
+      @options = default_options.merge(options)
+    end
+
+    def run!
+      runner = PDFMeta::Runner.new(command)
+      if runner.success?
+        PDFMeta::Parser.new(runner.output).results
+      else
+        raise runner.error
+      end
+    end
+
+    private
+
+      def command
+        [@options[:command], @options[:switches], @path].compact.join(' ')
+      end
+
+      def default_options
+        {
+          command: 'pdfinfo',
+          switches: nil
+        }
+      end
+
+  end
+end

data/lib/pdf_meta/parser.rb

@@ -0,0 +1,24 @@
+module PDFMeta
+  class Parser
+    
+    def initialize(output)
+      @output = output
+    end
+
+    def results
+      @results ||= PDFMeta::Results.new(parsed_output)
+    end
+
+    private
+
+    def parsed_output
+      out = @output.split("\n").map {|x| x.split(':', 2)}
+      hash = {}
+      out = out.each do |row|
+        hash[row.first.underscore.parameterize.underscore.to_sym] = row.last.strip
+      end
+      hash
+    end
+
+  end
+end

data/lib/pdf_meta/results/file_size.rb

@@ -0,0 +1,11 @@
+module PDFMeta
+  class Results
+    class FileSize < Virtus::Attribute
+
+      def coerce(value)
+        value.to_i
+      end
+
+    end
+  end
+end

data/lib/pdf_meta/results/page_size.rb

@@ -0,0 +1,18 @@
+module PDFMeta
+  class Results
+    class PageSize
+      include Virtus.model
+
+      attribute :height, Float
+      attribute :width,  Float
+      attribute :units,  String
+
+      def initialize(value)
+        self.units   = value.split(' ').last
+        self.height  = value.split(' ')[0]
+        self.width   = value.split(' ')[2]
+      end
+
+    end
+  end
+end

data/lib/pdf_meta/results.rb

@@ -0,0 +1,25 @@
+module PDFMeta
+  class Results
+    include Virtus.model
+
+    attribute :title,           String
+    attribute :author,          String
+    attribute :creator,         String
+    attribute :producer,        String
+    attribute :creation_date,   DateTime
+    attribute :mod_date,        DateTime
+    attribute :tagged,          Boolean
+    attribute :user_properties, Boolean
+    attribute :suspects,        Boolean
+    attribute :form,            String
+    attribute :java_script,     Boolean
+    attribute :pages,           Integer
+    attribute :encrypted,       Boolean
+    attribute :page_size,       PDFMeta::Results::PageSize
+    attribute :page_rot,        Integer
+    attribute :file_size,       PDFMeta::Results::FileSize
+    attribute :optimized,       Boolean
+    attribute :pdf_version,     Float
+
+  end
+end

data/lib/pdf_meta/runner.rb

@@ -0,0 +1,32 @@
+module PDFMeta
+  class Runner
+  
+    attr_reader :output
+    def initialize(command)
+      stdin, stdout, stderr, wait_thr = Open3.popen3(command)
+      @output  = stdout.read
+      @error   = stderr.read
+      @process = wait_thr.value 
+    end
+
+    def success?
+      @process.success?
+    end
+
+    def error
+      error_mapping[@process.exitstatus].new(@error)
+    end
+
+    private
+
+      def error_mapping
+        @error_mapping ||= Hash.new(UnknownError).merge({
+          1 =>  PDFMeta::UnableToReadFileError,
+          2 =>  PDFMeta::UnableOpenOutputFileError,
+          3 =>  PDFMeta::PDFPermissionError,
+          99 => PDFMeta::UnknownPopplerError
+        })
+      end
+
+  end
+end

data/lib/pdf_meta/version.rb

@@ -0,0 +1,3 @@
+module PDFMeta
+  VERSION = "0.1.0"
+end

data/lib/pdf_meta.rb

@@ -0,0 +1,58 @@
+require "active_support"
+require "active_support/core_ext"
+require "virtus"
+require "open3"
+require "pry"
+
+require "pdf_meta/version"
+
+require "pdf_meta/command"
+require "pdf_meta/runner"
+require "pdf_meta/parser"
+
+require "pdf_meta/results/file_size"
+require "pdf_meta/results/page_size"
+require "pdf_meta/results"
+
+
+module PDFMeta
+  PopplerMissingError         = Class.new(StandardError)
+  UnknownError                = Class.new(StandardError)
+  UnableToReadFileError       = Class.new(StandardError)
+  UnableOpenOutputFileError   = Class.new(StandardError)
+  PDFPermissionError          = Class.new(StandardError)
+  UnknownPopplerError         = Class.new(StandardError)
+
+  module_function
+
+  def config
+    @config ||= {
+      command_path: 'pdfinfo'
+    }
+  end
+
+  def configure &block
+    reset!
+    yield(config) if block_given?
+  end
+
+  def reset!
+    @config    = nil
+    @available = nil
+  end
+
+  def read(file)
+    raise PopplerMissingError unless available?
+    out = case file
+      when File then file.path
+      else file
+    end 
+    PDFMeta::Command.new(out).run!
+  end
+
+  def available?
+    @available ||= system("which #{config[:command_path]}")
+  end
+
+
+end

data/pdf_meta.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pdf_meta/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pdf_meta"
+  spec.version       = PDFMeta::VERSION
+  spec.authors       = ["Adam Carlile"]
+  spec.email         = ["adam.carlile@boardintelligence.co.uk"]
+
+  spec.summary       = %q{A gem for reading file data from poppler pdfinfo}
+  spec.homepage      = "http://github.com/boardiq/pdf_meta"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport"
+  spec.add_dependency "virtus"
+
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "awesome_print"
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: pdf_meta
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adam Carlile
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-05-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- adam.carlile@boardintelligence.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pdf_meta.rb
+- lib/pdf_meta/command.rb
+- lib/pdf_meta/parser.rb
+- lib/pdf_meta/results.rb
+- lib/pdf_meta/results/file_size.rb
+- lib/pdf_meta/results/page_size.rb
+- lib/pdf_meta/runner.rb
+- lib/pdf_meta/version.rb
+- pdf_meta.gemspec
+homepage: http://github.com/boardiq/pdf_meta
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: A gem for reading file data from poppler pdfinfo
+test_files: []
+has_rdoc: