ach 0.2.0 → 0.3.0

data/.autotest

@@ -0,0 +1,46 @@
+require 'autotest'
+
+Autotest.add_hook :initialize do |at|
+  at.clear_mappings
+  at.failed_results_re = /^\d+\)\n(?:\e\[\d*m)?(?:.*?Error in )?'([^\n]*)'(?: FAILED)?(?:\e\[\d*m)?\n(.*?)\n\n/m
+  at.completed_re = /\n(?:\e\[\d*m)?\d* examples?/m
+
+  at.add_mapping(%r%^examples/.*_example.rb$%) { |filename, _| 
+    filename 
+  }
+  
+  at.add_mapping(%r%^lib/(.*)\.rb$%) { |filename, m| 
+    ["examples/lib/#{m[1]}_example.rb"]
+  }
+  
+  at.add_mapping(%r%^examples/(example_helper|shared/.*)\.rb$%) { 
+    at.files_matching %r%^examples/.*_example\.rb$%
+  }
+end
+
+class Autotest
+  remove_method :consolidate_failures if instance_methods(false).include?("consolidate_failures")
+  remove_method :make_test_cmd if instance_methods(false).include?("make_test_cmd")
+
+  def consolidate_failures(failed)
+    filters = new_hash_of_arrays
+    failed.each do |spec, trace|
+      if trace =~ /\n(\.\/)?(.*example\.rb):[\d]+:\Z?/
+        filters[$2] << spec
+      end
+    end
+    return filters
+  end
+
+  def make_test_cmd(files_to_test)
+  puts 'command'
+    return '' if files_to_test.empty?
+    
+    examples = files_to_test.keys.flatten
+    
+    examples.map! {|f| %Q(require "#{f}")}
+
+    return "#{ruby} -Ilib -Iexamples -e '#{examples.join("; ")}'"
+  end
+  
+end

data/.gitignore

@@ -0,0 +1,10 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg
+.project
+.loadpath
+*qt_temp*
+*~
+*.gem

data/README.md

@@ -30,18 +30,20 @@ on individual fields. You can probably obtain a copy from your bank.
     batch = ACH::Batch.new
     bh = batch.header
     bh.company_name = "Company Name"
-    bh.company_identification = "Company ID"
+    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.amount = 100 # In cents
     ed.individual_id_number = "Employee Name"
     ed.individual_name = "Employee Name"
     ed.originating_dfi_identification = '00000000'
@@ -51,8 +53,9 @@ on individual fields. You can probably obtain a copy from your bank.
     # Insert trace numbers
     batch.entries.each{ |entry| entry.trace_number = (trace_number += 1) }
     
+    
     output = ach.to_s
-    File.open("/path/to/ach.txt", 'w') do |f|
+    File.open("ach.txt", 'w') do |f|
       f.write output
     end
 

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/ach.gemspec

@@ -1,15 +1,15 @@
 # Generated by jeweler
-# DO NOT EDIT THIS FILE
-# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{ach}
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jared Morgan"]
-  s.date = %q{2009-10-11}
+  s.date = %q{2009-11-29}
   s.description = %q{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.
 }
@@ -18,14 +18,20 @@ order and alignment, and adds padding lines to end of file.
     "README.md"
   ]
   s.files = [
-    "MIT-LICENSE",
+    ".autotest",
+     ".gitignore",
+     "MIT-LICENSE",
      "README.md",
      "Rakefile",
      "VERSION",
      "ach.gemspec",
      "examples/ach/ach_file_example.rb",
+     "examples/ach/batch_example.rb",
+     "examples/ach/field_identifiers_example.rb",
      "examples/ach/records/batch_control_example.rb",
+     "examples/ach/records/batch_header_example.rb",
      "examples/ach/records/nines_example.rb",
+     "examples/ach/records/shared/batch_summaries.rb",
      "examples/example_helper.rb",
      "lib/ach.rb",
      "lib/ach/ach_file.rb",
@@ -46,9 +52,13 @@ order and alignment, and adds padding lines to end of file.
   s.rubygems_version = %q{1.3.5}
   s.summary = %q{Helper for building ACH files in Ruby}
   s.test_files = [
-    "examples/ach/ach_file_example.rb",
-     "examples/ach/records/batch_control_example.rb",
+    "examples/ach/field_identifiers_example.rb",
+     "examples/ach/ach_file_example.rb",
      "examples/ach/records/nines_example.rb",
+     "examples/ach/records/shared/batch_summaries.rb",
+     "examples/ach/records/batch_control_example.rb",
+     "examples/ach/records/batch_header_example.rb",
+     "examples/ach/batch_example.rb",
      "examples/example_helper.rb"
   ]
 
@@ -62,3 +72,4 @@ order and alignment, and adds padding lines to end of file.
   else
   end
 end
+

data/examples/ach/batch_example.rb

@@ -0,0 +1,98 @@
+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"
+    @credit.account_number = "00000000000"
+    @credit.amount = 100 # In cents
+    @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
+    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"
+    return batch
+  end
+
+  describe '#to_s' do
+    it 'should determine BatchHeader#service_class_code if not set' do
+      debits = new_batch
+      debits.entries << @debit << @debit
+      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
+      debits.control.service_class_code.should be_nil
+      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
+      batch.header.service_class_code = 220
+      batch.control.service_class_code = 200
+      batch.to_ach
+      batch.control.service_class_code.should == 200
+    end
+  end
+end

data/examples/ach/field_identifiers_example.rb

@@ -0,0 +1,47 @@
+require 'example_helper'
+
+describe ACH::FieldIdentifiers do
+  describe 'setter' do
+    before(:each) do
+      @klass = Class.new(ACH::Records::Record)
+      @klass.instance_variable_set(:@fields, [])
+    end
+    
+    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)
+      record.sample.should be_nil
+      lambda { record.sample = 'abcdef' }.should raise_error(RuntimeError)
+      record.sample.should be_nil
+      lambda { record.sample = 'abcde' }.should_not raise_error
+      record.sample.should == 'abcde'
+    end
+      
+    it 'should validate against a Proc' do
+      block = Proc.new do |val|
+        [1, 2, 500].include?(val)
+      end
+      
+      @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)
+      record.sample.should be_nil
+      lambda { record.sample = 501 }.should raise_error(RuntimeError)
+      record.sample.should be_nil
+      lambda { record.sample = 1 }.should_not raise_error
+      record.sample.should == 1
+      lambda { record.sample = 500 }.should_not raise_error
+      record.sample.should == 500
+    end
+    
+    it 'should set instance variable' do
+      @klass.field(:sample, String)
+      record = @klass.new
+      record.sample = 'abcde'
+      record.instance_variable_get(:@sample).should == 'abcde'
+    end
+  end
+end

data/examples/ach/records/batch_control_example.rb

@@ -1,4 +1,5 @@
 require 'example_helper'
+require 'ach/records/shared/batch_summaries'
 
 describe ACH::Records::BatchControl do
   before(:each) do
@@ -13,6 +14,8 @@ describe ACH::Records::BatchControl do
     @record.batch_number = 5
   end
   
+  self.instance_eval(&SharedExamples.batch_summaries)
+  
   describe '#to_ach' do
     it 'should generate record string' do
       exp = [

data/examples/ach/records/batch_header_example.rb

@@ -0,0 +1,29 @@
+require 'example_helper'
+require 'ach/records/shared/batch_summaries'
+
+describe ACH::Records::BatchHeader do
+  before(:each) do
+    @record = ACH::Records::BatchHeader.new
+  end
+  
+  self.instance_eval(&SharedExamples.batch_summaries)
+  
+  describe '#standard_entry_class_code' do
+    it 'should default to PPD' do
+      @record.standard_entry_class_code_to_ach.should == 'PPD'
+    end
+    
+    it 'should be capitalized' do
+      @record.standard_entry_class_code = 'ccd'
+      @record.standard_entry_class_code_to_ach.should == 'CCD'
+    end
+    
+    it 'should be exactly three characters' do
+      lambda { @record.standard_entry_class_code = 'CCDA' }.should raise_error(RuntimeError)
+      lambda { @record.standard_entry_class_code = 'CC' }.should raise_error(RuntimeError)
+      lambda { @record.standard_entry_class_code = 'CCD' }.should_not raise_error(RuntimeError)
+    end
+    
+    it 'should be limited to real codes'
+  end
+end

data/examples/ach/records/shared/batch_summaries.rb

@@ -0,0 +1,43 @@
+# Include with:
+#
+#     self.instance_eval(&shared_examples_for_batch_summaries)
+
+module SharedExamples
+  def self.batch_summaries
+    Proc.new do
+      describe '#service_class_code' do
+        it 'should accept an Integer' do
+          @record.service_class_code = 200
+          @record.service_class_code.should == 200
+          @record.service_class_code_to_ach.should == '200'
+        end
+        
+        it 'should accept a String' do
+          @record.service_class_code = '220'
+          @record.service_class_code.should == '220'
+          @record.service_class_code_to_ach.should == '220'
+        end
+        
+        it 'must be a 200, 220, 225 or 280' do
+          lambda { @record.service_class_code = '201' }.should raise_error(RuntimeError)
+          lambda { @record.service_class_code = 201 }.should raise_error(RuntimeError)
+          lambda { @record.service_class_code = '2020' }.should raise_error(RuntimeError)
+          lambda { @record.service_class_code = '20' }.should raise_error(RuntimeError)
+        end
+        
+        describe '#service_class_code_to_ach' do
+          it 'should use a given value' do
+            @record.service_class_code = '220'
+            @record.service_class_code_to_ach.should == '220'
+            @record.service_class_code = '225'
+            @record.service_class_code_to_ach.should == '225'
+          end
+          
+          it 'should default to 200 when entries unavailable' do
+            @record.service_class_code_to_ach.should == '200'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ach.rb

@@ -9,6 +9,14 @@ module ACH
   SAVING_DEBIT = '37'
   SAVING_CREDIT_PRENOTE = '33'
   SAVING_DEBIT_PRENOT = '38'
+  
+  # Valid service class codes
+  SERVICE_CLASS_CODES = [
+    200, # ACH Entries Mixed Debits and Credits
+    220, # ACH Credits Only
+    225, # ACH Debits Only
+    280  # ACH Automated Accounting Advices
+  ]
 end
 
 require 'time'
@@ -25,6 +33,6 @@ end
 
 # Include Records module to simplify accessing Records classes.
 module ACH
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
   include Records
 end

data/lib/ach/ach_file.rb

@@ -37,7 +37,7 @@ module ACH
         @control.entry_hash += batch.control.entry_hash
       end
       
-      records.collect { |r| r.to_ach }.join("\n") + "\n"
+      records.collect { |r| r.to_ach }.join("\r\n") + "\r\n"
     end
     
     def report
@@ -50,7 +50,7 @@ module ACH
               sprintf("% 7d.%02d", entry.amount / 100, entry.amount % 100)
         end
       end
-      lines.join("\n")
+      lines.join("\r\n")
     end
   end
 end

data/lib/ach/batch.rb

@@ -15,17 +15,36 @@ module ACH
       @control.debit_total = 0
       @control.credit_total = 0
       @control.entry_hash = 0
+      has_debits = false
+      has_credits = false
       
       @entries.each do |e|
         if e.debit?
           @control.debit_total += e.amount
+          has_debits = true
         else
           @control.credit_total += e.amount
+          has_credits = true
         end
         @control.entry_hash +=
             (e.routing_number.to_i / 10) # Last digit is not part of Receiving DFI
       end
       
+      # Set service class codes if needed
+      if @header.service_class_code.nil?
+        if has_debits && has_credits
+          @header.service_class_code = 200
+        elsif has_debits
+          @header.service_class_code = 225
+        else
+          @header.service_class_code = 220
+        end
+      end
+      
+      if @control.service_class_code.nil?
+        @control.service_class_code = @header.service_class_code 
+      end
+      
       @control.company_identification = @header.company_identification
       @control.originating_dfi_identification = @header.originating_dfi_identification
       @control.batch_number = @header.batch_number

data/lib/ach/field_identifiers.rb

@@ -14,7 +14,12 @@ module ACH
           unless val =~ validate
             raise RuntimeError, "#{val} does not match Regexp #{validate}"
           end
+        elsif validate.respond_to?(:call) # Proc with value as argument
+          unless validate.call(val)
+            raise RuntimeError, "#{val} does not pass validation Proc"
+          end
         end
+        
         instance_variable_set( "@#{name}", val )
       end
       

data/lib/ach/records/batch_control.rb

@@ -4,9 +4,10 @@ module ACH::Records
     
     const_field :record_type, '8'
     
-    # TODO: This needs to be changed to reflect whether credits, debits or both.
-    const_field :service_class_code, '200'
     # Many of the fields are calculated in Batch.to_ach
+    field :service_class_code, String,
+        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)}

data/lib/ach/records/batch_header.rb

@@ -5,14 +5,20 @@ module ACH::Records
     const_field :record_type, '5'
     
     # TODO: This needs to be changed to reflect whether credits, debits or both.
-    const_field :service_class_code, '200'
+    field :service_class_code, String,
+        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, String,
         lambda {|f| '1' + f}, nil, /\A\d{9}\Z/,
         'Company Tax ID'
-    const_field :standard_entry_class_code, 'PPD'
+    # 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, 
+        lambda { |f| f.upcase }, 'PPD', /\A\w{3}\Z/
     field :company_entry_description, String,
         lambda { |f| left_justify(f, 10)}
     field :company_descriptive_date, Time,

data/lib/ach/records/entry_detail.rb

@@ -27,7 +27,10 @@ module ACH::Records
     def debit?
       !credit?
     end
+    
+    def amount_value
+      return self.amount
+    end
+    
   end
 end
-
-# Uses '\r\n' (I think)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ach
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Jared Morgan
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-11 00:00:00 -05:00
+date: 2009-11-29 00:00:00 -06:00
 default_executable: 
 dependencies: []
 
@@ -25,14 +25,20 @@ extensions: []
 extra_rdoc_files: 
 - README.md
 files: 
+- .autotest
+- .gitignore
 - MIT-LICENSE
 - README.md
 - Rakefile
 - VERSION
 - ach.gemspec
 - examples/ach/ach_file_example.rb
+- examples/ach/batch_example.rb
+- examples/ach/field_identifiers_example.rb
 - examples/ach/records/batch_control_example.rb
+- examples/ach/records/batch_header_example.rb
 - examples/ach/records/nines_example.rb
+- examples/ach/records/shared/batch_summaries.rb
 - examples/example_helper.rb
 - lib/ach.rb
 - lib/ach/ach_file.rb
@@ -75,7 +81,11 @@ signing_key:
 specification_version: 3
 summary: Helper for building ACH files in Ruby
 test_files: 
+- examples/ach/field_identifiers_example.rb
 - examples/ach/ach_file_example.rb
-- examples/ach/records/batch_control_example.rb
 - examples/ach/records/nines_example.rb
+- examples/ach/records/shared/batch_summaries.rb
+- examples/ach/records/batch_control_example.rb
+- examples/ach/records/batch_header_example.rb
+- examples/ach/batch_example.rb
 - examples/example_helper.rb