headache 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 38197db347ba22937f9bd2ac2c4ec0f08a7b1912
-  data.tar.gz: 81698a7ed860a42987faaf609cef7fff299e3b67
+  metadata.gz: a72d32f6528347c6a9d436c4bdac202084e41aab
+  data.tar.gz: 767ad6765618b1eacdace436a4c58f6c835bacc9
 SHA512:
-  metadata.gz: 724993f4ab4e3bd4421d83b59c7d467be8ea86161efb4c464ee35317959de419c9edd239a6634b436fb8cfa7b067a54fae32f17110ab5ee9148ebd7665e5a2f0
-  data.tar.gz: 7332c63174ef2162947174fd5455d6f2e2f3837a02d1989a22fd8507b24bd9cef312961649aadd9e5c1306f8f2790b9a83eca254cee0edda368199237bae821c
+  metadata.gz: c3c1de15d6b368b661d816743bf79e0ebcad538ba32258fb5a9368aaecb29be6ebe76a8fe57d0d2aa88eccdf796e3433db4adf21aa4f3220092182083417059c
+  data.tar.gz: 395de1946348f85b31e0a374ed8443d85a88949b446754c488f6f19c80a3962291511d2cf4bff4f63122c5f583acdf5afabf37ac502f6004293784631c47e808

data/.gitignore

@@ -8,3 +8,4 @@
 /spec/reports/
 /tmp/
 *.gem
+.rspec

data/Gemfile

@@ -1,4 +1,6 @@
 source 'https://rubygems.org'
 
+gem 'coveralls', require: false
+
 # Specify your gem's dependencies in headache.gemspec
 gemspec

data/README.md

@@ -1,6 +1,6 @@
 # HeadACHe
 
