ibandit 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 79bb8d78b071a6a3cfb74852b2f62641af34014d
-  data.tar.gz: 3868681d7108888d0259ff51f145bfefb481035f
+  metadata.gz: 3c7cc32ffca411662b2ec9370ec48119b19c7c29
+  data.tar.gz: efad5f26823ef1843a63351de65d3c618ff2f0ee
 SHA512:
-  metadata.gz: b3e0bb71e33693b7b7ad0a67a3b7aa911dd3d1ef0c0f2e1c1cfa4ca2a0815f2b4f3701cf76f6414fb674da299dc6c06cef64ad2edc98dfad990c5a9095dcff2e
-  data.tar.gz: 859b58bd96989e6bf05ab2127fb29939ad4db924bf816d97c5bfd86ee6b13d424d51ee7f6a3536def34375b17fab2bd9489f7dc1178ed4f98f06b921a294b3ad
+  metadata.gz: 85a6244394f46b3f9513314bcdc69875a6f1d14cf4ca33a17ff9ee913de7f76746690eadc64ca66384c36cbe2536c5e8bef26745d6ddffa9cefe971bc476c26e
+  data.tar.gz: 44b6dba9272e2b9a357421a415f8269b8edf04f143b2164b3ba2b2d5930120e94c49db9920699a41503bb6c0976d33f994cccfe81745d7a06e34119a54af7871

data/.rubocop.yml

@@ -12,7 +12,7 @@ LineLength:
   Max: 80
 
 ClassLength:
-  Max: 200
+  Max: 300
 
 # Avoid single-line methods.
 SingleLineMethods:

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.3.2 - February 24, 2015
+
+- Allow for injection of a modulus checker
+
 ## 0.3.1 - February 14, 2015
 
 - Add Malta to LocalDetailsCleaner and IBANAssembler

data/README.md

@@ -64,6 +64,27 @@ The following error keys may be set:
 - `length`
 - `format`
 
+Ibandit will also apply local modulus checks if you set a modulus checker:
+
+```ruby
+module ModulusChecker
+  def self.valid_bank_code?(iban_string)
+    some_codes
+  end
+  
+  def self.valid_account_number?(iban_string)
+    some_codes
+  end
+end
+
+Ibandit.modulus_checker = ModulusChecker
+```
+
+Both the `valid_bank_code?` and `valid_account_number?` methods will receive the plain-text IBAN.
+`valid_bank_code?` should return true unless it is known that the bank/branch code in this IBAN are
+invalid in the country specified. `valid_account_number?` should return true unless it is known that
+the account number in this IBAN cannot be valid due to local modulus checking rules.
+
 ### Deconstructing an IBAN into national banking details
 
 SWIFT define the following components for IBANs, and publish details of how each

data/lib/ibandit.rb

@@ -9,7 +9,7 @@ require 'ibandit/check_digit'
 
 module Ibandit
   class << self
-    attr_accessor :bic_finder
+    attr_accessor :bic_finder, :modulus_checker
 
     def find_bic(country_code, national_id)
       raise NotImplementedError, 'BIC finder is not defined' unless @bic_finder

data/lib/ibandit/iban.rb

@@ -67,7 +67,8 @@ module Ibandit
         valid_format?,
         valid_bank_code_format?,
         valid_branch_code_format?,
-        valid_account_number_format?
+        valid_account_number_format?,
+        valid_local_modulus_check?
       ].all?
     end
 
@@ -210,6 +211,13 @@ module Ibandit
       end
     end
 
+    def valid_local_modulus_check?
+      return unless valid_format?
+      return true unless Ibandit.modulus_checker
+
+      valid_modulus_check_bank_code? && valid_modulus_check_account_number?
+    end
+
     ###################
     # Private methods #
     ###################
@@ -254,5 +262,28 @@ module Ibandit
     def formatted
       iban.to_s.gsub(/(.{4})/, '\1 ').strip
     end
+
+    def valid_modulus_check_bank_code?
+      return true if Ibandit.modulus_checker.valid_bank_code?(iban.to_s)
+
+      @errors[modulus_check_bank_code_field] = 'is invalid'
+      false
+    end
+
+    def valid_modulus_check_account_number?
+      return true if Ibandit.modulus_checker.valid_account_number?(iban.to_s)
+
+      @errors[:account_number] = 'is invalid'
+      false
+    end
+
+    def modulus_check_bank_code_field
+      if LocalDetailsCleaner.required_fields(country_code).
+         include?(:branch_code)
+        :branch_code
+      else
+        :bank_code
+      end
+    end
   end
 end

data/lib/ibandit/version.rb

@@ -1,3 +1,3 @@
 module Ibandit
-  VERSION = '0.3.1'.freeze
+  VERSION = '0.3.2'.freeze
 end

data/spec/ibandit/iban_spec.rb

@@ -456,6 +456,51 @@ describe Ibandit::IBAN do
     end
   end
 
+  describe '#valid_local_modulus_check?' do
+    subject(:valid_local_modulus_check?) { iban.valid_local_modulus_check? }
+
+    context 'without a modulus checker defined' do
+      it { is_expected.to be(true) }
+    end
+
+    context 'with a modulus checker defined' do
+      before do
+        Ibandit.modulus_checker = double(
+          valid_bank_code?: valid_bank_code,
+          valid_account_number?: valid_account_number)
+      end
+      after { Ibandit.modulus_checker = nil }
+      before { iban.valid_local_modulus_check? }
+
+      context 'with an invalid bank code' do
+        let(:iban_code) { 'AT611904300234573201' }
+        let(:valid_bank_code) { false }
+        let(:valid_account_number) { true }
+
+        it { is_expected.to be(false) }
+        specify { expect(iban.errors).to include(bank_code: 'is invalid') }
+
+        context 'when the bank code is not required' do
+          let(:iban_code) { 'GB60BARC20000055779911' }
+          before { Ibandit.bic_finder = double(call: 'BARCGB22XXX') }
+          after { Ibandit.bic_finder = nil }
+          before { iban.valid_local_modulus_check? }
+
+          it { is_expected.to be(false) }
+          specify { expect(iban.errors).to include(branch_code: 'is invalid') }
+        end
+      end
+
+      context 'with an invalid account number' do
+        let(:valid_bank_code) { true }
+        let(:valid_account_number) { false }
+
+        it { is_expected.to be(false) }
+        specify { expect(iban.errors).to include(account_number: 'is invalid') }
+      end
+    end
+  end
+
   describe '#valid?' do
     describe 'validations called' do
       after { iban.valid? }
@@ -483,6 +528,10 @@ describe Ibandit::IBAN do
       it 'validates the account number format' do
         expect(iban).to receive(:valid_account_number_format?).at_least(1)
       end
+
+      it 'runs local modulus checks' do
+        expect(iban).to receive(:valid_local_modulus_check?).at_least(1)
+      end
     end
 
     context 'for a valid Albanian IBAN' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ibandit
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Grey Baker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-15 00:00:00.000000000 Z
+date: 2015-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec