iban_bic 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ceee574baf89047cca1c43e4a56867d1a21c5765
-  data.tar.gz: aca6662efc0a326032265cd136d700da947c7010
+  metadata.gz: f7b2f833a71bf207363496a6140a16d97de02395
+  data.tar.gz: d35302a1fdd34187d969477b0205eabd45ba795d
 SHA512:
-  metadata.gz: 620962ed8c778c9a76fa26bad91bf8893761caa57d48f8468eb3dd2ac8e3b59845ddee9c9ddfa2916571827a3448421d6b30280b5844c8cbcc57bf980b32478c
-  data.tar.gz: bfb982acd2ed33a89d7da67d115d9bee90e9681a070f2f87d7a3ffc606b0fdc87113f10413995105f870f17dd9ff8e1baec7d3825fe8b2eab136420e31da5686
+  metadata.gz: 45b4e30101e361d6f92d0d9441574a3d0d03cbea192667194cee19935822d90b325257eb446e083b8411b0ce13d2455ea1915dc8e2b5b3c6c4434f356a61b770
+  data.tar.gz: 3ecf0d1ec09baf2850ac0b8fe640e8c6ee66e67947886b42854327186bcad59a17f927ebbd37c71c4b93928204889d62ba0a40acc2874047b0c93a2f375f76b9

data/README.md

@@ -8,8 +8,9 @@ When IBAN validation is not enough.
 [![Dependency Status](https://www.versioneye.com/user/projects/59d393190fb24f0046190d85/badge.svg?style=flat-square)](https://www.versioneye.com/user/projects/59d393190fb24f0046190d85?style=flat)
 
 ## Features
-* IBAN validation (`ActiveModel::EachValidator` and control digits calculator function) and fixing.
+* IBAN and BIC validation (using `ActiveModel::EachValidator`, IBAN control digits calculator function).
 * National account digits control validation (currently only ES and PT are included, others countries can be added).
+* IBAN fixing (global and national control digits).
 * Associated tags to countries (currently only SEPA and FIXED_CHECK tags are available).
 * BICs mapping from IBAN bank code part: COUNTRY + BANK => BIC code.
   * Currently, static data only includes some ES banks, PRs are welcomed.
@@ -18,7 +19,7 @@ When IBAN validation is not enough.
 
 ## Usage
 
-1. Validator: add IBAN validation to your models.
+1. IBAN validator: add IBAN validation to your models.
 
 ```ruby
 validates :iban, iban: true
@@ -30,35 +31,48 @@ You can also validate that IBAN is from a SEPA country.
 validates :iban, iban: { tags: [:sepa] }
 ```
 
-2. IBAN control digits calculation
+2. BIC validator: add BIC validation to your models.
+
+```ruby
+validates :bic, bic: true
+```
+
+You can specify the country field in the record to enforce its inclusion in the given BIC.
+
+```ruby
+validates :bic, bic: { country: :pais }
+```
+
+
+3. IBAN control digits calculation
 
 ```ruby
 2.4.1 :001 > IbanBic.calculate_check("ES0000030000300000000000")
  => 87
 ```
 
-3. IBAN parsing
+4. IBAN parsing
 
 ```ruby
 2.4.1 :001 > IbanBic.parse("ES8700030000300000000000")
 => {"country"=>"ES", "iban_check"=>"87", "bank"=>"0003", "branch"=>"0000", "check"=>"30", "account"=>"0000000000"}
 ```
 
-4. IBAN fixing (IBAN control digits and country control digits, if that code is available)
+5. IBAN fixing (IBAN control digits and country control digits, if that code is available)
 
 ```ruby
 2.4.1 :001 > IbanBic.fix("ES0000030000200000000000")
  => "ES8700030000300000000000"
 ```
 
-5. BIC calculation (bank code must be in the static file or in the database)
+6. BIC calculation (bank code must be in the static file or in the database)
 
 ```ruby
 2.4.1 :001 > IbanBic.calculate_bic("ES8700030000300000000000")
  => "BDEPESM1XXX"
 ```
 
-6. Pattern generation for SQL LIKE queries.
+7. Pattern generation for SQL LIKE queries.
 
 ```ruby
 2.4.1 :001 > IbanBic.like_pattern("ES8700030000300000000000", :country, :bank)
@@ -67,7 +81,7 @@ validates :iban, iban: { tags: [:sepa] }
  => "ES__0003________________"
 ```
 
-7. Random IBAN generation
+8. Random IBAN generation
 
 ```ruby
 2.4.1 :001 > require "iban_bic/random"
@@ -98,7 +112,7 @@ gem "iban_bic"
 $ bundle
 ```
 
-3. Run installer 
+3. If you will use this gem for BIC calculations or want to add additional country control codes validations, choose from any of the following two options to run the installer:
 
 3.a. Using BICs dynamic data from database
 
@@ -126,6 +140,10 @@ $ bundle exec rails generate iban_bic:install --with-static-data
 4. Customize initializer if needed, adding validations for new countries, or overriding YAML files.
 
 ## Changelog
+#### 1.4.0
+
+* BIC validation moved from BIC model to an independent validator.
+
 #### 1.3.0
 
 * Added BIC format validation in BIC model.

data/lib/active_model/validations/bic_validator.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "active_model/validations"
+require "iban_bic"
+
+# ActiveModel Rails module.
+module ActiveModel
+  # ActiveModel::Validations Rails module. Contains all the default validators.
+  module Validations
+    class BicValidator < ActiveModel::EachValidator
+      def validate_each(record, attribute, value)
+        country_field = options[:country] ? record[options[:country]] : "[A-Z]{2}"
+        unless /[A-Z]{4}#{country_field}[0-9A-Z]{2,5}/.match? value.upcase
+          record.errors.add(attribute, :invalid_format)
+        end
+      end
+    end
+  end
+end

data/lib/iban_bic/engine.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "active_model/validations/bic_validator"
 require "active_model/validations/iban_validator"
 
 module IbanBic

data/lib/iban_bic/models/bic.rb

@@ -4,13 +4,7 @@ class Bic < ActiveRecord::Base
   self.table_name = IbanBic.configuration.bics_table_name
 
   validates :country, :bank_code, :bic, presence: true
-
-  validate do
-    bic.upcase!
-    unless /[A-Z]{4}#{country}[0-9A-Z]{2,5}/.match? bic
-      errors.add(:bic, :invalid_format)
-    end
-  end
+  validates :bic, bic: { country: :country }
 
   after_commit do
     IbanBic.clear_cache

data/lib/iban_bic/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module IbanBic
-  VERSION = "1.3.0"
+  VERSION = "1.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iban_bic
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Leonardo Diez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-13 00:00:00.000000000 Z
+date: 2017-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -133,6 +133,7 @@ files:
 - Rakefile
 - data/bics/es.yml
 - data/iban_meta.yml
+- lib/active_model/validations/bic_validator.rb
 - lib/active_model/validations/iban_validator.rb
 - lib/generators/iban_bic/install_generator.rb
 - lib/generators/iban_bic/templates/create_bics.rb.erb