iban-tools 1.0.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 97281d569702141068c2a7a708e8c2575ac867e7
-  data.tar.gz: 32d623b80cb8878fc2295e27ca7bd987bcef5f1c
+SHA256:
+  metadata.gz: 7212d683c7c3b3aacaf1d71a8954cfb325e0f4bcf8d8de768dd1c618e963f791
+  data.tar.gz: 0ea198c6321472c427cafbc96b17aaa4b28a15075cd2958ea64f48fdf65306ea
 SHA512:
-  metadata.gz: f4528a15faae008626cffd1b92d4979a1d18f0414eea511e55163a07e5b0620796eb3b69f94d100fb43168a59ba28dc7f517501746f02c6bd52c650594b0010b
-  data.tar.gz: f74d8c5ced292331dd28d3908035265d482161e3929c7d50f04344f4542dd94d037e989ccb219dd606898be7bd111387513563eab36e27eacce605c8762b816c
+  metadata.gz: 5db6b71a7245d8396e06b49907878ffc352604013ace9c38cbaed0e575950137c23e32e1094eeb869dd490d5488bfb17f542d7e0b24ce2962abbdeb8f026f12e
+  data.tar.gz: 4b76c82fbc3d64096ffe6b60578a11339ffc10c728d63f68f85d2a4eacc69acf309c814fa4742968c4951a52c256463253236a5452dccc7de7c372e4905d975a

data/README.md

@@ -2,13 +2,13 @@
 
 iban-tools is a Ruby library for manipulating and validating IBAN account numbers. You can [read more about IBAN](http://en.wikipedia.org/wiki/International_Bank_Account_Number) on Wikipedia
 
-[![Build Status](https://travis-ci.org/alphasights/iban-tools.svg)](https://travis-ci.org/alphasights/iban-tools)
+[![Build Status](https://travis-ci.org/alphasights/iban-tools.svg?branch=master)](https://travis-ci.org/alphasights/iban-tools)
 
 ## INSTALLATION
 
     gem install iban-tools
 
-    The gem should be compatible with MRI 1.8 and 1.9.
+The gem should be compatible with most Ruby versions.
 
 ## USAGE
 
@@ -34,7 +34,17 @@ Pretty print, canonicalize, and extract fields from an IBAN code
 
     iban.prettify
     => "RO49 AAAA 1B31 0075 9384 0000"
+    
+Convert  local account numbers to IBAN and back to local. 
+    
+    iban = IBANTools::IBAN.from_local('NO', bank_code: '9710', account_number: '1112222', check_digit: '7')
+    
+    iban.code
+    => "NO6197101112227"
+    
+    iban.to_local
+    => {:bank_code=>"9710", :account_number=>"111222", :check_digit=>"7"}
 
 ## Credit
 
-[Iulianu](http://github.com/iulianu) wrote [iban-tools](http://github.com/iulianu/iban-tools). [AlphaSights](https://coderwall.com/team/alphasights) is maintaining the gem.
+[Iulianu](http://github.com/iulianu) originally wrote [iban-tools](http://github.com/iulianu/iban-tools). The team at [AlphaSights](https://engineering.alphasights.com) is currently maintaining the gem.

data/lib/iban-tools/conversion.rb

@@ -4,12 +4,16 @@ module IBANTools
     def self.local2iban(country_code, data)
       config = load_config country_code
 
-      bban = config.map do |key, value|
-        insert_pattern = value[1]
-        # apply integer-typecast if it is intended to format as decimal-value
-        # this prevent mis-interpretation of integer with leading zeros into octal number!
-        insert_value = insert_pattern.include?('d') ? data[key.to_sym].to_i : data[key.to_sym]
-        insert_pattern % insert_value
+      bban = config.map do |key, values|
+        d = data[key.to_sym].dup
+        ret = [values].flatten.map do |value|
+          l = bban_format_length(value)
+          r = bban_format_to_format_string(value) % bban_format_cast(value, d[0..(l-1)])
+          d[0..(l-1)] = ''
+          r
+        end.join('')
+        # "%05s" % "a" -> "    a" and not "0000a"
+        ret.gsub(/ /, '0')
       end.join('')
 
       check_digits = "%02d" % checksum(country_code, bban)
@@ -22,18 +26,85 @@ module IBANTools
       config = load_config country_code
 
       local = {}
-      config.map do |key, value|
-        local[key.to_sym] = bban.scan(/^#{value[0]}/).first.sub(/^0+/, '')
-        bban.sub! /^#{value[0]}/, ''
+      config.map do |key, values|
+        local[key.to_sym] = [values].flatten.map do |value|
+          regexp = /^#{bban_format_to_regexp(value)}/
+          ret = bban.scan(regexp).first
+          bban.sub! regexp, ''
+          ret
+        end.join('')
+        local[key.to_sym].sub!(/^0+/, '')
+        local[key.to_sym] = '0' if local[key.to_sym] == ''
       end
       local
     end
 
     private
 
+    BBAN_REGEXP = /^(\d+)(!?)([nace])$/
+
+    def self.bban_format_length(format)
+      if format =~ BBAN_REGEXP
+        return $1.to_i
+      else
+        raise ArgumentError, "#{format} is not a valid bban format"
+      end
+    end
+
+    def self.bban_format_to_format_string(format)
+      if format =~ BBAN_REGEXP
+        if $3 == "e"
+          return " " * $1.to_i
+        end
+        format = '%0' + $1
+        format += case $3
+                 when 'n' then 'd'
+                 when 'a' then 's'
+                 when 'c' then 's'
+                 end
+        return format
+      else
+        raise ArgumentError, "#{format} is not a valid bban format"
+      end
+    end
+
+    def self.bban_format_cast(format, value)
+      if format =~ BBAN_REGEXP
+        if $3 == "n"
+          return value.to_i
+        else
+          return value
+        end
+      else
+        raise ArgumentError, "#{format} is not a valid bban format"
+      end
+    end
+
+    def self.bban_format_to_regexp(format)
+      if format =~ BBAN_REGEXP
+        regexp = case $3
+                 when 'n' then '[0-9]'
+                 when 'a' then '[A-Z]'
+                 when 'c' then '[a-zA-Z0-9]'
+                 when 'e' then '[ ]'
+                 end
+        regexp += '{'
+        unless $2 == '!'
+          regexp += ','
+        end
+        regexp += $1 + '}'
+        return regexp
+      else
+        raise ArgumentError, "#{format} is not a valid bban format"
+      end
+    end
+
     def self.load_config(country_code)
       default_config = YAML.
-        load(File.read(File.dirname(__FILE__) + '/conversion_rules.yml'))
+        load_file(File.join(File.dirname(__FILE__), 'conversion_rules.yml'))
+      unless default_config.key?(country_code)
+        raise ArgumentError, "Country code #{country_code} not availble"
+      end
       default_config[country_code]
     end
 

data/lib/iban-tools/conversion_rules.yml

@@ -1,11 +1,326 @@
+# Data from http://www.swift.com/dsp/resources/documents/IBAN_Registry.pdf
+# And the parsed, readable table on
+# http://en.wikipedia.org/wiki/International_Bank_Account_Number
+#
+# The values of the hashes follow the rules in the IBAN_Registry PDF:
+#
+# Length:
+# nn! - mixed length
+# nn  - maximum length
+#
+# Character representation
+# n - Digits (numeric characters 0 to 9 only)
+# a - Upper case letters (alphabetic characters A-Z only)
+# c - Upper and lower case alphanumeric characters (A-Z, a-z and 0-9)
+# e - blank space
+#
+# If a field has more than one kind of character representation, an array can
+# be used (see MU)
+#
+
+'AD':
+  bank_code: 4!n
+  branch_code: 4!n
+  account_number: 12!n
+
+'AE':
+  bank_code: 3!n
+  account_number: 16!n
+
+'AL':
+  bank_code: 3!n
+  branch_code: 4!n
+  check_digit: 1!n
+  account_number: 16!n
+
+'AT':
+  bank_code: 5!n
+  account_number: 11!n
+
+'AZ':
+  bank_code: 4!c
+  account_number: 20!n
+
+'BA':
+  bank_code: 3!n
+  branch_code: 3!n
+  account_number: 8!n
+  check_digits: 2!n
+
+'BE':
+  bank_code: 3!n
+  account_number: 7!n
+  check_digits: 2!n
+
+'BG':
+  bank_code: 4!a
+  branch_code: 4!n
+  account_type: 2!n
+  account_number: 8!c
+
+'BH':
+  bank_code: 4!a
+  account_number: 14!c
+
+'CH':
+  bank_code: 5!n
+  account_number: 12!c
+
+'CY':
+  bank_code: 3!n
+  branch_code: 5!n
+  account_number: 16!c
+
+'CZ':
+  bank_code: 4!n
+  account_prefix: 6!n
+  account_number: 10!n
+
 'DE':
-  blz: ['\d{8}', "%08d"]
-  account_number: ['\d{10}', "%010d"]
+  blz: 8!n
+  account_number: 10!n
+
+'DK':
+  bank_code: 4!n
+  account_number: 10!n
+
+'DO':
+  bank_code: 4!a
+  account_number: 20!n
+
+'EE':
+  bank_code: 2!n
+  branch_code: 2!n
+  account_number: 10!n
+  check_digits: 2!n
 
 'ES':
-  account_number: ['\d{20}', "%020d"]
+  account_number: 20!n
+
+'FI':
+  bank_code: 6!n
+  account_number: 7!n
+  check_digit: 1!n
+
+'FO':
+  bank_code: 4!n
+  account_number: 9!n
+  check_digit: 1!n
+
+'FR':
+  bank_code: 5!n
+  branch_code: 5!n
+  account_number: 11!c
+  check_digits: 2!n
+
+'GB':
+  bank_code: 4!a
+  branch_code: 6!n
+  account_number: 8!n
+
+'GE':
+  bank_code: 2!c
+  account_number: 16!n
+
+'GI':
+  bank_code: 4!a
+  account_number: 15!c
+
+'GL':
+  bank_code: 4!n
+  account_number: 10!n
+
+'GR':
+  bank_code: 3!n
+  branch_code: 4!n
+  account_number: 16!c
+
+'HR':
+  bank_code: 7!n
+  account_number: 10!n
+
+'HU':
+  bank_code: 3!n
+  branch_code: 4!n
+  account_prefix: 1!n
+  account_number: 15!n
+  check_digit: 1!n
+
+'IE':
+  bank_code: 4!c
+  branch_code: 6!c
+  account_number: 8n
+
+'IL':
+  bank_code: 3!n
+  branch_code: 3!n
+  account_number: 13!n
+
+'IS':
+  bank_code: 4!n
+  branch_code: 2!n
+  account_number: 6!n
+  kennitala: 10!n
+
+'IT':
+  check_char: 1!a
+  bank_code: 5!n
+  branch_code: 5!n
+  account_number: 12!c
+
+'JO':
+  bank_code: 4!a
+  branch_code: 4!n
+  zeros: 8!n
+  account_number: 10!n
+
+'KW':
+  bank_code: 4!a
+  account_number: 22!n
+
+'KZ':
+  bank_code: 3!n
+  account_number: 13!c
+
+'LB':
+  bank_code: 4!n
+  account_number: 20!c
+
+'LI':
+  bank_code: 5!n
+  account_number: 12!c
+
+'LT':
+  bank_code: 5!n
+  account_number: 11!n
+
+'LU':
+  bank_code: 3!n
+  account_number: 13!c
+
+'LV':
+  bank_code: 4!a
+  account_number: 13!c
+
+'MC':
+  bank_code: 5!n
+  branch_code: 5!n
+  account_number: 11!c
+  check_digits: 2!n
+
+'MD':
+  bank_code: 2!c
+  account_number: 18!n
+
+'ME':
+  bank_code: 3!n
+  account_number: 13!n
+  check_digits: 2!n
+
+'MK':
+  bank_code: 3!n
+  account_number: 10!c
+  check_digits: 2!n
+
+'MR':
+  bank_code: 5!n
+  branch_code: 5!n
+  account_number: 11!n
+  check_digits: 2!n
+
+'MT':
+  bank_code: 4!a
+  branch_code: 5!n
+  account_number: 18!c
+
+'MU':
+  bank_code: ['4!a', '2!n']
+  branch_code: 2!n
+  account_number: ['15!n', '3!a']
+
+'NL':
+  bank_code: 4!a
+  account_number: 10!n
+
+'NO':
+  # Don't remove the quotes here, NO == no == false in yaml.
+  bank_code: 4!n
+  account_number: 6!n
+  check_digit: 1!n
+
+'PK':
+  bank_code: 4!c
+  account_number: 16!n
+
+'PL':
+  bank_code: 3!n
+  branch_code: 4!n
+  check_digit: 1!n
+  account_number: 16!n
+
+'PS':
+  bank_code: 4!c
+  account_number: 21!n
+
+'PT':
+  bank_code: 4!n
+  branch_code: 4!n
+  account_number: 11!n
+  check_digits: 2!n
+
+'QA':
+  bank_code: 4!a
+  account_number: 21!c
+
+'RO':
+  bank_code: 4!a
+  account_number: 16!c
+
+'RS':
+  bank_code: 3!n
+  account_number: 13!n
+  check_digits: 2!n
+
+'SA':
+  bank_code: 2!n
+  account_number: 18!c
+
+'SE':
+  bank_code: 3!n
+  account_number: 16!n
+  check_digit: 1!n
+
+'SI':
+  bank_code: 2!n
+  branch_code: 3!n
+  account_number: 8!n
+  check_digits: 2!n
 
 'SK':
-  bank_code: ['\d{4}', "%04d"]
-  account_prefix: ['\d{6}', "%06d"]
-  account_number: ['\d{10}', "%010d"]
+  bank_code: 4!n
+  account_prefix: 6!n
+  account_number: 10!n
+
+'SM':
+  check_char: 1!a
+  bank_code: 5!n
+  branch_code: 5!n
+  account_number: 12!c
+
+'TN':
+  bank_code: 2!n
+  branch_code: 3!n
+  account_number: 15!n
+
+'TR':
+  bank_code: 5!n
+  reserved: 1!c
+  account_number: 16!c
+
+'VA':
+  bank_code: 3!n
+  account_number: 15!n
+
+'VG':
+  bank_code: 4!c
+  account_number: 16!n

data/lib/iban-tools/rules.yml

@@ -45,11 +45,36 @@
   length: 22
   bban_pattern: '[A-Z]{4}[A-Z0-9]{14}'
 
+'BR':
+  # Brazil
+  length: 29
+  bban_pattern: '\d{23}[A-Z0-9]{2}'
+
+'BY':
+  # Belarus
+  length: 28
+  bban_pattern: '[A-Z0-9]{4}\d{4}[A-Z0-9]{16}'
+
 'CH':
   # Switzerland
   length: 21
   bban_pattern: '\d{5}[A-Z0-9]{12}'
 
+'CI':
+  # Ivory Coast
+  length: 28
+  bban_pattern: '[A-Z0-9]{24}' # specification not clear
+
+'CR':
+  # Costa Rica
+  length: 22
+  bban_pattern: '\d{1}\d{3}\d{14}'
+
+'CV':
+  # Cape Verde
+  length: 25
+  bban_pattern: '\d{21}'
+
 'CY':
   # Cyprus
   length: 28
@@ -75,6 +100,11 @@
   length: 28
   bban_pattern: '[A-Z]{4}\d{20}'
 
+'EG':
+  # Egypt
+  length: 27
+  bban_pattern: '\d{23}' # specification not clear
+
 'EE':
   # Estonia
   length: 20
@@ -100,6 +130,11 @@
   length: 27
   bban_pattern: '\d{10}[A-Z0-9]{11}\d{2}'
 
+'GA':
+  # Gabon
+  length: 27
+  bban_pattern: '\d{23}' # specification not clear
+
 'GB':
   # United Kingdom
   length: 22
@@ -150,6 +185,11 @@
   length: 26
   bban_pattern: '\d{22}'
 
+'IQ':
+  # Iraq
+  length: 23
+  bban_pattern: '[A-Z]{4}[0-9]{15}'
+
 'IT':
   # Italy
   length: 27
@@ -210,6 +250,11 @@
   length: 22
   bban_pattern: '\d{18}'
 
+'MG':
+  # Madagascar
+  length: 27
+  bban_pattern: '\d{23}'
+
 'MK':
   # Macedonia
   length: 19
@@ -255,6 +300,11 @@
   length: 25
   bban_pattern: '\d{21}'
 
+'PS':
+  # Palestinian
+  length: 29
+  bban_pattern: '[A-Z]{4}[A-Z0-9]{21}'
+
 'QA':
   # Quatar
   length: 29
@@ -275,6 +325,11 @@
   length: 24
   bban_pattern: '\d{2}[A-Z0-9]{18}'
 
+'SC':
+  # Seychelles
+  length: 31
+  bban_pattern: '[A-Z]{4}[0-9]{20}[A-Z]{3}'
+
 'SE':
   # Sweden
   length: 24
@@ -295,6 +350,11 @@
   length: 27
   bban_pattern: '[A-Z]\d{10}[A-Z0-9]{12}'
 
+'SV':
+  # El Salvador
+  length: 28
+  bban_pattern: '[A-Z]{4}\d{20}'
+
 'TN':
   # Tunisia
   length: 24
@@ -305,3 +365,22 @@
   length: 26
   bban_pattern: '\d{5}[A-Z0-9]{17}'
 
+'UA':
+  # Ukraine
+  length: 29
+  bban_pattern: '\d{25}'
+
+'VA':
+  # Vatican City
+  length: 22
+  bban_pattern: '\d{18}'
+
+'VG':
+  # Virgin Islands
+  length: 24
+  bban_pattern: '[A-Z0-9]{4}\d{16}'
+
+'XK':
+  # Kosovo
+  length: 20
+  bban_pattern: '\d{4}\d{12}'

data/lib/iban-tools.rb

@@ -22,6 +22,6 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
 
-require 'iban-tools/conversion.rb'
-require 'iban-tools/iban.rb'
-require 'iban-tools/iban_rules.rb'
+require 'iban-tools/conversion'
+require 'iban-tools/iban'
+require 'iban-tools/iban_rules'

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: iban-tools
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Iulian Dogariu
 - Tor Erik Linnerud
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-09-23 00:00:00.000000000 Z
+date: 2023-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -58,7 +58,7 @@ homepage: https://github.com/alphasights/iban-tools
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -74,10 +74,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - none
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: IBAN validator
 test_files: []
-has_rdoc: