feat: Add connection utilities for improved API connection handling

Author: nanafox

README.md

@@ -78,6 +78,9 @@ end
 # Initialize with your Paystack secret key
 paystack = PaystackSdk::Client.new(secret_key: "sk_test_xxx")
 
+# Or set the PAYSTACK_SECRET_KEY in your environment and do this instead
+paystack = PaystackSdk::Client.new # => This will dynamically fetch the secret key
+
 # You can access the connection directly if needed
 connection = paystack.connection
 ```

lib/paystack_sdk/client.rb

@@ -1,32 +1,36 @@
 # frozen_string_literal: true
 
 require_relative "resources/transactions"
+require_relative "utils/connection_utils"
 
 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"
+ # Include connection utilities
+ include Utils::ConnectionUtils
 
  # @return [Faraday::Connection] The Faraday connection object used for API requests
  attr_reader :connection
 
  # Initializes a new `Client` instance.
  #
- # @param secret_key [String] The secret API key for authenticating with the Paystack API.
+ # @param connection [Faraday::Connection, nil] The Faraday connection object used for API requests.
+ # If nil, a new connection will be created using the default API key.
+ # @param secret_key [String, nil] Optional API key to use for creating a new connection.
+ # Only used if connection is nil.
  #
- # @example
+ # @example With an existing connection
+ # connection = Faraday.new(...)
+ # client = PaystackSdk::Client.new(connection)
+ #
+ # @example With an API key
  # client = PaystackSdk::Client.new(secret_key: "sk_test_xxx")
- def initialize(secret_key:)
- @connection = Faraday.new(url: BASE_URL) do |conn|
- conn.request :json
- conn.response :json, content_type: /\bjson$/
- conn.headers["Authorization"] = "Bearer #{secret_key}"
- conn.headers["Content-Type"] = "application/json"
- conn.headers["User-Agent"] = "paystack_sdk/#{PaystackSdk::VERSION}"
- conn.adapter Faraday.default_adapter
- end
+ #
+ # @example With default connection (requires PAYSTACK_SECRET_KEY environment variable)
+ # client = PaystackSdk::Client.new
+ def initialize(connection = nil, secret_key: nil)
+ @connection = initialize_connection(connection, secret_key: secret_key)
  end
 
  # Provides access to the `Transactions` resource.

lib/paystack_sdk/resources/base.rb

@@ -3,14 +3,15 @@
 require_relative "../response"
 require_relative "../client"
 require_relative "../validations"
+require_relative "../utils/connection_utils"
 
 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
- # Include validation methods
  include PaystackSdk::Validations
+ include PaystackSdk::Utils::ConnectionUtils
 
  # Initializes a new `Base` instance.
  #
@@ -29,36 +30,11 @@ class Base
  # @example With default connection (requires PAYSTACK_SECRET_KEY environment variable)
  # resource = PaystackSdk::Resources::SomeResource.new
  def initialize(connection = nil, secret_key: nil)
- @connection = if connection
- connection
- elsif secret_key
- create_connection(secret_key:)
- else
- # Try to get API key from environment variable
- env_secret_key = ENV["PAYSTACK_SECRET_KEY"]
- raise PaystackSdk::Error, "No connection or API key provided" unless env_secret_key
-
- create_connection(secret_key: env_secret_key)
- end
+ @connection = initialize_connection(connection, secret_key: secret_key)
  end
 
  private
 
- # Creates a new Faraday connection with the Paystack API.
- #
- # @param secret_key [String] The secret API key for authenticating with the Paystack API.
- # @return [Faraday::Connection] A configured Faraday connection.
- def create_connection(secret_key:)
- Faraday.new(url: PaystackSdk::Client::BASE_URL) do |conn|
- conn.request :json
- conn.response :json, content_type: /\bjson$/
- conn.headers["Authorization"] = "Bearer #{secret_key}"
- conn.headers["Content-Type"] = "application/json"
- conn.headers["User-Agent"] = "paystack_sdk/#{PaystackSdk::VERSION}"
- conn.adapter Faraday.default_adapter
- end
- end
-
  # Handles the API response, wrapping it in a Response object.
  #
  # @param response [Faraday::Response] The response object returned by the Faraday connection.

lib/paystack_sdk/utils/connection_utils.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module PaystackSdk
+ module Utils
+ # The `ConnectionUtils` module provides shared functionality for creating
+ # and initializing API connections. This is used by both the Client class
+ # and resource classes.
+ module ConnectionUtils
+ # The base URL for the Paystack API.
+ BASE_URL = "https://api.paystack.co"
+
+ # Initializes a connection based on the provided parameters.
+ #
+ # @param connection [Faraday::Connection, nil] An existing connection object.
+ # @param secret_key [String, nil] Optional API key to use for creating a new connection.
+ # @return [Faraday::Connection] A connection object for API requests.
+ # @raise [PaystackSdk::Error] If no connection or API key can be found.
+ def initialize_connection(connection = nil, secret_key: nil)
+ if connection
+ connection
+ elsif secret_key
+ create_connection(secret_key:)
+ else
+ # Try to get API key from environment variable
+ env_secret_key = ENV["PAYSTACK_SECRET_KEY"]
+ raise PaystackSdk::Error, "No connection or API key provided" unless env_secret_key
+
+ create_connection(secret_key: env_secret_key)
+ end
+ end
+
+ # Creates a new Faraday connection with the Paystack API.
+ #
+ # @param secret_key [String] The secret API key for authenticating with the Paystack API.
+ # @return [Faraday::Connection] A configured Faraday connection.
+ def create_connection(secret_key:)
+ Faraday.new(url: BASE_URL) do |conn|
+ conn.request :json
+ conn.response :json, content_type: /\bjson$/
+ conn.headers["Authorization"] = "Bearer #{secret_key}"
+ conn.headers["Content-Type"] = "application/json"
+ conn.headers["User-Agent"] = "paystack_sdk/#{PaystackSdk::VERSION}"
+ conn.adapter Faraday.default_adapter
+ end
+ end
+ end
+ end
+end