tv-pdf-stamper 0.3.7

data/History.txt

@@ -0,0 +1,36 @@
+== 0.3.6 2012-10-25
+* use java_import instead of include_class (include_class deprecated in jruby 1.7.0)
+
+== 0.3.5 2012-06-27
+* Checkboxes now work in JRuby
+
+== 0.3.4 2010-09-24
+* Circle/ellipse/rectangle now take a page parameter, and can be applied to a specific page.
+  This is useful for multi-page PDFs.
+
+== 0.3.3 2010-09-24
+* iText downgraded to 4.2.0 due to license incompatibility
+
+== 0.3.2 2010-09-24
+* Added support for drawing circles, rectangles and ellipses
+
+== 0.3.1 2010-09-15
+* checkbox support added
+* iText updated to 5.0.4
+* documentation updated and typos fixed
+
+== 0.3.0 2009-02-08
+
+* Refactored the code.
+* Added JRuby support
+* Fixed some documentation
+
+== 0.2.0 2007-11-08
+
+* Use bytearray for output
+* Added support for images
+
+== 0.1.0 2007-07-13
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,11 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+ext/iText-4.2.0.jar
+lib/pdf/stamper.rb
+lib/pdf/stamper/jruby.rb
+lib/pdf/stamper/rjb.rb
+spec/logo.gif
+spec/pdf_stamper_spec.rb
+spec/test_template.pdf

data/README.txt

@@ -0,0 +1,62 @@
+= pdf/stamper - PDF Templates
+  http://github.com/jaywhy/pdf-stamper/
+  by Jason Yates
+
+  15 September 2010 -- fork by Paul Schreiber
+  http://github.com/paulschreiber/pdf-stamper/
+
+  21 January 2013 -- fork by Wes Morgan (TurboVote)
+  http://github.com/turbovote/pdf-stamper
+
+== DESCRIPTION:
+
+Fill out PDF forms (templates) using iText's PdfStamper.
+
+== CAVEAT:
+
+You have to use JRuby or RJB. You need Adobe LiveCycle Designer
+or Acrobat Professional to create the templates.
+
+== EXAMPLE:
+pdf = PDF::Stamper.new("my_template.pdf")
+pdf.text :first_name, "Jason"
+pdf.text :last_name, "Yates"
+pdf.image :photo, "photo.jpg"
+pdf.checkbox :hungry
+pdf.ellipse(140, 380, 50, 13)
+pdf.rectangle(140, 380, 50, 13, 2)
+pdf.circle(140, 380)
+pdf.save_as "my_output.pdf"
+
+== INSTALL:
+
+$ sudo gem install tv-pdf-stamper
+
+== CODE:
+
+$ git clone http://github.com/turbovote/pdf-stamper/
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright 2007-2013 Jason Yates, Paul Schreiber, Wes Morgan
+
+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/Rakefile

@@ -0,0 +1,13 @@
+$:.unshift File.join(File.dirname(__FILE__), "lib")
+require 'pdf/stamper'
+require 'spec/rake/spectask'
+
+%w[rubygems rake rake/clean fileutils rubigen].each { |f| require f }
+
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/*_spec.rb']
+  t.warning = true
+  t.rcov = false
+end

data/lib/pdf/stamper.rb

@@ -0,0 +1,99 @@
+# = pdf/stamper.rb -- PDF template stamping.
+#
+#  Copyright (c) 2007-2009 Jason Yates
+
+require 'rbconfig'
+require 'fileutils'
+require 'tmpdir'
+
+include FileUtils
+
+module PDF
+  class Stamper
+    VERSION = "0.3.6"
+    
+    if RUBY_PLATFORM =~ /java/ # ifdef to check if your using JRuby
+      require 'pdf/stamper/jruby'
+    else
+      require 'pdf/stamper/rjb'
+    end
+    # PDF::Stamper provides an interface into iText's PdfStamper allowing for the
+    # editing of existing PDFs as templates. PDF::Stamper is not a PDF generator,
+    # it allows you to edit existing PDFs and use them as templates.
+    #
+    # == Creation of templates
+    #
+    # Templates currently can be created using Adobe LiveCycle Designer
+    # or Adobe Acrobat Professional. Using Acrobat Professional, you can create
+    # a form and add textfields, checkboxes, radio buttons and buttons for images.
+    #
+    # == Example
+    #
+    # pdf = PDF::Stamper.new("my_template.pdf")
+    # pdf.text :first_name, "Jason"
+    # pdf.text :last_name, "Yates"
+    # pdf.image :photo, "photo.jpg"
+    # pdf.checkbox :hungry
+    # pdf.save_as "my_output"
+    
+    # Set a textfield defined by key and text to value.
+    def text(key, value)
+      @form.setField(key.to_s, value.to_s) # Value must be a string or itext will error.
+    end
+
+    # Set a checkbox to checked
+    def checkbox(key)
+      field_type = @form.getFieldType(key.to_s)
+      return unless is_checkbox(field_type)
+
+      all_states = @form.getAppearanceStates(key.to_s)
+      yes_state = all_states.reject{|x| x == "Off"}
+      
+      
+      @form.setField(key.to_s, yes_state.first) unless (yes_state.size == 0)
+    end
+    
+    # Get checkbox values
+    def get_checkbox_values(key)
+      field_type = @form.getFieldType(key.to_s)
+      return unless is_checkbox(field_type)
+
+      @form.getAppearanceStates(key.to_s)
+    end
+
+    def circle(x, y, r, page=1)
+      update_canvas_list(page)
+      @canvas_list[page].circle(x, y, r)
+    end
+
+    def ellipse(x, y, width, height, page=1)
+      update_canvas_list(page)
+      @canvas_list[page].ellipse(x, y, x + width, y + height)
+    end
+
+    def rectangle(x, y,  width, height, page=1)
+      update_canvas_list(page)
+      @canvas_list[page].rectangle(x, y, width, height)
+    end
+    
+    # Saves the PDF into a file defined by path given.
+    def save_as(file)
+      File.open(file, "wb") { |f| f.write to_s }
+    end
+    
+    private
+    
+    def update_canvas_list(page)
+      @canvas_list[page] = @stamp.getOverContent(page) unless @canvas_list.has_key?(page)
+    end
+
+    def fill
+      @canvas_list.values.each do |c|
+        c.stroke
+      end
+      @stamp.setFormFlattening(true)
+      @stamp.close
+    end
+  end
+end
+    

data/lib/pdf/stamper/jruby.rb

@@ -0,0 +1,68 @@
+# = pdf/stamper/rjb.rb -- PDF template stamping.
+#
+#  Copyright (c) 2007-2009 Jason Yates
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', '..', '..', 'ext'))
+require 'java'
+
+java.lang.System.setProperty('java.awt.headless', 'true')
+
+require 'iText-4.2.0.jar'
+
+java_import 'java.io.FileOutputStream'
+java_import 'java.io.ByteArrayOutputStream'
+java_import 'com.lowagie.text.pdf.AcroFields'
+java_import 'com.lowagie.text.pdf.PdfReader'
+java_import 'com.lowagie.text.pdf.PdfStamper'
+java_import 'com.lowagie.text.Image'
+java_import 'com.lowagie.text.Rectangle'
+java_import 'com.lowagie.text.pdf.GrayColor'
+
+module PDF
+  class Stamper
+    def initialize(pdf = nil)
+      template(pdf) if ! pdf.nil?
+    end
+
+    def template(template)
+      # NOTE I'd rather use a ByteArrayOutputStream.  However I
+      # couldn't get it working.  Patches welcome.
+      #@tmp_path = File.join(Dir::tmpdir, 'pdf-stamper-' + rand(10000).to_s + '.pdf')
+      reader = PdfReader.new(template)
+      @baos = ByteArrayOutputStream.new
+      @stamp = PdfStamper.new(reader, @baos)#FileOutputStream.new(@tmp_path))
+      @form = @stamp.getAcroFields()
+      @black = GrayColor.new(0.0)
+      @canvas_list = { 1 => @stamp.getOverContent(1) }
+    end
+
+    def is_checkbox(field_type)
+      field_type == AcroFields::FIELD_TYPE_CHECKBOX
+    end
+
+    # Set a button field defined by key and replaces with an image.
+    def image(key, image_path)
+      # Idea from here http://itext.ugent.be/library/question.php?id=31
+      # Thanks Bruno for letting me know about it.
+      img = Image.getInstance(image_path)
+      img_field = @form.getFieldPositions(key.to_s)
+
+      rect = Rectangle.new(img_field[1], img_field[2], img_field[3], img_field[4])
+      img.scaleToFit(rect.width, rect.height)
+      img.setAbsolutePosition(
+        img_field[1] + (rect.width - img.scaledWidth) / 2,
+        img_field[2] + (rect.height - img.scaledHeight) /2
+      )
+
+      cb = @stamp.getOverContent(img_field[0].to_i)
+      cb.addImage(img)
+    end
+
+    # Takes the PDF output and sends as a string.  Basically it's sole
+    # purpose is to be used with send_data in rails.
+    def to_s
+      fill
+      String.from_java_bytes(@baos.toByteArray)
+    end
+  end
+end

data/lib/pdf/stamper/rjb.rb

@@ -0,0 +1,130 @@
+# = pdf/stamper/rjb.rb -- PDF template stamping.
+#
+#  Copyright (c) 2007-2009 Jason Yates
+
+require 'rubygems'
+require 'rjb'
+
+Rjb::load(File.join(File.dirname(__FILE__), '..', '..', '..', 'ext', 'iText-4.2.0.jar'), ['-Djava.awt.headless=true'])
+
+module PDF
+  # PDF::Stamper::RJB
+  #
+  # RJB needs the LD_LIBRARY_PATH and JAVA_HOME environment set for it
+  # to work correctly.  For example on my system:
+  #
+  # export LD_LIBRARY_PATH=/usr/java/jdk1.6.0/jre/lib/i386/:/usr/java/jdk1.6.0/jre/lib/i386/client/:./
+  # export JAVA_HOME=/usr/java/jdk1.6.0/
+  #
+  # Check the RJB documentation if you are having issues with this.
+  class Stamper
+    def initialize(pdf = nil, options = {})
+      @bytearray    = Rjb::import('java.io.ByteArrayOutputStream')
+      @filestream   = Rjb::import('java.io.FileOutputStream')
+      @acrofields   = Rjb::import('com.lowagie.text.pdf.AcroFields')
+      @pdfreader    = Rjb::import('com.lowagie.text.pdf.PdfReader')
+      @pdfstamper   = Rjb::import('com.lowagie.text.pdf.PdfStamper')
+      @pdfwriter    = Rjb::import('com.lowagie.text.pdf.PdfWriter')
+      @image_class  = Rjb::import('com.lowagie.text.Image')
+      @pdf_content_byte_class = Rjb::import('com.lowagie.text.pdf.PdfContentByte')
+      @basefont_class = Rjb::import('com.lowagie.text.pdf.BaseFont')
+      @rectangle = Rjb::import('com.lowagie.text.Rectangle')
+      @gray_color = Rjb::import('com.lowagie.text.pdf.GrayColor')
+    
+      template(pdf) if ! pdf.nil?
+    end
+    
+    def is_checkbox(field_type)
+      field_type == @acrofields.FIELD_TYPE_CHECKBOX
+    end
+  
+    def template(template)
+      reader = @pdfreader.new(template)
+      @pagesize = reader.getPageSize(1)
+      @numpages = reader.getNumberOfPages()
+      @baos = @bytearray.new
+      @stamp = @pdfstamper.new(reader, @baos)
+      @form = @stamp.getAcroFields()
+      @black = @gray_color.new(0.0)
+      @canvas_list = { 1 => @stamp.getOverContent(1) }
+    end
+
+    # Set a button field defined by key and replaces with an image.
+    def image(key, image_path)
+      # Idea from here http://itext.ugent.be/library/question.php?id=31 
+      # Thanks Bruno for letting me know about it.
+      img = @image_class.getInstance(image_path)
+      img_field = @form.getFieldPositions(key.to_s)
+
+      
+      rect = @rectangle.new(img_field[1], img_field[2], img_field[3], img_field[4])
+      img.scaleToFit(rect.width, rect.height)
+      img.setAbsolutePosition(
+        img_field[1] + (rect.width - img.getScaledWidth) / 2,
+        img_field[2] + (rect.height - img.getScaledHeight) /2
+      )
+
+      cb = @stamp.getOverContent(img_field[0].to_i)
+      cb.addImage(img)
+    end
+    
+    # Takes the PDF output and sends as a string.  Basically its sole
+    # purpose is to be used with send_data in rails.
+    def to_s
+      fill
+      @baos.toByteArray
+    end
+    
+    def add_images(images)
+      basefont = @basefont_class.createFont(@basefont_class.HELVETICA, @basefont_class.CP1252, @basefont_class.NOT_EMBEDDED)
+      image_size = []
+      half_page_width = @pagesize.width() / 2
+      half_page_height = @pagesize.height() / 2
+      image_size[0] = half_page_width - 80
+      image_size[1] = half_page_height - 80
+      pages = (images.length / 4.0).ceil
+      pages.times do |index|
+        page_number = index + @numpages + 1
+        image_index = index * 4
+        @stamp.insertPage(page_number, @pagesize)
+        over = @stamp.getOverContent(page_number)
+        over.setFontAndSize(basefont, 12.0)
+        4.times do |n|
+          if pdf_image = images[image_index + n]
+            if image_path = pdf_image[0]
+              img = @image_class.getInstance(image_path)
+              img.scaleToFit(image_size[0] + 30, (image_size[1]))
+              img_x_offset = (half_page_width - image_size[0]) / 2
+              img_y_offset = (half_page_height - img.getScaledHeight()) / 2
+              case n
+              when 0
+                img.setAbsolutePosition(img_x_offset, (half_page_height + img_y_offset))
+              when 1
+                img.setAbsolutePosition((half_page_width + (img_x_offset - 30)), (half_page_height + img_y_offset))
+              when 2
+                img.setAbsolutePosition(img_x_offset, img_y_offset)
+              when 3
+                img.setAbsolutePosition((half_page_width + (img_x_offset - 30)), img_y_offset)
+              end
+              over.addImage(img)
+            end
+            if image_label = pdf_image[1]
+              over.beginText()
+              over.showTextAligned(@pdf_content_byte_class.ALIGN_CENTER, image_label, (img.getAbsoluteX() + ((image_size[0] + 30) / 2)), (img.getAbsoluteY() - 15), 0)
+              over.endText()
+            end
+          end
+        end
+      end
+      @stamp.setFullCompression()
+    end
+    
+    def add_image_on_page(page, x, y, url)
+      over = @stamp.getOverContent(page)
+      img = @image_class.getInstance(url)
+      img.setAbsolutePosition(x,y)
+      img.scaleToFit(200,70)
+      over.addImage(img)
+    end
+  end
+end

data/spec/pdf_stamper_spec.rb

@@ -0,0 +1,21 @@
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+require 'pdf/stamper'
+
+describe PDF::Stamper do
+  before(:each) do
+    @pdf = PDF::Stamper.new(File.join(File.dirname(__FILE__), "test_template.pdf"))
+    @pdf.text :text_field01, "test"
+    @pdf.text :text_field02, "test2"
+    @pdf.image :button_field01, File.join(File.dirname(__FILE__), "logo.gif")
+  end
+
+  it "should create PDF document" do
+    @pdf.to_s.should_not be_nil
+  end
+
+  it "should save PDF document" do
+    @pdf.save_as "test_output.pdf"
+    File.exist?("test_output.pdf").should be_true
+    File.delete("test_output.pdf") # Comment this out to view the output
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: tv-pdf-stamper
+version: !ruby/object:Gem::Version
+  version: 0.3.7
+  prerelease: 
+platform: ruby
+authors:
+- Paul Schreiber
+- Wes Morgan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: newgem
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.3
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+description: ! 'Fill out PDF forms (templates) using iText''s PdfStamper.  == CAVEAT:  You
+  have to use JRuby or RJB. You need Adobe LiveCycle Designer or Acrobat Professional
+  to create the templates.  == EXAMPLE: pdf = PDF::Stamper.new("my_template.pdf")
+  pdf.text :first_name, "Jason" pdf.text :last_name, "Yates" pdf.image :photo, "photo.jpg"
+  pdf.checkbox :hungry pdf.save_as "my_output.pdf"'
+email:
+- paulschreiber@gmail.com
+- wes@turbovote.org
+executables: []
+extensions: []
+extra_rdoc_files:
+- History.txt
+- Manifest.txt
+- README.txt
+files:
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- ext/iText-4.2.0.jar
+- lib/pdf/stamper.rb
+- lib/pdf/stamper/jruby.rb
+- lib/pdf/stamper/rjb.rb
+- spec/logo.gif
+- spec/pdf_stamper_spec.rb
+- spec/test_template.pdf
+homepage: http://github.com/turbovote/pdf-stamper/
+licenses: []
+post_install_message: 
+rdoc_options:
+- --main
+- README.txt
+require_paths:
+- lib
+- ext
+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: '0'
+requirements: []
+rubyforge_project: pdf-stamper
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 2
+summary: PDF templates using iText's PdfStamper.
+test_files: []