peyemapi-sdk 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 56fb1e10f7666ec0777dd3e14c150cd3b3a7bec1b18bc1c1b669579afece01f5
+  data.tar.gz: fe7cb38ec9250d43008f7ac5b3fc7972ee2698f17fc773da7428204ae30db1ea
+SHA512:
+  metadata.gz: f3d8ade57d0ac3d027c00842425e6e1c674dcf4be61413722716254fe4eaf86e7ad07d794726834fc33af9578c8730b1cbf4d4b3011aa57eae2bd3cd3c5fa561
+  data.tar.gz: f2e4b39b774cb99b75c8f6fc7ae52336bf9e509dfb00c263fa1a1a0c24dd3a3e81fc92151371af8588381954c14be8eed726ec64308dc8ac94e4d2bf05d90f27

data/README.md

@@ -0,0 +1,132 @@
+# PeyemAPI Ruby SDK
+
+A gem for integrating [PeyemAPI](https://peyem.app) payments into any Ruby application — works with **Rails**, **Sinatra**, **Hanami**, and plain Ruby scripts.
+
+## Installation
+
+Add to your `Gemfile`:
+
+```ruby
+gem "peyemapi-sdk"
+```
+
+Then run:
+
+```bash
+bundle install
+```
+
+Or install globally:
+
+```bash
+gem install peyemapi-sdk
+```
+
+## Usage
+
+### Initialize the client
+
+```ruby
+require "peyemapi"
+
+# Reads PEYEM_API_KEY from environment
+client = Peyemapi::Client.new
+
+# Or pass key directly
+client = Peyemapi::Client.new("sk_user_...")
+
+# Shorthand
+client = Peyemapi.client("sk_user_...")
+```
+
+### Create a Payment
+
+```ruby
+response = client.create_payment(
+  amount:       500,                          # HTG
+  reference_id: "ORDER-123",
+  return_url:   "https://example.com/return",
+  description:  "Optional description"
+)
+
+if response["payment_url"]
+  redirect_to response["payment_url"]  # Rails example
+end
+```
+
+### Check Payment Status
+
+```ruby
+status = client.check_status("ORDER-123")
+puts status["status"]  # "completed", "pending", etc.
+```
+
+### Get Account Balance
+
+```ruby
+balance = client.get_balance
+puts "#{balance["balance"]} #{balance["currency"]}"  # "12500 HTG"
+```
+
+### Webhook Verification
+
+```ruby
+# Rails example
+class WebhooksController < ApplicationController
+  skip_before_action :verify_authenticity_token
+
+  def payment
+    payload   = request.raw_post
+    signature = request.headers["X-Webhook-Signature"]
+    secret    = ENV["PEYEM_WEBHOOK_SECRET"]
+
+    unless Peyemapi::Client.verify_webhook(payload, signature, secret)
+      return head :unauthorized
+    end
+
+    data = JSON.parse(payload)
+    # handle event...
+    head :ok
+  end
+end
+```
+
+## Environment Variables
+
+| Variable | Description |
+|---|---|
+| `PEYEM_API_KEY` | Your secret API key |
+| `PEYEM_API_URL` | Override the API base URL (optional) |
+| `PEYEM_WEBHOOK_SECRET` | Your webhook signing secret |
+
+Copy `.env.example` → `.env` and fill in your credentials.
+
+## Error Handling
+
+```ruby
+begin
+  result = client.create_payment(amount: 500, reference_id: "REF", return_url: "")
+rescue Peyemapi::Error => e
+  puts "API Error [#{e.status_code}]: #{e.message}"
+rescue Peyemapi::ConfigurationError => e
+  puts "Config Error: #{e.message}"
+end
+```
+
+## Running Tests
+
+```bash
+bundle install
+bundle exec rspec
+```
+
+## Publishing to RubyGems
+
+```bash
+gem build peyemapi-sdk.gemspec
+gem push peyemapi-sdk-1.0.0.gem
+```
+
+## License
+
+MIT

data/lib/peyemapi/client.rb

@@ -0,0 +1,106 @@
+require "faraday"
+require "faraday/multipart"
+require "openssl"
+require "json"
+
+module Peyemapi
+  class Client
+    DEFAULT_API_URL = "https://fyxmoljbnionrylsmfoo.supabase.co/functions/v1/bazik-api"
+
+    # @param secret_key [String, nil] API secret key. Falls back to PEYEM_API_KEY env var.
+    # @param api_url    [String, nil] Override the API base URL. Falls back to PEYEM_API_URL env var.
+    # @param timeout    [Integer]     HTTP timeout in seconds (default: 30).
+    def initialize(secret_key = nil, api_url: nil, timeout: 30)
+      @secret_key = secret_key || ENV["PEYEM_API_KEY"].to_s
+
+      if @secret_key.empty?
+        raise Peyemapi::ConfigurationError.new(
+          "API Secret Key is required. Pass it to the constructor or set the PEYEM_API_KEY environment variable."
+        )
+      end
+
+      base_url = api_url || ENV["PEYEM_API_URL"] || DEFAULT_API_URL
+      @conn = Faraday.new(url: base_url.chomp("/")) do |f|
+        f.request  :json
+        f.response :json, content_type: /\bjson$/
+        f.options.timeout = timeout
+        f.headers["Authorization"] = "Bearer #{@secret_key}"
+        f.headers["Accept"]        = "application/json"
+      end
+    end
+
+    # ──────────────────────────────────────────────────────────────────
+    # Public API methods
+    # ──────────────────────────────────────────────────────────────────
+
+    # Create a payment.
+    #
+    # @param amount       [Numeric] Amount in HTG (e.g. 500)
+    # @param reference_id [String]  Unique order ID (e.g. "ORDER-123")
+    # @param return_url   [String]  URL to redirect after payment
+    # @param description  [String]  Optional description
+    # @return             [Hash]    API response (may contain +payment_url+)
+    def create_payment(amount:, reference_id:, return_url: "", description: "Paiement commande")
+      request(:post, "/pay", {
+        amount:      amount,
+        referenceId: reference_id,
+        description: description,
+        returnUrl:   return_url
+      })
+    end
+
+    # Check the status of a payment.
+    #
+    # @param reference_id [String] The reference ID used when creating the payment
+    # @return             [Hash]   API response with +status+, +amount+, etc.
+    def check_status(reference_id)
+      request(:get, "/status", nil, params: { referenceId: reference_id })
+    end
+
+    # Get the account balance.
+    #
+    # @return [Hash] API response with +balance+ and +currency+
+    def get_balance
+      request(:get, "/balance")
+    end
+
+    # Verify an incoming webhook signature using HMAC-SHA256.
+    #
+    # @param payload        [String] Raw request body string
+    # @param signature      [String] Value from X-Webhook-Signature header
+    # @param webhook_secret [String] Your webhook secret (whsec_...)
+    # @return               [Boolean]
+    def self.verify_webhook(payload, signature, webhook_secret)
+      expected = OpenSSL::HMAC.hexdigest("SHA256", webhook_secret, payload)
+      ActiveSupport::SecurityUtils.secure_compare(expected, signature)
+    rescue NameError
+      # Fallback when ActiveSupport is not available (non-Rails)
+      OpenSSL.fixed_length_secure_compare(expected, signature)
+    end
+
+    # ──────────────────────────────────────────────────────────────────
+    private
+    # ──────────────────────────────────────────────────────────────────
+
+    def request(method, path, body = nil, params: {})
+      response =
+        if method == :post
+          @conn.post(path) { |req| req.body = body }
+        else
+          @conn.get(path) { |req| req.params.merge!(params) }
+        end
+
+      data = response.body || {}
+
+      unless response.success?
+        message = data.is_a?(Hash) ? data["message"] : "API request failed"
+        raise Peyemapi::Error.new(
+          message || "API request failed with status #{response.status}",
+          status_code: response.status
+        )
+      end
+
+      data
+    end
+  end
+end

data/lib/peyemapi/error.rb

@@ -0,0 +1,14 @@
+module Peyemapi
+  # Raised when the PeyemAPI returns an error response.
+  class Error < StandardError
+    attr_reader :status_code
+
+    def initialize(message, status_code: 0)
+      super(message)
+      @status_code = status_code
+    end
+  end
+
+  # Raised when required configuration is missing.
+  class ConfigurationError < Error; end
+end

data/lib/peyemapi/version.rb

@@ -0,0 +1,3 @@
+module Peyemapi
+  VERSION = "1.0.0"
+end

data/lib/peyemapi.rb

@@ -0,0 +1,13 @@
+require "peyemapi/version"
+require "peyemapi/client"
+require "peyemapi/error"
+
+module Peyemapi
+  class << self
+    # Shorthand to create a client
+    #   Peyemapi.client("sk_user_...")
+    def client(secret_key = nil, **options)
+      Client.new(secret_key, **options)
+    end
+  end
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: peyemapi-sdk
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Antigravity
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2026-03-30 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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.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'
+description: A lightweight, framework-agnostic Ruby SDK for integrating PeyemAPI payments.
+  Works with Rails, Sinatra, Hanami, and plain Ruby.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/peyemapi.rb
+- lib/peyemapi/client.rb
+- lib/peyemapi/error.rb
+- lib/peyemapi/version.rb
+homepage: https://github.com/peyemapi/peyemapi-ruby-sdk
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+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.0.3.1
+signing_key: 
+specification_version: 4
+summary: Ruby SDK for PeyemAPI — Haitian payment gateway
+test_files: []