paystack_sdk 0.0.6 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4ff6401efb6a0aba25394b61aa74e1a2645848c015565f3590ffdc10f504748
-  data.tar.gz: e59175c14b106866b7129e5cb640ec9a64feebb5a2ddce12940e0436e8dc88af
+  metadata.gz: 1161ca83326adeace91da47a17f4c078cee7f6073b4efda0d0d0e707b9744928
+  data.tar.gz: 44a2b6e56897e8e3f020705f2b836f6a6172599f43b1c976144a2cab9165616d
 SHA512:
-  metadata.gz: 964956e0a22d4ea337ac49896a865d43a0d6ba6ac2f2cc307a49f120b0b407cb4dedf80c6f3b5ed8a227b89d283e5a9d2729210c3763d4f6236f373de5e9bc6b
-  data.tar.gz: e86ef5b41b26ee645f3f3b208cc945cb382d38d768ace5440af66fc0e82a3fac2e036902723021da0d896b90b4b1877b5f395f3ea2860e577010035624608de7
+  metadata.gz: 59fc459f0ca4b103c4815c6523d6a6f6b7bf8088ef391c3d980b829f512aab9e66081796e2713d93d09cfeadb73c6069101ca91ce3b993ccf47389e0d8404df4
+  data.tar.gz: c4cc838ad71d8a8860b037096db5cf3c8cc55ed73a735eb405b4e81bd065a935de1529aa7e31876c64901c3f8fe973c9b2e7294924c7fd36881668a14297056a

data/CHANGELOG.md

@@ -1,5 +1,36 @@
 # Changelog
 
+## [0.0.8] - 2025-06-26
+
+### Added
+
+- Banks resource with support for listing banks and currency validation
+- Regression tests for Banks resource, including validation for allowed currencies
+- Registered `banks` resource in the main client for easy access
+
+### Improved
+
+- Validation for allowed currency values in Banks resource for safer API usage
+
+## [0.0.7] - 2025-06-25
+
+### Added
+
+- Transfer Recipients resource with full CRUD operations (create, list, fetch, update, delete)
+- Transfers resource with full API support (create/initiate, list, fetch, finalize, verify)
+- All resource methods now use `handle_response` for consistent response handling
+- Regression tests for Transfer Recipients and Transfers resources, ensuring response wrapping and validation
+
+### Changed
+
+- Registered `transfer_recipients` and `transfers` resources in the main client for easy access
+- Updated specs to verify that all resource methods wrap responses using `PaystackSdk::Response`
+
+### Improved
+
+- Enhanced test coverage for new resources and response handling
+- Improved code consistency by enforcing response wrapping and validation patterns across all new resources
+
 ## [0.0.6] - 2025-06-10
 
 ### Added

data/lib/paystack_sdk/client.rb

@@ -2,6 +2,9 @@
 
 require_relative "resources/transactions"
 require_relative "resources/customers"
+require_relative "resources/transfer_recipients"
+require_relative "resources/transfers"
+require_relative "resources/banks"
 require_relative "utils/connection_utils"
 
 module PaystackSdk
@@ -61,5 +64,47 @@ module PaystackSdk
     def customers
       @customers ||= Resources::Customers.new(@connection)
     end
+
+    # Provides access to the `TransferRecipients` resource.
+    #
+    # @return [PaystackSdk::Resources::TransferRecipients] An instance of the
+    #  `TransferRecipients` resource.
+    #
+    # @example
+    # ```ruby
+    #   recipients = client.transfer_recipients
+    #   response = recipients.create(params)
+    # ```
+    def transfer_recipients
+      @transfer_recipients ||= Resources::TransferRecipients.new(@connection)
+    end
+
+    # Provides access to the `Transfers` resource.
+    #
+    # @return [PaystackSdk::Resources::Transfers] An instance of the
+    #  `Transfers` resource.
+    #
+    # @example
+    # ```ruby
+    #   transfers = client.transfers
+    #   response = transfers.create(params)
+    # ```
+    def transfers
+      @transfers ||= Resources::Transfers.new(@connection)
+    end
+
+    # Provides access to the `Banks` resource.
+    #
+    # @return [PaystackSdk::Resources::Banks] An instance of the
+    #  `Banks` resource.
+    #
+    # @example
+    # ```ruby
+    #   banks = client.banks
+    #   response = banks.list
+    # ```
+    def banks
+      @banks ||= Resources::Banks.new(@connection)
+    end
   end
 end

data/lib/paystack_sdk/resources/banks.rb

@@ -0,0 +1,21 @@
+require_relative "../validations"
+
+module PaystackSdk
+  module Resources
+    class Banks < Base
+      # List banks
+      # @see https://paystack.com/docs/api/bank/#list
+      def list(query = {})
+        if query.key?(:currency)
+          validate_allowed_values!(
+            value: query[:currency],
+            name: "currency",
+            allowed_values: %w[NGN GHS ZAR KES USD]
+          )
+        end
+
+        handle_response(@connection.get("/bank", query))
+      end
+    end
+  end
+end

data/lib/paystack_sdk/resources/transfer_recipients.rb

