iulianu-iban-tools 0.0.1.1 → 0.0.2

data/README

@@ -1,18 +1,41 @@
-Installation
-------------
-You will need RubyGems 1.2.0 or later.
+iban-tools is a Ruby library for manipulating and validating
+IBAN account numbers.
 
- gem sources -a http://gems.github.com (you only have to do this once)
- sudo gem install iulianu-iban-tools
+Read more about IBAN at:
+http://en.wikipedia.org/wiki/International_Bank_Account_Number
 
-Usage
+USAGE
 -----
 
- irb(main):001:0> require 'rubygems'
- => true
- irb(main):002:0> require 'iban-tools'
- => true
- irb(main):003:0> IBANTools::IBAN.valid? "GB82 WEST 1234 5698 7654 32"
+ require 'rubygems'
+ require 'iban-tools'
+ 
+ IBANTools::IBAN.valid? "GB82 WEST 1234 5698 7654 32"
  => true
 
+ ### Advanced usage, gives more detailed error messages
+
+ IBANTools::IBAN.new("XQ75 BADCODE 666").validate
+ => [:unknown_country_code, :bad_check_digits]
+
+ ### Pretty print, canonicalize, and extract fields from an IBAN code
+
+ iban = IBANTools::IBAN.new " ro49  aaaa 1B31007593840000"
+
+ iban.code
+ => "RO49AAAA1B31007593840000"
+
+ iban.country_code
+ => "RO"
+
+ iban.prettify
+ => "RO49 AAAA 1B31 0075 9384 0000"
+
+INSTALLATION
+------------
+You will need RubyGems 1.2.0 or later.
+
+ gem sources -a http://gems.github.com
+ sudo gem install iulianu-iban-tools
+
 

data/lib/iban-tools/iban.rb

@@ -3,35 +3,84 @@
 module IBANTools
   class IBAN
 
-    def self.valid?( code )
-      new(code).validate.empty?
+    def self.valid?( code, rules = nil )
+      new(code).validate(rules).empty?
     end
 
     def initialize( code )
-      @code = code.gsub /\s+/, ''
+      @code = IBAN.canonicalize_code(code)
     end
 
-    def validate
+    def validate( rules = nil )
       errors = []
       return [:too_short] if @code.size < 5
-      errors << :bad_checksum unless valid_checksum?
+      return [:bad_chars] unless @code =~ /^[A-Z0-9]+$/
+      errors += validate_against_rules( rules || IBAN.default_rules )
+      errors << :bad_check_digits unless valid_check_digits?
       errors
     end
 
-    def valid_checksum?
+    def validate_against_rules( rules )
+      errors = []
+      return [:unknown_country_code] if rules[country_code].nil?
+      errors << :bad_length if rules[country_code]["length"] != @code.size
+      errors << :bad_format unless bban =~ rules[country_code]["bban_pattern"]
+      errors
+    end
+
+    # The code in canonical form,
+    # suitable for storing in a database
+    # or sending over the wire
+    def code
+      @code
+    end
+
+    def country_code
+      @code[0..1]
+    end
+
+    def check_digits
+      @code[2..3]
+    end
+
+    def bban
+      @code[4..-1]
+    end
+
+    def valid_check_digits?
       numerify.to_i % 97 == 1
     end
 
     def numerify
       (@code[4..-1] + @code[0..3]).chars.map do |ch|
-      	case ch.upcase
-	when '0'..'9'
-	  ch
-	when 'A'..'Z'
-	  (ch[0] - ?A + 10).to_s
-	end
+      	case ch
+	      when '0'..'9'
+          ch
+        when 'A'..'Z'
+          (ch[0] - ?A + 10).to_s
+        else
+          raise RuntimeError.new("Unexpected char '#{ch}' in IBAN code '#{prettify}'")
+        end
       end.join
     end
 
