wage_slave's Introduction

WageSlave

A toolkit for generating and working with bulk payment files in various banking formats.

Installation

Add this line to your application's Gemfile:

gem 'wage_slave', '~> 2.0'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install wage_slave

Formats

WageSlave can generate payment files in the following formats:

Available

ABA / Cemtext (Australian Banks)

Coming soon

NZ-DE (New Zealand Direct Entry File Format)
IB4B (Bank of New Zealand)
More...

Usage

Configure your application with information relating to your financial institution. For Rails applications this should be kept in an initializer. Keep this information secure and out of version control.

Configuration

WageSlave.configure do | config |
  config.financial_institution                  = "ANZ" # Name of your bank
  config.bank_code                              = "123-456" # i.e. BSB, Sort code etc
  config.user_id                                = "12345678" # i.e. CRN, Acc no. etc
  config.description                            = "A default description for all WageSlave transactions"
  config.user_name 								= "Username"
end

ABA / Cemtext

A bulk payment file that works with most Australian banks.

    
    # Build individual transactions
    transactions = [
        { name: "John Doe", account_number: "12345678", bsb: "999-999", amount: 5000 },
        { name: "Jane Doe", account_number: "87654321", bsb: "999-999", amount: 6000 }
    ]

    # Create an ABA object
    aba = WageSlave::ABA.new(transactions)

    # Print in ABA format
    # Validation errors will raise a RuntimeError when calling #to_s on an ABA object.
    aba.to_s

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run ruby bin/console for an interactive prompt that will allow you to experiment.