payOS 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6bb1ea8be43cc547a8501508fa27eb6b0ff6362b4435057c6c4f2a68dc0f523f
-  data.tar.gz: 30e5e2a4c6b1677025061307e362dfd4556effc1a501ae1294511ac93f8f65f5
+  metadata.gz: dbc5193acc97333368fa0ff679a1d8e70c21cfbd6431e786c68cd6d3e32dc586
+  data.tar.gz: da6f8d70cfcfc93957809efc40f605c3b6ab59e4ace232203acf9e868823325a
 SHA512:
-  metadata.gz: 65b2c71bdf2feb5353a24ad9ff53f3d3b47464b7eade0fc8a3501189922ccb4b11df342ed085aef2de081c5950e0470760a52008471d09e64cb1757205d90c12
-  data.tar.gz: 7a718232722397c9573563096ba404046c5f7af01fba605000bb194ef178a0369c8de9f1b5a9611053f8c433ac1a2090f6ef1f959954a4684c2d9b61ad296a18
+  metadata.gz: 2f207aaff9a8f441c7cbb738e4b87fb9cb00f9c0e0b919347aa49d90e24930ada2050e3f6f356e2df230380e881135894a306a71129cdb369da9579823d01143
+  data.tar.gz: fd39bbe44a5371721fd0992aaeb8458cb8b2e257972f47564aeee1baacbce9256f050dfbbfc96ad9213a68127e2fc79c40accbc42116b32edf73e3cf203c9e91

data/README.md

@@ -1,6 +1,6 @@
 # PayOS
 
