paystack_sdk 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bcb48b6fccd1a9125723781ac1f6d7adcf116459890587132dd12c516325a4aa
-  data.tar.gz: 175a50985ee81851b541efbc24c8c8075f8ecdf082e12b14a7736a248fbbca02
+  metadata.gz: 5dc8af5f5a8c1305ac52bb936f3601982204a1ccab20ee7d63b2b7ad89c03b3f
+  data.tar.gz: 30c6c8e89a107566d079ca22f78f56cbb6d48701db2d97f60ddb6357a2f5c5b7
 SHA512:
-  metadata.gz: 6a49b817e05714ee17fc0f950385cb9af46209fd3fc7b58f69d012a08bcaf2540c1b0fa45a5d7398bd4d38eb1abd56e65bbec815dbc5e8ea1e53ebecb1799977
-  data.tar.gz: d0b9948e467e520ee7e1b636c9ca0865a6ee0f8ff804dac7445ba7e939964b657bc7dab66a7fedba633212b5ab39c52fba69ea28a3a351796bca225f11042389
+  metadata.gz: b5f448b8d57b73b3837542791f56418b1711dc697b7551b1240eac3b86d5337d7a125b70d006654ef41a84e16b40da38ad5bb5178faf50fee12ac72ca9d8c7f1
+  data.tar.gz: 6c3d0d9eb5c06106e1fea26e7434034a42693925cae29a7cbf9288d5655c48598a91a80cc353b238dfdd9bb73be957d4f2e511fc54004260521aa8fedaf17cf3

data/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
 ```

data/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.

data/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 @@ module PaystackSdk
       # @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.

data/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

data/lib/paystack_sdk/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paystack_sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Maxwell Nana Forson (theLazyProgrammer)
@@ -119,6 +119,7 @@ files:
 - lib/paystack_sdk/resources/base.rb
 - lib/paystack_sdk/resources/transactions.rb
 - lib/paystack_sdk/response.rb
+- lib/paystack_sdk/utils/connection_utils.rb
 - lib/paystack_sdk/validations.rb
 - lib/paystack_sdk/version.rb
 - mise.toml