@@ -0,0 +1,47 @@
+require_relative "../validations"
+
+module PaystackSdk
+  module Resources
+    class TransferRecipients < Base
+      # Create a transfer recipient
+      # @see https://paystack.com/docs/api/transfer-recipient/#create
+      def create(params)
+        validate_hash!(input: params, name: "TransferRecipient params")
+        validate_required_params!(
+          payload: params,
+          required_params: %i[type name account_number bank_code],
+          operation_name: "Create Transfer Recipient"
+        )
+        handle_response(@connection.post("/transferrecipient", params))
+      end
+
+      # List transfer recipients
+      # @see https://paystack.com/docs/api/transfer-recipient/#list
+      def list(query = {})
+        handle_response(@connection.get("/transferrecipient", query))
+      end
+
+      # Fetch a transfer recipient
+      # @see https://paystack.com/docs/api/transfer-recipient/#fetch
+      def fetch(recipient_code:)
+        validate_presence!(value: recipient_code, name: "recipient_code")
+        handle_response(@connection.get("/transferrecipient/#{recipient_code}"))
+      end
+
+      # Update a transfer recipient
+      # @see https://paystack.com/docs/api/transfer-recipient/#update
+      def update(recipient_code:, params:)
+        validate_presence!(value: recipient_code, name: "recipient_code")
+        validate_hash!(input: params, name: "Update TransferRecipient params")
+        handle_response(@connection.put("/transferrecipient/#{recipient_code}", params))
+      end
+
+      # Delete a transfer recipient
+      # @see https://paystack.com/docs/api/transfer-recipient/#delete
+      def delete(recipient_code:)
+        validate_presence!(value: recipient_code, name: "recipient_code")
+        handle_response(@connection.delete("/transferrecipient/#{recipient_code}"))
+      end
+    end
+  end
+end

data/lib/paystack_sdk/resources/transfers.rb

@@ -0,0 +1,47 @@
+require_relative "../validations"
+
+module PaystackSdk
+  module Resources
+    class Transfers < Base
+      # Create a transfer
+      # @see https://paystack.com/docs/api/transfer/#initiate
+      def create(params)
+        validate_hash!(input: params, name: "Transfer params")
+        validate_required_params!(
+          payload: params,
+          required_params: %i[source amount recipient],
+          operation_name: "Create Transfer"
+        )
+        handle_response(@connection.post("/transfer", params))
+      end
+
+      # List transfers
+      # @see https://paystack.com/docs/api/transfer/#list
+      def list(query = {})
+        handle_response(@connection.get("/transfer", query))
+      end
+
+      # Fetch a transfer
+      # @see https://paystack.com/docs/api/transfer/#fetch
+      def fetch(id:)
+        validate_presence!(value: id, name: "transfer id")
+        handle_response(@connection.get("/transfer/#{id}"))
+      end
+
+      # Finalize a transfer (OTP)
+      # @see https://paystack.com/docs/api/transfer/#finalize
+      def finalize(transfer_code:, otp:)
+        validate_presence!(value: transfer_code, name: "transfer_code")
+        validate_presence!(value: otp, name: "otp")
+        handle_response(@connection.post("/transfer/finalize_transfer", {transfer_code: transfer_code, otp: otp}))
+      end
+
+      # Verify a transfer
+      # @see https://paystack.com/docs/api/transfer/#verify
+      def verify(reference:)
+        validate_presence!(value: reference, name: "reference")
+        handle_response(@connection.get("/transfer/verify/#{reference}"))
+      end
+    end
+  end
+end

data/lib/paystack_sdk/response.rb

@@ -51,6 +51,9 @@ module PaystackSdk
     # @return [String, nil] API message from the response
     attr_reader :api_message
 
+    # @return [String, nil] API message from the response, if available
+    attr_reader :message
+
     # @return [Hash, Array, Object] The underlying data
     attr_reader :raw_data
 
@@ -70,6 +73,7 @@ module PaystackSdk
         @status_code = response.status
         @body = response.body
         @api_message = extract_api_message(@body)
+        @message = @api_message
         @raw_data = extract_data_from_body(@body)
 
         case @status_code

data/lib/paystack_sdk/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paystack_sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.8
 platform: ruby
 authors:
 - Maxwell Nana Forson (theLazyProgrammer)
@@ -29,14 +29,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '3.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '3.13'
 - !ruby/object:Gem::Dependency
   name: standard
   requirement: !ruby/object:Gem::Requirement
@@ -115,9 +115,12 @@ files:
 - Rakefile
 - lib/paystack_sdk.rb
 - lib/paystack_sdk/client.rb
+- lib/paystack_sdk/resources/banks.rb
 - lib/paystack_sdk/resources/base.rb
 - lib/paystack_sdk/resources/customers.rb
 - lib/paystack_sdk/resources/transactions.rb
+- lib/paystack_sdk/resources/transfer_recipients.rb
+- lib/paystack_sdk/resources/transfers.rb
 - lib/paystack_sdk/response.rb
 - lib/paystack_sdk/utils/connection_utils.rb
 - lib/paystack_sdk/validations.rb