aba 0.5.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7d2996812bbfd9d6386cef252e680024545ad59b01eec0d6645d8cf75dafe6a
-  data.tar.gz: 584aad9a1c2b922680da873f1a95922dfa4864c5e54ac979d6ed6f5eb01e3094
+  metadata.gz: c71962d082a5f069278f49f74ebeba542179be98dfe151ba74f6d348bee4b1f9
+  data.tar.gz: db6ce6a6b139f5ace5c1f386c779d629937c563e26dc541f97dc2f11734bf12e
 SHA512:
-  metadata.gz: 4be17e99ad4fedbb404bb2305e0a310afafc96c0f2b39f57f49d76b198e7018a7fc9997b35441d2209bce37986487d683fcfd5f20d049acea8581804669ecc8b
-  data.tar.gz: b09e75f48ce6ddab89dc0fc82f1d9be3a87f573db08591d65158203b2b1a4d1ae6c3ec6cbf34437d1c4d15842e4e93f07f75977bbf5ac063338fbd2dc519a177
+  metadata.gz: 0c8bd0f8e21b4a911a439870df82b5663721d696a1d31a7e33fab9b8477c9d254202560c72952d8effc6df8b275653cf64b1b28daac1123f2ed0ac04b8749f1a
+  data.tar.gz: 204e6e3aa265fce388428b9ead10b510a1094d1030af3c19e1b75016fb00c78c510d31af782c24b9e13fabc0658ec28d42eee931f87ebfde3e92b58d18c30976

data/CHANGELOG.md

@@ -0,0 +1,33 @@
+# 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
+
+Account numbers/alphas validation should be case insensitive
+
+## v1.0.0, 12 July 2020
+
+### 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
+
+### 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).

data/Gemfile

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

data/README.md

@@ -65,28 +65,29 @@ There are a few ways to create a complete set of ABA data:
 ```ruby
 # Transactions added to the defined ABA object variable
 aba = Aba.batch financial_institution: 'ANZ', user_name: 'Joe Blow', user_id: 123456, process_at: 200615
-aba.add_transaction bsb: '123-456', account_number: '000-123-456', amount: 50000
-aba.add_transaction bsb: '456-789', account_number: '123-456-789', amount: '-10000', transaction_code: 13
+aba.add_transaction bsb: '123-456', account_number: '000-123-456', amount: 50000, transaction_code: 50
+aba.add_transaction bsb: '456-789', account_number: '123-456-789', amount: 10000, transaction_code: 13
 
 # Transactions passed individually inside a block
 aba = Aba.batch financial_institution: 'ANZ', user_name: 'Joe Blow', user_id: 123456, process_at: 200615 do |a|
-  a.add_transaction bsb: '123-456', account_number: '000-123-456', amount: 50000
-  a.add_transaction bsb: '456-789', account_number: '123-456-789', amount: '-10000', transaction_code: 13
+  a.add_transaction bsb: '123-456', account_number: '000-123-456', amount: 50000, transaction_code: 50
+  a.add_transaction bsb: '456-789', account_number: '123-456-789', amount: 10000, transaction_code: 13
 end
 
 # Transactions as an array passed to the second param of Aba.batch
 aba = Aba.batch(
   { financial_institution: 'ANZ', user_name: 'Joe Blow', user_id: 123456, process_at: 200615 },
   [
-    { bsb: '123-456', account_number: '000-123-456', amount: 50000 },
-    { bsb: '456-789', account_number: '123-456-789', amount: '-10000', transaction_code: 13 }
+    { bsb: '123-456', account_number: '000-123-456', amount: 50000, transaction_code: 50 },
+    { bsb: '456-789', account_number: '123-456-789', amount: 10000, transaction_code: 13 }
   ]
 )
-
-# NOTE: Be careful with negative transaction amounts! transaction_code will not
-#       be set to debit automatically!
 ```
 
