swiss_qr_bill 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f994168de5ab5bb925c716de6341de11fb79c403641858e94552a7576ab20ab1
+  data.tar.gz: 57e759c4076e09e3ec2ff556eb1d22c084d1788a1b5154ccf2d3eb390d0f2132
+SHA512:
+  metadata.gz: 28c74f4a36ecc862d27305720b4183d8ee065f31858017ecf9831b079d8b6cb72d934ada97b23400626b0858188963452dc9b3a0017d1ff72615f50b957260ca
+  data.tar.gz: d42289f1e25ed4d2166ae713af67b6fcea4290d9f22444d48ba64a25e1ed9ca6316df2bbad637bf2837d6e003e81bce5e5f0e8ed832cd83a2b0d4cfc50898d17

data/.node-version

@@ -0,0 +1 @@
+22.11.0

data/.rubocop.yml

@@ -0,0 +1,39 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.2
+  SuggestExtensions: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/NumericLiteralPrefix:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Max: 10
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+Metrics/MethodLength:
+  Max: 20
+  Exclude:
+    - "test/**/*"
+
+Layout/LineLength:
+  Max: 200
+
+Lint/ConstantDefinitionInBlock:
+  Exclude:
+    - lib/swiss_qr_bill/qr_bill.rb

data/.yarnrc

@@ -0,0 +1 @@
+--ignore-engines true

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-12-24
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at marco.roth@intergga.ch. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/README.md

@@ -0,0 +1,84 @@
+# SwissQRBill
+
+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).
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add swiss_qr_bill
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install swiss_qr_bill
+```
+
+Install the required NPM packages:
+
+```bash
+yarn add @andreekeberg/imagedata pdf-to-png-converter jsqr
+```
+
+## Usage
+
+```ruby
+require "swiss_qr_bill"
+
+qr_bills = SwissQRBill.parse_file("path/to/invoice.pdf")
+
+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">,
+#    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">,
+#    payment_reference=#<data SwissQRBill::QRBill::PaymentReference type="QRR", reference="000008207791225857421286694", additional_information="Premium calculation July 2020">,
+#    trailer=#<data SwissQRBill::QRBill::Trailer trailer="EPD">,
+#    additional_information=#<data SwissQRBill::QRBill::AdditionalInformation billing_information=nil, av1=nil, av2=nil>,
+#    raw=[...]
+#   >
+
+qr_bills.first.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"
+#  >
+
+qr_bills.first.to_s
+# => "SPC\n0200\n1\nCH6431961000004421557\nS\nHealth insurance fit&kicking\nAm Wasser\n1\n3000\nBern\nCH\n\n\n\n\n\n\n\n111.0\nCHF\nS\nSarah Beispiel\nMustergasse\n1\n3600\nThun\nCH\nQRR\n000008207791225857421286694\nPremium calculation July 2020\nEPD\n\n\n"
+```
+
+## Additional Information
+
+#### Specification
+
+* [Swiss Implementation Guidelines for the QR-bill](https://www.six-group.com/dam/download/banking-services/standardization/qr-bill/ig-qr-bill-v2.2-en.pdf)
+* [Six Download Center (For sample data, specifications, and more)](https://www.six-group.com/en/products-services/banking-services/payment-standardization/downloads-faq/download-center.html)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/marcoroth/swiss_qr_bill. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/marcoroth/swiss_qr_bill/blob/main/CODE_OF_CONDUCT.md).
+
+## Code of Conduct
+
+Everyone interacting in the SwissQRBill project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/marcoroth/swiss_qr_bill/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+task default: %i[test]

data/lib/swiss_qr_bill/qr_bill.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module SwissQRBill
+  class QRBill < Data.define(:header, :creditor_information, :creditor, :ulimate_creditor, :debtor, :payment_amount_information, :payment_reference, :trailer, :additional_information, :raw) # rubocop:disable Style/DataInheritance
+    Header = Data.define(:qr_type, :version, :coding_type)
+    CreditorInformation = Data.define(:iban)
+    PaymentReference = Data.define(:type, :reference, :additional_information)
+    Trailer = Data.define(:trailer)
+
+    PaymentAmountInformation = Data.define(:amount, :currency) do
+      def initialize(amount:, currency:)
+        super(amount: amount.to_f, currency:)
+      end
+    end
+
+    CombinedAddress = Data.define(:type, :name, :line1, :line2, :country) do
+      def street = line1
+      def building_number = line1
+      def postal_code = line2
+      def town = line2
+    end
+
+    StructuredAddress = Data.define(:type, :name, :street, :building_number, :postal_code, :town, :country) do
+      def line1 = "#{street} #{building_number}"
+      def line2 = "#{postal_code} #{town}"
+    end
+
+    class Address
+      def self.new(*data)
+        case data[0]
+        when "K"
+          CombinedAddress.new(
+            type: data[0],
+            name: data[1],
+            line1: data[2],
+            line2: data[3],
+            country: data[6]
+          )
+        when "S"
+          StructuredAddress.new(*data)
+        else
+          raise %(Unknown Address type: "#{data[0]}") unless data.map(&:empty?).reduce(:&)
+
+          StructuredAddress.new(*data)
+        end
+      end
+    end
+
+    AdditionalInformation = Data.define(:billing_information, :av1, :av2) do
+      def initialize(billing_information: nil, av1: nil, av2: nil)
+        super
+      end
+    end
+
+    REGIONS = {
+      00..02 => [:header, Header],
+      03..03 => [:creditor_information, CreditorInformation],
+      04..10 => [:creditor, Address],
+      11..17 => [:ulimate_creditor, Address],
+      18..19 => [:payment_amount_information, PaymentAmountInformation],
+      20..26 => [:debtor, Address],
+      27..29 => [:payment_reference, PaymentReference],
+      30..30 => [:trailer, Trailer],
+      31..33 => [:additional_information, AdditionalInformation]
+    }.freeze
+
+    def to_raw_data
+      [
+        header,
+        creditor_information,
+        creditor,
+        ulimate_creditor,
+        payment_amount_information,
+        debtor,
+        payment_reference,
+        trailer,
+        additional_information
+      ].flat_map(&:deconstruct).map(&:to_s)
+    end
+
+    def to_s
+      to_raw_data.join("\n")
+    end
+  end
+end

data/lib/swiss_qr_bill/qr_bill_parser.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module SwissQRBill
+  class QRBillParser
+    def self.parse_file(path)
+      detected_codes = QRCodeParser.parse_file(path)
+
+      return [] if detected_codes.empty?
+
+      detected_codes.map { |code| parse(code) }
+    end
+
+    def self.parse(data)
+      case data
+      when String
+        data = if data.count("\r").positive?
+                 data.split("\r\n")
+               else
+                 data.split("\n")
+               end
+      when Array
+        # ok
+      else
+        raise "Unsupported data argument type. Expected data argument of type Array or String, got: #{data.class}"
+      end
+
+      raise "Unsupported data length. Data object must have at least 31 entries. Found: #{data.length}" if data.length < 31
+      raise "Unsupported QRType: #{data[0]}" if data[0] != "SPC"
+      raise "Unsupported Version: #{data[1]}" if data[1] != "0200"
+      raise "Unsupported Coding: #{data[2]}" if data[2] != "1"
+
+      regions = QRBill::REGIONS.to_h { |range, (key, klass)| [key, klass.new(*data[range])] }
+
+      QRBill.new(
+        raw: data,
+        **regions
+      )
+    end
+  end
+end

data/lib/swiss_qr_bill/qr_code_parser.rb

@@ -0,0 +1,55 @@
+# 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/lib/swiss_qr_bill/version.rb

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

data/lib/swiss_qr_bill.rb

@@ -0,0 +1,13 @@
+# 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"
+
+module SwissQRBill
+  def self.parse_file(...)
+    QRBillParser.parse_file(...)
+  end
+end

data/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "swiss_qr_bill",
+  "private": true,
+  "author": "Marco Roth <marco.roth@intergga.ch>",
+  "license": "MIT",
+  "dependencies": {
+    "@andreekeberg/imagedata": "^1.0.2",
+    "jsqr": "^1.4.0",
+    "pdf-to-png-converter": "^3.6.3"
+  }
+}

data/sig/swiss_qr_bill.rbs

@@ -0,0 +1,4 @@
+module SwissQRBill
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/swiss_qr_bill.gemspec

@@ -0,0 +1,34 @@
+# 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