nguyen 0.0.1

data/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2012 Trung Lê
+
+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.rdoc

@@ -0,0 +1,56 @@
+= Nguyên the PDF Field Merger 
+
+A very lightweight library that fill PDF forms using XFDF/FDF with pdftk
+
+You could download pdftk at http://www.accesspdf.com/pdftk/
+
+Nguyên is a fork of Jens Krämer's pdf-forms with addition of filling forms with XFDF feature.
+
+== EXAMPLE:
+
+=== FDF creation
+
+    fdf = Nguyen::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'
+
+
+=== XFDF creation
+
+    xfdf = Nguyen::Xfdf.new(:key => 'value', :other_key => 'other value')
+    # use to_xfdf if you just want the XFDF data, without writing it to a file
+    puts xfdf.to_xfdf
+    # write xfdf file
+    xfdf.save_to 'path/to/file.xfdf'
+
+=== Query form fields and fill out PDF forms with pdftk
+
+    # adjust the pdftk path to suit your pdftk installation
+    pdftk = Nguyen.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
+
+    # with fdf
+    fdf = Nguyen::Fdf(:foo => 'bar')
+    pdftk.fill_form '/path/to/form.pdf', 'myform.pdf', fdf
+
+    # with xfdf
+    xfdf = Nguyen::Xfdf(:foo => 'bar')
+    pdftk.fill_form '/path/to/form.pdf', 'myform.pdf', xfdf
+
+== INSTALL:
+
+  $ gem install nguyen
+
+== Source Code:
+
+  $ git clone http://github.com/joneslee85/nguyen.git
+
+== LICENSE
+
+see LICENSE

data/lib/nguyen.rb

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

data/lib/nguyen/fdf.rb

@@ -0,0 +1,89 @@
+module Nguyen
+
+  # 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/nguyen/pdf.rb

@@ -0,0 +1,26 @@
+module Nguyen
+  class Pdf
+    attr_reader :path
+
+    def initialize(path, pdftk)
+      @path = path
+      raise IOError unless File.readable?(path)
+      @pdftk = pdftk
+    end
+
+    def fields
+      @fields ||= read_fields
+    end
+
+    protected
+
+      def read_fields
+        field_output = @pdftk.call_pdftk %Q("#{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/nguyen/pdftk_wrapper.rb

@@ -0,0 +1,58 @@
+require 'tempfile'
+module Nguyen
+  class PdftkError < StandardError
+  end
+
+  # 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', xfdf_or_fdf_object
+    def fill_form(template, destination, form_data_format)
+      tmp = Tempfile.new('pdf_forms-fdf')
+      tmp.close
+      form_data_format.save_to tmp.path
+      command = pdftk_command %Q("#{template}"), 'fill_form', tmp.path, 'output', destination, 'flatten', encrypt_options(tmp.path)
+      output = %x{#{command}}
+      unless File.readable?(destination) && File.size(destination) > 0
+        raise PdftkError.new("failed to fill form with command\n#{command}\ncommand output was:\n#{output}")
+      end
+    ensure
+      tmp.unlink if tmp
+    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_command args}}
+    end
+
+    protected
+
+      def pdftk_command(*args)
+        "#{pdftk} #{args.flatten.compact.join ' '} 2>&1"
+      end
+
+      def encrypt_options(pwd)
+        if options[:encrypt]
+          ['encrypt_128bit', 'owner_pw', pwd, options[:encrypt_options]]
+        end
+      end
+
+  end
+end

data/lib/nguyen/xfdf.rb

@@ -0,0 +1,44 @@
+require 'nokogiri'
+
+module Nguyen
+  class Xfdf
+    
+    attr_reader :options
+    
+    def initialize(fields = {}, options = {})
+      @fields = fields
+      @options = {
+        :file => nil,
+        :id => nil
+      }.merge(options)
+    end
+
+    # generate XFDF content
+    def to_xfdf
+      builder = Nokogiri::XML::Builder.new(:encoding => 'UTF-8') do |xml|
+        xml.xfdf('xmlns' => 'http://ns.adobe.com/xfdf/', 'xml:space' => 'preserve') {
+          xml.f(:href => options[:file]) if options[:file]
+          xml.ids(:original => options[:id], :modified => options[:id]) if options[:id]
+          xml.fields {
+            @fields.each do |field, value|
+              xml.field(:name => field) {
+                if value.is_a? Array
+                  value.each { |item| xml.value(item.to_s) }
+                else
+                  xml.value(value.to_s)
+                end
+              }
+            end
+          }
+        }
+      end
+      builder.to_xml
+    end
+
+    # write fdf content to path
+    def save_to(path)
+      (File.open(path, 'w') << to_xfdf).close
+    end
+
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: nguyen
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Trung Lê
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.5
+description: Forms for Nguyên is Ruby library that could merge PDF fields by XFDF/FDF
+  via pdftk.
+email: joneslee85@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/nguyen/fdf.rb
+- lib/nguyen/pdf.rb
+- lib/nguyen/pdftk_wrapper.rb
+- lib/nguyen/xfdf.rb
+- lib/nguyen.rb
+- LICENSE
+- README.rdoc
+homepage: http://github.com/joneslee85/nguyen
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements:
+- pdtk 1.44.1 or newer
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Fill out PDF forms by XFDF/FDF via pdftk.
+test_files: []