pdfinfo 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e5a425d0b0736d042ad6cb90cd730ec12b1086cc
+  data.tar.gz: f50db651591c946a6788ccdbb12ff3d9093ff789
+SHA512:
+  metadata.gz: e4b84b0d845a22db0e09d7651d6a62bd1af84108baa533af16d48975bfdba3ae28f3db9430acfb34e8a5c32aa894593910af66e93f994ad89f32aa69ae5a9d01
+  data.tar.gz: 17b53e239955de60c1c75a531b3dbfe603c1e92d356f425aa0cb94c2f01a151943876034528d4b9ed2b3917d1163dc3cc10198ad171379df4b6bfe8dbd5642a5

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format documentation
+--require spec_helper

data/.ruby-gemset

@@ -0,0 +1 @@
+pdfinfo

data/.ruby-version

@@ -0,0 +1 @@
+2.1.2

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ryan Venegas
+
+MIT License
+
+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,29 @@
+# Pdfinfo
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'pdfinfo'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pdfinfo
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/pdfinfo/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,6 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/pdfinfo.rb

@@ -0,0 +1,65 @@
+require 'open3'
+require 'pathname'
+
+class Pdfinfo
+  DIMENSIONS_REGEXP = /(\d+) x (\d+)/
+
+  attr_reader :creator,
+    :producer,
+    :form,
+    :page_count,
+    :width,
+    :height,
+    :file_size,
+    :pdf_version
+
+  def self.exec(file_path)
+    stdout, stderr, status = Open3.capture2e("pdfinfo #{file_path}")
+    stdout.chomp
+  end
+
+  def self.pdfinfo_command
+    @pdfinfo_command || 'pdfinfo'
+  end
+
+  def self.pdfinfo_command=(cmd)
+    @pdfinfo_command = cmd
+  end
+
+  def initialize(source_path)
+    info_hash = parse_shell_response(exec(source_path))
+
+    @creator        = info_hash['Creator']
+    @producer       = info_hash['Producer']
+    @tagged         = !!(info_hash['Tagged'] =~ /yes/)
+    @form           = info_hash['Form']
+    @page_count     = info_hash['Pages'].to_i
+    @encrypted      = !!(info_hash['Encrypted'] =~ /yes/)
+    @width, @height = extract_page_dimensions(info_hash['Page size'])
+    @file_size      = info_hash['File size'].to_i
+    @pdf_version    = info_hash['PDF version']
+  end
+
+  def tagged?
+    @tagged
+  end
+
+  def encrypted?
+    @encrypted
+  end
+
+  private
+
+  def exec(file_path)
+    self.class.exec(file_path)
+  end
+
+  def parse_shell_response(response_str)
+    Hash[response_str.split(/\n/).map {|kv| kv.split(/:\s+/) }]
+  end
+
+  def extract_page_dimensions(str)
+    return unless str
+    str.match(DIMENSIONS_REGEXP).captures.map(&:to_i)
+  end
+end

data/lib/pdfinfo/version.rb

@@ -0,0 +1,3 @@
+class Pdfinfo
+  VERSION = '0.0.1'
+end

data/pdfinfo.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pdfinfo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pdfinfo"
+  spec.version       = Pdfinfo::VERSION
+  spec.authors       = ["Ryan Venegas"]
+  spec.email         = ["RVenegas2@Gmail.com"]
+  spec.summary       = %q{Simple ruby wrapper around the pdfinfo executable}
+  spec.description   = %q{Simple ruby wrapper around the pdfinfo executable}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rake"
+end

data/spec/fixtures/shell_response.txt

@@ -0,0 +1,10 @@
+Creator:        Prawn
+Producer:       Prawn
+Tagged:         no
+Form:           none
+Pages:          3
+Encrypted:      no
+Page size:      612 x 792 pts (letter) (rotated 0 degrees)
+File size:      1521 bytes
+Optimized:      no
+PDF version:    1.3

data/spec/fixtures/test.pdf

@@ -0,0 +1,127 @@
+%PDF-1.3
+%����
+1 0 obj
+<< /Creator <feff0050007200610077006e>
+/Producer <feff0050007200610077006e>
+>>
+endobj
+2 0 obj
+<< /Type /Catalog
+/Pages 3 0 R
+>>
+endobj
+3 0 obj
+<< /Type /Pages
+/Count 3
+/Kids [5 0 R 8 0 R 10 0 R]
+>>
+endobj
+4 0 obj
+<< /Length 71
+>>
+stream
+q
+
+BT
+36 747.384 Td
+/F1.0 12 Tf
+[<50> 120 <41> 30 <47452031>] TJ
+ET
+
+Q
+
+endstream
+endobj
+5 0 obj
+<< /Type /Page
+/Parent 3 0 R
+/MediaBox [0 0 612.0 792.0]
+/Contents 4 0 R
+/Resources << /ProcSet [/PDF /Text /ImageB /ImageC /ImageI]
+/Font << /F1.0 6 0 R
+>>
+>>
+>>
+endobj
+6 0 obj
+<< /Type /Font
+/Subtype /Type1
+/BaseFont /Helvetica
+/Encoding /WinAnsiEncoding
+>>
+endobj
+7 0 obj
+<< /Length 71
+>>
+stream
+q
+
+BT
+36 747.384 Td
+/F1.0 12 Tf
+[<50> 120 <41> 30 <47452032>] TJ
+ET
+
+Q
+
+endstream
+endobj
+8 0 obj
+<< /Type /Page
+/Parent 3 0 R
+/MediaBox [0 0 612.0 792.0]
+/Contents 7 0 R
+/Resources << /ProcSet [/PDF /Text /ImageB /ImageC /ImageI]
+/Font << /F1.0 6 0 R
+>>
+>>
+>>
+endobj
+9 0 obj
+<< /Length 71
+>>
+stream
+q
+
+BT
+36 747.384 Td
+/F1.0 12 Tf
+[<50> 120 <41> 30 <47452033>] TJ
+ET
+
+Q
+
+endstream
+endobj
+10 0 obj
+<< /Type /Page
+/Parent 3 0 R
+/MediaBox [0 0 612.0 792.0]
+/Contents 9 0 R
+/Resources << /ProcSet [/PDF /Text /ImageB /ImageC /ImageI]
+/Font << /F1.0 6 0 R
+>>
+>>
+>>
+endobj
+xref
+0 11
+0000000000 65535 f 
+0000000015 00000 n 
+0000000109 00000 n 
+0000000158 00000 n 
+0000000228 00000 n 
+0000000349 00000 n 
+0000000527 00000 n 
+0000000624 00000 n 
+0000000745 00000 n 
+0000000923 00000 n 
+0000001044 00000 n 
+trailer
+<< /Size 11
+/Root 2 0 R
+/Info 1 0 R
+>>
+startxref
+1223
+%%EOF

