ach 0.2.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008-2009 Jared E Morgan
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,63 @@
+#ACH
+
+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 
+environment.**
+
+See [ACH::Builder](http://search.cpan.org/~tkeefer/ACH-Builder-0.03/lib/ACH/Builder.pm)
+for a similar Perl library
+
+##Example
+
+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 = "Company ID"
+    bh.company_entry_description = "DESCRIPTION"
+    bh.company_descriptive_date = Date.today
+    bh.effective_entry_date = (Date.today + 1)
+    bh.originating_dfi_identification = "00000000"
+    
+    # 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("/path/to/ach.txt", 'w') do |f|
+      f.write output
+    end
+
+    p ach.report
+
+##Copyright
+
+Copyright (c) 2008-2009 Jared E Morgan, released under the MIT license

data/Rakefile

@@ -0,0 +1,44 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "ach"
+    gem.summary = %{Helper for building ACH files in Ruby}
+    gem.description = <<EOF
+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.
+EOF
+    gem.email = "jmorgan@morgancreative.net"
+    gem.homepage = "http://github.com/jm81/ach"
+    gem.authors = ["Jared Morgan"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'micronaut/rake_task'
+Micronaut::RakeTask.new(:examples) do |examples|
+  examples.pattern = 'examples/**/*_example.rb'
+  examples.ruby_opts << '-Ilib -Iexamples'
+end
+
+Micronaut::RakeTask.new(:rcov) do |examples|
+  examples.pattern = 'examples/**/*_example.rb'
+  examples.rcov_opts = '-Ilib -Iexamples'
+  examples.rcov = true
+end
+
+task :default => :examples
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ''
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ACH #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/ach.gemspec

@@ -0,0 +1,64 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ach}
+  s.version = "0.2.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.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.
+}
+  s.email = %q{jmorgan@morgancreative.net}
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    "MIT-LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "ach.gemspec",
+     "examples/ach/ach_file_example.rb",
+     "examples/ach/records/batch_control_example.rb",
+     "examples/ach/records/nines_example.rb",
+     "examples/example_helper.rb",
+     "lib/ach.rb",
+     "lib/ach/ach_file.rb",
+     "lib/ach/batch.rb",
+     "lib/ach/field_identifiers.rb",
+     "lib/ach/records/addendum.rb",
+     "lib/ach/records/batch_control.rb",
+     "lib/ach/records/batch_header.rb",
+     "lib/ach/records/entry_detail.rb",
+     "lib/ach/records/file_control.rb",
+     "lib/ach/records/file_header.rb",
+     "lib/ach/records/nines.rb",
+     "lib/ach/records/record.rb"
+  ]
+  s.homepage = %q{http://github.com/jm81/ach}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  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/records/nines_example.rb",
+     "examples/example_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/examples/ach/ach_file_example.rb

@@ -0,0 +1,10 @@
+require 'example_helper'
+
+describe ACH::ACHFile do
+  before(:each) do
+  end
+
+  describe '#to_s' do
+    it 'should pad with 9s if needed'
+  end
+end

data/examples/ach/records/batch_control_example.rb

@@ -0,0 +1,34 @@
+require 'example_helper'
+
+describe ACH::Records::BatchControl do
+  before(:each) do
+    @record = ACH::Records::BatchControl.new
+    @record.entry_count = 1
+    @record.entry_hash = 2
+    @record.debit_total = 3
+    @record.credit_total = 4
+    @record.company_identification = '123456789'
+    @record.message_authentication_code = '22345678'
+    @record.originating_dfi_identification = '32345678'
+    @record.batch_number = 5
+  end
+  
+  describe '#to_ach' do
+    it 'should generate record string' do
+      exp = [
+        '8',
+        '200',
+        '000001',
+        '0000000002',
+        '000000000003',
+        '000000000004',
+        '1123456789',
+        '22345678           ',
+        '      ',
+        '32345678',
+        '0000005'
+      ]
+      @record.to_ach.should == exp.join('')
+    end
+  end
+end

data/examples/ach/records/nines_example.rb

@@ -0,0 +1,13 @@
+require 'example_helper'
+
+describe ACH::Records::Nines do
+  before(:each) do
+    @nines = ACH::Records::Nines.new
+  end
+
+  describe '#to_ach' do
+    it 'should generate 94 copies of the digit "9"' do
+      @nines.to_ach.should == ('9' * 94)
+    end
+  end
+end

data/examples/example_helper.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'micronaut'
+require 'ach'
+
+def not_in_editor?
+  !(ENV.has_key?('TM_MODE') || ENV.has_key?('EMACS') || ENV.has_key?('VIM'))
+end
+
+Micronaut.configure do |c|
+  c.color_enabled = not_in_editor?
+  c.filter_run :focused => true
+end

data/lib/ach.rb

@@ -0,0 +1,30 @@
+module ACH
+  # transaction codes
+  CHECKING_CREDIT = '22'
+  CHECKING_DEBIT = '27'
+  CHECKING_CREDIT_PRENOTE = '23'
+  CHECKING_DEBIT_PRENOT = '28'
+  
+  SAVING_CREDIT = '32'
+  SAVING_DEBIT = '37'
+  SAVING_CREDIT_PRENOTE = '33'
+  SAVING_DEBIT_PRENOT = '38'
+end
+
+require 'time'
+require 'ach/field_identifiers'
+require 'ach/ach_file'
+require 'ach/batch'
+
+# Require records files
+require 'ach/records/record'
+
+Dir.new(File.dirname(__FILE__) + '/ach/records').each do |file|
+  require('ach/records/' + File.basename(file)) if File.extname(file) == ".rb"
+end
+
+# Include Records module to simplify accessing Records classes.
+module ACH
+  VERSION = '0.2.0'
+  include Records
+end

data/lib/ach/ach_file.rb

@@ -0,0 +1,56 @@
+module ACH 
+  class ACHFile
+    include FieldIdentifiers
+    
+    attr_reader :batches
+    attr_reader :header
+    attr_reader :control
+    
+    def initialize
+      @batches = []
+      @header = Records::FileHeader.new
+      @control = Records::FileControl.new
+    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("\n") + "\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
+      lines.join("\n")
+    end
+  end
+end

data/lib/ach/batch.rb

@@ -0,0 +1,36 @@
+module ACH
+  class Batch
+    attr_reader :entries
+    attr_reader :header
+    attr_reader :control
+    
+    def initialize
+      @entries = []
+      @header = Records::BatchHeader.new
+      @control = Records::BatchControl.new
+    end
+    
+    def to_ach
+      @control.entry_count = @entries.length
+      @control.debit_total = 0
+      @control.credit_total = 0
+      @control.entry_hash = 0
+      
+      @entries.each do |e|
+        if e.debit?
+          @control.debit_total += e.amount
+        else
+          @control.credit_total += e.amount
+        end
+        @control.entry_hash +=
+            (e.routing_number.to_i / 10) # Last digit is not part of Receiving DFI
+      end
+      
+      @control.company_identification = @header.company_identification
+      @control.originating_dfi_identification = @header.originating_dfi_identification
+      @control.batch_number = @header.batch_number
+      
+      [@header] + @entries + [@control]
+    end
+  end
+end

data/lib/ach/field_identifiers.rb

@@ -0,0 +1,74 @@
+module ACH
+  module FieldIdentifiers
+    def field(name, klass, stringify = nil, default = nil, validate = nil, msg ='')
+      fields << name
+      
+      # getter
+      define_method name do
+        instance_variable_get( "@#{name}" )
+      end
+      
+      # setter (includes validations)
+      define_method "#{name}=" do | val |
+        if validate.kind_of?(Regexp)
+          unless val =~ validate
+            raise RuntimeError, "#{val} does not match Regexp #{validate}"
+          end
+        end
+        instance_variable_set( "@#{name}", val )
+      end
+      
+      # to_ach
+      define_method  "#{name}_to_ach" do
+        val = instance_variable_get( "@#{name}" )
+        
+        if val.nil?
+          if default.kind_of?(Proc)
+            val = default.call
+          elsif default
+            val = default
+          else
+            raise RuntimeError, "val is nil"
+          end
+        end
+        
+        if stringify.nil?
+          return val
+        else
+          stringify.call(val)
+        end
+      end
+    end
+    
+    def const_field(name, val)
+      fields << name
+      
+      # to_ach
+      define_method  "#{name}_to_ach" do
+        val
+      end
+    end
+    
+    def left_justify(val, length)
+      val_length = val.length
+      if val_length > length
+        val = val[0..(length - 1)]
+      else
+        val = val + (' ' * (length - val_length))
+      end
+    end
+    
+    # A routing number, usually, a string consisting of exactly nine digits.
+    # Represented by 'bTTTTAAAAC'.
+    def routing_field(sym)
+      field sym, String, lambda {|f| ' ' + f}, nil, /\A\d{9}\Z/,
+        'A string consisting of exactly nine digits'
+    end
+
+    # A routing number without leading space
+    def spaceless_routing_field(sym)
+      field sym, String, lambda {|f| f}, nil, /\A\d{9}\Z/,
+        'A string consisting of exactly nine digits'
+    end
+  end
+end

data/lib/ach/records/batch_control.rb

@@ -0,0 +1,29 @@
+module ACH::Records
+  class BatchControl < Record
+    @fields = []
+    
+    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 :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, String,
+        lambda {|f| '1' + 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

@@ -0,0 +1,30 @@
+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.
+    const_field :service_class_code, '200'
+    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'
+    field :company_entry_description, String,
+        lambda { |f| left_justify(f, 10)}
+    field :company_descriptive_date, Time,
+        lambda { |f| f.strftime('%y%m%d')},
+        lambda { Time.now }
+    field :effective_entry_date, Time,
+        lambda { |f| f.strftime('%y%m%d')}
+    const_field :settlement_date, '   '
+    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

data/lib/ach/records/entry_detail.rb

@@ -0,0 +1,33 @@
+module ACH::Records
+  class EntryDetail < Record
+    @fields = []
+    
+    attr_accessor :sorter
+    
+    const_field :record_type, '6'
+    field :transaction_code, String,
+        lambda {|f| f}, nil, /\A\d{2}\Z/
+    spaceless_routing_field :routing_number # Receiving DFI Identification 
+                                            # and Check Digit
+    field :account_number, String, lambda { |f| left_justify(f, 17)}
+    field :amount, Integer, lambda { |f| sprintf('%010d', f)}
+    field :individual_id_number, String, lambda { |f| left_justify(f, 15)}
+    field :individual_name, String, lambda { |f| left_justify(f, 22)}
+    field :discretionary_data, String, lambda { |f| left_justify(f, 2)}, '  '
+    field :addenda_record_indicator, Integer,
+        lambda { |f| sprintf('%01d', f)}, 0
+    field :originating_dfi_identification, String,
+        lambda {|f| f}, nil, /\A\d{8}\Z/
+    field :trace_number, Integer, lambda { |f| sprintf('%07d', f)}
+    
+    def credit?
+      @transaction_code[1..1] == '2' || @transaction_code[1..1] == '3'
+    end
+    
+    def debit?
+      !credit?
+    end
+  end
+end
+
+# Uses '\r\n' (I think)

data/lib/ach/records/file_control.rb

@@ -0,0 +1,17 @@
+module ACH::Records
+  class FileControl < Record
+    @fields = []
+    
+    const_field :record_type, '9'
+    # Many of the fields are calculated in ACHFile.to_ach
+    field :batch_count, Integer, lambda { |f| sprintf('%06d', f)}
+    field :block_count, Integer, lambda { |f| sprintf('%06d', f)}
+    field :entry_count, Integer, lambda { |f| sprintf('%08d', 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)}
+    const_field :reserved, (' ' * 39)
+  end
+end
+

data/lib/ach/records/file_header.rb

@@ -0,0 +1,21 @@
+module ACH::Records
+  class FileHeader < Record
+    @fields = []
+    
+    const_field :record_type, '1'
+    const_field :priority_code, '01'
+    routing_field :immediate_destination
+    routing_field :immediate_origin
+    field :transmission_datetime, Time,
+        lambda { |f| f.strftime('%y%m%d%H%M')},
+        lambda { Time.now }
+    field :file_id_modifier, String, nil, 'A', /\A\w\Z/
+    const_field :record_size, '094'
+    const_field :blocking_factor, '10'
+    const_field :format_code, '1'
+    field :immediate_destination_name, String, lambda { |f| left_justify(f, 23)}
+    field :immediate_origin_name, String, lambda { |f| left_justify(f, 23)}
+    field :reference_code, String, lambda { |f| left_justify(f, 8)}, ''
+  end
+end
+

data/lib/ach/records/nines.rb

@@ -0,0 +1,15 @@
+module ACH::Records
+  # The number of records must be a multiple of ten (that is, complete 940
+  # character blocks). If needed, rows that consist of the digit "9" may be
+  # used to pad the the file.
+  #
+  # "Nines" records thus consist of a single constant field containing the digit
+  # "9" 94 times.
+  #
+  # See 2008 ACH Rules, Appx 1, Sec 1.5; Appx 2, Sec 2.3
+  class Nines < Record
+    @fields = []
+    
+    const_field :record_type, ('9' * 94)
+  end
+end

data/lib/ach/records/record.rb

@@ -0,0 +1,19 @@
+module ACH
+  module Records
+    class Record
+      @fields = []
+      
+      class << self
+        def fields
+          @fields
+        end
+      end
+      
+      extend(FieldIdentifiers)
+      
+      def to_ach
+        self.class.fields.collect { |f| send("#{f}_to_ach") }.join('').upcase
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: ach
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Jared Morgan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-11 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+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: 
+- README.md
+files: 
+- MIT-LICENSE
+- README.md
+- Rakefile
+- VERSION
+- ach.gemspec
+- examples/ach/ach_file_example.rb
+- examples/ach/records/batch_control_example.rb
+- examples/ach/records/nines_example.rb
+- examples/example_helper.rb
+- lib/ach.rb
+- lib/ach/ach_file.rb
+- lib/ach/batch.rb
+- lib/ach/field_identifiers.rb
+- lib/ach/records/addendum.rb
+- lib/ach/records/batch_control.rb
+- lib/ach/records/batch_header.rb
+- lib/ach/records/entry_detail.rb
+- lib/ach/records/file_control.rb
+- lib/ach/records/file_header.rb
+- lib/ach/records/nines.rb
+- lib/ach/records/record.rb
+has_rdoc: true
+homepage: http://github.com/jm81/ach
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Helper for building ACH files in Ruby
+test_files: 
+- examples/ach/ach_file_example.rb
+- examples/ach/records/batch_control_example.rb
+- examples/ach/records/nines_example.rb
+- examples/example_helper.rb