fillable-pdf 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7da9c03f8ee095a61b7a95a206be382fa4b5d1d5
+  data.tar.gz: 1fcfa10679b928734cf5628fe063e0c60b739e23
+SHA512:
+  metadata.gz: 0fd914fff82bc757c7c1a521db4c222a314f84cd5e5caf9e10b92286bd877e8b43202b841cb89819efb288be307ae6c8e8dcf5304d21f1f9bce4e60613272b8f
+  data.tar.gz: 51cde33bf6c621b50487249c30d12bcc1e8f9f1caeda458fd73292fea33f8b999c1d8c786d9bbde9e306cc09eda8368c130e948b7122508953d329bde5ef36e0

data/.gitignore

@@ -0,0 +1,13 @@
+*.DS_Store
+*thumbs.db
+/*.gem
+/.bundle/
+/.idea/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/Gemfile.lock
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Vadim Kononov
+
+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,79 @@
+# FillablePDF
+
+[![Gem Version](https://badge.fury.io/rb/fillable-pdf.svg)](https://rubygems.org/gems/fillable-pdf)
+
+FillablePDF is an extremely simple and lightweight utility that bridges iText and Ruby in order to fill out fillable PDF forms or extract field values from previously filled out PDF forms. 
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fillable-pdf'
+
+And then execute:
+
+    bundle
+
+Or install it yourself as:
+
+    gem install fillable-pdf
+
+If you are using this gem in a script, you need to require it manually:
+
+```ruby
+require 'fillable-xml'
+```
+
+## Usage
+
+First of all, you should open a fillable PDF file:
+
+```ruby
+pdf = FillablePDF.new('input.pdf')
+```
+
+An instance of `FillablePDF` has the following methods at its disposal:
+
+```ruby
+pdf.get_field('full_name')
+
+pdf.set_field('first_name', 'Richard')
+
+pdf.set_fields({first_name: 'Richard', last_name: 'Rahl'})
+```
+
+Once the PDF is filled out you can either overwrite it or save it as another file:
+
+```ruby
+pdf.save
+
+pdf.save_as(file)
+```
+
+Or if you prefer to flatten the file (i.e. make it non-editable), you can instead use:
+
+```ruby
+pdf.save(true)
+
+pdf.save_as(file, true)
+```
+
+
+## Example
+
+For a a fuller usage example of this gem, please see the contents of the `test` directory.
+
+
+## Contributing
+
+1. Fork it
+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 new Pull Request
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'fillable-pdf'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require 'pry'
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/fillable-pdf.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fillable-pdf/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'fillable-pdf'
+  spec.version       = FillablePDF::VERSION
+  spec.authors       = ['Vadim Kononov']
+  spec.email         = ['vadim@poetic.com']
+
+  spec.summary       = 'Fill out or extract field values from simple fillable PDF forms using iText.'
+  spec.description   = 'FillablePDF is an extremely simple and lightweight utility that bridges iText and Ruby in order to fill out fillable PDF forms or extract field values from previously filled out PDF forms.'
+  spec.homepage      = 'http://vkononov.github.io/fillable-pdf'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = %w(ext lib)
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 11.2'
+  spec.add_runtime_dependency 'rjb', '~> 1.5'
+end

data/lib/fillable-pdf.rb

@@ -0,0 +1,98 @@
+require 'rjb'
+require 'securerandom'
+
+# http://github.com/itext/itextpdf/releases/latest
+Rjb::load(File.expand_path('../ext/itextpdf-5.5.9.jar', __dir__))
+
+
+class FillablePDF
+
+  # required Java imports
+  BYTE_STREAM = Rjb::import('java.io.ByteArrayOutputStream')
+  FILE_READER = Rjb::import('com.itextpdf.text.pdf.PdfReader')
+  PDF_STAMPER = Rjb::import('com.itextpdf.text.pdf.PdfStamper')
+
+
+  ##
+  # Opens a given fillable PDF file and prepares it for modification.
+  #
+  #   @param [String] file the name of the PDF file or file path
+  #
+  def initialize(file)
+    @file    = file
+    @byte_stream = BYTE_STREAM.new
+    @pdf_stamper = PDF_STAMPER.new FILE_READER.new(@file), @byte_stream
+    @form_fields = @pdf_stamper.getAcroFields
+  end
+
+
+  ##
+  # Retrieves the value of a field given its unique field name.
+  #
+  #   @param [String] key the field name
+  #
+  #   @return the value of the field
+  #
+  def get_field(key)
+    @form_fields.getField key.to_s
+  end
+
+
+  ##
+  # Sets the value of a field given its unique field name and value.
+  #
+  #   @param [String] key the field name
+  #   @param [String] value the field value
+  #
+  def set_field(key, value)
+    @form_fields.setField key.to_s, value.to_s
+  end
+
+
+  ##
+  # Sets the values of multiple fields given a set of unique field names and values.
+  #
+  #   @param [Hash] fields the set of field names and values
+  #
+  def set_fields(fields)
+    fields.each { |key, value| set_field key, value }
+  end
+
+
+  ##
+  # Overwrites the previously opened PDF file and flattens it if requested.
+  #
+  #   @param [bool] flatten true if PDF should be flattened, false otherwise
+  #
+  def save(flatten = false)
+    tmp_file = SecureRandom.uuid
+    save_as(tmp_file, flatten)
+    File.rename tmp_file, @file
+  end
+
+
+  ##
+  # Saves the filled out PDF file with a given file and flattens it if requested.
+  #
+  #   @param [String] file the name of the PDF file or file path
+  #   @param [bool] flatten true if PDF should be flattened, false otherwise
+  #
+  def save_as(file, flatten = false)
+    File.open(file, 'wb') { |f| f.write finalize flatten and f.close }
+  end
+
+
+  private
+
+  ##
+  # Writes the contents of the modified fields to the previously opened PDF file.
+  #
+  #   @param [bool] flatten true if PDF should be flattened, false otherwise
+  #
+  def finalize(flatten)
+    @pdf_stamper.setFormFlattening flatten
+    @pdf_stamper.close
+    @byte_stream.toByteArray
+  end
+
+end

data/lib/fillable-pdf/version.rb

@@ -0,0 +1,3 @@
+module FillablePDF
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: fillable-pdf
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vadim Kononov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.2'
+- !ruby/object:Gem::Dependency
+  name: rjb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+description: FillablePDF is an extremely simple and lightweight utility that bridges
+  iText and Ruby in order to fill out fillable PDF forms or extract field values from
+  previously filled out PDF forms.
+email:
+- vadim@poetic.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ext/itextpdf-5.5.9.jar
+- fillable-pdf.gemspec
+- lib/fillable-pdf.rb
+- lib/fillable-pdf/version.rb
+homepage: http://vkononov.github.io/fillable-pdf
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- ext
+- 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.6.6
+signing_key: 
+specification_version: 4
+summary: Fill out or extract field values from simple fillable PDF forms using iText.
+test_files: []