BankValInt 0.0.2

data/LICENSE

@@ -0,0 +1,27 @@
+== BankValInt
+
+Copyright (c) 2010, Unified Software
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * Neither the name of the <organization> nor the
+      names of its contributors may be used to endorse or promote products
+      derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL UNIFIED SOFTWARE BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

data/README

@@ -0,0 +1,82 @@
+== 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

data/Rakefile

@@ -0,0 +1,46 @@
+#BankValInt Rake file
+# 
+
+
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/testtask'
+require 'spec/rake/spectask'
+
+spec = Gem::Specification.new do |s|
+  s.name = 'BankValInt'
+  s.version = '0.0.2'
+  s.has_rdoc = true
+  s.extra_rdoc_files = ['README', 'LICENSE']
+  s.summary = 'Module containing classes to handle calls to Unified Software\'s International Bank Validation REST web services'
+  s.description = s.summary + " BankValInternational Services catered for by this module are getABAdetails, ibanValidate and getBankDetails2"
+  s.author = 'Alec Evans, Unified Software'
+  s.email = 'support@unifiedsoftware.co.uk'
+  s.homepage = 'http://www.unifiedsoftware.co.uk'
+  s.files = %w(LICENSE README Rakefile) + Dir.glob("{bin,lib,spec,test}/**/*")
+  s.require_path = "lib"
+  s.bindir = "bin"
+  s.license = "LICENSE"
+end
+
+Rake::GemPackageTask.new(spec) do |p|
+  p.gem_spec = spec
+  p.need_tar = true
+  p.need_zip = true
+end
+
+Rake::RDocTask.new do |rdoc|
+  files =['README', 'LICENSE', 'lib/**/*.rb']
+  rdoc.rdoc_files.add(files)
+  rdoc.main = "README" # page to start on
+  rdoc.title = "BankValInt Docs"
+  rdoc.rdoc_dir = 'doc/rdoc' # rdoc output folder
+  rdoc.options << '--line-numbers'
+end
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/**/*.rb']
+end

data/lib/BankValInternational.rb

