pdfinfo 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e5a425d0b0736d042ad6cb90cd730ec12b1086cc
-  data.tar.gz: f50db651591c946a6788ccdbb12ff3d9093ff789
+  metadata.gz: 4aaac914cb686f9cdd99edfbc378b8fbb4f91ef1
+  data.tar.gz: 404f4ebdb111f48bd5b538b03f1cc08a870d1dde
 SHA512:
-  metadata.gz: e4b84b0d845a22db0e09d7651d6a62bd1af84108baa533af16d48975bfdba3ae28f3db9430acfb34e8a5c32aa894593910af66e93f994ad89f32aa69ae5a9d01
-  data.tar.gz: 17b53e239955de60c1c75a531b3dbfe603c1e92d356f425aa0cb94c2f01a151943876034528d4b9ed2b3917d1163dc3cc10198ad171379df4b6bfe8dbd5642a5
+  metadata.gz: 0c4b285a441417f340030ed932a18aabc294b3784c0d358165dcff2d220b46663b98a503c8c8cfa5b1a467edef02e1882cf8db8acd0a5c379fd9e3ffca5acf40
+  data.tar.gz: 10956090e1a0ca786a85470fe43928bac9a83bad46cb8d1dc61c88e78c90c29be9fee3248b376d727779eec160d2991ba3acf7b5100bd6760cf142f536de9495

data/README.md

@@ -1,7 +1,13 @@
 # Pdfinfo
 
-TODO: Write a gem description
+Simple ruby wrapper around the pdfinfo command
 
+## Depdendecies
+
+usage of this gem assumes that you have xpdf installed.  The fastest way to install xpdf:
+
+    $ brew install xpdf
+    
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -18,7 +24,28 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+
+```ruby
+pdfinfo = Pdfinfo.new("path/to/file.pdf")
+
+pdfinfo.creator     #=> "Creator Name" # or nil
+pdfinfo.producer    #=> "Producer Name" # or nil
+pdfinfo.form        #=> "none"
+pdfinfo.page_count  #=> 3
+pdfinfo.width       #=> 612
+pdfinfo.height      #=> 792
+pdfinfo.size        #=> 1521 # file size in bytes
+pdfinfo.pdf_version #=> "1.3"
+pdfinfo.encrypted?  #=> false # or true
+pdfinfo.tagged?     #=> false # or true
+```
+
+You can directly set the location of the executable if its not located in your environment $PATH or you just want to point to a different location.
+
+```ruby
+Pdfinfo.pdfinfo_command = '/another/bin/path/pdfinfo'
+Pdfinfo.pdfinfo_command #=> '/another/bin/path/pdfinfo'
+```
 
 ## Contributing
 

data/lib/pdfinfo.rb

@@ -14,7 +14,7 @@ class Pdfinfo
     :pdf_version
 
   def self.exec(file_path)
-    stdout, stderr, status = Open3.capture2e("pdfinfo #{file_path}")
+    stdout, stderr, status = Open3.capture2e("#{pdfinfo_command} #{file_path}")
     stdout.chomp
   end
 
@@ -27,7 +27,7 @@ class Pdfinfo
   end
 
   def initialize(source_path)
-    info_hash = parse_shell_response(exec(source_path))
+    info_hash = parse_shell_response(Pdfinfo.exec(source_path))
 
     @creator        = info_hash['Creator']
     @producer       = info_hash['Producer']
@@ -50,10 +50,6 @@ class Pdfinfo
 
   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

data/lib/pdfinfo/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pdfinfo
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Ryan Venegas