+    def to_s
+      "#<#{self.class}: #{prettify}>"
+    end
+
+    # The IBAN code in a human-readable format
+    def prettify
+      @code.gsub(/(.{4})/, '\1 ').strip
+    end
+
+    def self.canonicalize_code( code )
+      code.strip.gsub(/\s+/, '').upcase
+    end
+
+    # Load and cache the default rules from rules.yml
+    def self.default_rules
+      @default_rules = IBANRules.defaults
+    end
+
   end
 end

data/lib/iban-tools/iban_rules.rb

@@ -0,0 +1,32 @@
+# vim:ts=2:sw=2:et:
+
+require 'yaml'
+
+module IBANTools
+
+  class IBANRules
+
+    def initialize( rules = {} )
+      @rules = rules
+    end
+
+    def [](key)
+      @rules[key]
+    end
+
+    def self.defaults
+      load_from_string( File.read(File.dirname(__FILE__) + "/rules.yml") )
+    end
+
+    def self.load_from_string( string )
+      rule_hash = YAML.load(string)
+      rule_hash.each do |country_code, specs|
+        specs["bban_pattern"] = Regexp.new(specs["bban_pattern"])
+      end
+      IBANRules.new(rule_hash)
+    end
+
+  end
+
+end
+

data/lib/iban-tools/rules.yml

@@ -0,0 +1,242 @@
+# Data from http://www.tbg5-finance.org/?ibandocs.shtml/
+
+"AD":
+  # Andorra
+  length: 24
+  bban_pattern: "\d{8}[A-Z0-9]{12}"
+
+"AL":
+  # Albania
+  length: 28
+  bban_pattern: "\d{8}[A-Z0-9]{16}"
+
+"AT":
+  # Austria
+  length: 20
+  bban_pattern: "\d{16}"
+
+"BA":
+  # Bosnia
+  length: 20
+  bban_pattern: "\d{16}"
+
+"BE":
+  # Belgium
+  length: 16
+  bban_pattern: "\d{12}"
+
+"BG":
+  # Bulgaria
+  length: 22
+  bban_pattern: "[A-Z]{4}\d{6}[A-Z0-9]{8}"
+
+"CH":
+  # Switzerland
+  length: 21
+  bban_pattern: "\d{5}[A-Z0-9]{12}"
+
+"CY":
+  # Cyprus
+  length: 28
+  bban_pattern: "\d{8}[A-Z0-9]{16}"
+
+"CZ":
+  # Czech Republic
+  length: 24
+  bban_pattern: "\d{20}"
+
+"DE":
+  # Germany
+  length: 22
+  bban_pattern: "\d{18}"
+
+"DK":
+  # Denmark
+  length: 18
+  bban_pattern: "\d{14}"
+
+"EE":
+  # Estonia
+  length: 20
+  bban_pattern: "\d{16}"
+
+"ES":
+  # Spain
+  length: 24
+  bban_pattern: "\d{20}"
+
+"FI":
+  # Finland
+  length: 18
+  bban_pattern: "\d{14}"
+
+"FO":
+  # Faroe Islands
+  length: 18
+  bban_pattern: "\d{14}"
+
+"FR":
+  # France
+  length: 27
+  bban_pattern: "\d{10}[A-Z0-9]{11}\d{2}"
+
+"GB":
+  # United Kingdom
+  length: 22
+  bban_pattern: "[A-Z]{4}\d{14}"
+
+"GI":
+  # Gibraltar
+  length: 23
+  bban_pattern: "[A-Z]{4}[A-Z0-9]{15}"
+
+"GL":
+  # Greenland
+  length: 18
+  bban_pattern: "\d{14}"
+
+"GR":
+  # Greece
+  length: 27
+  bban_pattern: "\d{7}[A-Z0-9]{16}"
+
+"HR":
+  # Croatia
+  length: 21
+  bban_pattern: "\d{17}"
+
+"HU":
+  # Hungary
+  length: 28
+  bban_pattern: "\d{24}"
+
+"IE":
+  # Ireland
+  length: 22
+  bban_pattern: "[A-Z]{4}\d{14}"
+
+"IL":
+  # Israel
+  length: 23
+  bban_pattern: "\d{19}"
+
+"IS":
+  # Iceland
+  length: 26
+  bban_pattern: "\d{22}"
+
+"IT":
+  # Italy
+  length: 27
+  bban_pattern: "[A-Z]\d{10}[A-Z0-9]{12}"
+
+"LI":
+  # Liechtenstein
+  length: 21
+  bban_pattern: "\d{5}[A-Z0-9]{12}"
+
+"LT":
+  # Lithuania
+  length: 20
+  bban_pattern: "\d{16}"
+
+"LU":
+  # Luxembourg
+  length: 20
+  bban_pattern: "\d{3}[A-Z0-9]{13}"
+
+"LV":
+  # Latvia
+  length: 21
+  bban_pattern: "[A-Z]{4}[A-Z0-9]{13}"
+
+"MC":
+  # Monaco
+  length: 27
+  bban_pattern: "\d{10}[A-Z0-9]{11}\d{2}"
+
+"ME":
+  # Montenegro
+  length: 22
+  bban_pattern: "\d{18}"
+
+"MK":
+  # Macedonia
+  length: 19
+  bban_pattern: "\d{3}[A-Z0-9]{10}\d{2}"
+
+"MT":
+  # Malta
+  length: 31
+  bban_pattern: "[A-Z]{4}\d{5}[A-Z0-9]{18}"
+
+"MU":
+  # Mauritius
+  length: 30
+  bban_pattern: "[A-Z]{4}\d{19}[A-Z]{3}"
+
+"NL":
+  # Netherlands
+  length: 18
+  bban_pattern: "[A-Z]{4}\d{10}"
+
+"NO":
+  # Norway
+  length: 15
+  bban_pattern: "\d{11}"
+
+"PL":
+  # Poland
+  length: 28
+  bban_pattern: "\d{8}[A-Z0-9]{16}"
+
+"PT":
+  # Portugal
+  length: 25
+  bban_pattern: "\d{21}"
+
+"RO":
+  # Romania
+  length: 24
+  bban_pattern: "[A-Z]{4}[A-Z0-9]{16}"
+
+"RS":
+  # Serbia
+  length: 22
+  bban_pattern: "\d{18}"
+
+"SA":
+  # Saudi Arabia
+  length: 24
+  bban_pattern: "\d{2}[A-Z0-9]{18}"
+
+"SE":
+  # Sweden
+  length: 24
+  bban_pattern: "\d{20}"
+
+"SI":
+  # Slovenia
+  length: 19
+  bban_pattern: "\d{15}"
+
+"SK":
+  # Slovakia
+  length: 24
+  bban_pattern: "\d{20}"
+
+"SM":
+  # San Marino
+  length: 27
+  bban_pattern: "[A-Z]\d{10}[A-Z0-9]{12}"
+
+"TN":
+  # Tunisia
+  length: 24
+  bban_pattern: "\d{20}"
+
+"TR":
+  # Turkey
+  length: 26
+  bban_pattern: "\d{5}[A-Z0-9]{17}"
+

data/lib/iban-tools.rb

@@ -1,3 +1,4 @@
 # vim:ts=2:sw=2:et:
 
 require 'iban-tools/iban.rb'
+require 'iban-tools/iban_rules.rb'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: iulianu-iban-tools
 version: !ruby/object:Gem::Version 
-  version: 0.0.1.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Iulian Dogariu
@@ -26,6 +26,8 @@ files:
 - README
 - lib/iban-tools.rb
 - lib/iban-tools/iban.rb
+- lib/iban-tools/iban_rules.rb
+- lib/iban-tools/rules.yml
 has_rdoc: false
 homepage: 
 post_install_message: