aba 0.4.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f11f3830479ca1fad3b854bb9459f99ce7dc8f5a
-  data.tar.gz: f793d6648ffc17e7589b2c5db57b26f548c5800e
+SHA256:
+  metadata.gz: 2156c80e41e17a9df07891a515adff66f0b41412dd83897067a5faa1a598e956
+  data.tar.gz: 853deb00316a156169fd1dbc81b5cea3b666122ff538fc61646fedb5bf44d15a
 SHA512:
-  metadata.gz: b350430aa9ee2c21cfa6d239c6871fcb3626f724dbd67d5cc5d58dac4d627c16b1e2873d1d4c4e9e80e0ca11acec6a5dfede5bae8b8184fcd8ab182ced99e7d9
-  data.tar.gz: 356d63f3de331b90a69fc8d586690eb793fa606c8544f4bfc481a8a055ee96811c98a76158617db3e773f13a126eab2a0b53f62d5ac0ddcf0985e1f09ce8bec3
+  metadata.gz: ccb0516b85f0b70af8374f8ef4a3f3effe157dcd19296283a2c274359926e567a9bf7120aad3cf784b4ae027f8bf9e4835edc3c02805d10ebca50d6feec4639e
+  data.tar.gz: fbce1803cff67a9bbff99f6c91720b05e20fc62837e39f6d170438b3f6e3d47972b2f24dcf969788487b65078b0822570f488541091847ae8238d8e9eb7542fd

data/.gitignore

@@ -20,3 +20,4 @@ tmp
 *.o
 *.a
 mkmf.log
+.ruby-version

data/.travis.yml

@@ -1,7 +1,6 @@
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.7
-  - 2.2.3
+  - 2.5.8
+  - 2.6.6
+  - 2.7.1
 script: bundle exec rspec spec

data/CHANGELOG.md

@@ -0,0 +1,20 @@
+## 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/README.md

@@ -19,7 +19,7 @@ aba = Aba.batch(
   process_at: Time.now.strftime("%d%m%y")
 )
 
