payOS 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6bb1ea8be43cc547a8501508fa27eb6b0ff6362b4435057c6c4f2a68dc0f523f
+  data.tar.gz: 30e5e2a4c6b1677025061307e362dfd4556effc1a501ae1294511ac93f8f65f5
+SHA512:
+  metadata.gz: 65b2c71bdf2feb5353a24ad9ff53f3d3b47464b7eade0fc8a3501189922ccb4b11df342ed085aef2de081c5950e0470760a52008471d09e64cb1757205d90c12
+  data.tar.gz: 7a718232722397c9573563096ba404046c5f7af01fba605000bb194ef178a0369c8de9f1b5a9611053f8c433ac1a2090f6ef1f959954a4684c2d9b61ad296a18

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,28 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Naming/FileName:
+  Exclude:
+    - 'lib/payOS.rb'
+    - 'spec/payOS_spec.rb'
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+3.3.6

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-12-25
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 ldhoax
+
+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,77 @@
+# PayOS
+
+PayOS is a Ruby library that provides a simple and elegant way to integrate with the PayOS payment gateway services.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'payOS'
+```
+
+Then run `bundle install` to install the gem.
+
+## Usage
+
+Before using PayOS, you need to configure it with your credentials. You can do this in an initializer file (e.g., `config/initializers/payOS.rb` in Rails):
+
+```ruby
+PayOS.configure do |config|
+  config.client_id = ENV['CLIENT_ID']
+  config.api_key = ENV['API_KEY']
+  config.checksum_secret = ENV['CHECKSUM_SECRET']
+  # Optional: config.partner_code = ENV['PARTNER_CODE']
+end
+```
+
+### Creating a Payment URL
+
+To create a payment URL, use the `create_payment_url` method:
+
+```ruby
+payment_params = {
+  amount: 123,
+  cancelUrl: "https://your-domain.com/cancel-webhook-path",
+  description: "description",
+  orderCode: 4573928465,
+  returnUrl: "https://your-domain.com/success-webhook-path",
+  ... other params
+}
+
+payment_url = PayOS.create_payment_url(payment_params)
+```
+
+### Getting Payment Information
+
+To retrieve information about a payment:
+
+```ruby
+payment_info = PayOS.get_payment_info('4573928465')
+```
+
+### Canceling a Payment
+
+To cancel a payment:
+
+```ruby
+PayOS.cancel_payment('4573928465')
+```
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ldhoax/payOS. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/ldhoax/payOS/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the PayOS project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/payOS/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/payOS/client.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module PayOS
+  class Client
+    def initialize(config)
+      @config = config
+      @http_client = Faraday.new(url: BASE_URL) do |faraday|
+        # Set default headers
+        faraday.headers["Content-Type"] = "application/json"
+        faraday.headers["x-client-id"] = config.client_id
+        faraday.headers["x-api-key"] = config.api_key
+        faraday.headers["x-partner-code"] = config.partner_code
+
+        # Add middleware for JSON parsing
+        faraday.request :json
+        faraday.response :json
+
+        # Add middleware for logging (optional)
+        # faraday.response :logger if config.debug_mode
+
+        # Use default adapter
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+
+    def post(path, payload)
+      response = @http_client.post(path) do |req|
+        req.body = payload.to_json
+      end
+
+      handle_response(response)
+    end
+
+    def get(path)
+      response = @http_client.get(path)
+      handle_response(response)
+    end
+
+    private
+
+    def handle_response(response)
+      case response.status
+      when 200
+        response_obj = Models::Response.new(response.body, @config.checksum_secret)
+        response_obj.verify_signature!
+        response_obj
+      when 429
+        raise RateLimitError, "Rate limit exceeded. Please try again later."
+      else
+        raise APIError, "API request failed: #{response.body}"
+      end
+    end
+  end
+end

data/lib/payOS/configuration.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module PayOS
+  class Configuration
+    attr_accessor :client_id, :api_key, :checksum_secret, :partner_code
+
+    def initialize
+      @client_id = nil
+      @api_key = nil
+      @checksum_secret = nil
+      @partner_code = nil
+    end
+
+    def validate!
+      raise Error, "client_id is required" if client_id.nil?
+      raise Error, "api_key is required" if api_key.nil?
+      raise Error, "checksum_secret is required" if checksum_secret.nil?
+    end
+  end
+end

data/lib/payOS/constants.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module PayOS
+  BASE_URL = "https://api-merchant.payos.vn"
+  API_VERSION = "v2"
+  PAYMENT_URL_PATH = "payment-requests"
+end

data/lib/payOS/errors.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module PayOS
+  class Error < StandardError; end
+  class SignatureVerificationError < Error; end
+  class RateLimitError < Error; end
+  class APIError < Error; end
+end

data/lib/payOS/models/response.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "openssl"
+
+module PayOS
+  module Models
+    class Response
+      attr_reader :code, :desc, :data, :signature, :raw_response
+
+      def initialize(response_body, checksum_secret)
+        @raw_response = response_body
+        @code = response_body["code"]
+        @desc = response_body["desc"]
+        @data = response_body["data"]
+        @signature = response_body.dig("data", "signature")
+        @checksum_secret = checksum_secret
+      end
+
+      def success?
+        code == "00"
+      end
+
+      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" }
+
+        # 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!"
+      end
+    end
+  end
+end

data/lib/payOS/services/payment_url.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative "../constants"
+require_relative "../utils/signature"
+
+module PayOS
+  module Services
+    class PaymentUrl
+      def initialize(client)
+        @client = client
+      end
+
+      def create(params)
+        @client.post("#{PayOS::API_VERSION}/#{PayOS::PAYMENT_URL_PATH}", params_with_signature(params))
+      end
+
+      def get_info(payment_url_id)
+        @client.get("#{PayOS::API_VERSION}/#{PayOS::PAYMENT_URL_PATH}/#{payment_url_id}")
+      end
+
+      def cancel(payment_url_id)
+        @client.post("#{PayOS::API_VERSION}/#{PayOS::PAYMENT_URL_PATH}/#{payment_url_id}/cancel", {})
+      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
+      end
+    end
+  end
+end

data/lib/payOS/utils/signature.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module PayOS
+  module Utils
+    class Signature
+      def self.generate(data, secret_key)
+        OpenSSL::HMAC.hexdigest("SHA256", secret_key, data)
+      end
+    end
+  end
+end

data/lib/payOS/version.rb

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

data/lib/payOS.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "json"
+
+require_relative "payOS/version"
+require_relative "payOS/configuration"
+require_relative "payOS/errors"
+require_relative "payOS/models/response"
+require_relative "payOS/client"
+require_relative "payOS/services/payment_url"
+
+module PayOS
+  class Error < StandardError; end
+
+  class << self
+    attr_accessor :configuration
+
+    def client
+      @client ||= Client.new(configuration)
+    end
+
+    def payment_service
+      @payment_service ||= Services::PaymentUrl.new(client)
+    end
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration) if block_given?
+    configuration.validate!
+  end
+
+  def self.create_payment_url(params)
+    payment_service.create(params)
+  end
+
+  def self.get_payment_info(payment_url_id)
+    payment_service.get_info(payment_url_id)
+  end
+
+  def self.cancel_payment(payment_url_id)
+    payment_service.cancel(payment_url_id)
+  end
+end

data/sig/payOS.rbs

@@ -0,0 +1,4 @@
+module PayOS
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: payOS
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ldhoax
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-12-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: A Ruby library for integrating with PayOS payment services
+email:
+- leduchoabatr12@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/payOS.rb
+- lib/payOS/client.rb
+- lib/payOS/configuration.rb
+- lib/payOS/constants.rb
+- lib/payOS/errors.rb
+- lib/payOS/models/response.rb
+- lib/payOS/services/payment_url.rb
+- lib/payOS/utils/signature.rb
+- lib/payOS/version.rb
+- sig/payOS.rbs
+homepage: https://github.com/ldhoax/payOS
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ldhoax/payOS
+  source_code_uri: https://github.com/ldhoax/payOS
+  changelog_uri: https://github.com/ldhoax/payOS/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Ruby SDK for PayOS payment gateway
+test_files: []