ach_builder 0.0.2 → 0.2.1

data/lib/ach/record/dynamic.rb

@@ -0,0 +1,58 @@
+module ACH
+  module Record
+    # Descendants of +ACH::Record::Dynamic+ class are the only
+    # records allowed to have previously undefined fields. However,
+    # each new field definition requires a rule string to be passed.
+    # +UndefinedFormatError+ will be raised otherwise. If the field
+    # has already been defined, and a new rule string is passed,
+    # a +DuplicateFormatError+ is raised.
+    #
+    # == Example
+    #
+    #   class CustomHeader < ACH::Record::Dynamic
+    #     request_type '<-9-' => '$$ADD ID='
+    #     remote_id    '<-8-'
+    #     file_type    '<-6-', 'NWFACH'
+    #   end
+    #
+    # This example declares a +CustomHeader+ record type with following
+    # fields:
+    # * +request_type+, defined by rule '<-9-' with a default
+    # value of '$$ADD ID='
+    # * +remote_id+ with no default value
+    # * +file_type+ with default value of 'NWFACH'
+    #
+    # Note: passing two arguments to method call is equivalent to
+    # passing a hash with a single key-value pair.
+    class Dynamic < Base
+      class DuplicateFormatError < ArgumentError
+        def initialize(field_name)
+          super "Rule #{field_name} has already been defined"
+        end
+      end
+      
+      class UndefinedFormatError < ArgumentError
+        def initialize(field_name)
+          super "Unknown field #{field_name} should be supplied by format"
+        end
+      end
+      
+      def self.method_missing(field, *args)
+        format, default = args.first.is_a?(Hash) ? args.first.first : args
+        unless format =~ Formatter::Rule::RULE_PARSER_REGEX
+          default, format = format, nil
+        end
+        
+        unless Formatter.defined? field
+          raise UndefinedFormatError.new(field) if format.nil?
+          Formatter.define field, format
+        else
+          raise DuplicateFormatError.new(field) if format
+        end
+        define_field_methods(field)
+        (@fields ||= []) << field
+        (@defaults ||= {})[field] = default if default
+      end
+    end
+  end
+end

data/lib/ach/record/entry.rb

@@ -0,0 +1,49 @@
+module ACH
+  module Record
+    # A subclass of ACH::Record::Base, an Entry appears in an ACH::Batch
+    # component. It is the main record for representing a particular
+    # transaction.
+    #
+    # == Fields
+    #
+    # * record_type
+    # * transaction_code
+    # * routing_number
+    # * bank_account
+    # * amount
+    # * customer_acct
+    # * customer_name
+    # * transaction_type
+    # * addenda
+    # * bank_15
+    class Entry < Base
+      CREDIT_TRANSACTION_CODE_ENDING_DIGITS = ('0'..'4').to_a.freeze
+      
+      fields :record_type,
+        :transaction_code,
+        :routing_number,
+        :bank_account,
+        :amount,
+        :customer_acct,
+        :customer_name,
+        :transaction_type,
+        :addenda,
+        :bank_15
+      
+      defaults :record_type => BATCH_ENTRY_RECORD_TYPE,
+        :transaction_code   => 27,
+        :transaction_type   => 'S',
+        :customer_acct      => '',
+        :addenda            => 0,
+        :bank_15            => ''
+      
+      def debit?
+        !credit?
+      end
+      
+      def credit?
+        CREDIT_TRANSACTION_CODE_ENDING_DIGITS.include? transaction_code.to_s[1..1]
+      end
+    end
+  end
+end

data/lib/ach/record/tail.rb

@@ -0,0 +1,10 @@
+module ACH
+  module Record
+    # Since a number of records in ACH file must be multiple of 10, tail records
+    # are used to populate empty records at the end of the file with "9" characters.
+    class Tail < Base
+      fields :nines
+      defaults :nines => '9' * RECORD_SIZE
+    end
+  end
+end

data/lib/ach/validations.rb

@@ -1,4 +1,6 @@
 module ACH
+  # This module hosts the most basic validations for both +components+ and
+  # +records+. The only validation being performed is presence validation.
   module Validations
     def valid?
       reset_errors!
@@ -7,11 +9,11 @@ module ACH
     end
     
     def valid_component?
-      counts = {}
+      counts = Hash.new(0)
       to_ach.each do |record|
-        counts[record.class] ||= 0
         unless record.valid?
