ibanizator 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f4516010c74f2fff18512e7fab52aea278531edf
-  data.tar.gz: 2cc32ba114285a09e3650580d2dca904d0229eb8
+  metadata.gz: 80f3e9fb535d2e6919de65a9edbedbde43ea2277
+  data.tar.gz: 7c75a0460dc326a4bf404daf231f0b5f7f427f11
 SHA512:
-  metadata.gz: 87eeea15696057f3a361695d878b079fa7afa3f1fdb91bb8057aed1cc8a99ee600394dfe622357037272eea0be12c7060d33b7ce65c7a3a48169904f2a637cdd
-  data.tar.gz: bade9a4c18b8efd786440cc7e119e6c26470334f24018e43d2a28a0bd533472e833b4dc0a44390966922fd65f781704ef0e8b8b7b81e2b368c161098f91b4151
+  metadata.gz: 394f6e0642c5589d19d0013f5fe72469488e459c2e95034cdc835a9c3282002a8ae08338bb103bbb79853137974e2c4f8009e7c681baacb7a50dfb235a7d899c
+  data.tar.gz: 491636beb8fed35fc402bf717cc86a2a55585ded14d046519978ea85bd1c8aed8578ea6915a6e231a6d531a2eda97e1069669908677770ce37f91bf09510e845

data/README.md

@@ -20,21 +20,32 @@ To calculate the iban for some german accounts, just use this method:
 
 In the current version the ibanizator gem only works for german accounts.
 
-### Validate IBAN
+### Validate an IBAN
 
 To validate the iban you need to check the length and after this check the checksum. For details please refer to
 the documentation online (e.g. http://es.wikipedia.org/wiki/IBAN).
 
-This gem provides a simple validator for several contries. All countries that are listed in the Iban::LENGTHS hash are supported at the moment.
+This gem provides a simple validator for several contries. All countries that are listed in the Ibanizator::Iban::LENGTHS hash are supported at the moment.
 
-    validator = Iban::Validator.new
-    valid = validator.validate_iban("DE68 2105 0170 0012 3456 78") # => true
+```ruby
+    iban = Ibanizator.iban_form_string("DE68 2105 0170 0012 3456 78")
+    iban.valid? # => true
+```
 
-There is an alternate way to validate an IBAN as a result of the 0.0.1 Version:
+### Information provided by an IBAN
 
-    ibanizator.validate_iban("DE68 2105 0170 0012 3456 78") # => true
+The Ibanizator::Iban class provides some handy utility methods to query
+information about an iban.
 
-The method returns true for valid ibans and false for invalid ibans. If the iban is too short or is using an unimplemented country code, the method throws an exception.
+```ruby
+    iban = Ibanizator.iban_form_string("DE68 2105 0170 0012 3456 78")
+    iban.country_code # => :DE
+
+    # there is extended data for german ibans
+    iban.extended_data.bank_code        # => "21050170"
+    iban.extended_data.account_number   # => "12345678"
+    iban.extended_data.bic              # => "NOLADE21KIE"
+```
 
 ### Find bank infos
 

data/lib/iban/validator.rb

@@ -1,8 +1,8 @@
-require_relative 'lengths'
-
 module Iban
   class Validator
+    # <b>DEPRECATED:</b> Please use <tt>Ibanizator.iban_from_string(an_iban).valid?</tt> instead.
     def validate_iban(input)
+      warn "[DEPRECATION] `Iban#validate_iban` is deprecated.  Please use `Ibanizator.iban_from_string(an_iban).valid?instead."
       iban = sanitize_input(input)
 
       valid_length?(iban) && valid_checksum?(iban)
@@ -18,7 +18,7 @@ module Iban
     def valid_length?(iban)
       return false if iban.length <= 4 # two digits for the country code and two for the checksum
       country_code = iban[0..1].upcase.to_sym
-      iban.length == LENGTHS[country_code]
+      iban.length == Ibanizator::Iban::LENGTHS[country_code]
     end
 
     def valid_checksum?(iban)

data/lib/ibanizator/bank_db.rb

@@ -1,5 +1,7 @@
 class Ibanizator
   class BankDb
+    class BankNotFoundError < StandardError ; end
+
     attr_reader :known_banks
 
     def initialize

data/lib/ibanizator/iban/extended_data/de.rb

@@ -0,0 +1,31 @@
+class Ibanizator
+  class Iban
+    module ExtendedData
+      class DE
+        attr_reader :iban
+        include Equalizer.new(:iban)
+        include Adamantium
+
+        def initialize(iban)
+          raise Invalid, "can't compute extended data on invalid iban" unless iban.valid?
+          @iban = iban
+        end
+
+        def bank_code
+          iban.to_s[4..11]
+        end
+        memoize :bank_code
+
+        def account_number
+          iban.to_s[12..-1].gsub(/\A0+/,"")
+        end
+        memoize :account_number
+
+        def bic
+          Ibanizator.bank_db.bank_by_bank_code(bank_code).bic
+        end
+        memoize :bic
+      end
+    end # ExtendedData
+  end # Iban
+end # Ibanizator

data/lib/ibanizator/iban/extended_data.rb

@@ -0,0 +1,10 @@
+require_relative 'extended_data/de'
+require_relative 'invalid'
+
+class Ibanizator
+  class Iban
+    module ExtendedData
+
+    end
+  end
+end

data/lib/ibanizator/iban/invalid.rb

@@ -0,0 +1,6 @@
+class Ibanizator
+  class Iban
+    class Invalid < ArgumentError ; end
+  end
+end
+

data/lib/ibanizator/iban/lengths.rb

@@ -0,0 +1,71 @@
+class Ibanizator
+  class Iban
+    # according to wikipedia (http://en.wikipedia.org/wiki/IBAN)
+    LENGTHS = {
+      :AL => 28,
+      :AD => 24,
+      :AT => 20,
+      :AZ => 28,
+      :BH => 22,
+      :BE => 16,
+      :BA => 20,
+      :BR => 29,
+      :BG => 22,
+      :CR => 21,
+      :HR => 21,
+      :CY => 28,
+      :CZ => 24,
+      :DK => 18,
+      :DO => 28,
+      :EE => 20,
+      :FO => 18,
+      :FI => 18,
+      :FR => 27,
+      :GE => 22,
+      :DE => 22,
+      :GI => 23,
+      :GR => 27,
+      :GL => 18,
+      :GT => 28,
+      :HU => 28,
+      :IS => 26,
+      :IE => 22,
+      :IL => 23,
+      :IT => 27,
+      :KZ => 20,
+      :KW => 30,
+      :LV => 21,
+      :LB => 28,
+      :LI => 21,
+      :LT => 20,
+      :LU => 20,
+      :MK => 19,
+      :MT => 31,
+      :MR => 27,
+      :MU => 30,
+      :MC => 27,
+      :MD => 24,
+      :ME => 22,
+      :NL => 18,
+      :NO => 15,
+      :PK => 24,
+      :PS => 29,
+      :PL => 28,
+      :PT => 25,
+      :RO => 24,
+      :SM => 27,
+      :SA => 24,
+      :RS => 22,
+      :SK => 24,
+      :SI => 19,
+      :ES => 24,
+      :SE => 24,
+      :CH => 21,
+      :TN => 24,
+      :TR => 26,
+      :AE => 23,
+      :GB => 22,
+      :VG => 24
+    }.freeze
+  end
+end

data/lib/ibanizator/iban/validator.rb

@@ -0,0 +1,37 @@
+class Ibanizator
+  class Iban
+    class Validator
+      attr_reader :iban
+
+      def initialize(iban)
+        @iban = iban.to_s
+      end
+
+      def validate
+        valid_length? && valid_checksum?
+      end
+
+      private
+      def valid_length?
+        return false if iban.length <= 4 # two digits for the country code and two for the checksum
+        country_code = iban[0..1].upcase.to_sym
+        iban.length == LENGTHS[country_code]
+      end
+
+      def valid_checksum?
+        number_representation = integerize(reorder(iban))
+        number_representation % 97 == 1
+      end
+
+      def reorder(iban)
+        "#{iban[4..-1]}#{iban[0..3]}"
+      end
+
+      def integerize(iban)
+        iban.gsub(/[A-Z]/) do |match|
+          match.ord - 'A'.ord + 10
+        end.to_i
+      end
+    end
+  end # Iban
+end # Ibanizator

data/lib/ibanizator/iban.rb

@@ -0,0 +1,46 @@
+require 'equalizer'
+require 'adamantium'
+
+require_relative 'iban/extended_data'
+require_relative 'iban/lengths'
+require_relative 'iban/validator'
+
+class Ibanizator
+  class Iban
+    attr_reader :iban_string
+    alias_method :to_s, :iban_string
+
+    include Equalizer.new(:iban_string)
+    include Adamantium
+
+    def initialize(an_iban)
+      @iban_string = sanitize(an_iban)
+    end
+
+    def self.from_string(a_string)
+      new(a_string)
+    end
+
+    def country_code
+      cc = iban_string[0..1].to_sym
+      LENGTHS.keys.include?(cc) ? cc : :unknown
+    end
+    memoize :country_code
+
+    def extended_data
+      if country_code == :DE
+        ExtendedData::DE.new(self)
+      end
+    end
+    memoize :extended_data
+
+    def valid?
+      Validator.new(self).validate
+    end
+
+    private
+    def sanitize(input)
+      input.to_s.gsub(/\s+/,'').upcase
+    end
+  end
+end

data/lib/ibanizator.rb

@@ -1,21 +1,27 @@
 require_relative 'iban/validator'
 require_relative 'swift_bic/bank_db'
+
 require_relative 'ibanizator/bank_db'
 require_relative 'ibanizator/bank'
+require_relative 'ibanizator/iban'
 
 class Ibanizator
+
   def self.bank_db
     @bank_db ||= BankDb.new
   end
 
+  def self.iban_from_string(a_string)
+    Iban.from_string(a_string)
+  end
+
   def calculate_iban options
     # Error handling
     # TODO
 
     # delete spaces
-    validator                = Iban::Validator.new
-    options[:account_number] = validator.sanitize_input(options[:account_number])
-    options[:bank_code]      = validator.sanitize_input(options[:bank_code])
+    options[:account_number] = options[:account_number].to_s.gsub(/\s+/, '')
+    options[:bank_code]      = options[:bank_code].to_s.gsub(/\s+/, '')
 
     # Fill account number to 10 digits
     while options[:account_number].size < 10 do
@@ -28,10 +34,11 @@ class Ibanizator
     options[:country_code].to_s.upcase + checksum + options[:bank_code] + options[:account_number]
   end
 
+  # <b>DEPRECATED:</b> Please use <tt>Ibanizator.iban_from_string(an_iban).valid?</tt> instead.
   def validate_iban iban
+    warn "[DEPRECATION] `Ibanizator#validate_iban` is deprecated.  Please use `Ibanizator.iban_from_string(an_iban).valid?instead."
     # for the sake of compatibility
-    validator = Iban::Validator.new
-    validator.validate_iban(iban)
+    self.class.iban_from_string(iban).valid?
   end
 
   # <b>DEPRECATED:</b> Please use <tt>Ibanizator.bank_db.bank_by_bank_code</tt> instead.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ibanizator
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Christoph Stettner
@@ -106,11 +106,16 @@ files:
 - db/blz.txt
 - lib/errors/bank_not_found_error.rb
 - lib/errors/invalid_bank_code_error.rb
-- lib/iban/lengths.rb
 - lib/iban/validator.rb
 - lib/ibanizator.rb
 - lib/ibanizator/bank.rb
 - lib/ibanizator/bank_db.rb
+- lib/ibanizator/iban.rb
+- lib/ibanizator/iban/extended_data.rb
+- lib/ibanizator/iban/extended_data/de.rb
+- lib/ibanizator/iban/invalid.rb
+- lib/ibanizator/iban/lengths.rb
+- lib/ibanizator/iban/validator.rb
 - lib/swift_bic/bank_db.rb
 - license.md
 homepage: https://github.com/softwareinmotion/ibanizator

data/lib/iban/lengths.rb

@@ -1,69 +0,0 @@
-module Iban
-  # according to wikipedia (http://en.wikipedia.org/wiki/IBAN)
-  LENGTHS = {
-    :AL => 28,
-    :AD => 24,
-    :AT => 20,
-    :AZ => 28,
-    :BH => 22,
-    :BE => 16,
-    :BA => 20,
-    :BR => 29,
-    :BG => 22,
-    :CR => 21,
-    :HR => 21,
-    :CY => 28,
-    :CZ => 24,
-    :DK => 18,
-    :DO => 28,
-    :EE => 20,
-    :FO => 18,
-    :FI => 18,
-    :FR => 27,
-    :GE => 22,
-    :DE => 22,
-    :GI => 23,
-    :GR => 27,
-    :GL => 18,
-    :GT => 28,
-    :HU => 28,
-    :IS => 26,
-    :IE => 22,
-    :IL => 23,
-    :IT => 27,
-    :KZ => 20,
-    :KW => 30,
-    :LV => 21,
-    :LB => 28,
-    :LI => 21,
-    :LT => 20,
-    :LU => 20,
-    :MK => 19,
-    :MT => 31,
-    :MR => 27,
-    :MU => 30,
-    :MC => 27,
-    :MD => 24,
-    :ME => 22,
-    :NL => 18,
-    :NO => 15,
-    :PK => 24,
-    :PS => 29,
-    :PL => 28,
-    :PT => 25,
-    :RO => 24,
-    :SM => 27,
-    :SA => 24,
-    :RS => 22,
-    :SK => 24,
-    :SI => 19,
-    :ES => 24,
-    :SE => 24,
-    :CH => 21,
-    :TN => 24,
-    :TR => 26,
-    :AE => 23,
-    :GB => 22,
-    :VG => 24
-  }.freeze
-end