Merge pull request #1 from mrsool/feature/generate-qr-codes

Author: obahareth

.github/workflows/main.yml

@@ -0,0 +1,26 @@
+name: Ruby
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0.0
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Lint
+      run: bundle exec standardrb
+
+    - name: Run tests
+      run: bundle exec rspec

.gitignore

@@ -1,56 +1,10 @@
-*.gem
-*.rbc
-/.config
+/.bundle/
+/.yardoc
+/_yardoc/
 /coverage/
-/InstalledFiles
+/doc/
 /pkg/
 /spec/reports/
-/spec/examples.txt
-/test/tmp/
-/test/version_tmp/
 /tmp/
 
-# Used by dotenv library to load environment variables.
-# .env
-
-# Ignore Byebug command history file.
-.byebug_history
-
-## Specific to RubyMotion:
-.dat*
-.repl_history
-build/
-*.bridgesupport
-build-iPhoneOS/
-build-iPhoneSimulator/
-
-## Specific to RubyMotion (use of CocoaPods):
-#
-# We recommend against adding the Pods directory to your .gitignore. However
-# you should judge for yourself, the pros and cons are mentioned at:
-# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
-#
-# vendor/Pods/
-
-## Documentation cache and generated files:
-/.yardoc/
-/_yardoc/
-/doc/
-/rdoc/
-
-## Environment normalization:
-/.bundle/
-/vendor/bundle
-/lib/bundler/man/
-
-# for a library or gem, you might want to ignore these files since the code is
-# intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
-# .ruby-version
-# .ruby-gemset
-
-# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
-.rvmrc
-
-# Used by RuboCop. Remote config files pulled in from inherit_from directive.
-# .rubocop-https?--*
+.byebug_history

.rspec

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

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"

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

README.md

@@ -1,2 +1,52 @@
 # zatca-qr-code
+
+[🚧 Still being validated by ZATCA](https://github.com/mrsool/zatca-qr-code/issues/3).
+
 A 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)
+```

Rakefile

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

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__)

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

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

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

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