dkd-ibanizator 0.9.0

data/lib/errors/bank_not_found_error.rb

@@ -0,0 +1,2 @@
+class BankNotFoundError < StandardError
+end

data/lib/errors/invalid_bank_code_error.rb

@@ -0,0 +1,2 @@
+class InvalidBankCodeError < StandardError
+end

data/lib/ibanizator/bank.rb

@@ -0,0 +1,17 @@
+require 'equalizer'
+require 'adamantium'
+
+class Ibanizator
+  class Bank
+    include Equalizer.new(:bic, :name, :bank_code)
+    include Adamantium
+
+    attr_reader :bic, :name, :bank_code
+
+    def initialize(bic, name, bank_code)
+      @bic = bic
+      @name = name
+      @bank_code = bank_code
+    end
+  end
+end

data/lib/ibanizator/bank_db.rb

@@ -0,0 +1,48 @@
+class Ibanizator
+  class BankDb
+    class BankNotFoundError < StandardError; end
+
+    attr_reader :known_banks
+
+    def initialize
+      @known_banks = []
+      @bic_index = {}
+      @bank_code_index = {}
+      populate_known_banks!
+    end
+
+    def bank_by_bic(a_bic)
+      @bic_index.fetch(a_bic.to_s) do
+        error! "No such bank for BIC `#{a_bic}` found!"
+      end
+    end
+
+    def bank_by_bank_code(a_bank_code)
+      @bank_code_index.fetch(sanitize_bank_code(a_bank_code)) do
+        error! "No bank for bank code `#{a_bank_code}` found!"
+      end
+    end
+
+    private
+
+    def populate_known_banks! # rubocop:disable Metrics/AbcSize
+      File.open(File.expand_path('../../../db/blz.txt', __FILE__), 'r').each_line do |line|
+        code, _, _, _, _, name, _, bic = line.unpack 'A8A1A58A5A35A27A5A11'
+        next if bic.empty?
+        name.force_encoding('iso-8859-1').encode!('utf-8')
+        bank = Bank.new(bic, name, code)
+        @known_banks << bank
+        @bic_index[bank.bic] = bank
+        @bank_code_index[bank.bank_code] = bank
+      end
+    end
+
+    def sanitize_bank_code(a_bank_code)
+      a_bank_code.to_s.gsub(/\s+/, '')
+    end
+
+    def error!(message)
+      raise BankNotFoundError, message
+    end
+  end
+end

data/lib/ibanizator/iban/country_codes.rb

@@ -0,0 +1,71 @@
+class Ibanizator
+  class Iban
+    # according to wikipedia (http://en.wikipedia.org/wiki/IBAN)
+    COUNTRY_CODES = {
+      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/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,9 @@
+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,5 @@
+class Ibanizator
+  class Iban
+    class Invalid < ArgumentError; end
+  end
+end

data/lib/ibanizator/iban/validator.rb

@@ -0,0 +1,36 @@
+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 == COUNTRY_CODES[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]/) { |match| match.ord - 'A'.ord + 10 }.to_i
+      end
+    end
+  end # Iban
+end # Ibanizator

data/lib/ibanizator/iban.rb

@@ -0,0 +1,45 @@
+require 'equalizer'
+require 'adamantium'
+
+require_relative 'iban/extended_data'
+require_relative 'iban/country_codes'
+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
+      COUNTRY_CODES.keys.include?(cc) ? cc : :unknown
+    end
+    memoize :country_code
+
+    def extended_data
+      ExtendedData::DE.new(self) if country_code == :DE
+    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

@@ -0,0 +1,43 @@
+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) # rubocop:disable Metrics/AbcSize
+    # Error handling
+    # TODO
+
+    # delete spaces
+    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
+      options[:account_number] = options[:account_number].rjust(10, '0')
+    end
+
+    country_code_num = character_to_digit options[:country_code].to_s
+    checksum = calculate_checksum options[:bank_code], options[:account_number], country_code_num
+
+    options[:country_code].to_s.upcase + checksum + options[:bank_code] + options[:account_number]
+  end
+
+  def character_to_digit(char)
+    char.upcase.split('').inject('') { |code, c| code + (c.ord - 55).to_s }
+  end
+
+  def calculate_checksum(bank_code, account_number, country_code_num)
+    x = (bank_code + account_number + country_code_num + '00').to_i % 97
+    checksum = (98 - x).to_s
+    checksum.length == 1 ? checksum.insert(0, '0') : checksum
+  end
+end

data/lib/swift_bic/bank_db.rb

@@ -0,0 +1,20 @@
+require_relative '../errors/invalid_bank_code_error'
+require_relative '../errors/bank_not_found_error'
+
+module SwiftBic
+  class BankDb
+    BANKS = {}.tap do |banks|
+      File.open(File.expand_path('../../../db/blz.txt', __FILE__), 'r').each_line do |line|
+        code, _, _, _, _, name, _, bic = line.unpack 'A8A1A58A5A35A27A5A11'
+        next if bic.empty?
+        name.force_encoding('iso-8859-1').encode!('utf-8')
+        banks[code] = { name: name, bic: bic }
+      end
+    end
+
+    def validate_bank_code(bank_code)
+      return true if bank_code.length == 8
+      raise InvalidBankCodeError
+    end
+  end
+end

data/license.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 dkd Internet Service GmbH
+
+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.

metadata

@@ -0,0 +1,214 @@
+--- !ruby/object:Gem::Specification
+name: dkd-ibanizator
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Nicolai Reuschling
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: equalizer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.11
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.11
+- !ruby/object:Gem::Dependency
+  name: adamantium
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.14.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.14.6
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.47.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.47.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.13.0
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.3
+- !ruby/object:Gem::Dependency
+  name: guard-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: terminal-notifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.1
+- !ruby/object:Gem::Dependency
+  name: terminal-notifier-guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+description: " dkd-ibanizator generates the correct IBAN for a given account number
+  and bank number for German bank accounts. It is possible to validate given IBAN
+  codes. Calculates also the BIC and bank names for given German bank codes. "
+email: nicolai.reuschling@dkd.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- db/blz.txt
+- lib/errors/bank_not_found_error.rb
+- lib/errors/invalid_bank_code_error.rb
+- lib/ibanizator.rb
+- lib/ibanizator/bank.rb
+- lib/ibanizator/bank_db.rb
+- lib/ibanizator/iban.rb
+- lib/ibanizator/iban/country_codes.rb
+- lib/ibanizator/iban/extended_data.rb
+- lib/ibanizator/iban/extended_data/de.rb
+- lib/ibanizator/iban/invalid.rb
+- lib/ibanizator/iban/validator.rb
+- lib/swift_bic/bank_db.rb
+- license.md
+homepage: https://github.com/dkd/dkd-ibanizator
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: An IBAN generator/validator and BIC generator for German bank accounts.
+test_files: []