esortcode 0.9.1

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2007-07-11
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2007 Geoff Garside
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest.txt

@@ -0,0 +1,33 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/e_sort_code.rb
+lib/esortcode.rb
+lib/esortcode/client.rb
+lib/esortcode/exception.rb
+lib/esortcode/industry_sort_code_directory.rb
+lib/esortcode/response.rb
+lib/esortcode/response/base.rb
+lib/esortcode/response/branch_details.rb
+lib/esortcode/response/standardise_account.rb
+lib/esortcode/response/validate_account.rb
+lib/esortcode/response/validate_credit_card.rb
+lib/esortcode/version.rb
+scripts/txt2html
+setup.rb
+spec/client_spec.rb
+spec/esortcode_spec.rb
+spec/response/branch_details_spec.rb
+spec/response/common_spec.rb
+spec/response/standardise_account_spec.rb
+spec/response/validate_account_spec.rb
+spec/response/validate_credit_card_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.rhtml

data/README.txt

@@ -0,0 +1,3 @@
+README for eSortCode
+====================
+

data/Rakefile

@@ -0,0 +1,138 @@
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/contrib/rubyforgepublisher'
+require 'fileutils'
+require 'hoe'
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts 'To use rspec for testing you must install rspec gem:'
+  puts '$ sudo gem install rspec'
+  exit
+end
+
+include FileUtils
+require File.join(File.dirname(__FILE__), 'lib', 'esortcode', 'version')
+
+AUTHOR      = 'Geoff Garside'  # can also be an array of Authors
+EMAIL       = "geoff.garside@openhosting.co.uk"
+DESCRIPTION = "Ruby interface to eSortCode UK Account and Bank Branch validator"
+GEM_NAME    = 'esortcode' # what ppl will type to install your gem
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}"
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  @rubyforge_username ||= @config["username"]
+end
+
+RUBYFORGE_PROJECT = 'esortcode' # The unix name for your project
+HOMEPATH          = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH     = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+NAME = "esortcode"
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
+VERS = ESortCode::VERSION::STRING + (REV ? ".#{REV}" : "")
+CLEAN.include ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']
+RDOC_OPTS = ['--quiet', '--title', 'eSortCode documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject { |x| Array(x).first == 'hoe' } 
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.author         = AUTHOR 
+  p.description    = DESCRIPTION
+  p.email          = EMAIL
+  p.summary        = DESCRIPTION
+  p.url            = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs     = ["test/**/test_*.rb"]
+  p.clean_globs   |= CLEAN  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = []     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+end
+
+CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\n\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+
+desc 'Generate website files'
+task :website_generate do
+  Dir['website/**/*.txt'].each do |txt|
+    sh %{ ruby scripts/txt2html #{txt} > #{txt.gsub(/txt$/,'html')} }
+  end
+end
+
+desc 'Upload website files to rubyforge'
+task :website_upload do
+  host = "#{rubyforge_username}@rubyforge.org"
+  remote_dir = "/var/www/gforge-projects/#{PATH}/"
+  local_dir = 'website'
+  sh %{rsync -aCv #{local_dir}/ #{host}:#{remote_dir}}
+end
+
+desc 'Generate and upload website files'
+task :website => [:website_generate, :website_upload, :publish_docs]
+
+desc 'Release the website and new gem version'
+task :deploy => [:check_version, :website, :release] do
+  puts "Remember to create SVN tag:"
+  puts "svn copy svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/trunk " +
+    "svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/tags/REL-#{VERS} "
+  puts "Suggested comment:"
+  puts "Tagging release #{CHANGES}"
+end
+
+desc 'Runs tasks website_generate and install_gem as a local deployment of the gem'
+task :local_deploy => [:website_generate, :install_gem]
+
+task :check_version do
+  unless ENV['VERSION']
+    puts 'Must pass a VERSION=x.y.z release version'
+    exit
+  end
+  unless ENV['VERSION'] == VERS
+    puts "Please update your version.rb to match the release version, currently #{VERS}"
+    exit
+  end
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+desc "Default task is to run specs"
+task :default => :spec
+

data/lib/e_sort_code.rb

@@ -0,0 +1,3 @@
+# This file is here to help load from
+# the constant name ESortCode.
+require 'esortcode'

data/lib/esortcode.rb

@@ -0,0 +1,5 @@
+require 'esortcode/version'
+require 'esortcode/client'
+require 'esortcode/exception'
+require 'esortcode/industry_sort_code_directory'
+require 'esortcode/response'

data/lib/esortcode/client.rb

@@ -0,0 +1,142 @@
+require 'uri'
+require 'net/https'
+
+module ESortCode
+  class Client
+    BASE_URL = 'https://ws.esortcode.com/bankdetails.asmx'
+    USER_AGENT = "Ruby eSortCode Client v#{ESortCode::VERSION::STRING}"
+    
+    def initialize(login = nil, guid = nil)
+      @account  = login ? login : @@account
+      @guid     = guid  ? guid  : @@guid
+      @uri = URI.parse(BASE_URL)
+    end
+    
+    class << self
+      def account_name=(val)
+        @@account = val
+      end
+      def account_name
+        @@account
+      end
+      
+      def guid=(val)
+        @@guid = val
+      end
+      def guid
+        @@guid
+      end
+      
+      alias :license_id= :guid=
+      alias :license_id  :guid
+    end
+    
+    def validate_account(sort_code, account_number)
+      unless sort_code.match(/^[0-9]{6}$/)
+        raise Exception::InvalidSortcode,
+          "#{sort_code} is not valid"
+      end
+      
+      unless account_number.match(/^[0-9]{8}$/)
+        raise Exception::InvalidAccountNumber,
+          "#{account_number} is not valid"
+      end
+      
+      Response::ValidateAccount.new(
+        request('ValidateAccount', :sSortcode => sort_code,
+          :sAccountNumber => account_number))
+    end
+    
+    def branch_details(sort_code)
+      unless sort_code.match(/^[0-9]{6}$/)
+        raise Exception::InvalidSortcode,
+          "#{sort_code} is not valid"
+      end
+      
+      Response::BranchDetails.new(
+        request('BranchDetails', :sSortcode => sort_code))
+    end
+    
+    def standardise_account(sort_code, account_number)
+      unless sort_code.match(/^[0-9]{6}$/)
+        raise Exception::InvalidSortcode,
+          "#{sort_code} is not valid"
+      end
+      
+      unless account_number.match(/^[0-9]{8}$/)
+        raise Exception::InvalidAccountNumber,
+          "#{account_number} is not valid"
+      end
+      
+      Response::StandardiseAccount.new(
+        request('StandardiseAccount', :sSortcode => sort_code,
+          :sAccountNumber => account_number))
+    end
+    
+    def validate_account_get_branch_details(sort_code, account_number)
+      unless sort_code.match(/^[0-9]{6}$/)
+        raise Exception::InvalidSortcode,
+          "#{sort_code} is not valid"
+      end
+      
+      unless account_number.match(/^[0-9]{6,10}$/)
+        raise Exception::InvalidAccountNumber,
+          "#{account_number} is not valid"
+      end
+      
+      Response::BranchDetails.new(
+        request('ValidateAccountGetBranchDetails',
+          :sSortcode => sort_code, 
+          :sAccountNumber => account_number))
+    end
+    
+    def validate_credit_card(credit_card_number)
+      unless credit_card_number.match(/[0-9]+/)
+        raise Exception::InvalidCreditCardNumber,
+          "#{credit_card_number} is not valid"
+      end
+      
+      Response::ValidateCreditCard.new(
+        request('ValidateCreditCard',
+          :sCreditCardNumber => credit_card_number))
+    end
+    
+    private
+      def request(action, args = {}, attempts = 3)
+        begin
+          s_client = Net::HTTP.new(@uri.host, @uri.port)
+          s_client.use_ssl = true
+          
+          @resp = s_client.start do |https|
+            @request = Net::HTTP::Post.new([@uri.path, action].join('/'))
+            @request.add_field('User-Agent', USER_AGENT)
+            @request.set_form_data(post_data.merge(args))
+            
+            https.request(@request)
+          end
+          
+          # Handle the response
+          case @resp
+          when Net::HTTPSuccess
+            @resp.body
+          else
+            @resp.error!
+          end
+        rescue Timeout::Error => e
+          if attempts == 1
+            raise e
+          else
+            request(action, args, attempts - 1)
+          end
+        end
+      end
+      
+      def post_data
+        {
+          :sUserName => @account,
+          :sGUID => @guid,
+          :sIPAddress => ''
+        }
+      end
+  end
+end

data/lib/esortcode/exception.rb

@@ -0,0 +1,9 @@
+module ESortCode
+  module Exception
+    class GeneralError < ::Exception; end
+    class ValidationError < ::Exception; end
+    class InvalidSortcode < ::Exception; end
+    class InvalidAccountNumber < ::Exception; end
+    class InvalidCreditCardNumber < ::Exception; end
+  end
+end

data/lib/esortcode/industry_sort_code_directory.rb

@@ -0,0 +1,19 @@
+module ESortCode
+  class IndustrySortCodeDirectory
+    def initialize(xml_doc)
+      @xml = xml_doc
+      @fields = Hash.new
+    end
+    
+    # We cache the requested entries in a hash for
+    # quicker repeated access to 
+    def [](v)
+      unless @fields.has_key?(v)
+        t = @xml.get_text("*/#{v}")
+        @fields[v] = t && t.to_s
+      end
+      
+      @fields[v]
+    end
+  end
+end

data/lib/esortcode/response.rb

@@ -0,0 +1,5 @@
+require 'esortcode/response/base'
+require 'esortcode/response/branch_details'
+require 'esortcode/response/standardise_account'
+require 'esortcode/response/validate_account'
+require 'esortcode/response/validate_credit_card'

data/lib/esortcode/response/base.rb

@@ -0,0 +1,41 @@
+require 'rexml/document'
+
+module ESortCode
+  module Response
+    class Base
+      def initialize(xml_data)
+        @xml = REXML::Document.new(xml_data)
+      end
+      
+      def valid?
+        @valid ||= (@xml.get_text('*/ValidationMessage') == 'VALID')
+      end
+      
+      def invalid_message
+        unless valid?
+          @invalid_message ||= (message_from(@xml.get_text('*/ValidationMessage')))
+        end
+      end
+      
+      def has_error?
+        @has_error ||= (@xml.get_text('*/IsError') == 'true')
+      end
+      
+      def error
+        if has_error?
+          @error ||= (message_from(@xml.get_text('*/ErrorMessage')))
+        end
+      end
+      
+      def error!
+        raise ESortCode::Exception::GeneralError, error if has_error?
+      end
+      
+      protected
+        def message_from(str)
+          return nil if str.nil?
+          str.to_s.split(':',2)[1].strip.gsub('"', '')
+        end
+    end
+  end
+end

data/lib/esortcode/response/branch_details.rb

@@ -0,0 +1,10 @@
+module ESortCode
+  module Response
+    class BranchDetails < Base
+      def directory
+        @directory ||= ESortCode::IndustrySortCodeDirectory.new(@xml)
+      end
+      alias :iscd :directory
+    end
+  end
+end