ips_qr_code 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 649400ee3e1c0ec1fac491f622e0affb57842d52d1935cd0c8bb7c76966729e4
+  data.tar.gz: d1ae5032032398103ddbb2fddf002b497526ee272f94e440fde9c215c06fcdb3
+SHA512:
+  metadata.gz: 977c5c6c6b2be6910250e8462f68233f2694a503725d4f418bfa3c946b6b67c9c0146d37219f6e2032dcc85b2bce183f9f44e49ac0eb23d318a7234403187267
+  data.tar.gz: 69a37eb75a36c7ed5f6a29dd3a52ae5cbc9a51296666c2392eb0269f9eec711cfb0432983e9bf507f7e0ca21b19796690d6fa4d657e93263498e9502fce3cbb2

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 ArtBIT
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+# IPS QR Code Generator (Ruby)
+
+Gem to generate IPS QR code formatted strings.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ips_qr_code'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install ips_qr_code
+
+## Usage
+
+```ruby
+require 'ips_qr_code'
+
+data = IpsQrCode.generate(
+  r: '845000000014284968',                  # racun primaoca
+  n: 'EPS Snabdevanje 11000 Beograd',       # naziv primaoca
+  sf: '221',                                # sifra placanja
+  i: 'RSD1000,00'                           # iznos
+  # optional:
+  # k: 'PR',                                # kod
+  # v: '01',                                # verzija
+  # c: '1',                                 # kodni raspored
+  # o: '200000000012345600',                # racun platioca
+  # p: 'Marko Markovic',                    # naziv platioca
+  # s: 'Uplata po racunu',                  # svrha placanja
+  # m: '1234',                              # merchantCodeCategory
+  # js: '12345',                            # jednokratnaSifra
+  # ro: '97123456789',                      # pozivNaBroj
+  # rl: 'ref primaoca',                     # referencaPrimaoca
+  # rp: '1234567890123456789'               # referencaPlacanja
+)
+puts data
+```
+
+### CLI
+
+```bash
+$ ips-qr-code --racun-primaoca 845000000014284968 \
+    --naziv-primaoca "EPS Snabdevanje 11000 Beograd" \
+    --sifra-placanja 221 \
+    --iznos RSD1000,00
+# => K:PR|V:01|C:1|R:845000000014284968|N:EPS Snabdevanje...
+```

data/bin/ips-qr-code

@@ -0,0 +1,87 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'ips_qr_code'
+require 'rqrcode'
+
+options = {}
+to_file = nil
+parser = OptionParser.new do |opts|
+  opts.banner = "Usage: ips-qr-code [options]"
+
+  opts.on("--kod K", "Kod (PR, PT, PK, EK)") { |v| options[:k] = v }
+  opts.on("--verzija V", "Verzija (01)") { |v| options[:v] = v }
+  opts.on("--kodni-raspored C", "Kod raspored (1)") { |v| options[:c] = v }
+  opts.on("--racun-primaoca R", "Broj racuna primaoca") { |v| options[:r] = v }
+  opts.on("--naziv-primaoca N", "Naziv primaoca") { |v| options[:n] = v }
+  opts.on("--racun-platioca O", "Broj racuna platioca") { |v| options[:o] = v }
+  opts.on("--naziv-platioca P", "Naziv platioca") { |v| options[:p] = v }
+  opts.on("--sifra-placanja SF", "Sifra placanja") { |v| options[:sf] = v }
+  opts.on("--iznos I", "Iznos (e.g. RSD1000,00)") { |v| options[:i] = v }
+  opts.on("--svrha-placanja S", "Svrha placanja") { |v| options[:s] = v }
+  opts.on("--merchant-code-category M", "Merchant code category") { |v| options[:m] = v }
+  opts.on("--jednokratna-sifra J", "Jednokratna sifra") { |v| options[:js] = v }
+  opts.on("--poziv-na-broj RO", "Poziv na broj") { |v| options[:ro] = v }
+  opts.on("--referenca-primaoca RL", "Referenca primaoca") { |v| options[:rl] = v }
+  opts.on("--referenca-placanja RP", "Referenca placanja") { |v| options[:rp] = v }
+  opts.on("--to-file FILE", "Save QR code to image file") { |v| to_file = v }
+
+  opts.on("-h", "--help", "Prints this help") do
+    puts opts
+    exit
+  end
+end
+
+begin
+  parser.parse!
+  result = IpsQrCode.generate(options)
+
+  if to_file
+    begin
+      qrcode = RQRCode::QRCode.new(result)
+
+      case File.extname(to_file).downcase
+      when '.png'
+        png = qrcode.as_png(
+          bit_depth: 1,
+          border_modules: 4,
+          color_mode: ChunkyPNG::COLOR_GRAYSCALE,
+          color: 'black',
+          file: nil,
+          fill: 'white',
+          module_px_size: 6,
+          resize_exactly_to: false,
+          resize_gte_to: false,
+          size: 300
+        )
+        IO.binwrite(to_file, png.to_s)
+        puts "QR code saved to #{to_file}"
+      when '.svg'
+        svg = qrcode.as_svg(
+          offset: 0,
+          color: '000',
+          shape_rendering: 'crispEdges',
+          module_size: 6,
+          standalone: true
+        )
+        File.write(to_file, svg)
+        puts "QR code saved to #{to_file}"
+      else
+        puts "Unsupported file format. Use .png or .svg"
+      end
+    rescue => e
+      warn "Error generating QR code: #{e.message}"
+      exit 1
+    end
+  else
+    puts result
+  end
+
+rescue OptionParser::InvalidOption => e
+  warn e.message
+  puts parser
+  exit 1
+rescue ArgumentError => e
+  warn "Error: #{e.message}"
+  exit 1
+end

