aba 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2156c80e41e17a9df07891a515adff66f0b41412dd83897067a5faa1a598e956
-  data.tar.gz: 853deb00316a156169fd1dbc81b5cea3b666122ff538fc61646fedb5bf44d15a
+  metadata.gz: c71962d082a5f069278f49f74ebeba542179be98dfe151ba74f6d348bee4b1f9
+  data.tar.gz: db6ce6a6b139f5ace5c1f386c779d629937c563e26dc541f97dc2f11734bf12e
 SHA512:
-  metadata.gz: ccb0516b85f0b70af8374f8ef4a3f3effe157dcd19296283a2c274359926e567a9bf7120aad3cf784b4ae027f8bf9e4835edc3c02805d10ebca50d6feec4639e
-  data.tar.gz: fbce1803cff67a9bbff99f6c91720b05e20fc62837e39f6d170438b3f6e3d47972b2f24dcf969788487b65078b0822570f488541091847ae8238d8e9eb7542fd
+  metadata.gz: 0c8bd0f8e21b4a911a439870df82b5663721d696a1d31a7e33fab9b8477c9d254202560c72952d8effc6df8b275653cf64b1b28daac1123f2ed0ac04b8749f1a
+  data.tar.gz: 204e6e3aa265fce388428b9ead10b510a1094d1030af3c19e1b75016fb00c78c510d31af782c24b9e13fabc0658ec28d42eee931f87ebfde3e92b58d18c30976

data/CHANGELOG.md

@@ -1,4 +1,15 @@
-## V1.0.1, 11 January 2021
+# Changelog
+
+## v1.0.2, 25 July 2022
+
+### Added
+
+- Enforce ABA validation:
+  - Amount (in cents) cannot exceed 10 characters.
+  - Total debit amount (in cents) cannot exceed 10 characters.
+  - Total credit amount (in cents) cannot exceed 10 characters.
+
+## v1.0.1, 11 January 2021
 
 ### BUG FIX
 
@@ -8,13 +19,15 @@ Account numbers/alphas validation should be case insensitive
 
 ### BREAKING CHANGES
 
