emv_qr_code_processor 1.1.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 182fc45c04647e1cc189c4af19d2094e8c0fa2e002923e1983a601e953e0d89a
+  data.tar.gz: ab7f560ccfec4c744976978e9505811589b0f49bf3ff2db7829fb072bcce096b
+SHA512:
+  metadata.gz: 7b35c4b86f0a8593c46ceeed2b5c0377c0a120d91d31de2a0321430e38d4d541bd1502ce53a6be6c83b84f65d47612df322ecbb57ab0c5814dd879c40b6fd010
+  data.tar.gz: f5d72bfc2a0bc3a849af83767b79b0a7e92eb22f1e87ebb9c83f758f22315ac946927adb3247ceec068dfc4c60b60b255d629e46258bb875dc90edb74d78961b

data/lib/emv_qr_code_processor/decoder.rb

@@ -0,0 +1,56 @@
+require 'digest/crc16_ccitt'
+
+module EmvQrCodeProcessor
+  class Decoder
+    attr_reader :raw_qr_code
+
+    def initialize(raw_qr_code)
+      @raw_qr_code = raw_qr_code
+    end
+
+    def decode(validate_crc: true)
+      result = decode_data_objects(raw_qr_code, Schema)
+      validate_crc(result.fetch(:crc)) if validate_crc
+
+      result
+    end
+
+    private
+
+    def decode_data_objects(raw_data, template)
+      result = {}
+
+      each_data_object(raw_data) do |data_object_id, value|
+        data_object_type = find_data_object_type(data_object_id, template)
+        raise Errors::InvalidQRCodePayload if data_object_type.nil?
+
+        value = decode_data_objects(value, data_object_type) unless data_object_type.primitive?
+        result[data_object_type.name] = value
+      end
+
+      result
+    end
+
+    def each_data_object(raw_data)
+      scanner = StringScanner.new(raw_data)
+      until scanner.eos?
+        data_object_id = scanner.scan(/\d{2}/)
+        value_length   = scanner.scan(/\d{2}/).to_i
+        value          = scanner.scan(/.{#{value_length}}/)
+
+        yield(data_object_id, value)
+      end
+    end
+
+    def find_data_object_type(id, template)
+      template.data_object_types.find { |d| d.id == id }
+    end
+
+    def validate_crc(crc)
+      payload_without_crc = raw_qr_code[0..-9]
+      calculated_crc = Schema::CRC.calculate(payload_without_crc)
+
+      raise Errors::InvalidCRC if calculated_crc != crc
+    end
+  end
+end

data/lib/emv_qr_code_processor/encoder.rb

@@ -0,0 +1,41 @@
+require 'digest/crc16_ccitt'
+
+module EmvQrCodeProcessor
+  class Encoder
+    attr_reader :payload
+
+    def initialize(payload)
+      @payload = payload
+    end
+
+    def encode
+      result = encode_data_objects(payload, Schema)
+      result << calculate_crc(result)
+      result
+    end
+
+    private
+
+    def calculate_crc(data)
+      format(Schema::CRC.id, Schema::CRC.calculate(data))
+    end
+
+    def encode_data_objects(data, template)
+      sorted = data.sort_by { |name, _| find_data_object_type(name, template).id }
+
+      sorted.each_with_object("") do |(name, value), result|
+        data_object_type = find_data_object_type(name, template)
+        value = encode_data_objects(value, data_object_type) unless data_object_type.primitive?
+        result << format(data_object_type.id, value)
+      end
+    end
+
+    def format(id, value)
+      [id, value.length.to_s.rjust(2, "0"), value].join
+    end
+
+    def find_data_object_type(name, template)
+      template.data_object_types.find { |d| d.name == name }
+    end
+  end
+end

data/lib/emv_qr_code_processor/errors.rb

@@ -0,0 +1,7 @@
+module EmvQrCodeProcessor
+  module Errors
+    class EMVQRCodeError < StandardError; end
+    class InvalidCRC < EMVQRCodeError; end
+    class InvalidQRCodePayload < EMVQRCodeError; end
+  end
+end

data/lib/emv_qr_code_processor/schema.rb

@@ -0,0 +1,86 @@
+module EmvQrCodeProcessor
+  module Schema
+    DataObjectType = Struct.new(:id, :name, keyword_init: true) do
+      def primitive?
+        true
+      end
+    end
+
+    TemplateType = Struct.new(:id, :name, :data_object_types, keyword_init: true) do
+      def primitive?
+        false
+      end
+    end
+
+    class CRCType < DataObjectType
+      LENGTH = "04".freeze
+
+      def initialize
+        super(id: "63", name: :crc)
+      end
+
+      def calculate(data)
+        Digest::CRC16CCITT.new.update([data, id, LENGTH].join).to_s.upcase
+      end
+    end
+
+    class AdditionalDataFieldType < TemplateType
+      PLACEHOLDER = "***".freeze
+
+      def initialize
+        data_object_types = [
+          DataObjectType.new(id: "01", name: :bill_number),
+          DataObjectType.new(id: "02", name: :mobile_number),
+          DataObjectType.new(id: "03", name: :store_label),
+          DataObjectType.new(id: "04", name: :loyalty_number),
+          DataObjectType.new(id: "05", name: :reference_label),
+          DataObjectType.new(id: "06", name: :customer_label),
+          DataObjectType.new(id: "07", name: :terminal_label),
+          DataObjectType.new(id: "08", name: :transaction_purpose)
+        ]
+
+        ("09".."99").each do |id|
+          data_object_types << DataObjectType.new(id: id, name: :"reserved_#{id}")
+        end
+
+        super(
+          id: "62",
+          name: :additional_data_field,
+          data_object_types: data_object_types
+        )
+      end
+    end
+
+    CRC = CRCType.new
+    ADDITIONAL_DATA_FIELD = AdditionalDataFieldType.new
+
+    DATA_OBJECT_TYPES = [
+      DataObjectType.new(id: "00", name: :payload_format_indicator),
+      DataObjectType.new(id: "01", name: :point_of_initiation_method),
+      DataObjectType.new(id: "15", name: :"merchant_account_information.union_pay"),
+      DataObjectType.new(id: "52", name: :merchant_category_code),
+      DataObjectType.new(id: "53", name: :transaction_currency),
+      DataObjectType.new(id: "54", name: :transaction_amount),
+      DataObjectType.new(id: "55", name: :tip_or_convenience_fee_indicator),
+      DataObjectType.new(id: "56", name: :value_of_convenience_fee_fixed),
+      DataObjectType.new(id: "57", name: :value_of_convenience_fee_percentage),
+      DataObjectType.new(id: "58", name: :country_code),
+      DataObjectType.new(id: "59", name: :merchant_name),
+      DataObjectType.new(id: "60", name: :merchant_city),
+      DataObjectType.new(id: "61", name: :postal_code),
+      ADDITIONAL_DATA_FIELD,
+      CRC,
+      DataObjectType.new(id: "64", name: :merchant_information_language)
+    ]
+
+    ("00".."99").each do |id|
+      next if DATA_OBJECT_TYPES.any? { |d| d.id == id }
+
+      DATA_OBJECT_TYPES << DataObjectType.new(id: id, name: :"reserved_#{id}")
+    end
+
+    def self.data_object_types
+      DATA_OBJECT_TYPES
+    end
+  end
+end

data/lib/emv_qr_code_processor/version.rb

@@ -0,0 +1,11 @@
+module EmvQrCodeProcessor
+  module VERSION
+    # Semantic versioning
+    MAJOR = 1
+    MINOR = 1
+    TINY = 5
+
+    # Full version number
+    STRING = [MAJOR, MINOR, TINY].compact.join(".")
+  end
+end

data/lib/emv_qr_code_processor.rb

@@ -0,0 +1,10 @@
+require "emv_qr_code_processor/schema"
+require "emv_qr_code_processor/encoder"
+require "emv_qr_code_processor/decoder"
+require "emv_qr_code_processor/errors"
+require "emv_qr_code_processor/version"
+
+module EmvQrCodeProcessor
+  module Schema
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: emv_qr_code_processor
+version: !ruby/object:Gem::Version
+  version: 1.1.5
+platform: ruby
+authors:
+- Sokmesa KHIEV
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-01-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: digest-crc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+description: 'Process to generate and read data EMV QRCode '
+email:
+- ksokmesa@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/emv_qr_code_processor.rb
+- lib/emv_qr_code_processor/decoder.rb
+- lib/emv_qr_code_processor/encoder.rb
+- lib/emv_qr_code_processor/errors.rb
+- lib/emv_qr_code_processor/schema.rb
+- lib/emv_qr_code_processor/version.rb
+homepage: https://github.com/sokmesakhiev/emv_qr_code_processor
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+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.0.3
+signing_key: 
+specification_version: 4
+summary: EMV QRCode reader and writer
+test_files: []