aba 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e304f03903a8b1cb21d29421192a35c2a8871bf
-  data.tar.gz: fb95004c3d622d371e5402d754b3892cc1b2434c
+  metadata.gz: 7db46f198fd52a43b83a85c383db00bb9c1f6c0a
+  data.tar.gz: cfbf7860f3f136ee259c494fe88b0015c3a9d233
 SHA512:
-  metadata.gz: 317b8b821976c27476a74dfa084563e8245908d31a4d1c9caaea3c4ef1fb7d80543147ef1a6c258adfbd8f405620480159668d9035c40d66a5530f1ef1a482fe
-  data.tar.gz: c71f432a1bde06cd05630a7e9b4fefaf0d16230c96c2a70bfd2b99f89dc63faddeeb7e6140692419d09307bbc13689ffa6b5ba86ecb5435f1f8f7a903ae803a0
+  metadata.gz: 3166c7bbe642707defa8e890f915de79813e07a264d07a77c2c5a5053fce053724a2956c3627b4d0e484ea9f52613c11cacf1a5f1f3161936ef10e9790398a7a
+  data.tar.gz: 4cfdf45552802bcd767524524602eabcf816695b39fe1f3ade9953c2e43fdb054934adaeffa028a6dd35d546545932629d44c956bd5d469cd07b74c2841bc7e8

data/README.md

