qr-bills 0.2.2 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 673b6c6cd7948ecf8121a1cff9462c6d60a7c8b1022078fae2eb463919885dc7
-  data.tar.gz: 765e8d32630c70b9b8441e0cc8613821ba8e683bd9324293adc3ebdea4ec785d
+  metadata.gz: dc357870d91f0b58fb6ea0895b8093cdff66fe9488080263cf9c50600b7bfb66
+  data.tar.gz: a1239f2e9aa5e25ddf01db1c8d1372be14809bf69b7a877074c9fd70c07e5780
 SHA512:
-  metadata.gz: bcb1a9f90fae5d55d14d2452212a47a29fa6049e9f1f86cc9ed682824424614a5909095b69aa0adc4f2b8d1f092fcc9fd56316b8742c559ba571acaaaba7a282
-  data.tar.gz: 58723203eeb46a9948ed5d37fcb35603c2e6abb7a294d351c30c7f3e26629fc0a4eecfd493aa947cef794a25fdc56c6a73432f57be3a373ce5c9fe2146c1b28d
+  metadata.gz: c950153805c26782e33f8a029b35a2610f6b5ac9030718836fb8bb06657d1d157ae6bf73dcfdb48e7ad796e21af006518cfb2cde15dc501adfdecb78f3ced28a
+  data.tar.gz: a995e3a5e7d45d6050214107d0f5db07937055e9db5daf204ba1550152a59cdb6b8f9417a512efc4618e2f79fcf8d79f98191d53431d63a198bb60fbc6d4f261

data/config/locales/qrbills.fr.yml

@@ -9,9 +9,9 @@ fr:
     currency: monnaie
     amount: montant
     receipt: récépissé
-    acceptance_point: èpomt de dépôt
+    acceptance_point: point de dépôt
     separate_before_paying_in: à détacher avant le versement
     payable_by: payable par
     payable_by_name_addr: payable par (nom/adresse)
     in_favour_of: en faveur de
-    name: name
+    name: name

data/lib/qr-bills/qr-creditor-reference.rb

@@ -1,9 +1,10 @@
 require 'qr-bills/qr-exceptions'
 
 # implement Creditor Reference ISO 11649 generator
-class QRCreditorReference
+module QRCreditorReference
   PREFIX = "RF"
 
+  # chars values to calculate the check code
   @char_values = {
     "A": 10,
     "B": 11,
@@ -56,6 +57,8 @@ class QRCreditorReference
     reference_val += @char_values["R".to_sym].to_s + @char_values["F".to_sym].to_s + "00"
 
     # get check code
+    # when performing the validation of the check code (n % 97) 
+    # the remainder must be equal to 1, thus the 98
     check_code = 98 - (reference_val.to_i % 97)
 
     if check_code < 10

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

@@ -1,4 +1,4 @@
-class QRExceptions
+module QRExceptions
   EXCEPTION_PREFIX = "QR-bill"
 
   INVALID_PARAMETERS = EXCEPTION_PREFIX + " invalid parameters"

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

@@ -1,8 +1,6 @@
 require 'rqrcode'
-require 'rmagick'
-include Magick
 
-class QRGenerator
+module QRGenerator
   # payload:
   #  "SPC\r\n" +    # indicator for swiss qr code: SPC (swiss payments code)
   #  "0200\r\n" +   # version of the specifications, 0200 = v2.0
@@ -39,11 +37,6 @@ class QRGenerator
   #  "eBill/B/41010560425610173";                 # alternative scheme paramaters, max 100 chars
  
   def self.create(params, qrcode_path)
-    create_qr(params, qrcode_path)
-    add_swiss_cross(qrcode_path, qrcode_path)
-  end
-
-  def self.create_qr(params, qrcode_path)
     payload = "SPC\r\n"
     payload += "0200\r\n"
     payload += "1\r\n"
@@ -76,7 +69,7 @@ class QRGenerator
     payload += "#{params[:bill_params][:additionally_information]}\r\n"
     payload += "EPD\r\n"
     payload += "#{params[:bill_params][:bill_information_coded]}\r\n"
-    payload += "#{params[:bill_params][:alternative_scheme_paramters]}\r\n"
+    payload += "#{params[:bill_params][:alternative_scheme_parameters]}\r\n"
 
     qrcode = RQRCode::QRCode.new(payload)
 
@@ -93,13 +86,8 @@ class QRGenerator
       size: 1024,
     )
 
-    IO.binwrite(qrcode_path, png.to_s)
-  end
-
-  def self.add_swiss_cross(qrcode_path, final_path)
-    qr_image    = Image.read(qrcode_path)[0]
-    swiss_cross = Image.read(File.expand_path("#{File.dirname(__FILE__)}/../../web/assets/images/swiss_cross.png"))[0]
-    final_qr    = qr_image.composite(swiss_cross, CenterGravity, OverCompositeOp)
-    final_qr.write(final_path)
+    swiss_cross = ChunkyPNG::Image.from_file(File.expand_path("#{File.dirname(__FILE__)}/../../web/assets/images/swiss_cross.png"))
+    final_qr    = png.compose!(swiss_cross, (png.width - swiss_cross.width) / 2,  (png.height - swiss_cross.height) / 2)
+    final_qr.save(qrcode_path)
   end
 end

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

@@ -1,6 +1,6 @@
 require 'qr-bills/qr-generator'
 
-class QRHTMLLayout
+module QRHTMLLayout
 
   def self.create(params)
     QRGenerator.create(params, params[:qrcode_filepath])
@@ -8,6 +8,7 @@ class QRHTMLLayout
   end
 
   def self.html_layout(params)
+    I18n.locale = params[:bill_params][:language]
     layout  = "<div class=\"bill_container\">\n"
     layout += "  <div class=\"receipt_section\">\n"
     layout += "    <div class=\"title\">#{I18n.t("qrbills.receipt").capitalize}</div>\n"
@@ -74,8 +75,8 @@ class QRHTMLLayout
     layout += "        <span class=\"finfo_header\">#{I18n.t("qrbills.name").capitalize} AV1:</span> #{params[:bill_params][:bill_information_coded]}\n"
     end
   
-    if !params[:bill_params][:alternative_scheme_paramters].nil? && !params[:bill_params][:alternative_scheme_paramters].empty?
-    layout += "        <span class=\"finfo_header\">#{I18n.t("qrbills.name").capitalize} AV2:</span> #{params[:bill_params][:alternative_scheme_paramters]}\n"
+    if !params[:bill_params][:alternative_scheme_parameters].nil? && !params[:bill_params][:alternative_scheme_parameters].empty?
+    layout += "        <span class=\"finfo_header\">#{I18n.t("qrbills.name").capitalize} AV2:</span> #{params[:bill_params][:alternative_scheme_parameters]}\n"
     end
 
     layout += "      </div>\n"
@@ -232,4 +233,4 @@ class QRHTMLLayout
 
     return layout
   end
-end
+end

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

@@ -1,7 +1,7 @@
-class QRParams
+module QRParams
   QR_BILL_WITH_QR_REFERENCE       = "orange_with_reference"
   QR_BILL_WITH_CREDITOR_REFERENCE = "red_with_reference"
