== BankValInt
== Unified Software

==SYNOPSIS (GetABA)

    require 'rubygems' #using uppercase letters may load the file more than once which will cause 'already set constant' warnings
    require 'bankvalinternational'

    obj = BankValInternational::GetABA.new
    ans = obj.bankval_int_getaba('json','123456789','abcd123','12345')

==Description

This Gem controls the calling of REST web services from Unified Software's International Bank Validation services.
It will transparently call Unified's back up servers in the unlikely event of any issues with the main servers.
The services which can be used from this Gem are:

[IBANValidate]Full IBAN number validation in accordance with ECBS standards.

    object = BankValInternational::GetIBAN.new
    method = object.bankval_int_ibanval(format,iban,userid,pin)


[getABAdetails]Full Routing number validation using the latest Routing Numbers Database.

    object = BankValInternational::GetABA.new
    method = object.bankval_int_getaba(format,aba,userid,pin)


[GetBankDetails2]Full validation of SWIFT BIC codes using the latest SWIFT BIC directory.

    object = BankValInternational::GetSWIFT.new
    method = object.bankval_int_getswift(format,swiftbic,userid,pin)

==Including the Gem

To allow the usage of this gem you must have RubyGems installed. To check if you have,
open a command prompt (win) or console window (*nix) and type 'gem'. If RubyGems is installed
you will see a help message. If it isn't a command unrecognised message will appear.

To install RubyGems please refer to :

http://docs.rubygems.org/read/chapter/3

Once Rubygems is installed you can install the BankValInt gem from Rubygems.org by either;

*searching for BankValInt from within your IDE (e.g. in netbeans tool>RubyGems)

*opening a command prompt (win) or a console window (*nix) and typing 'gem install BankValInt'

Once the BankValInt gem is installed on your system it can be included in your code by adding the following two lines:

require 'rubygems'
require 'BankValInt'

==Calling the services

To call the services simply create an instance of the relevant class (as shown in the description above) and call
the exposed method (again as shown above)

==Parameters

The required parameters for the services are as follows:

1. Format:: the response format (either xml, json or csv)

2. IBAN/ABA/SWIFTBIC:: the IBAN to be validated

3. UserID:: available from www.unifiedsoftware.co.uk

4. PIN:: available from www.unifiedsoftware.co.uk

The parameters must be passed in the order shown

==Method Returns

The methods will return the web services response as a string formatted in either xml, json, or csv depending on the format parameter

==BankValInternational Ruby Gem

==Unified Software 2010
==www.unifiedsoftware.co.uk