HyperPay 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cb8d58ae8360368a30935be12cc4e3dc0d2c5a234b6d1d31cad4959428864b3e
+  data.tar.gz: dfa14a6b30908707bc19eff2e4165b86bb42cc349ec50e32e659ec4fdeb2a5ed
+SHA512:
+  metadata.gz: dd532c6e1f74bbd756f0f544871edf1b3096a2395a50c62781848cfce90fdd62f3bac08ff1d95d0f310889f3432a434140b9337e2e419f1d8589f5e527478626
+  data.tar.gz: 279b7866cf4eae7488f5f574366621bc274e3f60aaef460512a6f8ff299433725e1a8a19fd6295f9be26dcce1ae922f2369bdea755822fb5e5ea4fbede1e111c

data/.idea/.gitignore

@@ -0,0 +1,8 @@
+# Default ignored files
+/shelf/
+/workspace.xml
+# Editor-based HTTP Client requests
+/httpRequests/
+# Datasource local storage ignored files
+/dataSources/
+/dataSources.local.xml

data/.idea/hyperpay.iml

@@ -0,0 +1,83 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="RUBY_MODULE" version="4">
+  <component name="ModuleRunConfigurationManager">
+    <shared />
+  </component>
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <sourceFolder url="file://$MODULE_DIR$/features" isTestSource="true" />
+      <sourceFolder url="file://$MODULE_DIR$/spec" isTestSource="true" />
+      <sourceFolder url="file://$MODULE_DIR$/test" isTestSource="true" />
+    </content>
+    <orderEntry type="jdk" jdkName="rbenv: 3.2.2" jdkType="RUBY_SDK" />
+    <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="library" scope="PROVIDED" name="ast (v2.4.2, rbenv: 3.2.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="bundler (v2.5.6, rbenv: 3.2.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="httparty (v0.21.0, rbenv: 3.2.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="json (v2.7.1, rbenv: 3.2.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="language_server-protocol (v3.17.0.3, rbenv: 3.2.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="mini_mime (v1.1.5, rbenv: 3.2.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="minitest (v5.22.2, rbenv: 3.2.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="multi_xml (v0.6.0, rbenv: 3.2.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="parallel (v1.24.0, rbenv: 3.2.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="parser (v3.3.0.5, rbenv: 3.2.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="racc (v1.7.3, rbenv: 3.2.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rainbow (v3.1.1, rbenv: 3.2.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rake (v13.1.0, rbenv: 3.2.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="regexp_parser (v2.9.0, rbenv: 3.2.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rexml (v3.2.6, rbenv: 3.2.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rubocop (v1.61.0, rbenv: 3.2.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rubocop-ast (v1.31.1, rbenv: 3.2.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="ruby-progressbar (v1.13.0, rbenv: 3.2.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="unicode-display_width (v2.5.0, rbenv: 3.2.2) [gem]" level="application" />
+  </component>
+  <component name="RakeTasksCache">
+    <option name="myRootTask">
+      <RakeTaskImpl id="rake">
+        <subtasks>
+          <RakeTaskImpl description="Build HyperPay-0.1.0.gem into the pkg directory" fullCommand="build" id="build" />
+          <RakeTaskImpl id="build">
+            <subtasks>
+              <RakeTaskImpl description="Generate SHA512 checksum if HyperPay-0.1.0.gem into the checksums directory" fullCommand="build:checksum" id="checksum" />
+            </subtasks>
+          </RakeTaskImpl>
+          <RakeTaskImpl description="Remove any temporary products" fullCommand="clean" id="clean" />
+          <RakeTaskImpl description="Remove any generated files" fullCommand="clobber" id="clobber" />
+          <RakeTaskImpl description="Build and install HyperPay-0.1.0.gem into system gems" fullCommand="install" id="install" />
+          <RakeTaskImpl id="install">
+            <subtasks>
+              <RakeTaskImpl description="Build and install HyperPay-0.1.0.gem into system gems without network access" fullCommand="install:local" id="local" />
+            </subtasks>
+          </RakeTaskImpl>
+          <RakeTaskImpl description="Create tag v0.1.0 and build and push HyperPay-0.1.0.gem to rubygems.org" fullCommand="release[remote]" id="release[remote]" />
+          <RakeTaskImpl description="Run RuboCop" fullCommand="rubocop" id="rubocop" />
+          <RakeTaskImpl id="rubocop">
+            <subtasks>
+              <RakeTaskImpl description="Autocorrect RuboCop offenses (only when it's safe)" fullCommand="rubocop:autocorrect" id="autocorrect" />
+              <RakeTaskImpl description="Autocorrect RuboCop offenses (safe and unsafe)" fullCommand="rubocop:autocorrect_all" id="autocorrect_all" />
+              <RakeTaskImpl description="" fullCommand="rubocop:auto_correct" id="auto_correct" />
+            </subtasks>
+          </RakeTaskImpl>
+          <RakeTaskImpl description="Run the test suite" fullCommand="test" id="test" />
+          <RakeTaskImpl id="test">
+            <subtasks>
+              <RakeTaskImpl description="Print out the test command" fullCommand="test:cmd" id="cmd" />
+              <RakeTaskImpl description="Show which test files fail when run in isolation" fullCommand="test:isolated" id="isolated" />
+              <RakeTaskImpl description="Show bottom 25 tests wrt time" fullCommand="test:slow" id="slow" />
+              <RakeTaskImpl description="" fullCommand="test:deps" id="deps" />
+            </subtasks>
+          </RakeTaskImpl>
+          <RakeTaskImpl description="" fullCommand="default" id="default" />
+          <RakeTaskImpl description="" fullCommand="release" id="release" />
+          <RakeTaskImpl id="release">
+            <subtasks>
+              <RakeTaskImpl description="" fullCommand="release:guard_clean" id="guard_clean" />
+              <RakeTaskImpl description="" fullCommand="release:rubygem_push" id="rubygem_push" />
+              <RakeTaskImpl description="" fullCommand="release:source_control_push" id="source_control_push" />
+            </subtasks>
+          </RakeTaskImpl>
+        </subtasks>
+      </RakeTaskImpl>
+    </option>
+  </component>
+</module>

data/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/hyperpay.iml" filepath="$PROJECT_DIR$/.idea/hyperpay.iml" />
+    </modules>
+  </component>
+</project>

data/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## [Unreleased]
+- Add Support for `ServerToServerAPI` 
+
+## [0.1.0] - 2024-03-06
+
+- Initial release
+- `CopyAndPayAPI` Wrapper

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# 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, 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 e-mail 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 m@kaakati.me. 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.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/HyperPay.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "lib/HyperPay/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "HyperPay"
+  spec.version = HyperPay::VERSION
+  spec.authors = ["Mohamad Kaakati"]
+  spec.email = ["m@kaakati.me"]
+
+  spec.summary = "A wrapper around HyperPay Copy And Pay API."
+  spec.description = "HyperPay is a wrapper around HyperPay Copy And Pay API. It provides a simple way to integrate with HyperPay's MENA payment gateway."
+  spec.homepage = "https://kaakati.me/"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/kaakati/hyperpay_ruby"
+  spec.metadata["changelog_uri"] = "https://github.com/kaakati/hyperpay_ruby/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = %w[lib README.md]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "httparty"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Mohamad Kaakati
+
+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,107 @@
+
+# HyperPay Gem
+
+HyperPay is a powerful payment gateway, transforming the online buying experience in the MENA region. HyperPay enable internet businesses to accept and manage payments online, with more flexibility, security and ease.
+
+HyperPay have been processing online payments since 2014. Today, HyperPay go beyond the payment gateway, as we provide merchants across almost every industry, a full-suite of online payment solutions, to serve every need.
+
+
+## Installation
+
+```ruby
+gem 'HyperPay'
+```
+
+## Configuration
+
+`config/initializers/hyperpay.rb`
+```ruby
+HyperPay.configure do |config|
+  config.authorization = "HYPER_PAY_AUTH_TOKEN"
+  config.environment = :sandbox
+end
+```
+
+# Usage example
+
+### Generate Checkout ID
+```ruby
+  # Generate HyperPay Checkout ID
+  #
+  # Parameters:
+  # @entity_id Entity ID that was used to generate the Checkout ID
+  # @return [Hash] {"result"=>{"code"=>"000.200.100", "description"=>"successfully created checkout"}, "buildNumber"=>"a58fee65f51ad5776b3c44e9929ca39a62a7cb43@2024-03-04 12:55:38 +0000", "timestamp"=>"2024-03-05 13:50:22+0000", "ndc"=>"ABCE449B5FC84ED5A1C7174840C7A3F8.uat01-vm-tx03", "id"=>"ABCE449B5FC84ED5A1C7174840C7A3F8.uat01-vm-tx03"}
+
+  checkout = HyperPay::CopyAndPay.new.create_checkout_id do |params|
+    params.add "entityId", "HYPER_PAY_ENTITY_ID"
+    params.add "customer.email", "john@doe.com"
+    params.add "customer.mobile", "9665xxxxxxxx"
+    params.add "customer.givenName", "John"
+    params.add "customer.surname", "Doe"
+    params.add "billing.street1", "STREET_NAME"
+    params.add "billing.country", "SA"
+    params.add "billing.city", "Riyadh"
+    params.add "billing.state", ""
+    params.add "billing.postcode", "00000"
+    params.add "customParameters[3DS2_enrolled]", "true"
+    params.add "merchantTransactionId", "YOUR_INVOICE_NUMBER"
+    params.add "paymentType", "DB"
+    params.add "currency", "SAR"
+    params.add "amount", "100" # On Sandbox, HyperPay Can process non-decimal numbers only.
+  end
+
+  p checkout['id']
+  p checkout['result']['code']
+  p checkout['result']['description']
+
+```
+
+### Response
+```ruby
+{"result"=>{"code"=>"000.200.100", "description"=>"successfully created checkout"}, "buildNumber"=>"a58fee65f51ad5776b3c44e9929ca39a62a7cb43@2024-03-04 12:55:38 +0000", "timestamp"=>"2024-03-05 13:50:22+0000", "ndc"=>"ABCE449B5FC84ED5A1C7174840C7A3F8.uat01-vm-tx03", "id"=>"ABCE449B5FC84ED5A1C7174840C7A3F8.uat01-vm-tx03"}
+```
+
+### Get Payment Status for Checkout ID
+```ruby
+  # Get HyperPay payment status for a given checkout
+  #
+  # Parameters:
+  # @entity_id Entity ID that was used to generate the Checkout ID
+  # @checkout_id HyperPay Checkout ID
+  # @return [Hash] {"result"=>{"code"=>"000.200.000", "description"=>"transaction pending"}, "buildNumber"=>"a58fee65f51ad5776b3c44e9929ca39a62a7cb43@2024-03-04 12:55:38 +0000", "timestamp"=>"2024-03-05 13:50:29+0000", "ndc"=>"ABCE449B5FC84ED5A1C7174840C7A3F8.uat01-vm-tx03"}
+  def get_status(entity_id:, checkout_id:)
+    get("/v1/checkouts/#{checkout_id}/payment"+"?entityId=#{entity_id}")
+  end
+
+  checkout = HyperPay::CopyAndPay.new.get_status(entity_id: "", checkout_id: "")
+  p checkout['id']
+  p checkout['result']['code']
+  p checkout['result']['description']
+```
+
+### Response
+```ruby
+{"result"=>{"code"=>"000.200.000", "description"=>"transaction pending"}, "buildNumber"=>"a58fee65f51ad5776b3c44e9929ca39a62a7cb43@2024-03-04 12:55:38 +0000", "timestamp"=>"2024-03-05 13:50:29+0000", "ndc"=>"ABCE449B5FC84ED5A1C7174840C7A3F8.uat01-vm-tx03"}
+```
+
+## Backoffce Operations
+
+### Capture Payment
+```ruby
+HyperPay::CopyAndPay.new.capture_payment(entity_id:, checkout_id:, amount:, currency:)
+```
+
+### Refund Payment
+```ruby
+HyperPay::CopyAndPay.new.refund_payment(entity_id: "", checkout_id: "", amount: "", currency: "")
+```
+
+### Reverse a payment
+```ruby
+HyperPay::CopyAndPay.new.reverse_payment(entity_id: "", checkout_id: "")
+```
+
+
+## Authors
+
+- [Mohamad Kaakati (@kaakati)](https://www.github.com/kaakati)

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/HyperPay/base.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require "httparty"
+require "HyperPay/configuration"
+
+module HyperPay
+  class Base
+    include HTTParty
+
+    def initialize
+      self.class.base_uri base_url
+    end
+
+    private
+
+    def get(path)
+      request(:get, path)
+    end
+
+    def post(path, payload = {})
+      encoded_payload = URI.encode_www_form(payload)
+      request(:post, path, body: encoded_payload, headers: { "Content-Type" => "application/x-www-form-urlencoded" })
+    end
+
+    def put(path, payload = {})
+      request(:put, path, payload)
+    end
+
+    def delete(path)
+      request(:delete, path)
+    end
+
+    def request(method, path, options = {})
+      prepare_headers(options)
+      prepare_body(options)
+      response = self.class.send(method, path, options)
+      JSON.parse(response.body)
+    rescue HTTParty::Error, StandardError => e
+      { error: e.message }
+    end
+
+
+    def parse_response(response)
+      JSON.parse(response.body)
+    end
+
+    def base_url
+      HyperPay.configuration.environment == :sandbox ? "https://eu-test.oppwa.com" : "https://eu-prod.oppwa.com"
+    end
+
+    private
+
+    def prepare_headers(options)
+      content_type = options.dig(:headers, "Content-Type") == "application/x-www-form-urlencoded" ?
+                       "application/x-www-form-urlencoded" : "application/json"
+      default_headers = {
+        "Authorization" => "Bearer #{HyperPay.configuration.authorization}",
+        "Accept" => "application/json",
+        "Content-Type" => content_type
+      }
+      options[:headers] = default_headers.merge(options[:headers] || {})
+    end
+
+    def prepare_body(options)
+      if options[:body] && options[:headers]["Content-Type"] == "application/json"
+        options[:body] = options[:body].to_json unless options[:body].is_a?(String)
+      end
+    end
+  end
+end

data/lib/HyperPay/configuration.rb

@@ -0,0 +1,9 @@
+module HyperPay
+  class Configuration
+    attr_accessor :authorization, :environment
+
+    def initialize
+      @environment = :sandbox # Default to sandbox
+    end
+  end
+end

data/lib/HyperPay/copy_and_pay.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require "HyperPay/payment_parameter_builder"
+require "HyperPay/base"
+
+module HyperPay
+  class CopyAndPay < HyperPay::Base
+    # Generate HyperPay Checkout ID
+    #
+    # Parameters:
+    # @entity_id Entity ID that was used to generate the Checkout ID
+    # @return [Hash] {"result"=>{"code"=>"000.200.100", "description"=>"successfully created checkout"}, "buildNumber"=>"a58fee65f51ad5776b3c44e9929ca39a62a7cb43@2024-03-04 12:55:38 +0000", "timestamp"=>"2024-03-05 13:50:22+0000", "ndc"=>"ABCE449B5FC84ED5A1C7174840C7A3F8.uat01-vm-tx03", "id"=>"ABCE449B5FC84ED5A1C7174840C7A3F8.uat01-vm-tx03"}
+    def create_checkout_id(&block)
+      builder = PaymentParameterBuilder.new
+      yield(builder) if block_given?
+      builder.validate! # Perform validations
+      post("/v1/checkouts", builder.parameters)
+    end
+
+    # Get HyperPay payment status for a given checkout
+    #
+    # Parameters:
+    # @entity_id Entity ID that was used to generate the Checkout ID
+    # @checkout_id HyperPay Checkout ID
+    # @return [Hash] {"result"=>{"code"=>"000.200.000", "description"=>"transaction pending"}, "buildNumber"=>"a58fee65f51ad5776b3c44e9929ca39a62a7cb43@2024-03-04 12:55:38 +0000", "timestamp"=>"2024-03-05 13:50:29+0000", "ndc"=>"ABCE449B5FC84ED5A1C7174840C7A3F8.uat01-vm-tx03"}
+    def get_status(entity_id:, checkout_id:)
+      get("/v1/checkouts/#{checkout_id}/payment"+"?entityId=#{entity_id}")
+    end
+
+    # Capture an authorization
+    # A capture is used to request clearing for previously authorized funds.
+    # Captures can be for full or partial amounts and multiple capture requests against the same PA are allowed.
+    #
+    # Parameters:
+    # @entity_id Entity ID that was used to generate the Checkout ID
+    # @checkout_id HyperPay Checkout ID
+    # @amount Amount
+    # @currency Currency
+    def capture_payment(entity_id:, checkout_id:, amount:, currency:)
+      post("/v1/payments/#{checkout_id}", { entityId: entity_id, paymentType: "CP", currency: currency, amount: amount })
+    end
+
+    # Refund a payment
+    # A refund is performed against a previous payment, referencing its `payment.id` by
+    # sending a POST request over HTTPS to the /payments/{id} endpoint.
+    # A refund can be performed against debit (DB) or captured pre-authorization (PA->CP) payment types.
+    # Where supported, the amount field can be used to process a partial or full amount.
+    #
+    # Parameters:
+    # @entity_id Entity ID that was used to generate the Checkout ID
+    # @checkout_id HyperPay Checkout ID
+    # @amount Amount
+    # @currency Currency
+    def refund_payment(entity_id:, checkout_id:, amount:, currency:)
+      post("/v1/payments/#{checkout_id}", { entityId: entity_id, amount: amount, currency: currency, paymentType: "RF" })
+    end
+
+    # Reverse a payment
+    # A reversal is performed against a previous payment, referencing its payment.id
+    # by sending a POST request over HTTPS to the /payments/{id} endpoint.
+    # A reversal should be sent against pre-authorization (PA) payment type.
+    # When reversing a card payment and if sent within the time-frame the authorization is not captured yet,
+    # the reversal causes an authorization reversal request to be sent to the card issuer
+    # to clear the funds held against the authorization.
+    #
+    # Parameters:
+    # @entity_id Entity ID that was used to generate the Checkout ID
+    # @checkout_id HyperPay Checkout ID
+    def reverse_payment(entity_id:, checkout_id:)
+      post("/v1/payments/#{checkout_id}", { entityId: entity_id, paymentType: "RV" })
+    end
+  end
+end
+

data/lib/HyperPay/payment_parameter_builder.rb

@@ -0,0 +1,24 @@
+module HyperPay
+  class PaymentParameterBuilder
+    REQUIRED_PARAMETERS = %w[entityId customer.email customer.mobile customer.givenName customer.surname billing.street1 billing.city billing.state billing.country billing.postcode customParameters[3DS2_enrolled] merchantTransactionId paymentType currency amount].freeze
+
+    attr_reader :parameters
+
+    def initialize
+      @parameters = {}
+    end
+
+    # Implementation of `add` method returns `self` to allow chaining
+    def add(key, value)
+      @parameters[key] = value
+      self # Return self to allow chaining
+    end
+
+    def validate!
+      missing_params = REQUIRED_PARAMETERS - @parameters.keys
+      unless missing_params.empty?
+        raise ArgumentError, "Missing required parameters: #{missing_params.join(', ')}"
+      end
+    end
+  end
+end

data/lib/HyperPay/version.rb

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

data/lib/hyper_pay.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative "HyperPay/version"
+require_relative "HyperPay/configuration"
+require_relative "HyperPay/copy_and_pay"
+
+module HyperPay
+  class Error < StandardError; end
+
+  class << self
+    attr_accessor :configuration
+
+    def configure
+      self.configuration ||= Configuration.new
+      yield(configuration)
+    end
+  end
+
+end

data/sig/HyperPay.rbs

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

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: HyperPay
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mohamad Kaakati
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: HyperPay is a wrapper around HyperPay Copy And Pay API. It provides a
+  simple way to integrate with HyperPay's MENA payment gateway.
+email:
+- m@kaakati.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".idea/.gitignore"
+- ".idea/hyperpay.iml"
+- ".idea/modules.xml"
+- ".idea/vcs.xml"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- HyperPay.gemspec
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/HyperPay/base.rb
+- lib/HyperPay/configuration.rb
+- lib/HyperPay/copy_and_pay.rb
+- lib/HyperPay/payment_parameter_builder.rb
+- lib/HyperPay/version.rb
+- lib/hyper_pay.rb
+- sig/HyperPay.rbs
+homepage: https://kaakati.me/
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://kaakati.me/
+  source_code_uri: https://github.com/kaakati/hyperpay_ruby
+  changelog_uri: https://github.com/kaakati/hyperpay_ruby/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+- README.md
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.6
+signing_key:
+specification_version: 4
+summary: A wrapper around HyperPay Copy And Pay API.
+test_files: []