-# Add transactions
+# Add transactions...
 10.times do
   aba.add_transaction(
     {
@@ -36,6 +36,26 @@ aba = Aba.batch(
   )
 end
 
+# ...or add returns
+10.times do
+  aba.add_return(
+    {
+        bsb: '453-543',
+        account_number: '45656733',
+        amount: 10000,
+        account_name: 'John Doe',
+        transaction_code: 53,
+        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,
+    }
+  )
+end
+
 puts aba.to_s # View output
 File.write("/Users/me/dd_#{Time.now.to_i}.aba", aba.to_s) # or write output to file
 ```
@@ -45,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/aba.gemspec

@@ -18,10 +18,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake", "~> 10.4"
-  spec.add_development_dependency "pry", "~> 0.10"
+  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 = '>= 1.9.2'
+  spec.required_ruby_version = '>= 2.5.0'
 end

data/lib/aba.rb

@@ -1,6 +1,8 @@
 require "aba/version"
 require "aba/validations"
+require "aba/entry"
 require "aba/batch"
+require "aba/return"
 require "aba/transaction"
 
 class Aba

data/lib/aba/batch.rb

@@ -2,7 +2,7 @@ class Aba
   class Batch
     include Aba::Validations
 
-    attr_accessor :bsb, :financial_institution, :user_name, :user_id, :description, :process_at, :transactions
+    attr_accessor :bsb, :financial_institution, :user_name, :user_id, :description, :process_at, :entries
 
     # BSB
     validates_bsb         :bsb, allow_blank: true
@@ -34,8 +34,7 @@ class Aba
         send("#{key}=", value)
       end
 
-      @transaction_index = 0
-      @transactions = {}
+      @entries = []
 
       unless transactions.nil? || transactions.empty?
         transactions.to_a.each do |t|
@@ -47,56 +46,63 @@ class Aba
     end
 
     def to_s
-      raise RuntimeError, 'No transactions present - add one using `add_transaction`' if @transactions.empty?
+      raise RuntimeError, 'No entries present - add one using `add_transaction` or `add_return`' if entries.empty?
       raise RuntimeError, 'ABA data is invalid - check the contents of `errors`' unless valid?
 
       # Descriptive record
       output = "#{descriptive_record}\r\n"
 
       # Transactions records
-      output += @transactions.map{ |t| t[1].to_s }.join("\r\n")
+      output += entries.map { |t| t.to_s }.join("\r\n")
 
       # Batch control record
       output += "\r\n#{batch_control_record}"
     end
 
     def add_transaction(attrs = {})
-      if attrs.instance_of?(Aba::Transaction)
-        transaction = attrs
-      else
-        transaction = Aba::Transaction.new(attrs)
-      end
-      @transactions[@transaction_index] = transaction
-      @transaction_index += 1
-      transaction
+      add_entry(Aba::Transaction, attrs)
+    end
+
+    def add_return(attrs = {})
+      add_entry(Aba::Return, attrs)
+    end
+
+    def transactions
+      entries.select { |entry| entry.instance_of?(Aba::Transaction) }
     end
 
     def transactions_valid?
-      !has_transaction_errors?
+      !transactions.map { |t| t.valid? }.include?(false)
     end
 
     def valid?
-      !has_errors? && transactions_valid?
+      !has_errors? && !has_entry_errors?
     end
 
     def errors
       # Run validations
       has_errors?
-      has_transaction_errors?
+      has_entry_errors?
 
       # Build errors
       all_errors = {}
       all_errors[:aba] = self.error_collection unless self.error_collection.empty?
-      transaction_error_collection = @transactions.each_with_index.map{ |(k, t), i| [k, t.error_collection] }.reject{ |e| e[1].nil? || e[1].empty? }.to_h
-      all_errors[:transactions] = transaction_error_collection unless transaction_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
+      all_errors[:entries] = entry_error_collection unless entry_error_collection.empty?
 
       all_errors unless all_errors.empty?
     end
 
     private
 
-    def has_transaction_errors?
-      @transactions.map{ |t| t[1].valid? }.include?(false)
+    def add_entry(type, attrs)
+      (attrs.instance_of?(type) ? attrs : type.new(attrs)).tap do |entry|
+        entries << entry
+      end
+    end
+
+    def has_entry_errors?
+      entries.map { |t| t.valid? }.include?(false)
     end
 
     def descriptive_record
@@ -159,14 +165,15 @@ class Aba
     end
 
     def batch_control_record
-      net_total_amount    = 0
       credit_total_amount = 0
       debit_total_amount  = 0
 
-      @transactions.each do |t|
-        net_total_amount += t[1].amount.to_i
-        credit_total_amount += t[1].amount.to_i if t[1].amount.to_i > 0
-        debit_total_amount += t[1].amount.to_i if t[1].amount.to_i < 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
 
       # Record type
@@ -187,17 +194,17 @@ class Aba
       # Net total
       # Max: 10
       # Char position: 21-30
-      output += net_total_amount.abs.to_s.rjust(10, "0")
+      output += (credit_total_amount - 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 += 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 += debit_total_amount.to_s.rjust(10, "0")
 
       # Reserved
       # Max: 24
@@ -207,7 +214,7 @@ class Aba
       # Total Item Count
       # Max: 6
       # Char position: 75-80
-      output += @transactions.size.to_s.rjust(6, "0")
+      output += entries.size.to_s.rjust(6, "0")
 
       # Reserved
       # Max: 40

data/lib/aba/entry.rb

@@ -0,0 +1,17 @@
+class Aba
+  class Entry
+    def initialize(attrs = {})
+      attrs.each do |key, value|
+        send("#{key}=", value)
+      end
+    end
+
+    def credit?
+      Validations::CREDIT_TRANSACTION_CODES.include?(transaction_code.to_i)
+    end
+
+    def debit?
+      Validations::DEBIT_TRANSACTION_CODES.include?(transaction_code.to_i)
+    end
+  end
+end

data/lib/aba/return.rb

@@ -0,0 +1,71 @@
+class Aba
+  class Return < Entry
+    include Aba::Validations
+
+    attr_accessor :account_number, :transaction_code, :amount, :account_name,
+                  :bsb, :trace_bsb, :trace_account_number, :name_of_remitter,
+                  :return_code, :lodgement_reference,
+                  :original_processing_day, :original_user_id
+
+    # BSB
+    validates_bsb               :bsb
+
+    # Account Number
+    validates_account_number    :account_number
+
+    # Indicator
+    validates_return_code       :return_code
+
+    # Transaction Code
+    validates_transaction_code  :transaction_code
+
+    # Amount
+    validates_integer           :amount
+
+    # Original Day of Processing
+    validates_integer           :original_processing_day, :unsigned
+
+    # Original User Id
+    validates_max_length        :original_user_id, 6
+    validates_integer           :original_user_id, :unsigned
+
+    # Account Name
+    validates_max_length        :account_name, 32
+    validates_becs              :account_name
+
+    # Lodgement Reference
+    validates_max_length        :lodgement_reference, 18
+    validates_becs              :lodgement_reference
+
+    # Trace Record
+    validates_bsb               :trace_bsb
+    validates_account_number    :trace_account_number
+
+    # Name of Remitter
+    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
+    end
+
+    def to_s
+      raise 'Transaction data is invalid - check the contents of `errors`' unless valid?
+
+      format('2%-7s%9s%1d%2d%010d%-32s%-18s%-7s%9s%-16s%02d%6s',
+             bsb,
+             account_number,
+             return_code,
+             transaction_code,
+             amount.to_i.abs,
+             account_name,
+             lodgement_reference,
+             trace_bsb,
+             trace_account_number,
+             name_of_remitter,
+             original_processing_day.to_i,
+             original_user_id)
+    end
+  end
+end

data/lib/aba/transaction.rb

@@ -1,5 +1,5 @@
 class Aba
-  class Transaction
+  class Transaction < Entry
     include Aba::Validations
 
     attr_accessor :account_number, :transaction_code, :amount, :account_name,
@@ -37,57 +37,21 @@ class Aba
     validates_max_length        :name_of_remitter, 16
     validates_becs              :name_of_remitter
 
-
-    def initialize(attrs = {})
-      attrs.each do |key, value|
-        send("#{key}=", value)
-      end
-    end
-
     # 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
+      @indicator || ' '
     end
 
-    # Fall back to empty string
-    def account_name
-      @account_name || ''
-    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

@@ -4,6 +4,8 @@ class Aba
 
     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 +15,10 @@ class Aba
       base.send :extend, ClassMethods
     end
 
+    def self.transaction_codes
+      DEBIT_TRANSACTION_CODES + CREDIT_TRANSACTION_CODES
+    end
+
     def valid?
       !has_errors?
     end
@@ -47,7 +53,7 @@ class Aba
               self.error_collection << "#{attribute} must be an unsigned number" unless value.to_s =~ /\A\d+\Z/
             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
@@ -56,7 +62,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
@@ -104,6 +110,10 @@ class Aba
         add_validation_attribute(attribute, :transaction_code)
       end
 
+      def validates_return_code(attribute)
+        add_validation_attribute(attribute, :integer, :return_code)
+      end
+
       private
 
       def add_validation_attribute(attribute, type, param = true)

data/lib/aba/version.rb

@@ -1,3 +1,3 @@
 class Aba
-  VERSION = "0.4.0"
+  VERSION = "1.0.1"
 end

data/spec/lib/aba/batch_spec.rb

@@ -3,61 +3,131 @@
 require "spec_helper"
 
 describe Aba::Batch do
-  let(:aba) { Aba::Batch.new(financial_institution: "WPC", user_name: "John Doe",
-                      user_id: "466364", description: "Payroll", process_at: "190615") }
-  let(:transaction_values) { [30, -20] }
-  let(:transactions) do
-    transaction_values.map do |amount|
-      Aba::Transaction.new(bsb: '342-342', account_number: '3244654', amount: amount,
-      account_name: 'John Doe', transaction_code: 53,
-      lodgement_reference: 'R435564', trace_bsb: '453-543',
-      trace_account_number: '45656733', name_of_remitter: 'Remitter')
+  subject(:batch) do
+    Aba::Batch.new(
+      financial_institution: "WPC",
+      user_name: "John Doe",
+      user_id: "466364",
+      description: "Payroll",
+      process_at: "190615",
+    )
+  end
+
+  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
-  subject { aba  }
-  before { transactions.each { |trx| subject.add_transaction(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(subject.to_s).to include("0                 01WPC       John Doe                  466364Payroll     190615                                        \r\n")
+          expect(batch.to_s).to include("0                 01WPC       John Doe                  466364Payroll     190615                                        \r\n")
         end
       end
 
       context 'with bsb' do
-        before { subject.bsb = "123-345" }
+        before { batch.bsb = "123-345" }
+
         it "should return a string containing the descriptive record with the bsb" do
-          expect(subject.to_s).to include("0123-345          01WPC       John Doe                  466364Payroll     190615                                        \r\n")
+          expect(batch.to_s).to include("0123-345          01WPC       John Doe                  466364Payroll     190615                                        \r\n")
         end
       end
     end
 
 
     context 'when detail record' do
-
-      it "should contain transactions records" do
-        expect(subject.to_s).to include("1342-342  3244654 530000000030John Doe                        R435564           453-543 45656733Remitter        00000000\r\n")
-        expect(subject.to_s).to include("1342-342  3244654 530000000020John Doe                        R435564           453-543 45656733Remitter        00000000\r\n")
+      it "should contain transaction & return records" do
+        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 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 wihere the net total is not zero" do
-          expect(subject.to_s).to include("7999-999            000000001000000000300000000020                        000002                                        ")
+        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_values) { [30, 30, -60] }
+        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(subject.to_s).to include("7999-999            000000000000000000600000000060                        000003                                        ")
+          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
+    it "is empty" do
+      expect(batch.errors).to be_nil
+    end
+
+    context "with an invalid amount" do
+      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
   end
 end

data/spec/lib/aba/return_spec.rb

@@ -0,0 +1,67 @@
+# encoding: UTF-8
+
+require "spec_helper"
+
+describe Aba::Return do
+  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(
+        "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
+
+    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
+    it "should be valid" 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"]
+    end
+  end
+end

data/spec/lib/aba/transaction_spec.rb

@@ -3,25 +3,38 @@
 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

data/spec/lib/aba/validations_spec.rb

@@ -138,8 +138,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 +151,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 +182,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/spec_helper.rb

@@ -2,6 +2,7 @@ require 'bundler/setup'
 Bundler.setup
 
 require "aba"
+require "pry"
 
 RSpec.configure do |config|
   config.order = :random

metadata

@@ -1,58 +1,44 @@
 --- !ruby/object:Gem::Specification
 name: aba
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Andrey Bazhutkin
 - Trevor Wistaff
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-09-24 00:00:00.000000000 Z
+date: 2021-01-11 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        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
@@ -85,10 +72,13 @@ files:
 - aba.gemspec
 - lib/aba.rb
 - lib/aba/batch.rb
+- lib/aba/entry.rb
+- lib/aba/return.rb
 - lib/aba/transaction.rb
 - lib/aba/validations.rb
 - lib/aba/version.rb
 - spec/lib/aba/batch_spec.rb
+- spec/lib/aba/return_spec.rb
 - spec/lib/aba/transaction_spec.rb
 - spec/lib/aba/validations_spec.rb
 - spec/lib/aba_spec.rb
@@ -97,7 +87,7 @@ homepage: https://github.com/andrba/aba
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -105,20 +95,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: ABA File Generator
 test_files:
 - spec/lib/aba/batch_spec.rb
+- spec/lib/aba/return_spec.rb
 - spec/lib/aba/transaction_spec.rb
 - spec/lib/aba/validations_spec.rb
 - spec/lib/aba_spec.rb