ibandit 0.2.1 → 0.3.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ibandit
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Grey Baker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-30 00:00:00.000000000 Z
+date: 2015-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.28.0
+        version: 0.29.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.28.0
+        version: 0.29.0
 - !ruby/object:Gem::Dependency
   name: sax-machine
   requirement: !ruby/object:Gem::Requirement
@@ -112,14 +112,18 @@ files:
 - lib/ibandit/errors.rb
 - lib/ibandit/german_details_converter.rb
 - lib/ibandit/iban.rb
-- lib/ibandit/iban_builder.rb
+- lib/ibandit/iban_assembler.rb
+- lib/ibandit/iban_splitter.rb
+- lib/ibandit/local_details_cleaner.rb
 - lib/ibandit/version.rb
 - spec/fixtures/germany_integration_test_cases.json
 - spec/fixtures/germany_unit_test_cases.json
 - spec/ibandit/check_digit_spec.rb
 - spec/ibandit/german_details_converter_spec.rb
-- spec/ibandit/iban_builder_spec.rb
+- spec/ibandit/iban_assembler_spec.rb
 - spec/ibandit/iban_spec.rb
+- spec/ibandit/iban_splitter_spec.rb
+- spec/ibandit/local_details_cleaner_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/gocardless/ibandit
 licenses:

data/lib/ibandit/iban_builder.rb

@@ -1,539 +0,0 @@
-module Ibandit
-  module IBANBuilder
-    SUPPORTED_COUNTRY_CODES = %w(AT BE CY DE EE ES FI FR GB IE IT LT LU LV MC NL
-                                 PT SI SK SM).freeze
-
-    def self.build(opts)
-      country_code = opts.delete(:country_code)
-
-      if country_code.nil?
-        raise ArgumentError, 'You must provide a country_code'
-      elsif !SUPPORTED_COUNTRY_CODES.include?(country_code)
-        msg = "Don't know how to build an IBAN for country code #{country_code}"
-        raise UnsupportedCountryError, msg
-      else
-        require_fields(country_code, opts)
-        bban = send(:"build_#{country_code.downcase}_bban", opts)
-        build_iban(country_code, bban)
-      end
-    end
-
-    ##################################
-    # Country-specific BBAN creation #
-    ##################################
-
-    def self.build_at_bban(opts)
-      # Local account details format:
-      #   aaaaaaaaaaa bbbbb
-      #   Account number may be 4-11 digits long
-      #
-      # Local account details name(s):
-      #   Bank code: 'Bankleitzahl' or 'BLZ'
-      #   Account number: 'Kontonummer' or 'Kto.-Nr'
-      #
-      # BBAN-specific check digits: none
-      #
-      # Other check digits:
-      #   Austrian account numbers have built-in check digits. The checking
-      #   rules are not public.
-      #
-      # Padding:
-      #   Add leading zeros to account number if < 11 digits.
-      [
-        opts[:bank_code],
-        opts[:account_number].rjust(11, '0')
-      ].join
-    end
-
-    def self.build_be_bban(opts)
-      # Local account details format: bbb-aaaaaaa-cc
-      #
-      # Local account details name(s):
-      #   Single name for all fields: "Rekeningnummer / Numéro de compte"
-      #   All fields are entered in one block, separated by hyphens for clarity
-      #
-      # BBAN-specific check digits: none
-      #
-      # Other check digits:
-      #   The last two digits of the account number are check digits, but these
-      #   are considered integral to the account number itself. See
-      #   CheckDigit#belgian for details of their calculation.
-      #
-      # Additional info:
-      #   The first three digits of Belgian account numbers are the bank_code,
-      #   but the account number is not considered complete without these three
-      #   numbers and the IBAN structure file includes them in its definition of
-      #   the account number. As a result, this method ignores all arguments
-      #   other than the account number.
-      opts[:account_number].tr('-', '')
-    end
-
-    def self.build_cy_bban(opts)
-      # Local account details format:
-      #   bbb-sssss aaaaaaaaaaaaaaaa
-      #   Account number may be 7-16 digits long
-      #
-      # Local account details name(s):
-      #   Bank code: 'Kodikos Trapezas'
-      #   Branch code: 'Kodikos Katastimatos'
-      #   Account number: 'Arithmos Logariasmou'
-      #
-      # BBAN-specific check digits: none
-      #
-      # Other check digits:
-      #   Some Cypriot banks may be using check digits in their account numbers,
-      #   but there's no central source of them.
-      #
-      # Padding:
-      #   Add leading zeros to account number if < 16 digits.
-      #
-      # Additional info:
-      #   Cypriot bank and branch codes are often communicated as a single code,
-      #   so this method handles being passed them together or separately.
-      combined_bank_code = opts[:bank_code]
-      combined_bank_code += opts[:branch_code] || ''
-
-      [
-        combined_bank_code,
-        opts[:account_number].rjust(16, '0')
-      ].join
-    end
-
-    def self.build_de_bban(opts)
-      # Local account details format:
-      #   bbbbbbbb aaaaaaaaaa
-      #   Account number may be 1-10 digits long
-      #
-      # Local account details name(s):
-      #   Bank code: 'Bankleitzahl' or 'BLZ'
-      #   Account number: 'Kontonummer' or 'Kto.-Nr'
-      #
-      # BBAN-specific check digits: none
-      #
-      # Other check digits:
-      #   Local bank validation is carried out by matching the bank code with
-      #   the right algorithm key, then applying that bank-specific algorithm.
-      #
-      # Padding:
-      #   Add leading zeros to account number if < 10 digits.
-      #
-      # Additional info:
-      #   There are many exceptions to the way German bank details translate
-      #   into an IBAN, detailed into a 200 page document compiled by the
-      #   Bundesbank, and handled by the GermanDetailsConverter class.
-      converted_details = GermanDetailsConverter.convert(opts)
-
-      [
-        converted_details[:bank_code],
-        converted_details[:account_number].rjust(10, '0')
-      ].join
-    end
-
-    def self.build_ee_bban(opts)
-      # Local account details format:
-      #   bbaaaaaaaaaaax
-      #   Account number may be up to 14 characters long
-      #   Bank code can be found by extracted from the first two digits of the
-      #   account number and converted using the rules at
-      #   http://www.pangaliit.ee/en/settlements-and-standards/bank-codes-of-estonian-banks
-      #
-      # Local account details name(s):
-      #   Account number: 'Kontonumber'
-      #
-      # BBAN-specific check digits: none
-      #
-      # Other check digits:
-      #   The last digit of the account number is a check digit, but this is
-      #   built-in. An implementation of the check digit algorithm is available
-      #   in CheckDigit#estonian.
-      #
-      # Padding:
-      #   Add leading zeros to account number if < 14 digits.
-      #
-      # Additional info:
-      #   Estonian national bank details were replaced with IBANs in Feb 2014.
-      #   All Estonian payers should therefore know their IBAN.
-      domestic_bank_code = opts[:account_number].gsub(/\A0+/, '').slice(0, 2)
-
-      case domestic_bank_code
-      when '11' then iban_bank_code = '22'
-      when '93' then iban_bank_code = '00'
-      else iban_bank_code = domestic_bank_code
-      end
-
-      iban_bank_code + opts[:account_number].rjust(14, '0')
-    end
-
-    def self.build_es_bban(opts)
-      # Local account details format:
-      #   bbbb-ssss-xx-aaaaaaaaaa
-      #   Usually not separated, except by spaces or dashes
-      #
-      # Local account details name(s):
-      #   Full details (20 digits): Código Cuenta Cliente
-      #   Bank code (first 4 digits): Código de entidad
-      #   Branch code (next 4 digits): Código de oficina
-      #   Check digits (next 2 ditigs): Dígitos de control
-      #   Account number (final 10 digits): Número de cuenta
-      #
-      # BBAN-specific check digits: none
-      #
-      # Other check digits:
-      #   The 2 check digits described above are part of the "account number" as
-      #   defined by SWIFT. See CheckDigit#spanish for their generation.
-      #
-      # Padding: None
-      #
-      # Additional info:
-      #   This method supports being passed the component IBAN parts, as defined
-      #   by SWIFT, or a single 20 digit string.
-      if opts.include?(:bank_code) && opts.include?(:branch_code)
-        [
-          opts[:bank_code],
-          opts[:branch_code],
-          opts[:account_number]
-        ].join
-      else
-        opts[:account_number].tr('-', '')
-      end
-    end
-
-    def self.build_fi_bban(opts)
-      # Local account details format:
-      #   bbbbbb-aaaaaaax
-      #   Usually two joined fields separated by a hyphen
-      #
-      # Local account details name(s):
-      #   Full details: 'Tilinumeron rakenne'
-      #
-      # BBAN-specific check digits: none
-      #
-      # Other check digits:
-      #   The last digit of the account number is a check digit. The check digit
-      #   algorithm is available in CheckDigit#lund.
-      #
-      # Padding:
-      #   Finnish account numbers need to be expanded into "electronic format"
-      #   by adding zero-padding. The expansion method depends on the first
-      #   character of the bank code.
-      if %w(4 5 6).include?(opts[:bank_code][0])
-        [
-          opts[:bank_code],
-          opts[:account_number][0],
-          opts[:account_number][1..-1].rjust(7, '0')
-        ].join
-      else
-        opts[:bank_code] + opts[:account_number].rjust(8, '0')
-      end
-    end
-
-    def self.build_fr_bban(opts)
-      # Local account details format:
-      #   bbbbb-sssss-aaaaaaaaaaa-xx
-      #   4 separated fields
-      #
-      # Local account details name(s):
-      #   Bank code (5 digits): 'Code banque'
-      #   Branch code (5 digits): 'Code guichet'
-      #   Account number (max 11 digits): 'Numéro de compte'
-      #   Check digits (2 digits): 'Clé RIB'
-      #
-      # BBAN-specific check digits: none
-      #
-      # Other check digits:
-      #   French BBANs include two "RIB key" check digits. In the SWIFT IBAN
-      #   structure definition these check digits are part of the account
-      #   number, although customers expect to see them as a separate field.
-      #   You should concatenate the account number with the entered check
-      #   digits when using this method.
-      #
-      # Padding: None
-      [
-        opts[:bank_code],
-        opts[:branch_code],
-        opts[:account_number]
-      ].join
-    end
-
-    def self.build_gb_bban(opts)
-      # Local account details format:
-      #   ssssss aaaaaaaa
-      #   2 separated fields
-      #
-      # Local account details name(s):
-      #   Branch code: Sort code
-      #   Account number: Account number
-      #
-      # BBAN-specific check digits: none
-      #
-      # Other check digits:
-      #   Local bank validation is carried out on a bank-by-bank basis, and out
-      #   of scope for this gem.
-      #
-      # Padding:
-      #   Add leading zeros to account number if < 8 digits.
-      #
-      # Additional info:
-      #   UK BBANs include the first four characters of the BIC. This requires a
-      #   BIC finder lambda to be defined, or the bank_code to be supplied.
-      branch_code = opts[:branch_code].gsub(/[-\s]/, '')
-
-      if opts[:bank_code]
-        bank_code = opts[:bank_code]
-      else
-        bic = Ibandit.find_bic('GB', branch_code)
-        raise BicNotFoundError, 'BIC finder failed to find a BIC.' if bic.nil?
-        bank_code = bic.slice(0, 4)
-      end
-
-      [
-        bank_code,
-        branch_code,
-        opts[:account_number].gsub(/[-\s]/, '').rjust(8, '0')
-      ].join
-    end
-
-    def self.build_lt_bban(opts)
-      # Additional info:
-      #   Lithuanian national bank details were replaced with IBANs in 2004.
-      #   All Lithuanian payers should therefore know their IBAN, and are
-      #   unlikely to know how it breaks down. This method is included for
-      #   consistency with the IBAN structure only.
-      [opts[:bank_code], opts[:account_number]].join
-    end
-
-    def self.build_lu_bban(opts)
-      # Additional info:
-      #   Luxembourgian national bank details were replaced with IBANs in 2002.
-      #   All Luxembourgian payers should therefore know their IBAN, and are
-      #   unlikely to know how it breaks down. This method is included for
-      #   consistency with the IBAN structure only.
-      [opts[:bank_code], opts[:account_number]].join
-    end
-
-    def self.build_lv_bban(opts)
-      # Additional info:
-      #   Latvian national bank details were replaced with IBANs in 2004.
-      #   All Latvian payers should therefore know their IBAN, and are
-      #   unlikely to know how it breaks down. This method is included for
-      #   consistency with the IBAN structure only.
-      [opts[:bank_code], opts[:account_number]].join
-    end
-
-    def self.build_ie_bban(opts)
-      # Ireland uses the same BBAN construction method as the United Kingdom
-      branch_code = opts[:branch_code].gsub(/[-\s]/, '')
-
-      if opts[:bank_code]
-        bank_code = opts[:bank_code]
-      else
-        bic = Ibandit.find_bic('IE', branch_code)
-        raise BicNotFoundError, 'BIC finder failed to find a BIC.' if bic.nil?
-        bank_code = bic.slice(0, 4)
-      end
-
-      [
-        bank_code,
-        branch_code,
-        opts[:account_number].gsub(/[-\s]/, '').rjust(8, '0')
-      ].join
-    end
-
-    def self.build_it_bban(opts)
-      # Local account details format:
-      #   x/bbbbb/sssss/cccccccccccc
-      #   4 fields, separated by slashes
-      #   The check digit is NOT included in the any of the other SWIFT
-      #   elements, so should be passed explicitly or left blank for it to be
-      #   calculated implicitly
-      #
-      # Local bank details name(s):
-      #   Check digit: 'CIN'
-      #   Bank code: 'Codice ABI'
-      #   Branch code: 'CAB'
-      #   Account number: 'Numero di conto'
-      #
-      # BBAN-specific check digits:
-      #   Italian BBANs include a single BBAN-specific check digit, calculated
-      #   using a bespoke algorithm. See CheckDigit#italian.
-      #
-      # Padding:
-      #   Add leading zeros to account number if < 10 digits.
-      combined_code = [
-        opts[:bank_code],
-        opts[:branch_code],
-        opts[:account_number].rjust(12, '0')
-      ].join
-
-      check_digit = opts[:check_digit] || CheckDigit.italian(combined_code)
-
-      [check_digit, combined_code].join
-    end
-
-    def self.build_mc_bban(opts)
-      # Monaco uses the same BBAN construction method as France
-      build_fr_bban(opts)
-    end
-
-    def self.build_nl_bban(opts)
-      # Local account details format:
-      #   aaaaaaaaaa
-      #   1 field for account number only
-      #   In theory the bank code can be looked up from the account number, but
-      #   we don't currently have a way of doing so.
-      #
-      # Local bank details name(s):
-      #   Account number: 'Rekeningnummer'
-      #
-      # BBAN-specific check digits: none
-      #
-      # Other check digits:
-      #   A modulus 11 check can be applied to Dutch IBANs. See CheckDigit#dutch
-      #   for an implementation.
-      #
-      # Padding:
-      #   Add leading zeros to account number if < 10 digits.
-      [
-        opts[:bank_code],
-        opts[:account_number].rjust(10, '0')
-      ].join
-    end
-
-    def self.build_pt_bban(opts)
-      # Local account details format:
-      #   bbbb.ssss.ccccccccccc.xx
-      #   Usually presented in one block
-      #
-      # Local account details name(s):
-      #   Full details: Número de Identificaçao Bancária (NIB)
-      #   Bank code: Código de Banco
-      #   Branch code: Código de Balcao
-      #   Account number: Número de conta
-      #   Local check digits: Dígitos de controlo
-      #
-      # BBAN-specific check digits:
-      #   Technically none, but see below
-      #
-      # Other check digits:
-      #   The last two digits of Portuguese account numbers, as defined by
-      #   SWIFT, are check digits, calculated using the same algorithm as the
-      #   overall IBAN check digits (i.e., mod_97_10). However, customers expect
-      #   to see these check digits as a separate field. You should concatenate
-      #   the account number with the entered check digits when using this
-      #   method.
-      #
-      # Additional info:
-      #   A side-effect of Portugal using the same algorithm for its local check
-      #   digits as the overall IBAN check digits is that the overall digits are
-      #   always 50.
-      [
-        opts[:bank_code],
-        opts[:branch_code],
-        opts[:account_number]
-      ].join
-    end
-
-    def self.build_si_bban(opts)
-      # Local account details format:
-      #   bbbbb-aaaaaaaaxx
-      #   Two fields, separated by a dash
-      #
-      # Local account details name(s):
-      #   Full details: Transakcijski račun
-      #
-      # BBAN-specific check digits: none
-      #
-      # Other check digits:
-      #   The last two digits of Slovenian account numbers, as defined by
-      #   SWIFT, are check digits, calculated using the same algorithm as the
-      #   overall IBAN check digits (i.e., mod_97_10).
-      #
-      # Additional info:
-      #   A side-effect of Slovenia using the same algorithm for its local check
-      #   digits as the overall IBAN check digits is that the overall digits are
-      #   always 56.
-      [
-        opts[:bank_code],
-        opts[:account_number].rjust(10, '0')
-      ].join
-    end
-
-    def self.build_sk_bban(opts)
-      # Local account details format:
-      #   pppppp-aaaaaaaaaa/bbbb
-      #   Three fields (or two, if prefix and account number are merged)
-      #
-      # Local account details name(s):
-      #   Account number prefix: Předčíslí
-      #   Account number: číslo účtu
-      #   Bank code: 'Kód banky'
-      #
-      # BBAN-specific check digits: none
-      #
-      # Other check digits:
-      #   The last digits of the account_number_prefix and the account_number
-      #   are check digits. See CheckDigit#slovakian_prefix and
-      #   CheckDigit#slovakian_basic
-      #
-      # Additional info:
-      #   The SWIFT definition of a Slovakian IBAN includes both the account
-      #   number prefix and the account number. This method therefore supports
-      #   passing those fields concatenated.
-      if opts.include?(:account_number_prefix)
-        [
-          opts[:bank_code],
-          opts[:account_number_prefix].rjust(6, '0'),
-          opts[:account_number].rjust(10, '0')
-        ].join
-      else
-        [
-          opts[:bank_code],
-          opts[:account_number].tr('-', '').rjust(16, '0')
-        ].join
-      end
-    end
-
-    def self.build_sm_bban(opts)
-      # San Marino uses the same BBAN construction method as Italy
-      build_it_bban(opts)
-    end
-
-    ##################
-    # Helper methods #
-    ##################
-
-    def self.require_fields(country_code, opts)
-      required_fields(country_code).each do |arg|
-        next if opts[arg]
-
-        msg = "#{arg} is a required field when building an #{country_code} IBAN"
-        raise ArgumentError, msg
-      end
-    end
-
-    def self.required_fields(country_code)
-      case country_code
-      when 'AT', 'CY', 'DE', 'FI', 'LT', 'LU', 'LV', 'NL', 'SI', 'SK'
-        %i(bank_code account_number)
-      when 'BE', 'EE', 'ES'
-        %i(account_number)
-      when 'GB', 'IE'
-        if Ibandit.bic_finder.nil? then %i(bank_code branch_code account_number)
-        else %i(branch_code account_number)
-        end
-      else
-        %i(bank_code branch_code account_number)
-      end
-    end
-
-    def self.build_iban(country_code, bban)
-      iban = [
-        country_code,
-        CheckDigit.iban(country_code, bban),
-        bban
-      ].join
-
-      IBAN.new(iban)
-    end
-  end
-end