-* Positive (`n`) and negative (`-n`) values are now treated the same.
-  e.g `5` and `-5` are both processed as `5`, without any signage.
-  To differentiate between a debit and credit, use the correct [Transaction Code](https://github.com/andrba/aba/blob/58446f5b0ef822e9792e9399b4af647319b13515/lib/aba/transaction.rb#L106-L112)
-* Removed default values for transactions records to avoid generation of potentially incorrect records. Safety first!
-* Minimum Ruby version is now 2.5
+- Positive (`n`) and negative (`-n`) values are now treated the same. e.g `5`
+  and `-5` are both processed as `5`, without any signage. To differentiate
+  between a debit and credit, use the correct [Transaction
+  Code](https://github.com/andrba/aba/blob/58446f5b0ef822e9792e9399b4af647319b13515/lib/aba/transaction.rb#L106-L112)
+- Removed default values for transactions records to avoid generation of
+  potentially incorrect records. Safety first!
+- Minimum Ruby version is now 2.5
 
 ### NEW FEATURE
 
-* You can now add a *return* record to be used when you'd like to return
-a credit or a debit to another financial institution (OFI).
+- You can now add a *return* record to be used when you'd like to return a
+  credit or a debit to another financial institution (OFI).

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in aba.gemspec

data/Rakefile

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 

data/aba.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)

data/lib/aba/batch.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Aba
   class Batch
     include Aba::Validations
@@ -28,6 +30,9 @@ class Aba
     validates_length      :process_at, 6
     validates_integer     :process_at, false
 
+    # Totals
+    validates_max_length  :debit_total_amount, 10
+    validates_max_length  :credit_total_amount, 10
 
     def initialize(attrs = {}, transactions = [])
       attrs.each do |key, value|
@@ -87,7 +92,10 @@ class Aba
       # Build errors
       all_errors = {}
       all_errors[:aba] = self.error_collection unless self.error_collection.empty?
-      entry_error_collection = entries.each_with_index.map { |t, i| [i, t.error_collection] }.reject { |e| e[1].nil? || e[1].empty? }.to_h
+      entry_error_collection = entries.each_with_index
+        .map { |t, i| [i, t.error_collection] }
+        .reject { |e| e[1].nil? || e[1].empty? }
+        .to_h
       all_errors[:entries] = entry_error_collection unless entry_error_collection.empty?
 
       all_errors unless all_errors.empty?
@@ -165,16 +173,8 @@ class Aba
     end
 
     def batch_control_record
-      credit_total_amount = 0
-      debit_total_amount  = 0
-
-      entries.each do |entry|
-        if entry.debit?
-          debit_total_amount += Integer(entry.amount).abs
-        else
-          credit_total_amount += Integer(entry.amount).abs
-        end
-      end
+      cached_credit_total_amount = credit_total_amount
+      cached_debit_total_amount = debit_total_amount
 
       # Record type
       # Max: 1
@@ -194,17 +194,17 @@ class Aba
       # Net total
       # Max: 10
       # Char position: 21-30
-      output += (credit_total_amount - debit_total_amount).abs.to_s.rjust(10, "0")
+      output += (cached_credit_total_amount - cached_debit_total_amount).abs.to_s.rjust(10, "0")
 
       # Credit Total Amount
       # Max: 10
       # Char position: 31-40
-      output += credit_total_amount.to_s.rjust(10, "0")
+      output += cached_credit_total_amount.to_s.rjust(10, "0")
 
       # Debit Total Amount
       # Max: 10
       # Char position: 41-50
-      output += debit_total_amount.to_s.rjust(10, "0")
+      output += cached_debit_total_amount.to_s.rjust(10, "0")
 
       # Reserved
       # Max: 24
@@ -221,5 +221,17 @@ class Aba
       # Char position: 81-120
       output += " " * 40
     end
+
+    def credit_total_amount
+      credit_total_amount ||= entries.reject(&:debit?).sum(&method(:entry_amount))
+    end
+
+    def debit_total_amount
+      entries.select(&:debit?).sum(&method(:entry_amount))
+    end
+
+    def entry_amount(entry)
+      entry.amount.to_s[/\A\-?\d+\z/] ? Integer(entry.amount).abs : 0
+    end
   end
 end

data/lib/aba/entry.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Aba
   class Entry
     def initialize(attrs = {})

data/lib/aba/return.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Aba
   class Return < Entry
     include Aba::Validations

data/lib/aba/transaction.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Aba
   class Transaction < Entry
     include Aba::Validations
@@ -20,6 +22,7 @@ class Aba
 
     # Amount
     validates_integer           :amount
+    validates_max_length        :amount, 10
 
     # Account Name
     validates_max_length        :account_name, 32

data/lib/aba/validations.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Aba
   module Validations
     attr_accessor :error_collection

data/lib/aba/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Aba
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

data/lib/aba.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "aba/version"
 require "aba/validations"
 require "aba/entry"

data/spec/lib/aba/batch_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # encoding: UTF-8
 
 require "spec_helper"
@@ -129,5 +131,31 @@ describe Aba::Batch do
         expect(batch.errors).to eq(:entries => { 1 => ["amount must be a number"], 2 => ["amount must be a number"] })
       end
     end
+
+    context "with an invalid credit total (exceeding 10 characters)" do
+      let(:transactions_attributes) do
+        [
+          {amount: 9999999999, transaction_code: 50},
+          {amount: 9999999999, transaction_code: 50},
+        ]
+      end
+
+      it "reports the errors" do
+        expect(batch.errors).to include(aba: ["credit_total_amount length must not exceed 10 characters"])
+      end
+    end
+
+    context "with an invalid debit total amount (exceeding 10 characters)" do
+      let(:transactions_attributes) do
+        [
+          {amount: 9999999999, transaction_code: 13},
+          {amount: 9999999999, transaction_code: 13},
+        ]
+      end
+
+      it "reports the errors" do
+        expect(batch.errors).to include(aba: ["debit_total_amount length must not exceed 10 characters"])
+      end
+    end
   end
 end

data/spec/lib/aba/return_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # encoding: UTF-8
 
 require "spec_helper"

data/spec/lib/aba/transaction_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # encoding: UTF-8
 
 require "spec_helper"
@@ -42,10 +44,31 @@ describe Aba::Transaction do
       expect(subject.valid?).to eq true
     end
 
-    it "should not be valid" do
-      transaction_params.delete(:bsb)
-      expect(subject.valid?).to eq false
-      expect(subject.errors).to eq ["bsb format is incorrect"]
+    context "without bsb param" do
+      before do
+        transaction_params.delete(:bsb)
+      end
+
+      it "is invalid" do
+        expect(subject.valid?).to eq false
+        expect(subject.errors).to eq ["bsb format is incorrect"]
+      end
+    end
+
+    describe ":amount" do
+      subject(:transaction) { Aba::Transaction.new(transaction_params.merge(amount: amount)) }
+
+      context "with 10 digits" do
+        let(:amount) { "1234567890" }
+
+        it { is_expected.to be_valid }
+      end
+
+      context "with 11 digits" do
+        let(:amount) { "12345678901" }
+
+        it { is_expected.not_to be_valid }
+      end
     end
   end
 end

data/spec/lib/aba/validations_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # encoding: UTF-8
 
 require "spec_helper"

data/spec/lib/aba_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # encoding: UTF-8
 
 require "spec_helper"

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/setup'
 Bundler.setup
 

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: aba
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Andrey Bazhutkin
 - Trevor Wistaff
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-11 00:00:00.000000000 Z
+date: 2022-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -87,7 +87,7 @@ homepage: https://github.com/andrba/aba
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -102,8 +102,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: ABA File Generator
 test_files: