iban_bic 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c52896535d5704a64d38733ff91cd49356d4acda
-  data.tar.gz: 569ccc510d44e3da5522caab6a45f805c34ea93a
+  metadata.gz: 868d6d3504a7634591fb05755ef16e2b7d97d0bf
+  data.tar.gz: d7d92fa69d618d303c37447ab204c4aa7d7e166c
 SHA512:
-  metadata.gz: c9d1aa2265b7692f04fd562c6d0bc652e7108bf6283b7526259cd1c28b3181c470936d24609b267ab7ceb39240300c137aaa7d56667e75d5c05f473f894b079b
-  data.tar.gz: b256ef1d47c347a273a56a0d1ff0e4bc3fead2be3d55131a52b5ae3a9c3c709c2db42740a8ba72fbc281e586a661985a0f9e3ec9617f3038a044aea7476408ed
+  metadata.gz: 7543c3a4b9be73644d210d1e119f82c8efc907bcd86402b4920ae6f1be63e2393e7690222ed6f720931800b5f19d1ee23ee522fc1d6ed1a4a0fac387f7fa114a
+  data.tar.gz: 7355d2ff4621e6a2574508cbf5987383084e5c0305c4c57f50b916c721904ec51c307805ab526409e5414967f58fa35d3fed10371c3deaf916556e2bdcea374e

data/README.md

@@ -1,18 +1,20 @@
 # IBAN + BIC
 When IBAN validation is not enough.
 
+[![Gem](https://img.shields.io/gem/v/iban_bic.svg)](https://rubygems.org/gems/iban_bic)
 [![Travis](https://img.shields.io/travis/podemos-info/iban_bic/master.svg)](https://travis-ci.org/podemos-info/iban_bic)
 [![Codecov](https://img.shields.io/codecov/c/github/podemos-info/iban_bic.svg)](https://codecov.io/gh/podemos-info/iban_bic)
 [![Scrutinizer](https://img.shields.io/scrutinizer/g/podemos-info/iban_bic.svg)](https://scrutinizer-ci.com/g/podemos-info/iban_bic/)
 [![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).
-* National account digits control validation (currently only ES included, others countries can be added).
-* Associated tags to countries (currently only SEPA tag is available).
+* IBAN validation (`ActiveModel::EachValidator` and control digits calculator function) and fixing.
+* National account digits control validation (currently only ES and PT are included, others countries can be added).
+* 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.
 * Optional database model to allow apps to dynamically add new BICs mapping.
+* Random IBANs generator
 
 ## Usage
 
@@ -42,13 +44,37 @@ validates :iban, iban: { tags: [:sepa] }
 => {"country"=>"ES", "iban_check"=>"87", "bank"=>"0003", "branch"=>"0000", "check"=>"30", "account"=>"0000000000"}
 ```
 
-4. BIC calculation (bank code must be in the static file or in the database)
+4. IBAN fixing (IBAN control digits and country control digits, if that code is available)
 
 ```ruby
-2.4.1 :009 > IbanBic.calculate_bic("ES8700030000300000000000")
+2.4.1 :001 > IbanBic.fix("ES0000030000200000000000")
+ => "ES8700030000300000000000"
+```
+
+5. 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. Random IBAN generation
+
+```ruby
+2.4.1 :001 > require "iban_bic/random"
+ => true
+2.4.1 :002 > IbanBic.random_iban
+ => "MU52BOIR2768144336487102000AWQ"
+2.4.1 :003 > IbanBic.random_iban country: "ES"
+ => "ES6111051493192369291292"
+2.4.1 :004 > IbanBic.random_iban tags: [:sepa]
+ => "FI5584518206233159"
+2.4.1 :005 > IbanBic.random_iban not_tags: [:sepa]
+ => "IL317532867920826062774"
+```
+
+Note: It can't generate a valid IBAN code for some countries where iban check digits are fixed if validation code for that country is not available.
+
 ## Installation
 
 1. Add this line to your application's Gemfile
@@ -90,9 +116,17 @@ $ bundle exec rails generate iban_bic:install --with-static-data
 
 4. Customize initializer if needed, adding validations for new countries, or overriding YAML files.
 
-## TO-DO
+## Changelog
+
+#### 1.0.0
+
+* Added IBAN fixing and random IBAN generator.
+
+* Changed country checks, they must change check parts to generate the correct IBAN. Comparison against the original IBAN is made by the caller.
+
+#### 0.1.0
 
-* Faker data generation
+* First version.
 
 ## Contributing
 Contribution directions go here.

data/data/iban_meta.yml

@@ -12,18 +12,18 @@ AZ:
   tags:
 BA:
   parts: (?<iban_check>39)    (?<bank>\d{3})         (?<branch>\d{3})         (?<account>\d{8})        (?<check>\d{2})
-  tags:
+  tags: fixed_iban_check
 BE:
   parts: (?<iban_check>\d{2}) (?<bank>\d{3})         (?<account>\d{7})        (?<check>\d{2})
   tags: sepa
 BG:
-  parts: (?<iban_check>\d{2}) (?<bank>[A-Z]{4})       (?<branch>\d{4})         \d{2}                    (?<account>[A-Z0-9]{8})
+  parts: (?<iban_check>\d{2}) (?<bank>[A-Z]{4})      (?<branch>\d{4})         (?<type>\d{2})           (?<account>[A-Z0-9]{8})
   tags: sepa
 BH:
   parts: (?<iban_check>\d{2}) (?<bank>[A-Z]{4})      (?<account>[A-Z0-9]{14})
   tags:
 BR:
-  parts: (?<iban_check>\d{2}) (?<bank>\d{8})         (?<branch>\d{5})         (?<account>\d{10})       [A-Z][A-Z0-9]
+  parts: (?<iban_check>\d{2}) (?<bank>\d{8})         (?<branch>\d{5})         (?<account>\d{10})       (?<type>[A-Z])           (?<number>[A-Z0-9])
   tags:
 CH:
   parts: (?<iban_check>\d{2}) (?<bank>\d{5})         (?<account>[A-Z0-9]{12})
@@ -62,19 +62,19 @@ FR:
   parts: (?<iban_check>\d{2}) (?<bank>\d{5})         (?<branch>\d{5})         (?<account>[A-Z0-9]{11}) (?<check>\d{2})
   tags: sepa
 GB:
-  parts: (?<iban_check>\d{2}) (?<bank>[A-Z]{4})       (?<branch>\d{6})         (?<account>\d{8})
+  parts: (?<iban_check>\d{2}) (?<bank>[A-Z]{4})      (?<branch>\d{6})         (?<account>\d{8})
   tags: sepa
 GE:
   parts: (?<iban_check>\d{2}) (?<bank>[A-Z]{2})      (?<account>\d{16})
   tags:
 GI:
-  parts: (?<iban_check>\d{2}) (?<bank>[A-Z]{4})       (?<account>[A-Z0-9]{15})
+  parts: (?<iban_check>\d{2}) (?<bank>[A-Z]{4})      (?<account>[A-Z0-9]{15})
   tags: sepa
 GR:
   parts: (?<iban_check>\d{2}) (?<bank>\d{3})         (?<branch>\d{4})         (?<account>[A-Z0-9]{16})
   tags: sepa
 GT:
-  parts: (?<iban_check>\d{2}) (?<bank>[A-Z0-9]{4})   [A-Z0-9]{2}              [A-Z0-9]{2}              (?<account>[A-Z0-9]{16})
+  parts: (?<iban_check>\d{2}) (?<bank>[A-Z0-9]{4})   (?<currency>[A-Z0-9]{2}) (?<type>[A-Z0-9]{2})     (?<account>[A-Z0-9]{16})
   tags:
 HR:
   parts: (?<iban_check>\d{2}) (?<bank>\d{7})         (?<account>\d{10})
@@ -83,7 +83,7 @@ HU:
   parts: (?<iban_check>\d{2}) (?<bank>\d{3})         (?<branch>\d{4})         (?<check>\d)             (?<account>\d{15})       (?<check2>\d)
   tags: sepa
 IE:
-  parts: (?<iban_check>\d{2}) (?<bank>[A-Z]{4})       (?<branch>\d{6})         (?<account>\d{8})
+  parts: (?<iban_check>\d{2}) (?<bank>[A-Z]{4})      (?<branch>\d{6})         (?<account>\d{8})
   tags: sepa
 IL:
   parts: (?<iban_check>\d{2}) (?<bank>\d{3})         (?<branch>\d{3})         (?<account>\d{13})
@@ -113,7 +113,7 @@ LU:
   parts: (?<iban_check>\d{2}) (?<bank>\d{3})         (?<account>[A-Z0-9]{13})
   tags: sepa
 LV:
-  parts: (?<iban_check>\d{2}) (?<bank>[A-Z]{4})       (?<account>[A-Z0-9]{13})
+  parts: (?<iban_check>\d{2}) (?<bank>[A-Z]{4})      (?<account>[A-Z0-9]{13})
   tags: sepa
 MC:
   parts: (?<iban_check>\d{2}) (?<bank>\d{5})         (?<branch>\d{5})         (?<account>[A-Z0-9]{11}) (?<check>\d{2})
@@ -131,15 +131,15 @@ MR:
   parts: (?<iban_check>\d{2}) (?<bank>\d{5})         (?<branch>\d{5})         (?<account>\d{11})       (?<check>\d{2})
   tags:
 MT:
-  parts: (?<iban_check>\d{2}) (?<bank>[A-Z]{4})       (?<branch>\d{5})         (?<account>[A-Z0-9]{18})
+  parts: (?<iban_check>\d{2}) (?<bank>[A-Z]{4})      (?<branch>\d{5})         (?<account>[A-Z0-9]{18})
   tags: sepa
 MU:
-  parts: (?<iban_check>\d{2}) (?<bank>[A-Z]{4}\d{2}) (?<branch>\d{2})         (?<account>\d{12})       000[A-Z]{3}
+  parts: (?<iban_check>\d{2}) (?<bank>[A-Z]{4}\d{2}) (?<branch>\d{2})         (?<account>\d{12})       (?<zeros>000)            (?<currency>[A-Z]{3})
   tags:
 NL:
-  parts: (?<iban_check>\d{2}) (?<bank>[A-Z]{4})       (?<account>\d{10})
+  parts: (?<iban_check>\d{2}) (?<bank>[A-Z]{4})      (?<account>\d{10})
   tags: sepa
-NO:
+"NO":
   parts: (?<iban_check>\d{2}) (?<bank>\d{4})         (?<account>\d{6})        (?<check>\d)
   tags: sepa
 PK:
@@ -149,23 +149,23 @@ PL:
   parts: (?<iban_check>\d{2}) (?<bank>\d{3})         (?<branch>\d{4})         (?<check>\d)             (?<account>\d{16})  
   tags: sepa
 PS:
-  parts: (?<iban_check>\d{2}) (?<bank>[A-Z0-9]{4})   \d{9}                    (?<account>\d{12})
+  parts: (?<iban_check>\d{2}) (?<bank>[A-Z0-9]{4})   (?<unknown>\d{9})        (?<account>\d{12})
   tags:
 PT:
   parts: (?<iban_check>50)    (?<bank>\d{4})         (?<branch>\d{4})         (?<account>\d{11})       (?<check>\d{2})
-  tags: sepa
+  tags: sepa fixed_iban_check
 RO:
-  parts: (?<iban_check>\d{2}) (?<bank>[A-Z]{4})       (?<account>[A-Z0-9]{16})
+  parts: (?<iban_check>\d{2}) (?<bank>[A-Z]{4})      (?<account>[A-Z0-9]{16})
   tags: sepa
 RS:
-  parts: (?<iban_check>35)    (?<bank>\d{3})         (?<account>\d{13})       (?<check>\d{2}) 
-  tags:
+  parts: (?<iban_check>35)    (?<bank>\d{3})         (?<account>\d{13})       (?<check>\d{2})
+  tags: fixed_iban_check
 SE:
   parts: (?<iban_check>\d{2}) (?<bank>\d{3})         (?<account>\d{17})
   tags: sepa
 SI:
   parts: (?<iban_check>56)    (?<bank>\d{2})         (?<branch>\d{3})         (?<account>\d{8})        (?<check>\d{2})
-  tags: sepa
+  tags: sepa fixed_iban_check
 SK:
   parts: (?<iban_check>\d{2}) (?<bank>\d{4})         (?<branch>\d{6})         (?<account>\d{10})
   tags: sepa
@@ -173,10 +173,10 @@ SM:
   parts: (?<iban_check>\d{2}) (?<check>[A-Z])        (?<bank>\d{5})           (?<branch>\d{5})         (?<account>[A-Z0-9]{12})
   tags: sepa
 TN:
-  parts: (?<iban_check>59)    (?<bank>\d{2})         (?<branch>\d{3})         (?<account>\d{15})
-  tags:
+  parts: (?<iban_check>59)    (?<bank>\d{2})         (?<branch>\d{3})         (?<account>\d{13})       (?<check>\d{2})
+  tags: fixed_iban_check
 TR:
-  parts: (?<iban_check>\d{2}) (?<bank>\d{5})         0                        (?<account>[A-Z0-9]{16})
+  parts: (?<iban_check>\d{2}) (?<bank>\d{5})         (?<zeros>0)              (?<account>[A-Z0-9]{16})
   tags: sepa
 VG:
   parts: (?<iban_check>\d{2}) (?<bank>[A-Z]{4})      (?<account>\d{16})

data/lib/generators/iban_bic/templates/iban_bic.rb.erb

@@ -5,7 +5,7 @@ IbanBic.configure do |config|
   config.use_static_bics = <%= static_bics? %>
 
   # add [country_code] do |parts|
-  #   Here test that parts (bank, branch, account and/or check) satifies national checks
+  #   Here change the check parts (check, check2) to make other parts (bank, branch, account) satify country checks
   # end
 
   # config.iban_meta_path = "path/iban_meta.yml"

data/lib/iban_bic/configuration.rb

@@ -4,12 +4,8 @@ module IbanBic
   class Configuration
     attr_accessor :iban_meta_path, :use_static_bics, :bics_table_name, :static_bics_path
 
-    def country_validators
-      @country_validators ||= {}
-    end
-
     def add(country)
-      country_validators[country] = Proc.new
+      IbanBic.country_validators[country] = Proc.new
     end
 
     def static_bics?

data/lib/iban_bic/core.rb

@@ -1,8 +1,14 @@
 # frozen_string_literal: true
 
 module IbanBic
+  @cached_variables = []
+
   module_function
 
+  def country_validators
+    @country_validators ||= {}
+  end
+
   def configuration
     @configuration ||= Configuration.new
   end
@@ -16,6 +22,34 @@ module IbanBic
     parts ? ActiveSupport::HashWithIndifferentAccess[parts.names.zip(parts.captures)] : nil
   end
 
+  def fix(iban)
+    # Fixed check IBAN parts (countries where IBAN check is always the same) must be fixed before parsing
+    iban, fixed_iban_check = fix_fixed_iban_check(iban)
+
+    parts = parse(iban)
+    return unless parts
+
+    iban = calculate_valid_country_check_iban(iban)
+    iban = fix_iban_check(iban) unless fixed_iban_check
+
+    iban
+  end
+
+  def fix_fixed_iban_check(iban)
+    return [iban, false] unless tags[iban[0..1]].member?(:fixed_iban_check)
+
+    result = iban.dup
+    result[2..3] = /\(\?\<iban_check>([^\)]*)\)/.match(iban_meta[iban[0..1]]["parts"])[1]
+    [result, true]
+  end
+
+  def fix_iban_check(iban)
+    result = iban.dup
+    result[2..3] = "00"
+    result[2..3] = calculate_check(result).to_s.rjust(2, "0")
+    result.freeze
+  end
+
   def has_tags?(iban, searched_tags)
     (tags[iban[0..1]] & searched_tags).any?
   end
@@ -30,14 +64,25 @@ module IbanBic
     end .join.to_i % 97
   end
 
+  def valid?(iban)
+    valid_check?(iban) && valid_country_check?(iban)
+  end
+
   def valid_check?(iban)
     calculate_check(iban) == 97
   end
 
-  def valid_country_check?(iban)
+  def calculate_valid_country_check_iban(iban)
+    validator = country_validators[iban[0..1]]
+    return iban unless validator
+
     parts = parse(iban)
-    validator = IbanBic.configuration.country_validators[parts[:country]]
-    validator.nil? || validator.call(parts)
+    validator.call(parts)
+    parts.values.join
+  end
+
+  def valid_country_check?(iban)
+    calculate_valid_country_check_iban(iban) == iban
   end
 
   def calculate_bic(iban)
@@ -49,23 +94,34 @@ module IbanBic
   end
 
   def clear_cache
-    @parser = @static_bics = @dynamic_bics = nil
+    @cached_variables.each { |variable| instance_variable_set(variable, nil) }
+    @cached_variables.clear
+  end
+
+  def iban_meta
+    @iban_meta ||= ::YAML.load_file(configuration.iban_meta_path)
   end
 
   def parser
-    @parser ||= Hash[
-      ::YAML.load_file(configuration.iban_meta_path).map do |country, meta|
-        [country, /^(?<country>#{country})#{meta["parts"].delete(" ")}$/]
-      end
-    ].freeze
+    @parser ||= begin
+      @cached_variables << :@parser
+      Hash[
+        iban_meta.map do |country, meta|
+          [country, /^(?<country>#{country})#{meta["parts"].delete(" ")}$/]
+        end
+      ].freeze
+    end
   end
 
   def tags
-    @tags ||= Hash[
-      ::YAML.load_file(configuration.iban_meta_path).map do |country, meta|
-        [country, meta["tags"]&.split&.map(&:to_sym) || []]
-      end
-    ].freeze
+    @tags ||= begin
+      @cached_variables << :@tags
+      Hash[
+        iban_meta.map do |country, meta|
+          [country, meta["tags"]&.split&.map(&:to_sym) || []]
+        end
+      ].freeze
+    end
   end
 
   def bics
@@ -73,13 +129,17 @@ module IbanBic
   end
 
   def static_bics
-    @static_bics ||= Hash[Dir.glob(File.join(configuration.static_bics_path, "*.yml")).map do |file|
-      [File.basename(file).delete(".yml").upcase, YAML.load_file(file)]
-    end].freeze
+    @static_bics ||= begin
+      @cached_variables << :@static_bics
+      Hash[Dir.glob(File.join(configuration.static_bics_path, "*.yml")).map do |file|
+        [File.basename(file).delete(".yml").upcase, YAML.load_file(file)]
+      end].freeze
+    end
   end
 
   def dynamic_bics
     @dynamic_bics ||= begin
+      @cached_variables << :@dynamic_bics
       ret = {}
       Bic.find_each do |bic|
         ret[bic.country] = {} unless ret[bic.country]

data/lib/iban_bic/defaults.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "iban_bic/validators/countries/es.rb"
+require "iban_bic/validators/countries/pt.rb"
 
 IbanBic.configure do |config|
   config.iban_meta_path = File.expand_path("../../data/iban_meta.yml", __dir__)

data/lib/iban_bic/random.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "regexp-examples"
+
+module IbanBic
+  module_function
+
+  def random_iban(options = {})
+    country = options[:country]
+    searched_tags = options[:tags]
+    non_searched_tags = options[:not_tags]
+
+    unless country
+      possible_countries = random_generator.keys
+      possible_countries -= IbanBic.tags.select { |_country, country_tags| (searched_tags - country_tags).any? } .keys if searched_tags.present?
+      possible_countries -= IbanBic.tags.select { |_country, country_tags| (non_searched_tags & country_tags).any? } .keys if non_searched_tags.present?
+      country = possible_countries.sample
+    end
+    IbanBic.fix(random_generator[country].random_example)
+  end
+
+  def random_generator
+    @random_generator ||= begin
+      @cached_variables << :@random_generator
+      Hash[
+        iban_meta.map do |country, meta|
+          [country, /^#{country}#{meta["parts"].delete(" ").gsub(/\(\?\<\w+\>([^\)]*)\)/, "\\1")}$/]
+        end
+      ].freeze
+    end
+  end
+end

data/lib/iban_bic/validators/countries/es.rb

@@ -1,12 +1,11 @@
 # frozen_string_literal: true
 
-def __bic_validation_proc(digits)
-  ret = 11 - digits.chars.each_with_index.sum { |x, i| x.to_i * 2**i } % 11
-  ret < 10 ? ret : 11 - ret
-end
-
 IbanBic.configure do
+  def __iban_bic_es_bic_validation_proc(digits)
+    ret = 11 - digits.chars.each_with_index.sum { |x, i| x.to_i * 2**i } % 11
+    ret < 10 ? ret : 11 - ret
+  end
   add "ES" do |parts|
-    parts[:check] == "#{__bic_validation_proc("00#{parts[:bank]}#{parts[:branch]}")}#{__bic_validation_proc(parts[:account])}"
+    parts[:check] = "#{__iban_bic_es_bic_validation_proc("00#{parts[:bank]}#{parts[:branch]}")}#{__iban_bic_es_bic_validation_proc(parts[:account])}"
   end
 end

data/lib/iban_bic/validators/countries/pt.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+IbanBic.configure do
+  IBAN_BIC_PT_WEIGHTS_INDEX = [73, 17, 89, 38, 62, 45, 53, 15, 50, 5, 49, 34, 81, 76, 27, 90, 9, 30, 3].freeze
+
+  add "PT" do |parts|
+    nib = "#{parts[:bank]}#{parts[:branch]}#{parts[:account]}"
+    sum = nib.chars.map(&:to_i).zip(IBAN_BIC_PT_WEIGHTS_INDEX).map { |a| a.inject(:*) } .sum
+    parts[:check] = 98 - sum % 97
+  end
+end

data/lib/iban_bic/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iban_bic
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Leonardo Diez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-04 00:00:00.000000000 Z
+date: 2017-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: regexp-examples
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: codecov
   requirement: !ruby/object:Gem::Requirement
@@ -129,10 +143,12 @@ files:
 - lib/iban_bic/defaults.rb
 - lib/iban_bic/engine.rb
 - lib/iban_bic/models/bic.rb
+- lib/iban_bic/random.rb
 - lib/iban_bic/validators/countries/es.rb
+- lib/iban_bic/validators/countries/pt.rb
 - lib/iban_bic/version.rb
 - lib/tasks/load_data.rake
-homepage: https://github.info/podemos-info/iban_bic
+homepage: https://github.com/podemos-info/iban_bic
 licenses:
 - MIT
 metadata: {}