aba 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f11f3830479ca1fad3b854bb9459f99ce7dc8f5a
-  data.tar.gz: f793d6648ffc17e7589b2c5db57b26f548c5800e
+SHA256:
+  metadata.gz: f7d2996812bbfd9d6386cef252e680024545ad59b01eec0d6645d8cf75dafe6a
+  data.tar.gz: 584aad9a1c2b922680da873f1a95922dfa4864c5e54ac979d6ed6f5eb01e3094
 SHA512:
-  metadata.gz: b350430aa9ee2c21cfa6d239c6871fcb3626f724dbd67d5cc5d58dac4d627c16b1e2873d1d4c4e9e80e0ca11acec6a5dfede5bae8b8184fcd8ab182ced99e7d9
-  data.tar.gz: 356d63f3de331b90a69fc8d586690eb793fa606c8544f4bfc481a8a055ee96811c98a76158617db3e773f13a126eab2a0b53f62d5ac0ddcf0985e1f09ce8bec3
+  metadata.gz: 4be17e99ad4fedbb404bb2305e0a310afafc96c0f2b39f57f49d76b198e7018a7fc9997b35441d2209bce37986487d683fcfd5f20d049acea8581804669ecc8b
+  data.tar.gz: b09e75f48ce6ddab89dc0fc82f1d9be3a87f573db08591d65158203b2b1a4d1ae6c3ec6cbf34437d1c4d15842e4e93f07f75977bbf5ac063338fbd2dc519a177

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/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
 ```

data/aba.gemspec

@@ -18,10 +18,10 @@ 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 "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry"
   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
@@ -163,10 +169,10 @@ class Aba
       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 |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
 
       # Record type
@@ -207,7 +213,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?
+      (50..57).include?(transaction_code.to_i)
+    end
+
+    def debit?
+      transaction_code.to_i == 13
+    end
+  end
+end

data/lib/aba/return.rb

@@ -0,0 +1,72 @@
+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_amount            :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,
@@ -19,7 +19,7 @@ class Aba
     validates_transaction_code  :transaction_code
 
     # Amount
-    validates_integer           :amount
+    validates_amount            :amount
 
     # Account Name
     validates_max_length        :account_name, 32
@@ -38,12 +38,6 @@ class Aba
     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

data/lib/aba/validations.rb

@@ -46,6 +46,12 @@ 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/
               self.error_collection << "#{attribute} must be a valid account number"
@@ -88,6 +94,11 @@ 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
@@ -104,6 +115,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 = "0.5.0"
 end

data/spec/lib/aba/batch_spec.rb

@@ -3,19 +3,33 @@
 require "spec_helper"
 
 describe Aba::Batch do
-  let(:aba) { Aba::Batch.new(financial_institution: "WPC", user_name: "John Doe",
+  subject(:batch) { Aba::Batch.new(financial_institution: "WPC", user_name: "John Doe",
                       user_id: "466364", description: "Payroll", process_at: "190615") }
-  let(:transaction_values) { [30, -20] }
+  let(:transaction_amounts) { [[53, 30], [13, -20]] }
   let(:transactions) do
-    transaction_values.map do |amount|
+    transaction_amounts.map do |(transaction_code, amount)|
       Aba::Transaction.new(bsb: '342-342', account_number: '3244654', amount: amount,
-      account_name: 'John Doe', transaction_code: 53,
+      account_name: 'John Doe', transaction_code: transaction_code,
       lodgement_reference: 'R435564', trace_bsb: '453-543',
       trace_account_number: '45656733', name_of_remitter: 'Remitter')
     end
   end
-  subject { aba  }
-  before { transactions.each { |trx| subject.add_transaction(trx) } }
+  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,
+
+      )
+    end
+  end
+  before { returns.each { |trx| batch.add_return(trx) } }
 
   describe "#to_s" do
 
@@ -23,14 +37,14 @@ describe Aba::Batch 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
@@ -38,26 +52,50 @@ describe Aba::Batch do
 
     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 530000000030John 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 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                                        ")
         end
       end
 
       context 'with balanced transactions' do
-        let(:transaction_values) { [30, 30, -60] }
+        let(:transaction_amounts) { [[50, 30], [50, 30], [13, -60]] }
+        let(:return_amounts) { [[50, 3], [50, 3], [13, -6]] }
         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            000000000000000000660000000066                        000006                                        ")
         end
       end
     end
   end
+
+  describe "#errors" do
+
+    let(:errors) { subject.errors }
+
+    it "is empty" do
+      expect(errors).to be_nil
+    end
+
+    context "with an invalid amount" do
+      let(:transaction_amounts) do
+        [[53, 1], [53, -1], [13, 'def']]
+      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"]
+        })
+      end
+    end
+  end
 end

data/spec/lib/aba/return_spec.rb

@@ -0,0 +1,47 @@
+# 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) }
+
+  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
+  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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aba
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Andrey Bazhutkin
@@ -9,50 +9,50 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-24 00:00:00.000000000 Z
+date: 2020-07-08 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'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -85,10 +85,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
@@ -105,20 +108,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
+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