BankValUK 0.0.2

data/LICENSE

@@ -0,0 +1,27 @@
+== BankValUK
+
+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,81 @@
+== BankValUK
+
+== Unified Software (c) 2010
+
+==SYNOPSIS
+
+    require 'rubygems' #using uppercase letters may load the file more than once which can cause 'already set constant' warnings
+    require 'bankval::uk'
+
+    obj = BankVal::UK.new
+    ans = obj.bank_val_uk('json','00-01-26','abcd123','12345')
+
+==Description
+
+This Gem controls the calling of REST web services from Unified Software's UK 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:
+
+[BankValPlus2]Validates UK bank sort code / account numbers. Returns transposed sort code and account number plus latest EISCD (Extended Industry Sorting Code Directory) data.
+
+    object = BankVal::UK.new
+    method = object.bank_val_uk(format,sortcode,accountno,userid,pin)
+
+
+[getBranchDetails2]Look up UK bank branch information using latest EISCD (Extended Industry Sorting Code Directory) data.
+
+    object = BankVal::UK.new
+    method = object.bank_val_uk(format,sortcode,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 BankValUK gem from Rubygems.org by either;
+
+*searching for BankValUK 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 'bankval'
+
+==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. Sort Code:: the IBAN to be validated
+
+3. Account Number:: the account number to be validated (optional)
+
+4. UserID:: available from www.unifiedsoftware.co.uk
+
+5. PIN:: available from www.unifiedsoftware.co.uk
+
+The parameters must be passed in the order shown although account number is optional. In the case of an
+account number not being passed in the web service getBankDetails2 will be called rather than bankValUKPlus2.
+
+==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
+
+==BankValUK Ruby Gem
+
+==Unified Software 2010
+==www.unifiedsoftware.co.uk

data/Rakefile

@@ -0,0 +1,48 @@
+# 
+# BankValUK rakefile
+ 
+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 = 'BankValUK'
+  s.version = '0.0.2'
+  s.has_rdoc = true
+  s.extra_rdoc_files = ['README', 'LICENSE']
+  s.summary = 'Handles calls to Unified Softwares BankValUK web services'
+  s.description = s.summary + ' including BankValPlus2 which validates UK bank accounts and returns EISCD data, and getBranchDetails2 which validates UK sort codes and returns EISCD data.'
+  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"
+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 = "BankValUK 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
+
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/**/*.rb']
+end

data/lib/BankVal.rb

@@ -0,0 +1,286 @@
+#=BankValInternational
+#
+#==Unified Software
+#
+#Module containing classes to handle calls to Unified Sotware's
+#BankValUK web services
+#
+#*[BankVal::UK] Which handles calls to <i>BankValPlus2 GetBranchDetails2</i>
+#
+module BankVal
+
+require 'net/https'
+require 'uri'
+
+  #=BankVal::UK
+  #
+  #Class to control calls to <i>BankValPlus2 GetBranchDetails2</i>
+  #
+  #=Synopsis
+  #
+  # requires 'BankVal::UK'
+  #
+  # @obj1 = BankVal::UK.new
+  # @ans = obj1.bank_val_uk('json','A_SORT_CODE','userID','PINNo')
+  #
+  #or..
+  # 
+  # @obj1 = BankVal::UK.new
+  # @ans = obj1.bank_val_uk('json','A_SORT_CODE','AN_ACCOUNT_No','userID','PINNo')
+  #
+  class BankVal::UK
+    @userid
+    @pin
+    @account
+    @sortcode
+    @format
+    @service_url
+    @error_string
+
+    #Method to control calls to _BankValPlus2_ _GetBranchDetails2_
+    #
+    #This method automatically controls calls to Unified software's
+    #BankValUK REST web services
+    #
+    #==Parameters
+    #1.Return Format:: Either 'csv','json','xml'
+    #2.SortCode:: The sortcode to be validated
+    #3.Account:: The account number to be validated (optional)
+    #4.UserId:: can obtained from http://www.unifiedsoftware.co.uk/freetrial/free-trial-home.html
+    #5.PIN:: can obtained from http://www.unifiedsoftware.co.uk/freetrial/free-trial-home.html
+    #
+    #The parameters *must* be passed in the order described above,
+    #although the Account number is optional. Supplying a return format,sort code and login
+    #details only will result in getBranchDetails being called rather than BankValPlus2.
+    #
+    #==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 bank_val_uk(*args)      
+      @format = args[0].downcase
+      @sortcode = args[1].gsub(/[- .]/, "")
+      case args.size
+      when 5
+        @account = args[2]
+        @userid = args[3]
+        @pin = args[4]
+      when 4
+        @userid = args[2]
+        @pin = args[3]
+      else
+        return "ERROR - not enough parameters supplied"
+      end
+      format_validation
+      if @error_string != nil
+        format_error_string
+        @error_string.gsub!(/\n/,'')
+        return @error_string
+      end
+      build_req_url
+      return "#{BankVal::GoValidate.new.validate(@service_url)}"
+    end
+
+    private
+    
+    #method to build the base request url for the REST call
+    def build_req_url()
+      if @account != nil
+        @service_url = "bankvaluk/bankvalplus2/userid/#{@userid}/pin/#{@pin}/sortcode/#{@sortcode}/account/#{@account}/#{@format}/"
+      else
+        @service_url = "bankvaluk/branchdets2/userid/#{@userid}/pin/#{@pin}/sortcode/#{@sortcode}/#{@format}/"
+      end
+
+    end  
+
+    #method to validate input and create error messages if they are invalid
+    def format_validation()
+      @error_string = nil
+      if @format !~  /^json$|^xml$|^csv$/
+        @error_string = "INVALID - Result Format"
+      elsif @account != nil && @account !~ /^[0-9]{7,10}$/
+        @error_string = "INVALID - Account"
+      elsif @sortcode !~ /^[0-9]{6}$/
+        @error_string = "INVALID - Sortcode"
+      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
+
+    #method to wrap error string in the correct format, indentation should be left as it is
+    def format_error_string()
+      if @format == "xml" && @account == nil
+        @error_string = "<?xml version=\"1.0\" encoding=\"UTF-8\"?><branchdets><result>" + @error_string + "</result>
+<sortcode></sortcode><bicbank></bicbank><bicbranch></bicbranch><subbranchsuffix></subbranchsuffix><bankname></bankname>
+<owningbank></owningbank><longbank1></longbank1><longbank2></longbank2><ownbc></ownbc><ccode></ccode>
+<supervisorybody></supervisorybody><deletedate></deletedate><changedate></changedate><printindicator></printindicator>
+<bacsstatus></bacsstatus><bacschangedate></bacschangedate><bacsclosedate></bacsclosedate><bacsredirectfrom></bacsredirectfrom>
+<bacsredtoscode></bacsredtoscode><bacssettbank></bacssettbank><bacssettsec></bacssettsec><bacssettsubsec>
+</bacssettsubsec><bacshandbank></bacshandbank><bacshandst></bacshandst><bacsaccnumflg></bacsaccnumflg>
+<bacsddiflg></bacsddiflg><bacsdrdisallowed></bacsdrdisallowed><bacscrdisallowed></bacscrdisallowed>
+<bacscudisallowed></bacscudisallowed><bacsprdisallowed></bacsprdisallowed><bacsbsdisallowed></bacsbsdisallowed>
+<bacsdvdisallowed></bacsdvdisallowed><bacsaudisallowed></bacsaudisallowed><spare1></spare1><spare2></spare2>
+<spare3></spare3><spare4></spare4><chapsretind></chapsretind><chapssstatus></chapssstatus><chapsschangedate>
+</chapsschangedate><chapssclosedate></chapssclosedate><chapsssettmem></chapsssettmem><chapssrbicbank></chapssrbicbank>
+<chapssrbicbr></chapssrbicbr><chapsestatus></chapsestatus><chapsechangedate></chapsechangedate><chapseclosedate>
+</chapseclosedate><chapserbicbank></chapserbicbank><chapserbicbr></chapserbicbr><chapsesettmem></chapsesettmem>
+<chapseretind></chapseretind><chapseswift></chapseswift><spare5></spare5><ccccstatus></ccccstatus><ccccchangedate>
+</ccccchangedate><ccccclosedate></ccccclosedate><ccccsettbank></ccccsettbank><ccccdasc></ccccdasc><ccccretind></ccccretind>
+<ccccgbni></ccccgbni><fpsstatus></fpsstatus><fpschangedate></fpschangedate><fpsclosedate></fpsclosedate><fpsredirectfrom>
+</fpsredirectfrom><fpsredirecttosc></fpsredirecttosc><fpssettbankct></fpssettbankct><fpsspare1></fpsspare1><fpssettbankbc>
+</fpssettbankbc><fpshandbankct></fpshandbankct><fpsspare2></fpsspare2><fpshandbankbc></fpshandbankbc><fpsaccnumflag>
+</fpsaccnumflag><fpsagencytype></fpsagencytype><fpsspare3></fpsspare3><printbti></printbti><printmainsc></printmainsc>
+<printmajlocname></printmajlocname><printminlocname></printminlocname><printbranchname></printbranchname><printsecentryind>
+</printsecentryind><printsecbrname></printsecbrname><printfbrtit1></printfbrtit1><printfbrtit2></printfbrtit2><printfbrtit3>
+</printfbrtit3><printaddr1></printaddr1><printaddr2></printaddr2><printaddr3></printaddr3><printaddr4></printaddr4>
+<printtown></printtown><printcounty></printcounty><printpcode1></printpcode1><printpcode2></printpcode2><printtelarea>
+</printtelarea><printtelno></printtelno><printtelarea2></printtelarea2><printtelno2></printtelno2></branchdets>"
+      elsif @format == "xml" && @account != nil
+        @error_string = "<?xml version=\"1.0\" encoding=\"UTF-8\"?><bankvalplus><result>" + @error_string + "</result>
+<transposedsortcode></transposedsortcode><transposedaccount></transposedaccount><sortcode>
+</sortcode><bicbank></bicbank><bicbranch></bicbranch><subbranchsuffix></subbranchsuffix>
+<bankname></bankname><owningbank></owningbank><longbank1></longbank1><longbank2></longbank2>
+<ownbc></ownbc><ccode></ccode><supervisorybody></supervisorybody><deletedate></deletedate>
+<changedate></changedate><printindicator></printindicator><bacsstatus></bacsstatus><bacschangedate>
+</bacschangedate><bacsclosedate></bacsclosedate><bacsredirectfrom></bacsredirectfrom><bacsredtoscode>
+</bacsredtoscode><bacssettbank></bacssettbank><bacssettsec></bacssettsec><bacssettsubsec></bacssettsubsec>
+<bacshandbank></bacshandbank><bacshandst></bacshandst><bacsaccnumflg></bacsaccnumflg><bacsddiflg></bacsddiflg>
+<bacsdrdisallowed></bacsdrdisallowed><bacscrdisallowed></bacscrdisallowed><bacscudisallowed></bacscudisallowed>
+<bacsprdisallowed></bacsprdisallowed><bacsbsdisallowed></bacsbsdisallowed><bacsdvdisallowed></bacsdvdisallowed>
+<bacsaudisallowed></bacsaudisallowed><spare1></spare1><spare2></spare2><spare3></spare3><spare4></spare4>
+<chapsretind></chapsretind><chapssstatus></chapssstatus><chapsschangedate></chapsschangedate><chapssclosedate>
+</chapssclosedate><chapsssettmem></chapsssettmem><chapssrbicbank></chapssrbicbank><chapssrbicbr></chapssrbicbr>
+<chapsestatus></chapsestatus><chapsechangedate></chapsechangedate><chapseclosedate></chapseclosedate><chapserbicbank>
+</chapserbicbank><chapserbicbr></chapserbicbr><chapsesettmem></chapsesettmem><chapseretind></chapseretind><chapseswift>
+</chapseswift><spare5></spare5><ccccstatus></ccccstatus><ccccchangedate></ccccchangedate><ccccclosedate></ccccclosedate>
+<ccccsettbank></ccccsettbank><ccccdasc></ccccdasc><ccccretind></ccccretind><ccccgbni></ccccgbni><fpsstatus></fpsstatus>
+<fpschangedate></fpschangedate><fpsclosedate></fpsclosedate><fpsredirectfrom></fpsredirectfrom><fpsredirecttosc></fpsredirecttosc>
+<fpssettbankct></fpssettbankct><fpsspare1></fpsspare1><fpssettbankbc></fpssettbankbc><fpshandbankct></fpshandbankct>
+<fpsspare2></fpsspare2><fpshandbankbc></fpshandbankbc><fpsaccnumflag></fpsaccnumflag><fpsagencytype></fpsagencytype>
+<fpsspare3></fpsspare3><printbti></printbti><printmainsc></printmainsc><printmajlocname></printmajlocname><printminlocname>
+</printminlocname><printbranchname></printbranchname><printsecentryind></printsecentryind><printsecbrname>
+</printsecbrname><printfbrtit1></printfbrtit1><printfbrtit2></printfbrtit2><printfbrtit3></printfbrtit3><printaddr1>
+</printaddr1><printaddr2></printaddr2><printaddr3></printaddr3><printaddr4></printaddr4><printtown></printtown><printcounty>
+</printcounty><printpcode1></printpcode1><printpcode2></printpcode2><printtelarea></printtelarea><printtelno></printtelno>
+<printtelarea2></printtelarea2><printtelno2></printtelno2></bankvalplus>"
+      elsif @format == "json" && @account == nil
+        @error_string = "{\"result\":\"" + @error_string + "\",\"sortcode\":\"\",\"bicbank\":\"\",\"bicbranch\":\"\",
+\"subbranchsuffix\":\"\",\"bankname\":\"\",\"owningbank\":\"\",\"longbank1\":\"\",\"longbank2\":\"\",\"ownbc\":
+\"\",\"ccode\":\"\",\"supervisorybody\":\"\",\"deletedate\":\"\",\"changedate\":\"\",\"printindicator\":\"\",\"bacsstatus\":
+\"\",\"bacschangedate\":\"\",\"bacsclosedate\":\"\",\"bacsredirectfrom\":\"\",\"bacsredtoscode\":\"\",\"bacssettbank\":\"\",\"
+bacssettsec\":\"\",\"bacssettsubsec\":\"\",\"bacshandbank\":\"\",\"bacshandst\":\"\",\"bacsaccnumflag\":\"\",\"bacsddiflg\":\"\"
+,\"bacsdrdisallowed\":\"\",\"bacscrdisallowed\":\"\",\"bacscudisallowed\":\"\",\"bacsprdisallowed\"
+:\"\",\"bacsbsdisallowed\":\"\",\"bacsdvdisallowed\":\"\",\"bacsaudisallowed\":\"\",\"spare1\":\"\",\"spare2\":\"\"
+,\"spare3\":\"\",\"spare4\":\"\",\"chapsretind\":\"\",\"chapssstatus\":\"\",\"chapsschangedate\":\"\",\"chapssclosedate\"
+:\"\",\"chapsssettmem\":\"\",\"chapssrbicbank\":\"\",\"chapssrbicbr\":\"\",\"chapsestatus\":\"\",\"chapsechangedate\":\"\"
+,\"chapseclosedate\":\"\",\"chapserbicbank\":\"\",\"chapserbicbr\":\"\",\"chapsesettmem\":\"\",\"chapseretind\":\"\"
+,\"chapseswift\":\"\",\"spare5\":\"\",\"ccccstatus\":\"\",\"ccccchangedate\":\"\",\"ccccclosedate\":\"\",\"ccccsettbank\"
+:\"\",\"ccccdasc\":\"\",\"ccccretind\":\"\",\"ccccgbni\":\"\",\"fpsstatus\":\"\",\"fpschangedate\":\"\",\"fpsclosedate\"
+:\"\",\"fpsredirectfrom\":\"\",\"fpsredirecttosc\":\"\",\"fpssettbankct\":\"\",\"fpsspare1\":\"\",\"fpssettbankbc\"
+:\"\",\"fpshandbankct\":\"\",\"fpsspare2\":\"\",\"fpshandbankbc\":\"\",\"fpsaccnumflag\":\"\",\"fpsagencytype\":\"\",\"
+fpsspare3\":\"\",\"printbti\":\"\",\"printmainsc\":\"\",\"printmajlocname\":\"\",\"printminlocname\":\"\",\"printbranchname\"
+:\"\",\"printsecentryind\":\"\",\"printsecbrname\":\"\",\"printfbrtit1\":\"\",\"printfbrtit2\":\"\",\"printfbrtit3\":\"\",\"
+printaddr1\":\"\",\"printaddr2\":\"\",\"printaddr3\":\"\",\"printaddr4\":\"\",\"printtown\":\"\",\"printcounty\"
+:\"\",\"printpcode1\":\"\",\"printpcode2\":\"\",\"printtelarea\":\"\",\"printtelno\":\"\",\"printtelarea2\":\"\",\"
+printtelno2\":\"\"}"
+      elsif @format == "json"
+        @error_string = "{\"result\":\"" + @error_string + "\",\"transposedsortcode\":\"\",\"transposedaccount\":\"\",\"sortcode\":\"\",\"bicbank\":\"\",\"bicbranch\":\"\",\"subbranchsuffix\":\"\",\"
+bankname\":\"\",\"owningbank\":\"\",\"longbank1\":\"\",\"longbank2\":\"\",\"ownbc\":\"\",\"ccode\":\"\",\"supervisorybody\":\"\",\"deletedate\":\"\",\"
+changedate\":\"\",\"printindicator\":\"\",\"bacsstatus\":\"\",\"bacschangedate\":\"\",\"bacsclosedate\":\"\",\"bacsredirectfrom\":\"\",\"
+bacsredtoscode\":\"\",\"bacssettbank\":\"\",\"bacssettsec\":\"\",\"bacssettsubsec\":\"\",\"bacshandbank\":\"\",\"bacshandst\":\"\",\"
+bacsaccnumflag\":\"\",\"bacsddiflg\":\"\",\"bacsdrdisallowed\":\"\",\"bacscrdisallowed\":\"\",\"bacscudisallowed\":\"\",\"
+bacsprdisallowed\":\"\",\"bacsbsdisallowed\":\"\",\"bacsdvdisallowed\":\"\",\"bacsaudisallowed\":\"\",\"spare1\":\"\",\"spare2\":\"\",\"
+spare3\":\"\",\"spare4\":\"\",\"chapsretind\":\"\",\"chapssstatus\":\"\",\"chapsschangedate\":\"\",\"chapssclosedate\":\"\",\"
+chapsssettmem\":\"\",\"chapssrbicbank\":\"\",\"chapssrbicbr\":\"\",\"chapsestatus\":\"\",\"chapsechangedate\":\"\",\"
+chapseclosedate\":\"\",\"chapserbicbank\":\"\",\"chapserbicbr\":\"\",\"chapsesettmem\":\"\",\"chapseretind\":\"\",\"
+chapseswift\":\"\",\"spare5\":\"\",\"ccccstatus\":\"\",\"ccccchangedate\":\"\",\"ccccclosedate\":\"\",\"ccccsettbank\":\"\",\"
+ccccdasc\":\"\",\"ccccretind\":\"\",\"ccccgbni\":\"\",\"fpsstatus\":\"\",\"fpschangedate\":\"\",\"fpsclosedate\":\"\",\"
+fpsredirectfrom\":\"\",\"fpsredirecttosc\":\"\",\"fpssettbankct\":\"\",\"fpsspare1\":\"\",\"fpssettbankbc\":\"\",\"
+fpshandbankct\":\"\",\"fpsspare2\":\"\",\"fpshandbankbc\":\"\",\"fpsaccnumflag\":\"\",\"fpsagencytype\":\"\",\"fpsspare3\":\"\",\"
+printbti\":\"\",\"printmainsc\":\"\",\"printmajlocname\":\"\",\"printminlocname\":\"\",\"printbranchname\":\"\",\"
+printsecentryind\":\"\",\"printsecbrname\":\"\",\"printfbrtit1\":\"\",\"printfbrtit2\":\"\",\"printfbrtit3\":\"\",\"
+printaddr1\":\"\",\"printaddr2\":\"\",\"printaddr3\":\"\",\"printaddr4\":\"\",\"printtown\":\"\",\"printcounty\":\"\",\"
+printpcode1\":\"\",\"printpcode2\":\"\",\"printtelarea\":\"\",\"printtelno\":\"\",\"printtelarea2\":\"\",\"printtelno2\":\"\"}"
+      end
+    end
+  
+  end
+
+
+  #=BankValInternational::GoValidate
+  #
+  #Class to make calls to Unified Softwares web services
+  #
+  #
+  class BankVal::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_test.rb

@@ -0,0 +1,108 @@
+# To change this template, choose Tools | Templates
+# and open the template in the editor.
+
+$:.unshift File.join(File.dirname(__FILE__),'..','lib')
+
+require 'test/unit'
+require 'BankVal'
+require 'rexml/document'
+require 'rubygems'
+require 'json'
+
+ class BvTest < Test::Unit::TestCase
+    @obj
+    def setup
+      @obj = BankVal::UK.new
+    end
+
+    def test_return_validation_UK
+      #test1_1 'J-Son' is rejected as invalid result format
+      assert_match /INVALID - Result Format/,@obj.bank_val_uk('J-Son','89','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.bank_val_uk('json','89','abcd123','12345')
+      assert_no_match /INVALID - Result Format/,@obj.bank_val_uk('xml','89','abcd123','12345')
+      assert_no_match /INVALID - Result Format/,@obj.bank_val_uk('csv','89','abcd123','12345')
+      #test1_5 tests that csv is returned as the first part of the string will be 'INVALID'
+      assert_match /^INVALID/,@obj.bank_val_uk('csv','89','abcd123','12345')
+      #test1_6 tests 'json' fails the csv test5
+      assert_no_match /^INVALID/,@obj.bank_val_uk('json','89','abcd123','12345')
+      #test1_7 tests xml is returned as no parseError will be raised
+      assert_nothing_raised{
+        REXML::Document.new(@obj.bank_val_uk('xml','89','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.bank_val_uk('json','89','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.bank_val_uk('csv','89','abcd123','12345')).root.name
+      }
+      #test1_10 tests 'xml' doesn't return json as parse error is raised
+      assert_raise (JSON::ParserError) {
+        JSON[@obj.bank_val_uk('xml','89','abcd123','12345')]
+      }
+      #test1_11 tests 'csv' doesn't return json
+      assert_raise (JSON::ParserError) {
+        JSON[@obj.bank_val_uk('csv','89','abcd123','12345')]
+      }
+      #test1_12 tests ''json' returns valid (parsable) json
+      assert_nothing_raised{
+        JSON[@obj.bank_val_uk('json','89','abcd123','12345')]
+      }
+    end
+
+    def test_sort_code_number_validation
+      #test2_1 check oversized sc is rejected
+      assert_match /^\{"result":"INVALID - Sortcode"/, @obj.bank_val_uk('json','12121212','abcd123','12345')
+      #test2_1.5 undersized sc
+      assert_match /^\{"result":"INVALID - Sortcode"/, @obj.bank_val_uk('json','12122','abcd123','12345')
+      #test2_2 check leading alpha is rejected
+      assert_match /^\{"result":"INVALID - Sortcode"/, @obj.bank_val_uk('json','*12121','abcd123','12345')
+      #test2_3 check trailing alpha is rejected
+      assert_match /^\{"result":"INVALID - Sortcode"/, @obj.bank_val_uk('json','12123:','abcd123','12345')
+      #test2_4 check embedded alpha is rejected
+      assert_match /^\{"result":"INVALID - Sortcode"/, @obj.bank_val_uk('json','12g121','abcd123','12345')
+      #test2_5 check correct size passes (error will be ID/PIN from server)
+      assert_match /^\{"result":"ERROR - Invalid User ID\/PIN"/, @obj.bank_val_uk('json','121212','abcd123','12345')
+      #test2_6 check removal of hyphens full stops and spaces
+      assert_no_match /^\{"result":"INVALID - Sortcode"/, @obj.bank_val_uk('json','12 12 30','abcd123','12345')
+      #test2_7 check removal of hyphens full stops and spaces
+      assert_no_match /^\{"result":"INVALID - Sortcode"/, @obj.bank_val_uk('json','12-12-30','abcd123','12345')
+      #test2_8 check removal of hyphens full stops and spaces
+      assert_no_match /^\{"result":"INVALID - Sortcode"/, @obj.bank_val_uk('json','12.12.30','abcd123','12345')
+    end
+
+    def test_account_validation
+      #test2.5_1 check over
+      assert_match /^\{"result":"INVALID - Account"/, @obj.bank_val_uk('json','121212','12345678901','abcd123','12345')
+      #test2.5_2 check under
+      assert_match /^\{"result":"INVALID - Account"/, @obj.bank_val_uk('json','121212','123456','abcd123','12345')
+      #test2.5_3 leading alpha
+      assert_match /^\{"result":"INVALID - Account"/, @obj.bank_val_uk('json','121212','g1234567','abcd123','12345')
+      #test2.5_4 trailing alpha
+      assert_match /^\{"result":"INVALID - Account"/, @obj.bank_val_uk('json','121212','1234567h','abcd123','12345')
+      #test2.5_5 embedded alpha
+      assert_match /^\{"result":"INVALID - Account"/, @obj.bank_val_uk('json','121212','1345h678','abcd123','12345')
+      #test2.5_6 correct size passes
+      assert_match /^\{"result":"ERROR - Invalid User ID\/PIN"/, @obj.bank_val_uk('json','121212','12345678','abcd12','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.bank_val_uk('json','121212','abcd12','12345')
+      #test3_2 too long user id 2nd element
+      assert_match /^\{"result":"ERROR - Invalid User ID\/PIN"/, @obj.bank_val_uk('json','121212','abcd1234','12345')
+      #test3_3 too short first element
+      assert_match /^\{"result":"ERROR - Invalid User ID\/PIN"/, @obj.bank_val_uk('json','121212','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.bank_val_uk('json','121212','abcd012','1234')
+      #test4_2 too long
+      assert_match /^\{"result":"ERROR - Invalid User ID\/PIN"/, @obj.bank_val_uk('json','121212','abcd123','123456')
+      #test4_3 bad chars
+      assert_match /^\{"result":"ERROR - Invalid User ID\/PIN"/, @obj.bank_val_uk('json','121212','abcd123','12{45')
+    end
+  end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: BankValUK
+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-09-01 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: Handles calls to Unified Softwares BankValUK web services including BankValPlus2 which validates UK bank accounts and returns EISCD data, and getBranchDetails2 which validates UK sort codes and returns EISCD data.
+email: support@unifiedsoftware.co.uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+files: 
+- LICENSE
+- README
+- Rakefile
+- lib/BankVal.rb
+- test/bv_test.rb
+has_rdoc: true
+homepage: http://www.unifiedsoftware.co.uk
+licenses: []
+
+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: Handles calls to Unified Softwares BankValUK web services
+test_files: []
+