@@ -0,0 +1,326 @@
+#=BankValInternational
+#
+#==Unified Software
+#
+#Module containing classes to handle calls to Unified Sotware's
+#BankValInternational web services
+#
+#*[BankValInternational::GetIBAN] Which handles calls to _IBANValidate_
+#
+#*[BankValInternational::GetSWIFT] Which handles calls to <i>GetBankDetails2</i>
+#
+#*[BankValInternational::GetABA] Which handles calls to _getABAdetails_
+#
+module BankValInternational
+  require 'net/https'
+  require 'uri'
+
+  #=BankValInternational::GetIban
+  #
+  #Class to control calls to _IBANValidate_
+  #
+  #=Synopsis
+  #
+  # requires 'BankValInternational'
+  #
+  # @obj1 = BankValInternational::GetIBAN.new
+  # @ans = obj1.bankval_int_ibanval('json','AN_IBAN_NUMBER','userID','PINNo')
+  #
+  class BankValInternational::GetIBAN
+    @userid
+    @pin
+    @iban
+    @format
+    @service_url
+    
+    #Method to control calls to _IBANValidate_
+    #
+    #==Parameters
+    #1.Return Format:: must be either 'json', 'xml' or 'csv'
+    #2.Iban Number:: the number for validation
+    #3.UserId:: can obtained from http://www.unifiedsoftware.co.uk/freetrial/free-trial-home.html
+    #4.PIN:: can obtained from http://www.unifiedsoftware.co.uk/freetrial/free-trial-home.html
+    #
+    #The parameters *must* be passed in the order shown above
+    #
+    #==Returns
+    #The response from the webservice is returned as a string in either:
+    #*XML format
+    #*json format
+    #*csv format
+    #depending on the Return Format Parameter passed in
+    #
+    def bankval_int_ibanval(*args)
+      @format = args[0].downcase
+      @iban = args[1]
+      @userid = args[2]
+      @pin = args[3]
+      if args.size !=4
+        return "ERROR - not enough parameters supplied"
+      end
+      format_validation
+      if @error_string != nil
+        format_error_string
+        return @error_string
+      end
+      build_req_url
+      return "#{BankValInternational::GoValidate.new.validate(@service_url)}"
+    end
+    
+    private
+    
+    #method to build the base request url for the REST call
+    def build_req_url()
+      @service_url = "bankvalint/ibanvalidator/userid/#{@userid}/pin/#{@pin}/iban/#{@iban}/#{@format}/"
+    end
+    def format_validation
+      @error_string = nil
+      if @format !~  /^json$|^xml$|^csv$/
+        @error_string = "INVALID - Result Format"
+      elsif @iban !~ /^[A-Z,0-9]{1,34}$/
+        @error_string = "INVALID - FORMAT"
+      elsif @pin !~ /^[0-9]{5}$/
+        @error_string = "ERROR - Invalid User ID/PIN"
+      elsif @userid !~ /^[a-zA-Z\-_][a-zA-Z][a-zA-Z]*\D\d\d\d$/
+        @error_string = "ERROR - Invalid User ID/PIN"
+      end
+    end
+
+    def format_error_string()
+      if @format == 'xml'
+        @error_string = "<?xml version=\"1.0\" encoding=\"UTF-8\"?><iban><result>" + @error_string + "</result></iban>"
+      elsif @format == 'json'
+        @error_string = "{\"result\":\"" + @error_string + "\"}"
+      end
+    end
+
+  end
+
+  #=BankValInternational::GetSWIFT
+  #
+  #Class to control calls to <i>getBankDetails2</i>
+  #
+  #=Synopsis
+  #
+  # requires 'BankValInternational'
+  #
+  # @obj1 = BankValInternational::GetSWIFT.new
+  # @ans = obj1.bankval_int_get_swift('xml','A_SWIFT_BIC','userID','PINNo')
+  #
+  class BankValInternational::GetSWIFT
+    @userid
+    @pin
+    @swiftbic
+    @format
+    @service_url
+
+    #Method to control calls to _getBankDetails2_
+    #
+    #==Parameters
+    #1.Return Format:: must be either 'json', 'xml' or 'csv'
+    #2.Swift BIC Number:: the number for validation
+    #3.UserId:: can obtained from http://www.unifiedsoftware.co.uk/freetrial/free-trial-home.html
+    #4.PIN:: can obtained from http://www.unifiedsoftware.co.uk/freetrial/free-trial-home.html
+    #
+    #The parameters *must* be passed in the order shown above
+    #
+    #==Returns
+    #The response from the webservice is returned as a string in either:
+    #*XML format
+    #*json format
+    #*csv format
+    #depending on the Return Format Parameter passed in
+    #
+    def bankval_int_getswift(*args)
+      @format = args[0].downcase
+      @swiftbic = args[1]
+      @userid = args[2]
+      @pin = args[3]
+      if args.size !=4
+        return "ERROR - not enough parameters supplied"
+      end
+      format_validation
+      if @error_string != nil
+        format_error_string
+        return @error_string
+      end
+      build_req_url
+      return "#{BankValInternational::GoValidate.new.validate(@service_url)}"
+    end
+
+    private
+
+    #method to build the base request url for the REST call
+    def build_req_url()
+      @service_url = "bankvalint/bankdetails2/userid/#{@userid}/pin/#{@pin}/swiftbic/#{@swiftbic}/#{@format}/"
+    end
+    def format_validation
+      @error_string = nil
+      if @format !~  /^json$|^xml$|^csv$/
+        @error_string = "INVALID - Result Format"
+      elsif @swiftbic !~ /^[A-Z,0-9]{8}$/
+        @error_string = "INVALID"
+      elsif @pin !~ /^[0-9]{5}$/
+        @error_string = "ERROR - Invalid User ID/PIN"
+      elsif @userid !~ /^[a-zA-Z\-_][a-zA-Z][a-zA-Z]*\D\d\d\d$/
+        @error_string = "ERROR - Invalid User ID/PIN"
+      end
+    end
+
+    def format_error_string()
+      if @format == 'xml'
+        @error_string = "<?xml version=\"1.0\" encoding=\"UTF-8\"?><swiftbic><result>" + @error_string + "</result><bic></bic><name1></name1><name2></name2><name3></name3><address1></address1><address2></address2><address3></address3><address4></address4><location></location><country></country></swiftbic>"
+      elsif @format == 'json'
+        @error_string = "{\"result\":\"" + @error_string + "\",\"bic\":\"\",\"name1\":\"\",\"name2\":\"\",\"name3\":\"\",\"address1\":\"\",\"address2\":\"\",\"address3\":\"\",\"address4\":\"\",\"location\":\"\",\"country\":\"\"}"
+      end
+    end
+    
+  end
+
+  #=BankValInternational::GetABA
+  #
+  #Class to control calls to _getABAdetails_
+  #
+  #=Synopsis
+  #
+  # requires 'BankValInternational'
+  #
+  # @obj1 = BankValInternational::GetABA.new
+  # @ans = obj1.bankval_int_ibanval('json','AN_ABA','userID','PINNo')
+  #
+  class BankValInternational::GetABA
+    @userid
+    @pin
+    @aba
+    @format
+    @service_url
+
+    #Method to control calls to _getABAdetails_
+    #
+    #==Parameters
+    #1.Return Format:: must be either 'json', 'xml' or 'csv'
+    #2.ABA Number:: the number for validation
+    #3.UserId:: can obtained from http://www.unifiedsoftware.co.uk/freetrial/free-trial-home.html
+    #4.PIN:: can obtained from http://www.unifiedsoftware.co.uk/freetrial/free-trial-home.html
+    #
+    #The parameters *must* be passed in the order shown above
+    #
+    #==Returns
+    #The response from the webservice is returned as a string in either:
+    #*XML format
+    #*json format
+    #*csv format
+    #depending on the Return Format Parameter passed in
+    #
+    def bankval_int_getaba(*args)
+      @format = args[0].downcase
+      @aba = args[1]
+      @userid = args[2]
+      @pin = args[3]
+      if args.size !=4
+        return "ERROR - not enough parameters supplied"
+      end
+      format_validation
+      if @error_string != nil
+        format_error_string
+        return @error_string
+      end
+      build_req_url
+      return "#{BankValInternational::GoValidate.new.validate(@service_url)}"
+    end
+
+    private
+
+    #method to build the base request url for the REST call
+    def build_req_url()
+      @service_url = "bankvalint/abadetails/userid/#{@userid}/pin/#{@pin}/aba/#{@aba}/#{@format}/"
+    end
+
+    def format_validation()
+      @error_string = nil
+      if @format !~  /^json$|^xml$|^csv$/
+        @error_string = "INVALID - Result Format"
+      elsif @aba !~ /^[0-9]{9}$/
+        @error_string = "INVALID"
+      elsif @pin !~ /^[0-9]{5}$/
+        @error_string = "ERROR - Invalid User ID/PIN"
+      elsif @userid !~ /^[a-zA-Z\-_][a-zA-Z][a-zA-Z]*\D\d\d\d$/
+        @error_string = "ERROR - Invalid User ID/PIN"
+      end
+    end
+
+    def format_error_string()
+      if @format == 'xml'
+        @error_string = "<?xml version=\"1.0\" encoding=\"UTF-8\"?><aba><result>" + @error_string + "</result><routingnumber></routingnumber><bankname></bankname><bankaddress></bankaddress><city></city><state></state><zipcode></zipcode><telephone></telephone><areacode></areacode><fips></fips><timezone></timezone><dst></dst><latitude></latitude><longitude></longitude><msa></msa><pmsa></pmsa><county></county></aba>"
+      elsif @format == 'json'
+        @error_string = "{\"result\":\"" + @error_string + "\",\"routingnumber\":\"\",\"bankname\":\"\",\"bankaddress\":\"\",\"city\":\"\",\"state\":\"\",\"zipcode\":\"\",\"telephone\":\"\",\"areacode\":\"\",\"fips\":\"\",\"timezone\":\"\",\"dst\":\"\",\"latitude\":\"\",\"longitude\":\"\",\"msa\":\"\",\"pmsa\":\"\",\"county\":\"\"}"
+      end
+    end
+  end
+
+  #=BankValInternational::GoValidate
+  #
+  #Class to make calls to Unified Softwares web services
+  #
+  #
+  class BankValInternational::GoValidate
+    @base_url
+
+    #Method to make REST web service calls and return response
+    #if call to the main data centre fails the back up method is called
+    #to make a call to the back up data centre
+    #
+    #==Parameters
+    #1. Serv_url is the services part of the URL for the REST call
+    #
+    #==Returns
+    #The response from the web service in requested format (XML,JSON or CSV)
+    #
+    #
+    def validate(ser_url)
+      @base_url = "https://www.unifiedsoftware.co.uk/services/"
+      uriobj = URI.parse(@base_url)
+      full_path = uriobj.path + ser_url
+      conn = Net::HTTP.new(uriobj.host, uriobj.port)
+      conn.use_ssl = true
+      conn.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      begin
+        webresponse = conn.get2(URI.encode(full_path))
+      rescue Exception => err
+        webresponse = failover(ser_url)
+      end
+      if webresponse == nil
+        return "Unknown Error-Check Local Network"
+      end
+      return webresponse.body
+    end
+
+    #Method to make backup REST web service calls and return response
+    #if call to the main data centre fails this method is called
+    #to make a call to the back up data centre
+    #
+    #==Parameters
+    #1. Serv_url is the services part of the URL for the REST call
+    #
+    #==Returns
+    #The response from the web service as a string in requested format (XML,JSON or CSV)
+    #or..
+    #error message in case of error
+    #
+    def failover(ser_url)
+      @base_url = "https://www.unifiedservices.co.uk/services/"
+      uriobj = URI.parse(@base_url)
+      full_path = uriobj.path + ser_url
+      conn = Net::HTTP.new(uriobj.host, uriobj.port)
+      conn.use_ssl = true
+      conn.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      begin
+        webresponse = conn.get2(URI.encode(full_path))
+      rescue Exception => err
+        return "Network Error" + err
+      end
+      return webresponse
+    end
+  end
+
+end

