paystack-gateway 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b006328b301fcf8623f6112708bfcc417a3ac526e624b5808fe734b4363f12b5
+  data.tar.gz: 52b87e2c79a821070b5dd7f742fde3eb73e2f164ea1d9163f8ad9c007299f580
+SHA512:
+  metadata.gz: 1678a9c29c4bcda5ed2440c70979efa7bf3171549baf07f6b086ec0a2bcf309b12ce9a367c324649958dffc1f6e705fb396616db4b67b026eddaf986ad2a5220
+  data.tar.gz: 1b9fd60c1f84978915cf365e551176f4a93fb63274a675430ead26d3b37bfdd9f36f900f6a4ef8966b44189995353edcd9d5286c863c59487a7b66e4db0b2d8a

data/.rubocop.yml

@@ -0,0 +1,25 @@
+require:
+  - rubocop-minitest
+  - rubocop-rake
+
+AllCops:
+  TargetRubyVersion: 3.3
+  NewCops: enable
+
+Metrics/AbcSize:
+  Max: 25
+Metrics/MethodLength:
+  Max: 25
+Minitest/MultipleAssertions:
+  Enabled: false
+Naming/FileName:
+  Exclude:
+    - lib/paystack-gateway.rb
+Style/NegatedIf:
+  Enabled: false
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: consistent_comma

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-10-27
+
+- 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) 2024 darthrighteous
+
+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,206 @@
+# PaystackGateway
+
+`paystack-gateway` is a Ruby library that provides easy-to-use bindings for the [Paystack API](https://paystack.com/docs/api/). This library provides a collection of modules, methods and helpers for interacting with Paystack's API endpoints. It includes built-in error handling, caching, parsing, and logging.
+
+## Installation
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+$ bundle add PLACEHOLDER_GEM_NAME
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+$ gem install PLACEHOLDER_GEM_NAME
+```
+
+## Configuration
+
+To use the PaystackGateway gem, you need to configure it with your Paystack secret key. You can do this in an initializer or directly in your application code.
+
+The configuration options are
+- `secret_key`: Your paystack api key used to authorize requests
+- `logger`: Your ruby Logger. Default is Logger.new($stdout)
+- `logging_options`:  Options passed to [Faraday logger middleware](https://github.com/lostisland/faraday/blob/main/lib/faraday/response/logger.rb). Default is `{ headers: false }`
+- `log_filter`: Filter used when logging headers and body.
+
+```ruby
+# config/initializers/paystack_gateway.rb
+
+PaystackGateway.configure do |config|
+  config.secret_key = Rails.application.credentials.dig(:paystack, :secret_key)
+  config.logger = Rails.logger
+  config.log_filter = ActiveSupport::ParameterFilter.new(Rails.application.config.filter_parameters).method(:filter)
+end
+```
+
+## Usage
+
+### Calling API endpoints
+Once configured, you can start using the various API modules and methods provided by the gem. They are designed to mirror how the api methods are grouped and listed on the [Paystack API](https://paystack.com/docs/api/).
+
+Here's an example creating a customer using the [/customer/create endpoint](https://paystack.com/docs/api/customer/#create).
+
+```ruby
+response = PaystackGateway::Customers.create_customer(
+  email: 'test@example.com',
+  first_name: 'Test',
+  last_name: 'User',
+)
+
+response.id # => 203316808
+response.customer_code # => "CUS_xsrozmbt8g1oear"
+```
+
+### Error Handling
+Whenever a network error occurs or the called endpoint responds with an error response, a `PaystackGateway::ApiError`(or a subclass of it) is raised that can be handled in your calling code.
+
+Here's an example initializing a transaction using the [/transaction/initialize endpoint](https://paystack.com/docs/api/transaction/#initialize)
+
+```ruby
+begin
+  response = PaystackGateway::Transactions.initialize_transaction(
+    email: 'test@example.com',
+    amount: 1000,
+    reference: 'test_reference',
+  )
+  return response.payment_url
+
+rescue InitializeTransactionError => e # subclass of PaystackGateway::ApiError
+  cancel_payment if e.cancellable?
+
+rescue PaystackGateway::ApiError => e
+  handle_initialize_error(e)
+end
+```
+
+### Caching
+
+While caching is implemented in the library, it is currently not configurable for all modules and api methods. With a little more work, this can be achieved. So if there's demand for it, I can work on it (PRs are also welcome 🙂).
+
+Some endpoints currently make use of caching:
+- Miscellaneous#list_banks
+- Verifications#resolve_account_number
+
+Caching works using an [ActiveSupport::Cache::FileStore](https://api.rubyonrails.org/classes/ActiveSupport/Cache/FileStore.html) cache. The default caching period is 7 days and the cache data is stored on the file system at `ENV['TMPDIR']` or `/tmp/cache`. 
+
+
+## API Modules and Methods
+> Refer to the [Paystack API documentation](https://paystack.com/docs/api) for details on all the available endpoints and their usage.
+
+### Implemented Modules and Methods
+
+Below is a complete list of the API modules and methods that are currently implemented.
+
+I invite you to collaborate on this project! If you need to use any of the unimplemented API methods or modules, or if you want to make modifications to the defaults or the level of configuration available in the currently implemented API methods, please feel free to raise a pull request (PR). See [Contributing](#contributing) and [Code of Conduct](#code-of-conduct) below
+
+- [x] [Transactions](https://paystack.com/docs/api/transaction/)
+  - [x] [Initialize Transaction](https://paystack.com/docs/api/transaction/#initialize)
+  - [x] [Verify Transaction](https://paystack.com/docs/api/transaction/#verify)
+  - [ ] [List Transactions](https://paystack.com/docs/api/transaction/#list)
+  - [ ] [Fetch Transaction](https://paystack.com/docs/api/transaction/#fetch)
+  - [x] [Charge Authorization](https://paystack.com/docs/api/transaction/#charge-authorization)
+  - [ ] [View Transaction Timeline](https://paystack.com/docs/api/transaction/#view-timeline)
+  - [ ] [Transaction Totals](https://paystack.com/docs/api/transaction/#totals)
+  - [ ] [Export Transactions](https://paystack.com/docs/api/transaction/#export)
+  - [ ] [Partial Debit](https://paystack.com/docs/api/transaction/#partial-debit)
+
+- [ ] [Customers](https://paystack.com/docs/api/customer/)
+  - [x] [Create Customer](https://paystack.com/docs/api/customer/#create)
+  - [ ] [List Customers](https://paystack.com/docs/api/customer/#list)
+  - [x] [Fetch Customer](https://paystack.com/docs/api/customer/#fetch)
+  - [ ] [Update Customer](https://paystack.com/docs/api/customer/#update)
+  - [ ] [Validate Customer](https://paystack.com/docs/api/customer/#validate)
+  - [ ] [Whitelist/Blacklist Customer](https://paystack.com/docs/api/customer/#whitelist-blacklist)
+  - [ ] [Deactivate Authorization](https://paystack.com/docs/api/customer/#deactivate-authorization)
+
+- [x] [Dedicated Virtual Accounts](https://paystack.com/docs/api/dedicated-virtual-account/)
+  - [x] [Create Dedicated Virtual Account](https://paystack.com/docs/api/dedicated-virtual-account/#create)
+  - [x] [Assign Dedicated Virtual Account](https://paystack.com/docs/api/dedicated-virtual-account/#assign)
+  - [ ] [List Dedicated Accounts](https://paystack.com/docs/api/dedicated-virtual-account/#list)
+  - [ ] [Fetch Dedicated Account](https://paystack.com/docs/api/dedicated-virtual-account/#fetch)
+  - [x] [Requery Dedicated Account](https://paystack.com/docs/api/dedicated-virtual-account/#requery)
+  - [ ] [Deactivate Dedicated Account](https://paystack.com/docs/api/dedicated-virtual-account/#deactivate)
+  - [x] [Split Dedicated Account Transaction](https://paystack.com/docs/api/dedicated-virtual-account/#add-split)
+  - [ ] [Remove Split from Dedicated Account](https://paystack.com/docs/api/dedicated-virtual-account/#remove-split)
+  - [ ] [Fetch Bank Providers](https://paystack.com/docs/api/dedicated-virtual-account/#providers)
+
+- [ ] [Subaccounts](https://paystack.com/docs/api/subaccount/)
+  - [x] [Create Subaccount](https://paystack.com/docs/api/subaccount/#create)
+  - [ ] [List Subaccounts](https://paystack.com/docs/api/subaccount/#list)
+  - [ ] [Fetch Subaccount](https://paystack.com/docs/api/subaccount/#fetch)
+  - [x] [Update Subaccount](https://paystack.com/docs/api/subaccount/#update)
+
+- [x] [Plans](https://paystack.com/docs/api/plan/)
+  - [x] [Create Plan](https://paystack.com/docs/api/plan/#create)
+  - [x] [List Plans](https://paystack.com/docs/api/plan/#list)
+  - [x] [Fetch Plan](https://paystack.com/docs/api/plan/#fetch)
+  - [x] [Update Plan](https://paystack.com/docs/api/plan/#update)
+
+- [x] [Transfer Recipients](https://paystack.com/docs/api/transfer-recipient/)
+  - [x] [Create Transfer Recipient](https://paystack.com/docs/api/transfer-recipient/#create)
+  - [ ] [Bulk Create Transfer Recipient](https://paystack.com/docs/api/transfer-recipient/#bulk)
+  - [ ] [List Transfer Recipients](https://paystack.com/docs/api/transfer-recipient/#list)
+  - [ ] [Fetch Transfer Recipient](https://paystack.com/docs/api/transfer-recipient/#fetch)
+  - [ ] [Update Transfer Recipient](https://paystack.com/docs/api/transfer-recipient/#update)
+  - [ ] [Delete Transfer Recipient](https://paystack.com/docs/api/transfer-recipient/#delete)
+
+- [x] [Transfers](https://paystack.com/docs/api/transfer/)
+  - [x] [Initiate Transfer](https://paystack.com/docs/api/transfer/#initiate)
+  - [ ] [Finalize Transfer](https://paystack.com/docs/api/transfer/#finalize)
+  - [ ] [Initiate Bulk Transfer](https://paystack.com/docs/api/transfer/#bulk)
+  - [ ] [List Transfers](https://paystack.com/docs/api/transfer/#list)
+  - [ ] [Fetch Transfer](https://paystack.com/docs/api/transfer/#fetch)
+  - [x] [Verify Transfer](https://paystack.com/docs/api/transfer/#verify)
+
+- [x] [Refunds](https://paystack.com/docs/api/refund/)
+  - [x] [Create Refund](https://paystack.com/docs/api/refund/#create)
+  - [x] [List Refunds](https://paystack.com/docs/api/refund/#list)
+  - [x] [Fetch Refund](https://paystack.com/docs/api/refund/#fetch)
+
+- [x] [Verification](https://paystack.com/docs/api/verification/)
+  - [x] [Resolve Account Number](https://paystack.com/docs/api/verification/#resolve-account)
+  - [ ] [Validate Account](https://paystack.com/docs/api/verification/#validate-account)
+  - [ ] [Resolve Card BIN](https://paystack.com/docs/api/verification/#resolve-card)
+
+- [x] [Miscellaneous](https://paystack.com/docs/api/miscellaneous/)
+  - [x] [List Banks](https://paystack.com/docs/api/miscellaneous/#bank)
+  - [ ] [List/Search Countries](https://paystack.com/docs/api/miscellaneous/#country)
+  - [ ] [List States (AVS)](https://paystack.com/docs/api/miscellaneous/#avs-states)
+
+
+## Development
+
+1. Fork the repository.
+2. Create a new branch for your feature or bugfix.
+3. Make your changes, add tests for them.
+4. Ensure the tests and linter pass
+5. Open a pull request with a detailed description of your changes.
+
+### Setting up
+
+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.
+
+### Running the tests and linter
+
+Minitest is used for unit tests. Rubocop is used to enforce the ruby style.
+
+To run the complete set of tests and linter run the following:
+
+```bash
+$ bundle install
+$ bundle exec rake test
+$ bundle exec rubocop
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/darthrighteous/paystack-gateway. 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/[darthrighteous/paystackgateway/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 PaystackGateway project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[darthrighteous/paystackgateway/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'minitest/test_task'
+
+Minitest::TestTask.create
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/faraday/response/caching.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+module Faraday
+  class Response
+    # https://github.com/lostisland/faraday_middleware/blob/main/lib/faraday_middleware/response/caching.rb
+    class Caching < Middleware
+      attr_reader :cache
+
+      # Internal: List of status codes that can be cached:
+      # * 200 - 'OK'
+      # * 203 - 'Non-Authoritative Information'
+      # * 300 - 'Multiple Choices'
+      # * 301 - 'Moved Permanently'
+      # * 302 - 'Found'
+      # * 404 - 'Not Found'
+      # * 410 - 'Gone'
+      CACHEABLE_STATUS_CODES = [200, 203, 300, 301, 302, 404, 410].freeze
+
+      extend Forwardable
+      def_delegators :'Faraday::Utils', :parse_query, :build_query
+
+      # Public: initialize the middleware.
+      #
+      # cache   - An object that responds to read and write (default: nil).
+      # options - An options Hash (default: {}):
+      #           :ignore_params - String name or Array names of query
+      #                                    params that should be ignored when forming
+      #                                    the cache key (default: []).
+      #           :write_options - Hash of settings that should be passed as the
+      #                                    third options parameter to the cache's #write
+      #                                    method. If not specified, no options parameter
+      #                                    will be passed.
+      #           :full_key      - Boolean - use full URL as cache key:
+      #                                    (url.host + url.request_uri)
+      #           :status_codes  - Array of http status code to be cache
+      #                                    (default: CACHEABLE_STATUS_CODE)
+      #
+      # Yields if no cache is given. The block should return a cache object.
+      def initialize(app, cache = nil, options = {})
+        super(app)
+        if cache.is_a?(Hash) && block_given?
+          options = cache
+          cache = nil
+        end
+        @cache = cache || yield
+        @options = options
+      end
+
+      def call(env)
+        if env[:method] == :get
+          if env[:parallel_manager]
+            # callback mode
+            cache_on_complete(env)
+          else
+            # synchronous mode
+            key = cache_key(env)
+            unless (response = cache.read(key)) && response
+              response = @app.call(env)
+              store_response_in_cache(key, response)
+            end
+            finalize_response(response, env)
+          end
+        else
+          @app.call(env)
+        end
+      end
+
+      def cache_key(env)
+        url = env[:url].dup
+        if url.query && params_to_ignore.any?
+          params = parse_query url.query
+          params.reject! { |k,| params_to_ignore.include? k }
+          url.query = params.any? ? build_query(params) : nil
+        end
+        url.normalize!
+        digest = full_key? ? url.host + url.request_uri : url.request_uri
+        Digest::SHA1.hexdigest(digest)
+      end
+
+      def params_to_ignore
+        @params_to_ignore ||= Array(@options[:ignore_params]).map(&:to_s)
+      end
+
+      def full_key?
+        @full_key ||= @options[:full_key]
+      end
+
+      def custom_status_codes
+        @custom_status_codes ||= begin
+          codes = CACHEABLE_STATUS_CODES & Array(@options[:status_codes]).map(&:to_i)
+          codes.any? ? codes : CACHEABLE_STATUS_CODES
+        end
+      end
+
+      def cache_on_complete(env)
+        key = cache_key(env)
+        if (cached_response = cache.read(key))
+          finalize_response(cached_response, env)
+        else
+          # response.status is nil at this point
+          # any checks need to be done inside on_complete block
+          @app.call(env).on_complete do |response_env|
+            store_response_in_cache(key, response_env.response)
+            response_env
+          end
+        end
+      end
+
+      def store_response_in_cache(key, response)
+        return unless custom_status_codes.include?(response.status)
+
+        if @options[:write_options]
+          cache.write(key, response, @options[:write_options])
+        else
+          cache.write(key, response)
+        end
+      end
+
+      def finalize_response(response, env)
+        response = response.dup if response.frozen?
+        env[:response] = response
+        unless env[:response_headers]
+          env.update response.env
+          # FIXME: omg hax
+          response.instance_variable_set('@env', env)
+        end
+        response
+      end
+    end
+  end
+end
+
+Faraday::Response.register_middleware(caching: Faraday::Response::Caching)

data/lib/faraday/response/mashify.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Faraday
+  class Response
+    # Parse response bodies as Hashie::Mash.
+    class Mashify < Middleware
+      def initialize(app = nil, mash_class: Hashie::Mash, symbolize: true)
+        super(app)
+
+        @mash_class = mash_class
+        @symbolize = symbolize
+      end
+
+      def on_complete(env)
+        process_response(env)
+      end
+
+      private
+
+      def process_response(env)
+        env[:body] = env[:body].try(:deep_symbolize_keys) if @symbolize
+        env[:body] = parse(env[:body])
+      rescue StandardError, SyntaxError => e
+        raise Faraday::ParsingError.new(e, env[:response])
+      end
+
+      def parse(body)
+        case body
+        when Hash
+          @mash_class.new(body)
+        when Array
+          body.map { |item| parse(item) }
+        else
+          body
+        end
+      end
+    end
+  end
+end
+
+Faraday::Response.register_middleware(mashify: Faraday::Response::Mashify)

data/lib/paystack-gateway.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'paystack_gateway'

data/lib/paystack_gateway/api_error.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'faraday/error'
+
+module PaystackGateway
+  # This error is raised when an exception occurs in the process of fulfilling
+  # an api method.
+  #
+  # It allows for dynamic checking of the error message by calling a method.
+  # * Calling `error.foo_error?` will return true if the error message is
+  #   "foo_error" or "foo".
+  #
+  # * Calling `error.foo_error!` ensures that subsequent calls to
+  #   `error.foo_error?` return true regardless of the message.
+  #
+  #     api_method def initialize_transaction(**transaction_data)
+  #       raise ApiError.new(:invalid_amount, cancellable: true) if !transaction_data[:amount]
+  #       ...
+  #     end
+  #
+  #     begin
+  #       initialize_transaction({amount: nil})
+  #     rescue ApiError => e
+  #       handle_invalid_amount_error(e) if e.invalid_amount_error? # => true
+  #       cancel_transaction if e.cancellable?
+  #     end
+  class ApiError < StandardError
+    CONNECTION_ERROR_CLASSES = [
+      Faraday::ServerError,
+      Faraday::ConnectionFailed,
+      Faraday::SSLError,
+    ].freeze
+
+    attr_reader :original_error, :cancellable
+    alias cancellable? cancellable
+
+    def initialize(msg = nil, original_error: nil, cancellable: false)
+      super(msg)
+
+      @original_error = original_error
+      @cancellable = cancellable
+    end
+
+    def network_error? = original_error&.class&.in?(CONNECTION_ERROR_CLASSES)
+
+    def method_missing(method_name, *)
+      return super unless method_name.to_s.end_with?('_error?', '_error!')
+
+      if method_name.to_s.end_with?('_error!')
+        define_singleton_method(method_name.to_s.sub(/!$/, '?')) { true }
+      elsif method_name.to_s.end_with?('_error?')
+        matching_messages = [
+          method_name.to_s.remove(/_error\?$/),
+          method_name.to_s.remove(/\?$/),
+        ]
+        message.to_s.in?(matching_messages)
+      end
+    end
+
+    def respond_to_missing?(method_name, *)
+      method_name.to_s.end_with?('_error?', '_error!') || super
+    end
+
+    private
+
+    def http_code = original_error.try(:response_status)
+    def response_body = original_error.try(:response_body)&.with_indifferent_access
+  end
+end