-PayOS is a Ruby library that provides a simple and elegant way to integrate with the PayOS payment gateway services.
+PayOS is a Ruby library that provides a simple and elegant way to integrate with the [PayOS payment gateway services](https://payos.vn/docs/).
 
 ## Installation
 
@@ -58,6 +58,14 @@ To cancel a payment:
 PayOS.cancel_payment('4573928465')
 ```
 
+### Confirming a Webhook
+
+To confirm a webhook:
+
+```ruby
+PayOS.confirm_webhook('https://example.com/webhook')
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/payOS/constants.rb

@@ -4,4 +4,5 @@ module PayOS
   BASE_URL = "https://api-merchant.payos.vn"
   API_VERSION = "v2"
   PAYMENT_URL_PATH = "payment-requests"
+  CONFIRM_WEBHOOK_PATH = "confirm-webhook"
 end

data/lib/payOS/errors.rb

@@ -5,4 +5,5 @@ module PayOS
   class SignatureVerificationError < Error; end
   class RateLimitError < Error; end
   class APIError < Error; end
+  class ForbiddenError < Error; end
 end

data/lib/payOS/models/response.rb

@@ -23,25 +23,9 @@ module PayOS
       def verify_signature!
         return true if @data.nil? || @data["signature"].nil?
 
-        # Remove signature from data before verification
-        data_without_signature = @data.reject { |k, _| k == "signature" }
+        string_to_sign = Utils::Formater.params_to_string(@data.reject { |k, _| k == "signature" })
 
-        # Sort parameters alphabetically and create string to verify
-        string_to_verify = data_without_signature.sort.to_h
-                                                 .map { |k, v| "#{k}=#{v}" }
-                                                 .join("&")
-
-        # Generate signature
-        expected_signature = OpenSSL::HMAC.hexdigest(
-          "SHA256",
-          @checksum_secret,
-          string_to_verify
-        )
-
-        return true if expected_signature == @signature
-
-        raise SignatureVerificationError,
-              "Invalid signature!"
+        Utils::Signature.verify!(string_to_sign, @checksum_secret, @signature)
       end
     end
   end

data/lib/payOS/services/payment_url.rb

@@ -2,6 +2,7 @@
 
 require_relative "../constants"
 require_relative "../utils/signature"
+require_relative "../utils/formater"
 
 module PayOS
   module Services
@@ -22,20 +23,17 @@ module PayOS
         @client.post("#{PayOS::API_VERSION}/#{PayOS::PAYMENT_URL_PATH}/#{payment_url_id}/cancel", {})
       end
 
+      def confirm_webhook(webhook_url)
+        @client.post(PayOS::CONFIRM_WEBHOOK_PATH, { "webhookUrl" => webhook_url })
+      end
+
       private
 
       def params_with_signature(params)
-        # Generate signature from the formatted params
-        formatted_params = params.sort_by { |key, _| key.to_s }.map do |key, value|
-          formatted_key = key.to_s.split("_").map.with_index do |word, i|
-            i.zero? ? word : word.capitalize
-          end.join
-          [formatted_key, value]
-        end.to_h
-
-        formatted_params["signature"] = Utils::Signature.generate(formatted_params.map do |k, v|
-          "#{k}=#{v}"
-        end.join("&"), PayOS.configuration.checksum_secret)
+        formatted_params = Utils::Formater.format_params(params)
+        string_to_sign = Utils::Formater.params_to_string(formatted_params)
+
+        formatted_params["signature"] = Utils::Signature.generate(string_to_sign, PayOS.configuration.checksum_secret)
 
         formatted_params
       end

data/lib/payOS/utils/formater.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module PayOS
+  module Utils
+    class Formater
+      def self.format_params(params)
+        params.sort_by { |key, _| key.to_s }.map do |key, value|
+          formatted_key = key.to_s.split("_").map.with_index do |word, i|
+            i.zero? ? word : word.capitalize
+          end.join
+          [formatted_key, value]
+        end.to_h
+      end
+
+      def self.params_to_string(params)
+        params.reject { |k, _| k == "signature" }.sort_by { |key, _| key.to_s }.map { |k, v| "#{k}=#{v}" }.join("&")
+      end
+
+      def self.webhook_data_to_string(data)
+        sorted_data_by_key = sort_obj_data_by_key(data)
+        convert_data_to_query_str(sorted_data_by_key)
+      end
+
+      def self.snake_to_camel(str)
+        str.to_s.split("_").map.with_index { |word, i| i.zero? ? word : word.capitalize }.join
+      end
+
+      def self.sort_obj_data_by_key(object)
+        object.transform_keys { |key| snake_to_camel(key) }
+              .sort
+              .to_h
+      end
+
+      def self.convert_data_to_query_str(object)
+        object.reject { |_, v| v.nil? }
+              .map do |key, value|
+                camel_key = snake_to_camel(key)
+                formatted_value = case value
+                                  when Array
+                                    JSON.generate(value.map { |val| sort_obj_data_by_key(val) })
+                                  when nil, "undefined", "null"
+                                    ""
+                                  else
+                                    value.to_s
+                                  end
+
+                "#{camel_key}=#{formatted_value}"
+              end
+              .join("&")
+      end
+    end
+  end
+end

data/lib/payOS/utils/signature.rb

@@ -6,6 +6,14 @@ module PayOS
       def self.generate(data, secret_key)
         OpenSSL::HMAC.hexdigest("SHA256", secret_key, data)
       end
+
+      def self.verify!(data, secret_key, signature)
+        raise SignatureVerificationError, "Invalid signature!" if signature.nil?
+
+        return true if OpenSSL::HMAC.hexdigest("SHA256", secret_key, data) == signature
+
+        raise SignatureVerificationError, "Invalid signature!"
+      end
     end
   end
 end

data/lib/payOS/version.rb

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

data/lib/payOS.rb

@@ -9,6 +9,8 @@ require_relative "payOS/errors"
 require_relative "payOS/models/response"
 require_relative "payOS/client"
 require_relative "payOS/services/payment_url"
+require_relative "payOS/utils/formater"
+require_relative "payOS/utils/signature"
 
 module PayOS
   class Error < StandardError; end
@@ -42,4 +44,16 @@ module PayOS
   def self.cancel_payment(payment_url_id)
     payment_service.cancel(payment_url_id)
   end
+
+  def self.confirm_webhook(webhook_url)
+    payment_service.confirm_webhook(webhook_url)
+  end
+
+  def self.verify_request!(data, signature)
+    # raise ForbiddenError if request_source != PayOS::BASE_URL
+
+    # verify signature
+    string_to_sign = Utils::Formater.webhook_data_to_string(data)
+    Utils::Signature.verify!(string_to_sign, PayOS.configuration.checksum_secret, signature)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: payOS
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - ldhoax
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-31 00:00:00.000000000 Z
+date: 2025-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -60,6 +60,7 @@ files:
 - lib/payOS/errors.rb
 - lib/payOS/models/response.rb
 - lib/payOS/services/payment_url.rb
+- lib/payOS/utils/formater.rb
 - lib/payOS/utils/signature.rb
 - lib/payOS/version.rb
 - sig/payOS.rbs