iaa 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 47702542829dfefc3e317e0c13a36ad3633282a5
-  data.tar.gz: 890134742cec065c4122d93c327f76e18b96ee01
+  metadata.gz: 1eb2158ff489e1ffc1e98abbbfde98270da163df
+  data.tar.gz: 8d517d819226ed638327487157eeeb27f254305c
 SHA512:
-  metadata.gz: daaaa4ee1deaf51d043ac4c12be24a94a50ea9fd5c8767beaa46b7ffcc69a212bcadce1ef1e8c59a2b8991a27b84a1d19928a52e75a850f7fa0d15aa2af69f8f
-  data.tar.gz: 6330f2f22b5610557051f2b8e588c7cf11130de88bb6c6a199dc3da2a438c18df79d87f36fc25ba1f3a06ce70438e57437cbc43b2dd2cab8adbaa2804f930f04
+  metadata.gz: 88fc95a42dc2016886f7f283a976f6d06070f7da731a3c0405f79ca332578ca4924b517a5f32fc1f725ea57cea9f9a34410c94719c3f66d1d95b8eaaf7a56df6
+  data.tar.gz: ac3590c159a1d5793af5d63aba8e3a6cb53a77073e56208bc6456058fba0f34bc151b6919f4b09cb5319e0b60759d00ee39cde62cfbae9aab9f9a06a5d50a5fb

data/README.md

@@ -56,11 +56,27 @@ 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.
+See `lib/mappings/7600A.json` and `lib/mappings/7600A.json` for all getter and setter methods. The field in these files called `"attribute_name"` corresponds to all getter and setter method names. For example in `lib/mappings/7600A.json`, we have:
+
+```json
+// ...
+  {
+    "name": "Start Date",
+    "attribute_name": "start_date",
+    "options": null,
+    "type": "Text",
+    "value": "FILL IN"
+  },
+// ...
+```
+
+This means instances of `IAA::Form7600A` have the methdods `#start_date` and `#start_date=`. All of the methods are created during `::initialize` through some metaprogramming. Think of the JSON files in the `mappings` folder as the canonical source of method names.
+
+You could also use these JSON files to create IAA form fillers in other languages.
 
-### mappings.json
+### PDFs
 
-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.
+The PDFs in `lib/pdfs` have been modified somewhat from their originals. Visually, nothing has changed, but a few of the underlying form field names have been changed. For example, one field, "GT & C #" caused a lot of trouble because of that pesky ampersand. So, the field value in the PDF was changed to "gt_and_c_number".
 
 ## Docker Compose Usage
 
