ibandit 1.20.0 → 1.22.0

data/data/structures.yml

@@ -273,7 +273,7 @@ EE:
   :iban_example: EE382200221020145685
   :bban_example: '2200221020145685'
   :domestic_account_number_example: '221020145685'
-  :bban_format: "\\d{2}\\d{2}\\d{11}\\d{1}"
+  :bban_format: "\\d{2}\\d{14}"
   :bank_code_format: "[1-9][0-9]"
   :account_number_format: "\\d{2}\\d{11}\\d{1}"
   :local_check_digit_position: 20
@@ -286,7 +286,7 @@ ES:
   :account_number_position: 13
   :account_number_length: 12
   :total_length: 24
-  :national_id_length: 4
+  :national_id_length: 8
   :iban_example: ES9121000418450200051332
   :bban_example: '21000418450200051332'
   :domestic_account_number_example: 2100 0418 45 0200051332
@@ -841,8 +841,8 @@ PT:
   :domestic_account_number_example: 0002.0123.12345678901.54
   :bban_format: "\\d{4}\\d{4}\\d{11}\\d{2}"
   :bank_code_format: "\\d{4}"
-  :account_number_format: "\\d{11}\\d{2}"
   :branch_code_format: "\\d{4}"
+  :account_number_format: "\\d{11}\\d{2}"
   :local_check_digit_position: 24
   :local_check_digit_length: 2
 RO:
@@ -1103,10 +1103,10 @@ ST:
   :account_number_length: 13
   :total_length: 25
   :national_id_length: 8
-  :iban_example: ST68000200010192194210112
-  :bban_example: '000200010192194210112'
-  :domestic_account_number_example: '01921942101.12'
-  :bban_format: "\\d{4}\\d{4}\\d{11}\\d{2}"
+  :iban_example: ST23000100010051845310146
+  :bban_example: '000100010051845310146'
+  :domestic_account_number_example: '0051845310146'
+  :bban_format: "\\d{8}\\d{11}\\d{2}"
   :bank_code_format: "\\d{4}"
   :branch_code_format: "\\d{4}"
   :account_number_format: "\\d{11}\\d{2}"
@@ -1137,9 +1137,9 @@ IQ:
   :iban_example: IQ98NBIQ850123456789012
   :bban_example: NBIQ850123456789012
   :domestic_account_number_example: '123456789012'
-  :bban_format: "[A-Z]{4}\\d{3}\\d{12}"
   :bank_code_format: "[A-Z]{4}"
   :branch_code_format: "\\d{3}"
+  :bban_format: "[A-Z]{4}\\d{3}\\d{12}"
   :account_number_format: "\\d{12}"
 SV:
   :bank_code_position: 5
@@ -1357,6 +1357,12 @@ MN:
   :account_number_length: 12
   :total_length: 20
   :national_id_length: 4
+  :iban_example: MN121234123456789123
+  :bban_example: '1234123456789123'
+  :domestic_account_number_example: 1234 5678 9123
+  :bban_format: "\\d{4}\\d{12}"
+  :bank_code_format: "\\d{4}"
+  :account_number_format: "\\d{12}"
 DZ:
   :bank_code_position: 5
   :bank_code_length: 3
@@ -1472,13 +1478,90 @@ RU:
   :account_number_length: 15
   :total_length: 33
   :national_id_length: 14
-  :iban_example: RU1704452522540817810538091310419
+  :iban_example: RU0304452522540817810538091310419
   :bban_example: 044525225 40817 810 5 3809 1310419
   :domestic_account_number_example: 40817 810 5 3809 1310419
   :bban_format: "\\d{9}\\d{5}[A-Z0-9]{15}"
   :bank_code_format: "\\d{9}"
   :branch_code_format: "\\d{5}"
   :account_number_format: "[A-Z0-9]{15}"
