pdf-forms 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 74a388e3ee6551d601f4d713863ff18d8d71e7bc
-  data.tar.gz: 28c603be2710e14695777208fa1b2219422c67ca
+  metadata.gz: f82a5f40a898d0b44980998389d2d65fccdf609c
+  data.tar.gz: 785b8dddce02826364296a277d070e9a9e513ba6
 SHA512:
-  metadata.gz: e7ba4e9bca7cf23c37e431a646c766486a748a9836fb7d3e432ea7ecf814523d1932276f81159c02af298562fdf2653933c2a3c6be16a8d54496e9469d29238b
-  data.tar.gz: b2e6c9002bcc6999c7b33ccf47eb82c22d3699bb709f6085f2b15b23dd0d4e94ad18e34eee14851f4cf0af5ddd031e779445bb6e1c57d207fd055ea12e64df1f
+  metadata.gz: 7d88e13704cb3190b22b64cf1b0cde1f94ab16b52e7ca6f95719f95a545a2859ede57509a8a0f93318ff4bd83994f97cb3ce537a327f34e9312725ca373b8643
+  data.tar.gz: 273c23ad22d6321829f45c2e0a1b2a568ea8faecbaf95359569b1b9011b14e6d082809052731ca9cf0adfc22439edc3a661973ca8575e91a71a9e7ac7e2774d6

data/README.md

