Module: Ibandit::IBANAssembler

Defined in:
lib/ibandit/iban_assembler.rb

Constant Summary collapse

EXCEPTION_COUNTRY_CODES = 
%w[IT SM BE].freeze

Class Method Summary collapse

Class Method Details

.allowed_fields(country_code) ⇒ Object 



102
103
104
105
106
107
108
109
110
111
 
# File 'lib/ibandit/iban_assembler.rb', line 102

def self.allowed_fields(country_code)
  # Some countries have additional optional fields
  case country_code
  when "BE" then %i[bank_code account_number]
  when "CY" then %i[bank_code branch_code account_number]
  when "IT" then %i[bank_code branch_code account_number check_digit]
  when "CZ", "SK" then %i[bank_code account_number account_number_prefix]
  else required_fields(country_code)
  end
end

.assemble(local_details) ⇒ Object 



7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
 
# File 'lib/ibandit/iban_assembler.rb', line 7

def self.assemble(local_details)
  country_code = local_details[:country_code]

  return unless can_assemble?(local_details)

  bban =
    if EXCEPTION_COUNTRY_CODES.include?(country_code)
      public_send(:"assemble_#{country_code.downcase}_bban", local_details)
    else
      assemble_general_bban(local_details)
    end

  assemble_iban(country_code, bban)
rescue InvalidCharacterError
  nil
end

.assemble_be_bban(opts) ⇒ Object

Country-specific BBAN creation #



36
37
38
39
40
41
42
43
 
# File 'lib/ibandit/iban_assembler.rb', line 36

def self.assemble_be_bban(opts)
  # 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]
end

.assemble_general_bban(opts) ⇒ Object

General case BBAN creation #



28
29
30
 
# File 'lib/ibandit/iban_assembler.rb', line 28

def self.assemble_general_bban(opts)
  [opts[:bank_code], opts[:branch_code], opts[:account_number]].join
end

.assemble_iban(country_code, bban) ⇒ Object 



113
114
115
116
117
118
119
120
121
 
# File 'lib/ibandit/iban_assembler.rb', line 113

def self.assemble_iban(country_code, bban)
  [
    country_code,
    CheckDigit.iban(country_code, bban),
    bban,
  ].join
rescue InvalidCharacterError
  nil
end

.assemble_it_bban(opts) ⇒ Object 



45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/ibandit/iban_assembler.rb', line 45

def self.assemble_it_bban(opts)
  # The  Italian 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
  partial_bban = [
    opts[:bank_code],
    opts[:branch_code],
    opts[:account_number],
  ].join

  check_digit = opts[:check_digit] || CheckDigit.italian(partial_bban)

  [check_digit, partial_bban].join
end

.assemble_sm_bban(opts) ⇒ Object 



60
61
62
63
 
# File 'lib/ibandit/iban_assembler.rb', line 60

def self.assemble_sm_bban(opts)
  # San Marino uses the same BBAN construction method as Italy
  assemble_it_bban(opts)
end

.can_assemble?(local_details) ⇒ Boolean

Helper methods #

Returns:

  • (Boolean) 


69
70
71
 
# File 'lib/ibandit/iban_assembler.rb', line 69

def self.can_assemble?(local_details)
  supported_country_code?(local_details) && valid_arguments?(local_details)
end

.required_fields(country_code) ⇒ Object 



90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/ibandit/iban_assembler.rb', line 90

def self.required_fields(country_code)
  case country_code
  when "AT", "CY", "CZ", "DE", "DK", "EE", "FO", "FI", "GL", "HR", "IS", "LT", "LU",
       "LV", "NL", "NO", "PL", "RO", "SE", "SI", "SK"
    %i[bank_code account_number]
  when "BE"
    %i[account_number]
  else
    %i[bank_code branch_code account_number]
  end
end

.supported_country_code?(local_details) ⇒ Boolean

Returns:

  • (Boolean) 


73
74
75
76
 
# File 'lib/ibandit/iban_assembler.rb', line 73

def self.supported_country_code?(local_details)
  Constants::CONSTRUCTABLE_IBAN_COUNTRY_CODES.
    include?(local_details[:country_code])
end

.valid_arguments?(local_details) ⇒ Boolean

Returns:

  • (Boolean) 


78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/ibandit/iban_assembler.rb', line 78

def self.valid_arguments?(local_details)
  country_code = local_details[:country_code]

  supplied = local_details.keys.select { |key| local_details[key] }
  supplied.delete(:country_code)

  allowed = allowed_fields(country_code)

  required_fields(country_code).all? { |key| supplied.include?(key) } &&
    supplied.all? { |key| allowed.include?(key) }
end