bai2 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b83aa7ebed34d3059973ec3d76e15f1e32d05814
-  data.tar.gz: fe4bec1ec7552da50e366d60113819c817dd92af
+  metadata.gz: 975f734808bc96fce7ca38c08e1ba90e8839b8c6
+  data.tar.gz: 99d17eec7002b0b0c6ca70b9a3228f2500efadc5
 SHA512:
-  metadata.gz: 1c318047c59369b2f709189e7efcbde12cc323368da2614e1b9d49d462be44f8a2f490e0b80c700aadb909001449640b0a1eaa4de09cd70d2b860d3f3fb2407e
-  data.tar.gz: 0eab9ce6627092f68b1749f2e2202f472706543c6728c578c8d8f6e490f2f06e759dff37ba7b3001e54059878ac53e68cd63a91b0532ba2a19b1e5eeb8e138ad
+  metadata.gz: bdd5385fe33114722442f33838c2bab6406cfc41ab7a1e3125bd09bf1d269e351e57008090da8ccb34b6ae11edefd4ec222cf9ae7fad32edcd3fb86a9b18bb6e
+  data.tar.gz: eb2228fdfaaba4856d141508995809e7ecc0235de2b6437206faa774c9382c469486ae9a001be4a2398746882a697b59936fd01aad5cf1713382159c6eed3ed7

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+Changelog
+
+## 2.0.0
+- Add parameters for whether or not we use account summaries for account control checksum. We now include it by default. To disable it `account_control_ignores_summary_amounts` should passed into `options` This is the only breaking change.
+- Allow for optional "as of" times on the Group header.
+
+## 1.0.0
+- Initial Release

data/README.md

@@ -75,6 +75,26 @@ file.groups.filter {|g| g.destination == YourOrgId }.each do |group|
   end
 end
 ```
+## Options
+`Bai2::BaiFile.parse` and `Bai2::BaiFile.new` accept an optional second parameter, `options`.
+
+* `options[:account_control_ignores_summary_amounts]` (Boolean, Default: False)
+See [Caveats](#caveats) below. Optionally ignores the amounts in the account summary fields when calculating the account control checksum.
+This value should be set only if you know that your bank uses this nonstandard calculation for
+account control values.
+
+* `options[:num_account_summary_continuation_records]` (Integer, Default: 0)
+The number of continuation records the account summary.
+
+
+##### Usage:
+
+```ruby
+Bai2::BaiFile.new(string_data,
+                  account_control_ignores_summary_amounts: true,
+                  num_account_summary_continuation_records: 3)
+```
+
 
 ## Caveats
 
@@ -85,11 +105,13 @@ just an SVB quirk. I would love to hear how other banks do this. GitHub Issues
 with more information on this would be greatly appreciated.
 
 ```ruby
