ibandit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 36930d16f5443cccf34293a0cb6014b8dc33c337
+  data.tar.gz: e8201ef2d1053ed3293ac3d620e0cd494e1f66a6
+SHA512:
+  metadata.gz: 98a90bb5ed4f7b50bf82abed4709bf919d7fad46f7695dc40e317d16c102aef3b097ef928806b0d3393a07e4d2701981727cf2c77b90427b41f485e449d5f437
+  data.tar.gz: 7c02243b084a98aac05bd911bf527667b47cf98a362795fb6f7214018f563ce8ad3726f623201a34c3e6cd883b697c8531a3c08632b7f505446b908066a55a18

data/.gitignore

@@ -0,0 +1,4 @@
+Gemfile.lock
+.bundle
+*.gem
+.DS_Store

data/.rubocop.yml

@@ -0,0 +1,43 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  Include:
+    - config.ru
+    - Rakefile
+  Exclude:
+    - .*/**/*
+
+# Limit lines to 80 characters.
+LineLength:
+  Max: 80
+
+ClassLength:
+  Max: 150
+
+# Avoid single-line methods.
+SingleLineMethods:
+  AllowIfMethodIsEmpty: true
+
+# Wants underscores in all large numbers. Pain in the ass for things like
+# unix timestamps.
+NumericLiterals:
+  Enabled: false
+
+# Wants you to use the same argument names for every reduce. This seems kinda
+# naff compared to naming them semantically
+SingleLineBlockParams:
+  Enabled: false
+
+Style/SignalException:
+  EnforcedStyle: 'only_raise'
+
+# Wants to exclude accents from comments
+Style/AsciiComments:
+  Enabled: false
+
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 25
+
+Style/DotPosition:
+  EnforcedStyle: 'trailing'

data/.rubocop_todo.yml

@@ -0,0 +1,23 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2014-12-08 13:56:37 +0000 using RuboCop version 0.27.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 4
+Metrics/AbcSize:
+  Max: 28
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 110
+
+# Offense count: 1
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+# Offense count: 4
+Style/Documentation:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,48 @@
+## 0.1.0 - December 29, 2014
+
+- Initial public release
+
+## 0.0.16 - December 29, 2014
+
+- Fix error handling in Modulus 97-10 check digit calculation
+
+## 0.0.15 - December 26, 2014
+
+- Raise namespaced errors
+
+## 0.0.14 - December 17, 2014
+
+- Add the Netherlands to IBANBuilder, and rename CheckDigit.mod_11
+
+## 0.0.13 - December 17, 2014
+
+- Send cleaned (de-space/hyphenated) sort codes to the BIC finder lambda
+
+## 0.0.12 - December 16, 2014
+
+- Allow spaced as well as hyphenated UK sort codes
+
+## 0.0.11 - December 15, 2014
+
+- `IBAN#to_s` returns IBAN string rather than object properties
+- Local check digits accessors
+- Only raises `ArgumentError`
+- Additional documentation on local details/IBAN conversion quirks
+
+## 0.0.10 - December 13, 2014
+
+- Update format validations for all IBAN countries. Add local_check_digits
+  accessor method to IBAN.
+
+## 0.0.5 - December 8, 2014
+
+- Add IBANSTRUCTURE file. All IBAN countries are now supported for validation
+  and deconstruction.
+
+## 0.0.2 - December 4, 2014
+
+- Rename to ibandit
+
+## 0.0.1 - November 27, 2014
+
+- Initial commit

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 GoCardless
+
+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.

data/README.md