data/test/bv_int_test.rb

@@ -0,0 +1,238 @@
+#internal gem test suite for BankValInternational
+
+$:.unshift File.join(File.dirname(__FILE__),'..','lib')
+
+require 'test/unit'
+require 'BankValInternational'
+require 'rexml/document'
+require 'rubygems'
+require 'json'
+
+  class BvIntGetAbaTest < Test::Unit::TestCase
+    @obj
+    def setup
+      @obj = BankValInternational::GetABA.new
+    end
+    
+    def test_return_validation_aba
+      #test1_1 'J-Son' is rejected as invalid result format
+      assert_match /INVALID - Result Format/,@obj.bankval_int_getaba('J-Son','12345678','abcd123','12345')
+      #tests 1_2 to 1_4 test that 'json','xml','csv' are not rejected as invalis result formats
+      assert_no_match /INVALID - Result Format/,@obj.bankval_int_getaba('json','12345678','abcd123','12345')
+      assert_no_match /INVALID - Result Format/,@obj.bankval_int_getaba('xml','12345678','abcd123','12345')
+      assert_no_match /INVALID - Result Format/,@obj.bankval_int_getaba('csv','12345678','abcd123','12345')
+      #test1_5 tests that csv is returned as the first part of the string will be 'INVALID'
+      assert_match /^INVALID/,@obj.bankval_int_getaba('csv','12345678','abcd123','12345')
+      #test1_6 tests 'json' fails the csv test5
+      assert_no_match /^INVALID/,@obj.bankval_int_getaba('json','12345678','abcd123','12345')
+      #test1_7 tests xml is returned as no parseError will be raised
+      assert_nothing_raised{
+        REXML::Document.new(@obj.bankval_int_getaba('xml','12345678','abcd123','12345')).root.name
+      }
+      #test1_8 tests 'json' fails this xml parse i.e. json doesn't return xml
+      assert_raise (NoMethodError){
+        REXML::Document.new(@obj.bankval_int_getaba('json','12345678','abcd123','12345')).root.name
+      }
+      #test1_9 tests 'csv' fails xml parse i.e. csv doesn't return xml
+      assert_raise (NoMethodError){
+        REXML::Document.new(@obj.bankval_int_getaba('csv','12345678','abcd123','12345')).root.name
+      }
+      #test1_10 tests 'xml' doesn't return json as parse error is raised
+      assert_raise (JSON::ParserError) {
+        JSON[@obj.bankval_int_getaba('xml','12345678','abcd123','12345')]
+      }
+      #test1_11 tests 'csv' doesn't return json
+      assert_raise (JSON::ParserError) {
+        JSON[@obj.bankval_int_getaba('csv','12345678','abcd123','12345')]
+      }
+      #test1_12 tests ''json' returns valid (parsable) json
+      assert_nothing_raised{
+        JSON[@obj.bankval_int_getaba('json','12345678','abcd123','12345')]
+      }
+    end
+
+    def test_aba_number_validation
+      #test2_1 check under sized aba is rejected (invalid userid/pin would error first on server)
+      assert_match /^\{"result":"INVALID","routingnumber"/, @obj.bankval_int_getaba('json','12345678','abcd123','12345')
+      #test2_2 check oversized aba is rejected
+      assert_match /^\{"result":"INVALID","routingnumber"/, @obj.bankval_int_getaba('json','1234567890','abcd123','12345')
+      #test2_3 check leading alpha is rejected
+      assert_match /^\{"result":"INVALID","routingnumber"/, @obj.bankval_int_getaba('json','l12345678','abcd123','12345')
+      #test2_4 check trailing alpha is rejected
+      assert_match /^\{"result":"INVALID","routingnumber"/, @obj.bankval_int_getaba('json','12345678g','abcd123','12345')
+      #test2_5 check embedded alpha is rejected
+      assert_match /^\{"result":"INVALID","routingnumber"/, @obj.bankval_int_getaba('json','1234S5678','abcd123','12345')
+      #test2_6 check correct size passes (error will be ID/PIN from server)
+      assert_match /^\{"result":"ERROR - Invalid User ID\/PIN","routingnumber"/, @obj.bankval_int_getaba('json','123456789','abcd123','12345')
+    end
+
+    def test_userid_validation #test with wireshark as well as returns are identical from server and client validation
+      #test3_1 too short user id 2nd element
+      assert_match /^\{"result":"ERROR - Invalid User ID\/PIN","routingnumber"/, @obj.bankval_int_getaba('json','123456789','abcd12','12345')
+      #test3_2 too long user id 2nd element
+      assert_match /^\{"result":"ERROR - Invalid User ID\/PIN","routingnumber"/, @obj.bankval_int_getaba('json','123456789','abcd1234','12345')
+      #test3_3 too short first element
+      assert_match /^\{"result":"ERROR - Invalid User ID\/PIN","routingnumber"/, @obj.bankval_int_getaba('json','123456789','ab123','12345')
+    end
+
+    def test_pin #test with wireshark as well (look for client hellos these will match each call to either server)
+      #test4_1 too short
+      assert_match /^\{"result":"ERROR - Invalid User ID\/PIN","routingnumber"/, @obj.bankval_int_getaba('json','123456789','abcd012','1234')
+      #test4_2 too long
+      assert_match /^\{"result":"ERROR - Invalid User ID\/PIN","routingnumber"/, @obj.bankval_int_getaba('json','123456789','abcd123','123456')
+      #test4_3 bad chars
+      assert_match /^\{"result":"ERROR - Invalid User ID\/PIN","routingnumber"/, @obj.bankval_int_getaba('json','123456789','abcd123','12{45')    end
+  end
+
+  class BvIntGetSWIFTTest < Test::Unit::TestCase
+    @obj
+    def setup
+      @obj = BankValInternational::GetSWIFT.new
+    end
+
+    def test_return_validation_aba
+      #test1_1 'J-Son' is rejected as invalid result format
+      assert_match /INVALID - Result Format/,@obj.bankval_int_getswift('J-Son','ABICAB99K','abcd123','12345')
+      #tests 1_2 to 1_4 test that 'json','xml','csv' are not rejected as invalis result formats
+      assert_no_match /INVALID - Result Format/,@obj.bankval_int_getswift('json','ABICAB99K','abcd123','12345')
+      assert_no_match /INVALID - Result Format/,@obj.bankval_int_getswift('xml','ABICAB99K','abcd123','12345')
+      assert_no_match /INVALID - Result Format/,@obj.bankval_int_getswift('csv','ABICAB99K','abcd123','12345')
+      #test1_5 tests that csv is returned as the first part of the string will be 'INVALID'
+      assert_match /^INVALID/,@obj.bankval_int_getswift('csv','ABICAB9','abcd123','12345')
+      #test1_6 tests 'json' fails the csv test5
+      assert_no_match /^INVALID/,@obj.bankval_int_getswift('json','ABICAB99K','abcd123','12345')
+      #test1_7 tests xml is returned as no parseError will be raised
+      assert_nothing_raised{
+        REXML::Document.new(@obj.bankval_int_getswift('xml','ABICAB99K','abcd123','12345')).root.name
+      }
+      #test1_8 tests 'json' fails this xml parse i.e. json doesn't return xml
+      assert_raise (NoMethodError){
+        REXML::Document.new(@obj.bankval_int_getswift('json','ABICAB99K','abcd123','12345')).root.name
+      }
+      #test1_9 tests 'csv' fails xml parse i.e. csv doesn't return xml
+      assert_raise (NoMethodError){
+        REXML::Document.new(@obj.bankval_int_getswift('csv','ABICAB99K','abcd123','12345')).root.name
+      }
+      #test1_10 tests 'xml' doesn't return json as parse error is raised
+      assert_raise (JSON::ParserError) {
+        JSON[@obj.bankval_int_getswift('xml','ABICAB99K','abcd123','12345')]
+      }
+      #test1_11 tests 'csv' doesn't return json
+      assert_raise (JSON::ParserError) {
+        JSON[@obj.bankval_int_getswift('csv','ABICAB99K','abcd123','12345')]
+      }
+      #test1_12 tests ''json' returns valid (parsable) json
+      assert_nothing_raised{
+        JSON[@obj.bankval_int_getswift('json','ABICAB99K','abcd123','12345')]
+      }
+    end
+
+    def test_iban_number_validation
+      #test2_1 check under sized IBAN is rejected (invalid userid/pin would error first on server)
+      assert_match /^\{"result":"INVALID","bic"/, @obj.bankval_int_getswift('json','ABICAB9','abcd123','12345')
+      #test2_2 check oversized bic is rejected
+      assert_match /^\{"result":"INVALID","bic"/, @obj.bankval_int_getswift('json','ABICAB9990','abcd123','12345')
+      #test2_3 check leading special char is rejected
+      assert_match /^\{"result":"INVALID","bic"/, @obj.bankval_int_getswift('json','?BICAB99','abcd123','12345')
+      #test2_4 check trailing special char is rejected
+      assert_match /^\{"result":"INVALID","bic"/, @obj.bankval_int_getswift('json','ABICAB9)','abcd123','12345')
+      #test2_5 check embedded special char is rejected
+      assert_match /^\{"result":"INVALID","bic"/, @obj.bankval_int_getswift('json','ABIC@B99','abcd123','12345')
+      #test2_6 check correct size passes (error will be ID/PIN from server)
+      assert_match /^\{"result":"ERROR - Invalid User ID\/PIN","bic"/, @obj.bankval_int_getswift('json','ABIBAB99','abcd123','12345')
+    end
+
+    def test_userid_validation #test with wireshark as well as returns are identical from server and client validation
+      #test3_1 too short user id 2nd element
+      assert_match /^\{"result":"ERROR - Invalid User ID\/PIN","bic"/, @obj.bankval_int_getswift('json','ABICAB99','abcd12','12345')
+      #test3_2 too long user id 2nd element
+      assert_match /^\{"result":"ERROR - Invalid User ID\/PIN","bic"/, @obj.bankval_int_getswift('json','ABICAB99','abcd1234','12345')
+      #test3_3 too short first element
+      assert_match /^\{"result":"ERROR - Invalid User ID\/PIN","bic"/, @obj.bankval_int_getswift('json','ABICAB99','ab123','12345')
+    end
+
+    def test_pin #test with wireshark as well (look for client hellos these will match each call to either server)
+      #test4_1 too short
+      assert_match /^\{"result":"ERROR - Invalid User ID\/PIN","bic"/, @obj.bankval_int_getswift('json','ABICAB99','abcd012','1234')
+      #test4_2 too long
+      assert_match /^\{"result":"ERROR - Invalid User ID\/PIN","bic"/, @obj.bankval_int_getswift('json','ABICAB99','abcd123','123456')
+      #test4_3 bad chars
+      assert_match /^\{"result":"ERROR - Invalid User ID\/PIN","bic"/, @obj.bankval_int_getswift('json','ABICAB99','abcd123','12{45')
+    end
+  end
+
+  class BvIntGetIBANTest < Test::Unit::TestCase
+    @obj
+    def setup
+      @obj = BankValInternational::GetIBAN.new
+    end
+
+    def test_return_validation_iban
+      #test1_1 'J-Son' is rejected as invalid result format
+      assert_match /INVALID - Result Format/,@obj.bankval_int_ibanval('J-Son','ABCDEFGHIJKLMNOPQRSTUVWXYZ123456789','abcd123','12345')
+      #tests 1_2 to 1_4 test that 'json','xml','csv' are not rejected as invalis result formats
+      assert_no_match /INVALID - Result Format/,@obj.bankval_int_ibanval('json','ABCDEFGHIJKLMNOPQRSTUVWXYZ123456789','abcd123','12345')
+      assert_no_match /INVALID - Result Format/,@obj.bankval_int_ibanval('xml','ABCDEFGHIJKLMNOPQRSTUVWXYZ123456789','abcd123','12345')
+      assert_no_match /INVALID - Result Format/,@obj.bankval_int_ibanval('csv','ABCDEFGHIJKLMNOPQRSTUVWXYZ123456789','abcd123','12345')
+      #test1_5 tests that csv is returned as the first part of the string will be 'INVALID'
+      assert_match /^INVALID/,@obj.bankval_int_ibanval('csv','ABCDEFGHIJKLMNOPQRSTUVWXYZ123456789','abcd123','12345')
+      #test1_6 tests 'json' fails the csv test5
+      assert_no_match /^INVALID/,@obj.bankval_int_ibanval('json','ABCDEFGHIJKLMNOPQRSTUVWXYZ123456789','abcd123','12345')
+      #test1_7 tests xml is returned as no parseError will be raised
+      assert_nothing_raised{
+        REXML::Document.new(@obj.bankval_int_ibanval('xml','ABCDEFGHIJKLMNOPQRSTUVWXYZ123456789','abcd123','12345')).root.name
+      }
+      #test1_8 tests 'json' fails this xml parse i.e. json doesn't return xml
+      assert_raise (NoMethodError){
+        REXML::Document.new(@obj.bankval_int_ibanval('json','ABCDEFGHIJKLMNOPQRSTUVWXYZ123456789','abcd123','12345')).root.name
+      }
+      #test1_9 tests 'csv' fails xml parse i.e. csv doesn't return xml
+      assert_raise (NoMethodError){
+        REXML::Document.new(@obj.bankval_int_ibanval('csv','ABCDEFGHIJKLMNOPQRSTUVWXYZ123456789','abcd123','12345')).root.name
+      }
+      #test1_10 tests 'xml' doesn't return json as parse error is raised
+      assert_raise (JSON::ParserError) {
+        JSON[@obj.bankval_int_ibanval('xml','ABCDEFGHIJKLMNOPQRSTUVWXYZ123456789','abcd123','12345')]
+      }
+      #test1_11 tests 'csv' doesn't return json
+      assert_raise (JSON::ParserError) {
+        JSON[@obj.bankval_int_ibanval('csv','ABCDEFGHIJKLMNOPQRSTUVWXYZ123456789','abcd123','12345')]
+      }
+      #test1_12 tests ''json' returns valid (parsable) json
+      assert_nothing_raised{
+        JSON[@obj.bankval_int_ibanval('json','ABCDEFGHIJKLMNOPQRSTUVWXYZ123456789','abcd123','12345')]
+      }
+    end
+
+    def test_iban_number_validation
+      #test2_1 check oversized iban is rejected
+      assert_match /^\{"result":"INVALID - FORMAT"/, @obj.bankval_int_ibanval('json','ABCDEFGHIJKLMNOPQRSTUVWXYZ123456789','abcd123','12345')
+      #test2_2 check leading special char is rejected
+      assert_match /^\{"result":"INVALID - FORMAT"/, @obj.bankval_int_ibanval('json','*ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567','abcd123','12345')
+      #test2_3 check trailing special char is rejected
+      assert_match /^\{"result":"INVALID - FORMAT"/, @obj.bankval_int_ibanval('json','ABCDEFGHIJKLMNOPQRSTUVWXYZ123:','abcd123','12345')
+      #test2_4 check embedded special char is rejected
+      assert_match /^\{"result":"INVALID - FORMAT"/, @obj.bankval_int_ibanval('json','SJKDFHJKSGHKJDFGH&&KLFJGDKLFJF','abcd123','12345')
+      #test2_5 check correct size passes (error will be ID/PIN from server)
+      assert_match /^\{"result":"ERROR - Invalid User ID\/PIN"/, @obj.bankval_int_ibanval('json','ABCDEFGHIJKLMNOPQRSTUVWXYZ12345678','abcd123','12345')
+    end
+
+    def test_userid_validation #test with wireshark as well as returns are identical from server and client validation
+      #test3_1 too short user id 2nd element
+      assert_match /^\{"result":"ERROR - Invalid User ID\/PIN"/, @obj.bankval_int_ibanval('json','ABCDEFGHIJKLMNOPQRSTUVWXYZ12345678','abcd12','12345')
+      #test3_2 too long user id 2nd element
+      assert_match /^\{"result":"ERROR - Invalid User ID\/PIN"/, @obj.bankval_int_ibanval('json','ABCDEFGHIJKLMNOPQRSTUVWXYZ12345678','abcd1234','12345')
+      #test3_3 too short first element
+      assert_match /^\{"result":"ERROR - Invalid User ID\/PIN"/, @obj.bankval_int_ibanval('json','ABCDEFGHIJKLMNOPQRSTUVWXYZ12345678','ab123','12345')
+    end
+
+    def test_pin #test with wireshark as well (look for client hellos these will match each call to either server)
+      #test4_1 too short
+      assert_match /^\{"result":"ERROR - Invalid User ID\/PIN"/, @obj.bankval_int_ibanval('json','ABCDEFGHIJKLMNOPQRSTUVWXYZ12345678','abcd012','1234')
+      #test4_2 too long
+      assert_match /^\{"result":"ERROR - Invalid User ID\/PIN"/, @obj.bankval_int_ibanval('json','ABCDEFGHIJKLMNOPQRSTUVWXYZ12345678','abcd123','123456')
+      #test4_3 bad chars
+      assert_match /^\{"result":"ERROR - Invalid User ID\/PIN"/, @obj.bankval_int_ibanval('json','ABCDEFGHIJKLMNOPQRSTUVWXYZ12345678','abcd123','12{45')
+    end
+  end
+

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: BankValInt
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Alec Evans, Unified Software
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-29 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: Module containing classes to handle calls to Unified Software's International Bank Validation REST web services BankValInternational Services catered for by this module are getABAdetails, ibanValidate and getBankDetails2
+email: support@unifiedsoftware.co.uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+files: 
+- LICENSE
+- README
+- Rakefile
+- lib/BankValInternational.rb
+- test/bv_int_test.rb
+has_rdoc: true
+homepage: http://www.unifiedsoftware.co.uk
+licenses: 
+- LICENSE
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Module containing classes to handle calls to Unified Software's International Bank Validation REST web services
+test_files: []
+