-          errors["#{record.class.name}##{counts[record.class] += 1}"] = record.errors
+          klass = record.class
+          errors["#{klass}##{counts[klass] += 1}"] = record.errors
         end
       end
     end

data/lib/ach/version.rb

@@ -1,3 +1,3 @@
 module ACH
-  VERSION = "0.0.2"
+  VERSION = "0.2.1"
 end

data/lib/ach_builder.rb

@@ -1,41 +1,28 @@
+require 'active_support/concern'
+require 'active_support/dependencies/autoload'
 require 'active_support/inflector'
 require 'active_support/ordered_hash'
+require 'active_support/core_ext/module/delegation'
+require 'active_support/core_ext/module/attribute_accessors'
+require 'active_support/core_ext/class/attribute'
 
 require "ach/version"
 
-require 'ach/constants'
-require 'ach/formatter'
-require 'ach/validations'
-require 'ach/component'
-require 'ach/record'
-require 'ach/entry'
-require 'ach/tail'
-require 'ach/batch'
-require 'ach/batch/header'
-require 'ach/batch/control'
-require 'ach/file'
-require 'ach/file/header'
-require 'ach/file/control'
-
+# Support for building the files necessary for the bulk exchange of debits and
+# credits with financial institutions via the Automated Clearing House system,
+# governed by NACHA ( http://www.nacha.org/ ).
 module ACH
-  def self.sample_file
-    File.new(:company_id => '11-11111', :company_name => 'MY COMPANY') do
-      immediate_dest '123123123'
-      immediate_dest_name 'COMMERCE BANK'
-      immediate_origin '123123123'
-      immediate_origin_name 'MYCOMPANY'
-      
-      ['WEB', 'TEL'].each do |code|
-        batch(:entry_class_code => code, :company_entry_descr => 'TV-TELCOM') do
-          effective_date Time.now.strftime('%y%m%d')
-          origin_dfi_id "00000000"
-          entry :customer_name => 'JOHN SMITH',
-            :customer_acct     => '61242882282',
-            :amount            => '2501',
-            :routing_number    => '010010101',
-            :bank_account      => '103030030'
-        end
-      end
-    end
+  extend ActiveSupport::Autoload
+
+  autoload :Constants
+  autoload :Formatter
+  autoload :Validations
+  autoload :Component
+  autoload :Record
+  autoload :Batch
+  autoload :File
+
+  def self.to_const(name)
+    [self, self::Record].detect{ |mod| mod.const_defined?(name) }.const_get(name)
   end
 end

data/spec/batch_spec.rb

@@ -3,22 +3,36 @@ require 'spec_helper'
 describe ACH::Batch do
   before(:each) do
     @batch = ACH::Batch.new
-    @file = ACH.sample_file
+    @file = ACH::FileFactory.sample_file
   end
   
-  it "should create entry with attributes" do
+  it "should create entry with attributes in hash form" do
     entry = @batch.entry :amount => 100
-    entry.should be_instance_of(ACH::Entry)
+    entry.should be_instance_of(ACH::Record::Entry)
     entry.amount.should == 100
   end
   
-  it "should create entry with attributes" do
+  it "should create entry with attributes in block form" do
     entry = @batch.entry do
       amount 100
     end
     entry.amount.should == 100
   end
   
+  it "should raise error when adding addenda records without any entry" do
+    batch = ACH::Batch.new
+    expect{ batch.addenda(:payment_related_info =>'foo bar') }.to raise_error(ACH::Component::HasManyAssociation::NoLinkError)
+  end
+  
+  it "should append addenda records after entry records" do
+    batch = ACH::Batch.new
+    3.times do |i|
+      batch.entry(:amount => 100)
+      i.times{ batch.addenda(:payment_related_info => 'foo bar') }
+    end
+    batch.to_ach.map(&:class)[1...-1].should == [ACH::Record::Entry, ACH::Record::Entry, ACH::Record::Addenda, ACH::Record::Entry, ACH::Record::Addenda, ACH::Record::Addenda]
+  end
+  
   it "should return false for has_credit? and has_debit? for empty entries" do
     @batch.has_credit?.should be_false
     @batch.has_debit?.should be_false
@@ -50,12 +64,10 @@ describe ACH::Batch do
     @batch.header.service_class_code.should == 200
   end
   