@@ -68,24 +84,7 @@ This repo provides a JSON file for each form (`lib/mappings/7600A.json` and `lib
 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
 
@@ -96,3 +95,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/18F/iaa-gem.
+

data/lib/base_form.rb

@@ -8,9 +8,10 @@ module IAA
     def init_pdftk(pdftk_path)
       PdfForms.new(pdftk_path || Cliver.detect('pdftk'))
     end
-
+    
     def get_mapper_fields(path)
-      JSON.parse(File.read(path))
+      full_path = File.expand_path(File.join('..', '..', path), __FILE__)
+      JSON.parse(File.read(full_path))
     end
 
     def load_fields_from_pdf!(pdf_path, pdftk, form_object)
@@ -29,6 +30,18 @@ module IAA
       @fill_values = {}
       load_fields_from_pdf!(pdf_path, @pdftk, self)
       @pdf_path = pdf_path || self.class.default_pdf_path
+      
+      @fields.each do |field|
+        self.class.send(:define_method, field['attribute_name']) do
+          get_attr(field['name'])
+        end
+      end
+      
+      @fields.each do |field|
+        self.class.send(:define_method, "#{field['attribute_name']}=") do |argument|
+          set_attr(field['name'], argument)
+        end
+      end
     end
 
     def read_fields

data/lib/form_7600a.rb

@@ -3,390 +3,5 @@ module IAA
     def self.form_name
       "7600A"
     end
-
-    def servicing_agency_tracking_number=(new_servicing_agency_tracking_number)
-      set_attr("Servicing Agency Agreement Tracking Number (Optional)", new_servicing_agency_tracking_number)
-    end
-
-    def servicing_agency_tracking_number
-      get_attr("Servicing Agency Agreement Tracking Number (Optional)")
-    end
-
-    def start_date=(new_start_date)
-      set_attr("Start Date", new_start_date)
-    end
-
-    def start_date
-      get_attr("Start Date")
-    end
-
-    def end_date=(new_end_date)
-      set_attr("End Date", new_end_date)
-    end
-
-    def end_date
-      get_attr("End Date")
-    end
-
-    def requesting_agency_name=(new_requesting_agency_name)
-      set_attr("Name Requesting Agency of Products/Services", new_requesting_agency_name)
-    end
-
-    def requesting_agency_name
-      get_attr("Name Requesting Agency of Products/Services")
-    end
-
-    def requesting_agency_address=(new_requesting_agency_address)
-      set_attr("Address Requesting Agency of Products/Services", new_requesting_agency_address)
-    end
-
-    def requesting_agency_address
-      get_attr("Address Requesting Agency of Products/Services")
-    end
-
-    def servicing_agency_name=(new_servicing_agency_name)
-      set_attr("Name Servicing Agency Providing Products/Services", new_servicing_agency_name)
-    end
-
-    def servicing_agency_name
-      get_attr("Name Servicing Agency Providing Products/Services")
-    end
-
-    def servicing_agency_address=(new_servicing_agency_address)
-      set_attr("Address Servicing Agency Providing Products/Services", new_servicing_agency_address)
-    end
-
-    def servicing_agency_address
-      get_attr("Address Servicing Agency Providing Products/Services")
-    end
-
-    def radio1=(new_radio1)
-      set_attr("Radio Button1", new_radio1)
-    end
-
-    def radio1
-      get_attr("Radio Button1")
-    end
-
-    def radio2=(new_radio2)
-      set_attr("Radio Button2", new_radio2)
-    end
-
-    def radio2
-      get_attr("Radio Button2")
-    end
-
-    def radio3=(new_radio3)
-      set_attr("Radio Button3", new_radio3)
-    end
-
-    def radio3
-      get_attr("Radio Button3")
-    end
-
-    def radio4=(new_radio4)
-      set_attr("Radio Button4", new_radio4)
-    end
-
-    def radio4
-      get_attr("Radio Button4")
-    end
-
-    def radio5=(new_radio5)
-      set_attr("Radio Button5", new_radio5)
-    end
-
-    def radio5
-      get_attr("Radio Button5")
-    end
-
-    def radio6=(new_radio6)
-      set_attr("Radio Button6", new_radio6)
-    end
-
-    def radio6
-      get_attr("Radio Button6")
-    end
-
-    def amendment=(new_amendment)
-      set_attr("Amendment", new_amendment)
-    end
-
-    def amendment
-      get_attr("Amendment")
-    end
-
-    def cancellation_explanation=(new_cancellation_explanation)
-      set_attr("IAA Cancellation Explanation", new_cancellation_explanation)
-    end
-
-    def cancellation_explanation
-      get_attr("IAA Cancellation Explanation")
-    end
-
-    def other_renewal_period=(new_other_renewal_period)
-      set_attr("Other Renewal Period", new_other_renewal_period)
-    end
-
-    def other_renewal_period
-      get_attr("Other Renewal Period")
-    end
-
-    def requesting_agency_statutory_authority_title_and_citation=(new_requesting_agency_statutory_authority_title_and_citation)
-      set_attr("Requesting Agency's Statutory Authority Title and Citation", new_requesting_agency_statutory_authority_title_and_citation)
-    end
-
-    def requesting_agency_statutory_authority_title_and_citation
-      get_attr("Requesting Agency's Statutory Authority Title and Citation")
-    end
-
-    def gt_and_c_number=(new_gt_and_c_number)
-      set_attr("GT&C #", new_gt_and_c_number)
-    end
-
-    def gt_and_c_number
-      get_attr("GT&C #")
-    end
-
-    def mod_number=(new_mod_number)
-      set_attr("Mod #", new_mod_number)
-    end
-
-    def mod_number
-      get_attr("Mod #")
-    end
-
-    def direct_cost=(new_direct_cost)
-      set_attr("Direct  Cost", new_direct_cost)
-    end
-
-    def direct_cost
-      get_attr("Direct  Cost")
-    end
-
-    def overhead_fees_and_charges=(new_overhead_fees_and_charges)
-      set_attr("Overhead Fees  Charges", new_overhead_fees_and_charges)
-    end
-
-    def overhead_fees_and_charges
-      get_attr("Overhead Fees  Charges")
-    end
-
-    def total_estimated_amount=(new_total_estimated_amount)
-      set_attr("Total Estimated Amount", new_total_estimated_amount)
-    end
-
-    def total_estimated_amount
-      get_attr("Total Estimated Amount")
-    end
-
-    def requesting_agency_scope=(new_requesting_agency_scope)
-      set_attr("11 Requesting Agencys Scope State andor list attachments that support Requesting Agencys Scope", new_requesting_agency_scope)
-    end
-
-    def requesting_agency_scope
-      get_attr("11 Requesting Agencys Scope State andor list attachments that support Requesting Agencys Scope")
-    end
-
-    def requesting_agency_roles_and_responsibilities=(new_requesting_agency_roles_and_responsibilities)
-      set_attr("12 Roles  Responsibilities for the Requesting Agency and Servicing Agency State andor list attachments for the roles and responsibilities for the Requesting Agency and the Servicing Agency", new_requesting_agency_roles_and_responsibilities)
-    end
-
-    def requesting_agency_roles_and_responsibilities
-      get_attr("12 Roles  Responsibilities for the Requesting Agency and Servicing Agency State andor list attachments for the roles and responsibilities for the Requesting Agency and the Servicing Agency")
-    end
-
-    def radio7=(new_radio7)
-      set_attr("Radio Button7", new_radio7)
-    end
-
-    def radio7
-      get_attr("Radio Button7")
-    end
-
-    def radio8=(new_radio8)
-      set_attr("Radio Button8", new_radio8)
-    end
-
-    def radio8
-      get_attr("Radio Button8")
-    end
-
-    def general_explanation_overhead_fees_and_charges=(new_general_explanation_overhead_fees_and_charges)
-      set_attr("General Explanation Overhead Fees & Charges", new_general_explanation_overhead_fees_and_charges)
-    end
-
-    def general_explanation_overhead_fees_and_charges
-      get_attr("General Explanation Overhead Fees & Charges")
-    end
-
-    def statory_authority=(new_statory_authority)
-      set_attr("Statutory authority", new_statory_authority)
-    end
-
-    def statory_authority
-      get_attr("Statutory authority")
-    end
-
-    def statutory_authority_1=(new_statutory_authority_1)
-      set_attr("Statutory Authority1", new_statutory_authority_1)
-    end
-
-    def statutory_authority_1
-      get_attr("Statutory Authority1")
-    end
-
-    def restrictions=(new_restrictions)
-      set_attr("13 Restrictions Optional State andor attach unique requirements andor mission specific restrictions specific to this IAA", new_restrictions)
-    end
-
-    def restrictions
-      get_attr("13 Restrictions Optional State andor attach unique requirements andor mission specific restrictions specific to this IAA")
-    end
-
-    def requesting_agency_organiations_authorized=(new_requesting_agency_organiations_authorized)
-      set_attr("17  Assisted Acquisition Agreements  Requesting Agencys Organizations Authorized To Request Acquisition Assistance for this IAA State or attach a list of Requesting Agencys organizations authorized to request acquisition assistance for this IAA", new_requesting_agency_organiations_authorized)
-    end
-
-    def requesting_agency_organiations_authorized
-      get_attr("17  Assisted Acquisition Agreements  Requesting Agencys Organizations Authorized To Request Acquisition Assistance for this IAA State or attach a list of Requesting Agencys organizations authorized to request acquisition assistance for this IAA")
-    end
-
-    def servicing_agency_organiations=(new_servicing_agency_organiations)
-      set_attr("18  Assisted Acquisition Agreements  Servicing Agencys Organizations authorized to Provide Acquisition Assistance for this IAA State or attach a list of Servicing Agencys organizations authorized to provide acquisition for this IAA", new_servicing_agency_organiations)
-    end
-
-    def servicing_agency_organiations
-      get_attr("18  Assisted Acquisition Agreements  Servicing Agencys Organizations authorized to Provide Acquisition Assistance for this IAA State or attach a list of Servicing Agencys organizations authorized to provide acquisition for this IAA")
-    end
-
-    def requesting_agency_clauses=(new_requesting_agency_clauses)
-      set_attr("19 Requesting Agency Clauses Optional State andor attach any additional Requesting Agency clauses", new_requesting_agency_clauses)
-    end
-
-    def requesting_agency_clauses
-      get_attr("19 Requesting Agency Clauses Optional State andor attach any additional Requesting Agency clauses")
-    end
-
-    def number_of_days_this_iaa_may_be_terminated=(new_number_of_days_this_iaa_may_be_terminated)
-      set_attr("No. of days this IAA may be terminated", new_number_of_days_this_iaa_may_be_terminated)
-    end
-
-    def number_of_days_this_iaa_may_be_terminated
-      get_attr("No. of days this IAA may be terminated")
-    end
-
-    def servicing_agency_clauses=(new_servicing_agency_clauses)
-      set_attr("20 Servicing Agency Clauses Optional State andor attach any additional Servicing Agency clauses", new_servicing_agency_clauses)
-    end
-
-    def servicing_agency_clauses
-      get_attr("20 Servicing Agency Clauses Optional State andor attach any additional Servicing Agency clauses")
-    end
-
-    def additional_attachments=(new_additional_attachments)
-      set_attr("21 Additional Requesting Agency andor Servicing Agency Attachments Optional State andor attach any additional Requesting Agency andor Servicing Agency attachments", new_additional_attachments)
-    end
-
-    def additional_attachments
-      get_attr("21 Additional Requesting Agency andor Servicing Agency Attachments Optional State andor attach any additional Requesting Agency andor Servicing Agency attachments")
-    end
-
-    def requesting_agency_name=(new_requesting_agency_name)
-      set_attr("Requesting Agency Name", new_requesting_agency_name)
-    end
-
-    def requesting_agency_name
-      get_attr("Requesting Agency Name")
-    end
-
-    def servicing_agency_name=(new_servicing_agency_name)
-      set_attr("Servicing Agency Name", new_servicing_agency_name)
-    end
-
-    def servicing_agency_name
-      get_attr("Servicing Agency Name")
-    end
-
-    def requesting_agency_title=(new_requesting_agency_title)
-      set_attr("Requesting Agency Title", new_requesting_agency_title)
-    end
-
-    def requesting_agency_title
-      get_attr("Requesting Agency Title")
-    end
-
-    def servicing_agency_title=(new_servicing_agency_title)
-      set_attr("Servicing Agency Title", new_servicing_agency_title)
-    end
-
-    def servicing_agency_title
-      get_attr("Servicing Agency Title")
-    end
-
-    def requesting_agency_telephone_number=(new_requesting_agency_telephone_number)
-      set_attr("Requesting Agency Telephone Number", new_requesting_agency_telephone_number)
-    end
-
-    def requesting_agency_telephone_number
-      get_attr("Requesting Agency Telephone Number")
-    end
-
-    def servicing_agency_telephone_number=(new_servicing_agency_telephone_number)
-      set_attr("Servicing Agency Telephone Number", new_servicing_agency_telephone_number)
-    end
-
-    def servicing_agency_telephone_number
-      get_attr("Servicing Agency Telephone Number")
-    end
-
-    def requesting_agency_fax_number=(new_requesting_agency_fax_number)
-      set_attr("Requesting Agency Fax Number", new_requesting_agency_fax_number)
-    end
-
-    def requesting_agency_fax_number
-      get_attr("Requesting Agency Fax Number")
-    end
-
-    def servicing_agency_fax_number=(new_servicing_agency_fax_number)
-      set_attr("Servicing Agency Fax Number", new_servicing_agency_fax_number)
-    end
-
-    def servicing_agency_fax_number
-      get_attr("Servicing Agency Fax Number")
-    end
-
-    def requesting_agency_email_address=(new_requesting_agency_email_address)
-      set_attr("Requesting Agency Email Address", new_requesting_agency_email_address)
-    end
-
-    def requesting_agency_email_address
-      get_attr("Requesting Agency Email Address")
-    end
-
-    def servicing_agency_email_address=(new_servicing_agency_email_address)
-      set_attr("Servicing Agency Email Address", new_servicing_agency_email_address)
-    end
-
-    def servicing_agency_email_address
-      get_attr("Servicing Agency Email Address")
-    end
-
-    def requesting_agency_approval_date=(new_requesting_agency_approval_date)
-      set_attr("Requesting Agency Approval Date", new_requesting_agency_approval_date)
-    end
-
-    def requesting_agency_approval_date
-      get_attr("Requesting Agency Approval Date")
-    end
-
-    def servicing_agency_approval_date=(new_servicing_agency_approval_date)
-      set_attr("Servicing Agency Approval Date", new_servicing_agency_approval_date)
-    end
-
-    def servicing_agency_approval_date
-      get_attr("Servicing Agency Approval Date")
-    end
-
   end
 end