swiss_qr_bill 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f994168de5ab5bb925c716de6341de11fb79c403641858e94552a7576ab20ab1
-  data.tar.gz: 57e759c4076e09e3ec2ff556eb1d22c084d1788a1b5154ccf2d3eb390d0f2132
+  metadata.gz: de84a5080c04ece3528f8e0ac793f1517e5e01d16d94f6e80b87e84e0d5ee877
+  data.tar.gz: 6f5602368bc17d25dae9281cedc55d59c7e157101c2ac8b6bb039e187384cdb1
 SHA512:
-  metadata.gz: 28c74f4a36ecc862d27305720b4183d8ee065f31858017ecf9831b079d8b6cb72d934ada97b23400626b0858188963452dc9b3a0017d1ff72615f50b957260ca
-  data.tar.gz: d42289f1e25ed4d2166ae713af67b6fcea4290d9f22444d48ba64a25e1ed9ca6316df2bbad637bf2837d6e003e81bce5e5f0e8ed832cd83a2b0d4cfc50898d17
+  metadata.gz: a585399a6e03872554b1b1231a53dbaf05a3b66b0d42d7162097bb0f39d869d9a910f54591c5a8613fe123b781f49b81bb8681a65463fbee7085181ebc3098d3
+  data.tar.gz: 473c039954d34a22b72b7067e61c67a8f4e24de80d21b04c0315f1ae7b8b3b5d204858b6927b61bd31e65cc03aa5c856eb5a84063995e46592448000d3b938ce

data/.ruby-version

@@ -0,0 +1 @@
+4.0.0

data/README.md

@@ -2,7 +2,7 @@
 
 A Ruby Gem for reading and parsing Swiss QR-Bills from documents like PDFs and images.
 