+> **Note:** 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)
+
 Validation errors can be caught in several ways:
 
 ```ruby

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)
@@ -18,9 +20,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "pry", "~> 0.13"
   spec.add_development_dependency "rspec", "~> 3.0"
 
   spec.required_ruby_version = '>= 2.5.0'

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,15 +173,8 @@ class Aba
     end
 
     def batch_control_record
-      net_total_amount    = 0
-      credit_total_amount = 0
-      debit_total_amount  = 0
-
-      entries.each do |t|
-        net_total_amount += t.amount.to_i
-        credit_total_amount += t.amount.to_i if t.amount.to_i > 0
-        debit_total_amount += t.amount.to_i if t.amount.to_i < 0
-      end
+      cached_credit_total_amount = credit_total_amount
+      cached_debit_total_amount = debit_total_amount
 
       # Record type
       # Max: 1
@@ -193,17 +194,17 @@ class Aba
       # Net total
       # Max: 10
       # Char position: 21-30
-      output += net_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.abs.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.abs.to_s.rjust(10, "0")
+      output += cached_debit_total_amount.to_s.rjust(10, "0")
 
       # Reserved
       # Max: 24
@@ -220,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 = {})
@@ -7,11 +9,11 @@ class Aba
     end
 
     def credit?
-      (50..57).include?(transaction_code.to_i)
+      Validations::CREDIT_TRANSACTION_CODES.include?(transaction_code.to_i)
     end
 
     def debit?
-      transaction_code.to_i == 13
+      Validations::DEBIT_TRANSACTION_CODES.include?(transaction_code.to_i)
     end
   end
 end

data/lib/aba/return.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Aba
   class Return < Entry
     include Aba::Validations
@@ -20,7 +22,7 @@ class Aba
     validates_transaction_code  :transaction_code
 
     # Amount
-    validates_amount            :amount
+    validates_integer           :amount
 
     # Original Day of Processing
     validates_integer           :original_processing_day, :unsigned
@@ -45,7 +47,6 @@ class Aba
     validates_max_length        :name_of_remitter, 16
     validates_becs              :name_of_remitter
 
-
     # Allow dashes to be input, but remove them from output
     def account_number
       @account_number ? @account_number.to_s.delete('-') : nil

data/lib/aba/transaction.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Aba
   class Transaction < Entry
     include Aba::Validations
@@ -19,7 +21,8 @@ class Aba
     validates_transaction_code  :transaction_code
 
     # Amount
-    validates_amount            :amount
+    validates_integer           :amount
+    validates_max_length        :amount, 10
 
     # Account Name
     validates_max_length        :account_name, 32
@@ -37,51 +40,21 @@ class Aba
     validates_max_length        :name_of_remitter, 16
     validates_becs              :name_of_remitter
 
-
     # Allow dashes to be input, but remove them from output
     def account_number
       @account_number ? @account_number.to_s.gsub('-', '') : nil
     end
 
-    # Fall back to blank string
+    # Sane default for majority of use cases as per BECS
     def indicator
-      @indicator || Aba::Validations::INDICATORS.first
-    end
-
-    # Fall back to 50
-    def transaction_code
-      @transaction_code || 50
-    end
-
-    # Fall back to 0
-    def amount
-      @amount || 0
-    end
-
-    # Fall back to empty string
-    def account_name
-      @account_name || ''
+      @indicator || ' '
     end
 
-    # Fall back to empty string
+    # Optional as per BECS
     def lodgement_reference
       @lodgement_reference || ''
     end
 
-    # Fall back to BSB
-    def trace_bsb
-      @trace_bsb || bsb
-    end
-
-    # Fall back to Account Number
-    def trace_account_number
-      @trace_account_number ? @trace_account_number.to_s.gsub('-', '') : account_number
-    end
-
-    def name_of_remitter
-      @name_of_remitter || ''
-    end
-
     def to_s
       raise RuntimeError, 'Transaction data is invalid - check the contents of `errors`' unless valid?
 

data/lib/aba/validations.rb

@@ -1,9 +1,13 @@
+# frozen_string_literal: true
+
 class Aba
   module Validations
     attr_accessor :error_collection
 
     BECS_PATTERN = /\A[\w\+\-\@\ \$\!\%\&\(\)\*\.\/\#\=\:\;\?\,\'\[\]\_\^]*\Z/
     INDICATORS = [' ', 'N', 'T', 'W', 'X', 'Y']
+    DEBIT_TRANSACTION_CODES = [13]
+    CREDIT_TRANSACTION_CODES = [50, 51, 52, 53, 54, 55, 56, 57]
 
     def self.included(base)
       base.instance_eval do
@@ -13,6 +17,10 @@ class Aba
       base.send :extend, ClassMethods
     end
 
+    def self.transaction_codes
+      DEBIT_TRANSACTION_CODES + CREDIT_TRANSACTION_CODES
+    end
+
     def valid?
       !has_errors?
     end
@@ -46,14 +54,8 @@ class Aba
             else
               self.error_collection << "#{attribute} must be an unsigned number" unless value.to_s =~ /\A\d+\Z/
             end
-          when :matches_transaction_code
-            if debit? && value.to_i > 0
-              self.error_collection << "#{attribute} is positive but the transaction type is a debit"
-            elsif credit? && value.to_i < 0
-              self.error_collection << "#{attribute} is negative but the transaction type is a credit"
-            end
           when :account_number
-            if value.to_s =~ /\A[0\ ]+\Z/ || value.to_s !~ /\A[a-z\d\ ]{1,9}\Z/
+            if value.to_s =~ /\A[0\ ]+\Z/ || value.to_s !~ /\A[a-z\d\ ]{1,9}\Z/i
               self.error_collection << "#{attribute} must be a valid account number"
             end
           when :becs
@@ -62,7 +64,7 @@ class Aba
             list = INDICATORS.join('\', \'')
             self.error_collection << "#{attribute} must be a one of '#{list}'" unless INDICATORS.include?(value.to_s)
           when :transaction_code
-            self.error_collection << "#{attribute} must be a 2 digit number" unless value.to_s =~ /\A\d{2,2}\Z/
+            self.error_collection << "#{attribute} must be one of #{Validations.transaction_codes.join(', ')}" unless Validations.transaction_codes.include?(value.to_i)
           end
         end
       end
@@ -94,11 +96,6 @@ class Aba
         add_validation_attribute(attribute, :integer, signed)
       end
 
-      def validates_amount(attribute)
-        add_validation_attribute(attribute, :integer, true)
-        add_validation_attribute(attribute, :matches_transaction_code)
-      end
-
       def validates_account_number(attribute)
         add_validation_attribute(attribute, :account_number)
       end

data/lib/aba/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Aba
-  VERSION = "0.5.0"
+  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,40 +1,62 @@
+# frozen_string_literal: true
+
 # encoding: UTF-8
 
 require "spec_helper"
 
 describe Aba::Batch do
-  subject(:batch) { Aba::Batch.new(financial_institution: "WPC", user_name: "John Doe",
-                      user_id: "466364", description: "Payroll", process_at: "190615") }
-  let(:transaction_amounts) { [[53, 30], [13, -20]] }
-  let(:transactions) do
-    transaction_amounts.map do |(transaction_code, amount)|
-      Aba::Transaction.new(bsb: '342-342', account_number: '3244654', amount: amount,
-      account_name: 'John Doe', transaction_code: transaction_code,
-      lodgement_reference: 'R435564', trace_bsb: '453-543',
-      trace_account_number: '45656733', name_of_remitter: 'Remitter')
-    end
+  subject(:batch) do
+    Aba::Batch.new(
+      financial_institution: "WPC",
+      user_name: "John Doe",
+      user_id: "466364",
+      description: "Payroll",
+      process_at: "190615",
+    )
   end
-  before { transactions.each { |trx| batch.add_transaction(trx) } }
-
-  let(:return_amounts) { [[53, 3], [13, -2]] }
-  let(:returns) do
-    return_amounts.map do |(transaction_code, amount)|
-      Aba::Return.new(bsb: '453-543', account_number: '45656733', amount: amount,
-                      account_name: 'John Doe', transaction_code: transaction_code,
-                      lodgement_reference: 'R435564', trace_bsb: '342-342',
-                      trace_account_number: '3244654', name_of_remitter: 'Remitter',
-                      return_code: 8, original_user_id: 654321,
-                      original_processing_day: 12,
 
+  let(:transactions_attributes) { [{amount: 30, transaction_code: 50}, {amount: 20, transaction_code: 13}] }
+  let(:returns_attributes) { [{amount: 3, transaction_code: 50}, {amount: 2, transaction_code: 13}] }
+
+  before do
+    transactions_attributes.each do |attr|
+      transaction = Aba::Transaction.new(
+        bsb: '342-342',
+        account_number: '3244654',
+        amount: attr[:amount],
+        account_name: 'John Doe',
+        transaction_code: attr[:transaction_code],
+        lodgement_reference: 'R435564',
+        trace_bsb: '453-543',
+        trace_account_number: '45656733',
+        name_of_remitter: 'Remitter',
       )
+
+      batch.add_transaction(transaction)
+    end
+
+    returns_attributes.map do |attr|
+      ret = Aba::Return.new(
+        bsb: '453-543',
+        account_number: '45656733',
+        amount: attr[:amount],
+        account_name: 'John Doe',
+        transaction_code: attr[:transaction_code],
+        lodgement_reference: 'R435564',
+        trace_bsb: '342-342',
+        trace_account_number: '3244654',
+        name_of_remitter: 'Remitter',
+        return_code: 8,
+        original_user_id: 654321,
+        original_processing_day: 12,
+      )
+
+      batch.add_return(ret)
     end
   end
-  before { returns.each { |trx| batch.add_return(trx) } }
 
   describe "#to_s" do
-
     context 'when descriptive record' do
-
       context 'without bsb' do
         it "should return a string containing the descriptive record without the bsb" do
           expect(batch.to_s).to include("0                 01WPC       John Doe                  466364Payroll     190615                                        \r\n")
@@ -43,6 +65,7 @@ describe Aba::Batch do
 
       context 'with bsb' do
         before { batch.bsb = "123-345" }
+
         it "should return a string containing the descriptive record with the bsb" do
           expect(batch.to_s).to include("0123-345          01WPC       John Doe                  466364Payroll     190615                                        \r\n")
         end
@@ -51,50 +74,87 @@ describe Aba::Batch do
 
 
     context 'when detail record' do
-
       it "should contain transaction & return records" do
-        expect(batch.to_s).to include("1342-342  3244654 530000000030John Doe                        R435564           453-543 45656733Remitter        00000000\r\n")
+        expect(batch.to_s).to include("1342-342  3244654 500000000030John Doe                        R435564           453-543 45656733Remitter        00000000\r\n")
         expect(batch.to_s).to include("1342-342  3244654 130000000020John Doe                        R435564           453-543 45656733Remitter        00000000\r\n")
-        expect(batch.to_s).to include("2453-543 456567338530000000003John Doe                        R435564           342-342  3244654Remitter        12654321\r\n")
+        expect(batch.to_s).to include("2453-543 456567338500000000003John Doe                        R435564           342-342  3244654Remitter        12654321\r\n")
         expect(batch.to_s).to include("2453-543 456567338130000000002John Doe                        R435564           342-342  3244654Remitter        12654321\r\n")
       end
     end
 
     context 'when file total record' do
-
       context 'with unbalanced transactions' do
         it "should return a string where the net total is not zero" do
           expect(batch.to_s).to include("7999-999            000000001100000000330000000022                        000004                                        ")
+          #                                                  | Total  || Credit || Debit  |
         end
       end
 
       context 'with balanced transactions' do
-        let(:transaction_amounts) { [[50, 30], [50, 30], [13, -60]] }
-        let(:return_amounts) { [[50, 3], [50, 3], [13, -6]] }
+        let(:transactions_attributes) do
+          [{amount: 30, transaction_code: 50}, {amount: 30, transaction_code: 13}, {amount: 30, transaction_code: 50}]
+        end
+        let(:returns_attributes) do
+          [{amount: 3, transaction_code: 50}, {amount: 3, transaction_code: 13}, {amount: 30, transaction_code: 13}]
+        end
+
         it "should return a string where the net total is zero" do
-          expect(batch.to_s).to include("7999-999            000000000000000000660000000066                        000006                                        ")
+          expect(batch.to_s).to include("7999-999            000000000000000000630000000063                        000006                                        ")
+          #                                                  | Total  || Credit || Debit  |
+        end
+      end
+
+      context 'with negative values supplied for the amounts' do
+        let(:transactions_attributes) { [{amount: -30, transaction_code: 50}, {amount: -20, transaction_code: 13}] }
+        let(:returns_attributes) { [{amount: -3, transaction_code: 50}, {amount: 2, transaction_code: 13}] }
+
+        it 'should return a string where the amount segments rely on the transaction code, not the amount sign' do
+          expect(batch.to_s).to include("7999-999            000000001100000000330000000022                        000004                                        ")
+          #                                                  | Total  || Credit || Debit  |
         end
+
       end
     end
   end
 
   describe "#errors" do
-
-    let(:errors) { subject.errors }
-
     it "is empty" do
-      expect(errors).to be_nil
+      expect(batch.errors).to be_nil
     end
 
     context "with an invalid amount" do
-      let(:transaction_amounts) do
-        [[53, 1], [53, -1], [13, 'def']]
+      let(:transactions_attributes) do
+        [{amount: 1, transaction_code: 50}, {amount: 'abc', transaction_code: 13}, {amount: 'def', transaction_code: 50}]
+      end
+
+      it "reports the errors" 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(errors).to eq(:entries => {
-            1 => ["amount is negative but the transaction type is a credit"],
-            2 => ["amount must be a number"]
-        })
+        expect(batch.errors).to include(aba: ["debit_total_amount length must not exceed 10 characters"])
       end
     end
   end

data/spec/lib/aba/return_spec.rb

@@ -1,24 +1,30 @@
+# frozen_string_literal: true
+
 # encoding: UTF-8
 
 require "spec_helper"
 
 describe Aba::Return do
-  let(:transaction_params) { {
-    :trace_account_number => 23432342,
-    :transaction_code => 53,
-    :amount => 50050,
-    :account_name => "John Doe",
-    :trace_bsb => "345-453",
-    :return_code => 8,
-    :lodgement_reference => "R45343",
-    :bsb => "123-234",
-    :account_number => "4647642",
-    :name_of_remitter => "Remitter",
-    :original_processing_day => "07",
-    :original_user_id => "054321",
-  } }
   subject(:transaction) { Aba::Return.new(transaction_params) }
 
+  let(:transaction_attributes) { {amount: 50050, transaction_code: 53} }
+  let(:transaction_params) do
+    {
+      :trace_account_number => 23432342,
+      :transaction_code => transaction_attributes[:transaction_code],
+      :amount => transaction_attributes[:amount],
+      :account_name => "John Doe",
+      :trace_bsb => "345-453",
+      :return_code => 8,
+      :lodgement_reference => "R45343",
+      :bsb => "123-234",
+      :account_number => "4647642",
+      :name_of_remitter => "Remitter",
+      :original_processing_day => "07",
+      :original_user_id => "054321",
+    }
+  end
+
   describe "#to_s" do
     it "should create a transaction row" do
       expect(subject.to_s).to include(
@@ -31,6 +37,22 @@ describe Aba::Return do
         #                                                              |                 +-trace_bsb
         #                                                              +-lodgement_reference
     end
+
+    context 'when supplied amount is negative' do
+      let(:transaction_attributes) { {amount: -50050, transaction_code: 53} }
+
+      it "should create a transaction row where the amount does not have a sign" do
+        expect(subject.to_s).to include(
+          "2123-234  46476428530000050050John Doe                        R45343            345-453 23432342Remitter        07054321")
+          # |      |        || |         |                               |                 |      |        |               | |
+          # +-bsb  |        || +-amount  +-account_name                  |                 |      |        |               | +-original_user_id
+          #        |        |+-transaction_code                          |                 |      |        |               +-original_processing_day
+          #        |        +-return_code                                |                 |      |        +-name_of_remitter
+          #        +-account_number                                      |                 |      +-trace_account_number
+          #                                                              |                 +-trace_bsb
+          #                                                              +-lodgement_reference
+      end
+    end
   end
 
   describe "#valid?" do

data/spec/lib/aba/transaction_spec.rb

@@ -1,27 +1,42 @@
+# frozen_string_literal: true
+
 # encoding: UTF-8
 
 require "spec_helper"
 
 describe Aba::Transaction do
-  let(:transaction_params) { {
-    :account_number => 23432342,
-    :transaction_code => 53,
-    :amount => 50050,
-    :account_name => "John Doe",
-    :bsb => "345-453",
-    :witholding_amount => 87,
-    :indicator => "W",
-    :lodgement_reference => "R45343",
-    :trace_bsb => "123-234",
-    :trace_account_number => "4647642",
-    :name_of_remitter => "Remitter"
-  } }
   subject(:transaction) { Aba::Transaction.new(transaction_params) }
 
+  let(:transaction_attributes) { {amount: 50050, transaction_code: 53} }
+
+  let(:transaction_params) do
+    {
+      :account_number => 23432342,
+      :transaction_code => transaction_attributes[:transaction_code],
+      :amount => transaction_attributes[:amount],
+      :account_name => "John Doe",
+      :bsb => "345-453",
+      :witholding_amount => 87,
+      :indicator => "W",
+      :lodgement_reference => "R45343",
+      :trace_bsb => "123-234",
+      :trace_account_number => "4647642",
+      :name_of_remitter => "Remitter",
+    }
+  end
+
   describe "#to_s" do
     it "should create a transaction row" do
       expect(subject.to_s).to include("1345-453 23432342W530000050050John Doe                        R45343            123-234  4647642Remitter        00000087")
     end
+
+    context 'when supplied amount is negative' do
+      let(:transaction_attributes) { {amount: -50050, transaction_code: 53} }
+
+      it "should create a transaction row where the amount does not have a sign" do
+        expect(subject.to_s).to include("1345-453 23432342W530000050050John Doe                        R45343            123-234  4647642Remitter        00000087")
+      end
+    end
   end
 
   describe "#valid?" do
@@ -29,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"
@@ -138,8 +140,7 @@ describe Aba::Validations do
       expect(subject.errors).to eq ["attr1 must be a valid account number"]
 
       subject.attr1 = "00 0A0"
-      expect(subject.valid?).to eq false
-      expect(subject.errors).to eq ["attr1 must be a valid account number"]
+      expect(subject.valid?).to eq true
 
       subject.attr1 = "00 111"
       expect(subject.valid?).to eq true
@@ -152,6 +153,9 @@ describe Aba::Validations do
 
       subject.attr1 = "aa aaa"
       expect(subject.valid?).to eq true
+
+      subject.attr1 = "1A2B3C"
+      expect(subject.valid?).to eq true
     end
 
     it "should validate becs" do
@@ -180,35 +184,31 @@ describe Aba::Validations do
 
       subject.attr1 = "$"
       expect(subject.valid?).to eq false
-      list = Aba::Validations::INDICATORS.join('\', \'')
+      list = described_class::INDICATORS.join('\', \'')
       expect(subject.errors).to eq ["attr1 must be a one of '#{list}'"]
 
-      subject.attr1 = Aba::Validations::INDICATORS.sample
+      subject.attr1 = described_class::INDICATORS.sample
       expect(subject.valid?).to eq true
     end
 
     it "should validate transaction code" do
       clean_room.instance_eval do
-        attr_accessor :attr1
-        validates_transaction_code :attr1
+        attr_accessor :transaction_code
+        validates_transaction_code :transaction_code
       end
 
-      subject.attr1 = "AA"
-      expect(subject.valid?).to eq false
-      expect(subject.errors).to eq ["attr1 must be a 2 digit number"]
-
-      subject.attr1 = "123"
+      subject.transaction_code = "AA"
       expect(subject.valid?).to eq false
-      expect(subject.errors).to eq ["attr1 must be a 2 digit number"]
+      expect(subject.errors).to eq ["transaction_code must be one of #{described_class::transaction_codes.join(', ')}"]
 
-      subject.attr1 = "1"
+      subject.transaction_code = "1"
       expect(subject.valid?).to eq false
-      expect(subject.errors).to eq ["attr1 must be a 2 digit number"]
+      expect(subject.errors).to eq ["transaction_code must be one of #{described_class::transaction_codes.join(', ')}"]
 
-      subject.attr1 = "15"
+      subject.transaction_code = "13"
       expect(subject.valid?).to eq true
 
-      subject.attr1 = 15
+      subject.transaction_code = 50
       expect(subject.valid?).to eq true
     end
   end

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,7 +1,10 @@
+# frozen_string_literal: true
+
 require 'bundler/setup'
 Bundler.setup
 
 require "aba"
+require "pry"
 
 RSpec.configure do |config|
   config.order = :random

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aba
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Andrey Bazhutkin
@@ -9,50 +9,36 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-08 00:00:00.000000000 Z
+date: 2022-07-25 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.13'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -78,6 +64,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -115,7 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: ABA File Generator