-[![Code Climate](https://img.shields.io/codeclimate/github/teampayoff/headache.svg?style=flat-square)](https://codeclimate.com/github/teampayoff/headache)
+[![Code Climate](https://img.shields.io/codeclimate/github/teampayoff/headache.svg?style=flat-square)](https://codeclimate.com/github/teampayoff/headache) [![Travis CI](https://img.shields.io/travis/teampayoff/headache.svg?style=flat-square)](https://travis-ci.org/teampayoff/headache) [![Coverage](https://img.shields.io/coveralls/teampayoff/headache.svg?style=flat-square)](https://coveralls.io/r/teampayoff/headache)
 
 Headache takes a lot of the guesswork out of building [ACH (Automated Clearing House)](https://en.wikipedia.org/wiki/Automated_Clearing_House) files to move money around between banks.
 

data/Rakefile

@@ -1 +1,6 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+ RSpec::Core::RakeTask.new(:spec)
+
+ task default: :spec

data/headache.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
   spec.add_dependency 'fixy', '~> 0.0'
-  spec.add_dependency 'activesupport', '~> 4'
+  spec.add_dependency 'activesupport', '>= 4'
   spec.add_development_dependency 'faker', '~> 1.4'
   spec.add_development_dependency 'rspec', '~> 3.3'
   spec.add_development_dependency 'factory_girl', '~> 4.5'

data/lib/headache.rb

@@ -6,6 +6,7 @@ require 'active_support/core_ext/enumerable'
 
 require 'headache/formatters'
 require 'headache/definitions'
+require 'headache/record/base'
 require 'headache/records'
 require 'headache/batch'
 require 'headache/document'

data/lib/headache/batch.rb

@@ -5,7 +5,8 @@ module Headache
     attr_accessor :type, :document, :batch_number, :service_code, :odfi_id,
                   :company_name, :company_identification, :effective_date,
                   :company_name, :company_identification, :discretionary,
-                  :entry_class_code, :entry_description
+                  :entry_class_code, :entry_description, :descriptive_date,
+                  :total_debit, :total_credit, :entry_hash
 
     @@record_classes = { header: Record::BatchHeader,
                          control: Record::BatchControl }
@@ -23,6 +24,17 @@ module Headache
       @@record_classes[type] = klass
     end
 
+    def parse(records)
+      @header  = @@record_classes[:header].new(self, @document).parse(records.shift)
+      @control = @@record_classes[:control].new(self, @document).parse(records.pop)
+      records.each { |r| @members << Headache::Record::Entry.new(self, @document).parse(r) }
+      self
+    end
+
+    def descriptive_date
+      @descriptive_date || Date.today
+    end
+
     def effective_date
       @effective_date || Date.today
     end
@@ -32,6 +44,12 @@ module Headache
       @members  = []
     end
 
+    def self.type_from_service_code(code)
+      return :credit if code.to_s == '220'
+      return :debit  if code.to_s == '225'
+      fail "unknown service code: #{code.inspect} (expecting 220 or 225)"
+    end
+
     def service_code
       return '220' if type == :credit
       return '225' if type == :debit
@@ -51,11 +69,17 @@ module Headache
     end
 
     def batch_number
-      @batch_number || document.batches.index(batch) + 1
+      @batch_number || document.batches.index(self) + 1
+    end
+
+    def to_h
+      {  batch_header: @header.to_h,
+              entries: @members.to_a.map(&:to_h),
+        batch_control: @control.to_h }
     end
 
     def entry_hash
-      entries.map(&:routing_identification).map(&:to_i).sum
+      @entry_hash || entries.map(&:routing_identification).map(&:to_i).sum
     end
 
     def add_entry(entry)
@@ -73,11 +97,11 @@ module Headache
     end
 
     def total_debit
-      entries.map(&:amount).select { |amt| amt < 0 }.map(&:abs).sum
+      @total_debit || entries.map(&:amount).select { |amt| (amt || 0) < 0 }.map(&:abs).sum
     end
 
     def total_credit
-      entries.map(&:amount).select { |amt| amt > 0 }.sum
+      @total_credit || entries.map(&:amount).select { |amt| (amt || 0) > 0 }.sum
     end
 
   end

data/lib/headache/definition/batch_control.rb

@@ -7,10 +7,10 @@ module Headache
         include Common
 
         field :service_code,                 3, '2-4',   :alphanumeric
-        field :entry_count,                  6, '5-10',  :numeric
+        field :entry_count,                  6, '5-10',  :numeric_value
         field :entry_hash,                  10, '11-20', :numeric
-        field :total_debit,                 12, '21-32', :numeric
-        field :total_credit,                12, '33-44', :numeric
+        field :total_debit,                 12, '21-32', :numeric_value
+        field :total_credit,                12, '33-44', :numeric_value
         field :company_identification,      10, '45-54', :alphanumeric
         field :message_authentication_code, 19, '55-73', :nothing
         field :reserved,                     6, '74-79', :nothing

data/lib/headache/definition/batch_header.rb

@@ -12,14 +12,13 @@ module Headache
         field :company_identification, 10, '41-50', :alphanumeric
         field :entry_class_code,        3, '51-53', :alphanumeric
         field :entry_description,      10, '54-63', :alphanumeric
-        field :descriptive_date,        6, '64-69', :nothing
+        field :descriptive_date,        6, '64-69', :date
         field :effective_date,          6, '70-75', :date
-        field :settlement_date,         3, '76-78', :nothing
+        field :settlement_date,         3, '76-78', :nothing # inserted by ACH operator
         field :originator_status_code,  1, '79-79', :alphanumeric
         field :odfi_id,                 8, '80-87', :alphanumeric
-        field :batch_number,            7, '88-94', :alphanumeric
+        field :batch_number,            7, '88-94', :numeric
 
-        field_value :descriptive_date,       ''
         field_value :settlement_date,        ''
         field_value :originator_status_code, '1'
       end

data/lib/headache/definition/common.rb

@@ -13,7 +13,10 @@ module Headache
 
         field :record_type_code, 1, '1-1', :alphanumeric
 
-        def record_type_codes
+        delegate :record_type_codes, to: :class
+        delegate :record_type_code,  to: :class
+
+        def self.record_type_codes
           { file_header: 1,
            batch_header: 5,
                   entry: 6,
@@ -21,8 +24,8 @@ module Headache
            file_control: 9 }
         end
 
-        def record_type_code
-          record_type = self.class.name.demodulize.underscore
+        def self.record_type_code
+          record_type = name.demodulize.underscore
           record_type_codes[record_type.to_sym]
         end
       end

data/lib/headache/definition/entry.rb

@@ -10,7 +10,7 @@ module Headache
         field :routing_identification, 8,  '4-11', :numeric
         field :check_digit,            1, '12-12', :numeric
         field :account_number,        17, '13-29', :alphanumeric
-        field :amount,                10, '30-39', :numeric
+        field :amount,                10, '30-39', :numeric_value
         field :internal_id,           15, '40-54', :alphanumeric
         field :individual_name,       22, '55-76', :alphanumeric
         field :discretionary,          2, '77-78', :alphanumeric
@@ -20,14 +20,6 @@ module Headache
         field_value :addenda_record, '0'
         field_value :discretionary,  ''
       end
-
-      def routing_identification
-        routing_number.first 8
-      end
-
-      def check_digit
-        routing_number.last 1
-      end
     end
   end
 end

data/lib/headache/definition/file_control.rb

@@ -6,14 +6,14 @@ module Headache
       included do
         include Common
 
-        field :batch_count,   6,   '2-7', :numeric
-        field :block_count,   6,  '8-13', :numeric
-        field :entry_count,   8, '14-21', :numeric
+        field :batch_count,   6,   '2-7', :numeric_value
+        field :block_count,   6,  '8-13', :numeric_value
+        field :entry_count,   8, '14-21', :numeric_value
         field :entry_hash,   10, '22-31', :numeric
-        field :total_debit,  12, '32-43', :numeric
-        field :total_credit, 12, '44-55', :numeric
+        field :total_debit,  12, '32-43', :numeric_value
+        field :total_credit, 12, '44-55', :numeric_value
         field :reserved,     39, '56-94', :nothing
-        
+
         field_value :reserved, ''
       end
     end

data/lib/headache/document.rb

@@ -2,12 +2,22 @@ module Headache
   class Document < Fixy::Document
     attr_reader :batches
 
+    LINE_SEPARATOR = "\r\n"
+
     delegate :add_entry, :'<<', to: :first_batch
 
     @@record_classes = { batch: Batch,
                          header: Record::FileHeader,
                          control: Record::FileControl }
 
+    def self.header_class
+      @@record_classes[:header]
+    end
+
+    def self.control_class
+      @@record_classes[:control]
+    end
+
     def self.header=(klass)
       set_class :header, klass
     end
@@ -16,13 +26,50 @@ module Headache
       set_class :control, klass
     end
 
+    def self.extract_lines(string_or_file)
+      string = string_or_file.respond_to?(:read) ? string_or_file.read : string_or_file
+      string.split(LINE_SEPARATOR).reject { |line| line == Headache::Record::Overflow.new.generate.strip }
+    end
+
+    def self.cleanse_records(records)
+      invalid_lines = records.reject { |line| Headache::Record::FileHeader.record_type_codes.values.include?(line.first.to_i) }
+      raise "uknown record type(s): #{invalid_lines.map(&:first).inspect}" if invalid_lines.any?
+      records
+    end
+
+    def self.parse(string_or_file)
+      records = cleanse_records(extract_lines string_or_file)
+      header  = header_class.new(nil).parse(records.shift)
+      control = control_class.new(nil).parse(records.pop)
+      batches = get_batches(records).map { |b| Headache::Batch.new(self).parse(b) }
+      new header, control, batches
+    end
+
+    def self.get_batches(records)
+      batches = []
+      batch   = []
+      records.each do |line|
+        if line.starts_with?(Headache::Record::BatchHeader.record_type_codes[:batch_header].to_s)
+          batches << batch unless batches.empty? && batch == []
+          batch = [line]
+        else
+          batch << line
+        end
+      end
+      batches << batch
+    end
+
     def self.set_class(type, klass)
       fail "unknown record class: #{type}" unless @@record_classes[type].present?
       @@record_classes[type] = klass
     end
 
-    def initialize
-      @batches = []
+    def initialize(header = nil, control = nil, batches = [])
+      @header  = header
+      @control = control
+      @batches = batches
+      @header.document  = self unless @header.nil?
+      @control.document = self unless @control.nil?
     end
 
     def first_batch
@@ -57,6 +104,12 @@ module Headache
       @control ||= @@record_classes[:control].new self
     end
 
+    def records
+      ([ header ] << batches.map do |batch|
+        [ batch.header, batch.entries, batch.control ]
+      end << control).flatten # .compact
+    end
+
     def lines
       @content.split("\n").count
     end
@@ -65,6 +118,12 @@ module Headache
       10 - lines % 10
     end
 
+    def to_h
+      {  file_header: @header.to_h,
+             batches: @batches.map(&:to_h),
+        file_control: @control.to_h }
+    end
+
     def build
       append_record header
       @batches.each do |batch|

data/lib/headache/formatters.rb

@@ -1,14 +1,24 @@
 module Headache
   module Formatters
     include Fixy::Formatter::Alphanumeric
+    BLANK_DATE = "      "
 
     def format_alphanumeric(input, length)
       super(input, length).upcase
     end
 
-    def format_date(input, _length)
-      fail "input #{input.inspect} does not respond to #strftime!" unless input.respond_to?(:strftime)
-      input.strftime '%y%m%d'
+    def format_numeric_value(input, length)
+      format_numeric(input, length)
+    end
+
+    def format_date(input, length)
+      if input.respond_to?(:strftime)
+        return input.strftime '%y%m%d'
+      elsif input.blank?
+        return BLANK_DATE
+      else
+        format_date Date.strptime(input.to_s, '%y%m%d'), length
+      end
     end
 
     def format_nothing(_input, length)
@@ -23,6 +33,12 @@ module Headache
     end
 
     def format_time(input, _length)
+      if input.is_a?(String) || input.is_a?(Fixnum)
+        chars   = input.to_s.chars
+        minutes = chars.pop(2).join.to_i
+        hours   = chars.join.to_i
+        input   = Time.new 0, 1, 1, hours, minutes
+      end
       fail "input #{input.inspect} does not respond to #strftime!" unless input.respond_to?(:strftime)
       input.strftime '%H%M'
     end

data/lib/headache/record/base.rb

@@ -0,0 +1,57 @@
+module Headache
+  module Record
+    class Base < Fixy::Record
+      def self.parse_fields_normalize(record_string)
+        parse_fields(record_string).inject({}) { |m,i| m[i.first] = normalize_field_value(i.first, i.last); m }
+      end
+
+      def self.parse_fields(record_string)
+        parse(record_string)[:fields].inject({}) do |m,i|
+          m[i[:name]] = i[:value]; m
+        end
+      end
+
+      def self.fields
+        @record_fields.to_a.map { |i| i.last }.inject({}) { |m,i| m[i[:name]] = i.except(:name); m }
+      end
+
+      def self.normalize_field_value(field, value)
+        field_type = fields[field].try(:[],:type)
+        return value if field_type.nil?
+
+        case field_type
+        when :numeric_value
+          value.gsub(/^0+/,'').to_i
+        when :alphanumeric
+          value.strip
+        when :nothing
+          nil
+        else
+          value
+        end
+      end
+
+      def normalize_field_value(f, v)
+        self.class.normalize_field_value(f, v)
+      end
+
+      def to_h
+        str = self.generate.gsub Headache::Document::LINE_SEPARATOR, ''
+        self.class.parse_fields(str)
+      end
+
+      def parse_fields(record_string)
+        self.class.parse_fields record_string
+      end
+
+      def parse(record_string)
+        parse_fields(record_string).each_pair do |field, value|
+          if respond_to?("#{field}=")
+            send "#{field}=", normalize_field_value(field, value)
+          end
+        end
+        self
+      end
+    end
+  end
+end

data/lib/headache/record/batch_control.rb

@@ -1,12 +1,13 @@
 module Headache
   module Record
-    class BatchControl < Fixy::Record
+    class BatchControl < Headache::Record::Base
       include Definition::BatchControl
 
       attr_accessor :batch, :document
 
-      delegate :entry_hash, :total_debit, :total_credit, :batch_number,
-               :service_code, :odfi_id, :company_identification, to: :batch
+      delegate :entry_hash, :batch_number, :total_debit, :total_credit,
+               :total_debit=, :total_credit=, :service_code, :odfi_id,
+               :company_identification, :entry_hash=, to: :batch
 
       def initialize(batch, document)
         @batch = batch
@@ -16,7 +17,6 @@ module Headache
       def entry_count
         batch.size
       end
-
     end
   end
 end

data/lib/headache/record/batch_header.rb

@@ -1,6 +1,6 @@
 module Headache
   module Record
-    class BatchHeader < Fixy::Record
+    class BatchHeader < Headache::Record::Base
       include Definition::BatchHeader
 
       attr_accessor :batch, :document
@@ -9,12 +9,19 @@ module Headache
                :company_identification, :'company_identification=', :company_name,
                :'company_name=', :entry_description, :'entry_description=', :discretionary,
                :'discretionary=', :entry_class_code, :'entry_class_code=', :effective_date,
-               :'effective_date=', to: :batch
+               :'effective_date=', :'type=', :descriptive_date,
+               :'descriptive_date=', to: :batch
 
       def initialize(batch = nil, document = nil)
         @batch    = batch
         @document = document
       end
+
+      def parse_fields(record_string)
+        fields = super
+        type   = Headache::Batch.type_from_service_code(fields.delete :service_code)
+        fields.merge(type: type)
+      end
     end
   end
 end

data/lib/headache/record/entry.rb

@@ -1,14 +1,54 @@
 module Headache
   module Record
-    class Entry < Fixy::Record
+    class Entry < Headache::Record::Base
       include Definition::Entry
 
       attr_accessor :routing_number, :account_number, :amount,
                     :internal_id, :trace_number, :individual_name,
-                    :transaction_code, :document, :batch, :discretionary
+                    :transaction_code, :document, :batch, :discretionary,
+                    :check_digit, :routing_identification
+
+      def check_digit=(value)
+        rval = (@check_digit = value)
+        assemble_routing_number
+        rval
+      end
+
+      def routing_identification=(value)
+        rval = (@routing_identification = value)
+        assemble_routing_number
+        rval
+      end
+
+      def assemble_routing_number
+        if @routing_identification.present? && @check_digit.present?
+          @routing_number = "#{@routing_identification}#{@check_digit}"
+        end
+      end
+
+      def to_h
+        new_hsh = {}
+        super.each_pair do |key, value|
+          next if key == :check_digit
+          if key == :routing_identification
+            key   = :routing_number
+            value = @routing_number
+          end
+          new_hsh[key] = value
+        end
+        new_hsh
+      end
+
+      def routing_identification
+        @routing_identification || routing_number.to_s.first(8)
+      end
+
+      def check_digit
+        @check_digit || routing_number.to_s.last(1)
+      end
 
       def initialize(batch = nil, document = nil)
-        @batch = batch
+        @batch    = batch
         @document = document
       end
     end

data/lib/headache/record/file_control.rb

@@ -1,6 +1,6 @@
 module Headache
   module Record
-    class FileControl < Fixy::Record
+    class FileControl < Headache::Record::Base
       include Definition::FileControl
 
       attr_accessor :document

data/lib/headache/record/file_header.rb

@@ -1,6 +1,6 @@
 module Headache
   module Record
-    class FileHeader < Fixy::Record
+    class FileHeader < Headache::Record::Base
       include Definition::FileHeader
 
       attr_accessor :reference_code, :creation_time, :origin, :origin_name,
@@ -12,7 +12,7 @@ module Headache
       end
 
       def destination
-        ' ' + (@destination || '')
+        ' ' + (@destination || '').to_s
       end
 
       def creation_date

data/lib/headache/record/overflow.rb

@@ -1,6 +1,6 @@
 module Headache
   module Record
-    class Overflow < Fixy::Record
+    class Overflow < Headache::Record::Base
       include Formatters
 
       set_record_length 94

data/lib/headache/version.rb

@@ -1,3 +1,3 @@
 module Headache
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: headache
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Payoff, Inc.
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-02 00:00:00.000000000 Z
+date: 2015-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fixy
@@ -29,14 +29,14 @@ dependencies:
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4'
 - !ruby/object:Gem::Dependency
@@ -137,6 +137,7 @@ files:
 - lib/headache/definitions.rb
 - lib/headache/document.rb
 - lib/headache/formatters.rb
+- lib/headache/record/base.rb
 - lib/headache/record/batch_control.rb
 - lib/headache/record/batch_header.rb
 - lib/headache/record/entry.rb
@@ -165,7 +166,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Take the pain out of building ACH files.