ach 0.4.0 → 0.4.1

data/README.md

@@ -4,7 +4,7 @@ ach is a Ruby helper for builder ACH files. In particular, it helps with field
 order and alignment, and adds padding lines to end of file.
 
 **This library has only been used in one production application and for very
-limited purposes. Please test thoroughly before using in a production 
+limited purposes. Please test thoroughly before using in a production
 environment.**
 
 See [ACH::Builder](http://search.cpan.org/~tkeefer/ACH-Builder-0.03/lib/ACH/Builder.pm)
@@ -31,6 +31,7 @@ fh.immediate_origin_name = "BANK NAME"
 batch = ACH::Batch.new
 bh = batch.header
 bh.company_name = "Company Name"
+bh.company_identification_code_designator = "1"
 bh.company_identification = "123456789"
 bh.standard_entry_class_code = 'PPD'
 bh.company_entry_description = "DESCRIPTION"

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.4.1

data/ach.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "ach"
-  s.version = "0.4.0"
+  s.version = "0.4.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jared Morgan", "Josh Puetz"]
-  s.date = "2012-11-07"
+  s.date = "2012-12-10"
   s.description = "ach is a Ruby helper for builder ACH files. In particular, it helps with field\norder and alignment, and adds padding lines to end of file.\n"
   s.email = "jmorgan@morgancreative.net"
   s.extra_rdoc_files = [

data/examples/ach/batch_example.rb

@@ -3,7 +3,7 @@ require 'example_helper'
 describe ACH::Batch do
   before(:each) do
     @batch = ACH::Batch.new
-    
+
     @credit = ACH::EntryDetail.new
     @credit.transaction_code = ACH::CHECKING_CREDIT
     @credit.routing_number = "000000000"
@@ -12,11 +12,11 @@ describe ACH::Batch do
     @credit.individual_id_number = "Employee Name"
     @credit.individual_name = "Employee Name"
     @credit.originating_dfi_identification = '00000000'
-    
+
     @debit = @credit.dup
     @debit.transaction_code = ACH::CHECKING_DEBIT
   end
-  
+
   def new_batch
     batch = ACH::Batch.new
     bh = batch.header
@@ -37,47 +37,47 @@ describe ACH::Batch do
       debits.header.service_class_code.should be_nil
       debits.to_ach
       debits.header.service_class_code.should == 225
-      
+
       credits = new_batch
       credits.entries << @credit << @credit
       credits.header.service_class_code.should be_nil
       credits.to_ach
       credits.header.service_class_code.should == 220
-      
+
       both = new_batch
       both.entries << @credit << @debit
       both.header.service_class_code.should be_nil
       both.to_ach
       both.header.service_class_code.should == 200
     end
-    
+
     it 'should not override BatchHeader#service_class_code if already set' do
       debits = new_batch
       debits.header.service_class_code = 200
       debits.entries << @debit << @debit
       debits.to_ach
       debits.header.service_class_code.should == 200
-      
+
       debits = new_batch
       debits.header.service_class_code = '220'
       debits.entries << @credit << @credit
       debits.to_ach
       debits.header.service_class_code.should == '220'
     end
-    
+
     it 'should set BatchControl#service_class_code from BatchHeader if not set' do
       batch = new_batch
       batch.header.service_class_code = 200
       batch.control.service_class_code.should be_nil
       batch.to_ach
       batch.control.service_class_code.should == 200
-      
+
       batch = new_batch
       batch.header.service_class_code = '225'
       batch.control.service_class_code.should be_nil
       batch.to_ach
       batch.control.service_class_code.should == '225'
-      
+
       debits = new_batch
       debits.entries << @debit << @debit
       debits.header.service_class_code.should be_nil
@@ -85,7 +85,7 @@ describe ACH::Batch do
       debits.to_ach
       debits.header.service_class_code.should == 225
     end
-    
+
     it 'should not override BatchHeader#service_class_code if already set' do
       # Granted that I can't imagine this every being used...
       batch = new_batch

data/examples/ach/fixtures/return_noc.txt

@@ -5,9 +5,9 @@
 820000000200121140390000000000000000000000001412345678                         992222220000001
 5200COMPANY INC     DISC DATA           1412345678PPDDESCRIPT  1210151210150001992222220000002
 6261211403993300911569       0000002536GKGQT9VK       NAME TWO                1121140390280738
-799R07992222220280393      12114039                                            121140390280738
+799R07992222220280393      12114039INVALID                                     121140390280738
 820000000200121140390000000025360000000000001412345678                         992222220000002
-5200COMPANY INC     DISC DATA           1412345678PPDDESCRIPT  1210151210150001992222220000003
+5200COMPANY INC     DISC DATA           1412345678PPDDESCRIPT        1210150001992222220000003
 6261211403993300911569       0000002417KYU341VP       NAME THREE              1121140390280729
 799R03992222220280389      12114039                                            121140390280729
 820000000200121140390000000024170000000000001412345678                         992222220000003

data/examples/ach/parse_example.rb

@@ -37,12 +37,27 @@ describe "Parse" do
       ed.individual_id_number.should == "A38LTNY2"
       ed.individual_name.should == "NAME ONE"
 
+      ed.addenda.size.should == 1
+      ad = ed.addenda[0]
+      ad.type_code.should == '98'
+      ad.reason_code.should == 'C05'
+      ad.original_entry_trace_number.should == '992222220280489'
+      ad.corrected_data.should == '32'
+      ad.sequence_number.should == 4039
+
       batch = ach.batches[1]
       batch.entries.size.should == 1
       bh = batch.header
       bh.standard_entry_class_code.should == 'PPD'
       ed = batch.entries[0]
       ed.amount.should == 2536
+
+      ed.addenda.size.should == 1
+      ad = ed.addenda[0]
+      ad.type_code.should == '99'
+      ad.reason_code.should == 'R07'
+      ad.original_entry_trace_number.should == '992222220280393'
+      ad.addenda_information.should == 'INVALID'
     end
 
   end

data/examples/ach/records/batch_control_example.rb

@@ -13,9 +13,9 @@ describe ACH::Records::BatchControl do
     @record.originating_dfi_identification = '32345678'
     @record.batch_number = 5
   end
-  
+
   self.instance_eval(&SharedExamples.batch_summaries)
-  
+
   describe '#to_ach' do
     it 'should generate record string' do
       exp = [

data/lib/ach/ach_file.rb

@@ -1,13 +1,13 @@
 require 'date'
 
-module ACH 
+module ACH
   class ACHFile
     include FieldIdentifiers
-    
+
     attr_reader :batches
     attr_reader :header
     attr_reader :control
-    
+
     def initialize data=nil
       @batches = []
       @header = Records::FileHeader.new
@@ -17,52 +17,52 @@ module ACH
         parse(data)
       end
     end
-    
+
     def to_s
       records = []
       records << @header
       @batches.each { |b| records += b.to_ach }
       records << @control
-      
+
       nines_needed = 10 - (records.length % 10)
       nines_needed = nines_needed % 10
       nines_needed.times { records << Records::Nines.new() }
-      
+
       @control.batch_count = @batches.length
       @control.block_count = (records.length / 10).ceil
-      
+
       @control.entry_count = 0
       @control.debit_total = 0
       @control.credit_total = 0
       @control.entry_hash = 0
-      
+
       @batches.each do | batch |
         @control.entry_count += batch.entries.length
         @control.debit_total += batch.control.debit_total
         @control.credit_total += batch.control.credit_total
         @control.entry_hash += batch.control.entry_hash
       end
-      
+
 
       records.collect { |r| r.to_ach }.join("\r\n") + "\r\n"
     end
-    
+
     def report
       to_s # To ensure correct records
       lines = []
-      
+
       @batches.each do | batch |
         batch.entries.each do | entry |
           lines << left_justify(entry.individual_name + ": ", 25) +
               sprintf("% 7d.%02d", entry.amount / 100, entry.amount % 100)
-        end        
+        end
       end
       lines << ""
       lines << left_justify("Debit Total: ", 25) +
           sprintf("% 7d.%02d", @control.debit_total / 100, @control.debit_total % 100)
       lines << left_justify("Credit Total: ", 25) +
           sprintf("% 7d.%02d", @control.credit_total / 100, @control.credit_total % 100)
-      
+
       lines.join("\r\n")
     end
 
@@ -74,8 +74,9 @@ module ACH
       ed = nil
 
       data.strip.split(/\n|\r\n/).each do |line|
-        type = line[0..0]
-        if type == '1'
+        type = line[0]
+        case type
+        when '1'
           fh.immediate_destination          = line[03..12].strip
           fh.immediate_origin               = line[13..22].strip
           fh.transmission_datetime          = Time.utc('20'+line[23..24], line[25..26], line[27..28], line[29..30], line[31..32])
@@ -83,7 +84,7 @@ module ACH
           fh.immediate_destination_name     = line[40..62].strip
           fh.immediate_origin_name          = line[63..85].strip
           fh.reference_code                 = line[86..93].strip
-        elsif type == '5'
+        when '5'
           self.batches << batch unless batch.nil?
           batch = ACH::Batch.new
           bh = batch.header
@@ -91,10 +92,10 @@ module ACH
           bh.company_identification         = line[41..49].strip
           bh.standard_entry_class_code      = line[50..52].strip
           bh.company_entry_description      = line[53..62].strip
-          bh.company_descriptive_date       = Date.parse(line[63..68])
+          bh.company_descriptive_date       = Date.parse(line[63..68]) rescue nil # this can be various formats
           bh.effective_entry_date           = Date.parse(line[69..74])
           bh.originating_dfi_identification = line[79..86].strip
-        elsif type == '6'
+        when '6'
           ed = ACH::CtxEntryDetail.new
           ed.transaction_code               = line[1..2]
           ed.routing_number                 = line[3..11]
@@ -105,16 +106,24 @@ module ACH
           ed.originating_dfi_identification = line[79..86]
           ed.trace_number                   = line[87..93].to_i
           batch.entries << ed
-        elsif type == '7'
-          ad = ACH::Addendum.new
-          ad.type_code                      = line[1..2]
+        when '7'
+          type_code = line[1..2]
+          ad = case type_code
+          when '98'
+            ACH::Addendum::NotificationOfChange.new
+          when '99'
+            ACH::Addendum::Return.new
+          else
+            ACH::Addendum.new
+          end
+          ad.type_code                      = type_code
           ad.payment_data                   = line[3..82].strip
           ad.sequence_number                = line[83..86].strip.to_i
           ad.entry_detail_sequence_number   = line[87..93].to_i
           ed.addenda << ad
-        elsif type == '8'
+        when '8'
           # skip
-        elsif type == '9'
+        when '9'
           # skip
         else
           raise "Didn't recognize type code #{type} for this line:\n#{line}"

data/lib/ach/records/addendum.rb

@@ -1,13 +1,57 @@
 module ACH::Records
   class Addendum < Record
-    
     @fields = []
 
     const_field :record_type, '7'
-    field :type_code, String, lambda {|f| f}, '05', /\A\d{2}\Z/
+    field :type_code, String, nil, '05', /\A\d{2}\Z/
     field :payment_data, String, lambda { |f| left_justify(f, 80)}
     field :sequence_number, Integer, lambda { |f| sprintf('%04d', f)}
     field :entry_detail_sequence_number, Integer, lambda { |f| sprintf('%07d', f)}
 
+    # NOTE: When the API can change, these subclasses should override the
+    #       redundant fields in Addendum
+    class NotificationOfChange < Addendum
+      @fields = Addendum.fields
+
+      def reason_code
+        payment_data[0..2]
+      end
+
+      def original_entry_trace_number
+        payment_data[3..17]
+      end
+
+      def original_receiving_dfi_identification
+        payment_data[24..31]
+      end
+
+      def corrected_data
+        payment_data[32..60].strip
+      end
+    end
+
+    class Return < Addendum
+      @fields = Addendum.fields
+
+      def reason_code
+        payment_data[0..2]
+      end
+
+      def original_entry_trace_number
+        payment_data[3..17]
+      end
+
+      def date_of_death
+        Date.parse(payment_data[18..23])
+      end
+
+      def original_receiving_dfi_identification
+        payment_data[24..31]
+      end
+
+      def addenda_information
+        payment_data[32..75].strip
+      end
+    end
   end
-end
+end

data/lib/ach/records/batch_control.rb

@@ -1,30 +1,31 @@
 module ACH::Records
   class BatchControl < Record
     @fields = []
-    
+
     const_field :record_type, '8'
-    
+
     # Many of the fields are calculated in Batch.to_ach
     field :service_class_code, String,
-        lambda { |f| f.to_s }, '200', 
+        lambda { |f| f.to_s }, '200',
         lambda { |f| ACH::SERVICE_CLASS_CODES.include?(f.to_i) }
     field :entry_count, Integer, lambda { |f| sprintf('%06d', f)}
     field :entry_hash, Integer, lambda { |f| sprintf('%010d', f % (10 ** 10))}
     field :debit_total, Integer, lambda { |f| sprintf('%012d', f)}
     field :credit_total, Integer, lambda { |f| sprintf('%012d', f)}
-    
+    field :company_identification_code_designator, String, lambda {|f| f}, '1',
+        /\A(1|3){1}\Z/
     field :company_identification, String,
-        lambda {|f| '1' + f}, nil, /\A\d{9}\Z/,
+        lambda {|f| f}, nil, /\A\d{9}\Z/,
         'Company Tax ID'
-        
+
     field :message_authentication_code, String,
         lambda { |f| left_justify(f, 19)}, ''
 
     const_field :reserved, (' ' * 6)
-    
+
     field :originating_dfi_identification, String,
         lambda {|f| f}, nil, /\A\d{8}\Z/
-        
+
     field :batch_number, Integer, lambda { |f| sprintf('%07d', f)}, 1
   end
 end

data/lib/ach/records/batch_header.rb

@@ -1,23 +1,25 @@
 module ACH::Records
   class BatchHeader < Record
     @fields = []
-    
+
     const_field :record_type, '5'
-    
+
     # TODO: This needs to be changed to reflect whether credits, debits or both.
     field :service_class_code, String,
-        lambda { |f| f.to_s }, '200', 
+        lambda { |f| f.to_s }, '200',
         lambda { |f| ACH::SERVICE_CLASS_CODES.include?(f.to_i) }
     field :company_name, String, lambda { |f| left_justify(f, 16)}
     field :company_discretionary_data, String,
         lambda { |f| left_justify(f, 20)}, ''
+    field :company_identification_code_designator, String, lambda {|f| f}, '1',
+        /\A(1|3){1}\Z/
     field :company_identification, String,
-        lambda {|f| '1' + f}, nil, /\A\d{9}\Z/,
+        lambda {|f| f}, nil, /\A\d{9}\Z/,
         'Company Tax ID'
     # TODO This should be used to determine whether other records are valid for
     # for this code. Should there be a Class for each code?
     # The default of PPD is purely for my benefit (Jared Morgan)
-    field :standard_entry_class_code, String, 
+    field :standard_entry_class_code, String,
         lambda { |f| f.upcase }, 'PPD', /\A\w{3}\Z/
     field :company_entry_description, String,
         lambda { |f| left_justify(f, 10)}
@@ -30,7 +32,7 @@ module ACH::Records
     const_field :originator_status_code, '1'
     field :originating_dfi_identification, String,
         lambda {|f| f}, nil, /\A\d{8}\Z/
-        
+
     field :batch_number, Integer, lambda { |f| sprintf('%07d', f)}, 1
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ach
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-07 00:00:00.000000000 Z
+date: 2012-12-10 00:00:00.000000000 Z
 dependencies: []
 description: ! 'ach is a Ruby helper for builder ACH files. In particular, it helps
   with field