ibandit 1.19.0 → 1.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47171b99a86687a326f6f674684d5faa489f4aef980e623e2f43d3ffdf841d84
-  data.tar.gz: 6074f09b34e39a205fdacabbc1a7376dfec8ac38f2821cbfd1d7ae6a8ba683cf
+  metadata.gz: 37a15fbc4242dda50e51d295ef5e37e6ee692d5f91d43d32842c2df570213e82
+  data.tar.gz: db530699e09d54603f27cbee4c4d6e9f254e89557ce1c41ac0cbfb8e82a58e90
 SHA512:
-  metadata.gz: 9f2ff5eb107524c44c68118315f916d86c7550335bae82747165edbfcf4f11d196b29cd3ec6f130babbf7765866925768dca7b5532357510248e8994e9bca0ae
-  data.tar.gz: 0a66dd61f63feeb8534a6b48de006c64928c6f43bf65463ca8e24ccd412d13aa87fc8b8102a4fb54d5585d70a96df91db50be8117c7c025ac576fb0d033c4909
+  metadata.gz: 1a9b288596e9bddae7eab282e12f20a650bdbc74016240f56f4a7a34fa9628885070b276ac079d149a146a4cd0ac68ceb58923001edb40159bd368637b1534d2
+  data.tar.gz: '08f3f363786871a019ebe9122d1b9fe96893823811a9578d25a652757a01d8b4e9904ae4ecf32542a2ddb856894486816429a97f65ecd7bc450158c0924de475'

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 1.21.0 - August 6, 2024
+
+- Canada, Financial Institution number - allow 3 digits
+- modulus_checker failures will now return validation method specific error message
+
+## 1.20.0 - October 13, 2023
+
+- Do not allow all 0 transit numbers in CA
+
 ## 1.19.0 - October 3, 2023
 
 - Do not allow all-0 account numbers for CA

data/config/locales/da.yml

@@ -17,3 +17,4 @@ da:
     bank_code_does_not_exist: "bankkoden findes ikke"
     has_invalid_clearing_code_length: "længden på clearingskoden er ugyldig"
     has_invalid_serial_number: "ugyldigt serienummer"
+    branch_code_does_not_exist: "filialkode findes ikke"

data/config/locales/de.yml

@@ -17,3 +17,4 @@ de:
     bank_code_does_not_exist: "Bankleitzahl existiert nicht"
     has_invalid_clearing_code_length: "Länge des Verrechnungscodes ist ungültig"
     has_invalid_serial_number: "Seriennummer ist ungültig"
+    branch_code_does_not_exist: "Filialcode existiert nicht"

data/config/locales/en.yml

@@ -17,3 +17,4 @@ en:
     bank_code_does_not_exist: "bank code does not exist"
     has_invalid_clearing_code_length: "clearing code length is invalid"
     has_invalid_serial_number: "serial number is invalid"
+    branch_code_does_not_exist: "branch code does not exist"

data/config/locales/es.yml

@@ -1,7 +1,7 @@
 es:
   ibandit:
-    invalid_country_code: "\"%{country_code}\" no es un código de país IBAN ISO 3166-1 válido"
-    invalid_check_digits: "Los dígitos de verificación han generado un error en la comprobación del módulo. Se esperaba \"%{expected_check_digits}\", pero se ha recibido \"%{check_digits}\"."
+    invalid_country_code: '"%{country_code}" no es un código de país IBAN ISO 3166-1 válido'
+    invalid_check_digits: 'Los dígitos de verificación han generado un error en la comprobación del módulo. Se esperaba "%{expected_check_digits}", pero se ha recibido "%{check_digits}".'
     invalid_length: "La longitud no coincide con la especificación SWIFT (se esperaban %{expected_length} caracteres, pero se han recibido %{length})"
     is_required: "es obligatorio"
     wrong_length: "no tiene la longitud correcta (debe tener %{expected} caracteres)"
@@ -17,3 +17,4 @@ es:
     bank_code_does_not_exist: "codigo bancario inexistente"
     has_invalid_clearing_code_length: "codigo de oficina de oficina de compensación invalido"
     has_invalid_serial_number: "número de serie invalido"
+    branch_code_does_not_exist: "código de sucursal no existe"

data/config/locales/fr.yml

@@ -17,3 +17,4 @@ fr:
     bank_code_does_not_exist: "le code de la banque n'existe pas"
     has_invalid_clearing_code_length: "la longueur du clearing code n'est pas valide"
     has_invalid_serial_number: "le numéro de série n'est pas valide"
+    branch_code_does_not_exist: "le code de la succursale n'existe pas"

data/config/locales/it.yml

@@ -1,6 +1,6 @@
 it:
   ibandit:
-    invalid_country_code: "\"%{country_code}\" non è un codice di paese IBAN 3166-1 valido"
+    invalid_country_code: '"%{country_code}" non è un codice di paese IBAN 3166-1 valido'
     invalid_check_digits: "Controllo del modulo non riuscito per i caratteri. %{expected_check_digits} caratteri previsti, %{check_digits} immessi."
     invalid_length: "La lunghezza non corrisponde alla specifica SWIFT (%{expected_length} caratteri previsti, %{length} immessi)"
     is_required: "è obbligatorio"
@@ -17,4 +17,4 @@ it:
     bank_code_does_not_exist: "codice banca inesistente"
     has_invalid_clearing_code_length: "lunghezza clearing code non valida"
     has_invalid_serial_number: "numero di serie non valido"
