uk_account_validator 0.0.1

data/features/exceptions.feature

@@ -0,0 +1,49 @@
+Feature: Exceptions
+
+  Background:
+    Given I create a new checker
+
+  Scenario Outline: Valid Codes
+    Given I have a sort code <sortcode>
+    And I have an account number <accountnumber>
+
+    Then the combination is valid
+
+  Examples:
+    | test | description                                                                                                      | sortcode | accountnumber |
+    | 4    | Exception 10 & 11 where first check passes and second check fails.                                               | 871427   | 46238510      |
+    | 5    | Exception 10 & 11 where first check fails and second check passes.                                               | 872427   | 46238510      |
+    | 6    | Exception 10 where in the account number ab=09 and the g=9. The first check passes and second check fails.       | 871427   | 09123496      |
+    | 7    | Exception 10 where in the account number ab=99 and the g=9. The first check passes and the second check fails.   | 871427   | 99123496      |
+    | 8    | Exception 3, and the sorting code is the start of a range. As c=6 the second check should be ignored.            | 820000   | 73688637      |
+    | 9    | Exception 3, and the sorting code is the end of a range. As c=9 the second check should be ignored.              | 827999   | 73988638      |
+    | 10   | Exception 3. As c!=6 or 9 perform both checks pass.                                                              | 827101   | 28748352      |
+    | 11   | Exception 4 where the remainder is equal to the checkdigit.                                                      | 134020   | 63849203      |
+    | 12   | Exception 1 - ensures that 27 has been added to the accumulated total and passes double alternate modulus check. | 118765   | 64371389      |
+    | 13   | Exception 6 where the account fails standard check but is a foreign currency account.                            | 200915   | 41011166      |
+    | 14   | Exception 5 where the check passes.                                                                              | 938611   | 07806039      |
+    | 15   | Exception 5 where the check passes with substitution.                                                            | 938600   | 42368003      |
+    | 16   | Exception 5 where both checks produce a remainder of 0 and pass.                                                 | 938063   | 55065200      |
+    | 17   | Exception 7 where passes but would fail the standard check.                                                      | 772798   | 99345694      |
+    | 18   | Exception 8 where the check passes.                                                                              | 086090   | 06774744      |
+    | 19   | Exception 2 & 9 where the first check passes.                                                                    | 309070   | 02355688      |
+    | 20   | Exception 2 & 9 where the first check fails and second check passes with substitution.                           | 309070   | 12345668      |
+    | 21   | Exception 2 & 9 where a!=0 and g!=9 and passes.                                                                  | 309070   | 12345677      |
+    | 22   | Exception 2 & 9 where a!=0 and g=9 and passes.                                                                   | 309070   | 99345694      |
+    | 31   | Exception 12/13 where passes modulus 11 check                                                                    | 074456   | 12345112      |
+    | 32   | Exception 12/13 where passes the modulus 11 check                                                                | 070116   | 34012583      |
+    | 33   | Exception 12/13 where fails the modulus 11 check, but passes the modulus 10 check.                               | 074456   | 11104102      |
+    | 34   | Exception 14 where the first check fails and the second check passes.                                            | 180002   | 00000190      |
+
+  Scenario Outline: Invalid Codes
+    Given I have a sort code <sortcode>
+    And I have an account number <accountnumber>
+
+    Then the combination is invalid
+
+  Examples:
+    | test | description                                                                 | sortcode | accountnumber |
+    | 23   | Exception 5 where the first checkdigit is correct and the second incorrect. | 938063 | 15764273 |
+    | 24   | Exception 5 where the first checkdigit is incorrect and the second correct. | 938063 | 15764264 |
+    | 25   | Exception 5 where the first checkdigit is incorrect with a remainder of 1.  | 938063 | 15763217 |
+    | 26   | Exception 1 where it fails double alternate check.                          | 118765 | 64371388 |

data/features/modulus10.feature

@@ -0,0 +1,18 @@
+Feature: Modulus 10 Checking
+
+  Background:
+    Given I create a new checker
+
+  Scenario: 1) Pass modulus 10 check
+    Given I have a sort code 089999
+    And I have an account number 66374958
+
+    Then the modulus is MOD10
+    And the combination is valid
+
+  Scenario: 29) Fail modulus 10 check
+    Given I have a sort code 089999
+    And I have an account number 66374959
+
+    Then the modulus is MOD10
+    And the combination is invalid