+SO:
+  :bank_code_position: 5
+  :bank_code_length: 4
+  :branch_code_position: 9
+  :branch_code_length: 3
+  :account_number_position: 12
+  :account_number_length: 12
+  :total_length: 23
+  :national_id_length: 7
+  :iban_example: SO211000001001000100141
+  :bban_example: '1000001001000100141'
+  :domestic_account_number_example: '001000100141'
+  :bban_format: "\\d{4}\\d{3}\\d{12}"
+  :bank_code_format: "\\d{4}"
+  :branch_code_format: "\\d{3}"
+  :account_number_format: "\\d{12}"
+NI:
+  :bank_code_position: 5
+  :bank_code_length: 4
+  :branch_code_position: 0
+  :branch_code_length: 0
+  :account_number_position: 9
+  :account_number_length: 20
+  :total_length: 28
+  :national_id_length: 4
+  :iban_example: NI45BAPR00000013000003558124
+  :bban_example: BAPR00000013000003558124
+  :domestic_account_number_example: '00000013000003558124'
+  :bban_format: "[A-Z]{4}\\d{20}"
+  :bank_code_format: "[A-Z]{4}"
+  :account_number_format: "\\d{20}"
+FK:
+  :bank_code_position: 5
+  :bank_code_length: 2
+  :branch_code_position: 0
+  :branch_code_length: 0
+  :account_number_position: 7
+  :account_number_length: 12
+  :total_length: 18
+  :national_id_length: 2
+  :iban_example: FK88SC123456789012
+  :bban_example: SC123456789012
+  :domestic_account_number_example: '123456789012'
+  :bban_format: "[A-Z]{2}\\d{12}"
+  :bank_code_format: "[A-Z]{2}"
+  :account_number_format: "\\d{12}"
+OM:
+  :bank_code_position: 5
+  :bank_code_length: 3
+  :branch_code_position: 0
+  :branch_code_length: 0
+  :account_number_position: 8
+  :account_number_length: 16
+  :total_length: 23
+  :national_id_length: 3
+  :iban_example: OM810180000001299123456
+  :bban_example: '0180000001299123456'
+  :domestic_account_number_example: '0000001299123456'
+  :bban_format: "\\d{3}[A-Z0-9]{16}"
+  :bank_code_format: "\\d{3}"
+  :account_number_format: "[A-Z0-9]{16}"
+YE:
+  :bank_code_position: 5
+  :bank_code_length: 4
+  :branch_code_position: 9
+  :branch_code_length: 4
+  :account_number_position: 13
+  :account_number_length: 18
+  :total_length: 30
+  :national_id_length: 8
+  :iban_example: YE15CBYE0001018861234567891234
+  :bban_example: CBYE0001018861234567891234
+  :domestic_account_number_example: '018861234567891234'
+  :bban_format: "[A-Z]{4}\\d{4}[A-Z0-9]{18}"
+  :bank_code_format: "[A-Z]{4}"
+  :branch_code_format: "\\d{4}"
+  :account_number_format: "[A-Z0-9]{18}"
 AU:
   :bank_code_length: 0
   :branch_code_length: 6
@@ -1493,13 +1576,16 @@ AU:
   :pseudo_iban_account_number_length: 10
   :national_id_length: 6
 CA:
-  :bank_code_length: 4
+  :bank_code_length: !ruby/range
+    begin: 3
+    end: 4
+    excl: false
   :branch_code_length: 5
   :account_number_length: !ruby/range
     begin: 7
     end: 12
     excl: false
-  :bank_code_format: "\\d{4}"
+  :bank_code_format: "\\d{3,4}"
   :branch_code_format: 0{0,4}[1-9][0-9]{0,4}
   :account_number_format: "(?!0+\\z)\\d{7,12}"
   :national_id_length: 9

data/ibandit.gemspec