@@ -11,7 +11,6 @@ Fill out PDF forms with [pdftk](http://www.pdflabs.com/tools/pdftk-server/).
 You'll need a working `pdftk` binary. Either get a binary package from
 http://www.pdflabs.com/tools/pdftk-server/ and install it, or run
 `apt-get install pdftk` if you're on Debian or similar.
-[Homebrew Cask](http://caskroom.io) also has a pftk formula.
 
 After that, add `pdf-forms` to your Gemfile or manually install the gem. Nothing
 unusual here.
@@ -54,13 +53,24 @@ pdftk.fill_form '/path/to/form.pdf', 'myform.pdf', :foo => 'bar'
 
 # optionally, add the :flatten option to prevent editing of a filled out form
 pdftk.fill_form '/path/to/form.pdf', 'myform.pdf', {:foo => 'bar'}, :flatten => true
+
+# to enable PDF encryption, pass encrypt: true. By default, a random 'owner
+# password' will be used, but you can also set one with the :encrypt_pw option.
+pdftk.fill_form '/path/to/form.pdf', 'myform.pdf', {foo: 'bar'}, encrypt: true, encrypt_options: 'allow printing'
+
+# you can also protect the PDF even from opening by specifying an additional user_pw option:
+pdftk.fill_form '/path/to/form.pdf', 'myform.pdf', {foo: 'bar'}, encrypt: true, encrypt_options: 'user_pw secret'
 ```
 
+Any options shown above can also be set when initializing the PdfForms
+instance. In this case, options given to `fill_form` will override the global
+options.
+
 ### 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
 
-Created by [Jens Kraemer](http://jkraemer.net/) and licensed under the MIT Liense.
+Created by [Jens Kraemer](http://jkraemer.net/) and licensed under the MIT License.
 

data/lib/pdf_forms/field.rb

@@ -9,35 +9,45 @@ module PdfForms
     # FieldStateOption: Ja
     # FieldStateOption: Off
     #
-    # Represenation of a PDF Form Field
+    # Representation of a PDF Form Field
     def initialize(field_description)
+      last_value = nil
       field_description.each_line do |line|
-        case line
-        when /FieldStateOption:\s*(.*?)\s*$/
-          (@options ||= []) << $1
-        else
-          line.strip!
-          key, value = line.split(": ")
-          key.gsub!(/Field/, "")
-          key = key.split(/(?=[A-Z])/).map(&:downcase).join('_').split(":")[0]
-          
-          instance_variable_set("@#{key}", value)
-          
-          # dynamically add in fields that we didn't anticipate in ATTRS
-          unless self.respond_to?(key.to_sym)
-            proc = Proc.new { instance_variable_get("@#{key}".to_sym) }
-            self.class.send(:define_method, key.to_sym, proc)
+        line.chomp!
+
+        if line =~ /^Field([A-Za-z]+):\s+(.*)/
+          _, key, value = *$~
+
+          if key == 'StateOption'
+            (@options ||= []) << value
+
+          else
+            value.chomp!
+            last_value = value
+            key = key.split(/(?=[A-Z])/).map(&:downcase).join('_')
+            instance_variable_set("@#{key}", value)
+
+            # dynamically add in fields that we didn't anticipate in ATTRS
+            unless self.respond_to?(key.to_sym)
+              proc = Proc.new { instance_variable_get("@#{key}".to_sym) }
+              self.class.send(:define_method, key.to_sym, proc)
+            end
           end
+
+        else
+          # pdftk returns a line that doesn't start with "Field"
+          # It happens when a text field has multiple lines
+          last_value << "\n" << line
         end
       end
     end
-    
+
     def to_hash
       hash = {}
       ATTRS.each do |attribute|
         hash[attribute] = self.send(attribute)
       end
-      
+
       hash
     end
 

data/lib/pdf_forms/normalize_path.rb

@@ -5,8 +5,7 @@ module PdfForms
   module NormalizePath
 
     def normalize_path(path)
-      path = path.to_path if path.respond_to? :to_path
-      path.to_str
+      Pathname(path).to_path
     end
 
   end

data/lib/pdf_forms/pdftk_wrapper.rb

@@ -3,6 +3,7 @@
 require 'tempfile'
 require 'cliver'
 require 'safe_shell'
+require 'securerandom'
 
 module PdfForms
   class PdftkError < StandardError
@@ -40,8 +41,7 @@ module PdfForms
       fill_options = {:tmp_path => tmp.path}.merge(fill_options)
 
       args = [ q_template, 'fill_form', normalize_path(tmp.path), 'output', q_destination ]
-      append_options args, fill_options
-      result = call_pdftk *args
+      result = call_pdftk(*(append_options(args, fill_options)))
 
       unless File.readable?(destination) && File.size(destination) > 0
         fdf_path = nil
@@ -85,13 +85,28 @@ module PdfForms
       SafeShell.execute pdftk, *(args.flatten)
     end
 
-    # concatenate documents
+    # concatenate documents, can optionally specify page ranges
     #
-    # args: in_file1, in_file2, ... , in_file_n, output
+    # args: in_file1, {in_file2 => ["1-2", "4-10"]}, ... , in_file_n, output
     def cat(*args)
-      arguments = args.flatten.compact.map{|path| normalize_path(path)}
-      output = arguments.pop
-      call_pdftk arguments, 'output', output
+      in_files = []
+      page_ranges = []
+      file_handle = "A"
+      output = normalize_path args.pop
+
+      args.flatten.compact.each do |in_file|
+        if in_file.is_a? Hash
+          path = in_file.keys.first
+          page_ranges.push *in_file.values.first.map {|range| "#{file_handle}#{range}"}
+        else
+          path = in_file
+          page_ranges.push "#{file_handle}"
+        end
+        in_files.push "#{file_handle}=#{normalize_path(path)}"
+        file_handle.next!
+      end
+
+      call_pdftk in_files, 'cat', page_ranges, 'output', output
     end
 
     # stamp one pdf with another
@@ -119,16 +134,20 @@ module PdfForms
     end
 
     def append_options(args, local_options = {})
-      return if options.empty? && local_options.empty?
+      return args if options.empty? && local_options.empty?
+      args = args.dup
       if option_or_global(:flatten, local_options)
         args << 'flatten'
       end
       if option_or_global(:encrypt, local_options)
         encrypt_pass = option_or_global(:encrypt_password, local_options)
-        encrypt_pass ||= option_or_global(:tmp_path, local_options)
+        encrypt_pass ||= SecureRandom.urlsafe_base64
         encrypt_options = option_or_global(:encrypt_options, local_options)
-        args += ['encrypt_128bit', 'owner_pw', encrypt_pass, encrypt_options].flatten.compact
+        encrypt_options = encrypt_options.split if String === encrypt_options
+        args << ['encrypt_128bit', 'owner_pw', encrypt_pass, encrypt_options]
       end
+      args.flatten!
+      args.compact!
       args
     end
 

data/lib/pdf_forms/version.rb

@@ -1,5 +1,5 @@
 # coding: UTF-8
 
 module PdfForms
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/lib/pdf_forms/xfdf.rb

@@ -1,5 +1,7 @@
 # coding: UTF-8
 
+require 'rexml/document'
+
 module PdfForms
   # Map keys and values to Adobe's XFDF format.
   class XFdf < DataFormat
@@ -14,7 +16,6 @@ module PdfForms
     end
 
     def quote(value)
-      require 'rexml/document'
       REXML::Text.new(value.to_s).to_s
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdf-forms
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Jens Krämer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-30 00:00:00.000000000 Z
+date: 2016-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cliver
@@ -48,14 +48,14 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
@@ -112,9 +112,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: pdf-forms
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Fill out PDF forms with pdftk (http://www.accesspdf.com/pdftk/).
 test_files: []
-has_rdoc: