iban-tools 0.0.6

data/README.md

@@ -0,0 +1,50 @@
+# iban-tools
+
+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
+
+## Credit
+
+[Iulianu](http://github.com/iulianu) wrote [iban-tools](http://github.com/iulianu/iban-tools). We just removed use of `String#ord` for compatibility with Ruby 1.8 and 1.9 and of course pushed the built gem to gemcutter.
+
+You'll find the [source code](http://github.com/iulianu/iban-tools) on Github. [Our fork](http://github.com/alphasights/iban-tools) is also available on GitHub
+
+The gem should be compatible with Ruby 1.8.6, 1.8.7 and 1.9.1.
+
+## INSTALLATION
+
+You'll need to add http://gems.rubyforge.com as a gem source if you don't already have it.
+
+You can accomplish this with the gemcutter gem.
+
+    gem install gemcutter
+    gem tumble
+
+Once you have the gemcutter source added you can install iban-tools with a simple gem install.
+
+    gem install iban-tools
+
+## USAGE
+
+    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").validation_errors
+    => [: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"

data/lib/iban-tools.rb

@@ -0,0 +1,26 @@
+# vim:ts=2:sw=2:et:
+#--
+# Copyright (c) 2009 Iulian Dogariu
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#++
+
+require 'iban-tools/iban.rb'
+require 'iban-tools/iban_rules.rb'

data/lib/iban-tools/iban.rb

@@ -0,0 +1,88 @@
+# vim:ts=2:sw=2:et:
+
+module IBANTools
+  class IBAN
+
+    def self.valid?( code, rules = nil )
+      new(code).validation_errors(rules).empty?
+    end
+
+    def initialize( code )
+      @code = IBAN.canonicalize_code(code)
+    end
+
+    def validation_errors( rules = nil )
+      errors = []
+      return [:too_short] if @code.size < 5
+      return [:bad_chars] unless @code =~ /^[A-Z0-9]+$/
+      errors += validation_errors_against_rules( rules || IBAN.default_rules )
+      errors << :bad_check_digits unless valid_check_digits?
+      errors
+    end
+
+    def validation_errors_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
+      numerified = ""
+      (@code[4..-1] + @code[0..3]).each_byte do |byte|
+        numerified += case byte
+        # 0..9
+        when 48..57 then byte.chr
+        # 'A'..'Z'
+        when 65..90 then (byte - 55).to_s # 55 = 'A'.ord + 10
+        else
+          raise RuntimeError.new("Unexpected byte '#{byte}' in IBAN code '#{prettify}'")
+        end
+      end
+      numerified
+    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}"
+

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification 
+name: iban-tools
+version: !ruby/object:Gem::Version 
+  version: 0.0.6
+platform: ruby
+authors: 
+- Iulian Dogariu
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-05 00:00:00 +00:00
+default_executable: 
+dependencies: []
+
+description: Validates IBAN account numbers
+email: 
+- code@iuliandogariu.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.md
+- lib/iban-tools.rb
+- lib/iban-tools/iban.rb
+- lib/iban-tools/iban_rules.rb
+- lib/iban-tools/rules.yml
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: 
+- none
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: IBAN validator
+test_files: []
+