https://github.com/marcoroth/swiss_qr_bill
A Ruby Gem for reading and parsing Swiss QR-Bills from documents like PDFs and images.
https://github.com/marcoroth/swiss_qr_bill
Last synced: 6 months ago
JSON representation
A Ruby Gem for reading and parsing Swiss QR-Bills from documents like PDFs and images.
- Host: GitHub
- URL: https://github.com/marcoroth/swiss_qr_bill
- Owner: marcoroth
- Created: 2024-12-24T04:12:07.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-12-22T18:53:18.000Z (6 months ago)
- Last Synced: 2025-12-24T07:50:34.494Z (6 months ago)
- Language: Ruby
- Homepage:
- Size: 4.43 MB
- Stars: 17
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 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`](https://github.com/damoiser/qr-bills) and [`prawn-swiss_qr_bill`](https://github.com/mitosch/prawn-swiss_qr_bill) gems.
## 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
```
#### 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:
You can read out it's information using:
```ruby
require "swiss_qr_bill"
qr_bills = SwissQRBill.parse_file("path/to/invoice.pdf")
qr_bills.first
# =>
# #,
# creditor_information=#,
# creditor=#,
# ulimate_creditor=#,
# debtor=#,
# payment_amount_information=#,
# payment_reference=#,
# trailer=#,
# additional_information=#,
# raw=[...]
# >
qr_bills.first.creditor
# =>
# #
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).