zatca 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dfcfffb30bc80671008a9f4d85bc6300f7bed524f02919a35314be134f6ced61
-  data.tar.gz: b5fdeac07afe47aabcb05284283a4197ddaf55262961d34dd953a7e9d74f6487
+  metadata.gz: aaa15fcf4e0f8bc1ecdd57277871998c22eb1310294aec57ca297324f8ac2e18
+  data.tar.gz: 27e35dae1b305d98573e81e6edcc06eb57013ea145a50614d80889245c302989
 SHA512:
-  metadata.gz: 9905e39f50b48661abc536d803254b99dbb7aa4c8a200e3b2c80b9292080aa5d5fa64f419ccf2d5e9c368691ce068cfab96a6373dcc42e9fa9dfc037b3639128
-  data.tar.gz: f3b19d710fce67255bd151bdd1913e900419fddf7343b547a88eb86ebc21b8aaecc40537c1b6a0e58ce0f79b4002667780a3768b95a7042c03b87faca2268038
+  metadata.gz: 1d1fc81fd4799d919c0df244327cdffd74cb30aa62b6d906d4b8e422bfe4dd831577d87e55672e403151563055e2ad99be28d482936d19524951c64df586991a
+  data.tar.gz: 41db16f2a9dde6111a5fd0d6459e0d3c4910d3ca20cc77a7220b62f3b5dc08b7841130c7e3c334b598e914297e20ec9a7038a1a6e9416ef4f958e058229dcc14

data/README.md

@@ -1,5 +1,5 @@
 # zatca
-![](https://img.shields.io/gem/v/zatca) ![](https://img.shields.io/github/workflow/status/mrsool/zatca/Ruby)
+![](https://img.shields.io/gem/v/zatca) ![](https://img.shields.io/github/actions/workflow/status/mrsool/zatca/test.yml?branch=main)
 
 A Ruby library for generating QR Codes and e-invoices according to the standard created by ZATCA in Saudi Arabia.
 
@@ -31,7 +31,7 @@ tags = {
   invoice_total: "115",
 }
 
-ZATCA.render_qr_code(tags)
+ZATCA.render_qr_code(tags: tags)
 # => data:image/png;base64,...
 # Hint (Try pasting the above into your web browser's address bar)
 ```
@@ -49,7 +49,7 @@ tags = ZATCA::Tags.new({
   invoice_total: "115",
 })
 
-generator = ZATCA::QRCodeGenerator.new(tags)
+generator = ZATCA::QRCodeGenerator.new(tags: tags)
 generator.render(size: 512)
 ```
 

data/lib/zatca/client.rb

@@ -4,6 +4,8 @@ require "json"
 # This wraps the API described here:
 # https://sandbox.zatca.gov.sa/IntegrationSandbox
 class ZATCA::Client
+  attr_accessor :before_submitting_request, :before_parsing_response
+
   # API URLs are not present in developer portal, they can only be found in a PDF
   # called Fatoora Portal User Manual, here:
   # https://zatca.gov.sa/en/E-Invoicing/Introduction/Guidelines/Documents/Fatoora%20portal%20user%20manual.pdf
@@ -20,15 +22,28 @@ class ZATCA::Client
   DEFAULT_API_VERSION = "V2".freeze
   LANGUAGES = %w[ar en].freeze
 
-  def initialize(username:, password:, language: "ar", version: DEFAULT_API_VERSION, environment: :production)
+  def initialize(
+    username:,
+    password:,
+    language: "ar",
+    version: DEFAULT_API_VERSION,
+    environment: :production,
+    verbose: false,
+    before_submitting_request: nil,
+    before_parsing_response: nil
+  )
     raise "Invalid language: #{language}, Please use one of: #{LANGUAGES}" unless LANGUAGES.include?(language)
 
     @username = username
     @password = password
     @language = language
     @version = version
+    @verbose = verbose
 
     @base_url = ENVIRONMENTS_TO_URLS_MAP[environment.to_sym] || PRODUCTION_BASE_URL
+
+    @before_submitting_request = before_submitting_request
+    @before_parsing_response = before_parsing_response
   end
 
   # Reporting API
@@ -132,6 +147,9 @@ class ZATCA::Client
     url = "#{@base_url}/#{path}"
     headers = default_headers.merge(headers)
 
+    before_submitting_request&.call(method, url, body, headers)
+    log("Requesting #{method} #{url} with\n\nbody: #{body}\n\nheaders: #{headers}\n")
+
     client = if authenticated
       authenticated_request_cilent
     else
@@ -139,14 +157,27 @@ class ZATCA::Client
     end
 
     response = client.send(method, url, json: body, headers: headers)
+    before_parsing_response&.call(response)
+    log("Raw response: #{response}")
+
+    if response.instance_of?(HTTPX::ErrorResponse)
+      return {
+        message: response.error&.message,
+        details: response.to_s
+      }
+    end
 
     response_body = response.body.to_s
 
-    if response.headers["Content-Type"] == "application/json"
+    parsed_body = if response.headers["Content-Type"] == "application/json"
       parse_json_or_return_string(response_body)
     else
       response_body
     end
+
+    log("Response body: #{parsed_body}")
+
+    parsed_body
   end
 
   def authenticated_request_cilent
@@ -170,4 +201,11 @@ class ZATCA::Client
   rescue JSON::ParserError
     json
   end
+
+  def log(message)
+    return unless @verbose
+    message = "\n\n---------------------\n\n#{message}\n\n"
+
+    puts message
+  end
 end

data/lib/zatca/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zatca
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Omar Bahareth
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-06 00:00:00.000000000 Z
+date: 2023-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk