pdf-forms 0.3.0

data/README.rdoc

@@ -0,0 +1,69 @@
+= pdf-forms 
+  http://github.com/jkraemer/pdf-forms/
+  by Jens Kraemer, jk@jkraemer.net
+
+== DESCRIPTION:
+
+Fill out PDF forms with pdftk (http://www.accesspdf.com/pdftk/).
+
+== EXAMPLE:
+
+=== FDF creation
+
+  fdf = PdfForms::Fdf.new :key => 'value', :other_key => 'other value'
+  # use to_fdf if you just want the fdf data, without writing it to a file
+  puts fdf.to_fdf
+  # write fdf file
+  fdf.save_to 'path/to/file.fdf'
+
+=== Query form fields and fill out PDF forms with pdftk
+
+First get pdftk from http://www.accesspdf.com/pdftk/ and install it.
+
+  # adjust the pdftk path to suit your pdftk installation
+  pdftk = PdfForms.new('/usr/local/bin/pdftk')
+  
+  # find out the field names that are present in form.pdf
+  pdftk.get_field_names 'path/to/form.pdf'
+  
+  # take form.pdf, set the 'foo' field to 'bar' and save the document to myform.pdf
+  pdftk.fill_form '/path/to/form.pdf', 'myform.pdf', :foo => 'bar'
+  
+  
+
+== INSTALL:
+
+  $ sudo gem install jkraemer-pdf-forms
+
+== CODE:
+
+  $ git clone http://github.com/jkraemer/pdf-forms.git
+
+== Prior Art
+
+The FDF generation part is a straight port of Steffen Schwigon's PDF::FDF::Simple perl module. Didn't port the FDF parsing, though ;-)
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Jens Kraemer
+
+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/lib/pdf_forms.rb

@@ -0,0 +1,11 @@
+require 'pdf_forms/version'
+require 'pdf_forms/fdf'
+require 'pdf_forms/pdf'
+require 'pdf_forms/pdftk_wrapper'
+
+module PdfForms
+  # shorthand for PdfForms::PdftkWrapper.new(...)
+  def self.new(*args)
+    PdftkWrapper.new *args
+  end
+end

data/lib/pdf_forms/fdf.rb

@@ -0,0 +1,89 @@
+module PdfForms
+  
+  # Map keys and values to Adobe's FDF format.
+  #
+  # Straight port of Perl's PDF::FDF::Simple by Steffen Schwigon.
+  # Parsing FDF files is not supported (yet).
+  class Fdf
+    
+    attr_reader :options
+    
+    def initialize(data = {}, options = {})
+      @data = data
+      @options = {
+        :file => nil,
+        :ufile => nil,
+        :id => nil
+      }.merge(options)
+    end
+
+    # generate FDF content
+    def to_fdf
+      fdf = header
+      
+      @data.each do |key, value|
+        if Hash === value
+          value.each do |sub_key, sub_value|
+            fdf << field("#{key}_#{sub_key}", sub_value)
+          end
+        else
+          fdf << field(key, value)
+        end
+      end
+
+      fdf << footer
+      return fdf
+    end
+    
+    # write fdf content to path
+    def save_to(path)
+      (File.open(path, 'w') << to_fdf).close
+    end
+    
+    protected
+    
+    def header
+      header = "%FDF-1.2\n\n1 0 obj\n<<\n/FDF << /Fields 2 0 R"
+      
+      # /F
+      header << "/F (#{options[:file]})" if options[:file]
+      # /UF
+      header << "/UF (#{options[:ufile]})" if options[:ufile]
+      # /ID
+      header << "/ID[" << options[:id].join << "]" if options[:id]
+      
+      header << ">>\n>>\nendobj\n2 0 obj\n["
+      return header
+    end
+
+    def field(key, value)
+      "<</T(#{key})/V" +
+        (Array === value ? "[#{value.map{ |v|"(#{quote(v)})" }.join}]" : "(#{quote(value)})") +
+        ">>\n"
+    end
+    
+    def quote(value)
+      value.to_s.strip.
+        gsub( /\\/, '\\' ).
+        gsub( /\(/, '\(' ).
+        gsub( /\)/, '\)' ).
+        gsub( /\n/, '\r' )
+    end
+    
+    FOOTER =<<-EOFOOTER
+]
+endobj
+trailer
+<<
+/Root 1 0 R
+
+>>
+%%EOF
+EOFOOTER
+    
+    def footer
+      FOOTER
+    end
+    
+  end
+end

data/lib/pdf_forms/pdf.rb

@@ -0,0 +1,25 @@
+module PdfForms
+  class Pdf
+    attr_reader :path
+    
+    def initialize(path, pdftk)
+      @path = path
+      @pdftk = pdftk
+    end
+    
+    def fields
+      @fields ||= read_fields
+    end
+    
+    protected
+    
+    def read_fields
+      field_output = @pdftk.call_pdftk "'#{path}'", 'dump_data_fields'
+      @fields = field_output.split(/^---\n/).map do |field_text|
+        if field_text =~ /^FieldName: (\w+)$/
+          $1
+        end
+      end.compact.uniq
+    end
+  end
+end

data/lib/pdf_forms/pdftk_wrapper.rb

@@ -0,0 +1,47 @@
+require 'tempfile'
+module PdfForms
+  # Wraps calls to PdfTk
+  class PdftkWrapper
+    
+    attr_reader :pdftk, :options
+    
+    # PdftkWrapper.new('/usr/bin/pdftk', :encrypt => true, :encrypt_options => 'allow Printing')
+    def initialize(pdftk_path, options = {})
+      @pdftk = pdftk_path
+      @options = options
+    end
+    
+    # pdftk.fill_form '/path/to/form.pdf', '/path/to/destination.pdf', :field1 => 'value 1'
+    def fill_form(template, destination, data = {})
+      fdf = Fdf.new(data)
+      tmp = Tempfile.new('pdf_forms-fdf')
+      tmp.close
+      fdf.save_to tmp.path
+      call_pdftk "'#{template}'", 'fill_form', tmp.path, 'output', destination, 'flatten', encrypt_options(tmp.path)
+      tmp.unlink
+    end
+    
+    # pdftk.read '/path/to/form.pdf'
+    # returns an instance of PdfForms::Pdf representing the given template
+    def read(path)
+      Pdf.new path, self
+    end
+    
+    def get_field_names(template)
+      read(template).fields
+    end
+    
+    def call_pdftk(*args)
+      %x{#{pdftk} #{args.flatten.compact.join ' '}}
+    end
+    
+    protected
+    
+    def encrypt_options(pwd)
+      if options[:encrypt]
+        ['encrypt_128bit', 'owner_pw', pwd, options[:encrypt_options]]
+      end
+    end
+    
+  end
+end

data/lib/pdf_forms/version.rb

@@ -0,0 +1,3 @@
+module PdfForms
+  VERSION = '0.3.0'
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification 
+name: pdf-forms
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.3.0
+platform: ruby
+authors: 
+- "Jens Kr\xC3\xA4mer"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-10 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: Fill out PDF forms with pdftk (http://www.accesspdf.com/pdftk/).
+email: 
+- jk@jkraemer.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/pdf_forms/fdf.rb
+- lib/pdf_forms/pdf.rb
+- lib/pdf_forms/pdftk_wrapper.rb
+- lib/pdf_forms/version.rb
+- lib/pdf_forms.rb
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/jkraemer/pdf-forms
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: pdf-forms
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Fill out PDF forms with pdftk (http://www.accesspdf.com/pdftk/).
+test_files: []
+