ach_builder 0.0.2 → 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a6370b31599af5467812e5b45be57e99c5e19a32
+  data.tar.gz: 326db2ed6596c13a95ad0deeb8b5a9881270e857
+SHA512:
+  metadata.gz: a039dc192619a516cdf9c09fdefe33dde1505655c6b67c9bdacfd7ab47301a5586b1d1b5cd01292ef244cbd1fece3aa81b7344a9c4168f40e0a68d6694ac31f5
+  data.tar.gz: 5175200c43de130adb641b6d6c3d247b860b6e186cf2ff9ecc871dae6d95f0465f189a04f9d0e8f2430c811b77c74ad6272bbdea8b8109f6d667037aafce5fff

data/.gitignore

@@ -2,3 +2,15 @@
 .bundle
 Gemfile.lock
 pkg/*
+/.yardoc
+.idea
+doc/
+
+# exclude everything in tmp
+tmp/*
+# except the metric_fu directory
+!tmp/metric_fu/
+# but exclude everything *in* the metric_fu directory
+tmp/metric_fu/*
+# except for the _data directory to track metrical outputs
+!tmp/metric_fu/_data/

data/.rspec

@@ -1,2 +1,3 @@
 --color
---format documentation
+--format documentation
+--profile

data/.ruby-gemset

@@ -0,0 +1 @@
+ach_builder

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p247

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+script: "rake spec"
+rvm:
+  - 1.9.3
+  - 2.0.0
+notifications:
+  email:
+    - rubygems@tmxcredit.com
+    - AKuzko@sphereconsultinginc.com
+    - SPotapov@sphereconsultinginc.com

data/Gemfile

@@ -1,5 +1,14 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
+
 
 # Specify your gem's dependencies in ach_builder.gemspec
+gem 'i18n'
 gemspec
-gem 'rspec'
+gem 'rspec'
+
+group :development, :test do
+  gem 'rspec'
+
+  gem "simplecov"          , :require => false
+  gem 'simplecov-rcov-text', :require => false
+end

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2011 Artem Kuzko
+Copyright (c) 2013 TMX Credit
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,41 +1,49 @@
 #ACH-Builder
 
-Ruby helper for creating ACH files. It's API is designed to be as flexible as possible.
+[![Build Status](https://secure.travis-ci.org/TMXCredit/ach_builder.png)](http://travis-ci.org/TMXCredit/ach_builder)
 
-Inspired by
+Ruby helper for creating ACH files. Its API is designed to be as flexible as possible.
 
-[ach](http://github.com/jm81/ach) - Ruby helper
-
-[ACH::Builder](http://github.com/camerb/ACH-Builder) - Perl module
-
-with similar functionality
+Inspired by:
+* [ach](http://github.com/jm81/ach) - Ruby helper
+* [ACH::Builder](http://github.com/camerb/ACH-Builder) - Perl module
 
 ##Example
+
+```ruby
     # attributes for records may be passed as parameters, as well as modified in block
     # these attributes will be passed to all inner entities in a cascade way, if required
     file = ACH::File.new(:company_id => '11-11111', :company_name => 'MY COMPANY') do
       immediate_dest_name 'COMMERCE BANK'
       immediate_origin '123123123'
-      immediate_oreigin_name 'MYCOMPANY'
-        
+      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'
+          addenda do
+            addenda_type_code          '05'
+            payment_related_info       'foo bar'
+            addenda_sequence_num       1
+            entry_details_sequence_num 1
+          end
         end
       end
     end
-    
+
     file.valid? # => false
     file.errors # => {"ACH::File::Header#1"=>{:immediate_dest=>"is required"}}
     file.header.immediate_dest = '123123123'
     file.write('ach_01.txt')
+```
 
 ##Copyright
 
-Copyright (c) 2011 Artem Kuzko, released under the MIT license
+Copyright (c) 2013 TMX Credit, released under the MIT license

data/Rakefile

@@ -1 +1,45 @@
+task :default => :spec
+
 require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+def gemspec
+  @gem_spec ||= eval( open( `ls *.gemspec`.strip ){|file| file.read } )
+end
+
+def gem_version
+  gemspec.version
+end
+
+def gem_version_tag
+  "v#{gem_version}"
+end
+
+def gem_name
+  gemspec.name
+end
+
+def gem_file_name
+  "#{gem_name}-#{gem_version}.gem"
+end
+
+namespace :git do
+  desc "Create git version tag #{gem_version}"
+  task :tag do
+    sh "git tag -a #{gem_version_tag} -m \"Version #{gem_version}\""
+  end
+
+  desc "Push git tag to GitHub"
+  task :push_tags do
+    sh 'git push --tags'
+  end
+
+  desc "Create git version tag #{gem_version} and push to GitHub"
+  task :submit => [:tag, :push_tags] do
+    puts "Deployed to GitHub."
+  end
+end

data/ach_builder.gemspec

@@ -5,9 +5,9 @@ require "ach/version"
 Gem::Specification.new do |s|
   s.name        = "ach_builder"
   s.version     = ACH::VERSION
-  s.authors     = ["Artem Kuzko"]
-  s.email       = ["a.kuzko@gmail.com"]
-  s.homepage    = "http://github.com/akuzko/ach_builder"
+  s.authors     = ["TMX Credit", "Artem Kuzko", "Sergey Potapov"]
+  s.email       = ["rubygems@tmxcredit.com", "AKuzko@sphereconsultinginc.com", "SPotapov@sphereconsultinginc.com"]
+  s.homepage    = "https://github.com/TMXCredit/ach_builder"
   s.summary     = "Ruby tools for building ACH files"
   s.description = "Ruby tools for building ACH (Automated Clearing House) files"
 
@@ -17,7 +17,11 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
+  s.licenses      = ['MIT']
 
-  s.add_development_dependency "rspec", ">= 2.0.0"
-  s.add_runtime_dependency "active_support", ">= 2.3.0"
+  s.add_development_dependency "rspec"    , ">= 2.0.0"
+  s.add_runtime_dependency "activesupport", ">= 2.3.0"
+
+  # Necessary for active_support/inflector:
+  s.add_runtime_dependency "i18n"
 end

data/lib/ach/batch.rb

@@ -1,37 +1,15 @@
 module ACH
+  # Represents an ACH::Component, which is located under ACH::File and
+  # contains a variable number of ACH::Record::Entry and ACH::Record::Addenda
+  # records itself.
   class Batch < Component
+    autoload :Builder
+    autoload :Control
+    autoload :Header
+
+    include Builder
+
     has_many :entries
-    
-    def has_credit?
-      entries.any?(&:credit?)
-    end
-    
-    def has_debit?
-      entries.any?(&:debit?)
-    end
-    
-    def entry_count
-      entries.length
-    end
-    
-    def entry_hash
-      entries.map{ |e| e.routing_number.to_i / 10 }.compact.inject(&:+)
-    end
-    
-    def total_debit_amount
-      entries.select(&:debit?).map{ |e| e.amount.to_i }.compact.inject(&:+) || 0
-    end
-    
-    def total_credit_amount
-      entries.select(&:credit?).map{ |e| e.amount.to_i }.compact.inject(&:+) || 0
-    end
-    
-    def to_ach
-      [header] + entries + [control]
-    end
-    
-    def before_header
-      attributes[:service_class_code] ||= (has_debit? && has_credit? ? 200 : has_debit? ? 225 : 220)
-    end
+    has_many :addendas, :linked_to => :entries
   end
 end

data/lib/ach/batch/builder.rb

@@ -0,0 +1,60 @@
+module ACH
+  # Supports building a string representation of a particular instance of an
+  # ACH batch. Supports building ACH lines. Included by ACH::File.
+  module Batch::Builder
+    # Returns +true+ if any of internal ACH entries has 'credit' transaction code
+    def has_credit?
+      entries.any?(&:credit?)
+    end
+
+    # Returns +true+ if any internal ACH entry has 'debit' transaction code
+    def has_debit?
+      entries.any?(&:debit?)
+    end
+
+    # Returns total amount of entry and addenda records within batch
+    def entry_addenda_count
+      entries.size + addendas.values.flatten.size
+    end
+
+    # Returns 'hashed' representation of all entries within batch. See NACHA
+    # documentation for more details on entry hash
+    def entry_hash
+      entries.map{ |entry| entry.routing_number.to_i / 10 }.compact.inject(&:+)
+    end
+
+    # Returns total amount of all 'debit' entries within a batch
+    def total_debit_amount
+      amount_sum_for(:debit?)
+    end
+
+    # Returns total amount of all 'credit' entries within a batch
+    def total_credit_amount
+      amount_sum_for(:credit?)
+    end
+
+    # Returns ACH record objects that represent the batch
+    def to_ach
+      [header] + fetch_entries + [control]
+    end
+
+    # Helper method executed just before building a header record for the batch
+    def before_header
+      attributes[:service_class_code] ||= (has_debit? && has_credit? ? 200 : has_debit? ? 225 : 220)
+    end
+    private :before_header
+
+    # Helper method, returns total amount of all entries within a batch, filtered by +meth+
+    def amount_sum_for(meth)
+      entries.select(&meth).map{ |entry| entry.amount.to_i }.compact.inject(&:+) || 0
+    end
+    private :amount_sum_for
+
+    # Fetches all internal records (entries and addendas) in right order, i.e. addenda records
+    # should be positioned right after corresponding entry records.
+    def fetch_entries
+      entries.inject([]){ |all, entry| all << entry << addendas[entry] }.flatten.compact
+    end
+    private :fetch_entries
+  end
+end

data/lib/ach/batch/control.rb

@@ -1,8 +1,23 @@
 module ACH
-  class Batch::Control < Record
+  # Every ACH::Batch component ends with a batch control record.
+  #
+  # == Fields
+  #
+  # * record_type
+  # * service_class_code
+  # * entry_addenda_count
+  # * entry_hash
+  # * total_debit_amount
+  # * total_credit_amount
+  # * company_id
+  # * authen_code
+  # * bank_6
+  # * origin_dfi_id
+  # * batch_number
+  class Batch::Control < Record::Base
     fields :record_type,
       :service_class_code,
-      :entry_count,
+      :entry_addenda_count,
       :entry_hash,
       :total_debit_amount,
       :total_credit_amount,
@@ -12,7 +27,7 @@ module ACH
       :origin_dfi_id,
       :batch_number
     
-    defaults :record_type => 8,
+    defaults :record_type => BATCH_CONTROL_RECORD_TYPE,
       :authen_code        => '',
       :bank_6             => ''
   end

data/lib/ach/batch/header.rb

@@ -1,5 +1,22 @@
 module ACH
-  class Batch::Header < Record
+  # Every ACH::Batch component starts with a batch header record
+  #
+  # == Fields
+  #
+  # * record_type
+  # * service_class_code
+  # * company_name
+  # * company_note_data
+  # * company_id
+  # * entry_class_code
+  # * company_entry_descr
+  # * desc_date
+  # * effective_date
+  # * settlement_date
+  # * origin_status_code
+  # * origin_dfi_id
+  # * batch_number
+  class Batch::Header < Record::Base
     fields :record_type,
       :service_class_code,
       :company_name,
@@ -7,18 +24,18 @@ module ACH
       :company_id,
       :entry_class_code,
       :company_entry_descr,
-      :date,
+      :desc_date,
       :effective_date,
       :settlement_date,
       :origin_status_code,
       :origin_dfi_id,
       :batch_number
     
-    defaults :record_type => 5,
+    defaults :record_type => BATCH_HEADER_RECORD_TYPE,
       :service_class_code => 200,
       :company_note_data  => '',
       :date               => lambda{ Time.now.strftime("%y%m%d") },
       :settlement_date    => '',
-      :origin_status_code => ''
+      :origin_status_code => 1
   end
 end

data/lib/ach/component.rb

@@ -1,39 +1,98 @@
 module ACH
+  # Base class for ACH::File and ACH::Batch. Every component has its own number
+  # of entities, header and control records. So it provides ACH::Component#header,
+  # ACH::Component#control, ACH::Component.has_many methods to manage them.
+  #
+  # == Example
+  #
+  #    class File < Component
+  #      has_many :batches
+  #      # implementation
+  #    end
   class Component
+    extend ActiveSupport::Autoload
+
     include Validations
     include Constants
-    
-    class UnknownAttribute < ArgumentError
-      def initialize field
-        super "Unrecognized attribute '#{field}'"
+
+    autoload :HasManyAssociation
+
+    # Exception raised on attempt to assign a value to nonexistent field.
+    class UnknownAttributeError < ArgumentError
+      def initialize field, obj
+        super "Unrecognized attribute '#{field}' for #{obj}"
       end
     end
     
+    class_attribute :default_attributes
+    class_attribute :after_initialize_hooks
+    self.default_attributes = {}
+    self.after_initialize_hooks = []
+
     attr_reader :attributes
-    
-    def initialize fields = {}, &block
-      @attributes = {}
+
+    def self.inherited(klass)
+      klass.default_attributes = default_attributes.dup
+      klass.after_initialize_hooks = after_initialize_hooks.dup
+    end
+
+    # Uses +method_missing+ pattern to specify default attributes for a
+    # +Component+. If method name is one of the defined rules, saves it to
+    # +default_attributes+ hash.
+    #
+    # These attributes are passed to inner components in a cascade way, i.e. when ACH
+    # File was defined with default value for 'company_name', this value will be passed
+    # to every Batch component within file, and from every Batch to corresponding batch
+    # header record.
+    #
+    # Note that default values may be overwritten when building records.
+    def self.method_missing(meth, *args)
+      if Formatter.defined?(meth)
+        default_attributes[meth] = args.first
+      else
+        super
+      end
+    end
+
+    def initialize(fields = {}, &block)
+      @attributes = {}.merge(self.class.default_attributes)
       fields.each do |name, value|
-        raise UnknownAttribute.new(name) unless Formatter::RULES.key?(name)
+        raise UnknownAttributeError.new(name, self) unless Formatter.defined?(name)
         @attributes[name] = value
       end
-      after_initialize if respond_to?(:after_initialize)
+      after_initialize
       instance_eval(&block) if block
     end
-    
-    def method_missing meth, *args
-      if Formatter::RULES.key?(meth)
+
+    def method_missing(meth, *args)
+      if Formatter.defined?(meth)
         args.empty? ? @attributes[meth] : (@attributes[meth] = args.first)
       else
         super
       end
     end
-    
-    def before_header
+
+    def before_header # :nodoc:
     end
     private :before_header
-    
-    def header fields = {}, &block
+
+    # Sets header fields if fields or block passed. Returns header record.
+    #
+    # == Example 1
+    #
+    #   header :foo => "value 1", :bar => "value 2"
+    #
+    # == Example 2
+    #
+    #   header do
+    #     foo "value 1"
+    #     bar "value 2"
+    #   end
+    #
+    # == Example 3
+    #
+    #   header # => just returns a header object
+    def header(fields = {}, &block)
       before_header
       merged_fields = fields_for(self.class::Header).merge(fields)
       @header ||= self.class::Header.new(merged_fields)
@@ -41,39 +100,62 @@ module ACH
         head.instance_eval(&block) if block
       end
     end
-    
+
+    def build_header(str) # :nodoc:
+      @header = self.class::Header.from_s(str)
+    end
+
     def control
-      klass = self.class::Control
-      fields = klass.fields.select{ |f| respond_to?(f) || attributes[f] }
-      klass.new Hash[*fields.zip(fields.map{ |f| send(f) }).flatten]
+      @control ||= begin
+        klass  = self.class::Control
+        fields = klass.fields.select{ |f| respond_to?(f) || attributes[f] }
+        klass.new Hash[*fields.zip(fields.map{ |f| send(f) }).flatten]
+      end
     end
-    
-    def fields_for component_or_class
-      klass = component_or_class.is_a?(Class) ? component_or_class : "ACH::#{component_or_class.camelize}".constantize
-      klass < Component ? attributes : attributes.select{ |k, v| klass.fields.include?(k) && attributes[k] }
+
+    def build_control(str) # :nodoc:
+      @control = self.class::Control.from_s(str)
     end
     
-    def self.has_many plural_name, proc_defaults = nil
-      attr_reader plural_name
-      
-      singular_name = plural_name.to_s.singularize
-      klass = "ACH::#{singular_name.camelize}".constantize
-      
-      define_method(singular_name) do |*args, &block|
-        index_or_fields = args.first || {}
-        return send(plural_name)[index_or_fields] if Fixnum === index_or_fields
-        
-        defaults = proc_defaults ? instance_exec(&proc_defaults) : {}
-        
-        klass.new(fields_for(singular_name).merge(defaults).merge(index_or_fields)).tap do |component|
-          component.instance_eval(&block) if block
-          send(plural_name) << component
-        end
+    def fields_for(klass)
+      if klass < Component
+        attributes
+      else
+        attrs = attributes.find_all{ |k, v| klass.fields.include?(k) && attributes[k] }
+        Hash[*attrs.flatten]
       end
-      
-      define_method :after_initialize do
-        instance_variable_set("@#{plural_name}", [])
+    end
+
+    def after_initialize # :nodoc:
+      self.class.after_initialize_hooks.each{ |hook| instance_exec(&hook) }
+    end
+    
+    # Creates has many association.
+    #
+    # == Example
+    #
+    #    class File < Component
+    #      has_many :batches
+    #    end
+    #
+    #    file = File.new do
+    #      batch :foo => 1, :bar => 2
+    #    end
+    #
+    #    file.batches  # => [#<Batch ...>]
+    #
+    # The example above extends File with #batches and #batch instance methods:
+    # * #batch is used to add new instance of Batch.
+    # * #batches is used to get an array of batches which belong to file.
+    def self.has_many(plural_name, options = {})
+      association = HasManyAssociation.new(plural_name, options)
+
+      association_variable_name = "@#{plural_name}_association"
+      association.delegation_methods.each do |method_name|
+        delegate method_name, :to => association_variable_name
       end
+
+      after_initialize_hooks << lambda{ instance_variable_set(association_variable_name, association.for(self)) }
     end
   end
 end