data/features/modulus11.feature

@@ -0,0 +1,15 @@
+Feature: Modulus 11 Checking
+
+  Background:
+    Given I create a new checker
+
+  Scenario: 2) Pass modulus 11 check
+    Given I have a sort code 107999
+    And I have an account number 88837491
+
+    Then the modulus is MOD11
+    And the combination is valid
+
+  Scenario: 30) Fail modulus 11 check
+    Given I have a sort code 107999
+    And I have an account number 88837493

data/features/modulus_weight.feature

@@ -0,0 +1,26 @@
+Feature: Modulus Weight
+
+  Scenario: Reading Weights
+    Given I have the following weight data:
+      """
+      070116 070116 MOD11    0    0    7    6    5    8    9    4    5    6    7    8    9   -1  12
+      """
+
+    Then the weight's sort_code_start is 070116
+    And the weight's sort_code_end is 070116
+    And the weight's modulus is MOD11
+    And the weight's u is 0
+    And the weight's v is 0
+    And the weight's w is 7
+    And the weight's x is 6
+    And the weight's y is 5
+    And the weight's z is 8
+    And the weight's a is 9
+    And the weight's b is 4
+    And the weight's c is 5
+    And the weight's d is 6
+    And the weight's e is 7
+    And the weight's f is 8
+    And the weight's g is 9
+    And the weight's h is -1
+    And the weight's exception is 12

data/features/modulus_weights_table.feature

@@ -0,0 +1,14 @@
+Feature: Modulus Weight Table
+
+Scenario: Finding appropriate modulus weight
+  Given I have a modulus weight table loaded from data/valacdos.txt
+
+  Then the modulus for sort code 010004 is MOD11
+  And the modulus for sort code 010005 is MOD11
+  And the modulus for sort code 016714 is MOD11
+  And the modulus for sort code 016715 is MOD11
+
+Scenario: Sort code doesn't exist
+  Given I have a modulus weight table loaded from data/valacdos.txt
+
+  Then the modulus for sort code 020000 cannot be found

data/features/step_definitions/basics.rb

@@ -0,0 +1,23 @@
+Given(/^I create a new checker$/) do
+  @checker = UkAccountValidator::Validator.new
+end
+
+Given(/^I have a sort code (\d+)$/) do |sort_code|
+  @checker.sort_code = sort_code
+end
+
+Given(/^I have an account number (\d+)$/) do |acc_number|
+  @checker.account_number = acc_number
+end
+
+Then(/^the modulus is (\S+)$/) do |modulus|
+  expect(@checker.modulus_weights.first.modulus).to eq modulus
+end
+
+Then(/^the combination is valid$/) do
+  expect(@checker.valid?).to be true
+end
+
+Then(/^the combination is invalid$/) do
+  expect(@checker.valid?).to be false
+end

data/features/step_definitions/modulus_weight.rb