data/spec/pdfinfo_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_helper'
+
+RSpec.describe Pdfinfo do
+  let(:pdf_path) { fixture_path('test.pdf') }
+  let(:pdfinfo) { described_class.new(pdf_path) }
+  let(:mock_response) { File.read(fixture_path('shell_response.txt')).chomp }
+
+  before(:suite) do
+    # validate that our mock response matches the real response
+    expect(described_class.exec(pdf_path)).to eq(mock_response)
+  end
+
+  before(:each) do
+    allow(described_class).to receive(:exec).and_return(mock_response)
+  end
+
+  describe 'pdfinfo_command' do
+    it "falls back to pdfinfo" do
+      Pdfinfo.pdfinfo_command = nil
+      expect(Pdfinfo.pdfinfo_command).to eq('pdfinfo')
+    end
+
+    it 'allows the command to be changed' do
+      Pdfinfo.pdfinfo_command = '/another/bin/path/pdfinfo'
+      expect(Pdfinfo.pdfinfo_command).to eq('/another/bin/path/pdfinfo')
+    end
+  end
+
+  describe '#creator' do
+    context 'when given a creator' do
+      it { expect(pdfinfo.creator).to eq('Prawn') }
+    end
+    context 'when creator is not present' do
+      let(:mock_response) { "Creator: \n" }
+      it { expect(pdfinfo.creator).to be_nil }
+    end
+  end
+
+  describe '#producer' do
+    context 'when given a creator' do
+      it { expect(pdfinfo.producer).to eq('Prawn') }
+    end
+    context 'when creator is not present' do
+      let(:mock_response) { "Producer: \n" }
+      it { expect(pdfinfo.producer).to be_nil }
+    end
+  end
+
+  describe 'tagged?' do
+    context 'when tagged' do
+      let(:mock_response) { "Tagged: yes" }
+      it { expect(pdfinfo.tagged?).to eq(true) }
+    end
+    context 'when not tagged' do
+      let(:mock_response) { "Tagged: no" }
+      it { expect(pdfinfo.tagged?).to eq(false) }
+    end
+  end
+
+  describe '#form' do
+    it { expect(pdfinfo.form).to eq('none') }
+  end
+
+  describe 'page_count' do
+    it 'returns a fixnum value of the number of pages' do
+      expect(pdfinfo.page_count).to eq(3)
+    end
+  end
+
+  describe 'encrypted?' do
+    context 'given encrypted pdf' do
+      let(:mock_response) { "Encrypted: yes\n" }
+      it { expect(pdfinfo.encrypted?).to eq(true) }
+    end
+    context 'given unencrypted pdf' do
+      let(:mock_response) { 'Encrypted: no' }
+      it { expect(pdfinfo.encrypted?).to eq(false) }
+    end
+  end
+
+  describe 'width' do
+    it { expect(pdfinfo.width).to eq(612) }
+  end
+
+  describe 'height' do
+    it { expect(pdfinfo.height).to eq(792) }
+  end
+
+  describe 'size' do
+    it 'returns a fixnm value for the file size in bytes' do
+      expect(pdfinfo.file_size).to eq(1521)
+    end
+  end
+
+  describe 'pdf_version' do
+    it 'returns a string value for the PDF spec version' do
+      expect(pdfinfo.pdf_version).to eq('1.3')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,36 @@
+require File.expand_path("#{__dir__}/../lib/pdfinfo")
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    # expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  config.disable_monkey_patching!
+
+  config.warnings = false
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  # config.profile_examples = 10
+
+  config.order = :random
+
+  Kernel.srand config.seed
+
+  config.before(:each) do
+    Pdfinfo.instance_variable_set(:@pdfinfo_command, nil)
+  end
+end
+
+def fixture_path(path)
+  Pathname.new(File.expand_path(File.join("../fixtures", path), __FILE__))
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: pdfinfo
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ryan Venegas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: rake
+  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'
+description: Simple ruby wrapper around the pdfinfo executable
+email:
+- RVenegas2@Gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pdfinfo.rb
+- lib/pdfinfo/version.rb
+- pdfinfo.gemspec
+- spec/fixtures/shell_response.txt
+- spec/fixtures/test.pdf
+- spec/pdfinfo_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Simple ruby wrapper around the pdfinfo executable
+test_files:
+- spec/fixtures/shell_response.txt
+- spec/fixtures/test.pdf
+- spec/pdfinfo_spec.rb
+- spec/spec_helper.rb