zatca 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 31fc90251ebaaa59adb0c0e56c685d7a0328621d4135ec652c1b755ffaba9dcb
+  data.tar.gz: dfe4cf0d45af7b39910b74f960f9eac6396baa4d023633f8a14dd45f23f0fb36
+SHA512:
+  metadata.gz: 509c63d4567ad7a299feb239f52138f89d5085785584f12a8b2b2f2ef907cdcbbfe84a902b301eb04e5b13fac42811f9c7932e84606c861427da66da07024755
+  data.tar.gz: 531d7fe55112f3c5f50765895a9d0276fd9dcef4807fba574c901fd73fd2be8c7adf2bd304469744dc0fb1adb41da73e7991c7cb0020abfc95988a3b9aa889cb

data/.rspec

@@ -0,0 +1,2 @@
+--require spec_helper
+-I lib/zatca

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in zatca-qr-code.gemspec
+gemspec
+
+gem "rake", "~> 13.0"

data/Gemfile.lock

@@ -0,0 +1,100 @@
+PATH
+  remote: .
+  specs:
+    zatca-qr-code (0.1.0)
+      dry-schema (~> 1.5)
+      rqrcode (~> 2.1.0)
+      zeitwerk (~> 2.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    byebug (9.1.0)
+    chunky_png (1.4.0)
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.4.4)
+    dry-configurable (0.13.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.6)
+    dry-container (0.9.0)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.13, >= 0.13.0)
+    dry-core (0.7.1)
+      concurrent-ruby (~> 1.0)
+    dry-inflector (0.2.1)
+    dry-initializer (3.0.4)
+    dry-logic (1.2.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.5, >= 0.5)
+    dry-schema (1.8.0)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.13, >= 0.13.0)
+      dry-core (~> 0.5, >= 0.5)
+      dry-initializer (~> 3.0)
+      dry-logic (~> 1.0)
+      dry-types (~> 1.5)
+    dry-types (1.5.1)
+      concurrent-ruby (~> 1.0)
+      dry-container (~> 0.3)
+      dry-core (~> 0.5, >= 0.5)
+      dry-inflector (~> 0.1, >= 0.1.2)
+      dry-logic (~> 1.0, >= 1.0.2)
+    parallel (1.21.0)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rqrcode (2.1.0)
+      chunky_png (~> 1.0)
+      rqrcode_core (~> 1.0)
+    rqrcode_core (1.2.0)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.20.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.9.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.12.0)
+      parser (>= 3.0.1.1)
+    rubocop-performance (1.11.5)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    standard (1.3.0)
+      rubocop (= 1.20.0)
+      rubocop-performance (= 1.11.5)
+    unicode-display_width (2.1.0)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  x86_64-darwin-20
+  x86_64-linux
+
+DEPENDENCIES
+  byebug (~> 9.0)
+  rake (~> 13.0)
+  rspec (~> 3.10)
+  standard (~> 1.3)
+  zatca-qr-code!
+
+BUNDLED WITH
+   2.2.27

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Mrsool
+
+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,53 @@
+# zatca-qr-code
+![](https://img.shields.io/gem/v/zatca-qr-code) ![](https://img.shields.io/github/workflow/status/mrsool/zatca-qr-code/Ruby)
+
+[🚧 Still being validated by ZATCA](https://github.com/mrsool/zatca-qr-code/issues/3).
+
+A Ruby library for generating QR Codes for the e-invoice standard by ZATCA in Saudi Arabia.
+
+# Installation
+
+## Rubygems
+```sh
+gem install zatca-qr-code
+```
+
+## Bundler
+```sh
+bundle add zatca-qr-code
+```
+
+# Usage
+
+```rb
+require "zatca-qr-code"
+
+tags = {
+  seller_name: "Mrsool",
+  vat_registration_number: "310228833400003",
+  timestamp: "2021-10-20T19:29:32+03:00",
+  vat_total: "15",
+  invoice_total: "115",
+}
+
+ZATCA.render_qr_code(tags)
+# => data:image/png;base64,...
+# Hint (Try pasting the above into your web browser's address bar)
+```
+
+If you'd like to customize the size of the QR Code you can manually use the generator like so:
+
+```rb
+require "zatca-qr-code"
+
+tags = ZATCA::Tags.new({
+  seller_name: "Mrsool",
+  vat_registration_number: "310228833400003",
+  timestamp: "2021-10-20T19:29:32+03:00",
+  vat_total: "15",
+  invoice_total: "115",
+})
+
+generator = ZATCA::QRCodeGenerator.new(tags)
+generator.render(size: 512)
+```

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require_relative "../lib/zatca.rb"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/zatca/qr_code_generator.rb

@@ -0,0 +1,21 @@
+require "rqrcode"
+
+module ZATCA
+  class QRCodeGenerator
+    def initialize(tags)
+      @tags = tags
+    end
+
+    def render(size: 256)
+      qr_code = generate
+
+      qr_code.as_png(size: size, border_modules: 2)&.to_data_url
+    end
+
+    private
+
+    def generate
+      RQRCode::QRCode.new(@tags.to_base64)
+    end
+  end
+end

data/lib/zatca/tag.rb

@@ -0,0 +1,31 @@
+module ZATCA
+  class Tag
+    TAG_IDS = {
+      seller_name: 1,
+      vat_registration_number: 2,
+      timestamp: 3,
+      invoice_total: 4,
+      vat_total: 5
+    }.freeze
+
+    attr_accessor :id, :key, :value
+
+    def initialize(key:, value:)
+      @id = TAG_IDS[key]
+      @key = key
+      @value = value.to_s
+    end
+
+    def to_h
+      {id: @id, key: @key, value: @value}
+    end
+
+    def to_tlv
+      # TLV should be concatenated together without any separator in the following
+      # format: hex_value_of_id hex_value_of_length value_itself
+      # where hex_values should be padded with a 0 if containing only a single digit.
+
+      sprintf("%02X%02X%s", @id, @value.length, @value)
+    end
+  end
+end

data/lib/zatca/tags.rb

@@ -0,0 +1,38 @@
+require "base64"
+
+module ZATCA
+  class Tags
+    def initialize(tags)
+      keys_to_coerce_to_string = tags.except(:timestamp).keys
+      stringified_tags = tags.map do |key, value|
+        if keys_to_coerce_to_string.include?(key)
+          [key, value.to_s]
+        else
+          [key, value]
+        end
+      end.to_h
+
+      schema_result = TagsSchema.call(stringified_tags)
+      if schema_result.failure?
+        raise(Error, "Parsing tags failed due to:\n#{schema_result.errors(full: true).to_h}")
+      end
+
+      stringified_tags[:timestamp] = tags[:timestamp].to_s
+
+      # Create tags, then sort them by ID
+      @tags = stringified_tags.map do |key, value|
+        Tag.new(key: key, value: value)
+      end.sort_by(&:id)
+    end
+
+    def to_base64
+      Base64.strict_encode64(to_tlv)
+    end
+
+    private
+
+    def to_tlv
+      @tags.map(&:to_tlv).join("")
+    end
+  end
+end

data/lib/zatca/tags_schema.rb

@@ -0,0 +1,22 @@
+require "dry-schema"
+
+module ZATCA
+  TagsSchema = Dry::Schema.Params do
+    required(:seller_name).filled(:string)
+    required(:vat_registration_number).filled(:string)
+
+    required(:timestamp).filled([:date_time, :string])
+
+    # Using strings to avoid any floating point approximations, we're not doing
+    # any calculations with these values, it's for display purposes only. A
+    # string is a good fit.
+    required(:invoice_total).filled(:string)
+    required(:vat_total).filled(:string)
+
+    # TODO: Data types required by 1 January 2023
+    # - Hash of XML Invoice
+    # - ECDSA signature
+    # - ECDSA public key
+    # - ECDSA signature of the cryptographic stamp’s public key by ZATCA’s technical CA
+  end
+end

data/lib/zatca/version.rb

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

data/lib/zatca.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative "zatca/version"
+
+require "zeitwerk"
+
+loader = Zeitwerk::Loader.for_gem
+loader.inflector.inflect(
+  "zatca" => "ZATCA",
+  "qr_code_generator" => "QRCodeGenerator"
+)
+loader.setup
+
+module ZATCA
+  extend self
+
+  class Error < StandardError; end
+
+  def self.render_qr_code(tags)
+    QRCodeGenerator.new(ZATCA::Tags.new(tags)).render
+  end
+end
+
+loader.eager_load

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: zatca
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Omar Bahareth
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-11-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: dry-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rqrcode
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+description: A library for generating QR Codes for the e-invoice standard by ZATCA
+  in Saudi Arabia.
+email:
+- obahareth@mrsool.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/zatca.rb
+- lib/zatca/qr_code_generator.rb
+- lib/zatca/tag.rb
+- lib/zatca/tags.rb
+- lib/zatca/tags_schema.rb
+- lib/zatca/version.rb
+homepage: https://github.com/mrsool/zatca-qr-code
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/mrsool/zatca-qr-code
+  source_code_uri: https://github.com/mrsool/zatca-qr-code
+  changelog_uri: https://github.com/mrsool/zatca-qr-code/releases
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key: 
+specification_version: 4
+summary: A library for generating QR Codes for the e-invoice standard by ZATCA in
+  Saudi Arabia.
+test_files: []