@@ -0,0 +1,7 @@
+Given(/^I have the following weight data:$/) do |weight_data|
+  @weight = UkAccountValidator::ModulusWeight.from_line(weight_data)
+end
+
+Then(/^the weight's (\S+) is (\S+)$/) do |arg, value|
+  expect(@weight.send(arg).to_s).to eq value
+end

data/features/step_definitions/modulus_weights_table.rb

@@ -0,0 +1,13 @@
+Given(/^I have a modulus weight table loaded from (.+?)$/) do |file_path|
+  @table = UkAccountValidator::ModulusWeightsTable.new(
+    File.join(File.dirname(__FILE__), '../..', file_path)
+  )
+end
+
+Then(/^the modulus for sort code (\d+) is (\S+)$/) do |sort_code, mod|
+  expect(@table.find(sort_code).first.modulus).to eq mod
+end
+
+Then(/^the modulus for sort code (\d+) cannot be found$/) do |sort_code|
+  expect(@table.find(sort_code)).to match_array([])
+end

data/features/support/env.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH << File.expand_path('../../lib', File.dirname(__FILE__))
+require 'uk_account_validator'

data/features/two_modulus_check.feature

@@ -0,0 +1,25 @@
+Feature: Two Modulus Checks
+
+  Background:
+  Given I create a new checker
+
+  Scenario Outline: Valid Codes
+    Given I have a sort code <sortcode>
+    And I have an account number <accountnumber>
+
+    Then the combination is valid
+
+  Examples:
+    | test | description                                  | sortcode | accountnumber |
+    | 3    | Pass modulus 11 and double alternate checks. | 202959   | 63748472      |
+
+  Scenario Outline: Invalid Codes
+    Given I have a sort code <sortcode>
+    And I have an account number <accountnumber>
+
+    Then the combination is invalid
+
+  Examples:
+    | test | description                                            | sortcode | accountnumber |
+    | 27   | Pass modulus 11 check and fail double alternate check. | 203099   | 66831036      |
+    | 28   | Fail modulus 11 check and pass double alternate check. | 203099   | 58716970      |

data/lib/uk_account_validator.rb

@@ -0,0 +1,41 @@
+require 'uk_account_validator/validator.rb'
+require 'uk_account_validator/modulus_weight.rb'
+require 'uk_account_validator/modulus_weights_table.rb'
+
+require 'uk_account_validator/validators/base_validator.rb'
+require 'uk_account_validator/validators/standard_modulus.rb'
+require 'uk_account_validator/validators/modulus10.rb'
+require 'uk_account_validator/validators/modulus11.rb'
+require 'uk_account_validator/validators/double_alternate.rb'
+
+module UkAccountValidator
+  def self.modulus_weights_table
+    @modulus_weights_table ||= read_modulus_weights_table
+  end
+
+  def self.sort_code_substitution
+    @sort_code_substitution ||= read_sort_code_substitution
+  end
+
+  private
+
+  def self.modulus_weights_table_file
+    File.join(File.dirname(__FILE__), '../data/valacdos.txt')
+  end
+
+  def self.read_modulus_weights_table
+    ModulusWeightsTable.new(modulus_weights_table_file)
+  end
+
+  def self.sort_code_substitution_file
+    File.join(File.dirname(__FILE__), '../data/scsubtab.txt')
+  end
+
+  def self.read_sort_code_substitution
+    @substitutions ||= Hash[
+      File.readlines(UkAccountValidator.sort_code_substitution_file).map do |line|
+        line.split(' ')
+      end
+    ]
+  end
+end

data/lib/uk_account_validator/modulus_weight.rb

@@ -0,0 +1,35 @@
+module UkAccountValidator
+  class ModulusWeight
+    attr_accessor :sort_code_start, :sort_code_end, :modulus, :u, :v, :w, :x,
+                :y, :z, :a, :b, :c, :d, :e, :f, :g, :h, :exception
+
+    # the size of each column
+    COLUMN_SIZES = [6, 7, 9, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 4, 3]
+
+    # @param definition_line The line from valacdos.txt that defines this weight.
+    def self.from_line(definition_line)
+      # See https://www.ruby-forum.com/topic/184294#805359
+      data = definition_line.unpack("A#{COLUMN_SIZES.join('A')}")
+
+      data.map! { |d| d.strip }
+
+      @sort_code_start, @sort_code_end, @modulus, @u, @v, @w, @x,
+        @y, @z, @a, @b, @c, @d, @e, @f, @g, @h, @exception = data
+
+      ModulusWeight.new(*data)
+    end
+
+    def initialize(sort_code_start, sort_code_end, modulus, u, v, w, x, y, z,
+          a, b, c, d, e, f, g, h, exception)
+
+      @sort_code_start = sort_code_start
+      @sort_code_end   = sort_code_end
+      @modulus         = modulus
+      @exception       = exception
+
+      @u, @v, @w, @x, @y, @z, @a, @b, @c, @d, @e, @f, @g, @h =
+        [u.to_i, v.to_i, w.to_i, x.to_i, y.to_i, z.to_i, a.to_i, b.to_i, c.to_i,
+         d.to_i, e.to_i, f.to_i, g.to_i, h.to_i]
+    end
+  end
+end

data/lib/uk_account_validator/modulus_weights_table.rb

@@ -0,0 +1,31 @@
+module UkAccountValidator
+  class ModulusWeightsTable
+
+    def initialize(path)
+      @weights = []
+
+      File.readlines(path).each do |line|
+        @weights << ModulusWeight.from_line(line)
+      end
+
+      @weights.sort! { |weight| weight.sort_code_start.to_i }
+    end
+
+    def find(sort_code, found_weights = [], exclude = [])
+      sort_code = sort_code.to_i
+
+      weight = @weights.bsearch do |w|
+        w.sort_code_start.to_i <= sort_code && !exclude.include?(w)
+      end
+
+      return found_weights if weight.nil?
+      return found_weights unless
+        weight.sort_code_start.to_i <= sort_code &&
+        sort_code <= weight.sort_code_end.to_i
+
+      found_weights << weight
+
+      find(sort_code, found_weights, exclude + [weight])
+    end
+  end
+end

data/lib/uk_account_validator/validator.rb

@@ -0,0 +1,60 @@
+module UkAccountValidator
+  class Validator
+    attr_accessor :account_number, :sort_code
+
+    def initialize(account_number = nil, sort_code = nil)
+      @account_number = account_number
+      @sort_code      = sort_code
+    end
+
+    def modulus_weights
+      @modulus_weights ||= UkAccountValidator.modulus_weights_table.find(sort_code)
+    end
+
+    def validator(modulus)
+      case modulus
+      when 'MOD10'
+        Validators::Modulus10
+      when 'MOD11'
+        Validators::Modulus11
+      when 'DBLAL'
+        Validators::DoubleAlternate
+      else
+        fail NotImplementedError
+      end
+    end
+
+    def valid?
+      exceptions = modulus_weights.map(&:exception)
+
+      results = modulus_weights.each_with_index.map do |modulus_weight, i|
+        if i == 1 && exceptions.include?('2') && exceptions.include?('9')
+          next Validator.new(account_number, '309634').valid?
+        end
+
+        validator(modulus_weight.modulus).new(account_number, sort_code, modulus_weight, exceptions).valid?
+      end
+
+      return results.any? if exceptions.include?('2') && exceptions.include?('9')
+      return results.any? if exceptions.include?('10') && exceptions.include?('11')
+      return results.any? if exceptions.include?('12') && exceptions.include?('13')
+      return apply_exception_14 if !results.any? && exceptions.include?('14')
+
+      results.all?
+    end
+
+    # If the 8th digit of the account number (reading from left to right) is
+    # not 0, 1 or 9 then the account number fails the second check and is not a
+    # valid Coutts account number.
+    # If the 8th digit is 0, 1 or 9, then remove the digit from the account
+    # number and insert a 0 as the 1st digit for check purposes only
+    def apply_exception_14
+      return false unless %w(0 1 9).include?(account_number[7])
+
+      account_number.slice!(7)
+      exception_account_number = '0' + account_number
+
+      return Validator.new(exception_account_number, sort_code).valid?
+    end
+  end
+end

data/lib/uk_account_validator/validators/base_validator.rb

@@ -0,0 +1,154 @@
+module UkAccountValidator
+  module Validators
+    class BaseValidator
+      NUMBER_INDEX = {
+        u: 0,
+        v: 1,
+        w: 2,
+        x: 3,
+        y: 4,
+        z: 5,
+        a: 6,
+        b: 7,
+        c: 8,
+        d: 9,
+        e: 10,
+        f: 11,
+        g: 12,
+        h: 13
+      }
+
+      def initialize(account_number, sort_code, modulus_weight, exceptions)
+        @account_number = account_number
+        @sort_code      = sort_code
+        @modulus_weight = modulus_weight
+        @exceptions     = exceptions
+
+        @sort_code = apply_exception_5_substitutions(sort_code) if @modulus_weight.exception == '5'
+      end
+
+      def applying_exceptions(test_digits)
+        apply_exception_2_9(test_digits) if @exceptions.include?('2') &&  @exceptions.include?('9')
+        apply_exception_3(test_digits)  if @modulus_weight.exception == '3'
+        apply_exception_6(test_digits)  if @modulus_weight.exception == '6'
+        apply_exception_7(test_digits)  if @modulus_weight.exception == '7'
+        apply_exception_8(test_digits)  if @modulus_weight.exception == '8'
+        apply_exception_10(test_digits) if @modulus_weight.exception == '10'
+
+        total = yield
+
+        total += 27 if @modulus_weight.exception == '1'
+
+        total
+      end
+
+      def zero_all
+        @modulus_weight = ModulusWeight.new(
+          @modulus_weight.sort_code_start,
+          @modulus_weight.sort_code_end,
+          @modulus_weight.modulus,
+          0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+          @modulus_weight.exception
+        )
+      end
+
+      def zero_u_b
+        @modulus_weight = ModulusWeight.new(
+          @modulus_weight.sort_code_start,
+          @modulus_weight.sort_code_end,
+          @modulus_weight.modulus,
+          0, 0, 0, 0, 0, 0, 0, 0,
+          @modulus_weight.c, @modulus_weight.d, @modulus_weight.e,
+          @modulus_weight.f, @modulus_weight.g, @modulus_weight.h,
+          @modulus_weight.exception
+        )
+      end
+
+      def apply_exception_2_9(test_digits)
+        return if test_digits[NUMBER_INDEX[:a]] == 0
+
+        if test_digits[NUMBER_INDEX[:g]] != 9
+          @modulus_weight = ModulusWeight.new(
+            @modulus_weight.sort_code_start,
+            @modulus_weight.sort_code_end,
+            @modulus_weight.modulus,
+            0, 0, 1, 2, 5, 3, 6, 4, 8, 7, 10, 9, 3, 1,
+            @modulus_weight.exception
+          )
+        else
+          @modulus_weight = ModulusWeight.new(
+            @modulus_weight.sort_code_start,
+            @modulus_weight.sort_code_end,
+            @modulus_weight.modulus,
+            0, 0, 0, 0, 0, 0, 0, 0, 8, 7, 10, 9, 3, 1,
+            @modulus_weight.exception
+          )
+        end
+      end
+
+      def apply_exception_3(test_digits)
+        c = test_digits[NUMBER_INDEX[:c]]
+        zero_all if c == 6 || c == 9
+      end
+
+      def apply_exception_4(total, test_digits)
+        check_sum = [test_digits[NUMBER_INDEX[:g]], test_digits[NUMBER_INDEX[:h]]].join
+        check_sum = check_sum.to_i
+
+        total % modulus == check_sum
+      end
+
+      def apply_exception_5_substitutions(sort_code)
+        substitutions = UkAccountValidator.read_sort_code_substitution
+
+        if substitutions.keys.include?(sort_code)
+          sort_code = substitutions[sort_code]
+        end
+
+        return sort_code
+      end
+
+      def apply_exception_5(total, test_digits, check_digit)
+        check_sum    = total % modulus
+        expected_sum = test_digits[NUMBER_INDEX[check_digit]].to_i
+
+        return false if check_sum == 1 && check_digit == :g
+        return true  if check_sum == 0 && expected_sum == 0
+
+        return (modulus - check_sum) == expected_sum
+      end
+
+      # If a = 4, 5, 6, 7 or 8, and g and h are the same
+      def apply_exception_6(test_digits)
+        a = test_digits[NUMBER_INDEX[:a]]
+        g = test_digits[NUMBER_INDEX[:g]]
+        h = test_digits[NUMBER_INDEX[:h]]
+
+        zero_all if (a == 4 || a == 5 || a == 6 || a == 7 || a == 8) && g == h
+      end
+
+      def apply_exception_7(test_digits)
+        return unless test_digits[NUMBER_INDEX[:g]] == 9
+
+        zero_u_b
+      end
+
+      def apply_exception_8(test_digits)
+        test_string = '090126' + @account_number
+
+        test_digits.replace(test_string.split(//).map(&:to_i))
+      end
+
+      def apply_exception_10(test_digits)
+        # if ab = 09 or 99 and g=9, zeroise weighting positions u-b.
+        a = test_digits[NUMBER_INDEX[:a]]
+        b = test_digits[NUMBER_INDEX[:b]]
+
+        return unless (a == 0 && b == 9) ||
+          (a == 9 && b == 9 && test_digits[NUMBER_INDEX[:g]] == 9)
+
+        zero_u_b
+      end
+    end
+  end
+end