bank_account_tools 1.0.0

data/lib/bank_account_tools/iban.rb

@@ -0,0 +1,47 @@
+require 'forwardable'
+require 'bank_account_tools/bban'
+require 'bank_account_tools/validators/iban_validator' if defined? ActiveModel
+
+module BankAccountTools
+  class IBAN # International Bank Account Number
+    extend Forwardable
+    def_delegators :bban,
+      :account_number, :bank_identifier, :branch_identifier, :country_applies_iban?
+
+    def self.valid?(code)
+      new(code).valid?
+    end
+
+    def initialize(code)
+      @code = code.to_s.gsub(/\s+/, '').upcase
+    end
+
+    def country_code
+      @code[0..1]
+    end
+
+    def check_digits
+      @code[2..3]
+    end
+
+    def bban
+      @bban ||= BBAN.new(country_code, @code[4..-1])
+    end
+
+    def valid?
+      valid_check_digits? && bban.valid?
+    end
+
+    def valid_check_digits?
+      to_i % 97 == 1
+    end
+
+    def to_i
+      "#{bban}#{country_code}#{check_digits}".each_char.map { |chr| chr.to_i(36) }.join.to_i
+    end
+
+    def to_s(formatted=false)
+      formatted ? @code.gsub(/(.{4})/, '\1 ').strip : @code
+    end
+  end
+end

data/lib/bank_account_tools/matchers/active_model/have_valid_bic.rb

@@ -0,0 +1,9 @@
+RSpec::Matchers.define :have_valid_bic do |attribute|
+  match do
+    actual_class_name = subject.is_a?(Class) ? subject : subject.class
+    actual = actual_class_name.new
+    
+    expect(actual).to be_invalid
+    expect(actual.errors[attribute.to_sym]).to include('is of invalid format')
+  end
+end

data/lib/bank_account_tools/matchers/active_model/have_valid_iban.rb

@@ -0,0 +1,9 @@
+RSpec::Matchers.define :have_valid_iban do |attribute|
+  match do
+    actual_class_name = subject.is_a?(Class) ? subject : subject.class
+    actual = actual_class_name.new
+    
+    expect(actual).to be_invalid
+    expect(actual.errors[attribute.to_sym]).to include('is of invalid format')
+  end
+end

data/lib/bank_account_tools/matchers/rspec.rb

@@ -0,0 +1,2 @@
+require_relative 'active_model/have_valid_iban'
+require_relative 'active_model/have_valid_bic'

data/lib/bank_account_tools/validators/bic_validator.rb

@@ -0,0 +1,7 @@
+require 'active_model/validator'
+
+class BicValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    record.errors.add(attribute, :invalid) unless BankAccountTools::BIC.valid?(value)
+  end
+end

data/lib/bank_account_tools/validators/iban_validator.rb

@@ -0,0 +1,7 @@
+require 'active_model/validator'
+
+class IbanValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    record.errors.add(attribute, :invalid) unless BankAccountTools::IBAN.valid?(value)
+  end
+end

data/lib/bank_account_tools/version.rb

@@ -0,0 +1,3 @@
+module BankAccountTools
+  VERSION = '1.0.0'
+end

data/lib/bank_account_tools.rb

@@ -0,0 +1,19 @@
+require 'bank_account_tools/version'
+require 'bank_account_tools/iban'
+require 'bank_account_tools/bic'
+require 'bank_account_tools/bban'
+require 'bank_account_tools/contact'
+
+require 'pathname'
+require 'yaml'
+
+if defined?(::ActiveModel)
+  require 'bank_account_tools/validators/bic_validator'
+  require 'bank_account_tools/validators/iban_validator'
+end
+
+module BankAccountTools
+  def self.load_specifications(name)
+    YAML.load_file Pathname.new(__FILE__).dirname.parent + 'data' + "#{name}.yml"
+  end
+end

data/spec/activemodel_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+class BankAccount
+  include ActiveModel::Model
+
+  attr_accessor :iban_required, :iban_optional
+
+  validates :iban_required, iban: true
+  validates :iban_optional, iban: true, allow_nil: true
+end
+
+describe IbanValidator do
+  let(:model) { BankAccount.new }
+
+  it 'is valid' do
+    model.iban_required = 'FR1420041010050500013M02606'
+
+    expect(model).to be_valid
+  end
+
+  it 'is not valid' do
+    model.iban_required = 'FR1420041010050500013'
+
+    expect(model).to be_invalid
+    expect(model.errors[:iban_required]).to include('is invalid')
+  end
+
+  it 'does not validate with nil value' do
+    model.iban_required = 'FR1420041010050500013M02606'
+    model.iban_optional = nil
+
+    expect(model).to be_valid
+  end
+end