-This gem is meant for reading and parsing Swiss QR-Bill codes out of documents, if you are looking to generate Swiss QR-Bills check out the [`qr-bills` gem](https://github.com/damoiser/qr-bills).
+This gem is meant for reading and parsing Swiss QR-Bill codes out of documents, if you are looking to generate Swiss QR-Bills check out the [`qr-bills`](https://github.com/damoiser/qr-bills) and [`prawn-swiss_qr_bill`](https://github.com/mitosch/prawn-swiss_qr_bill) gems.
 
 ## Installation
 
@@ -24,8 +24,21 @@ Install the required NPM packages:
 yarn add @andreekeberg/imagedata pdf-to-png-converter jsqr
 ```
 
+#### Note
+
+This gem is built on top of the [`jsQR`](https://github.com/cozmo/jsQR) NPM package, which means you need to be running [Node.js](https://nodejs.org/en). We utilize the [`nodo`](https://github.com/mtgrosser/nodo) gem for calling out to Node.js.
+
+TL;DR: as long as you have Node.js installed and the above listed NPM packages installed you shouldn't notice that it's calling out to Node.js.
+
+
 ## Usage
 
+Given the following QR-Bill:
+
+![](https://github.com/marcoroth/swiss_qr_bill/blob/main/test/fixtures/muster-qr-zahlteile-en/Nr.%201%20englisch.jpg?raw=true)
+
+You can read out it's information using:
+
 ```ruby
 require "swiss_qr_bill"
 
@@ -36,7 +49,7 @@ qr_bills.first
 #  #<data SwissQRBill::QRBill
 #    header=#<data SwissQRBill::QRBill::Header qr_type="SPC", version="0200", coding_type="1">,
 #    creditor_information=#<data SwissQRBill::QRBill::CreditorInformation iban="CH6431961000004421557">,
-#    creditor= #<data SwissQRBill::QRBill::StructuredAddress type="S", name="Health insurance fit&kicking", street="Am Wasser", building_number="1", postal_code="3000", town="Bern", country="CH">,
+#    creditor=#<data SwissQRBill::QRBill::StructuredAddress type="S", name="Health insurance fit&kicking", street="Am Wasser", building_number="1", postal_code="3000", town="Bern", country="CH">,
 #    ulimate_creditor=#<data SwissQRBill::QRBill::StructuredAddress type="", name="", street="", building_number="", postal_code="", town="", country="">,
 #    debtor=#<data SwissQRBill::QRBill::StructuredAddress type="S", name="Sarah Beispiel", street="Mustergasse", building_number="1", postal_code="3600", town="Thun", country="CH">,
 #    payment_amount_information=#<data SwissQRBill::QRBill::PaymentAmountInformation amount=111.0, currency="CHF">,

data/lib/swiss_qr_bill/qr_bill_parser.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
+require "qr_code_scanner"
+
 module SwissQRBill
   class QRBillParser
     def self.parse_file(path)
-      detected_codes = QRCodeParser.parse_file(path)
+      detected_codes = QRCodeScanner.scan(path)
 
       return [] if detected_codes.empty?
 

data/lib/swiss_qr_bill/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SwissQRBill
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/swiss_qr_bill.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
 require_relative "swiss_qr_bill/version"
-require_relative "swiss_qr_bill/qr_code_parser"
-
 require_relative "swiss_qr_bill/qr_bill"
 require_relative "swiss_qr_bill/qr_bill_parser"
 

data/yarn.lock

@@ -12,9 +12,9 @@
     mime-kind "^3.0.0"
 
 "@babel/runtime@^7.7.2":
-  version "7.26.0"
-  resolved "https://registry.yarnpkg.com/@babel/runtime/-/runtime-7.26.0.tgz#8600c2f595f277c60815256418b85356a65173c1"
-  integrity sha512-FDSOghenHTiToteC/QRlv2q3DhPZ/oOXTBoirfWNx1Cx3TMVcGWQtMMmQcSvb/JjpNeGzx8Pq/b4fKEJuWm1sw==
+  version "7.26.10"
+  resolved "https://registry.yarnpkg.com/@babel/runtime/-/runtime-7.26.10.tgz#a07b4d8fa27af131a633d7b3524db803eb4764c2"
+  integrity sha512-2WJMeRQPHKSPemqk/awGrAiuFfzBmOIPXKizAsVhWH9YJqLZ0H+HS4c8loHGgW6utJ3E/ejXQUsiGaQy2NZ9Fw==
   dependencies:
     regenerator-runtime "^0.14.0"
 
@@ -559,9 +559,9 @@ mime@^1.3.4:
   integrity sha512-x0Vn8spI+wuJ1O6S7gnbaQg8Pxh4NNHb7KSINmEWKiPE4RKOplvijn+NkmYmmRgP68mc70j2EbeTFRsrswaQeg==
 
 min-document@^2.19.0:
-  version "2.19.0"
-  resolved "https://registry.yarnpkg.com/min-document/-/min-document-2.19.0.tgz#7bd282e3f5842ed295bb748cdd9f1ffa2c824685"
-  integrity sha512-9Wy1B3m3f66bPPmU5hdA4DR4PB2OfDU/+GS3yAB7IQozE3tqXaVv2zOjgla7MEGSRv95+ILmOuvhLkOK6wJtCQ==
+  version "2.19.2"
+  resolved "https://registry.yarnpkg.com/min-document/-/min-document-2.19.2.tgz#f95db44639eaae3ac8ea85ae6809ae85ff7e3b81"
+  integrity sha512-8S5I8db/uZN8r9HSLFVWPdJCvYOejMcEC82VIzNUc6Zkklf/d1gg2psfE79/vyhWOj4+J8MtwmoOz3TmvaGu5A==
   dependencies:
     dom-walk "^0.1.0"
 

metadata

@@ -1,29 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: swiss_qr_bill
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Marco Roth
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-24 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: nodo
+  name: qr_code_scanner
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.1'
 description: A Ruby Gem for reading and parsing Swiss QR-Bills from documents.
 email:
 - marco.roth@intergga.ch
@@ -33,6 +32,7 @@ extra_rdoc_files: []
 files:
 - ".node-version"
 - ".rubocop.yml"
+- ".ruby-version"
 - ".yarnrc"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -41,11 +41,9 @@ files:
 - lib/swiss_qr_bill.rb
 - lib/swiss_qr_bill/qr_bill.rb
 - lib/swiss_qr_bill/qr_bill_parser.rb
-- lib/swiss_qr_bill/qr_code_parser.rb
 - lib/swiss_qr_bill/version.rb
 - package.json
 - sig/swiss_qr_bill.rbs
-- swiss_qr_bill.gemspec
 - yarn.lock
 homepage: https://github.com/marcoroth/swiss_qr_bill
 licenses: []
@@ -54,7 +52,6 @@ metadata:
   rubygems_mfa_required: 'true'
   source_code_uri: https://github.com/marcoroth/swiss_qr_bill
   changelog_uri: https://github.com/marcoroth/swiss_qr_bill/blob/main/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -69,8 +66,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.5
-signing_key:
+rubygems_version: 4.0.3
 specification_version: 4
 summary: A Ruby Gem for reading and parsing Swiss QR-Bills from documents.
 test_files: []

data/lib/swiss_qr_bill/qr_code_parser.rb

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-require "nodo"
-
-module SwissQRBill
-  class QRCodeParser < Nodo::Core
-    require fs: "node:fs"
-    require path: "node:path"
-
-    require jsQR: "jsqr"
-    require pdfToPng: "pdf-to-png-converter"
-    require imagedata: "@andreekeberg/imagedata"
-
-    def self.parse_file(path)
-      if path.end_with?(".pdf")
-        new.parse_pdf(path)
-      else
-        [new.parse_image(path)]
-      end
-    end
-
-    function :parse_image, <<~JS
-      (imagePath) => {
-        const { data, width, height } = imagedata.getSync(imagePath)
-
-        return jsQR(data, width, height)?.data
-      }
-    JS
-
-    function :parse_pdf, <<~JS
-      async (pdfPath) => {
-        const filename = path.basename(pdfPath)
-
-        const pages = await pdfToPng.pdfToPng(pdfPath, { // The function accepts PDF file path or a Buffer
-          disableFontFace: false, // When `false`, fonts will be rendered using a built-in font renderer that constructs the glyphs with primitive path commands. Default value is true.
-          // useSystemFonts: false, // When `true`, fonts that aren't embedded in the PDF document will fallback to a system font. Default value is false.
-          // enableXfa: false, // Render Xfa forms if any. Default value is false.
-          viewportScale: 3.0, // The desired scale of PNG viewport. Default value is 1.0.
-          outputFolder: 'tmp/swiss_qr_bill', // Folder to write output PNG files. If not specified, PNG output will be available only as a Buffer content, without saving to a file.
-          outputFileMaskFunc: (page) => `${filename}_page_${page}.png`, // Function to generate custom output filenames. Example: (pageNum) => `page_${pageNum}.png`
-          // pdfFilePassword: 'pa$$word', // Password for encrypted PDF.
-          // pagesToProcess: [1, 3, 11], // Subset of pages to convert (first page = 1), other pages will be skipped if specified.
-          // strictPagesToProcess: false, // When `true`, will throw an error if specified page number in pagesToProcess is invalid, otherwise will skip invalid page. Default value is false.
-          // verbosityLevel: 0 // Verbosity level. ERRORS: 0, WARNINGS: 1, INFOS: 5. Default value is 0.
-        })
-
-        const result = pages.map(page => parse_image(page.path))
-
-        pages.map(page => fs.unlinkSync(page.path)) // cleanup generated images
-
-        return result.filter(result => result)
-      }
-    JS
-  end
-end

data/swiss_qr_bill.gemspec

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/swiss_qr_bill/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "swiss_qr_bill"
-  spec.version = SwissQRBill::VERSION
-  spec.authors = ["Marco Roth"]
-  spec.email = ["marco.roth@intergga.ch"]
-
-  spec.summary = "A Ruby Gem for reading and parsing Swiss QR-Bills from documents."
-  spec.description = spec.summary
-  spec.homepage = "https://github.com/marcoroth/swiss_qr_bill"
-  spec.required_ruby_version = ">= 3.2.0"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["rubygems_mfa_required"] = "true"
-  spec.metadata["source_code_uri"] = "https://github.com/marcoroth/swiss_qr_bill"
-  spec.metadata["changelog_uri"] = "https://github.com/marcoroth/swiss_qr_bill/blob/main/CHANGELOG.md"
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (File.expand_path(f) == __FILE__) ||
-        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile])
-    end
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_dependency "nodo"
-end