paystack-gateway 0.1.0

data/lib/paystack_gateway/transfers.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module PaystackGateway
+  # Automate sending money https://paystack.com/docs/api/#transfer
+  module Transfers
+    include PaystackGateway::RequestModule
+
+    # Response from POST /transfer endpoint.
+    class InitiateTransferResponse < PaystackGateway::Response
+      include TransactionResponse
+
+      delegate :transfer_code, :id, :transferred_at, to: :data
+
+      def transaction_completed_at
+        transferred_at || super
+      end
+    end
+
+    # Raised when an error occurs while calling POST /transfer
+    class InitiateTransferError < ApiError
+      def transaction_failed?
+        response_body[:status] == false && http_code == 400
+      end
+
+      def failure_reason
+        response_body[:message]
+      end
+    end
+
+    api_method def self.initiate_transfer(amount:, recipient_code:, reference:, reason: nil)
+      response = use_connection do |connection|
+        connection.post(
+          '/transfer',
+          {
+            source: :balance, amount: (amount * 100).to_i, recipient: recipient_code,
+            reference: reference, reason: reason,
+          }.compact,
+        )
+      end
+      response.tap { |r| r.completed_at = Time.current }
+    end
+
+    # Response from GET /transfer/verify/:reference endpoint.
+    class VerifyTransferResponse < InitiateTransferResponse; end
+
+    # Raised when an error occurs while calling GET /transfer/verify/:reference
+    class VerifyTransferError < ApiError
+      def transaction_not_found?
+        response_body[:status] == false && response_body[:message].match?(/transfer not found/i)
+      end
+    end
+
+    api_method def self.verify_transfer(reference:)
+      use_connection do |connection|
+        connection.get("/transfer/verify/#{reference}")
+      end
+    end
+  end
+end

data/lib/paystack_gateway/verification.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module PaystackGateway
+  # Perform KYC processes https://paystack.com/docs/api/#verification
+  module Verification
+    include PaystackGateway::RequestModule
+
+    # Response from GET /bank/resolve endpoint.
+    class ResolveAccountNumberResponse < PaystackGateway::Response
+      delegate :account_name, :bank_id, to: :data
+
+      def account_valid?
+        status && account_name.present?
+      end
+    end
+
+    # Raised when an error occurs while calling /bank/resolve
+    class ResolveAccountNumberError < ApiError
+      def invalid_account?
+        http_code == 422 && response_body[:status] == false
+      end
+    end
+
+    api_method def self.resolve_account_number(account_number:, bank_code:)
+      use_connection(cache_options: {}) do |connection|
+        connection.get(
+          '/bank/resolve',
+          { account_number: account_number, bank_code: bank_code },
+        )
+      end
+    end
+  end
+end

data/lib/paystack_gateway/version.rb

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

data/lib/paystack_gateway/webhooks.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'active_support/security_utils'
+
+module PaystackGateway
+  # Webhooks
+  module Webhooks
+    # https://paystack.com/docs/payments/webhooks/#ip-whitelisting
+    WEBHOOK_IPS = %w[52.31.139.75 52.49.173.169 52.214.14.220].freeze
+    WEBHOOK_IP_ADDRESSES = WEBHOOK_IPS.map { |addr| IPAddr.new(addr) }
+
+    # Wrapper for webhook responses from Paystack.
+    class WebhookResponse < PaystackGateway::Response
+      property :event
+    end
+
+    def self.parse_webhook(parsed_body)
+      WebhookResponse.new(parsed_body.deep_symbolize_keys)
+    end
+
+    # https://paystack.com/docs/payments/webhooks/#signature-validation
+    def self.valid_webhook?(request_headers, request_body)
+      request_signature = request_headers['X-Paystack-Signature']
+      return false if request_signature.blank?
+
+      calculated_signature = OpenSSL::HMAC.hexdigest('SHA512', PaystackGateway.secret_key, request_body)
+      ActiveSupport::SecurityUtils.secure_compare(request_signature, calculated_signature)
+    end
+
+    def self.valid_ip?(request_ip) = WEBHOOK_IP_ADDRESSES.any? { _1.include?(request_ip) }
+  end
+end

data/lib/paystack_gateway.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'paystack_gateway/version'
+require 'paystack_gateway/configuration'
+require 'paystack_gateway/api_error'
+require 'paystack_gateway/current'
+require 'paystack_gateway/request_module'
+require 'paystack_gateway/response'
+require 'paystack_gateway/transaction_response'
+
+require 'paystack_gateway/customers'
+require 'paystack_gateway/dedicated_virtual_accounts'
+require 'paystack_gateway/miscellaneous'
+require 'paystack_gateway/plans'
+require 'paystack_gateway/refunds'
+require 'paystack_gateway/subaccounts'
+require 'paystack_gateway/transactions'
+require 'paystack_gateway/transfer_recipients'
+require 'paystack_gateway/transfers'
+require 'paystack_gateway/verification'
+require 'paystack_gateway/webhooks'
+
+# = PaystackGateway
+module PaystackGateway
+end

data/sig/paystack_gateway.rbs

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

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: paystack-gateway
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- darthrighteous
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-11-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !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: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: |-
+  Library providing a collection of easy-to-use modules, methods, and helpers
+      for interacting with Paystack’s API endpoints. Includes built-in error
+      handling, response parsing and logging. See official paystack docs
+      https://paystack.com/docs/api/
+email:
+- ja.ogunniyi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/faraday/response/caching.rb
+- lib/faraday/response/mashify.rb
+- lib/paystack-gateway.rb
+- lib/paystack_gateway.rb
+- lib/paystack_gateway/api_error.rb
+- lib/paystack_gateway/configuration.rb
+- lib/paystack_gateway/current.rb
+- lib/paystack_gateway/customers.rb
+- lib/paystack_gateway/dedicated_virtual_accounts.rb
+- lib/paystack_gateway/miscellaneous.rb
+- lib/paystack_gateway/plans.rb
+- lib/paystack_gateway/refunds.rb
+- lib/paystack_gateway/request_module.rb
+- lib/paystack_gateway/response.rb
+- lib/paystack_gateway/subaccounts.rb
+- lib/paystack_gateway/transaction_response.rb
+- lib/paystack_gateway/transactions.rb
+- lib/paystack_gateway/transfer_recipients.rb
+- lib/paystack_gateway/transfers.rb
+- lib/paystack_gateway/verification.rb
+- lib/paystack_gateway/version.rb
+- lib/paystack_gateway/webhooks.rb
+- sig/paystack_gateway.rbs
+homepage: https://github.com/darthrighteous/paystackgateway
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+  homepage_uri: https://github.com/darthrighteous/paystackgateway
+  source_code_uri: https://github.com/darthrighteous/paystackgateway
+  changelog_uri: https://github.com/darthrighteous/paystackgateway/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Ruby bindings for Paystack’s API https://paystack.com/docs/api
+test_files: []