data/spec/bic_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe BankAccountTools::BIC do
+  let(:bic) { described_class.new('ABNACHZ8XXX')}
+
+  it 'returns the right bank code' do
+    expect(bic.bank_code).to eq('ABNA')
+  end
+
+  it 'returns the right country code' do
+    expect(bic.country_code).to eq('CH')
+  end
+
+  it 'returns the right location code' do
+    expect(bic.location_code).to eq('Z8')
+  end
+
+  it 'returns the right branch code' do
+    expect(bic.branch_code).to eq('XXX')
+  end
+
+  [
+    'UCJAES2MXXX',
+    'ABAGATWWXXX',
+    'UCJAES2MXXX'
+  ].each do |code|
+    describe code do
+      it 'has a valid format' do
+        expect(BankAccountTools::BIC.new(code)).to be_valid
+      end
+    end
+  end
+
+  [
+    '12341234',    # only digits
+    'UCJAES2MXAA', # branch code starts with 'X'
+    'UCJAES2MAA',  # too short
+    'UCJAES2M0001' # too long
+  ].each do |code|
+    describe code do
+      it 'has an invalid format' do
+        expect(BankAccountTools::BIC.new(code)).not_to be_valid
+      end
+    end
+  end
+
+end

data/spec/contact_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe BankAccountTools::Contact do
+  let(:iban) { BankAccountTools::IBAN.new('FR14 2004 1010 0505 0001 3M026 06') }
+  let(:bic) { BankAccountTools::BIC.new('BYLADEM1203') }
+  let(:contact) { BankAccountTools::Contact.new(iban, bic) }
+
+  it 'is validate' do
+    expect(contact).to be_valid
+  end
+
+  it 'has the right types' do
+    expect(contact.iban).to be_kind_of(BankAccountTools::IBAN)
+    expect(contact.bic).to be_kind_of(BankAccountTools::BIC)
+  end
+
+  it 'exports to_h' do
+    expect(contact.to_h).to eq(
+      iban: 'FR1420041010050500013M02606',
+      bic: 'BYLADEM1203'
+    )
+  end
+
+  it 'exports to_a' do
+    expect(contact.to_a).to eq(['FR1420041010050500013M02606', 'BYLADEM1203'])
+  end
+end

data/spec/iban_spec.rb