@@ -0,0 +1,303 @@
+# Ibandit
+
+Ibandit is a Ruby library for manipulating and validating
+[IBANs](http://en.wikipedia.org/wiki/International_Bank_Account_Number). It
+allows you to:
+
+1. Create an IBAN from national banking details
+2. Deconstruct an IBAN into national banking details
+3. Validate an IBAN's check digits and structure
+
+Ibandit also provides helper methods for validating some countries' local
+account details.
+
+The gem is kept up to date using the IBAN structure file from SWIFT.
+
+## Usage
+
+### Installation
+
+You don't need this source code unless you want to modify the gem. If you just
+want to use it, you should run:
+
+```ruby
+gem install ibandit
+```
+
+### Creating IBANs
+
+All functionality is based around `IBAN` objects. To create one, simply pass a
+string to `Ibandit::IBAN.new`. Note that you don't need to worry about case and
+whitespace:
+
+```ruby
+iban = Ibandit::IBAN.new("xq75 B a dCode 666")
+iban.to_s                      # => "XQ75BADCODE666"
+iban.to_s(:formatted)          # => "XQ75 BADC ODE6 66"
+```
+
+### Validating an IBAN
+
+IBANs are validated based on their structure and check-digits:
+
+```ruby
+iban = Ibandit::IBAN.new("XQ75 BADCODE 666")
+
+iban.valid?                    # => false
+```
+
+After validations, you can fetch details of any errors:
+
+```ruby
+iban.errors                    # => { country_code: "'XQ' is not a valid..." }
+```
+
+The following error keys may be set:
+- `country_code`
+- `check_digits`
+- `characters`
+- `length`
+- `format`
+
+### Deconstructing an IBAN into national banking details
+
+SWIFT define the following components for IBANs, and publish details of how each
+county combines them:
+
+`country_code`
+:    The [ISO 3166-1](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) country code prefix
+
+`check_digits`
+:    Two digits calculated using part of the ISO/IEC 7064:2003 standard
+
+`bank_code`
+:    The SWIFT identifier for the bank to which the IBAN refers
+
+`branch_code`
+:    The SWIFT identifer for the branch to which the IBAN refers (not used in all countries)
+
+`account_number`
+:    The account number for the account
+
+`iban_national_id`
+:    The national ID for the bank / branch as documented by SWIFT
+
+The SWIFT IBAN components are all available as methods on an `IBAN` object:
+
+```ruby
+iban = Ibandit::IBAN.new("GB82 WEST 1234 5698 7654 32")
+
+iban.country_code              # => "GB"
+iban.check_digits              # => "82"
+iban.bank_code                 # => "WEST"
+iban.branch_code               # => "123456"
+iban.account_number            # => "98765432"
+iban.iban_national_id          # => "WEST123456"
+```
+
+In addition, it is often useful to extract any local check digits from the IBAN.
+These are available through a `local_check_digits` method:
+
+```ruby
+iban = Ibandit::IBAN.new("ES12 1234 5678 9112 3456 7890")
+
+iban.local_check_digits        # => "91"
+```
+
+### Initializing Ibandit
+
+The UK and Ireland both use part of the BIC as the `bank_code` in their IBANs.
+If you wish to construct UK or Irish IBANs you will either need to pass the
+`bank_code` explicitly, or configure Ibandit with a BIC finder:
+
+```ruby
+# config/initializers/ibandit.rb
+Ibandit.bic_finder = -> (country_code, national_id) do
+  # This assumes you have `BankDirectoryPlus` set up to access the data provided
+  # by SWIFTRef in their Bank Directory Plus product. The `national_id` is the
+  # local national ID, not the "IBAN National ID" referred to in the IBAN Plus
+  # file (since that is the `bank_code` and the `branch_code`).
+ BankDirectoryPlus.find_by(country_code: country_code,
+                           national_id: national_id).
+                   try(:bic)
+end
+```
+
+### Creating an IBAN from national banking details
+
+In many countries customers are familiar with national details rather than
+their IBAN. For example, in the UK customers use their Account Number and Sort
+Code.
+
+To build an IBAN from local details:
+
+```ruby
+# Austria
+iban = Ibandit::IBANBuilder.build(
+  country_code: 'AT',
+  account_number: '234573201',
+  bank_code: '19043'
+)
+iban.iban                     # => "AT611904300234573201"
+
+# Belgium
+iban = Ibandit::IBANBuilder.build(
+  country_code: 'BE',
+  account_number: '510-0075470-61'
+)
+iban.iban                     # => "BE62510007547061"
+
+# Cyprus
+iban = Ibandit::IBANBuilder.build(
+  country_code: 'CY',
+  account_number: '1200527600',
+  bank_code: '002',
+  branch_code: '00128'
+)
+iban.iban                     # => "CY17002001280000001200527600"
+
+# Germany
+iban = Ibandit::IBANBuilder.build(
+  country_code: 'DE',
+  bank_code: '37040044',
+  account_number: '0532013000'
+)
+iban.iban                     # => "DE89370400440532013000"
+
+# Estonia
+iban = Ibandit::IBANBuilder.build(
+  country_code: 'EE',
+  account_number: '111020145685'
+)
+iban.iban                     # => "EE412200111020145685"
+
+# Finland
+iban = Ibandit::IBANBuilder.build(
+  country_code: 'FI',
+  bank_code: '123456'
+  account_number: '785'
+)
+iban.iban                     # => "FI2112345600000785"
+
+# France
+iban = Ibandit::IBANBuilder.build(
+  country_code: 'FR',
+  bank_code: '20041',
+  branch_code: '01005',
+  account_number: '0500013M02606',
+)
+iban.iban                     # => "FR1420041010050500013M02606"
+
+# United Kingdom
+iban = Ibandit::IBANBuilder.build(
+  country_code: 'GB',
+  bank_code: 'BARC', # optional if a BIC finder is configured
+  branch_code: '200000',
+  account_number: '55779911'
+)
+iban.iban                     # => "GB60BARC20000055779911"
+
+# Ireland
+iban = Ibandit::IBANBuilder.build(
+  country_code: 'IE',
+  bank_code: 'AIBK', # optional if a BIC finder is configured
+  branch_code: '931152',
+  account_number: '12345678'
+)
+iban.iban                     # => "IE29AIBK93115212345678"
+
+# Italy
+iban = Ibandit::IBANBuilder.build(
+  country_code: 'IT',
+  bank_code: '05428',
+  branch_code: '11101',
+  account_number: '000000123456'
+)
+iban.iban                     # => "IT60X0542811101000000123456"
+
+# Latvia
+iban = Ibandit::IBANBuilder.build(
+  country_code: 'LV',
+  account_number: '1234567890123',
+  bank_code: 'BANK'
+)
+iban.iban                     # => "LV72BANK1234567890123"
+
+# Luxembourg
+iban = Ibandit::IBANBuilder.build(
+  country_code: 'LU',
+  account_number: '1234567890123',
+  bank_code: 'BANK'
+)
+iban.iban                     # => "LU75BANK1234567890123"
+
+# Monaco
+iban = Ibandit::IBANBuilder.build(
+  country_code: 'MC',
+  bank_code: '20041',
+  branch_code: '01005',
+  account_number: '0500013M026'
+)
+iban.iban                     # => "MC9320041010050500013M02606"
+
+# The Netherlands
+iban = Ibandit::IBANBuilder.build(
+  country_code: 'NL',
+  account_number: '0417164300',
+  bank_code: 'ABNA'
+)
+iban.iban                     # => "NL91ABNA0417164300"
+
+# Portugal
+iban = Ibandit::IBANBuilder.build(
+  country_code: 'PT',
+  bank_code: '0002',
+  branch_code: '0023',
+  account_number: '0023843000578'
+)
+iban.iban                     # => "PT50000200230023843000578"
+
+# Slovakia
+iban = Ibandit::IBANBuilder.build(
+  country_code: 'SK',
+  bank_code: '1200',
+  account_number_prefix: '19',
+  account_number: '8742637541'
+)
+iban.iban                     # => "SK3112000000198742637541"
+
+# Slovenia
+iban = Ibandit::IBANBuilder.build(
+  country_code: 'SI',
+  bank_code: '19100',
+  account_number: '1234'
+)
+iban.iban                     # => "SI56191000000123438"
+
+# Spain
+iban = Ibandit::IBANBuilder.build(
+  country_code: 'ES',
+  bank_code: '2310',
+  branch_code: '0001',
+  account_number: '180000012345'
+)
+iban.iban                     # => "ES8023100001180000012345"
+
+# Spain with 20 digit account number
+iban = Ibandit::IBANBuilder.build(
+  country_code: 'ES',
+  account_number: '23100001180000012345'
+)
+iban.iban                     # => "ES8023100001180000012345"
+
+# San Marino
+iban = Ibandit::IBANBuilder.build(
+  country_code: 'SM',
+  bank_code: '05428',
+  branch_code: '11101',
+  account_number: '000000123456'
+)
+iban.iban                     # => "SM88X0542811101000000123456"
+```
+
+Support for Greece and Malta is coming soon.