Module: QRBills

Defined in:
lib/qr-bills.rb

Class Method Summary collapse

Class Method Details

.create_creditor_reference(reference) ⇒ Object 



39
40
41
 
# File 'lib/qr-bills.rb', line 39

def self.create_creditor_reference(reference)
  QRCreditorReference.create(reference)
end

.create_esr_creditor_reference(reference) ⇒ Object

ESR reference should be considered “deprecated” and is here for backward compatibility This is based on: sahits.ch/blog/blog/2007/11/08/uberprufen-esr-referenz-nummer/

Raises:

  • (ArgumentError) 


45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/qr-bills.rb', line 45

def self.create_esr_creditor_reference(reference)
  raise ArgumentError, "#{QRExceptions::INVALID_PARAMETERS}: You must provide a 26 digit reference for ESR." unless reference.size == 26
  raise ArgumentError, "#{QRExceptions::INVALID_PARAMETERS}: You must provide a valid digit for ESR." unless reference.to_i.to_s == reference

  esr = "#{reference}0"
  lookup_table = [0, 9, 4, 6, 8, 2, 7, 1, 3, 5]
  next_val = 0

  (0...esr.length - 1).each do |i|
    ch = esr[i]
    n = ch.to_i
    index = (next_val + n) % 10
    next_val = lookup_table[index]
  end

  result = (10 - next_val) % 10
  return result
end

.generate(qr_params) ⇒ Object

Raises:

  • (ArgumentError) 


8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
 
# File 'lib/qr-bills.rb', line 8

def self.generate(qr_params)
  raise ArgumentError, "#{QRExceptions::INVALID_PARAMETERS}: bill type param not set" unless qr_params.has_key?(:bill_type)
  raise ArgumentError, "#{QRExceptions::INVALID_PARAMETERS}: validation failed" unless QRParams.valid?(qr_params)

  # init translator sets
  %i[it en de fr].each do |locale|
    locale_file = File.join(qr_params[:locales][:path], "qrbills.#{locale}.yml")

    I18n.load_path << locale_file
  end

  output = case qr_params[:output_params][:format]
           when 'html'
             QRHTMLLayout.create(qr_params)
           else
             QRGenerator.create(qr_params, qr_params[:qrcode_filepath])
           end

  { params: qr_params, output: output }
end

.get_qr_params ⇒ Object 



64
65
66
 
# File 'lib/qr-bills.rb', line 64

def self.get_qr_params
  QRParams.get_qr_params
end

.get_qrbill_with_creditor_reference_type ⇒ Object 



72
73
74
 
# File 'lib/qr-bills.rb', line 72

def self.get_qrbill_with_creditor_reference_type
  QRParams::QR_BILL_WITH_CREDITOR_REFERENCE
end

.get_qrbill_with_qr_reference_type ⇒ Object 



68
69
70
 
# File 'lib/qr-bills.rb', line 68

def self.get_qrbill_with_qr_reference_type
  QRParams::QR_BILL_WITH_QR_REFERENCE
end

.get_qrbill_without_reference_type ⇒ Object 



76
77
78
 
# File 'lib/qr-bills.rb', line 76

def self.get_qrbill_without_reference_type
  QRParams::QR_BILL_WITHOUT_REFERENCE
end

.iban_type(iban) ⇒ Object

Given a creditor’s IBAN number, this method checks whether an IBAN is of the new qr or the legacy esr type. When generating a bill with a reference number, that number must be generated using the following method if this helper returns:

- :qr => create_creditor_reference
- :esr => create_esr_creditor_reference



33
34
35
36
37
 
# File 'lib/qr-bills.rb', line 33

def self.iban_type(iban)
  return nil if iban.blank?
  iban_institute_identifier = iban.strip.gsub(' ', '')[4..8].to_i
  return iban_institute_identifier.between?(30_000, 31_999) ? :qr : :esr
end