@@ -0,0 +1,160 @@
+require 'spec_helper'
+
+describe BankAccountTools::IBAN do
+  let(:iban) { BankAccountTools::IBAN.new('FR14 2004 1010 0505 0001 3M026 06') }
+
+  it 'is valid from class method' do
+    expect(BankAccountTools::IBAN.valid?('FR14 2004 1010 0505 0001 3M026 06')).to be_truthy
+  end
+
+  it 'loads the validation rules' do
+    expect(BankAccountTools.load_specifications(:iban)).to be_present
+    expect(BankAccountTools.load_specifications(:iban)).to be_kind_of(Hash)
+  end
+
+  it 'should return the county code' do
+    expect(iban.country_code).to eq('FR')
+  end
+
+  it 'should return the check digits' do
+    expect(iban.check_digits).to eq('14')
+  end
+
+  it 'should return the BBAN' do
+    expect(iban.bban).to be_a(BankAccountTools::BBAN)
+    expect(iban.bban.to_s).to eq('20041010050500013M02606')
+  end
+
+  it 'should convert to integer value' do
+    expect(iban.to_i).to eq(200410100505000132202606152714)
+  end
+
+  it 'should convert to string' do
+    expect(iban.to_s).to eq('FR1420041010050500013M02606')
+  end
+
+  it 'should convert to formatted string' do
+    expect(iban.to_s(true)).to eq('FR14 2004 1010 0505 0001 3M02 606')
+  end
+
+  it 'respond_to? account_number' do
+    expect(iban.respond_to?(:account_number)).to be_truthy
+  end
+
+  it 'returns account_number' do
+    expect(iban.account_number).to eq('0500013M026')
+  end
+
+  it 'returns bank_identifier' do
+    expect(iban.bank_identifier).to eq('20041')
+  end
+
+  it 'returns branch_identifier' do
+    expect(iban.branch_identifier).to eq('01005')
+  end
+
+  it 'knows which countries use IBAN' do
+    expect(iban.country_applies_iban?).to be_truthy
+
+    expect(BankAccountTools::IBAN.new('ZZ99 123456790').country_applies_iban?).to be_falsey
+  end
+
+  [
+    'AL47212110090000000235698741',
+    'AD12 00012030200359100100',
+    'AT611904300234573201',
+    'BE68539007547034',
+    'BA391290079401028494',
+    'BG80BNBG96611020345678',
+    'HR1210010051863000160',
+    'CY17002001280000001200527600',
+    'CZ6508000000192000145399',
+    'DK5000400440116243',
+    'EE382200221020145685',
+    'FO1464600009692713',
+    'FI2112345600000785',
+    'FR1420041010050500013M02606',
+    'GE29NB0000000101904917',
+    'DE89370400440532013000',
+    'GI75NWBK000000007099453',
+    'GR1601101250000000012300695',
+    'GL8964710001000206',
+    'HU42117730161111101800000000',
+    'IS140159260076545510730339',
+    'IE29AIBK93115212345678',
+    'IT60X0542811101000000123456',
+    'LV80BANK0000435195001',
+    'LI21088100002324013AA',
+    'LT121000011101001000',
+    'LU280019400644750000',
+    'MK07300000000042425',
+    'MT84MALT011000012345MTLCAST001S',
+    'MD24AG000225100013104168',
+    'MC5813488000010051108001292',
+    'ME25505000012345678951',
+    'NL91ABNA0417164300',
+    'NO9386011117947',
+    'PL27114020040000300201355387',
+    'PT50000201231234567890154',
+    'RO49AAAA1B31007593840000',
+    'SM86U0322509800000000270100',
+    'RS35260005601001611379',
+    'SK3112000000198742637541',
+    'SI56191000000123438',
+    'ES9121000418450200051332',
+    'SE3550000000054910000003',
+    'CH9300762011623852957',
+    'UA573543470006762462054925026',
+    'GB29NWBK60161331926819',
+    'DZ4000400174401001050486',
+    'AO06000600000100037131174',
+    'AZ21NABZ00000000137010001944',
+    'BH29BMAG1299123456BH00',
+    'BJ11B00610100400271101192591',
+    'BR9700360305000010009795493P1',
+    'VG96VPVG0000012345678901',
+    'BF1030134020015400945000643',
+    'BI43201011067444',
+    'CM2110003001000500000605306',
+    'CV64000300004547069110176',
+    'FR7630007000110009970004942',
+    'CG5230011000202151234567890',
+    'CR0515202001026284066',
+    'DO28BAGR00000001212453611324',
+    'EG1100006001880800100014553',
+    'GA2140002000055602673300064',
+    'GT82TRAJ01020000001210029690',
+    'IR580540105180021273113007',
+    'IL620108000000099999999',
+    'CI05A00060174100178530011852',
+    'KZ176010251000042993',
+    'KW74NBOK0000000000001000372151',
+    'LB30099900000001001925579115',
+    'MG4600005030010101914016056',
+    'ML03D00890170001002120000447',
+    'MR1300012000010000002037372',
+    'MU17BOMM0101101030300200000MUR',
+    'MZ59000100000011834194157',
+    'PK24SCBL0000001171495101',
+    'PS92PALS000000000400123456702',
+    'PT50000200000163099310355',
+    'SA0380000000608010167519',
+    'SN12K00100152000025690007542',
+    'TN5914207207100707129648',
+    'TR330006100519786457841326',
+    'AE260211000000230064016',
+    'XK051212012345678906',
+    'JO94CBJO0010000000000131000302',
+    'QA58DOHB00001234567890ABCDEFG',
+    'TL380030000000025923744',
+    'SC18SSCB11010000000000001497USD',
+    'ST23000200000289355710148',
+    'LC55HEMM000100010012001200023015',
+  ].each do |code|
+    describe code do
+      it 'is valid' do
+        expect(BankAccountTools::IBAN.new(code)).to be_valid
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'active_model'
+require 'bank_account_tools/iban'
+require 'bank_account_tools/bic'
+require 'bank_account_tools/contact'

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: bank_account_tools
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Dimitar Kostov
+- Kevin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: 'Bank account tools for dealing with IBANs/BICs: information, validation
+  and formatting.'
+email:
+- mitko.kostov@gmail.com
+- kevin.melchert@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bank_account_tools.gemspec
+- data/iban.yml
+- lib/bank_account_tools.rb
+- lib/bank_account_tools/bban.rb
+- lib/bank_account_tools/bic.rb
+- lib/bank_account_tools/contact.rb
+- lib/bank_account_tools/iban.rb
+- lib/bank_account_tools/matchers/active_model/have_valid_bic.rb
+- lib/bank_account_tools/matchers/active_model/have_valid_iban.rb
+- lib/bank_account_tools/matchers/rspec.rb
+- lib/bank_account_tools/validators/bic_validator.rb
+- lib/bank_account_tools/validators/iban_validator.rb
+- lib/bank_account_tools/version.rb
+- spec/activemodel_spec.rb
+- spec/bic_spec.rb
+- spec/contact_spec.rb
+- spec/iban_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/mytrile/bank_account_tools
+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.8
+signing_key: 
+specification_version: 4
+summary: Bank account tools for dealing with IBANs/BICs
+test_files:
+- spec/activemodel_spec.rb
+- spec/bic_spec.rb
+- spec/contact_spec.rb
+- spec/iban_spec.rb
+- spec/spec_helper.rb