@@ -27,13 +27,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.required_ruby_version = ">= 2.7.0"
-  spec.add_development_dependency "gc_ruboconfig",   "~> 4.3"
-  spec.add_development_dependency "nokogiri",        "~> 1.6"
-  spec.add_development_dependency "pry",             "~> 0.13"
-  spec.add_development_dependency "pry-byebug",      "~> 3.10"
-  spec.add_development_dependency "rspec",           "~> 3.12"
-  spec.add_development_dependency "rspec-its",       "~> 1.2"
-  spec.add_development_dependency "sax-machine", "~> 1.3"
 
-  spec.add_runtime_dependency "i18n"
+  spec.add_dependency "i18n"
 end

data/lib/ibandit/iban.rb

@@ -158,14 +158,17 @@ module Ibandit
 
     def valid_bank_code_length?
       return unless valid_country_code?
-      return true if structure[:bank_code_length]&.zero?
+      if structure[:bank_code_length].is_a?(Integer) && structure[:bank_code_length].zero?
+        return true
+      end
 
       if swift_bank_code.nil? || swift_bank_code.empty?
         @errors[:bank_code] = Ibandit.translate(:is_required)
         return false
       end
 
-      return true if swift_bank_code.length == structure[:bank_code_length]
+      return true if valid_input_length?(structure[:bank_code_length],
+                                         swift_bank_code.length)
 
       @errors[:bank_code] =
         Ibandit.translate(:wrong_length, expected: structure[:bank_code_length])
@@ -176,16 +179,15 @@ module Ibandit
       return unless valid_country_code?
       return true if swift_branch_code.to_s.length == structure[:branch_code_length]
 