@@ -1,32 +1,43 @@
+[ ![Codeship Status for krakendevelopments/aba](https://codeship.com/projects/982382f0-f22b-0132-a80d-0acc257ded9c/status?branch=master)](https://codeship.com/projects/85083)
+
 # Aba
 
-The purpose of this gem is to generate an ABA (Australian Banking Association) file. It is a format used by banks to allow for batch transaction.
+Generates ABA (Australian Banking Association) file format output
 
 ## Usage
 
 ```ruby
 require 'aba'
 
-aba = Aba.new(bsb: "123-345", financial_institution: "WPC", user_name: "John Doe", 
-      user_id: "466364", description: "Payroll", process_at: Time.now)
+# Initialise ABA
+aba = Aba.new(
+  bsb: "123-345", # Optional (Not required by NAB)
+  financial_institution: "WPC", 
+  user_name: "John Doe",
+  user_id: "466364", 
+  description: "Payroll", 
+  process_at: Time.now.strftime("%d%m%y")
+)
 
 # Add transactions
-transactions.each do |t|
-  aba.transactions << Aba::Transaction.new(
-    :bsb => "342-342", 
-    :account_number => "3244654", 
-    :amount => amount, 
-    :account_name => "John Doe", 
-    :payment_id => "P2345543", 
-    :transaction_code => 53,
-    :lodgement_reference => "R435564", 
-    :trace_bsb => "453-543", 
-    :trace_account_number => "45656733", 
-    :name_of_remitter => "Remitter"
+10.times do
+  aba.add_transaction(
+    Aba::Transaction.new(
+      bsb: "342-342", 
+      account_number: "3244654", 
+      amount: 10000, # Amount in cents
+      account_name: "John Doe", 
+      transaction_code: 53,
+      lodgement_reference: "R435564", 
+      trace_bsb: "453-543", 
+      trace_account_number: "45656733", 
+      name_of_remitter: "Remitter"
+    )
   )
 end
 
-puts aba.to_s
+puts aba.to_s # View output
+File.write("/Users/me/dd_#{Time.now.to_i}.aba", aba.to_s) # or write output to file
 ```
 
 ## Installation

data/aba.gemspec

@@ -6,8 +6,8 @@ require 'aba/version'
 Gem::Specification.new do |spec|
   spec.name          = "aba"
   spec.version       = Aba::VERSION
-  spec.authors       = ["Andrey Bazhutkin"]
-  spec.email         = ["andrey.bazhutkin@gmail.com"]
+  spec.authors       = ["Andrey Bazhutkin", "Trevor Wistaff"]
+  spec.email         = ["andrey.bazhutkin@gmail.com", "trev@a07.com.au"]
   spec.summary       = "ABA File Generator"
   spec.description   = "ABA (Australian Bankers Association) File Generator"
   spec.homepage      = "https://github.com/andrba/aba"
@@ -19,7 +19,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rake", "~> 10.4"
+  spec.add_development_dependency "pry", "~> 0.10"
   spec.add_development_dependency "rspec", "~> 3.0"
 
   spec.required_ruby_version = '>= 1.9.2'

data/lib/aba.rb

@@ -5,25 +5,23 @@ require "aba/transaction"
 class Aba
   include Aba::Validations
 
-  attr_accessor :bsb, :account_number, :financial_institution, :user_name, :user_id,
-                :description, :process_at, :name_of_remitter, :transactions
+  attr_accessor :bsb, :financial_institution, :user_name, :user_id, :description, :process_at
 
-  validates_presence_of :bsb, :financial_institution, :user_name, :user_id, :description, :process_at
-  
-  validates_bsb :bsb
+  validates_bsb :bsb, allow_blank: true
 
-  validates_max_length :account_number,         9
-  validates_max_length :financial_institution,  3
   validates_max_length :user_name,              26
   validates_max_length :user_id,                6
   validates_max_length :description,            12
 
+  validates_length     :financial_institution,  3
+  validates_length     :process_at,             6
+
   def initialize(attrs = {})
     attrs.each do |key, value|
       send("#{key}=", value)
     end
 
-    self.transactions = []
+    @transactions = []
 
     yield self if block_given?
   end
@@ -39,56 +37,70 @@ class Aba
     output += "\r\n#{batch_control_record}"
   end
 
+  def add_transaction(transaction)
+    @transactions << transaction
+  end
+
   private
 
   def descriptive_record
     # Record type
+    # Max: 1
+    # Char position: 1
     output = "0"
 
-    # Bank/State/Branch number of the funds account with a hyphen in the 4th character position. e.g. 013-999. 
-    output += self.bsb
-
-    # Funds account number.
-    output += self.account_number.to_s.ljust(9, " ")
-
-    # Reserved
-    output += " "
+    # Optional branch number of the funds account with a hyphen in the 4th character position
+    # Char position: 2-18
+    # Max: 17
+    # Blank filled
+    output += self.bsb.nil? ? " " * 17 : self.bsb.to_s.ljust(17)
 
     # Sequence number 
+    # Char position: 19-20
+    # Max: 2
+    # Zero padded
     output += "01"
 
-    # Must contain the bank mnemonic that is associated with the BSB of the funds account. e.g. ‘ANZ’. 
-    output += self.financial_institution[0..2].to_s
+    # Name of user financial instituion
+    # Max: 3
+    # Char position: 21-23
+    output += self.financial_institution.to_s
 
     # Reserved 
+    # Max: 7
+    # Char position: 24-30
     output += " " * 7
 
-    # Name of User supplying File as advised by User's Financial Institution
-    output += self.user_name.to_s.ljust(26, " ")
+    # Name of User supplying File
+    # Char position: 31-56
+    # Max: 26
+    # Blank filled
+    output += self.user_name.to_s.ljust(26)
 
-    # Direct Entry User ID. 
+    # Direct Entry User ID
+    # Char position: 57-62
+    # Max: 6
+    # Zero padded
     output += self.user_id.to_s.rjust(6, "0")
 
-    # Description of payments in the file (e.g. Payroll, Creditors etc.). 
-    output += self.description.to_s.ljust(12, " ")
+    # Description of payments in the file (e.g. Payroll, Creditors etc.)
+    # Char position: 63-74
+    # Max: 12
+    # Blank filled
+    output += self.description.to_s.ljust(12)
 
-    # Date and time on which the payment is to be processed.
-    output += self.process_at.strftime("%d%m%y%H%M")
+    # Date on which the payment is to be processed
+    # Char position: 75-80
+    # Max: 6
+    output += self.process_at.rjust(6, "0")
 
     # Reserved
-    output += " " * 36
+    # Max: 40
+    # Char position: 81-120
+    output += " " * 40
   end
 
   def batch_control_record
-    # Record type
-    output = "7"
-
-    # BSB Format Filler
-    output += "999-999"
-
-    # Reserved
-    output += " " * 12
-
     net_total_amount    = 0
     credit_total_amount = 0
     debit_total_amount  = 0
@@ -99,22 +111,49 @@ class Aba
       debit_total_amount += t.amount if t.amount < 0
     end
 
-    # Must equal the difference between File Credit & File Debit Total Amounts. Show in cents without punctuation
+    # Record type
+    # Max: 1
+    # Char position: 1
+    output = "7"
+
+    # BSB Format Filler
+    # Max: 7
+    # Char position: 2-8
+    output += "999-999"
+
+    # Reserved
+    # Max: 12
+    # Char position: 9-20
+    output += " " * 12
+
+    # Net total
+    # Max: 10
+    # Char position: 21-30
     output += net_total_amount.abs.to_s.rjust(10, "0")
 
-    # Batch Credit Total Amount 
+    # Credit Total Amount 
+    # Max: 10
+    # Char position: 31-40
     output += credit_total_amount.abs.to_s.rjust(10, "0")
 
-    # Batch Debit Total Amount 
+    # Debit Total Amount 
+    # Max: 10
+    # Char position: 41-50
     output += debit_total_amount.abs.to_s.rjust(10, "0")
 
     # Reserved
+    # Max: 24
+    # Char position: 51-74
     output += " " * 24
 
-    # Batch Total Item Count 
+    # Total Item Count 
+    # Max: 6
+    # Char position: 75-80
     output += @transactions.size.to_s.rjust(6, "0")
 
     # Reserved
+    # Max: 40
+    # Char position: 81-120
     output += " " * 40
   end
-end
+end

data/lib/aba/transaction.rb

@@ -2,14 +2,14 @@ class Aba
   class Transaction
     include Aba::Validations
 
-    attr_accessor :account_number, :transaction_code, :amount, :account_name, :payment_id, 
-                  :bsb, :trace_bsb, :trace_account_number, :name_of_remitter, :witholding_amount, 
-                  :indicator, :lodgement_reference
+    attr_accessor :account_number, :transaction_code, :amount, :account_name, 
+                  :bsb, :trace_bsb, :trace_account_number, :name_of_remitter,
+                  :witholding_amount, :indicator, :lodgement_reference
 
-    validates_presence_of :bsb, :account_number, :amount, :account_name, :payment_id, :transaction_code,
-                          :lodgement_reference, :trace_bsb, :trace_account_number, :name_of_remitter
+    validates_bsb :bsb
+    validates_bsb :trace_bsb
     
-    validates_bsb :bsb, :trace_bsb
+    validates_integer :amount
 
     validates_max_length :account_number,         9
     validates_max_length :indicator,              1
@@ -73,4 +73,4 @@ class Aba
       output += (witholding_amount || 0).abs.to_s.rjust(8, "0")
     end
   end
-end
+end

data/lib/aba/validations.rb

@@ -1,4 +1,5 @@
 class Aba
+  require 'pry'
   module Validations
     attr_accessor :errors
 
@@ -22,9 +23,15 @@ class Aba
           when :presence
             self.errors << "#{attribute} is empty" if value.nil? || value.to_s.empty?
           when :bsb
-            self.errors << "#{attribute} format is incorrect" unless value =~ /^\d{3}-\d{3}$/
+            unless((param && value.nil?) || value =~ /^\d{3}-\d{3}$/)
+              self.errors << "#{attribute} format is incorrect"
+            end
           when :max_length
             self.errors << "#{attribute} length must not exceed #{param} characters" if value.to_s.length > param
+          when :length
+            self.errors << "#{attribute} length must be exactly #{param} characters" if value.to_s.length != param
+          when :integer
+            self.errors << "#{attribute} must be an integer" unless value.to_s =~ /\A[+-]?\d+\Z/
           end
         end
       end
@@ -39,16 +46,23 @@ class Aba
         end
       end
 
-      def validates_bsb(*attributes)
-        attributes.each do |a| 
-          add_validation_attribute(a, :bsb)
-        end
+      def validates_bsb(attribute, options = {})
+        options[:allow_blank] ||= false
+        add_validation_attribute(attribute, :bsb, options[:allow_blank])
       end
 
       def validates_max_length(attribute, length)
         add_validation_attribute(attribute, :max_length, length)
       end
 
+      def validates_length(attribute, length)
+        add_validation_attribute(attribute, :length, length)
+      end
+
+      def validates_integer(attribute)
+        add_validation_attribute(attribute, :integer)
+      end
+
       private
 
       def add_validation_attribute(attribute, type, param = true)
@@ -57,4 +71,4 @@ class Aba
       end
     end
   end
-end
+end

data/lib/aba/version.rb

@@ -1,3 +1,3 @@
 class Aba
-  VERSION = "0.1.0"
+  VERSION = "0.3.0"
 end

data/spec/aba_spec.rb

@@ -1,40 +1,61 @@
 require "spec_helper"
 
 describe Aba do
-  subject(:aba) do
-    aba = Aba.new(bsb: "123-345", financial_institution: "WPC", user_name: "John Doe", 
-      user_id: "466364", description: "Payroll", process_at: Time.new(2014, 12, 01, 10, 22, 0)) 
-
-    [30, -20].each do |amount|
-      aba.transactions << Aba::Transaction.new(
-        :bsb => "342-342", 
-        :account_number => "3244654", 
-        :amount => amount, 
-        :account_name => "John Doe", 
-        :payment_id => "P2345543", 
-        :transaction_code => 53,
-        :lodgement_reference => "R435564", 
-        :trace_bsb => "453-543", 
-        :trace_account_number => "45656733", 
-        :name_of_remitter => "Remitter"
-      )
+  let(:aba) { Aba.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')
     end
-
-    aba
   end
+  subject { aba  }
+  before { transactions.each { |trx| subject.add_transaction(trx) } }
 
   describe "#to_s" do
-    it "should contain a descriptive record" do
-      expect(subject.to_s).to include("0123-345          01WPC       John Doe                  466364Payroll     0112141022                                    \r\n")
+
+    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")
+        end
+      end
+
+      context 'with bsb' do
+        before { subject.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")
+        end
+      end
     end
 
-    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")
+
+    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")
+      end
     end
 
-    it "should contain a batch control record" do
-      expect(subject.to_s).to include("7999-999            000000001000000000300000000020                        000002                                        ")
+    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                                        ")
+        end
+      end
+
+      context 'with balanced transactions' do
+        let(:transaction_values) { [30, 30, -60] }
+        it "should return a string where the net total is zero" do
+          expect(subject.to_s).to include("7999-999            000000000000000000600000000060                        000003                                        ")
+        end
+      end
     end
   end
-end
+end

data/spec/transaction_spec.rb

@@ -6,7 +6,6 @@ describe Aba::Transaction do
     :transaction_code => 53,
     :amount => 50050,
     :account_name => "John Doe",
-    :payment_id => "P30234",
     :bsb => "345-453",
     :witholding_amount => 87,
     :indicator => "W",
@@ -31,7 +30,7 @@ describe Aba::Transaction do
     it "should not be valid" do
       transaction_params.delete(:bsb)
       expect(subject.valid?).to eq false
-      expect(subject.errors).to eq ["bsb is empty", "bsb format is incorrect"]
+      expect(subject.errors).to eq ["bsb format is incorrect"]
     end
   end
-end
+end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: aba
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Andrey Bazhutkin
+- Trevor Wistaff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-24 00:00:00.000000000 Z
+date: 2015-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,16 +29,30 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -55,6 +70,7 @@ dependencies:
 description: ABA (Australian Bankers Association) File Generator
 email:
 - andrey.bazhutkin@gmail.com
+- trev@a07.com.au
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -94,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.4
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: ABA File Generator