qr-bills 1.0.10 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbb88b03ca64ef109608926dc972fd7c53f1db3f325e47d652faac6d128ad327
-  data.tar.gz: 2c7443c74f2a307e4b7d93774454131e723fc73b310d0cc613efac3d92a86450
+  metadata.gz: 7fc173cb15d0093e2298fa873dcc9320b1485c093cee48f4ac6f8266bb0ea45a
+  data.tar.gz: acc76affa6b192d19dbc0b749440afe706af181127a2ae5337a161f13c889551
 SHA512:
-  metadata.gz: 64d2bb70d15a823c5cf8fe007d4be5f206e299334eee7f8193eda58249d97356a128c1f2782d58c04d1e835a3e52a401a36ccc10973907893ced49c7b050d7e8
-  data.tar.gz: 1ebf9dbf4363102cb28f4c4b8781b26622f1fe69b4696c2e07fe83caa263cfbf376e566db5196dfa889389458f8e7866a6d5ca21c10e1a5f4b9cc41f44e828d2
+  metadata.gz: bd9cf2223b15f2e4a3d93e548d10e60f05dbf8d7862c9e635f51f24b6d10740b72c5016609521bd865411c7bb26085fb351ece7f3abeb6b996a90c7b6787bcda
+  data.tar.gz: daadbf86fc459a426fded5b081529941d9fe895ccdcd988eae21dca7dba14f913fe5b8b794fc16955a70fff4aa7a508c152168caa20a71485d2cac0325d199c2

data/lib/qr-bills/qr-generator.rb

@@ -19,8 +19,6 @@ module QRGenerator
   end
 
   def self.build_qrcode_png(bill_params, qrcode_path)
-    warn('DEPRECATION WARNING: The qrcode_png format and qrcode_filepath parameter are deprecated and will be removed from qr-bills 1.1 (use png or svg instead)')
-
     final_qr = build_png(bill_params)
     final_qr.save(qrcode_path)
     final_qr
@@ -127,8 +125,8 @@ module QRGenerator
     payload += "#{bill_params[:creditor][:iban].delete(' ')}\r\n"
     payload += "#{bill_params[:creditor][:address][:type]}\r\n"
     payload += "#{bill_params[:creditor][:address][:name]}\r\n"
-    payload += "#{bill_params[:creditor][:address][:line1]}\r\n"
-    payload += "#{bill_params[:creditor][:address][:line2]}\r\n"
+    payload += "#{bill_params[:creditor][:address][:street_name]}\r\n"
+    payload += "#{bill_params[:creditor][:address][:building_number]}\r\n"
     payload += "#{bill_params[:creditor][:address][:postal_code]}\r\n"
     payload += "#{bill_params[:creditor][:address][:town]}\r\n"
     payload += "#{bill_params[:creditor][:address][:country]}\r\n"
@@ -143,8 +141,8 @@ module QRGenerator
     payload += "#{bill_params[:currency]}\r\n"
     payload += "#{bill_params[:debtor][:address][:type]}\r\n"
     payload += "#{bill_params[:debtor][:address][:name]}\r\n"
-    payload += "#{bill_params[:debtor][:address][:line1]}\r\n"
-    payload += "#{bill_params[:debtor][:address][:line2]}\r\n"
+    payload += "#{bill_params[:debtor][:address][:street_name]}\r\n"
+    payload += "#{bill_params[:debtor][:address][:building_number]}\r\n"
     payload += "#{bill_params[:debtor][:address][:postal_code]}\r\n"
     payload += "#{bill_params[:debtor][:address][:town]}\r\n"
     payload += "#{bill_params[:debtor][:address][:country]}\r\n"
@@ -154,5 +152,8 @@ module QRGenerator
     payload += "EPD\r\n"
     payload += "#{bill_params[:bill_information_coded]}\r\n"
     payload += "#{bill_params[:alternative_scheme_parameters]}\r\n"
+
+    payload.delete_suffix!("\r\n") while payload.end_with?("\r\n")
+    payload
   end
 end

data/lib/qr-bills/qr-html-layout.rb

@@ -248,9 +248,13 @@ module QRHTMLLayout
   def self.render_address(address)
     case address[:type]
     when 'S'
-      format("%s<br>\n%s %s<br>\n%s %s<br>\n", address[:name], address[:line1], address[:line2], address[:postal_code], address[:town])
+      if address[:street_name].empty?
+        format("%s<br>\n%s %s<br>\n", address[:name], address[:postal_code], address[:town])
+      else 
+        format("%s<br>\n%s %s<br>\n%s %s<br>\n", address[:name], address[:street_name], address[:building_number], address[:postal_code], address[:town])
+      end
     when 'K'
-      format("%s<br>\n%s<br>\n%s<br>\n", address[:name], address[:line1], address[:line2])
+      raise ArgumentError, "#{QRExceptions::INVALID_PARAMETERS}: please move to type-S addresses, K-type is not supported anymore with and after v2.0.0 - params line1 and line2 doesn't exist anymore and are now street_name / building_number"
     end
   end
 end

data/lib/qr-bills/qr-params.rb

@@ -30,8 +30,8 @@ module QRParams
           address: {
             type: "S",
             name: "",
-            line1: "",
-            line2: "",
+            street_name: "",
+            building_number: "",
             postal_code: "",
             town: "",
             country: "",
@@ -42,8 +42,8 @@ module QRParams
           address: {
             type: "S",
             name: "",
-            line1: "",
-            line2: "",
+            street_name: "",
+            building_number: "",
             postal_code: "",
             town: "",
             country: "",
@@ -80,7 +80,7 @@ module QRParams
     if params.dig(:bill_params, :currency) == "" || params.dig(:bill_params, :currency) == nil
       raise ArgumentError, "#{QRExceptions::INVALID_PARAMETERS}: currency cannot be blank"
     end
-
+ 
     true
   end
 

data/lib/qr-bills.rb

@@ -26,10 +26,41 @@ module QRBills
     { params: qr_params, output: output }
   end
 
+  # 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
+  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
+
   def self.create_creditor_reference(reference)
     QRCreditorReference.create(reference)
   end
 
+  # ESR reference should be considered "deprecated" and is here for backward compatibility
+  # This is based on: http://sahits.ch/blog/blog/2007/11/08/uberprufen-esr-referenz-nummer/
+  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
+
   def self.get_qr_params
     QRParams.get_qr_params
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qr-bills
 version: !ruby/object:Gem::Version
-  version: 1.0.10
+  version: 2.0.0
 platform: ruby
 authors:
 - Damiano Radice
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-07 00:00:00.000000000 Z
+date: 2026-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -134,7 +134,7 @@ files:
 - web/assets/images/swiss_cross.svg
 homepage: https://github.com/damoiser/qr-bills
 licenses:
-- MIT
+- BSD-3-Clause
 metadata:
   bug_tracker_uri: https://github.com/damoiser/qr-bills/issues
   changelog_uri: https://github.com/damoiser/qr-bills/CHANGELOG.md
@@ -150,14 +150,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.1
+      version: 3.2.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: QR-bills support for swiss payments