-      if structure[:branch_code_length]&.zero?
-        @errors[:branch_code] = Ibandit.translate(:not_used_in_country,
+      @errors[:branch_code] = if structure[:branch_code_length]&.zero?
+                                Ibandit.translate(:not_used_in_country,
                                                   country_code: country_code)
-      elsif swift_branch_code.nil? || swift_branch_code.empty?
-        @errors[:branch_code] = Ibandit.translate(:is_required)
-      else
-        @errors[:branch_code] =
-          Ibandit.translate(:wrong_length,
-                            expected: structure[:branch_code_length])
-      end
+                              elsif swift_branch_code.nil? || swift_branch_code.empty?
+                                Ibandit.translate(:is_required)
+                              else
+                                Ibandit.translate(:wrong_length,
+                                                  expected: structure[:branch_code_length])
+                              end
       false
     end
 
@@ -197,14 +199,8 @@ module Ibandit
         return false
       end
 
-      case structure[:account_number_length]
-      when Range
-        if structure[:account_number_length].include?(swift_account_number.length)
-          return true
-        end
-      else
-        return true if swift_account_number.length == structure[:account_number_length]
-      end
+      return true if valid_input_length?(structure[:account_number_length],
+                                         swift_account_number.length)
 
       @errors[:account_number] =
         Ibandit.translate(:wrong_length,
@@ -240,7 +236,9 @@ module Ibandit
 
     def valid_bank_code_format?
       return unless valid_bank_code_length?
-      return true if structure[:bank_code_length]&.zero?
+      if structure[:bank_code_length].is_a?(Integer) && structure[:bank_code_length].zero?
+        return true
+      end
 
       if swift_bank_code&.match?(
         entire_string_regex(structure[:bank_code_format]),
@@ -391,7 +389,6 @@ module Ibandit
       valid_modulus_check_branch_code?
     end
 
-    # rubocop:disable Metrics/AbcSize
     def bank_code_passes_checksum_test?
       return false unless swift_bank_code
       return false if swift_bank_code.length != 9
@@ -408,8 +405,6 @@ module Ibandit
 
       mod.zero?
     end
-    # rubocop:enable Metrics/AbcSize
-
     ###################
     # Private methods #
     ###################
@@ -509,17 +504,26 @@ module Ibandit
       iban.to_s.gsub(/(.{4})/, '\1 ').strip
     end
 
+    def valid_input_length?(allowed_length, input_length)
+      case allowed_length
+      when Range
+        allowed_length.include?(input_length)
+      else
+        allowed_length == input_length
+      end
+    end
+
     def valid_modulus_check_bank_code?
       return true if Ibandit.modulus_checker.valid_bank_code?(self)
 
-      @errors[:bank_code] = Ibandit.translate(:failed_modulus_check)
+      @errors[:bank_code] = Ibandit.translate(:bank_code_does_not_exist)
       false
     end
 
     def valid_modulus_check_branch_code?
       return true if Ibandit.modulus_checker.valid_branch_code?(self)
 
-      @errors[:branch_code] = Ibandit.translate(:failed_modulus_check)
+      @errors[:branch_code] = Ibandit.translate(:branch_code_does_not_exist)
       false
     end
 

data/lib/ibandit/sweden/bank_lookup.rb

@@ -13,7 +13,7 @@ module Ibandit
       end
 
       def self.bank_info_table
-        @swedish_bank_lookup ||=
+        @bank_info_table ||=
           begin
             relative_path = "../../../../data/raw/swedish_bank_lookup.yml"
             raw_info = YAML.load_file(File.expand_path(relative_path, __FILE__))

data/lib/ibandit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ibandit
-  VERSION = "1.20.0"
+  VERSION = "1.22.0"
 end

data/lib/ibandit.rb

@@ -30,10 +30,8 @@ module Ibandit
     end
 
     def structures
-      @structures ||= YAML.safe_load(
-        File.read(File.expand_path("../data/structures.yml", __dir__)),
-        permitted_classes: [Range, Symbol],
-      )
+      @structures ||= YAML.safe_load_file(File.expand_path("../data/structures.yml", __dir__),
+                                          permitted_classes: [Range, Symbol])
     end
 
     def translate(key, options = {})

data/spec/ibandit/iban_assembler_spec.rb

@@ -293,11 +293,11 @@ describe Ibandit::IBANAssembler do
       it_behaves_like "allows round trips", "ES80 2310 0001 1800 0001 2345"
 
       context "without a bank_code or branch code" do
-        before { args.delete(:bank_code) }
-
-        before { args.delete(:branch_code) }
-
-        before { args[:account_number] = "23100001180000012345" }
+        before do
+          args.delete(:bank_code)
+          args.delete(:branch_code)
+          args[:account_number] = "23100001180000012345"
+        end
 
         it { is_expected.to be_nil }
       end
@@ -487,27 +487,29 @@ describe Ibandit::IBANAssembler do
       it_behaves_like "allows round trips", "HU42 1177 3016 1111 1018 0000 0000"
 
       context "without a bank_code or branch_code" do
-        before { args.delete(:bank_code) }
-
-        before { args.delete(:branch_code) }
-
-        before { args[:account_number] = "11773016-11111018-00000000" }
+        before do
+          args.delete(:bank_code)
+          args.delete(:branch_code)
+          args[:account_number] = "11773016-11111018-00000000"
+        end
 
         it { is_expected.to be_nil }
       end
 
       context "without a bank_code" do
-        before { args.delete(:bank_code) }
-
-        before { args[:account_number] = "11773016-11111018-00000000" }
+        before do
+          args.delete(:bank_code)
+          args[:account_number] = "11773016-11111018-00000000"
+        end
 
         it { is_expected.to be_nil }
       end
 
       context "without a branch_code" do
-        before { args.delete(:branch_code) }
-
-        before { args[:account_number] = "11773016-11111018-00000000" }
+        before do
+          args.delete(:branch_code)
+          args[:account_number] = "11773016-11111018-00000000"
+        end
 
         it { is_expected.to be_nil }
       end
@@ -826,9 +828,10 @@ describe Ibandit::IBANAssembler do
       it_behaves_like "allows round trips", "NO93 8601 1117 947"
 
       context "without a bank_code" do
-        before { args.delete(:bank_code) }
-
-        before { args[:account_number] = "86011117947" }
+        before do
+          args.delete(:bank_code)
+          args[:account_number] = "86011117947"
+        end
 
         it { is_expected.to be_nil }
       end
@@ -854,9 +857,10 @@ describe Ibandit::IBANAssembler do
       it_behaves_like "allows round trips", "PL60 1020 1026 0000 0422 7020 1111"
 
       context "without a bank_code" do
-        before { args.delete(:bank_code) }
-
-        before { args[:account_number] = "60102010260000042270201111" }
+        before do
+          args.delete(:bank_code)
+          args[:account_number] = "60102010260000042270201111"
+        end
 
         it { is_expected.to be_nil }
       end

data/spec/ibandit/iban_spec.rb

@@ -11,9 +11,7 @@ describe Ibandit::IBAN do
   its(:iban) { is_expected.to eq(iban_code) }
 
   context "with locales" do
-    all_keys = YAML.safe_load(
-      File.read("config/locales/en.yml"),
-    )["en"]["ibandit"].keys
+    all_keys = YAML.safe_load_file("config/locales/en.yml")["en"]["ibandit"].keys
 
     Ibandit::Constants::SUPPORTED_LOCALES.each do |locale|
       context "for #{locale}", locale: locale do
@@ -129,19 +127,19 @@ describe Ibandit::IBAN do
     end
 
     context "when the IBAN was created from a Belgian IBAN" do
-      let(:iban_code) { "BE62510007547061" }
+      let(:iban_code) { "BE68539007547034" }
 
       its(:country_code) { is_expected.to eq("BE") }
-      its(:bank_code) { is_expected.to eq("510") }
+      its(:bank_code) { is_expected.to eq("539") }
       its(:branch_code) { is_expected.to be_nil }
-      its(:account_number) { is_expected.to eq("510007547061") }
+      its(:account_number) { is_expected.to eq("539007547034") }
       its(:account_number_suffix) { is_expected.to be_nil }
-      its(:swift_bank_code) { is_expected.to eq("510") }
+      its(:swift_bank_code) { is_expected.to eq("539") }
       its(:swift_branch_code) { is_expected.to be_nil }
-      its(:swift_account_number) { is_expected.to eq("510007547061") }
-      its(:swift_national_id) { is_expected.to eq("510") }
-      its(:local_check_digits) { is_expected.to eq("61") }
-      its(:bban) { is_expected.to eq("510007547061") }
+      its(:swift_account_number) { is_expected.to eq("539007547034") }
+      its(:swift_national_id) { is_expected.to eq("539") }
+      its(:local_check_digits) { is_expected.to eq("34") }
+      its(:bban) { is_expected.to eq("539007547034") }
     end
 
     context "when the IBAN was created with local details" do
@@ -869,6 +867,23 @@ describe Ibandit::IBAN do
         expect(subject.errors).to eq(account_number: "format is invalid")
       end
     end
+
+    # Spanish IBANs have recently switched to 8 character national IDs
+    context "with a Spanish IBAN" do
+      let(:iban_code) { "ES9121000418450200051332" }
+
+      its(:country_code) { is_expected.to eq("ES") }
+      its(:bank_code) { is_expected.to eq("2100") }
+      its(:branch_code) { is_expected.to eq("0418") }
+      its(:account_number) { is_expected.to eq("450200051332") }
+      its(:account_number_suffix) { is_expected.to be_nil }
+      its(:swift_bank_code) { is_expected.to eq("2100") }
+      its(:swift_branch_code) { is_expected.to eq("0418") }
+      its(:swift_account_number) { is_expected.to eq("450200051332") }
+      its(:swift_national_id) { is_expected.to eq("21000418") }
+      its(:local_check_digits) { is_expected.to eq("45") }
+      its(:bban) { is_expected.to eq("21000418450200051332") }
+    end
   end
 
   describe "#to_s" do
@@ -1318,12 +1333,11 @@ describe Ibandit::IBAN do
           valid_branch_code?: valid_branch_code,
           valid_account_number?: valid_account_number,
         )
+        iban.valid_local_modulus_check?
       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 }
@@ -1341,7 +1355,7 @@ describe Ibandit::IBAN do
         it { is_expected.to be(false) }
 
         it "sets the errors on the IBAN" do
-          expect(iban.errors).to include(bank_code: "did not pass modulus check")
+          expect(iban.errors).to include(bank_code: "bank code does not exist")
         end
       end
 
@@ -1351,12 +1365,13 @@ describe Ibandit::IBAN do
         let(:valid_branch_code) { false }
         let(:valid_account_number) { true }
 
-        before { Ibandit.bic_finder = double(call: "BARCGB22XXX") }
+        before do
+          Ibandit.bic_finder = double(call: "BARCGB22XXX")
+          iban.valid_local_modulus_check?
+        end
 
         after { Ibandit.bic_finder = nil }
 
-        before { iban.valid_local_modulus_check? }
-
         it "calls valid_branch_code? with an IBAN object" do
           expect(Ibandit.modulus_checker).
             to receive(:valid_branch_code?).
@@ -1368,7 +1383,7 @@ describe Ibandit::IBAN do
         it { is_expected.to be(false) }
 
         it "sets the errors on the IBAN" do
-          expect(iban.errors).to include(branch_code: "did not pass modulus check")
+          expect(iban.errors).to include(branch_code: "branch code does not exist")
         end
       end
 
@@ -1581,7 +1596,7 @@ describe Ibandit::IBAN do
           it { is_expected.to be(false) }
 
           it "sets the errors on the IBAN" do
-            expect(iban.errors).to include(branch_code: "did not pass modulus check")
+            expect(iban.errors).to include(branch_code: "branch code does not exist")
           end
         end
       end
@@ -1646,7 +1661,7 @@ describe Ibandit::IBAN do
           it { is_expected.to be(false) }
 
           it "sets the errors on the IBAN" do
-            expect(iban.errors).to include(branch_code: "did not pass modulus check")
+            expect(iban.errors).to include(branch_code: "branch code does not exist")
           end
         end
       end
@@ -1711,7 +1726,7 @@ describe Ibandit::IBAN do
           it { is_expected.to be(false) }
 
           it "sets the errors on the IBAN" do
-            expect(iban.errors).to include(branch_code: "did not pass modulus check")
+            expect(iban.errors).to include(branch_code: "branch code does not exist")
           end
         end
       end
@@ -2235,6 +2250,31 @@ describe Ibandit::IBAN do
       let(:valid_iban) { "RU0204452560040702810412345678901" }
       let(:invalid_iban) { "RUXX0204452560040702810412345678901" }
     end
+
+    it_behaves_like "a country's IBAN", "SO" do
+      let(:valid_iban) { "SO211000001001000100141" }
+      let(:invalid_iban) { "SO411000001001000100141" }
+    end
+
+    it_behaves_like "a country's IBAN", "NI" do
+      let(:valid_iban) { "NI45BAPR00000013000003558124" }
+      let(:invalid_iban) { "NI55BAPR00000013000003558124" }
+    end
+
+    it_behaves_like "a country's IBAN", "FK" do
+      let(:valid_iban) { "FK88SC123456789012" }
+      let(:invalid_iban) { "FK8SC123456789012" }
+    end
+
+    it_behaves_like "a country's IBAN", "OM" do
+      let(:valid_iban) { "OM810180000001299123456" }
+      let(:invalid_iban) { "OM10180000001299123456" }
+    end
+
+    it_behaves_like "a country's IBAN", "YE" do
+      let(:valid_iban) { "YE15CBYE0001018861234567891234" }
+      let(:invalid_iban) { "YE1CBYE0001018861234567891234" }
+    end
   end
 
   describe "#local_check_digits" do