ibandit 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1d395f9c98c2624ae5fb316baa0c29f66f392ec8
-  data.tar.gz: 6ece4a67e949d1845941a5eaa131fddb0d60d20a
+  metadata.gz: 88b94ddf1d92608eb6b2139998ef10a94aed471f
+  data.tar.gz: 7ef91de41d5f0e5441c5172cb83c32c28b0b7c4d
 SHA512:
-  metadata.gz: f2759545860494377394eabaffb74020c9c96e8b726459c5aaa5ad51ec1bd7cb741dba1e8c230dbece8fe462e33802a2d88e5858533d88a80c877799ec831e1c
-  data.tar.gz: d70cabba73c7e4e9ad8023a84e26e5f1381caedc7d1d215dc91a70fd98f28a4b6838c23fa586ef76de7eca76a22c903eed24c325737479b485b7eadce95f8a28
+  metadata.gz: 0787d58ded4a0b90315183c9a1fca92c89ccb3d3b53c2fb53b696c1b16da54df7fd53bf8dbd562a5e0f879bbe435f065e7413a81e18e0258e48dd404e7eb3aeb
+  data.tar.gz: 1ea5256cecbdbbd870c829f5f77e34b9c4b35daa6837d1872720d34084eb6fc3794971954de2488762955c580af80577624262206fc0ccbfa4dbcac3e42f8c1e

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 0.3.5 - March 23, 2015
+
+- Use I18n for internationalised validation messages (patch by [@isaacseymour](https://github.com/isaacseymour))
+
 ## 0.3.4 - March 6, 2015
 
 - Update BLZ data

data/config/locale/en.yml

@@ -0,0 +1,13 @@
+en:
+  ibandit:
+    invalid_country_code: "'%{country_code}' is not a valid ISO 3166-1 IBAN country code"
+    invalid_check_digits: "Check digits failed modulus check. Expected '%{expected_check_digits}', received '%{check_digits}'."
+    invalid_length: "Length doesn't match SWIFT specification (expected %{expected_length} characters, received %{length})"
+    is_required: "is required"
+    wrong_length: "is the wrong length (should be %{expected} characters)"
+    not_used_in_country: "is not used in %{country_code}"
+    non_alphanumeric_characters: "Non-alphanumeric characters found: %{characters}"
+    invalid_format: "Unexpected format for a %{country_code} IBAN."
+    is_invalid: "is invalid"
+
+

data/config/locale/fr.yml

@@ -0,0 +1,12 @@
+fr:
+  ibandit:
+    invalid_country_code: "'%{country_code} n'est pas le code pays ISO 3166-1 de l'IBAN"
+    invalid_check_digits: "Les chiffres de vérification ont échoué les tests de modulo. '%{expected_check_digits}' attendu, '%{check_digits}' reçu."
+    invalid_length: "La longueur ne correspond pas aux spécifications SWIFT (%{expected_length} caractères attendus, %{length} reçus)"
+    is_required: "est requis"
+    wrong_length: "n'a pas la bonne longueur (doit avoir %{expected} caractères)"
+    not_used_in_country: "n'est pas utilisé en %{country_code}"
+    non_alphanumeric_characters: "Caractères non alphanumériques présents : %{characters}"
+    invalid_format: "Format inconnu pour l'IBAN %{country_code}."
+    is_invalid: "est invalide"
+

data/ibandit.gemspec

@@ -7,6 +7,8 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'sax-machine',     '~> 1.1'
   gem.add_development_dependency 'nokogiri',        '~> 1.6'
 
+  gem.add_runtime_dependency 'i18n', '~> 0.7.0'
+
   gem.authors = ['Grey Baker']
   gem.description = 'Ibandit is a Ruby library for manipulating and ' \
                     'validating IBANs. It allows you to construct an IBAN ' \

data/lib/ibandit.rb

@@ -1,3 +1,4 @@
+require 'i18n'
 require 'ibandit/version'
 require 'ibandit/errors'
 require 'ibandit/iban'
@@ -7,6 +8,8 @@ require 'ibandit/iban_assembler'
 require 'ibandit/local_details_cleaner'
 require 'ibandit/check_digit'
 
+I18n.load_path += Dir['config/locale/*.yml']
+
 module Ibandit
   class << self
     attr_accessor :bic_finder, :modulus_checker
@@ -21,5 +24,9 @@ module Ibandit
         File.expand_path('../../data/structures.yml', __FILE__)
       )
     end
+
+    def translate(key, options = {})
+      I18n.translate(key, { scope: [:ibandit] }.merge(options))
+    end
   end
 end

data/lib/ibandit/iban.rb

@@ -76,8 +76,8 @@ module Ibandit
       if Ibandit.structures.key?(country_code)
         true
       else
-        @errors[:country_code] = "'#{country_code}' is not a valid " \
-                                 'ISO 3166-1 IBAN country code'
+        @errors[:country_code] = Ibandit.translate(:invalid_country_code,
+                                                   country_code: country_code)
         false
       end
     end
@@ -89,9 +89,10 @@ module Ibandit
       if check_digits == expected_check_digits
         true
       else
-        @errors[:check_digits] = 'Check digits failed modulus check. ' \
-                                 "Expected '#{expected_check_digits}', " \
-                                 "received '#{check_digits}'"
+        @errors[:check_digits] =
+          Ibandit.translate(:invalid_check_digits,
+                            expected_check_digits: expected_check_digits,
+                            check_digits: check_digits)
         false
       end
     end
@@ -102,9 +103,10 @@ module Ibandit
       if iban.length == structure[:total_length]
         true
       else
-        @errors[:length] = "Length doesn't match SWIFT specification " \
-                           "(expected #{structure[:total_length]} " \
-                           "characters, received #{iban.size})"
+        @errors[:length] =
+          Ibandit.translate(:invalid_length,
+                            expected_length: structure[:total_length],
+                            length: iban.size)
         false
       end
     end
@@ -113,14 +115,14 @@ module Ibandit
       return unless valid_country_code?
 
       if bank_code.nil? || bank_code.length == 0
-        @errors[:bank_code] = 'is required'
+        @errors[:bank_code] = Ibandit.translate(:is_required)
         return false
       end
 
       return true if bank_code.length == structure[:bank_code_length]
 
-      @errors[:bank_code] = 'is the wrong length (should be ' \
-                            "#{structure[:bank_code_length]} characters)"
+      @errors[:bank_code] =
+        Ibandit.translate(:wrong_length, expected: structure[:bank_code_length])
       false
     end
 
@@ -129,12 +131,14 @@ module Ibandit
       return true if branch_code.to_s.length == structure[:branch_code_length]
 
       if structure[:branch_code_length] == 0
-        @errors[:branch_code] = "is not used in #{country_code}"
+        @errors[:branch_code] = Ibandit.translate(:not_used_in_country,
+                                                  country_code: country_code)
       elsif branch_code.nil? || branch_code.length == 0
-        @errors[:branch_code] = 'is required'
+        @errors[:branch_code] = Ibandit.translate(:is_required)
       else
-        @errors[:branch_code] = 'is the wrong length (should be ' \
-                                "#{structure[:branch_code_length]} characters)"
+        @errors[:branch_code] =
+          Ibandit.translate(:wrong_length,
+                            expected: structure[:branch_code_length])
       end
       false
     end
@@ -143,23 +147,24 @@ module Ibandit
       return unless valid_country_code?
 
       if account_number.nil?
-        @errors[:account_number] = 'is required'
+        @errors[:account_number] = Ibandit.translate(:is_required)
         return false
       end
 
       return true if account_number.length == structure[:account_number_length]
 
-      @errors[:account_number] = 'is the wrong length (should be ' \
-                                 "#{structure[:account_number_length]} " \
-                                 'characters)'
+      @errors[:account_number] =
+        Ibandit.translate(:wrong_length,
+                          expected: structure[:account_number_length])
       false
     end
 
     def valid_characters?
       return if iban.nil?
       if iban.scan(/[^A-Z0-9]/).any?
-        @errors[:characters] = 'Non-alphanumeric characters found: ' \
-                               "#{iban.scan(/[^A-Z\d]/).join(' ')}"
+        @errors[:characters] =
+          Ibandit.translate(:non_alphanumeric_characters,
+                            characters: iban.scan(/[^A-Z\d]/).join(' '))
         false
       else
         true
@@ -172,7 +177,8 @@ module Ibandit
       if bban =~ Regexp.new(structure[:bban_format])
         true
       else
-        @errors[:format] = "Unexpected format for a #{country_code} IBAN."
+        @errors[:format] = Ibandit.translate(:invalid_format,
+                                             country_code: country_code)
         false
       end
     end
@@ -183,7 +189,7 @@ module Ibandit
       if bank_code =~ Regexp.new(structure[:bank_code_format])
         true
       else
-        @errors[:bank_code] = 'is invalid'
+        @errors[:bank_code] = Ibandit.translate(:is_invalid)
         false
       end
     end
@@ -195,7 +201,7 @@ module Ibandit
       if branch_code =~ Regexp.new(structure[:branch_code_format])
         true
       else
-        @errors[:branch_code] = 'is invalid'
+        @errors[:branch_code] = Ibandit.translate(:is_invalid)
         false
       end
     end
@@ -206,7 +212,7 @@ module Ibandit
       if account_number =~ Regexp.new(structure[:account_number_format])
         true
       else
-        @errors[:account_number] = 'is invalid'
+        @errors[:account_number] = Ibandit.translate(:is_invalid)
         false
       end
     end
@@ -266,14 +272,14 @@ module Ibandit
     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'
+      @errors[modulus_check_bank_code_field] = Ibandit.translate(: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'
+      @errors[:account_number] = Ibandit.translate(:is_invalid)
       false
     end
 

data/lib/ibandit/version.rb

@@ -1,3 +1,3 @@
 module Ibandit
-  VERSION = '0.3.4'.freeze
+  VERSION = '0.3.5'.freeze
 end

data/spec/ibandit/iban_spec.rb

@@ -111,12 +111,17 @@ describe Ibandit::IBAN do
     end
 
     context 'with an unknown country code' do
+      before { iban.valid_country_code? }
       let(:iban_code) { 'AA123456789123456' }
       it { is_expected.to eq(false) }
 
-      it 'sets errors on the IBAN' do
-        iban.valid_country_code?
-        expect(iban.errors).to include(:country_code)
+      context 'locale en', locale: :en do
+        it 'sets errors on the IBAN' do
+          iban.valid_country_code?
+          expect(iban.errors).
+            to include(country_code: "'AA' is not a valid ISO 3166-1 IBAN " \
+                                     'country code')
+        end
       end
     end
   end
@@ -138,9 +143,23 @@ describe Ibandit::IBAN do
       let(:iban_code) { 'GB12WEST12345698765432' }
       it { is_expected.to eq(false) }
 
-      it 'sets errors on the IBAN' do
-        iban.valid_check_digits?
-        expect(iban.errors).to include(:check_digits)
+      context 'locale en', locale: :en do
+        it 'sets errors on the IBAN' do
+          iban.valid_check_digits?
+          expect(iban.errors).
+            to include(check_digits: 'Check digits failed modulus check. ' \
+                                     "Expected '82', received '12'.")
+        end
+      end
+
+      context 'locale fr', locale: :fr do
+        it 'sets errors on the IBAN' do
+          iban.valid_check_digits?
+          expect(iban.errors).
+            to include(check_digits: 'Les chiffres de vérification ont ' \
+                                     "échoué les tests de modulo. '82' " \
+                                     "attendu, '12' reçu.")
+        end
       end
     end
 
@@ -176,9 +195,23 @@ describe Ibandit::IBAN do
       let(:iban_code) { 'GB82WEST123456987654' }
       it { is_expected.to eq(false) }
 
-      it 'sets errors on the IBAN' do
-        iban.valid_length?
-        expect(iban.errors).to include(:length)
+      context 'locale en', locale: :en do
+        it 'sets errors on the IBAN' do
+          iban.valid_length?
+          expect(iban.errors).
+            to include(length: "Length doesn't match SWIFT specification " \
+                       '(expected 22 characters, received 20)')
+        end
+      end
+
+      context 'locale fr', locale: :fr do
+        it 'sets errors on the IBAN' do
+          iban.valid_length?
+          expect(iban.errors).
+            to include(length: 'La longueur ne correspond pas aux ' \
+                               'spécifications SWIFT (22 caractères ' \
+                               'attendus, 20 reçus)')
+        end
       end
     end
 
@@ -204,9 +237,22 @@ describe Ibandit::IBAN do
       before { allow(iban).to receive(:bank_code).and_return('WES') }
       it { is_expected.to eq(false) }
 
-      it 'sets errors on the IBAN' do
-        iban.valid_bank_code_length?
-        expect(iban.errors).to include(:bank_code)
+      context 'locale en', locale: :en do
+        it 'sets errors on the IBAN' do
+          iban.valid_bank_code_length?
+          expect(iban.errors).
+            to include(bank_code: 'is the wrong length (should be 4 ' \
+                                  'characters)')
+        end
+      end
+
+      context 'locale fr', locale: :fr do
+        it 'sets errors on the IBAN' do
+          iban.valid_bank_code_length?
+          expect(iban.errors).
+            to include(bank_code: "n'a pas la bonne longueur (doit avoir 4 " \
+                                  'caractères)')
+        end
       end
     end
 
@@ -232,9 +278,22 @@ describe Ibandit::IBAN do
       before { allow(iban).to receive(:branch_code).and_return('12345') }
       it { is_expected.to eq(false) }
 
-      it 'sets errors on the IBAN' do
-        iban.valid_branch_code_length?
-        expect(iban.errors).to include(:branch_code)
+      context 'locale en', locale: :en do
+        it 'sets errors on the IBAN' do
+          iban.valid_branch_code_length?
+          expect(iban.errors).
+            to include(branch_code: 'is the wrong length (should be 6 ' \
+                       'characters)')
+        end
+      end
+
+      context 'locale fr', locale: :fr do
+        it 'sets errors on the IBAN' do
+          iban.valid_branch_code_length?
+          expect(iban.errors).
+            to include(branch_code: "n'a pas la bonne longueur (doit avoir 6 " \
+                                    'caractères)')
+        end
       end
     end
 
@@ -242,9 +301,18 @@ describe Ibandit::IBAN do
       before { allow(iban).to receive(:branch_code).and_return(nil) }
       it { is_expected.to eq(false) }
 
-      it 'sets errors on the IBAN' do
-        iban.valid_branch_code_length?
-        expect(iban.errors).to include(:branch_code)
+      context 'locale en', locale: :en do
+        it 'sets errors on the IBAN' do
+          iban.valid_branch_code_length?
+          expect(iban.errors).to include(branch_code: 'is required')
+        end
+      end
+
+      context 'locale fr', locale: :fr do
+        it 'sets errors on the IBAN' do
+          iban.valid_branch_code_length?
+          expect(iban.errors).to include(branch_code: 'est requis')
+        end
       end
     end
 
@@ -270,9 +338,22 @@ describe Ibandit::IBAN do
       before { allow(iban).to receive(:account_number).and_return('1234567') }
       it { is_expected.to eq(false) }
 
-      it 'sets errors on the IBAN' do
-        iban.valid_account_number_length?
-        expect(iban.errors).to include(:account_number)
+      context 'locale en', locale: :en do
+        it 'sets errors on the IBAN' do
+          iban.valid_account_number_length?
+          expect(iban.errors).
+            to include(account_number: 'is the wrong length (should be 8 ' \
+                                       'characters)')
+        end
+      end
+
+      context 'locale fr', locale: :fr do
+        it 'sets errors on the IBAN' do
+          iban.valid_account_number_length?
+          expect(iban.errors).
+            to include(account_number: "n'a pas la bonne longueur (doit " \
+                                       'avoir 8 caractères)')
+        end
       end
     end
 
@@ -299,9 +380,21 @@ describe Ibandit::IBAN do
       let(:iban_code) { 'GB-123ABCD' }
       it { is_expected.to eq(false) }
 
-      it 'sets errors on the IBAN' do
-        iban.valid_characters?
-        expect(iban.errors).to include(:characters)
+      context 'locale en', locale: :en do
+        it 'sets errors on the IBAN' do
+          iban.valid_characters?
+          expect(iban.errors).
+            to include(characters: 'Non-alphanumeric characters found: -')
+        end
+      end
+
+      context 'locale fr', locale: :fr do
+        it 'sets errors on the IBAN' do
+          iban.valid_characters?
+          expect(iban.errors).
+            to include(characters: 'Caractères non alphanumériques présents ' \
+                                   ': -')
+        end
       end
     end
   end
@@ -318,9 +411,20 @@ describe Ibandit::IBAN do
       let(:iban_code) { 'GB82WEST12AAAAAA7654' }
       it { is_expected.to eq(false) }
 
-      it 'sets errors on the IBAN' do
-        iban.valid_format?
-        expect(iban.errors).to include(:format)
+      context 'locale en', locale: :en do
+        it 'sets errors on the IBAN' do
+          iban.valid_format?
+          expect(iban.errors).
+            to include(format: 'Unexpected format for a GB IBAN.')
+        end
+      end
+
+      context 'locale fr', locale: :fr do
+        it 'sets errors on the IBAN' do
+          iban.valid_format?
+          expect(iban.errors).
+            to include(format: "Format inconnu pour l'IBAN GB.")
+        end
       end
     end
 
@@ -350,9 +454,18 @@ describe Ibandit::IBAN do
 
       it { is_expected.to eq(false) }
 
-      it 'sets errors on the IBAN' do
-        iban.valid_bank_code_format?
-        expect(iban.errors).to include(:bank_code)
+      context 'locale en', locale: :en do
+        it 'sets errors on the IBAN' do
+          iban.valid_bank_code_format?
+          expect(iban.errors).to include(bank_code: 'is invalid')
+        end
+      end
+
+      context 'locale fr', locale: :fr do
+        it 'sets errors on the IBAN' do
+          iban.valid_bank_code_format?
+          expect(iban.errors).to include(bank_code: 'est invalide')
+        end
       end
     end
 
@@ -391,9 +504,18 @@ describe Ibandit::IBAN do
 
       it { is_expected.to eq(false) }
 
-      it 'sets errors on the IBAN' do
-        iban.valid_branch_code_format?
-        expect(iban.errors).to include(:branch_code)
+      context 'locale en', locale: :en do
+        it 'sets errors on the IBAN' do
+          iban.valid_branch_code_format?
+          expect(iban.errors).to include(branch_code: 'is invalid')
+        end
+      end
+
+      context 'locale fr', locale: :fr do
+        it 'sets errors on the IBAN' do
+          iban.valid_branch_code_format?
+          expect(iban.errors).to include(branch_code: 'est invalide')
+        end
       end
     end
 
@@ -431,9 +553,18 @@ describe Ibandit::IBAN do
 
       it { is_expected.to eq(false) }
 
-      it 'sets errors on the IBAN' do
-        iban.valid_account_number_format?
-        expect(iban.errors).to include(:account_number)
+      context 'locale en', locale: :en do
+        it 'sets errors on the IBAN' do
+          iban.valid_account_number_format?
+          expect(iban.errors).to include(account_number: 'is invalid')
+        end
+      end
+
+      context 'locale fr', locale: :fr do
+        it 'sets errors on the IBAN' do
+          iban.valid_account_number_format?
+          expect(iban.errors).to include(account_number: 'est invalide')
+        end
       end
     end
 
@@ -478,7 +609,13 @@ describe Ibandit::IBAN do
         let(:valid_account_number) { true }
 
         it { is_expected.to be(false) }
-        specify { expect(iban.errors).to include(bank_code: 'is invalid') }
+        context 'locale en', locale: :en do
+          specify { expect(iban.errors).to include(bank_code: 'is invalid') }
+        end
+
+        context 'locale fr', locale: :fr do
+          specify { expect(iban.errors).to include(bank_code: 'est invalide') }
+        end
 
         context 'when the bank code is not required' do
           let(:iban_code) { 'GB60BARC20000055779911' }
@@ -487,7 +624,17 @@ describe Ibandit::IBAN do
           before { iban.valid_local_modulus_check? }
 
           it { is_expected.to be(false) }
-          specify { expect(iban.errors).to include(branch_code: 'is invalid') }
+          context 'locale en', locale: :en do
+            specify do
+              expect(iban.errors).to include(branch_code: 'is invalid')
+            end
+          end
+
+          context 'locale fr', locale: :fr do
+            specify do
+              expect(iban.errors).to include(branch_code: 'est invalide')
+            end
+          end
         end
       end
 
@@ -496,7 +643,17 @@ describe Ibandit::IBAN do
         let(:valid_account_number) { false }
 
         it { is_expected.to be(false) }
-        specify { expect(iban.errors).to include(account_number: 'is invalid') }
+        context 'locale en', locale: :en do
+          specify do
+            expect(iban.errors).to include(account_number: 'is invalid')
+          end
+        end
+
+        context 'locale fr', locale: :fr do
+          specify do
+            expect(iban.errors).to include(account_number: 'est invalide')
+          end
+        end
       end
     end
   end

data/spec/spec_helper.rb

@@ -10,3 +10,11 @@ end
 def json_fixture(filename)
   JSON.parse(File.read("spec/fixtures/#{filename}.json"))
 end
+
+RSpec.shared_context 'locale en', locale: :en do
+  around { |example| I18n.with_locale(:en) { example.run } }
+end
+
+RSpec.shared_context 'locale fr', locale: :fr do
+  around { |example| I18n.with_locale(:fr) { example.run } }
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ibandit
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.5
 platform: ruby
 authors:
 - Grey Baker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-06 00:00:00.000000000 Z
+date: 2015-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -80,6 +80,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0
 description: Ibandit is a Ruby library for manipulating and validating IBANs. It allows
   you to construct an IBAN from national banking details; deconstruct an IBAN into
   national banking details; and validate an IBAN's check digits and format.
@@ -100,6 +114,8 @@ files:
 - TODO.md
 - bin/build_german_iban_rules.rb
 - bin/build_structure_file.rb
+- config/locale/en.yml
+- config/locale/fr.yml
 - data/german_iban_rules.yml
 - data/raw/BLZ2.txt
 - data/raw/IBANSTRUCTURE.xml