iaa 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bcd9a53843a589857b720adf9e28fe794bf686ba
+  data.tar.gz: e2217c2af2632269e6400c21976b981752ff582d
+SHA512:
+  metadata.gz: 54e98206a7bd0cebbdfa31ccd66e17774ccbf21f5ac6f1d0dd7dfd46ddee043cf6dff3d91b9812f97698bb7fc9d1819725e3d9c4d6330282e40f13144dec3350
+  data.tar.gz: 62ae37a08a5f2cbeec6f87a4f58e777c4dfd0112be462df682a13b0519659533eaf9388fad4b36c516e4bca4ace8eb6f9a8e93c9eb114d90eea618c751f545ae

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/*
+!/tmp/humans.txt

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.1.5
+before_install:
+  - gem install bundler -v 1.10.4
+  - sudo apt-get install pdftk -y

data/CONTRIBUTING.md

@@ -0,0 +1,15 @@
+## Welcome!
+
+We're so glad you're thinking about contributing to an 18F open source project! If you're unsure or afraid of anything, just ask or submit the issue or pull request anyways. The worst that can happen is that you'll be politely asked to change something. We appreciate any sort of contribution, and don't want a wall of rules to get in the way of that.
+
+Before contributing, we encourage you to read our CONTRIBUTING policy (you are here), our LICENSE, and our README, all of which should be in this repository. If you have any questions, or want to read more about our underlying policies, you can consult the 18F Open Source Policy GitHub repository at https://github.com/18f/open-source-policy, or just shoot us an email/official government letterhead note to [18f@gsa.gov](mailto:18f@gsa.gov).
+
+## Public domain
+
+This project is in the public domain within the United States, and
+copyright and related rights in the work worldwide are waived through
+the [CC0 1.0 Universal public domain dedication](https://creativecommons.org/publicdomain/zero/1.0/).
+
+All contributions to this project will be released under the CC0
+dedication. By submitting a pull request, you are agreeing to comply
+with this waiver of copyright interest.

data/Dockerfile

@@ -0,0 +1,8 @@
+FROM      ruby:2.1.6
+MAINTAINER V David Zvenyach <vladlen.zvenyach@gsa.gov>
+RUN apt-get update && apt-get install pdftk -y
+WORKDIR /iaa-gem
+ADD . /iaa-gem
+RUN gem install bundler -v 1.10.4
+RUN bundle install
+CMD ["/iaa-gem/bin/console"]

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in iaa.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,31 @@
+As a work of the United States Government, this project is in the
+public domain within the United States.
+
+Additionally, we waive copyright and related rights in the work
+worldwide through the CC0 1.0 Universal public domain dedication.
+
+## CC0 1.0 Universal Summary
+
+This is a human-readable summary of the [Legal Code (read the full text)](https://creativecommons.org/publicdomain/zero/1.0/legalcode).
+
+### No Copyright
+
+The person who associated a work with this deed has dedicated the work to
+the public domain by waiving all of his or her rights to the work worldwide
+under copyright law, including all related and neighboring rights, to the
+extent allowed by law.
+
+You can copy, modify, distribute and perform the work, even for commercial
+purposes, all without asking permission.
+
+### Other Information
+
+In no way are the patent or trademark rights of any person affected by CC0,
+nor are the rights that other persons may have in the work or in how the
+work is used, such as publicity or privacy rights.
+
+Unless expressly stated otherwise, the person who associated a work with
+this deed makes no warranties about the work, and disclaims liability for
+all uses of the work, to the fullest extent permitted by applicable law.
+When using or citing the work, you should not imply endorsement by the
+author or the affirmer.

data/README.md

@@ -0,0 +1,98 @@
+[![Build Status](https://travis-ci.org/18F/iaa-gem.svg)](https://travis-ci.org/18F/iaa-gem)
+
+# IAA
+
+## Installation
+
+Dependencies (other than standard Ruby/bundler):
+
+- `pdftk`. Get it [here](https://www.pdflabs.com/tools/pdftk-server/).
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'iaa'
+```
+
+To use the latest and greatest:
+
+```ruby
+gem 'iaa', github: '18F/iaa-gem', branch: 'master'
+```
+
+And then execute:
+
+```sh
+$ bundle
+```
+
+## Usage
+
+This gem makes available two classes, `IAA::Form7600A` and `IAA::Form7600B`.
+
+### Open and read an existing IAA Form 7600A or 7600B
+
+```ruby
+form = IAA::Form7600A.new(pdf_path: 'path/to/7600A.pdf')
+form.start_date #=> "05-20-2015"
+form.end_date #> "06-20-2015"
+# ... etc
+```
+
+### Edit and save an IAA Form 7600A or 7600B
+
+```ruby
+form.start_date = "05-21-2015"
+form.save('/path/to/save/destination')
+```
+
+Note: the default directory to save is the "tmp" directory within the iaa-gem directory.
+
+### Start from a blank IAA Form 7600A or 7600B
+
+```ruby
+form2 = IAA::Form7600A.new
+form2.start_date = "07-07-2016"
+form.save('/path/to/save/destination')
+```
+
+See `lib/form_7600a.rb` and `lib/form_7600b` for all getter and setter methods.
+
+### mappings.json
+
+This repo provides a JSON file for each form (`lib/mappings/7600A.json` and `lib/mappings/7600B.json`) of all form fields including their types and possible values (e.g. for radio buttons and checkboxes). This could be used to map objects in other languages to the IAA Form 7600A.
+
+## Docker Compose Usage
+
+1. Make sure that [Docker Compose](https://docs.docker.com/compose/install/) is installed.
+2. Navigate to iaa-gem directory and run `docker-compose build`.
+3. Run `docker-compose run iaa`.
+
+## Caveats
+
+Currently, the following fields cannot be set:
+
+### Form 7600A
+
+- gt_and_c_number
+- general_explanation_overhead_fees_and_charges
+- number_of_days_this_iaa_may_be_terminated
+
+### Form 7600B
+
+- gt_and_c_number
+- requesting_agency_a
+- servicing_agency_a
+- overhead_fees_and_charges
+
+See https://github.com/18F/iaa-gem/issues/6.
+
+## Development
+
+After checking out the repo, run `gem install bundler && bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/18F/iaa-gem.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "iaa"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/docker-compose.yml

@@ -0,0 +1,4 @@
+iaa:
+  build: .
+  volumes: 
+  - .:/iaa-gem

data/iaa.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'iaa/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "iaa"
+  spec.version       = IAA::VERSION
+  spec.authors       = ["Alan deLevie", "V. David Zvenyach"]
+  spec.email         = ["alan.delevie@gsa.gov"]
+  spec.summary       = %q{Programatically fills PDF to produce Inter-Agency Agreements (IAAs)}
+  spec.description   = %q{Helps you create IAAs}
+  spec.homepage      = "https://github.com/18f/iaa-gem"
+  spec.license       = "See LICENSE.md"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  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 = ["lib"]
+
+  spec.add_runtime_dependency "pdf-forms"
+  spec.add_runtime_dependency "cliver"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+end

data/lib/base_form.rb

@@ -0,0 +1,80 @@
+require 'pdf_forms'
+require 'json'
+require 'pry'
+require 'cliver'
+
+module IAA
+  class BaseForm
+    def init_pdftk(pdftk_path)
+      PdfForms.new(pdftk_path || Cliver.detect('pdftk'))
+    end
+
+    def get_mapper_fields(path)
+      JSON.parse(File.read(path))
+    end
+
+    def load_fields_from_pdf!(pdf_path, pdftk, form_object)
+      return if pdf_path.nil?
+      fields = pdftk.get_fields(pdf_path)
+      fields.each do |field|
+        value = field.value rescue nil
+        form_object.set_attr(field.name, value)
+      end
+    end
+
+    def initialize(pdf_path: nil, pdftk_path: nil)
+      @fields = get_mapper_fields(self.class.mapper_path)
+      @pdftk = init_pdftk(pdftk_path)
+      @save_filename = nil
+      @fill_values = {}
+      load_fields_from_pdf!(pdf_path, @pdftk, self)
+      @pdf_path = pdf_path || self.class.default_pdf_path
+    end
+
+    def read_fields
+      @pdftk.get_fields(@pdf_path).map do |field|
+        {
+          "name" => field.name,
+          "options" => field.options,
+          "type" => field.type,
+          "value" => field.value
+        }
+      end
+    end
+
+    def read_field(field_name)
+      read_fields.find {|f| f["name"] == field_name}["value"]
+    end
+
+    def fill_attributes
+      @fill_values
+    end
+
+    def filename
+      @save_filename
+    end
+
+    def set_attr(field, value)
+      @fill_values[field] = value
+    end
+
+    def get_attr(field)
+      @fill_values[field]
+    end
+
+    def save(save_path='tmp')
+      filename = "#{save_path}/#{self.class.form_name}_#{Time.now.to_i}.pdf"
+      @pdftk.fill_form @pdf_path, filename, @fill_values
+      @filename = filename
+    end
+
+    def self.mapper_path
+      "lib/mappings/#{self.form_name}.json"
+    end
+
+    def self.default_pdf_path
+      "lib/pdfs/#{self.form_name}.pdf"
+    end
+
+  end
+end