ibanizator 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6e4b864df215e01fb6c4a916515668d937a1ae2d
-  data.tar.gz: 7d810309a577814be7dd3691f524d5c704750aed
+  metadata.gz: 20719f6ac56b0b536446948da0e98540c02fb106
+  data.tar.gz: e18a2a4e3ab59f8c95a0e32f381edd2bf9b708d0
 SHA512:
-  metadata.gz: ae4beb1d02495c730169a6b89228ce9020c41b7a1ccb86c42e521f13b1743d189a401a17eca0441f13a7bd8eb6c919c4211998c94ecf13a746922f3eed7f9874
-  data.tar.gz: dcaa2f5eb9bf645e9ccabf900fb6386f0cd2ed291974c861025f1515c209c24c711e6709bcd05e753a13be3e59d7bdcadf9f5c304cab7e25b897be6dc87f5cf3
+  metadata.gz: 66bf35e9cd503100af54b91d16fd6fbca0bc8ae9307ffa2c872dc3c5ceb829d2e7169c33b0da6eac89cd36a8505a63a2c18f2e149d68f7688982d830e1f5539f
+  data.tar.gz: 437677f6b0c14417c0a316a36d48e39195b437f5c51b68f13e311bbfe61c8f2645a1ec6c85a527cf04bbcbaa3661cf6efe6776b4526ead057866c879e78354ab

data/README.md

@@ -0,0 +1,71 @@
+# ibanizator [![Build Status](https://travis-ci.org/softwareinmotion/ibanizator.svg?branch=master)](https://travis-ci.org/softwareinmotion/ibanizator)
+
+ibanizator calculates the iban for german accounts. The database that is used to convert a bank number to a
+BIC is taken from [Deutsche Bundesbank](http://www.bundesbank.de/Redaktion/EN/Standardartikel/Tasks/Payment_systems/bank_sort_codes_download.html).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ibanizator'
+
+## Usage
+
+### Calculate IBAN
+
+To calculate the iban for some german accounts, just use this method:
+
+    ibanizator = Ibanizator.new
+    ibanizator.calculate_iban country_code: :de, bank_code: '12345678', account_number: '123456789'
+
+In the current version the ibanizator gem only works for german accounts.
+
+### Validate 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.
+
+    validator = Iban::Validator.new
+    valid = validator.validate_iban("DE68 2105 0170 0012 3456 78") # => true
+
+There is an alternate way to validate an IBAN as a result of the 0.0.1 Version:
+
+    ibanizator.validate_iban("DE68 2105 0170 0012 3456 78") # => true
+
+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.
+
+### Find bank infos
+
+If you need to get a bank name, bank code or a bic from a german bank and you
+have either a BIC or a bank code there is a bank db.
+
+```ruby
+# find a bank by BIC
+bank_1 = Ibanizator.bank_db.bank_by_bic('MARKDEF1100')
+bank_1.name       # => 'BBk Berlin'
+bank_1.bic        # => 'MARKDEF1100'
+bank_1.bank_code  # => '10000000'
+
+# find a bank by bank_code (de: Bankleitzahl)
+bank_2 = Ibanizator.bank_db.bank_bybank_code('100 000 00')
+bank_2.name       # => 'BBk Berlin'
+bank_2.bic        # => 'MARKDEF1100'
+bank_2.bank_code  # => '10000000'
+
+bank_3 = Ibanizator.bank_db.bank_bybank_code('10000000')
+bank_3.name       # => 'BBk Berlin'
+bank_3.bic        # => 'MARKDEF1100'
+bank_3.bank_code  # => '10000000'
+
+bank_1 == bank_2  # => true
+bank_2 == bank_3  # => true
+
+bank_4 = Ibanizator.bank_db.bank_by_bic('OASPDE6AXXX')
+bank_4 == bank_2  # => false
+```
+
+## Licence
+
+The code is availiable under the MIT-Licence

data/lib/ibanizator/bank.rb

@@ -0,0 +1,15 @@
+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, @name, @bank_code = bic, name, bank_code
+    end
+  end
+end

data/lib/ibanizator/bank_db.rb

@@ -0,0 +1,44 @@
+class Ibanizator
+  class BankDb
+    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 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!
+      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/license.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 softwareinmotion 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

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ibanizator
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Christoph Stettner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-27 00:00:00.000000000 Z
+date: 2014-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: equalizer
@@ -94,21 +94,23 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 4.2.10
-description: ibanizator generates the correct IBAN for given account number and bank
-  number for german accounts. It is possible to validate given international IBANS.
-  Calculates also the BIC and bank names for given german bank codes.
+description: "                           \n         .                .\n                           .\n"
 email: christoph.stettner@softwareinmotion.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/iban/lengths.rb
 - lib/iban/validator.rb
 - lib/ibanizator.rb
+- lib/ibanizator/bank.rb
+- lib/ibanizator/bank_db.rb
 - lib/swift_bic/bank_db.rb
+- license.md
 homepage: https://github.com/softwareinmotion/ibanizator
 licenses:
 - MIT