dkd-ibanizator 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9174054e7bb5ce346dfc60614f84990aac53251a
+  data.tar.gz: ccb61c49d93be5787147270fe8006d3cbbe6b802
+SHA512:
+  metadata.gz: 822eeeb600c9665be306c5fb9088cd44176a5e60505ddca12de347fbaee4d733e3f2ebab33f017d5096cd93fc7f1f3b67dae95de961c71c7a41d774c5f7e403a
+  data.tar.gz: eb151e5a65cc2b445b419bdf0adb4689a5493b3d4b2a03c8d3beb188d8ef8da7dee21f5cc97abafcc68937178276dad1ea260e866978e07987b05e65774152f9

data/README.md

@@ -0,0 +1,88 @@
+# dkd-ibanizator [![Build Status](https://travis-ci.org/dkd/dkd-ibanizator.svg?branch=master)](https://travis-ci.org/dkd/dkd-ibanizator) [![Gem Version](https://badge.fury.io/rb/dkd-ibanizator.svg)](https://badge.fury.io/rb/dkdeploy-core)
+
+dkd-ibanizator calculates the IBAN for German bank 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:
+
+```ruby
+    gem 'dkd-ibanizator'
+```
+
+## Usage
+
+### Calculate IBAN
+
+Load dkd-ibanizator:
+
+```ruby
+    require 'ibanizator'
+```
+
+To calculate the IBAN for some German bank accounts, just use this method:
+
+```ruby
+    ibanizator = Ibanizator.new
+    ibanizator.calculate_iban country_code: :de, bank_code: '12345678', account_number: '123456789'
+```
+
+Note: In the current version the dkd-ibanizator gem only works for German bank accounts.
+
+### 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 Ibanizator::Iban::COUNTRY_CODES hash are supported at the moment.
+
+```ruby
+    iban = Ibanizator.iban_from_string("DE68 2105 0170 0012 3456 78")
+    iban.valid? # => true
+```
+
+### Information provided by an IBAN
+
+The Ibanizator::Iban class provides some handy utility methods to query information about an iban.
+
+```ruby
+    iban = Ibanizator.iban_from_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
+
+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_by_bank_code('100 000 00')
+    bank_2.name       # => 'BBk Berlin'
+    bank_2.bic        # => 'MARKDEF1100'
+    bank_2.bank_code  # => '10000000'
+
+    bank_3 = Ibanizator.bank_db.bank_by_bank_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 based on the GitHub project [softwareinmotion/ibanizator](https://github.com/softwareinmotion/ibanizator) and availiable under the MIT licence.