nacha 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1411753b1afc7c81a9e3875ec1541986d8b461afd5d0daae835879d17776ea7c
+  data.tar.gz: 38fbcd4d7e222177dfc8bdce195991d13716ae669ca4649a7cf4e3428ab646d0
+SHA512:
+  metadata.gz: 34e0fe3b791e0a47f9bef29898815b5d7fccac762ec21cbf227e3896a6dc8933d0a68349ff4cd661a65bff4f886b68fd22a31236dfdc6984d21c27b83d12d295
+  data.tar.gz: 2f53f2b8ed728dc2778a1c78461fefb8dd22ddd8fe5d8ccefad1deff50931924e11af55b4a5edcbe1880455de7019b3434a0a42ceff8c12f99a3d8bdc75ac14e

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.byebug_history

data/.gitlab-ci.yml

@@ -0,0 +1,13 @@
+image: "ruby:2.5"
+
+before_script:
+  - apt-get update -qq && apt-get install -y -qq sqlite3 libsqlite3-dev
+  - ruby -v
+  - which ruby
+  - gem install bundler --no-document
+  - bundle install --jobs $(nproc)  "${FLAGS[@]}"
+
+rspec:
+  script:
+    - bundle exec rspec
+    - bundle exec rubocop

data/.rspec

@@ -0,0 +1,2 @@
+--format progress
+--color

data/.rubocop.yml

@@ -0,0 +1,42 @@
+inherit_gem:
+  gitlab-styles:
+    - rubocop-default.yml
+
+AllCops:
+  TargetRubyVersion: 2.5
+  Exclude:
+    - 'tmp/**/*'
+    - 'bin/**/*'
+  CacheRootDirectory: tmp
+
+# This cop checks whether some constant value isn't a
+# mutable literal (e.g. array or hash).
+Style/MutableConstant:
+  Enabled: true
+
+Style/SafeNavigation:
+  Enabled: false
+
+# Frozen String Literal
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  Exclude:
+    - 'Gemfile'
+    - 'Rakefile'
+    - 'spec/**/*'
+
+Metrics/LineLength:
+  Max: 92
+
+Naming/FileName:
+  ExpectMatchingDefinition: true
+  Exclude:
+    - 'spec/**/*'
+
+  IgnoreExecutableScripts: true
+
+Layout/LeadingCommentSpace:
+  Enabled: false
+
+Style/Encoding:
+  Enabled: false

data/.ruby-gemset

@@ -0,0 +1 @@
+nacha

data/.ruby-version

@@ -0,0 +1 @@
+2.4

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.14.6

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in nacha.gemspec
+gemspec
+
+gem 'pry-byebug', group: %i[development test]
+gem 'pry-highlight', group: %i[development test]
+gem 'pry-remote', group: %i[development test]
+gem 'pry-stack_explorer', group: %i[development test]

data/Guardfile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+  watch(%r{^lib/nacha/base_record\.rb}) { Dir.glob('spec/nacha/record_types/*_spec.rb') }
+  watch(%r{^lib/config/definitions/(.+)\.yml}) { |m| "spec/nacha/record_types/#{m[1]}_spec.rb" }
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 David H. Wilkins
+
+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,75 @@
+# Nacha
+
+Validating Ruby ACH parser and generator
+
+Format documentation here: http://achrulesonline.org/
+
+The definition of the records exactly mirrors the NACHA documentation so that
+development and business can use the same terminology.
+
+Work in progress - contributors welcome.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nacha'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nacha
+
+## Usage
+
+API may change at any time.   Pull requests welcomed
+
+
+`"101 124000054 1240000540907021214A094101ZIONS FIRST NATIONAL BAZIONS FIRST NATIONAL BA       1"`
+
+```ruby
+    ach_records = Nacha.parse(ach_file)
+
+    ach_records[0].class  # => Nacha::Record::FileHeaderRecord
+
+    ach_records[0].to_json
+```
+```json
+{
+  "record_type_code": "1",
+  "priority_code": 1,
+  "immediate_destination": "124000054",
+  "immediate_origin": "124000054",
+  "file_creation_date": "2009-07-02",
+  "file_creation_time": "1214",
+  "file_id_modifier": "A",
+  "record_size": "094",
+  "blocking_factor": "10",
+  "format_code": "1",
+  "immediate_destination_name": "ZIONS FIRST NATIONAL BA",
+  "immediate_origin_name": "ZIONS FIRST NATIONAL BA",
+  "reference_code": "       1"
+}
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/dwilkins/nacha.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/ROADMAP.md

@@ -0,0 +1,56 @@
+- [x] Define All Record Types
+  - [x] AdvBatchControlRecord
+  - [x] AdvEntryDetailRecord
+  - [x] AdvFileControlRecord
+  - [x] AdvFileHeaderRecord
+  - [x] ArcEntryDetailRecord
+  - [x] BatchControlRecord
+  - [x] BatchHeaderRecord
+  - [x] BocEntryDetailRecord
+  - [x] CcdAddendaRecord
+  - [x] CcdEntryDetailRecord
+  - [x] CieAddendaRecord
+  - [x] CieEntryDetailRecord
+  - [x] CtxAddendaRecord
+  - [x] CtxCorporateEntryDetailRecord
+  - [x] DneAddendaRecord
+  - [x] DneEntryDetailRecord
+  - [x] EnrAddendaRecord
+  - [x] EnrEntryDetailRecord
+  - [x] FileControlRecord
+  - [x] FileHeaderRecord
+  - [x] IatBatchHeaderRecord
+  - [x] IatEntryDetailRecord
+  - [x] FirstIatAddendaRecord
+  - [x] SecondIatAddendaRecord
+  - [x] ThirdIatAddendaRecord
+  - [x] FourthIatAddendaRecord
+  - [x] FifthIatAddendaRecord
+  - [x] SixthIatAddendaRecord
+  - [x] SeventhIatAddendaRecord
+  - [x] IatForeignCoorespondentBankInformationAddendaRecord
+  - [x] IatRemittanceInformationAddendaRecord
+  - [x] IatBatchHeaderRecord
+  - [x] MteAddendaRecord
+  - [x] MteEntryDetailRecord
+  - [x] PopEntryDetailRecord
+  - [x] PosAddendaRecord
+  - [x] PosEntryDetailRecord
+  - [x] PpdAddendaRecord
+  - [x] PpdEntryDetailRecord
+  - [x] RckEntryDetailRecord
+  - [x] ShrAddendaRecord
+  - [x] ShrEntryDetailRecord
+  - [x] TelEntryDetailRecord
+  - [x] TrcEntryDetailRecord
+  - [x] TrxAddendaRecord
+  - [x] TrxEntryDetailRecord
+  - [x] WebAddendaRecord
+  - [x] WebEntryDetailRecord
+  - [x] XckEntryDetailRecord
+- [ ] Debug / Inspection
+- [ ] Field Validations
+- [ ] Record Validations
+- [ ] Implement record order logic
+  - [ ] Establish child record types
+  - [ ] Establish possible next record type

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "nacha"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/nacha/aba_number.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+class Nacha::AbaNumber
+  attr_reader :routing_number
+  attr_reader :aba_number
+
+  def initialize(routing_number)
+    self.routing_number = routing_number
+  end
+
+  def compute_check_digit
+    n = @routing_number.to_s.strip.ljust(8, '0').chars.collect(&:to_i)
+    sum = (3 * (n[0] + n[3] + n[6])) +
+      (7 * (n[1] + n[4] + n[7])) +
+      (n[2] + n[5])
+    intermediate = (sum % 10)
+    intermediate.zero? ? '0' : (10 - intermediate).to_s
+  end
+
+  def routing_number=(val)
+    @valid = nil
+    @routing_number = val.strip
+  end
+
+  def add_check_digit
+    @routing_number = @routing_number[0..7] + compute_check_digit
+  end
+
+  def check_digit
+    @routing_number.chars[8] if @routing_number.length == 9 && compute_check_digit == @routing_number.chars[8]
+  end
+
+  def valid?
+    @valid ||= (@routing_number.length == 9 && compute_check_digit == @routing_number.chars[8])
+  end
+
+  def to_s(with_checkdigit = true)
+    if with_checkdigit
+      @routing_number
+    else
+      @routing_number[0..7]
+    end
+  end
+end

data/lib/nacha/ach_date.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'date'
+# A Date object to handle some of the Ach formatted dates
+
+class Nacha::AchDate < Date
+  def self.new(date_str)
+    if date_str.is_a? String
+      strptime(date_str, '%y%m%d')
+    elsif date_str.is_a? Date
+      date_str.dup
+    else
+      super(date_str)
+    end
+  end
+
+  def to_s
+    strftime('%y%m%d')
+  end
+
+  def valid?
+    !nil?
+  end
+end

data/lib/nacha/field.rb

@@ -0,0 +1,139 @@
+# coding: utf-8
+require 'pry'
+require 'bigdecimal'
+require 'nacha/numeric'
+require 'nacha/aba_number'
+require 'nacha/ach_date'
+
+class Nacha::Field
+
+  attr_accessor :inclusion, :contents, :position
+  attr_accessor :data, :name, :errors
+  attr_reader  :input_data
+  attr_reader :data_type
+  attr_reader :validator
+  attr_reader :justification
+  attr_reader :fill_character
+  attr_reader :output_conversion
+  attr_reader :json_output
+
+  def initialize opts = {}
+    @data_type = String
+    @errors = []
+    @name = 'Unknown'.freeze
+    @justification = :ljust
+    @fill_character =  ' '.freeze
+    @json_output = [:to_s]
+    @output_conversion = [:to_s]
+    opts.each do |k,v|
+      setter = "#{k}="
+      if(respond_to?(setter))
+        send(setter, v) unless v.nil?
+      end
+    end
+  end
+
+  # CXXX Constant
+  #
+  def contents= val
+    @contents = val
+    case @contents
+    when /\AC(.*)\z/  # Constant
+      @data = $1
+    when /Numeric/
+      @data_type = Nacha::Numeric
+      @justification = :rjust
+      @json_output = [[:to_i]]
+      @output_conversion = [:to_i]
+      @fill_character = '0'.freeze
+    when /.?TTTTAAAAC/
+      @data_type = Nacha::AbaNumber
+      @validator = :valid?
+      @justification = :rjust
+      @output_conversion = [:to_s]
+      @fill_character = ' '.freeze
+    when 'YYMMDD'
+      @data_type = Nacha::AchDate
+      @justification = :rjust
+      @validator = :valid?
+      @json_output = [[:iso8601]]
+      @output_conversion = [:to_s]
+      @fill_character = ' '.freeze
+    when 'Alphameric'
+      @data_type = String
+      @justification = :ljust
+      @output_conversion = [:to_s]
+      @fill_character = ' '.freeze
+    when /\$+\¢\¢/
+      @data_type = Nacha::Numeric
+      @justification = :rjust
+      @json_output = [[:to_i],[:/,100.0]]
+      @output_conversion = [:to_i]
+      @fill_character = '0'.freeze
+    end
+  end
+
+  def data= val
+    @data = @data_type.new(val)
+    @input_data = val
+  end
+
+  def mandatory?
+    @inclusion == 'M'.freeze
+  end
+
+  def required?
+    @inclusion == 'R'.freeze
+  end
+
+  def optional?
+    @inclusion == 'O'.freeze
+  end
+
+  def valid?
+    @valid = inclusion && contents && position
+    if(@validator && @data)
+      @valid &&= @data.send(@validator)
+    end
+    @valid
+  end
+
+  def add_error err_string
+    errors << err_string
+  end
+
+  def self.unpack_str(definition = {  })
+    if(definition[:contents] =~ /(Numeric|\$+\¢\¢)/)
+      'a'.freeze
+    else
+      'A'.freeze
+    end + definition[:position].size.to_s
+  end
+
+  def to_ach
+    str = to_s
+    fill_char = @fill_character
+    fill_char = ' '.freeze unless str
+    str ||= ''.freeze
+    str.send(justification,position.count, fill_char)
+  end
+
+  def to_json_output
+    if(@json_output)
+      @json_output.reduce(@data) { |output, operation|
+        output = output.send(*operation) if output
+      }
+    else
+      to_s
+    end
+  end
+
+  def to_s
+    @data.send(*output_conversion).to_s
+  end
+
+  def raw
+    @data
+  end
+
+end

data/lib/nacha/numeric.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+class Nacha::Numeric
+  attr_accessor :value
+  def initialize(val = nil)
+    self.value = val
+  end
+
+  def to_i
+    if @value
+      if @value.is_a?(String) && @value.match(/ */)
+        self
+      else
+        @value.to_i
+      end
+    else
+      self
+    end
+  end
+
+  def value=(val)
+    if val.is_a?(String)
+      @value = val.dup
+      if !val.strip.empty?
+        @value = BigDecimal(val.strip)
+        @op_value = @value
+      else
+        @op_value = BigDecimal(0)
+      end
+    else
+      @value = BigDecimal(val)
+      @op_value = @value
+    end
+    @value
+  end
+
+  def to_s
+    @value ? @value.to_s : nil
+  end
+
+  def respond_to?(method_name, include_private = false)
+    puts "In respond_to? #{method_name}"
+    @op_value.respond_to? method_name
+  end
+
+  # @op_value is the value for operations.   @value may still be a string
+  # from the input data.   If an operation is attempted, then @op_value
+  # should be checked to see if the operation is valid for it, not
+  # necessarily the potentially string @value
+  def method_missing(method_name, *args, &block)
+    puts "In method_missing for #{method_name} value_class = #{@value.class}, op_value_class = #{@op_value.class}"
+    if @op_value.respond_to? method_name
+      old_op_value = @op_value.dup
+      if /!\z/.match?(method_name.to_s)
+        @op_value.send(method_name, *args, &block)
+        return_value = @op_value
+      else
+        return_value = @op_value.send(method_name, *args, &block)
+      end
+      if old_op_value != return_value
+        @value = return_value
+        @op_value = return_value
+      end
+      @value
+    else
+      super
+    end
+  end
+end

data/lib/nacha/parser.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require 'nacha'
+
+class Nacha::Parser
+  DEFAULT_RECORD_TYPES = ['Nacha::Record::FileHeader'].freeze
+  def initialize
+    reset!
+  end
+
+  def reset!; end
+
+  def parse_file(file)
+    parent = nil
+    records = []
+    File.foreach(file).with_index do |line, line_num|
+      records << process(line, line_num, records.last)
+      parent = records.last if records.lasts.class.child_record_types.any?
+    end
+  end
+
+  def parse_string(str)
+    line_num = -1
+    records = []
+    str.scan(/.{94}/).each do |line|
+      line_num += 1
+      records << process(line, line_num, records.last)
+    end.compact
+    records
+  end
+
+  def process(line, line_num, previous = nil)
+    parent = previous
+    record = nil
+
+    record_types = valid_record_types(parent)
+    while record_types
+      record = parse_by_types(line, record_types)
+      break if record || !parent
+
+      parent = parent.parent
+      record_types = valid_record_types(parent)
+    end
+    add_child(parent, record)
+    record
+  end
+
+  def valid_record_types(parent)
+    return DEFAULT_RECORD_TYPES unless parent && parent.respond_to?(:child_record_types)
+
+    parent.child_record_types
+  end
+
+  def add_child(parent, child)
+    return unless parent && child
+
+    parent.children << child
+    child.parent = parent
+  end
+
+  def parse_by_types(line, record_types)
+    record_types.detect do |rt|
+      record_type = Object.const_get(rt)
+      return record_type.parse(line) if record_type.matcher =~ line
+    end
+  end
+end

data/lib/nacha/record/addenda_record_type.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Nacha
+  module Record
+    module AddendaRecordType
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        def child_record_types
+          []
+        end
+
+        def self.next_record_types
+          []
+        end
+      end
+
+      def child_record_types
+        self.class.child_record_types
+      end
+
+      def next_record_types
+        self.class.next_record_types
+      end
+    end
+  end
+end