-
+    branch_code_does_not_exist: "codice filiale non esiste"

data/config/locales/nb.yml

@@ -17,3 +17,4 @@ nb:
     bank_code_does_not_exist: "bankkoden eksisterer ikke"
     has_invalid_clearing_code_length: "registreringsnummerets lengde er ugyldig"
     has_invalid_serial_number: "ugyldig serienummer"
+    branch_code_does_not_exist: "filialkode eksisterer ikke"

data/config/locales/nl.yml

@@ -17,3 +17,4 @@ nl:
     bank_code_does_not_exist: "bankcode bestaat niet"
     has_invalid_clearing_code_length: "lengte clearingcode is ongeldig"
     has_invalid_serial_number: "serienummer is ongeldig"
+    branch_code_does_not_exist: "takcode bestaat niet"

data/config/locales/pt.yml

@@ -17,3 +17,4 @@ pt:
     bank_code_does_not_exist: "o código do banco não existe"
     has_invalid_clearing_code_length: "o comprimento do código de libertação é inválido"
     has_invalid_serial_number: "o número de série é inválido"
+    branch_code_does_not_exist: "código da filial não existe"

data/config/locales/sl.yml

@@ -17,3 +17,4 @@ sl:
     bank_code_does_not_exist: "koda banke ne obstaja"
     has_invalid_clearing_code_length: "dolžina klirinške kode ni veljavna"
     has_invalid_serial_number: "serijska številka ni veljavna"
+    branch_code_does_not_exist: "koda podružnice ne obstaja"

data/config/locales/sv.yml

@@ -17,3 +17,4 @@ sv:
     bank_code_does_not_exist: "bankkoden existerar inte"
     has_invalid_clearing_code_length: "clearingnumrets längd är ogiltigt"
     has_invalid_serial_number: "ogiltigt serienummer"
+    branch_code_does_not_exist: "filialkod finns inte"

data/data/raw/pseudo_ibans.yml

@@ -13,14 +13,17 @@ 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}"
-  :branch_code_format: "\\d{5}"
+  :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
   :pseudo_iban_bank_code_length: 4

data/data/structures.yml

@@ -1493,14 +1493,17 @@ 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}"
-  :branch_code_format: "\\d{5}"
+  :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
   :pseudo_iban_bank_code_length: 4

data/ibandit.gemspec

@@ -27,7 +27,7 @@ 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 "gc_ruboconfig",   "~> 5.0"
   spec.add_development_dependency "nokogiri",        "~> 1.6"
   spec.add_development_dependency "pry",             "~> 0.13"
   spec.add_development_dependency "pry-byebug",      "~> 3.10"

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])
@@ -197,14 +200,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 +237,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]),
@@ -509,17 +508,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/version.rb

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

data/spec/ibandit/iban_spec.rb

@@ -422,10 +422,55 @@ describe Ibandit::IBAN do
         {
           country_code: "CA",
           bank_code: bank_code,
-          branch_code: "00063",
+          branch_code: branch_code,
           account_number: account_number,
         }
       end
+      let(:branch_code) { "00063" }
+
+      context "and a 5 digit branch code" do
+        let(:account_number) { "0123456" }
+        let(:bank_code) { "036" }
+        let(:branch_code) { "00063" }
+
+        its(:country_code) { is_expected.to eq("CA") }
+        its(:bank_code) { is_expected.to eq("0036") }
+        its(:branch_code) { is_expected.to eq("00063") }
+        its(:account_number) { is_expected.to eq("0123456") }
+        its(:swift_bank_code) { is_expected.to eq("0036") }
+        its(:swift_branch_code) { is_expected.to eq("00063") }
+        its(:swift_account_number) { is_expected.to eq("0123456") }
+        its(:swift_national_id) { is_expected.to eq("003600063") }
+        its(:pseudo_iban) { is_expected.to eq("CAZZ003600063_____0123456") }
+
+        its(:iban) { is_expected.to be_nil }
+        its(:valid?) { is_expected.to eq(true) }
+        its(:to_s) { is_expected.to eq("") }
+      end
+
+      context "for an all zero transit number" do
+        let(:account_number) { "0123456" }
+        let(:bank_code) { "036" }
+        let(:branch_code) { "00000" }
+
+        it "is invalid and has the correct errors" do
+          expect(subject.valid?).to eq(false)
+          expect(subject.errors).
+            to eq(branch_code: "format is invalid")
+        end
+      end
+
+      context "and a 4 digit branch code" do
+        let(:account_number) { "0123456" }
+        let(:bank_code) { "036" }
+        let(:branch_code) { "0063" }
+
+        it "is invalid and has the correct errors" do
+          expect(subject.valid?).to eq(false)
+          expect(subject.errors).
+            to eq(branch_code: "is the wrong length (should be 5 characters)")
+        end
+      end
 
       context "and a 3 digit bank code" do
         let(:account_number) { "0123456" }
@@ -1296,7 +1341,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
 
@@ -1323,7 +1368,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
 
@@ -1536,7 +1581,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
@@ -1601,7 +1646,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
@@ -1666,7 +1711,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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ibandit
 version: !ruby/object:Gem::Version
-  version: 1.19.0
+  version: 1.21.0
 platform: ruby
 authors:
 - GoCardless
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-03 00:00:00.000000000 Z
+date: 2024-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gc_ruboconfig
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement