class Ibandit::IBAN
Attributes
Public Class Methods
Source
# File lib/ibandit/iban.rb, line 11 def initialize(argument) case argument when String input = argument.to_s.gsub(/\s+/, "").upcase pseudo_iban_splitter = PseudoIBANSplitter.new(input) is_pseudo_iban_country = Constants::PSEUDO_IBAN_COUNTRY_CODES. include?(pseudo_iban_splitter.country_code) if pseudo_iban?(input) && is_pseudo_iban_country @source = :pseudo_iban local_details = pseudo_iban_splitter.split build_iban_from_local_details(local_details) else @source = :iban @iban = input extract_swift_details_from_iban! end when Hash @source = :local_details build_iban_from_local_details(argument) else raise TypeError, "Must pass an IBAN string or hash of local details" end @errors = {} end
Public Instance Methods
Source
# File lib/ibandit/iban.rb, line 58 def account_number return nil if @account_number.nil? return @account_number unless country_code == "NZ" @account_number[0..6] end
Source
# File lib/ibandit/iban.rb, line 65 def account_number_suffix return nil if @account_number.nil? return nil unless country_code == "NZ" @account_number[7..] end
Source
# File lib/ibandit/iban.rb, line 395 def bank_code_passes_checksum_test? return false unless swift_bank_code return false if swift_bank_code.length != 9 code_digits = swift_bank_code.chars.map(&:to_i) mod = ( (3 * (code_digits[0] + code_digits[3] + code_digits[6])) + (7 * (code_digits[1] + code_digits[4] + code_digits[7])) + (1 * (code_digits[2] + code_digits[5] + code_digits[8])) ) % 10 @errors[:bank_code] = Ibandit.translate(:failed_checksum_test) unless mod.zero? mod.zero? end
Source
# File lib/ibandit/iban.rb, line 72 def local_check_digits return unless decomposable? && structure[:local_check_digit_position] iban.slice( structure[:local_check_digit_position] - 1, structure[:local_check_digit_length], ) end
Source
# File lib/ibandit/iban.rb, line 292 def passes_country_specific_checks? return unless valid_country_code? case country_code when "DE" then supports_iban_determination? when "SE" then valid_swedish_details? when "AU" then valid_australian_details? when "NZ" then valid_nz_details? when "CA" then valid_ca_details? when "US" then bank_code_passes_checksum_test? else true end end
Source
# File lib/ibandit/iban.rb, line 85 def pseudo_iban @pseudo_iban ||= PseudoIBANAssembler.new( country_code: country_code, bank_code: bank_code, branch_code: branch_code, account_number: @account_number, ).assemble end
Source
# File lib/ibandit/iban.rb, line 306 def supports_iban_determination? return unless valid_format? return true unless country_code == "DE" begin GermanDetailsConverter.convert( country_code: country_code, bank_code: swift_bank_code, account_number: swift_account_number, ) true rescue UnsupportedAccountDetails @errors[:account_number] = Ibandit.translate(:does_not_support_payments) false end end
Source
# File lib/ibandit/iban.rb, line 50 def swift_national_id return if swift_bank_code.nil? && swift_branch_code.nil? national_id = swift_bank_code.to_s national_id += swift_branch_code.to_s national_id.slice(0, structure[:national_id_length]) end
Component parts #
Source
# File lib/ibandit/iban.rb, line 38 def to_s(format = :compact) case format when :compact then iban.to_s when :formatted then formatted else raise ArgumentError, "invalid format '#{format}'" end end
Source
# File lib/ibandit/iban.rb, line 98 def valid? has_iban = !iban.nil? has_pseudo_iban = !pseudo_iban.nil? if has_pseudo_iban && !has_iban valid_pseudo_iban? else valid_iban? end end
Validations #
Source
# File lib/ibandit/iban.rb, line 270 def valid_account_number_format? return unless valid_account_number_length? if swift_account_number&.match?( entire_string_regex(structure[:account_number_format]), ) true else @errors[:account_number] = Ibandit.translate(:has_invalid_format) false end end
Source
# File lib/ibandit/iban.rb, line 197 def valid_account_number_length? return unless valid_country_code? if swift_account_number.nil? @errors[:account_number] = Ibandit.translate(:is_required) return false end return true if valid_input_length?(structure[:account_number_length], swift_account_number.length) @errors[:account_number] = Ibandit.translate(:wrong_length, expected: structure[:account_number_length]) false end
Source
# File lib/ibandit/iban.rb, line 388 def valid_australian_details? return true unless country_code == "AU" return true unless Ibandit.modulus_checker valid_modulus_check_branch_code? end
Source
# File lib/ibandit/iban.rb, line 240 def valid_bank_code_format? return unless valid_bank_code_length? if structure[:bank_code_length].is_a?(Integer) && structure[:bank_code_length].zero? return true end if swift_bank_code&.match?( entire_string_regex(structure[:bank_code_format]), ) true else @errors[:bank_code] = Ibandit.translate(:has_invalid_format) false end end
Source
# File lib/ibandit/iban.rb, line 162 def valid_bank_code_length? return unless valid_country_code? if structure[:bank_code_length].is_a?(Integer) && structure[:bank_code_length].zero? return true end if swift_bank_code.nil? || swift_bank_code.empty? @errors[:bank_code] = Ibandit.translate(:is_required) return false end return true if valid_input_length?(structure[:bank_code_length], swift_bank_code.length) @errors[:bank_code] = Ibandit.translate(:wrong_length, expected: structure[:bank_code_length]) false end
Source
# File lib/ibandit/iban.rb, line 256 def valid_branch_code_format? return unless valid_branch_code_length? return true unless structure[:branch_code_format] if swift_branch_code&.match?( entire_string_regex(structure[:branch_code_format]), ) true else @errors[:branch_code] = Ibandit.translate(:has_invalid_format) false end end
Source
# File lib/ibandit/iban.rb, line 181 def valid_branch_code_length? return unless valid_country_code? return true if swift_branch_code.to_s.length == structure[:branch_code_length] @errors[:branch_code] = if structure[:branch_code_length]&.zero? Ibandit.translate(:not_used_in_country, country_code: country_code) elsif swift_branch_code.nil? || swift_branch_code.empty? Ibandit.translate(:is_required) else Ibandit.translate(:wrong_length, expected: structure[:branch_code_length]) end false end
Source
# File lib/ibandit/iban.rb, line 381 def valid_ca_details? return true unless country_code == "CA" return true unless Ibandit.modulus_checker valid_modulus_check_branch_code? end
Source
# File lib/ibandit/iban.rb, line 214 def valid_characters? return if iban.nil? if iban.scan(/[^A-Z0-9]/).any? @errors[:characters] = Ibandit.translate(:non_alphanumeric_characters, characters: iban.scan(/[^A-Z\d]/).join(" ")) false else true end end
Source
# File lib/ibandit/iban.rb, line 132 def valid_check_digits? return true if source == :pseudo_iban && check_digits == Constants::PSEUDO_IBAN_CHECK_DIGITS return unless decomposable? && valid_characters? expected_check_digits = CheckDigit.iban(country_code, bban) if check_digits == expected_check_digits true else @errors[:check_digits] = Ibandit.translate(:invalid_check_digits, expected_check_digits: expected_check_digits, check_digits: check_digits) false end end
Source
# File lib/ibandit/iban.rb, line 122 def valid_country_code? if Ibandit.structures.key?(country_code) true else @errors[:country_code] = Ibandit.translate(:invalid_country_code, country_code: country_code) false end end
Source
# File lib/ibandit/iban.rb, line 227 def valid_format? return unless valid_country_code? return unless structure[:bban_format] if bban&.match?(entire_string_regex(structure[:bban_format])) true else @errors[:format] = Ibandit.translate(:invalid_format, country_code: country_code) false end end
Source
# File lib/ibandit/iban.rb, line 148 def valid_length? return unless valid_country_code? && !iban.nil? if iban.length == structure[:total_length] true else @errors[:length] = Ibandit.translate(:invalid_length, expected_length: structure[:total_length], length: iban.size) false end end
Source
# File lib/ibandit/iban.rb, line 283 def valid_local_modulus_check? return unless valid_format? return true unless Ibandit.modulus_checker valid_modulus_check_bank_code? && valid_modulus_check_branch_code? && valid_modulus_check_account_number? end
Source
# File lib/ibandit/iban.rb, line 374 def valid_nz_details? return true unless country_code == "NZ" return true unless Ibandit.modulus_checker valid_modulus_check_branch_code? end
Source
# File lib/ibandit/iban.rb, line 109 def valid_pseudo_iban_check_digits? return true unless source == :pseudo_iban return true if check_digits == Constants::PSEUDO_IBAN_CHECK_DIGITS @errors[:check_digits] = Ibandit.translate( :invalid_check_digits, expected_check_digits: Constants::PSEUDO_IBAN_CHECK_DIGITS, check_digits: check_digits, ) false end
Source
# File lib/ibandit/iban.rb, line 323 def valid_swedish_details? return true unless country_code == "SE" if branch_code valid_swedish_local_details? else valid_swedish_swift_details? end end
Source
# File lib/ibandit/iban.rb, line 355 def valid_swedish_local_details? unless Sweden::Validator.valid_clearing_code_length?(branch_code) @errors[:branch_code] = Ibandit.translate(:has_invalid_clearing_code_length) return false end valid_serial_number = Sweden::Validator.valid_serial_number_length?( clearing_code: branch_code, serial_number: account_number, ) unless valid_serial_number @errors[:account_number] = Ibandit.translate(:has_invalid_serial_number) return false end true end
Source
# File lib/ibandit/iban.rb, line 333 def valid_swedish_swift_details? unless Sweden::Validator.bank_code_exists?(swift_bank_code) bank_code_field = bank_code.nil? ? :account_number : :bank_code @errors[bank_code_field] = Ibandit.translate(:bank_code_does_not_exist) @errors.delete(:bank_code) if bank_code.nil? return false end length_valid = Sweden::Validator.account_number_length_valid_for_bank_code?( bank_code: swift_bank_code, account_number: swift_account_number, ) unless length_valid @errors[:account_number] = Ibandit.translate(:has_invalid_length) return false end true end
Private Instance Methods
Source
# File lib/ibandit/iban.rb, line 453 def build_iban_from_local_details(details_hash) local_details = LocalDetailsCleaner.clean(details_hash) @country_code = try_dup(local_details[:country_code]) @account_number = try_dup(local_details[:account_number]) @branch_code = try_dup(local_details[:branch_code]) @bank_code = try_dup(local_details[:bank_code]) @swift_account_number = try_dup(local_details[:swift_account_number]) @swift_branch_code = try_dup(local_details[:swift_branch_code]) @swift_bank_code = try_dup(local_details[:swift_bank_code]) @iban = IBANAssembler.assemble(swift_details) if source == :pseudo_iban @check_digits = try_dup(local_details[:check_digits]) else @check_digits = @iban.slice(2, 2) unless @iban.nil? end end
Source
# File lib/ibandit/iban.rb, line 449 def decomposable? [iban, country_code, swift_bank_code, swift_account_number].none?(&:nil?) end
Source
# File lib/ibandit/iban.rb, line 502 def entire_string_regex(pattern) Regexp.new("\\A#{pattern}\\z") end
Source
# File lib/ibandit/iban.rb, line 474 def extract_swift_details_from_iban! swift_details = IBANSplitter.split(@iban) @country_code = swift_details[:country_code] @check_digits = swift_details[:check_digits] @swift_bank_code = swift_details[:bank_code] @swift_branch_code = swift_details[:branch_code] @swift_account_number = swift_details[:account_number] return if Constants::PSEUDO_IBAN_COUNTRY_CODES. include?(@country_code) @bank_code = swift_details[:bank_code] @branch_code = swift_details[:branch_code] @account_number = swift_details[:account_number] end
Source
# File lib/ibandit/iban.rb, line 506 def formatted iban.to_s.gsub(/(.{4})/, '\1 ').strip end
Source
# File lib/ibandit/iban.rb, line 549 def pseudo_iban?(input) return false if input.nil? input.slice(2, 2) == Constants::PSEUDO_IBAN_CHECK_DIGITS end
Source
# File lib/ibandit/iban.rb, line 498 def structure Ibandit.structures[country_code] end
Source
# File lib/ibandit/iban.rb, line 540 def swift_details { country_code: @country_code, account_number: @swift_account_number, branch_code: @swift_branch_code, bank_code: @swift_bank_code, } end
Source
# File lib/ibandit/iban.rb, line 492 def try_dup(object) object.dup rescue TypeError object end
Source
# File lib/ibandit/iban.rb, line 431 def valid_iban? [ valid_country_code?, valid_characters?, valid_check_digits?, valid_length?, valid_bank_code_length?, valid_branch_code_length?, valid_account_number_length?, valid_format?, valid_bank_code_format?, valid_branch_code_format?, valid_account_number_format?, valid_local_modulus_check?, passes_country_specific_checks?, ].all? end
Source
# File lib/ibandit/iban.rb, line 510 def valid_input_length?(allowed_length, input_length) case allowed_length when Range allowed_length.include?(input_length) else allowed_length == input_length end end
Source
# File lib/ibandit/iban.rb, line 533 def valid_modulus_check_account_number? return true if Ibandit.modulus_checker.valid_account_number?(self) @errors[:account_number] = Ibandit.translate(:failed_modulus_check) false end
Source
# File lib/ibandit/iban.rb, line 519 def valid_modulus_check_bank_code? return true if Ibandit.modulus_checker.valid_bank_code?(self) @errors[:bank_code] = Ibandit.translate(:bank_code_does_not_exist) false end
Source
# File lib/ibandit/iban.rb, line 526 def valid_modulus_check_branch_code? return true if Ibandit.modulus_checker.valid_branch_code?(self) @errors[:branch_code] = Ibandit.translate(:branch_code_does_not_exist) false end
Source
# File lib/ibandit/iban.rb, line 417 def valid_pseudo_iban? [ valid_pseudo_iban_check_digits?, valid_country_code?, valid_bank_code_length?, valid_branch_code_length?, valid_account_number_length?, valid_bank_code_format?, valid_branch_code_format?, valid_account_number_format?, passes_country_specific_checks?, ].all? end
Private methods #