paystack_sdk 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c6c4ffb56d54aca1c129d5f8d9c825e31f0c4f0df719a95c324eb8b220156f2f
+  data.tar.gz: 8a5a351599e8795c3c61deb5d8d2737c5fb5e445e20bf7c72b357bf0fb84f0ca
+SHA512:
+  metadata.gz: c9c76e4b0ef258ac320e4088d15ba07d7703d3436ad57246b22ab079873b9a0f590553dd0b712d8e2c2a4a3220c41090000d1fa115b83650a5e00780d519f033
+  data.tar.gz: cf9454f62965fbc0555303a83f658ebf6cf7f249605a263a429dfa6d5da9810db5bb4b5ed76ea844f0228bb391ce21b0143b7a7846f343515705d07b5479e248

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+ruby-3.3.5

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.2.2

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.0.1] - 2025-05-10
+
+- Initial release

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
+[INSERT CONTACT METHOD].
+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 Maxwell Nana Forson (theLazyProgrammer)
+
+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,82 @@
+# Paystack Ruby SDK: Simplify Payments
+
+The `paystack_sdk` gem provides a simple and intuitive interface for interacting with Paystack's payment gateway API. It allows developers to easily integrate Paystack's payment processing features into their Ruby applications. With support for various endpoints, this SDK simplifies tasks such as initiating transactions, verifying payments, managing customers, and more.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'paystack_sdk'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install paystack_sdk
+```
+
+## Usage
+
+Here’s a basic example of how to use the `paystack_sdk` gem:
+
+```ruby
+require 'paystack_sdk'
+
+# Initialize the SDK with your Paystack secret key
+paystack = PaystackSdk::Client.new(api_key: "sk_test_xxx")
+
+# Example: Initialize a payment
+params = {email: "customer@email.com", amount: "2300", currency: "USD"}
+response = paystack.transactions.initialize_transaction(params)
+
+# Example: Verify a payment
+response = paystack.transactions.verify(reference: "transaction_reference")
+if paystack.transactions.success?
+  puts "Payment verified successfully!"
+else
+  puts "Payment verification failed: #{response.error_message}"
+end
+
+# Note: The `response` object is a hash containing the API response. Use the `#success?`
+# method on the relevant resource instance (e.g., `transactions`, `plans`, `subscriptions`)
+# to determine if the request was successful.
+```
+
+Refer to the [documentation](https://github.com/nanafox/paystack_sdk) for more detailed usage examples and supported endpoints.
+
+## 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:
+
+```bash
+bundle exec rake install
+```
+
+To release a new version, update the version number in `version.rb`, and then run:
+
+```bash
+bundle exec rake release
+```
+
+This 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/nanafox/paystack_sdk](https://github.com/nanafox/paystack_sdk). 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/nanafox/paystack_sdk/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 PaystackSdk project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the [code of conduct](https://github.com/nanafox/paystack_sdk/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/lib/paystack_sdk/client.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative "resources/transactions"
+
+module PaystackSdk
+  # The `Client` class serves as the main entry point for interacting with the Paystack API.
+  # It initializes a connection to the Paystack API and provides access to various resources.
+  class Client
+    # The base URL for the Paystack API.
+    BASE_URL = "https://api.paystack.co"
+
+    # Initializes a new `Client` instance.
+    #
+    # @param api_key [String] The secret API key for authenticating with the Paystack API.
+    #
+    # @example
+    #   client = PaystackSdk::Client.new(api_key: "sk_test_xxx")
+    def initialize(api_key:)
+      @connection = Faraday.new(url: BASE_URL) do |conn|
+        conn.request :json
+        conn.response :json, content_type: /\bjson$/
+        conn.headers["Authorization"] = "Bearer #{api_key}"
+        conn.headers["Content-Type"] = "application/json"
+        conn.headers["User-Agent"] = "paystack_sdk/#{PaystackSdk::VERSION}"
+        conn.adapter Faraday.default_adapter
+      end
+    end
+
+    # Provides access to the `Transactions` resource.
+    #
+    # @return [PaystackSdk::Resources::Transactions] An instance of the
+    #  `Transactions` resource.
+    #
+    # @example
+    #   transactions = client.transactions
+    #   response = transactions.initialize_transaction(params)
+    def transactions
+      @transactions ||= Resources::Transactions.new(@connection)
+    end
+  end
+end

data/lib/paystack_sdk/resources/base.rb

@@ -0,0 +1,39 @@
+module PaystackSdk
+  module Resources
+    # The `Base` class serves as a parent class for all resource classes in the SDK.
+    # It provides shared functionality, such as handling API responses.
+    class Base
+      # Initializes a new `Base` instance.
+      #
+      # @param connection [Faraday::Connection] The Faraday connection object used for API requests.
+      def initialize(connection)
+        @connection = connection
+      end
+
+      # Checks if the last API response was successful.
+      #
+      # @return [Boolean] `true` if the last API response was successful, otherwise `false`.
+      def success?
+        @api_response&.success? || false
+      end
+
+      private
+
+      # Handles the API response, raising an error if the response is unsuccessful.
+      #
+      # @param response [Faraday::Response] The response object returned by the Faraday connection.
+      # @return [Hash] The parsed response body if the request was successful.
+      # @raise [PaystackSdk::Error] If the response indicates an error.
+      def handle_response(response)
+        @api_response ||= response
+
+        if response.success?
+          response.body
+        else
+          error_message = response.body.is_a?(Hash) ? response.body["message"] : "Paystack API Error"
+          raise PaystackSdk::Error, error_message
+        end
+      end
+    end
+  end
+end

data/lib/paystack_sdk/resources/transactions.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module PaystackSdk
+  module Resources
+    # The `Transactions` class provides methods for interacting with the Paystack Transactions API.
+    # It allows you to initialize transactions, verify payments, list transactions, and fetch transaction details.
+    class Transactions < PaystackSdk::Resources::Base
+      # Initializes a new transaction.
+      #
+      # @param payload [Hash] The payload containing transaction details (e.g., email, amount, currency).
+      # @return [Hash] The response from the Paystack API.
+      # @raise [PaystackSdk::Error] If the payload is invalid or the API request fails.
+      #
+      # @example
+      #   payload = { email: "customer@email.com", amount: 10000, currency: "GHS" }
+      #   response = transactions.initialize_transaction(payload)
+      def initialize_transaction(payload)
+        raise PaystackSdk::Error, "Invalid payload" unless payload.is_a?(Hash)
+        response = @connection.post("/transaction/initialize", payload)
+        handle_response(response)
+      end
+
+      # Verifies a transaction using its reference.
+      #
+      # @param reference [String] The unique reference for the transaction.
+      # @return [Hash] The response from the Paystack API.
+      # @raise [PaystackSdk::Error] If the API request fails.
+      #
+      # @example
+      #   response = transactions.verify("transaction_reference")
+      def verify(reference:)
+        response = @connection.get("/transaction/verify/#{reference}")
+        handle_response(response)
+      end
+
+      # Lists all transactions.
+      #
+      # @return [Hash] The response from the Paystack API containing a list of transactions.
+      # @raise [PaystackSdk::Error] If the API request fails.
+      #
+      # @example
+      #   response = transactions.list
+      def list
+        response = @connection.get("/transaction")
+        handle_response(response)
+      end
+
+      # Fetches details of a single transaction by its ID.
+      #
+      # @param id [Integer] The ID of the transaction to fetch.
+      # @return [Hash] The response from the Paystack API containing transaction details.
+      # @raise [PaystackSdk::Error] If the API request fails.
+      #
+      # @example
+      #   response = transactions.fetch("transaction_id")
+      def fetch(id)
+        response = @connection.get("/transaction/#{id}")
+        handle_response(response)
+      end
+
+      # Fetches the totals of all transactions.
+      #
+      # @return [Hash] The response from the Paystack API containing transaction totals.
+      # @raise [PaystackSdk::Error] If the API request fails.
+      #
+      # @example
+      #  response = transactions.totals
+      def totals
+        response = @connection.get("/transaction/totals")
+        handle_response(response)
+      end
+    end
+  end
+end

data/lib/paystack_sdk/version.rb

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

data/lib/paystack_sdk.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "faraday"
+require_relative "paystack_sdk/version"
+require_relative "paystack_sdk/client"
+
+module PaystackSdk
+  class Error < StandardError; end
+end

data/mise.toml

@@ -0,0 +1,2 @@
+[tools]
+ruby = "3.3.5"

data/sig/paystack_sdk.rbs

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

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: paystack_sdk
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Maxwell Nana Forson (theLazyProgrammer)
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-05-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.13.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.13.1
+- !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: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.49.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.49.0
+- !ruby/object:Gem::Dependency
+  name: irb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.15.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.15.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.2.1
+description: |
+  The `paystack_sdk` gem provides a simple and intuitive interface for
+  interacting with Paystack's payment gateway API. It allows developers to
+  easily integrate Paystack's payment processing features into their Ruby
+  applications. With support for various endpoints, this SDK simplifies tasks
+  such as initiating transactions, verifying payments, managing customers, and more.
+email:
+- nanaforsonjnr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".ruby-version"
+- ".standard.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/paystack_sdk.rb
+- lib/paystack_sdk/client.rb
+- lib/paystack_sdk/resources/base.rb
+- lib/paystack_sdk/resources/transactions.rb
+- lib/paystack_sdk/version.rb
+- mise.toml
+- sig/paystack_sdk.rbs
+homepage: https://github.com/nanafox/paystack_sdk
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/nanafox/paystack_sdk
+  changelog_uri: https://github.com/nanafox/paystack_sdk/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: A Ruby SDK for integrating with Paystack's payment gateway API.
+test_files: []