ach 0.3.2 → 0.4.0

data/README.md

@@ -15,51 +15,60 @@ for a similar Perl library
 You should consult a copy of the [ACH Rules](http://www.nacha.org) for details
 on individual fields. You can probably obtain a copy from your bank.
 
-    # Create ACH file
-    ach = ACH::ACHFile.new
-    trace_number = 0
-    
-    # File Header
-    fh = ach.header
-    fh.immediate_destination = "000000000"
-    fh.immediate_destination_name = "BANK NAME"
-    fh.immediate_origin = "000000000"
-    fh.immediate_origin_name = "BANK NAME"
-    
-    # Batch
-    batch = ACH::Batch.new
-    bh = batch.header
-    bh.company_name = "Company Name"
-    bh.company_identification = "123456789"
-    bh.standard_entry_class_code = 'PPD'
-    bh.company_entry_description = "DESCRIPTION"
-    bh.company_descriptive_date = Date.today
-    bh.effective_entry_date = (Date.today + 1)
-    bh.originating_dfi_identification = "00000000"
-    ach.batches << batch
-    
-    # Detail Entry
-    ed = ACH::EntryDetail.new
-    ed.transaction_code = ACH::CHECKING_CREDIT
-    ed.routing_number = "000000000"
-    ed.account_number = "00000000000"
-    ed.amount = 100 # In cents
-    ed.individual_id_number = "Employee Name"
-    ed.individual_name = "Employee Name"
-    ed.originating_dfi_identification = '00000000'
-    batch.entries << ed
-    # ... Additional detail entries, possibly including *offsetting entry*, if needed.
-    
-    # Insert trace numbers
-    batch.entries.each{ |entry| entry.trace_number = (trace_number += 1) }
-    
-    
-    output = ach.to_s
-    File.open("ach.txt", 'w') do |f|
-      f.write output
-    end
-
-    p ach.report
+```ruby
+# Create ACH file
+ach = ACH::ACHFile.new
+trace_number = 0
+
+# File Header
+fh = ach.header
+fh.immediate_destination = "000000000"
+fh.immediate_destination_name = "BANK NAME"
+fh.immediate_origin = "000000000"
+fh.immediate_origin_name = "BANK NAME"
+
+# Batch
+batch = ACH::Batch.new
+bh = batch.header
+bh.company_name = "Company Name"
+bh.company_identification = "123456789"
+bh.standard_entry_class_code = 'PPD'
+bh.company_entry_description = "DESCRIPTION"
+bh.company_descriptive_date = Date.today
+bh.effective_entry_date = (Date.today + 1)
+bh.originating_dfi_identification = "00000000"
+ach.batches << batch
+
+# Detail Entry
+ed = ACH::EntryDetail.new
+ed.transaction_code = ACH::CHECKING_CREDIT
+ed.routing_number = "000000000"
+ed.account_number = "00000000000"
+ed.amount = 100 # In cents
+ed.individual_id_number = "Employee Name"
+ed.individual_name = "Employee Name"
+ed.originating_dfi_identification = '00000000'
+batch.entries << ed
+# ... Additional detail entries, possibly including *offsetting entry*, if needed.
+
+# Insert trace numbers
+batch.entries.each{ |entry| entry.trace_number = (trace_number += 1) }
+
+
+output = ach.to_s
+File.open("ach.txt", 'w') do |f|
+  f.write output
+end
+
+p ach.report
+```
+
+```ruby
+# Parse an ACH file
+ach = ACH::ACHFile.new(File.read('examples/ach/fixtures/return_noc.txt'))
+ach.batches.first.entries.first.addenda.first.payment_data
+=> "C05992222220280489      1211403932                                          1211"
+```
 
 ##Copyright
 

data/Rakefile

@@ -22,7 +22,7 @@ end
 
 require 'micronaut/rake_task'
 Micronaut::RakeTask.new(:examples) do |examples|
-  examples.pattern = 'examples/**/*_example.rb'
+  examples.pattern = './examples/**/*_example.rb'
   examples.ruby_opts << '-Ilib -Iexamples'
 end
 
@@ -34,7 +34,7 @@ end
 
 task :default => :examples
 
-require 'rake/rdoctask'
+require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|
   version = File.exist?('VERSION') ? File.read('VERSION') : ''
   rdoc.rdoc_dir = 'rdoc'

data/VERSION

@@ -1 +1 @@
-0.3.2
+0.4.0

data/ach.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "ach"
-  s.version = "0.3.2"
+  s.version = "0.4.0"
 
   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-02"
+  s.date = "2012-11-07"
   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 = [
@@ -25,6 +25,8 @@ Gem::Specification.new do |s|
     "examples/ach/ach_file_example.rb",
     "examples/ach/batch_example.rb",
     "examples/ach/field_identifiers_example.rb",
+    "examples/ach/fixtures/return_noc.txt",
+    "examples/ach/parse_example.rb",
     "examples/ach/records/batch_control_example.rb",
     "examples/ach/records/batch_header_example.rb",
     "examples/ach/records/ctx_entry_detail_example.rb",
@@ -47,7 +49,7 @@ Gem::Specification.new do |s|
   ]
   s.homepage = "http://github.com/jm81/ach"
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.11"
+  s.rubygems_version = "1.8.10"
   s.summary = "Helper for building ACH files in Ruby"
 
   if s.respond_to? :specification_version then

data/examples/ach/field_identifiers_example.rb

@@ -10,8 +10,7 @@ describe ACH::FieldIdentifiers do
     it 'should validate against a Regexp' do
       @klass.field(:sample, String, nil, nil, /\A\w{5}\Z/)
       record = @klass.new
-      msg = "abcd does not match Regexp #{/\A\w{5}\Z/}"
-      lambda { record.sample = 'abcd' }.should raise_error(RuntimeError, msg)
+      lambda { record.sample = 'abcd' }.should raise_error(RuntimeError)
       record.sample.should be_nil
       lambda { record.sample = 'abcdef' }.should raise_error(RuntimeError)
       record.sample.should be_nil
@@ -26,8 +25,7 @@ describe ACH::FieldIdentifiers do
       
       @klass.field(:sample, String, nil, nil, block)
       record = @klass.new
-      msg = "5 does not pass validation Proc"
-      lambda { record.sample = 5 }.should raise_error(RuntimeError, msg)
+      lambda { record.sample = 5 }.should raise_error(RuntimeError)
       record.sample.should be_nil
       lambda { record.sample = 501 }.should raise_error(RuntimeError)
       record.sample.should be_nil

data/examples/ach/fixtures/return_noc.txt

@@ -0,0 +1,20 @@
+101 191001234 9922222261210151518A094101Certification Bank-SiliCERTIFICATION BANK-SILIRETURNS 
+5200COMPANY INC     DISC DATA           1412345678CORDESCRIPT  1210151210150001992222220000001
+6211211403993300911569       0000000000A38LTNY2       NAME ONE                1121140390280747
+798C05992222220280489      1211403932                                          121140390280747
+820000000200121140390000000000000000000000001412345678                         992222220000001
+5200COMPANY INC     DISC DATA           1412345678PPDDESCRIPT  1210151210150001992222220000002
+6261211403993300911569       0000002536GKGQT9VK       NAME TWO                1121140390280738
+799R07992222220280393      12114039                                            121140390280738
+820000000200121140390000000025360000000000001412345678                         992222220000002
+5200COMPANY INC     DISC DATA           1412345678PPDDESCRIPT  1210151210150001992222220000003
+6261211403993300911569       0000002417KYU341VP       NAME THREE              1121140390280729
+799R03992222220280389      12114039                                            121140390280729
+820000000200121140390000000024170000000000001412345678                         992222220000003
+9000003000002000000060036342117000000004953000000000000                                       
+9999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999
+9999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999
+9999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999
+9999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999
+9999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999
+9999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999

data/examples/ach/parse_example.rb

@@ -0,0 +1,49 @@
+require 'example_helper'
+require 'date'
+
+describe "Parse" do
+  describe 'Returns and NOC' do
+    before(:each) do
+      @data = File.read('examples/ach/fixtures/return_noc.txt')
+    end
+
+    it "should parse return/notification of change file" do
+      ach = ACH::ACHFile.new(@data)
+      fh = ach.header
+      fh.immediate_destination.should == "191001234"
+      fh.immediate_origin.should == "992222226"
+      fh.transmission_datetime.should == Time.utc(2012, 10, 15, 15, 18)
+      fh.immediate_destination_name.should == "Certification Bank-Sili"
+      fh.immediate_origin_name.should == "CERTIFICATION BANK-SILI"
+
+      ach.batches.size.should == 3
+
+      batch = ach.batches[0]
+      batch.entries.size.should == 1
+      bh = batch.header
+      bh.company_name.should == "COMPANY INC"
+      bh.company_identification.should == "412345678"
+      bh.standard_entry_class_code.should == 'COR'
+      bh.company_entry_description.should == "DESCRIPT"
+      bh.company_descriptive_date.should == Date.parse('121015')
+      bh.effective_entry_date.should == Date.parse('121015')
+      bh.originating_dfi_identification.should == "99222222"
+
+      ed = batch.entries[0]
+      ed.transaction_code.should == "21"
+      ed.routing_number.should == "121140399"
+      ed.account_number.should == "3300911569"
+      ed.amount.should == 0 # In cents
+      ed.individual_id_number.should == "A38LTNY2"
+      ed.individual_name.should == "NAME ONE"
+
+      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
+    end
+
+  end
+end

data/lib/ach/ach_file.rb

@@ -1,3 +1,5 @@
+require 'date'
+
 module ACH 
   class ACHFile
     include FieldIdentifiers
@@ -6,10 +8,14 @@ module ACH
     attr_reader :header
     attr_reader :control
     
-    def initialize
+    def initialize data=nil
       @batches = []
       @header = Records::FileHeader.new
       @control = Records::FileControl.new
+
+      if data
+        parse(data)
+      end
     end
     
     def to_s
@@ -37,6 +43,7 @@ module ACH
         @control.entry_hash += batch.control.entry_hash
       end
       
+
       records.collect { |r| r.to_ach }.join("\r\n") + "\r\n"
     end
     
@@ -58,5 +65,66 @@ module ACH
       
       lines.join("\r\n")
     end
+
+    def parse data
+      trace_number = 0
+      fh =  self.header
+      batch = nil
+      bh = nil
+      ed = nil
+
+      data.strip.split(/\n|\r\n/).each do |line|
+        type = line[0..0]
+        if type == '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])
+          fh.file_id_modifier               = line[33..33]
+          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'
+          self.batches << batch unless batch.nil?
+          batch = ACH::Batch.new
+          bh = batch.header
+          bh.company_name                   = line[4..19].strip
+          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.effective_entry_date           = Date.parse(line[69..74])
+          bh.originating_dfi_identification = line[79..86].strip
+        elsif type == '6'
+          ed = ACH::CtxEntryDetail.new
+          ed.transaction_code               = line[1..2]
+          ed.routing_number                 = line[3..11]
+          ed.account_number                 = line[12..28].strip
+          ed.amount                         = line[29..38].to_i # cents
+          ed.individual_id_number           = line[39..53].strip
+          ed.individual_name                = line[54..75].strip
+          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]
+          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'
+          # skip
+        elsif type == '9'
+          # skip
+        else
+          raise "Didn't recognize type code #{type} for this line:\n#{line}"
+        end
+      end
+
+      batch.entries << ed unless ed.nil?
+      self.batches << batch unless batch.nil?
+      batch.entries.each{ |entry| entry.trace_number = (trace_number += 1) }
+      to_s
+    end
   end
 end