-  it "should have header record with length of 94" do
-    @file.batch(0).header.to_s!.length.should == ACH::Constants::RECORD_SIZE
-  end
-  
-  it "should have control record with length of 94" do
-    @file.batch(0).send(:before_header) # to fill service_class_code value
-    @file.batch(0).control.to_s!.length.should == ACH::Constants::RECORD_SIZE
+  it "should have header and control record with length of 94" do
+    [:header, :control].each do |record|
+      @file.batches[0].send(record).to_s!.length.should == ACH::Constants::RECORD_SIZE
+    end
   end
+
 end

data/spec/componenet/has_many_association_spec.rb

@@ -0,0 +1,111 @@
+require 'spec_helper'
+
+describe ACH::Component::HasManyAssociation do
+  before(:all) do
+    ACH::Element = Class.new(ACH::Component)
+    ACH::Record::Item = Class.new(ACH::Record::Dynamic) do
+      item_id '<-3' => 'foo'
+    end
+  end
+
+  after(:all) do
+    ACH.remove_const(:Element)
+    ACH::Record.remove_const(:Item)
+  end
+
+  describe "properties" do
+    before(:each) do
+      @association = ACH::Component::HasManyAssociation.new(:elements)
+    end
+
+    it "should have proper klass" do
+      @association.send(:klass).should == ACH::Element
+    end
+
+    it "should have proper singular name" do
+      @association.send(:singular_name).should == 'element'
+    end
+
+    it "should have proper set of delegation methods" do
+      @association.delegation_methods.to_set.should == %w{elements element build_element}.to_set
+    end
+
+    describe "owner assignment" do
+      before(:each) do
+        @assigned = @association.for(ACH::Element.new)
+      end
+
+      it "should have @owner assigned" do
+        @assigned.instance_variable_get('@owner').should_not be_nil
+      end
+
+      it "should not share containers" do
+        @other = @association.for(ACH::Element.new)
+        @assigned.container.object_id.should_not == @other.container.object_id
+      end
+
+      it "should have method aliases for owner to delegate" do
+        @association.delegation_methods.each do |method_name|
+          @assigned.should respond_to method_name
+        end
+      end
+    end
+
+    describe "reassignment" do
+      it "should raise error" do
+        assigned = @association.for(Object.new)
+        expect{ assigned.for(Object.new) }.to raise_error(ACH::Component::HasManyAssociation::DoubleAssignmentError)
+      end
+    end
+
+    describe "without :linked_to option" do
+      it "should have Array as container" do
+        @association.container.should be_an Array
+      end
+
+      it "container_for_associated should be the same as container" do
+        @association.container_for_associated.object_id.should == @association.container.object_id
+      end
+    end
+
+    describe "with :linked_to option" do
+      before(:each) do
+        @linked_association = ACH::Component::HasManyAssociation.new(:items, :linked_to => :elements)
+        @assigned = @association.for(ACH::Element.new)
+        @linked_assigned = @linked_association.for(@assigned)
+      end
+
+      it "should have proper klass" do
+        @linked_association.send(:klass).should == ACH::Record::Item
+      end
+
+      it "should have Hash as container" do
+        @linked_association.container.should be_a Hash
+      end
+
+      it "container_for_associated should raise NoLinkError if there is no parent record created" do
+        expect {
+          @linked_assigned.container_for_associated
+        }.to raise_error(ACH::Component::HasManyAssociation::NoLinkError)
+      end
+
+      it "container_for_associated should be array if there is parent record" do
+        @assigned.create
+        @linked_assigned.container_for_associated.should be_an Array
+      end
+    end
+
+    describe "with :proc_defaults option" do
+      before(:each) do
+        @proc_association = ACH::Component::HasManyAssociation.new(
+          :items, :proc_defaults => lambda{ {:item_id => 'bar'} }
+        ).for(ACH::Element.new)
+      end
+
+      it "created item should have proper value" do
+        item = @proc_association.create
+        item.item_id.should == 'bar'
+      end
+    end
+  end
+end

data/spec/file_spec.rb

@@ -1,90 +1,182 @@
 require 'spec_helper'
 
 describe ACH::File do
-  before(:each) do
-    @attributes = {
-      :company_id => '11-11111',
-      :company_name => 'MY COMPANY',
-      :immediate_dest => '123123123',
-      :immediate_dest_name => 'COMMERCE BANK',
-      :immediate_origin => '123123123',
-      :immediate_origin_name => 'MYCOMPANY' }
-    @invalid_attributes = {:foo => 'bar'}
-    @file = ACH::File.new(@attributes)
-    @file_with_batch = ACH::File.new(@attributes) do
-      batch :entry_class_code => 'WEB'
-    end
-    @sample_file = ACH.sample_file
-  end
-  
-  it "should correctly assign attributes" do
-    @file.company_id.should == '11-11111'
-  end
-  
-  it "should be modified by calling attribute methods in block" do
-    file = ACH::File.new(@attributes) do
-      company_name "MINE COMPANY"
+
+  context "building the ACH file" do
+    before(:each) do
+      @attributes = {
+        :company_id => '11-11111',
+        :company_name => 'MY COMPANY',
+        :immediate_dest => '123123123',
+        :immediate_dest_name => 'COMMERCE BANK',
+        :immediate_origin => '123123123',
+        :immediate_origin_name => 'MYCOMPANY' }
+      @invalid_attributes = {:foo => 'bar'}
+      @file = ACH::File.new(@attributes)
+      @file_with_batch = ACH::File.new(@attributes) do
+        batch :entry_class_code => 'WEB'
+      end
+      @sample_file = ACH::FileFactory.sample_file
     end
-    file.company_name.should == "MINE COMPANY"
-  end
-  
-  it "should fetch and return header" do
-    head = @file.header
-    head.should be_instance_of(ACH::File::Header)
-    head.immediate_dest.should == '123123123'
-  end
-  
-  it "should be able to modify header info in block form" do
-    file = ACH::File.new(@attributes) do
-      header(:immediate_dest => '321321321') do
-        immediate_dest_name 'BANK COMMERCE'
+
+    it "should correctly assign attributes" do
+      @file.company_id.should == '11-11111'
+    end
+
+    it "should be modified by calling attribute methods in block" do
+      file = ACH::File.new(@attributes) do
+        company_name "MINE COMPANY"
       end
+      file.company_name.should == "MINE COMPANY"
+    end
+
+    it "should fetch and return header" do
+      head = @file.header
+      head.should be_instance_of(ACH::File::Header)
+      head.immediate_dest.should == '123123123'
+    end
+
+    it "should be able to modify header info in block form" do
+      file = ACH::File.new(@attributes) do
+        header(:immediate_dest => '321321321') do
+          immediate_dest_name 'BANK COMMERCE'
+        end
+      end
+      head = file.header
+      head.immediate_dest.should == '321321321'
+      head.immediate_dest_name.should == 'BANK COMMERCE'
+    end
+
+    it "should raise exception on unknown attribute assignement" do
+      lambda {
+        ACH::File.new(@invalid_attributes)
+      }.should raise_error(ACH::Component::UnknownAttributeError)
+    end
+
+    it "should be able to create a batch" do
+      @file_with_batch.batches.should_not be_empty
+    end
+
+    it "should return a batch when index is passed" do
+      @file_with_batch.batches[0].should be_instance_of(ACH::Batch)
+    end
+
+    it "should assign a batch_number to a batch" do
+      batch = @file_with_batch.batches[0]
+      batch.batch_number.should == 1
+      batch = @file_with_batch.batch(:entry_class_code => 'WEB')
+      batch.batch_number.should == 2
+    end
+
+    it "should assign attributes to a batch" do
+      batch = @file_with_batch.batches[0]
+      batch.attributes.should include(@file_with_batch.attributes)
+    end
+
+    it "should have correct record count" do
+      @sample_file.record_count.should == 10
+    end
+
+    it "should have header and control record with length of 94" do
+      [:header, :control].each do |record|
+        @sample_file.send(record).to_s!.length.should == ACH::Constants::RECORD_SIZE
+      end
+    end
+
+    it "should have length devisible by 94 (record size)" do
+      (@sample_file.to_s!.gsub(ACH::Constants::ROWS_DELIMITER, '').length % ACH::Constants::RECORD_SIZE).should be_zero
+    end
+
+
+    describe 'transmission header' do
+      before(:all) do
+        @with_transmission_header
+        attrs = {:remote_id => 'ZYXWVUTS', :application_id => '98765432'}
+        ach_file = ACH::FileFactory.with_transmission_header(attrs)
+        @transmission_header = ach_file.to_s!.split(ACH::Constants::ROWS_DELIMITER).first
+      end
+
+      it "should raise error when defining empty transmission header" do
+        expect do
+          Class.new(ACH::File) do
+            transmission_header
+          end
+        end.to raise_error(ACH::File::EmptyTransmissionHeaderError)
+      end
+
+      it "have_transmission_header? method should return proper value" do
+        without_header = Class.new(ACH::File)
+        with_header = Class.new(ACH::File) do
+          transmission_header do
+            application_id
+          end
+        end
+
+        without_header.have_transmission_header?.should be_false
+        with_header.have_transmission_header?.should be_true
+      end
+
+      it "has length of 38" do
+        @transmission_header.length.should == 38
+      end
+
+      it "has specified remote_id" do
+        @transmission_header[9..16].should == 'ZYXWVUTS'
+      end
+
+      it "has specified application_id" do
+        @transmission_header[29..36].should == '98765432'
+      end
+    end
+
+    it 'number of records is multiple of 10 (transmission header is ignored)' do
+      records = ACH::FileFactory.sample_file.to_s!.split(ACH::Constants::ROWS_DELIMITER)
+      (records.size % 10).should == 0
+
+      records = ACH::FileFactory.with_transmission_header.to_s!.split(ACH::Constants::ROWS_DELIMITER)
+      ((records.size - 1) % 10).should == 0
+    end
+
+    describe 'inherited class' do
+      before(:all) do
+        @custom_file_class = Class.new(ACH::File) do
+          immediate_dest_name 'CUSTOM VALUE'
+          customer_name "PETER PARKER"
+        end
+
+        @custom_file = @custom_file_class.new do
+          immediate_dest '123123123'
+          immediate_origin '123123123'
+          immediate_origin_name 'MYCOMPANY'
+          batch(:entry_class_code => "WEB", :company_entry_descr => 'TV-TELCOM') do
+            effective_date Time.now.strftime('%y%m%d')
+            desc_date      Time.now.strftime('%b %d').upcase
+            origin_dfi_id "00000000"
+            entry :customer_acct     => '61242882282',
+                  :amount            => '2501',
+                  :routing_number    => '010010101',
+                  :bank_account      => '103030030'
+          end
+        end
+      end
+
+      it 'should use default values defined in inherited class' do
+        header = @custom_file.header
+        header.immediate_dest_name.should == "CUSTOM VALUE"
+        entry = @custom_file.batches.first.entries.first
+        entry.customer_name.should == "PETER PARKER"
+      end
+    end
+
+    describe "file control" do
+      subject { @file.control }
+      it { should be_an ACH::File::Control }
     end
-    head = file.header
-    head.immediate_dest.should == '321321321'
-    head.immediate_dest_name.should == 'BANK COMMERCE'
-  end
-  
-  it "should raise exception on unknown attribute assignement" do
-    lambda {
-      ACH::File.new(@invalid_attributes)
-    }.should raise_error(ACH::Component::UnknownAttribute)
-  end
-  
-  it "should be able to create a batch" do
-    @file_with_batch.batches.should_not be_empty
-  end
-  
-  it "should return a batch when index is passed" do
-    @file_with_batch.batch(0).should be_instance_of(ACH::Batch)
-  end
-  
-  it "should assign a batch_number to a batch" do
-    batch = @file_with_batch.batch(0)
-    batch.batch_number.should == 1
-    batch = @file_with_batch.batch(:entry_class_code => 'WEB')
-    batch.batch_number.should == 2
-  end
-  
-  it "should assign attributes to a batch" do
-    batch = @file_with_batch.batch(0)
-    batch.attributes.should include(@file_with_batch.attributes)
-  end
-  
-  it "should have correct record count" do
-    @sample_file.record_count.should == 8
-  end
-  
-  it "should have header record with length of 94" do
-    @sample_file.header.to_s!.length.should == ACH::Constants::RECORD_SIZE
-  end
-  
-  it "should have control record with length of 94" do
-    @sample_file.control.to_s!.length.should == ACH::Constants::RECORD_SIZE
   end
-  
-  it "should have length devisible by 94 (record size)" do
-    (@sample_file.to_s!.gsub("\r\n", '').length % ACH::Constants::RECORD_SIZE).should be_zero
+
+  context "reading the ACH file" do
+    before(:each) { @result = ACH::File.read well_fargo_empty_filename }
+    subject { @result }
+    it { should be_an ACH::File }
   end
 end
-