-  QR_BILL_WITOUTH_REFERENCE       = "red_without_reference"
+  QR_BILL_WITHOUT_REFERENCE       = "red_without_reference"
 
   def self.get_qr_params
     {
@@ -24,7 +24,7 @@ class QRParams
         reference: "", # qr reference or creditor reference (iso-11649)
         additionally_information: "",
         bill_information_coded: "",
-        alternative_scheme_paramters: "",
+        alternative_scheme_parameters: "",
         creditor: {
           address: {
             type: "S",
@@ -56,43 +56,70 @@ class QRParams
   end
 
   def self.valid?(params)
-    if params.has_key?(:bill_type)
+    return false unless params.key?(:bill_type)
+    return false unless QRParams.base_params_valid?(params)
 
-      if !QRParams.base_params_valid?(params)
-        return false
-      end
-
-      if params[:bill_type] == QR_BILL_WITH_QR_REFERENCE
-        return QRParams.qr_bill_with_qr_reference_valid?(params)
-      elsif params[:bill_type] == QR_BILL_WITH_CREDITOR_REFERENCE
-        return QRParams.qr_bill_with_creditor_reference_valid?(params)
-      elsif params[:bill_type] == QR_BILL_WITOUTH_REFERENCE
-        return QRParams.qr_bill_without_reference_valid?(params)
-      else
-        return false
-      end
+    case params[:bill_type]
+    when QRParams::QR_BILL_WITH_QR_REFERENCE
+      QRParams.qr_bill_with_qr_reference_valid?(params)
+    when QRParams::QR_BILL_WITH_CREDITOR_REFERENCE
+      QRParams.qr_bill_with_creditor_reference_valid?(params)
+    when QRParams::QR_BILL_WITHOUT_REFERENCE
+      QRParams.qr_bill_without_reference_valid?(params)
     else
-      return false
+      false
     end
   end
-
+  
   def self.base_params_valid?(params)
-    # todo
-    return true
+    if params[:bill_type] == "" || params[:bill_type] == nil
+      raise ArgumentError, "#{QRExceptions::INVALID_PARAMETERS}: bill type cannot be blank"
+    end
+
+    if params[:qrcode_filepath] == "" || params[:qrcode_filepath] == nil
+      raise ArgumentError, "#{QRExceptions::INVALID_PARAMETERS}: qrcode_filepath cannot be blank"
+    end
+
+    if params[:bill_params][:currency] == "" || params[:bill_params][:currency] == nil
+      raise ArgumentError, "#{QRExceptions::INVALID_PARAMETERS}: currency cannot be blank"
+    end
+
+    true
   end
 
   def self.qr_bill_with_qr_reference_valid?(params)
-    # todo
-    return true
+    if params[:bill_params][:reference_type] != "QRR"
+      raise ArgumentError, "#{QRExceptions::INVALID_PARAMETERS}: reference type must be 'QRR' for QR bill with standard reference"
+    end
+    
+    if params[:bill_params][:reference] == "" || params[:bill_params][:reference] == nil
+      raise ArgumentError, "#{QRExceptions::INVALID_PARAMETERS}: reference cannot be blank for QR bill with standard reference"
+    end
+
+    true
   end
 
   def self.qr_bill_with_creditor_reference_valid?(params)
-    # todo
-    return true
+    if params[:bill_params][:reference_type] != "SCOR"
+      raise ArgumentError, "#{QRExceptions::INVALID_PARAMETERS}: reference type must be 'SCOR' for QR bill with (new) creditor reference"
+    end
+    
+    if params[:bill_params][:reference] == "" || params[:bill_params][:reference] == nil
+      raise ArgumentError, "#{QRExceptions::INVALID_PARAMETERS}: reference cannot be blank for QR bill with (new) creditor reference"
+    end
+
+    true
   end
 
   def self.qr_bill_without_reference_valid?(params)
-    # todo
-    return true
+    if params[:bill_params][:reference_type] != "NON"
+      raise ArgumentError, "#{QRExceptions::INVALID_PARAMETERS}: reference type must be 'NON' for QR bill without reference"
+    end
+    
+    if params[:bill_params][:reference] != ""
+      raise ArgumentError, "#{QRExceptions::INVALID_PARAMETERS}: reference must be blank for QR bill without reference"
+    end
+  
+    true
   end
 end

data/lib/qr-bills.rb

@@ -4,41 +4,32 @@ require 'qr-bills/qr-params'
 require 'qr-bills/qr-html-layout'
 require 'qr-bills/qr-creditor-reference'
 
-class QRBills
+module QRBills
   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)
 
-    # params validation
-    if qr_params.has_key?(:bill_type)
-
-      if !QRParams.valid?(qr_params)
-        raise QRExceptions::INVALID_PARAMETERS + ": params validation check failed"
-      end
+    # init translator sets
+    %i[it en de fr].each do |locale|
+      locale_file = File.join(qr_params[:locales][:path], "qrbills.#{locale}.yml")
 
-      if !qr_params[:output_params][:format] == "html"
-        raise QRExceptions::NOT_SUPPORTED + ": html is the only output format supported so far"
-      end
+      I18n.load_path << locale_file
+    end
 
+    output = case qr_params[:output_params][:format]
+    when 'html'
+      QRHTMLLayout.create(qr_params)
+    when 'qrcode_png'
+      QRGenerator.create(qr_params, qr_params[:qrcode_filepath])
     else
-      raise QRExceptions::INVALID_PARAMETERS + ": bill type param not set"
+      raise ArgumentError, "#{QRExceptions::NOT_SUPPORTED}: #{qr_params[:output_params][:format]} is not yet supported"
     end
 
-    # init translator sets
-    I18n.load_path << File.join(qr_params[:locales][:path], "qrbills.it.yml")
-    I18n.load_path << File.join(qr_params[:locales][:path], "qrbills.en.yml")
-    I18n.load_path << File.join(qr_params[:locales][:path], "qrbills.de.yml")
-    I18n.load_path << File.join(qr_params[:locales][:path], "qrbills.fr.yml")
-    I18n.default_locale = :it
-
-    bill = { 
-      params: qr_params,
-      output: QRHTMLLayout.create(qr_params) 
-    }
-
-    return bill
+    { params: qr_params, output: output }
   end
 
   def self.create_creditor_reference(reference)
-    return QRCreditorReference.create(reference)
+    QRCreditorReference.create(reference)
   end
 
   def self.get_qr_params
@@ -54,6 +45,6 @@ class QRBills
   end
 
   def self.get_qrbill_without_reference_type
-    QRParams::QR_BILL_WITOUTH_REFERENCE
+    QRParams::QR_BILL_WITHOUT_REFERENCE
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qr-bills
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 1.0.2
 platform: ruby
 authors:
 - Damiano Radice
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-11 00:00:00.000000000 Z
+date: 2021-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -50,26 +50,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '2'
-- !ruby/object:Gem::Dependency
-  name: rmagick
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.1.2
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.1.2
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -100,7 +80,7 @@ dependencies:
         version: '13.0'
 description: 'QR-bills support for swiss payments, for full documentation please refer
   to github repo: https://github.com/damoiser/qr-bills'
-email: damoiser+qrbill@gmail.com
+email: dam.radice@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -133,7 +113,7 @@ metadata:
   homepage_uri: https://github.com/damoiser/qr-bills
   source_code_uri: https://github.com/damoiser/qr-bills
   wiki_uri: https://github.com/damoiser/qr-bills
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -149,7 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: QR-bills support for swiss payments
 test_files: []