data/lib/ach/batch.rb

@@ -1,11 +1,13 @@
 module ACH
   class Batch
     attr_reader :entries
+    attr_reader :addendas
     attr_reader :header
     attr_reader :control
     
     def initialize
       @entries = []
+      @addendas = []
       @header = Records::BatchHeader.new
       @control = Records::BatchControl.new
     end
@@ -49,7 +51,7 @@ module ACH
       @control.originating_dfi_identification = @header.originating_dfi_identification
       @control.batch_number = @header.batch_number
       
-      [@header] + @entries + [@control]
+      [@header] + @entries + @addendas + [@control]
     end
   end
 end

data/lib/ach/field_identifiers.rb

@@ -12,11 +12,11 @@ module ACH
       define_method "#{name}=" do | val |
         if validate.kind_of?(Regexp)
           unless val =~ validate
-            raise RuntimeError, "#{val} does not match Regexp #{validate}"
+            raise RuntimeError, "#{val} does not match Regexp #{validate} for field #{name}"
           end
         elsif validate.respond_to?(:call) # Proc with value as argument
           unless validate.call(val)
-            raise RuntimeError, "#{val} does not pass validation Proc"
+            raise RuntimeError, "#{val} does not pass validation Proc for field #{name}"
           end
         end
         
@@ -33,7 +33,7 @@ module ACH
           elsif default
             val = default
           else
-            raise RuntimeError, "val is nil"
+            raise RuntimeError, "val of #{name} is nil"
           end
         end
         

data/lib/ach/records/addendum.rb

@@ -4,7 +4,7 @@ module ACH::Records
     @fields = []
 
     const_field :record_type, '7'
-    const_field :type_code, '05'
+    field :type_code, String, lambda {|f| f}, '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)}

data/lib/ach/records/entry_detail.rb

@@ -68,7 +68,7 @@ module ACH::Records
 
       self.addenda.each {|a|
         a.entry_detail_sequence_number = self.trace_number
-        ach_string << "\r\n" + a.to_ach 
+        ach_string << "\r\n" + a.to_ach
       }
       return ach_string
     end  

data/lib/ach/records/file_header.rb

@@ -4,8 +4,8 @@ module ACH::Records
     
     const_field :record_type, '1'
     const_field :priority_code, '01'
-    routing_field :immediate_destination
-    routing_field :immediate_origin
+    field :immediate_destination, String, nil, /\A\s?\d{9}\Z/
+    field :immediate_origin, String, nil, /\A\d{9,10}\Z/
     field :transmission_datetime, Time,
         lambda { |f| f.strftime('%y%m%d%H%M')},
         lambda { Time.now }

data/lib/ach.rb

