paygate_pk 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b06b7bfef5146c0fffbe72c7f1c173b08abb1873ec492a25b7b6e2366ebfbd45
+  data.tar.gz: d44d8b3169b624f1a0aa2b2e06c4754fc90136b4d055aad1b90121cc6d2faee1
+SHA512:
+  metadata.gz: f7f8bb5aea01aac11d7579b384e9c7d4e63a03d367e77bc05d9ff48aed3959255f4f3aa54119a39cbe04be82d86ea80e2d3e5c8dfb842e697d31f1bd4fba91c0
+  data.tar.gz: 23131a34e78b2fb40bfe1ae582276766cccd997b3bcdbbef95b4d5021340c7dc28e59d6ce7f48b8049add3950082d13590b658f0b80ff5d47aca4151f1706369

data/.rubocop.yml

@@ -0,0 +1,24 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 20 # Example: Set maximum method length to 15 lines
+  CountAsOne:
+    - array
+    - hash
+    - heredoc
+    - method_call
+
+Metrics/AbcSize:
+  Max: 20

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+## [0.1.0] - 2025-10-01
+
+- Initial release.
+- PayFast: GetAccessToken + Checkout (HTML redirect parsing).
+- Config, errors, HTTP client, tests, CI scaffolding.

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 talhajunaid65@gmail.com. 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/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in paygate_pk.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,92 @@
+PATH
+  remote: .
+  specs:
+    paygate_pk (0.1.0)
+      faraday (>= 2.7)
+      faraday-retry (>= 2.0)
+      json
+      nokogiri (>= 1.16, < 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
+    ast (2.4.3)
+    bigdecimal (3.2.3)
+    crack (1.0.0)
+      bigdecimal
+      rexml
+    docile (1.4.1)
+    faraday (2.13.1)
+      faraday-net_http (>= 2.0, < 3.5)
+      json
+      logger
+    faraday-net_http (3.4.1)
+      net-http (>= 0.5.0)
+    faraday-retry (2.3.2)
+      faraday (~> 2.0)
+    hashdiff (1.2.1)
+    json (2.12.2)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    logger (1.7.0)
+    minitest (5.25.5)
+    net-http (0.6.0)
+      uri
+    nokogiri (1.18.9-x86_64-darwin)
+      racc (~> 1.4)
+    parallel (1.27.0)
+    parser (3.3.8.0)
+      ast (~> 2.4.1)
+      racc
+    prism (1.5.1)
+    public_suffix (6.0.2)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.3.0)
+    regexp_parser (2.10.0)
+    rexml (3.4.4)
+    rubocop (1.78.0)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.45.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.46.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    ruby-progressbar (1.13.0)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.13.2)
+    simplecov_json_formatter (0.1.4)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+    uri (1.0.3)
+    webmock (3.25.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  x86_64-darwin-24
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  paygate_pk!
+  rake (~> 13.0)
+  rubocop (~> 1.21)
+  simplecov (>= 0.22)
+  webmock
+
+BUNDLED WITH
+   2.4.8

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Talha Junaid
+
+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,118 @@
+# PaygatePk
+
+Unified Ruby wrapper for PayFast (and soon Easypaisa) payments in Pakistan.
+
+This gem provides a clean, provider-agnostic interface to obtain access tokens and create hosted checkouts with PayFast. It wraps HTTP details, validates required fields, and exposes simple, Ruby-friendly objects. Rails-friendly configuration is included; IPN verification and recurring/tokenized flows are on the roadmap.
+
+## Requirements
+
+- Ruby ≥ 3.1
+- Faraday (runtime, included by gemspec)
+- Nokogiri (runtime, for HTML redirect parsing, included)
+- (Dev) Byebug, SimpleCov, RuboCop — optional
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add "paygate_pk", "~> 0.1.0"
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install "paygate_pk", "~> 0.1.0"
+
+## Usage
+
+# Initializer
+
+```ruby
+# config/initializers/paygate_pk.rb
+
+PaygatePk.configure do |c|
+  c.default_currency = "PKR"
+  c.user_agent = "paygate_pk/#{PaygatePk::VERSION}"
+
+  # PayFast base host only; endpoints include /Ecommerce/api internally
+
+  c.payfast.base_url = "https://ipguat.apps.net.pk"
+  c.payfast.merchant_id = ENV.fetch("PAYFAST_MERCHANT_ID")
+  c.payfast.secured_key = ENV.fetch("PAYFAST_SECURED_KEY")
+  c.payfast.checkout_mode = :immediate # or :delayed
+
+  # Optional: tune timeouts & retries
+
+  c.timeouts = { open_timeout: 5, read_timeout: 10 }
+  c.retry = { max: 2, interval: 0.2, backoff_factor: 2.0, retry_statuses: [429, 500, 502, 503, 504] }
+end
+```
+
+## QuickStart
+
+# 1) Get Access Token (PayFast)
+
+```ruby
+auth = PaygatePk::Providers::PayFast::Auth.new(config: PaygatePk.config.payfast)
+
+token_obj = auth.get_access_token(
+basket_id: "B-1001",
+amount: 1500
+
+# currency: "PKR", # optional; defaults to PaygatePk.config.default_currency
+
+# endpoint: "/Ecommerce/api/Transaction/GetAccessToken" # optional override
+
+)
+
+puts token_obj.token # => "ACCESS_TOKEN_STRING"
+
+```
+
+# 2) Create Hosted Checkout (PayFast)
+
+```ruby
+checkout = PaygatePk::Providers::PayFast::Checkout.new(config: PaygatePk.config.payfast)
+
+hc = checkout.create!(opts: {
+  token:       token_obj.token,
+  basket_id:   "B-1001",
+  amount:      1500, # paisa (Rs 15.00)
+  customer:    { mobile: "03001234567", email: "buyer@example.com" },
+  success_url: "https://your-app.example.com/payments/success",
+  failure_url: "https://your-app.example.com/payments/failure",
+  description: "Order #1001"
+  # checkout_mode: :immediate,  # optional; default from config
+  # endpoint: "/Ecommerce/api/Transaction/PostTransaction" # optional override
+})
+
+hc.url # => "https://gateway.payfast/redirect/ABC123"
+# Redirect the buyer to hc.url
+```
+
+# Error handling
+
+All errors inherit from PaygatePk::Error:
+
+- PaygatePk::ConfigurationError — missing/invalid configuration (e.g., merchant_id, secured_key, or base_url).
+- PaygatePk::ValidationError — missing required method arguments or required form fields.
+- PaygatePk::HTTPError — network/HTTP failure (wraps response status & body).
+- PaygatePk::AuthError — auth call succeeded at HTTP level but token missing/invalid in body.
+- PaygatePk::SignatureError — reserved for webhook/IPN verification (upcoming).
+- PaygatePk::ProviderError — reserved for provider business-rule failures.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/[USERNAME]/paygate_pk. 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/[USERNAME]/paygate_pk/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 PaygatePk project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/paygate_pk/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/paygate_pk/config.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module PaygatePk
+  # Global configuration for PaygatePk
+  class Config
+    attr_accessor :logger, :default_currency, :timeouts, :retry, :user_agent
+    attr_reader   :pay_fast
+
+    def initialize
+      @logger = nil
+      @default_currency = "PKR"
+      @timeouts = { open_timeout: 5, read_timeout: 10 }
+      @retry = { max: 2, interval: 0.2, backoff_factor: 2.0, retry_statuses: [429, 500, 502, 503, 504] }
+      @user_agent = "paygate_pk/#{PaygatePk::VERSION}"
+
+      @pay_fast = ProviderConfig.new
+      @frozen = false
+    end
+
+    def freeze!
+      @frozen = true
+      self
+    end
+
+    def frozen?
+      @frozen
+    end
+
+    # Provider-specific configuration
+    class ProviderConfig
+      attr_accessor :base_url, :merchant_id, :secured_key, :checkout_mode, :username, :password, :store_id
+
+      def initialize
+        @base_url = nil
+        @merchant_id = nil
+        @secured_key = nil
+        @checkout_mode = :immediate
+        @username = nil
+        @password = nil
+        @store_id = nil
+      end
+    end
+  end
+end

data/lib/paygate_pk/contracts/access_token.rb

@@ -0,0 +1,8 @@
+# lib/paygate_pk/contracts/access_token.rb
+# frozen_string_literal: true
+
+module PaygatePk
+  module Contracts
+    AccessToken = Struct.new(:token, :raw, keyword_init: true)
+  end
+end

data/lib/paygate_pk/contracts/hosted_checkout.rb

@@ -0,0 +1,8 @@
+# lib/paygate_pk/contracts/access_token.rb
+# frozen_string_literal: true
+
+module PaygatePk
+  module Contracts
+    HostedCheckout = Struct.new(:provider, :basket_id, :amount, :url, :raw, :form, keyword_init: true)
+  end
+end

data/lib/paygate_pk/errors.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module PaygatePk
+  class Error < StandardError; end
+  class ConfigurationError < Error; end
+
+  # Raised when a request validation fails.
+  class ValidationError < Error
+    attr_reader :details
+
+    def initialize(msg = "validation failed", details: {})
+      @details = details
+      super(msg)
+    end
+  end
+
+  # Raised for HTTP errors, e.g. non-2xx responses.
+  class HTTPError < Error
+    attr_reader :status, :body
+
+    def initialize(message = "http error", status: nil, body: nil)
+      @status = status
+      @body = body
+      super(message)
+    end
+  end
+
+  class AuthError < Error; end
+  class SignatureError < Error; end
+  class ProviderError < Error; end
+end

data/lib/paygate_pk/http/client.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "faraday/retry"
+require "json"
+require "securerandom"
+
+module PaygatePk
+  module HTTP
+    # Simple HTTP client using Faraday
+    class Client
+      def initialize(base_url:, headers: {}, timeouts: {}, retry_conf: {}, logger: nil)
+        @conn = Faraday.new(url: base_url) do |f|
+          f.request :retry,
+                    max: retry_conf[:max] || 2,
+                    interval: retry_conf[:interval] || 0.2,
+                    backoff_factor: retry_conf[:backoff_factor] || 2.0,
+                    retry_statuses: retry_conf[:retry_statuses] || [429, 500, 502, 503, 504]
+
+          f.request :url_encoded
+          f.response :raise_error
+          f.adapter Faraday.default_adapter
+        end
+
+        @headers  = headers
+        @timeouts = timeouts
+        @logger   = logger
+      end
+
+      def post(path, json: nil, form: nil, headers: {})
+        request(:post, path, json: json, form: form, headers: headers)
+      end
+
+      def get(path, params: {}, headers: {})
+        request(:get, path, params: params, headers: headers)
+      end
+
+      private
+
+      # rubocop:disable Metrics/ParameterLists
+      def request(method, path, json: nil, form: nil, params: nil, headers: {})
+        resp = execute_request(method, path, params, headers) do |req|
+          configure_timeouts(req)
+          set_request_body(req, json, form)
+        end
+
+        log_response(resp)
+        parse_body(resp)
+      rescue Faraday::ClientError => e
+        handle_client_error(e)
+      end
+      # rubocop:enable Metrics/ParameterLists
+
+      def execute_request(method, path, params, headers)
+        @conn.run_request(method, path, nil, merged_headers(headers)) do |req|
+          req.params.update(params) if params
+          yield req if block_given?
+        end
+      end
+
+      def merged_headers(headers)
+        base_headers.merge(headers)
+      end
+
+      def configure_timeouts(req)
+        req.options.timeout = @timeouts[:read_timeout] if @timeouts[:read_timeout]
+        req.options.open_timeout = @timeouts[:open_timeout] if @timeouts[:open_timeout]
+      end
+
+      def set_request_body(req, json, form)
+        if json
+          set_json_body(req, json)
+        elsif form
+          set_form_body(req, form)
+        end
+      end
+
+      def set_json_body(req, json)
+        req.headers["Content-Type"] = "application/json"
+        req.body = JSON.generate(json)
+      end
+
+      def set_form_body(req, form)
+        req.headers["Content-Type"] = "application/x-www-form-urlencoded"
+        req.body = URI.encode_www_form(form)
+      end
+
+      def handle_client_error(error)
+        body = error.response&.dig(:body)
+        status = error.response&.dig(:status)
+
+        raise PaygatePk::HTTPError.new(
+          error.message,
+          status: status,
+          body: body
+        )
+      end
+
+      def base_headers
+        {
+          "User-Agent" => PaygatePk.config.user_agent || "paygate_pk",
+          "X-Request-Id" => SecureRandom.uuid
+        }.merge(@headers)
+      end
+
+      def parse_body(resp)
+        b = resp.body
+        if b.is_a?(String) && !b.empty?
+          begin
+            JSON.parse(b)
+          rescue StandardError
+            b
+          end
+        else
+          b
+        end
+      end
+
+      def log_response(resp)
+        return unless @logger
+
+        @logger.info("paygate_pk http #{resp.env.method.upcase} #{resp.env.url} -> #{resp.status}")
+      end
+    end
+  end
+end

data/lib/paygate_pk/providers/pay_fast/auth.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "date"
+
+module PaygatePk
+  module Providers
+    module PayFast
+      # Auth client for PayFast API
+      class Auth < Client
+        ENDPOINT = "/Ecommerce/api/Transaction/GetAccessToken"
+
+        # Returns Contracts::AccessToken
+        # Required by PayFast: MERCHANT_ID, SECURED_KEY, BASKET_ID, TXNAMT, CURRENCY_CODE
+        #
+        def get_access_token(basket_id:, amount:, currency: PaygatePk.config.default_currency, endpoint: ENDPOINT)
+          ensure_config!
+          ensure_args!(basket_id: basket_id, amount: amount, currency: currency)
+
+          # Guide endpoint: .../Ecommerce/api/Transaction/GetAccessToken
+          resp  = http.post(endpoint,
+                            form: payload(basket_id, amount, currency))
+          token = resp.is_a?(Hash) ? (resp["ACCESS_TOKEN"] || resp["access_token"]) : nil
+          raise AuthError, "missing ACCESS_TOKEN in response" unless token
+
+          Contracts::AccessToken.new(token: token, raw: resp)
+        end
+
+        private
+
+        def ensure_config!
+          missing = []
+          missing << :merchant_id if @config.merchant_id.to_s.strip.empty?
+          missing << :secured_key if @config.secured_key.to_s.strip.empty?
+          raise ConfigurationError, "PayFast config missing: #{missing.join(", ")}" unless missing.empty?
+        end
+
+        def ensure_args!(basket_id:, amount:, currency:)
+          missing = []
+          missing << :basket_id if basket_id.to_s.strip.empty?
+          missing << :amount if amount.nil?
+          missing << :currency if currency.to_s.strip.empty?
+          raise ValidationError, "missing required args: #{missing.join(", ")}" unless missing.empty?
+        end
+
+        def payload(basket_id, amount, currency)
+          {
+            "MERCHANT_ID" => @config.merchant_id,
+            "SECURED_KEY" => @config.secured_key,
+            "BASKET_ID" => basket_id,
+            "TXNAMT" => amount.to_s,
+            "CURRENCY_CODE" => currency
+          }
+        end
+      end
+    end
+  end
+end

data/lib/paygate_pk/providers/pay_fast/checkout.rb

@@ -0,0 +1,153 @@
+# lib/paygate_pk/providers/pay_fast/checkout.rb
+# frozen_string_literal: true
+
+require "securerandom"
+require "date"
+require "nokogiri"
+
+module PaygatePk
+  module Providers
+    module PayFast
+      # Builds and submits a hosted checkout request to PayFast.
+      #
+      # Usage:
+      #   client   = PaygatePk::Providers::PayFast::Checkout.new(config: PaygatePk.config.payfast)
+      #   checkout = client.create!(
+      #     token: token.token,
+      #     basket_id: "B-1001",
+      #     amount: 1500,
+      #     customer: { mobile: "03xxxxxxxxx", email: "buyer@example.com" },
+      #     success_url: "...",
+      #     failure_url: "...",
+      #     description: "Order #1001",
+      #     checkout_mode: :immediate
+      #   )
+      class Checkout < Client
+        ENDPOINT = "/Ecommerce/api/Transaction/PostTransaction"
+
+        REQUIRED_ROOT_KEYS     = %i[token basket_id amount success_url failure_url description].freeze
+        REQUIRED_CUSTOMER_KEYS = %i[mobile email].freeze
+
+        # Creates a hosted checkout via PayFast.
+        #
+        # @param token [String] ACCESS_TOKEN from GetAccessToken
+        # @param basket_id [String]
+        # @param amount [Integer, Float] rupees
+        # @param customer [Hash] keys: :mobile, :email
+        # @param success_url [String]
+        # @param failure_url [String]
+        # @param description [String] TXNDESC
+        # @param order_date [Date] defaults: Date.today
+        # @param checkout_mode [Symbol] :immediate or :delayed (defaults from config)
+        # @param endpoint [Symbol] default to ENDPOINT constant
+
+        # @return [PaygatePk::Contracts::HostedCheckout]
+        def create!(opts: {})
+          validate_config!
+          validate_args!(opts)
+
+          form = build_form(opts)
+
+          response = http.post(opts[:endpoint] || ENDPOINT, form: form)
+
+          PaygatePk::Contracts::HostedCheckout.new(
+            provider: :payfast,
+            basket_id: opts[:basket_id],
+            amount: opts[:amount],
+            url: PaygatePk::Util::Html.first_anchor_href(response),
+            form: PaygatePk::Util::Html.extract_form(response),
+            raw: response
+          )
+        end
+
+        private
+
+        # -- Validation ---------------------------------------------------------
+
+        def validate_config!
+          missing = []
+          missing << :merchant_id if blank?(config.merchant_id)
+          missing << :secured_key if blank?(config.secured_key)
+          raise PaygatePk::ConfigurationError, "PayFast config missing: #{missing.join(", ")}" unless missing.empty?
+        end
+
+        def validate_args!(opts)
+          missing = []
+          REQUIRED_ROOT_KEYS.each do |k|
+            v = opts[k]
+            missing << k if k == :amount ? opts[:amount].nil? : blank?(v)
+          end
+          REQUIRED_CUSTOMER_KEYS.each { |k| missing << :"customer.#{k}" if blank?(opts[:customer][k]) }
+          raise PaygatePk::ValidationError, "missing required args: #{missing.join(", ")}" unless missing.empty?
+        end
+
+        # -- Builders -----------------------------------------------------------
+
+        def merchant_params
+          {
+            "MERCHANT_ID" => config.merchant_id,
+            "MERCHANT_NAME" => merchant_name_default
+          }
+        end
+
+        def order_params(opts)
+          {
+            "BASKET_ID" => opts[:basket_id],
+            "TXNDESC" => opts[:description],
+            "TXNAMT" => opts[:amount].to_s,
+            "CURRENCY_CODE" => PaygatePk.config.default_currency,
+            "ORDER_DATE" => (opts[:order_date] || Date.today).to_s,
+            "SUCCESS_URL" => opts[:success_url],
+            "FAILURE_URL" => opts[:failure_url],
+            "CHECKOUT_URL" => normalize_checkout_mode(opts[:checkout_mode] || config.checkout_mode)
+          }
+        end
+
+        def customer_params(opts)
+          {
+            "CUSTOMER_MOBILE_NO" => opts[:customer][:mobile],
+            "CUSTOMER_EMAIL_ADDRESS" => opts[:customer][:email]
+          }
+        end
+
+        def generic_params(opts)
+          {
+            "TOKEN" => opts[:token],
+            "PROCCODE" => "00",
+            "SIGNATURE" => SecureRandom.hex(16),
+            "VERSION" => PaygatePk::VERSION
+          }
+        end
+
+        def build_form(opts)
+          merchant_params
+            .merge(order_params(opts))
+            .merge(customer_params(opts))
+            .merge(generic_params(opts))
+        end
+
+        # -- Helpers ------------------------------------------------------------
+
+        def normalize_checkout_mode(mode)
+          case mode&.to_sym
+          when :delayed then "DELAYED"
+          when :immediate, nil then "IMMEDIATE"
+          else
+            # Be lenient but explicit: unknown symbols fall back to IMMEDIATE
+            "IMMEDIATE"
+          end
+        end
+
+        def merchant_name_default
+          # Kept blank as many integrations treat it as optional; override here
+          # later if you decide to expose it via config.
+          ""
+        end
+
+        def blank?(value)
+          value.nil? || (value.respond_to?(:empty?) && value.empty?)
+        end
+      end
+    end
+  end
+end

data/lib/paygate_pk/providers/pay_fast/client.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "../../http/client"
+require_relative "../../version"
+
+module PaygatePk
+  module Providers
+    module PayFast
+      # HTTP client for PayFast API
+      class Client
+        def initialize(config: PaygatePk.config.pay_fast)
+          @config = config
+        end
+
+        private
+
+        attr_reader :config
+
+        def http
+          raise ConfigurationError, "PayFast base_url not set" unless config.base_url
+
+          PaygatePk::HTTP::Client.new(
+            base_url: config.base_url,
+            headers: { "Accept" => "application/json" },
+            timeouts: PaygatePk.config.timeouts,
+            retry_conf: PaygatePk.config.retry,
+            logger: PaygatePk.config.logger
+          )
+        end
+      end
+    end
+  end
+end

data/lib/paygate_pk/util/html.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "nokogiri"
+
+module PaygatePk
+  module Util
+    # HTML parsing utilities
+    module Html
+      module_function
+
+      # Extract a specific <form> (default: first) into a hash of action/method/inputs
+      def extract_form(html, index: 0)
+        doc  = parse(html)
+        form = doc.css("form")[index]
+        return nil unless form
+
+        {
+          action: form["action"],
+          method: (form["method"] || "GET").upcase,
+          inputs: form.css("input[name]").to_h { |i| [i["name"], i["value"]] }
+        }
+      end
+
+      # NEW: Return the first anchor href (or nil) – handy for redirect pages
+      # Optionally pass a CSS selector (e.g., "a.pay-button") if you need a specific link.
+      def first_anchor_href(html, selector: "a")
+        doc = parse(html)
+        a   = doc.at(selector)
+        a ? a["href"] : nil
+      end
+
+      # --- internals ----------------------------------------------------------
+
+      def parse(html)
+        Nokogiri::HTML5(html)
+      rescue NoMethodError
+        # Fallback for environments without HTML5 parser
+        Nokogiri::HTML(html)
+      end
+    end
+  end
+end

data/lib/paygate_pk/version.rb

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

data/lib/paygate_pk.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative "paygate_pk/version"
+require_relative "paygate_pk/errors"
+require_relative "paygate_pk/config"
+require_relative "paygate_pk/http/client"
+
+# Contracts used by the endpoint
+require_relative "paygate_pk/contracts/access_token"
+require_relative "paygate_pk/contracts/hosted_checkout"
+
+# PayFast
+require_relative "paygate_pk/providers/pay_fast/client"
+require_relative "paygate_pk/providers/pay_fast/auth"
+require_relative "paygate_pk/providers/pay_fast/checkout"
+
+require_relative "paygate_pk/util/html"
+
+# Main module for PaygatePk
+module PaygatePk
+  class << self
+    def configure
+      yield(config)
+      config.freeze!
+    end
+
+    def config
+      @config ||= PaygatePk::Config.new
+    end
+  end
+end

data/paygate_pk.gemspec

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative "lib/paygate_pk/version"
+
+Gem::Specification.new do |spec|
+  spec.name       = "paygate_pk"
+  spec.version    = PaygatePk::VERSION
+  spec.authors    = ["Talha Junaid"]
+  spec.email      = ["talhajunaid65@gmail.com"]
+  spec.summary    = "Unified Ruby wrapper for PayFast"
+  spec.description = "Provider-agnostic Ruby/Rails client for PayFast: checkout, webhooks/IPN verification,
+                      tokenized & recurring payments."
+  spec.license     = "MIT"
+  spec.homepage    = "https://github.com/qbitechs/paygate_pk"
+  spec.metadata    = {
+    "source_code_uri" => "https://github.com/qbitechs/paygate_pk",
+    "changelog_uri" => "https://github.com/qbitechs/paygate_pk/blob/main/CHANGELOG.md",
+    "homepage_url" => spec.homepage
+  }
+
+  spec.required_ruby_version = ">= 2.6.0"
+
+  # 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 .circleci appveyor])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = %w[lib test]
+
+  # Runtime deps
+  spec.add_dependency "faraday", ">= 2.7"
+  spec.add_dependency "faraday-retry", ">= 2.0"
+  spec.add_dependency "json"
+
+  # spec.add_development_dependency "byebug"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_dependency "nokogiri", ">= 1.16", "< 2.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rubocop", "~> 1.21"
+  spec.add_development_dependency "simplecov", ">= 0.22"
+  spec.add_development_dependency "webmock"
+end

data/sig/paygate_pk.rbs

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

metadata

@@ -0,0 +1,202 @@
+--- !ruby/object:Gem::Specification
+name: paygate_pk
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Talha Junaid
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-10-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: faraday-retry
+  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: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.16'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.16'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.22'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |-
+  Provider-agnostic Ruby/Rails client for PayFast: checkout, webhooks/IPN verification,
+                        tokenized & recurring payments.
+email:
+- talhajunaid65@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/paygate_pk.rb
+- lib/paygate_pk/config.rb
+- lib/paygate_pk/contracts/access_token.rb
+- lib/paygate_pk/contracts/hosted_checkout.rb
+- lib/paygate_pk/errors.rb
+- lib/paygate_pk/http/client.rb
+- lib/paygate_pk/providers/pay_fast/auth.rb
+- lib/paygate_pk/providers/pay_fast/checkout.rb
+- lib/paygate_pk/providers/pay_fast/client.rb
+- lib/paygate_pk/util/html.rb
+- lib/paygate_pk/version.rb
+- paygate_pk.gemspec
+- sig/paygate_pk.rbs
+homepage: https://github.com/qbitechs/paygate_pk
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/qbitechs/paygate_pk
+  changelog_uri: https://github.com/qbitechs/paygate_pk/blob/main/CHANGELOG.md
+  homepage_url: https://github.com/qbitechs/paygate_pk
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+- test
+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.4.3
+signing_key:
+specification_version: 4
+summary: Unified Ruby wrapper for PayFast
+test_files: []