data/lib/ips_qr_code/utils.rb

@@ -0,0 +1,126 @@
+module IpsQrCode
+  module Utils
+    RENAME_KEYS = {
+      'kod'                   => :k,
+      'verzija'               => :v,
+      'version'               => :v,
+      'characterEncodingType' => :c,
+      'znakovniSkup'          => :c,
+      'racunPrimaoca'         => :r,
+      'nazivPrimaoca'         => :n,
+      'iznos'                 => :i,
+      'nazivPlatioca'         => :p,
+      'sifraPlacanja'         => :sf,
+      'svrhaPlacanja'         => :s,
+      'merchantCodeCategory'  => :m,
+      'jednokratnaSifra'      => :js,
+      'pozivNaBroj'           => :ro,
+      'referencaPrimaoca'     => :rl,
+      'referencaPlacanja'     => :rp
+    }.freeze
+
+    def self.rename_keys(opts)
+      result = {}
+      opts.each do |key, value|
+        key_str = key.to_s
+        new_key = RENAME_KEYS[key_str] || key_str.to_sym
+        result[new_key] = value
+      end
+      result
+    end
+
+    def self.normalize_bank_account(input)
+      numerals = input.to_s.gsub(/\D/, '')
+      bank     = numerals[0,3]
+      control  = numerals[-2,2] || numerals[-2..-1]
+      account  = numerals[3...-2] || ''
+      "#{bank}#{account.rjust(13, '0')}#{control}"
+    end
+
+    def self.modulo(divident, divisor)
+      div     = divident.to_s
+      divisor = divisor.to_i
+      while div.length > 10
+        part = div[0,10].to_i
+        div  = (part % divisor).to_s + div[10..-1]
+      end
+      div.to_i % divisor
+    end
+
+    def self.calculate_bank_account_control_number(input)
+      98 - modulo(input[0...-2] + '00', 97)
+    end
+
+    def self.validate_bank_account(input)
+      normalized        = normalize_bank_account(input)
+      control_number    = normalized[-2,2]
+      calculated_number = calculate_bank_account_control_number(normalized).to_s.rjust(2, '0')
+      control_number == calculated_number
+    end
+
+    def self.validate_reference_number(input)
+      return true if input.nil? || input.to_s.empty?
+      input_str = input.to_s
+      model     = input_str[0,2]
+      case model
+      when '97'
+        sanitized = sanitize97(input_str)
+        control   = sanitized[2,2]
+        poziv     = sanitized[4..-1]
+        control.to_i == mod97(poziv)
+      when '22'
+        sanitized = sanitize22(input_str)
+        poziv     = sanitized[5...-1]
+        control   = sanitized[-1]
+        control.to_i == mod22(poziv)
+      when '00'
+        true
+      else
+        warn "Model #{model} is not supported."
+        true
+      end
+    end
+
+    def self.sanitize97(input)
+      input.to_s.upcase.gsub(/[ \-]/, '').chars.map.with_index do |char, idx|
+        code = char.ord
+        if code.between?(65, 90)
+          (code - 55).to_s
+        elsif code.between?(48, 57)
+          (code - 48).to_s
+        else
+          raise ArgumentError, "Invalid character \"#{char}\" at position #{idx}"
+        end
+      end.join
+    end
+
+    def self.sanitize22(input)
+      input.to_s.gsub(/[ \-]/, '').chars.map.with_index do |char, idx|
+        code = char.ord
+        if code.between?(48, 57)
+          (code - 48).to_s
+        else
+          raise ArgumentError, "Invalid character \"#{char}\" at position #{idx}"
+        end
+      end.join
+    end
+
+    def self.mod97(input)
+      control = 0
+      base    = 100
+      input.to_s.reverse.chars.map(&:to_i).each do |char|
+        control = (control + base * char) % 97
+        base    = (base * 10) % 97
+      end
+      98 - control
+    end
+
+    def self.mod22(input)
+      control = input.to_s.reverse.chars.map(&:to_i).each_with_index.reduce(0) do |sum,(char, idx)|
+        sum + (idx + 1) * char
+      end
+      control = 11 - (control % 11)
+      control % 10
+    end
+  end
+end

data/lib/ips_qr_code/version.rb

@@ -0,0 +1,3 @@
+module IpsQrCode
+  VERSION = '0.1.0'
+end

data/lib/ips_qr_code.rb

@@ -0,0 +1,124 @@
+require 'ips_qr_code/version'
+require 'ips_qr_code/utils'
+
+module IpsQrCode
+  ORDER = %i[k v c r n i sf s m js ro rl rp].freeze
+
+  def self.generate(opts = {})
+    opts = Utils.rename_keys(opts)
+    opts = { k: 'PR', v: '01', c: '1' }.merge(opts)
+
+    # Validate required fields
+    %i[r n i sf].each do |field|
+      raise ArgumentError, "Missing required #{field}" unless opts[field]
+    end
+
+    # Normalize and validate racun primaoca (r)
+    opts[:r] = Utils.normalize_bank_account(opts[:r])
+    unless opts[:r] =~ /^\d{18}$/ && Utils.validate_bank_account(opts[:r])
+      raise ArgumentError, 'Invalid racunPrimaoca'
+    end
+
+    # Optional racun platioca (o)
+    if opts[:o]
+      opts[:o] = Utils.normalize_bank_account(opts[:o])
+      unless opts[:o] =~ /^\d{18}$/ && Utils.validate_bank_account(opts[:o])
+        raise ArgumentError, 'Invalid racunPlatioca'
+      end
+    end
+
+    # Validate naziv primaoca (n)
+    n = opts[:n].to_s
+    if n.length < 1 || n.length > 70
+      raise ArgumentError, 'nazivPrimaoca must be between 1 and 70 characters'
+    end
+    unless n.match?(/^[a-zA-ZšđžčćŠĐŽČĆ0-9 \(\)\{\}\[\]<>\/\.,:;!@#\$%\^&\?„""""'`''_~=+\-\s]+$/u)
+      raise ArgumentError, 'Only letters, numbers, and select special characers are allowed.'
+    end
+    if n.lines.count > 3
+      raise ArgumentError, 'nazivPrimaoca must not contain more than 3 lines'
+    end
+
+    # Optional naziv platioca (p)
+    if opts[:p]
+      p = opts[:p].to_s
+      if p.length > 70
+        raise ArgumentError, 'nazivPlatioca must be at most 70 characters'
+      end
+    end
+
+    # Validate iznos (i)
+    i_val = opts[:i].to_s
+    unless i_val.length.between?(5, 20) && i_val.match?(/^[A-Z]{3}[0-9]+,[0-9]{0,2}$/)
+      raise ArgumentError, 'Invalid iznos format'
+    end
+
+    # Validate sifra placanja (sf)
+    sf = opts[:sf].to_s
+    unless sf.match?(/^[12][0-9]{2}$/)
+      raise ArgumentError, 'Invalid sifraPlacanja'
+    end
+
+    # Optional svrha placanja (s)
+    if opts[:s]
+      s = opts[:s].to_s
+      if s.length > 35
+        raise ArgumentError, 'svrhaPlacanja must be at most 35 characters'
+      end
+    end
+
+    # Optional merchant code category (m)
+    if opts[:m]
+      m = opts[:m].to_s
+      unless m.match?(/^[0-9]{4}$/)
+        raise ArgumentError, 'Invalid merchantCodeCategory'
+      end
+    end
+
+    # Optional jednokratna sifra (js)
+    if opts[:js]
+      js = opts[:js].to_s
+      unless js.match?(/^[0-9]{5}$/)
+        raise ArgumentError, 'Invalid jednokratnaSifra'
+      end
+    end
+
+    # Optional poziv na broj (ro)
+    if opts[:ro]
+      ro = opts[:ro].to_s
+      if ro.length > 35
+        raise ArgumentError, 'pozivNaBroj must be at most 35 characters'
+      end
+      ro = "00#{ro}" unless %w[97 22 11 00].include?(ro[0,2])
+      unless Utils.validate_reference_number(ro)
+        raise ArgumentError, 'Invalid pozivNaBroj'
+      end
+      opts[:ro] = ro
+    end
+
+    # Optional referenca primaoca (rl)
+    if opts[:rl]
+      rl = opts[:rl].to_s
+      if rl.length > 140
+        raise ArgumentError, 'referencaPrimaoca must be at most 140 characters'
+      end
+    end
+
+    # Optional referenca placanja (rp)
+    if opts[:rp]
+      rp = opts[:rp].to_s
+      unless rp.match?(/^[0-9]{19}$/)
+        raise ArgumentError, 'Invalid referencaPlacanja'
+      end
+    end
+
+    # Build IPS data string
+    parts = ORDER.map do |key|
+      val = opts[key]
+      next unless val
+      "#{key.to_s.upcase}:#{val.to_s.gsub('|', '-')}"
+    end.compact
+
+    parts.join('|')
+  end
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: ips_qr_code
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ivan Nemytchenko
+bindir: bin
+cert_chain: []
+date: 2025-04-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rqrcode
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Generate IPS QR Code data strings
+email:
+- nemytchenko@gmail.com
+executables:
+- ips-qr-code
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/ips-qr-code
+- lib/ips_qr_code.rb
+- lib/ips_qr_code/utils.rb
+- lib/ips_qr_code/version.rb
+homepage: https://github.com/inem/ips-qr-code
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.4
+specification_version: 4
+summary: Generate IPS QR Code data strings
+test_files: []