zai_payment 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 719c0663d33f0ced4d8bcc6627dd58ce98b8c14f436d9ce02210f01fc04b99d3
+  data.tar.gz: 85e8ae991cec90cd59e11f8234cdff9a7f684d4c5632bd9fd4659dc1af4ccedf
+SHA512:
+  metadata.gz: 1536177552b6ba2e10bb61734f574e697275cba87c74af530bbf8c125f37927f1cb2bf5de7dc4b94dffaaccd563f4d9f49ab96d1d40bf6fc5511f1ddf51adf11
+  data.tar.gz: 843f7c8d8650fc974af5a701d33e139cc1170a84cf064d765bc31729a0c3cd95487e4e51d4c06595a2e70bcc3f104a908d39c00343acc89d9054d146c7f31d9a

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## [Unreleased]
+
+## [1.0.0] - 2025-10-21
+
+- Initial release: token auth client with in-memory caching (`ZaiPayment.token`, `refresh_token!`, `clear_token!`, `token_type`, `token_expiry`)
+
+**Full Changelog**: https://github.com/Sentia/zai-payment/commits/v1.0.0

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
+contact@sentia.com.au.
+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) 2025 Eddy Jaga
+
+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,135 @@
+# Zai Payment Ruby Library
+
+[![CI](https://github.com/Sentia/zai-payment/actions/workflows/ci.yml/badge.svg)](https://github.com/Sentia/zai-payment/actions/workflows/ci.yml)
+
+A lightweight and extensible Ruby client for the **Zai (AssemblyPay)** API — starting with secure OAuth2 authentication, and ready for Payments, Virtual Accounts, Webhooks, and more.
+
+---
+
+## ✨ Features
+
+- 🔐 OAuth2 Client Credentials authentication with automatic token management  
+- 🧠 Smart token caching and refresh  
+- ⚙️ Environment-aware (Pre-live / Production)  
+- 🧱 Modular structure: easy to extend to Payments, Wallets, Webhooks, etc.  
+- 🧩 Thread-safe in-memory store (Redis support coming soon)  
+- 🧰 Simple Ruby API, no heavy dependencies  
+
+---
+
+## 🧭 Installation
+
+### From GitHub (private repo)
+Add this line to your Gemfile:
+
+```ruby
+gem "zai_payment",
+    git: "https://github.com/Sentia/zai-payment.git",
+    branch: "main"
+```
+
+Then install
+
+```bash
+bundle install
+```
+
+## ⚙️ Configuration
+
+```ruby
+# config/initializers/zai_payment.rb
+ZaiPayment.configure do |c|
+  c.environment   = Rails.env.production? ? :production : :prelive
+  c.client_id     = ENV.fetch("ZAI_CLIENT_ID")
+  c.client_secret = ENV.fetch("ZAI_CLIENT_SECRET")
+  c.scope         = ENV.fetch("ZAI_OAUTH_SCOPE")
+end
+```
+
+## 🚀 Authentication
+
+The Zai Payment gem implements OAuth2 Client Credentials flow for secure authentication with the Zai API. The gem intelligently manages your authentication tokens behind the scenes, so you don't have to worry about token expiration or manual refreshes.
+
+When you request a token, the gem automatically caches it and reuses it for subsequent requests. Since Zai tokens expire after 60 minutes, the gem monitors the token lifetime and seamlessly refreshes it before expiration — ensuring your API calls never fail due to stale credentials.
+
+This automatic token management means you can focus on building your integration while the gem handles all the authentication complexity for you. Simply configure your credentials once, and the gem takes care of the rest.
+
+For more details about Zai's OAuth2 authentication, see the [official documentation](https://developer.hellozai.com/reference/overview#authentication).
+
+```ruby
+client = ZaiPayment::Auth::TokenProvider.new(config: ZaiPayment.config)
+
+client.bearer_token
+```
+
+Or, more easily, you can get a token with the convenience one-liner:
+
+
+```ruby
+ZaiPayment.token
+```
+
+## 🧩 Roadmap
+
+| Area                            | Description                       | Status         |
+| ------------------------------- | --------------------------------- | -------------- |
+| ✅ Authentication                | OAuth2 Client Credentials flow    | Done           |
+| 💳 Payments                     | Single and recurring payments     | 🚧 In progress |
+| 🏦 Virtual Accounts (VA / PIPU) | Manage virtual accounts & PayTo   | ⏳ Planned      |
+| 🧾 Webhooks                     | CRUD for webhook endpoints        | ⏳ Planned      |
+| 👤 Users                        | Manage PayIn / PayOut users       | ⏳ Planned      |
+| 💼 Wallets                      | Create and manage wallet accounts | ⏳ Planned      |
+
+## 🧪 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`.
+
+### Running Tests
+
+```bash
+bundle exec rspec
+```
+
+### Code Quality
+
+This project uses RuboCop for linting. Run it with:
+
+```bash
+bundle exec rubocop
+```
+
+### Interactive Console
+
+For development and testing, use the interactive console:
+
+```bash
+bin/console
+```
+
+This will load the gem and all its dependencies, allowing you to experiment with the API in a REPL environment.
+
+## 🧾 Versioning
+This gem follows [Semantic Versioning](https://semver.org).
+
+See [CHANGELOG.md](./CHANGELOG.md) for release history.
+
+
+## 🤝 Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Sentia/zai-payment. 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/Sentia/zai-payment/blob/main/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 ZaiPayment project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/Sentia/zai-payment/blob/main/CODE_OF_CONDUCT.md).
+
+## 🔗 Resources
+
+- [Zai Developer Portal](https://developer.hellozai.com/)
+- [Zai API Reference](https://developer.hellozai.com/reference)
+- [AssemblyPay Auth Documentation](https://developer.hellozai.com/docs/introduction)

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/zai_payment/auth/token_provider.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require 'faraday'
+
+module ZaiPayment
+  module Auth
+    class TokenProvider
+      def initialize(config:, store: nil)
+        @config = config
+        @store  = store || TokenStores::MemoryStore.new
+        @mutex  = Mutex.new
+      end
+
+      # Returns "Bearer <token>"
+      def bearer_token
+        token = @store.fetch
+        return "Bearer #{token.value}" if token && Time.now < token.expires_at
+
+        @mutex.synchronize do
+          token = @store.fetch
+          return "Bearer #{token.value}" if token && Time.now < token.expires_at
+
+          new_token = request_token!
+          @store.write(new_token)
+          "Bearer #{new_token.value}"
+        end
+      end
+
+      # Force refresh: clears current token then fetches a new one
+      def refresh_token
+        clear_token
+        bearer_token
+      end
+
+      # Clear cached token (next call will re-auth)
+      def clear_token
+        @store.clear
+      end
+
+      # Returns a Time (or nil if no token cached)
+      def token_expiry
+        token = @store.fetch
+        token&.expires_at
+      end
+
+      # Returns the token type string (e.g., "Bearer") or nil if none cached
+      def token_type
+        token = @store.fetch
+        token&.type
+      end
+
+      private
+
+      def request_token!
+        resp = perform_token_request
+        parse_token_response(resp)
+      rescue Faraday::Error => e
+        raise ZaiPayment::Errors::AuthError, "Token request failed: #{e.message}"
+      end
+
+      def perform_token_request
+        connection.post('/tokens') do |req|
+          req.body = {
+            grant_type: 'client_credentials',
+            client_id: @config.client_id,
+            client_secret: @config.client_secret,
+            scope: @config.scope
+          }
+        end
+      end
+
+      def connection
+        Faraday.new do |faraday|
+          faraday.request :url_encoded
+          faraday.response :json
+          faraday.adapter Faraday.default_adapter
+          faraday.url_prefix = @config.endpoints[:auth_base]
+        end
+      end
+
+      def parse_token_response(resp)
+        data = resp.body
+        token_value = data['access_token'] || data['token']
+        expires_in  = (data['expires_in'] || 3600).to_i
+        token_type  = data['token_type'] || 'Bearer'
+
+        raise ZaiPayment::Errors::AuthError, 'No access_token found' unless token_value
+
+        TokenStore::Token.new(
+          value: token_value,
+          expires_at: Time.now + expires_in - 60,
+          type: token_type
+        )
+      end
+    end
+  end
+end

data/lib/zai_payment/auth/token_store.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module ZaiPayment
+  module Auth
+    class TokenStore
+      Token = Struct.new(:value, :expires_at, :type, keyword_init: true)
+
+      def fetch = raise(NotImplementedError)
+      def write(token) = raise(NotImplementedError)
+      def clear = raise(NotImplementedError)
+    end
+  end
+end

data/lib/zai_payment/auth/token_stores/memory_store.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'monitor'
+
+module ZaiPayment
+  module Auth
+    module TokenStores
+      class MemoryStore < TokenStore
+        def initialize
+          super
+          @token = nil
+          @monitor = Monitor.new
+        end
+
+        def fetch
+          @monitor.synchronize { @token }
+        end
+
+        def write(token)
+          @monitor.synchronize { @token = token }
+        end
+
+        def clear
+          @monitor.synchronize { @token = nil }
+        end
+      end
+    end
+  end
+end

data/lib/zai_payment/config.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module ZaiPayment
+  class Config
+    attr_accessor :environment, :client_id, :client_secret, :scope,
+                  :timeout, :open_timeout
+
+    def initialize
+      @environment  = :prelive # or :production
+      @client_id    = nil
+      @client_secret = nil
+      @scope = nil
+    end
+
+    def validate!
+      raise Errors::ConfigurationError, 'client_id is required' if client_id.nil? || client_id.empty?
+      raise Errors::ConfigurationError, 'client_secret is required' if client_secret.nil? || client_secret.empty?
+      raise Errors::ConfigurationError, 'scope is required' if scope.nil? || scope.empty?
+    end
+
+    def endpoints
+      case environment.to_sym
+      when :prelive
+        {
+          core_base: 'https://test.api.promisepay.com',
+          va_base: 'https://sandbox.au-0000.api.assemblypay.com',
+          auth_base: 'https://au-0000.sandbox.auth.assemblypay.com'
+        }
+      when :production
+        {
+          core_base: 'https://au-0000.api.assemblypay.com',
+          va_base: 'https://secure.api.promisepay.com',
+          auth_base: 'https://au-0000.auth.assemblypay.com'
+        }
+      else
+        raise "Unknown environment: #{environment}"
+      end
+    end
+  end
+end

data/lib/zai_payment/errors.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module ZaiPayment
+  module Errors
+    class Error < StandardError; end
+    class AuthError < Error; end
+    class ConfigurationError < Error; end
+  end
+end

data/lib/zai_payment/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ZaiPayment
+  VERSION = '1.0.1'
+end

data/lib/zai_payment.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require_relative 'zai_payment/version'
+require_relative 'zai_payment/config'
+require_relative 'zai_payment/errors'
+require_relative 'zai_payment/auth/token_provider'
+require_relative 'zai_payment/auth/token_store'
+require_relative 'zai_payment/auth/token_stores/memory_store'
+
+module ZaiPayment
+  class << self
+    def config
+      @config ||= Config.new
+    end
+
+    def configure
+      yield config
+    end
+
+    # Singleton auth token provider (uses default MemoryStore under the hood)
+    def auth
+      @auth ||= ZaiPayment::Auth::TokenProvider.new(config: config)
+    end
+
+    # --- Convenience one-liners ---
+    def token            = auth.bearer_token
+    def refresh_token!   = auth.refresh_token
+    def clear_token!     = auth.clear_token
+    def token_expiry     = auth.token_expiry
+    def token_type       = auth.token_type
+  end
+end

data/sig/zai_payment.rbs

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

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: zai_payment
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Eddy Jaga
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-10-21 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'
+description: A Ruby gem for integrating with Zai payment platform APIs.
+email:
+- eddy.jaga@sentia.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/zai_payment.rb
+- lib/zai_payment/auth/token_provider.rb
+- lib/zai_payment/auth/token_store.rb
+- lib/zai_payment/auth/token_stores/memory_store.rb
+- lib/zai_payment/config.rb
+- lib/zai_payment/errors.rb
+- lib/zai_payment/version.rb
+- sig/zai_payment.rbs
+homepage: https://github.com/Sentia/zai-payment
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/Sentia/zai-payment
+  source_code_uri: https://github.com/Sentia/zai-payment
+  changelog_uri: https://github.com/Sentia/zai-payment/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: Ruby gem for Zai payment integration
+test_files: []