-# Check sum vs. summary + transaction sums
-actual_sum = self.transactions.map(&:amount).reduce(0, &:+) \
-  #+ self.summaries.map {|s| s[:amount] }.reduce(0, &:+)
-  # TODO: ^ there seems to be a disconnect between what the spec defines
-  # as the formula for the checksum and what SVB implements...
+# Some banks differ from the spec (*cough* SVB) and do not include
+# the summary amounts in the control amount.
+actual_sum = if options[:account_control_ignores_summary_amounts]
+               transaction_amounts_sum
+             else
+               transaction_amounts_sum + summary_amounts_sum
+             end
 ```
 
 

data/lib/bai2.rb

@@ -11,12 +11,17 @@ module Bai2
   #
   class BaiFile
 
+    DEFAULT_OPTIONS = {
+      account_control_ignores_summary_amounts: false,
+      num_account_summary_continuation_records: 0
+    }.freeze
+
     # Parse a file on disk:
     #
     #   f = BaiFile.parse('myfile.bai2')
     #
-    def self.parse(path)
-      self.new(File.read(path))
+    def self.parse(path, options = {})
+      self.new(File.read(path), options)
     end
 
 
@@ -24,9 +29,10 @@ module Bai2
     #
     #   f = BaiFile.new(bai2_data)
     #
-    def initialize(raw)
+    def initialize(raw, options = {})
       @raw = raw
       @groups = []
+      @options = DEFAULT_OPTIONS.merge(options)
       parse(raw)
     end
 

data/lib/bai2/integrity.rb

@@ -36,12 +36,14 @@ module Bai2
       end
 
       # Run children assertions, which return number of records. May raise.
-      records = self.groups.map {|g| g.send(:assert_integrity!) }.reduce(0, &:+)
+      records = self.groups.map {|g| g.send(:assert_integrity!, @options) }.reduce(0, &:+)
 
-      unless expectation[:records] == (actual = records + 2)
+      unless expectation[:records] == (actual_num_records = records + 2)
         raise IntegrityError.new(
-          "Record count invalid: file: #{expectation[:records]}, groups: #{actual}")
+          "Record count invalid: file: #{expectation[:records]}, groups: #{actual_num_records}")
       end
+
+      actual_num_records
     end
 
 
@@ -53,7 +55,7 @@ module Bai2
 
       # Asserts integrity of a fully-parsed BaiFile by calculating checksums.
       #
-      def assert_integrity!
+      def assert_integrity!(options)
         expectation = {
           sum:      @trailer[:group_control_total],
           children: @trailer[:number_of_accounts],
@@ -77,15 +79,15 @@ module Bai2
         end
 
         # Run children assertions, which return number of records. May raise.
-        records = self.accounts.map {|a| a.send(:assert_integrity!) }.reduce(0, &:+)
+        records = self.accounts.map {|a| a.send(:assert_integrity!, options) }.reduce(0, &:+)
 
-        unless expectation[:records] == (actual = records + 2)
+        unless expectation[:records] == (actual_num_records = records + 2)
           raise IntegrityError.new(
-            "Record count invalid: group: #{expectation[:records]}, accounts: #{actual}")
+            "Record count invalid: group: #{expectation[:records]}, accounts: #{actual_num_records}")
         end
 
         # Return record count
-        records + 2
+        actual_num_records
       end
     end
 
@@ -93,17 +95,23 @@ module Bai2
     class Account
       private
 
-      def assert_integrity!
+      def assert_integrity!(options)
         expectation = {
           sum:      @trailer[:account_control_total],
           records:  @trailer[:number_of_records],
         }
 
         # Check sum vs. summary + transaction sums
-        actual_sum = self.transactions.map(&:amount).reduce(0, &:+) \
-          #+ self.summaries.map {|s| s[:amount] }.reduce(0, &:+)
-          # TODO: ^ there seems to be a disconnect between what the spec defines
-          # as the formula for the checksum and what SVB implements...
+        summary_amounts_sum = self.summaries.map {|s| s[:amount] }.reduce(0, &:+)
+        transaction_amounts_sum = self.transactions.map(&:amount).reduce(0, &:+)
+
+        # Some banks differ from the spec (*cough* SVB) and do not include
+        # the summary amounts in the control amount.
+        actual_sum = if options[:account_control_ignores_summary_amounts]
+                       transaction_amounts_sum
+                     else
+                       transaction_amounts_sum + summary_amounts_sum
+                     end
 
         unless expectation[:sum] == actual_sum
           raise IntegrityError.new(
@@ -115,13 +123,19 @@ module Bai2
           tx.instance_variable_get(:@record).physical_record_count
         end.reduce(0, &:+)
 
-        unless expectation[:records] == (actual = records + 2)
-          raise IntegrityError.new("Record count invalid: " \
-            + "account: #{expectation[:records]}, transactions: #{actual}")
+        # Account for the account header and the account trailer records
+        # and any additional summary records (Some banks use continuation records
+        # for account summaries, others put the summary data on the same row as the header)
+        additional_records = 2 + options[:num_account_summary_continuation_records]
+        actual_num_records = records + additional_records
+
+        unless expectation[:records] == actual_num_records
+          raise IntegrityError.new(
+              "Record count invalid: account: #{expectation[:records]}, transactions: #{actual_num_records}")
         end
 
         # Return record count
-        records + 2
+        actual_num_records
       end
     end
   end

data/lib/bai2/record.rb

@@ -30,7 +30,7 @@ module Bai2
 
     # Returns a time interval in seconds, to be added to the date
     ParseMilitaryTime = -> (v) do
-      v = '2400' if v == '9999'
+      v = '2400' if (v == '' || v == '9999')
       Time.strptime("#{v} utc", '%H%M %Z').to_i % 86400
     end
 

data/lib/bai2/version.rb

@@ -1,3 +1,3 @@
 module Bai2
-  VERSION = '1.0.0'
+  VERSION = '2.0.0'
 end

data/test/data/daily_with_summary.bai2

@@ -0,0 +1,11 @@
+01,121140399,9999999999,050608,1015,1,80,1,2/
+02,9999999999,121140399,1,050607,1015,,2/
+03,1234567890,USD,010,000,,,015,000,,/
+88,040,000,,,045,000,,/
+88,072,000,,,074,000,,/
+88,100,25001,17,,400,000,0,/
+16,174,25001,Z,,50848,/
+88,SAMPLE CONTINUATION TEXT,/
+49,50002,7/
+98,50002,1,9/
+99,50002,1,11/

data/test/data/eod_without_as_of_time.bai2

@@ -0,0 +1,17 @@
+01,121140399,3333333333,100831,1720,000001,80,1,2/
+02,3333333333,121140399,1,100831,,USD,4/
+03,3333333333,USD,,,,/
+16,195,8325982,,,,FED NO: 20100831L1B77D1CDSDSDJSIO15608310954FT01
+88,SENDER BNK:=ETRADE BANK
+88,SENDER ID:=056073573
+88,ORG:=OPTIONS LINK WIRE CLEARING
+88,ORG ADDRESS:=1995 SE. 57TH ST. NY, NY 10022
+88,BNF ID:=3300333333
+88,BNF NAME:=YOUR NAME HERE INC
+88,BNF ADDRESS:=185 B ST SAN FRAN, CA 94011
+88,REC FI:=SIL VLY BK SCLA
+88,REC ID:=121140399
+88,OBI:=INVOICE 123456
+49,8325982,13/
+98,8325982,1,15/
+99,8325982,1,17/

data/test/data/invalid_checksum_eod.bai2

@@ -0,0 +1,17 @@
+01,121140399,3333333333,100831,1720,000001,80,1,2/
+02,3333333333,121140399,1,100831,1720,USD,4/
+03,3333333333,USD,,,,/
+16,195,8325982,,,,FED NO: 20100831L1B77D1CDSDSDJSIO15608310954FT01
+88,SENDER BNK:=ETRADE BANK
+88,SENDER ID:=056073573
+88,ORG:=OPTIONS LINK WIRE CLEARING
+88,ORG ADDRESS:=1995 SE. 57TH ST. NY, NY 10022
+88,BNF ID:=3300333333
+88,BNF NAME:=YOUR NAME HERE INC
+88,BNF ADDRESS:=185 B ST SAN FRAN, CA 94011
+88,REC FI:=SIL VLY BK SCLA
+88,REC ID:=121140399
+88,OBI:=INVOICE 123456
+49,8325983,13/
+98,8325983,1,15/
+99,8325983,1,17/

data/test/tests/bai2.rb

@@ -6,16 +6,23 @@ class Bai2Test < Minitest::Test
 
   def setup
     @daily = Bai2::BaiFile.parse(File.expand_path('../../data/daily.bai2', __FILE__))
+    @daily_with_summary = Bai2::BaiFile.parse(File.expand_path('../../data/daily_with_summary.bai2', __FILE__),
+                                              num_account_summary_continuation_records: 3)
+
     @eod = Bai2::BaiFile.parse(File.expand_path('../../data/eod.bai2', __FILE__))
+    @eod_no_as_of_time = Bai2::BaiFile.parse(File.expand_path('../../data/eod_without_as_of_time.bai2', __FILE__))
+
+    @all_files = [@daily, @daily_with_summary, @eod, @eod_no_as_of_time]
   end
 
   def test_parsing
-    assert_kind_of(Bai2::BaiFile, @daily)
-    assert_kind_of(Bai2::BaiFile, @eod)
+    @all_files.each do |file|
+      assert_kind_of(Bai2::BaiFile, file)
+    end
   end
 
   def test_groups
-    [@daily, @eod].each do |file|
+    @all_files.each do |file|
       assert_kind_of(Array, file.groups)
       assert_equal(1, file.groups.count)
       group = file.groups.first
@@ -27,8 +34,8 @@ class Bai2Test < Minitest::Test
   end
 
   def test_accounts
-    [@daily, @eod].each do |file|
-      accounts = @daily.groups.first.accounts
+    @all_files.each do |file|
+      accounts = file.groups.first.accounts
       assert_kind_of(Array, accounts)
       assert_equal(1, accounts.count)
       assert_kind_of(Bai2::BaiFile::Account, accounts.first)
@@ -56,4 +63,15 @@ class Bai2Test < Minitest::Test
     })
   end
 
+  def test_integrity
+    assert_raises Bai2::BaiFile::IntegrityError do
+      # Calling without the options: num_account_summary_continuation_records => 3 should raise an error
+      Bai2::BaiFile.parse(File.expand_path('../../data/daily_with_summary.bai2', __FILE__))
+    end
+    assert_raises Bai2::BaiFile::IntegrityError do
+      # An invalid amount checksum should raise an error
+      Bai2::BaiFile.parse(File.expand_path('../../data/invalid_checksum_eod.bai2', __FILE__))
+    end
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bai2
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Kenneth Ballenegger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-20 00:00:00.000000000 Z
+date: 2019-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -74,6 +74,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -88,7 +89,10 @@ files:
 - lib/bai2/version.rb
 - test/autorun.rb
 - test/data/daily.bai2
+- test/data/daily_with_summary.bai2
 - test/data/eod.bai2
+- test/data/eod_without_as_of_time.bai2
+- test/data/invalid_checksum_eod.bai2
 - test/tests/bai2.rb
 - test/tests/parsing.rb
 homepage: https://github.com/venturehacks/bai2
@@ -111,14 +115,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: Parse BAI2 files.
 test_files:
 - test/autorun.rb
 - test/data/daily.bai2
+- test/data/daily_with_summary.bai2
 - test/data/eod.bai2
+- test/data/eod_without_as_of_time.bai2
+- test/data/invalid_checksum_eod.bai2
 - test/tests/bai2.rb
 - test/tests/parsing.rb
-has_rdoc: