pdf_info 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+group :development do
+  gem "rspec", "~> 2.5.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+end

data/Gemfile.lock

@@ -0,0 +1,26 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  rspec (~> 2.5.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Tom Taylor
+
+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,32 @@
+pdf_info
+==
+
+Very simple wrapper to the pdfinfo unix tool, to provide the metadata information as a hash.
+
+Example
+--
+
+    require 'pdf/info'
+    info = PDF::Info.new('/Users/tom/tmp/magazine.pdf')
+    pp info.metadata
+
+Gives you the following output:
+
+    {:version=>1.3,
+     :pages=>
+      [[819.213, 1077.17],
+       [819.213, 1077.17],
+       [819.213, 1077.17],
+       [819.213, 1077.17],
+       [819.213, 1077.17],
+       [819.213, 1077.17],
+       [819.213, 1077.17],
+       [819.213, 1077.17],
+       [819.213, 1077.17],
+       [819.213, 1077.17],
+       [819.213, 1077.17],
+       [819.213, 1077.17]],
+     :page_count=>12,
+     :encrypted=>false}
+   
+Each of the pages has an individual size - that's just how PDFs are. If you want more of the metadata that pdfinfo outputs, send us a patch.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "pdf_info"
+  gem.homepage = "http://github.com/newspaperclub/pdf_info"
+  gem.license = "MIT"
+  gem.summary = %Q{Wraps the pdfinfo command line tool to provide a hash of metadata}
+  gem.email = "tom@newspaperclub.com"
+  gem.authors = ["Tom Taylor"]
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "pdf_info #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/pdf/info/exceptions.rb

@@ -0,0 +1,12 @@
+module PDF
+  class Info
+    class UnexpectedExitError < RuntimeError
+      attr_accessor :exit_code
+    end
+
+    class UnknownError < RuntimeError; end
+    class FileError < RuntimeError; end
+    class OutputError < RuntimeError; end
+    class BadPermissionsError < RuntimeError; end
+  end
+end

data/lib/pdf/info.rb

@@ -0,0 +1,70 @@
+require 'pdf/info/exceptions'
+
+module PDF
+  class Info
+    @@command_path = "pdfinfo"
+
+    def self.command_path=(path)
+      @@command_path = path
+    end
+
+    def self.command_path
+      @@command_path
+    end
+
+    def initialize(pdf_path)
+      @pdf_path = pdf_path
+    end
+
+    def command
+      output = `#{self.class.command_path} "#{@pdf_path}" -f 1 -l -1`
+      exit_code = $? 
+      case exit_code
+      when 0
+        return output
+      else
+        exit_error = PDF::Info::UnexpectedExitError.new
+        exit_error.exit_code = exit_code
+        raise exit_error
+      end
+    end
+
+    def metadata
+      begin
+        process_output(command)
+      rescue UnexpectedExitError => e
+        case e.exit_code
+        when 1
+          raise FileError
+        when 2
+          raise OutputError
+        when 3
+          raise BadPermissionsError
+        else
+          raise UnknownError
+        end
+      end
+    end
+
+    def process_output(output)
+      rows = output.split("\n")
+      metadata = {}
+      rows.each do |row|
+        pair = row.split(':', 2)
+        case pair.first
+        when "Pages"
+          metadata[:page_count] = pair.last.to_i
+        when "Encrypted"
+          metadata[:encrypted] = pair.last == 'yes'
+        when "PDF version"
+          metadata[:version] = pair.last.to_f
+        when /^Page.*size$/
+          metadata[:pages] ||= []
+          metadata[:pages] << pair.last.scan(/[\d.]+/).map(&:to_f)
+        end
+      end
+      return metadata
+    end
+
+  end
+end

data/pdf_info.gemspec

@@ -0,0 +1,63 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{pdf_info}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Tom Taylor"]
+  s.date = %q{2011-04-15}
+  s.email = %q{tom@newspaperclub.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/pdf/info.rb",
+    "lib/pdf/info/exceptions.rb",
+    "pdf_info.gemspec",
+    "spec/output/successful.txt",
+    "spec/pdf_info_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/support/output_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/newspaperclub/pdf_info}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{Wraps the pdfinfo command line tool to provide a hash of metadata}
+  s.test_files = [
+    "spec/pdf_info_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/support/output_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 2.5.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.5.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.5.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+  end
+end
+

data/spec/output/successful.txt

@@ -0,0 +1,22 @@
+Creator:        Adobe InDesign CS2 (4.0.5)
+Producer:       Adobe PDF Library 7.0
+CreationDate:   Mon Jun 14 13:59:52 2010
+ModDate:        Mon Jun 14 14:02:15 2010
+Tagged:         no
+Pages:          12
+Encrypted:      no
+Page    1 size: 819.213 x 1077.17 pts
+Page    2 size: 819.213 x 1077.17 pts
+Page    3 size: 819.213 x 1077.17 pts
+Page    4 size: 819.213 x 1077.17 pts
+Page    5 size: 819.213 x 1077.17 pts
+Page    6 size: 819.213 x 1077.17 pts
+Page    7 size: 819.213 x 1077.17 pts
+Page    8 size: 819.213 x 1077.17 pts
+Page    9 size: 819.213 x 1077.17 pts
+Page   10 size: 819.213 x 1077.17 pts
+Page   11 size: 819.213 x 1077.17 pts
+Page   12 size: 819.213 x 1077.17 pts
+File size:      15650809 bytes
+Optimized:      no
+PDF version:    1.4

data/spec/pdf_info_spec.rb

@@ -0,0 +1,90 @@
+require 'spec_helper'
+
+describe PDF::Info do
+
+  describe "default #command_path" do
+    subject { PDF::Info }
+    its(:command_path) { should == "pdfinfo" }
+  end
+
+  describe "#command_path=" do
+    subject { PDF::Info }
+    before(:each) { subject.command_path = "/usr/bin/pdfinfo" }
+    its(:command_path) { should == "/usr/bin/pdfinfo" }
+  end
+
+  describe ".metadata" do
+
+    context "success" do
+      before(:each) do
+        @pdf_info = PDF::Info.new('test.pdf')
+        @pdf_info.stub!(:command).and_return(output('successful.txt'))
+      end
+      subject { @pdf_info.metadata }
+      its([:page_count]) { should == 12 }
+      its([:pages]) { should have(12).items }
+
+      it "should have the correct page size set" do
+        subject[:pages].each do |page|
+          page.should == [819.213, 1077.17]
+        end
+      end
+
+      its([:version]) { should == 1.4 }
+      its([:encrypted]) { should be_false }
+    end
+
+    context "error opening file" do
+      before(:each) do 
+        @pdf_info = PDF::Info.new('test.pdf')
+        unexpected_error = PDF::Info::UnexpectedExitError.new
+        unexpected_error.exit_code = 1
+        @pdf_info.stub!(:command).and_raise(unexpected_error)
+      end
+
+      it "should raise an error" do
+        lambda { @pdf_info.metadata }.should raise_error(PDF::Info::FileError)
+      end
+    end
+
+    context "error opening output" do
+      before(:each) do 
+        @pdf_info = PDF::Info.new('test.pdf')
+        unexpected_error = PDF::Info::UnexpectedExitError.new
+        unexpected_error.exit_code = 2
+        @pdf_info.stub!(:command).and_raise(unexpected_error)
+      end
+
+      it "should raise an error" do
+        lambda { @pdf_info.metadata }.should raise_error(PDF::Info::OutputError)
+      end
+    end
+
+    context "bad permissions" do
+      before(:each) do 
+        @pdf_info = PDF::Info.new('test.pdf')
+        unexpected_error = PDF::Info::UnexpectedExitError.new
+        unexpected_error.exit_code = 3
+        @pdf_info.stub!(:command).and_raise(unexpected_error)
+      end
+
+      it "should raise an error" do
+        lambda { @pdf_info.metadata }.should raise_error(PDF::Info::BadPermissionsError)
+      end
+    end
+
+    context "unknown error" do
+      before(:each) do 
+        @pdf_info = PDF::Info.new('test.pdf')
+        unexpected_error = PDF::Info::UnexpectedExitError.new
+        unexpected_error.exit_code = 4
+        @pdf_info.stub!(:command).and_raise(unexpected_error)
+      end
+
+      it "should raise an error" do
+        lambda { @pdf_info.metadata }.should raise_error(PDF::Info::UnknownError)
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'pdf/info'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.include OutputHelper
+end

data/spec/support/output_helper.rb

@@ -0,0 +1,7 @@
+module OutputHelper
+
+  def output(filename)
+    File.read(File.join(File.dirname(__FILE__), '..', 'output', filename))
+  end
+
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification 
+name: pdf_info
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Tom Taylor
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-15 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 2
+        - 5
+        - 0
+        version: 2.5.0
+  name: rspec
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  name: bundler
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  name: jeweler
+  version_requirements: *id003
+description: 
+email: tom@newspaperclub.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/pdf/info.rb
+- lib/pdf/info/exceptions.rb
+- pdf_info.gemspec
+- spec/output/successful.txt
+- spec/pdf_info_spec.rb
+- spec/spec_helper.rb
+- spec/support/output_helper.rb
+has_rdoc: true
+homepage: http://github.com/newspaperclub/pdf_info
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Wraps the pdfinfo command line tool to provide a hash of metadata
+test_files: 
+- spec/pdf_info_spec.rb
+- spec/spec_helper.rb
+- spec/support/output_helper.rb