@@ -36,6 +36,6 @@ end
 
 # Include Records module to simplify accessing Records classes.
 module ACH
-  VERSION = '0.3.2'
+  VERSION = '0.4.0'
   include Records
 end

metadata

@@ -1,36 +1,29 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: ach
-version: !ruby/object:Gem::Version 
-  hash: 23
+version: !ruby/object:Gem::Version
+  version: 0.4.0
   prerelease: 
-  segments: 
-  - 0
-  - 3
-  - 2
-  version: 0.3.2
 platform: ruby
-authors: 
+authors:
 - Jared Morgan
 - Josh Puetz
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-11-02 00:00:00 Z
+date: 2012-11-07 00:00:00.000000000 Z
 dependencies: []
+description: ! 'ach is a Ruby helper for builder ACH files. In particular, it helps
+  with field
 
-description: |
-  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.
 
+'
 email: jmorgan@morgancreative.net
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.md
-files: 
+files:
 - .autotest
 - MIT-LICENSE
 - README.md
@@ -40,6 +33,8 @@ files:
 - examples/ach/ach_file_example.rb
 - examples/ach/batch_example.rb
 - examples/ach/field_identifiers_example.rb
+- examples/ach/fixtures/return_noc.txt
+- examples/ach/parse_example.rb
 - examples/ach/records/batch_control_example.rb
 - examples/ach/records/batch_header_example.rb
 - examples/ach/records/ctx_entry_detail_example.rb
@@ -61,36 +56,26 @@ files:
 - lib/ach/records/record.rb
 homepage: http://github.com/jm81/ach
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Helper for building ACH files in Ruby
 test_files: []
-