paystack_sdk 0.4.1 → 0.5.0

data/lib/paystack_sdk/validations.rb

@@ -85,6 +85,23 @@ module PaystackSdk
       end
     end
 
+    # Validates a numeric identifier, such as a customer or plan ID. Paystack answers with an empty
+    # list and no error when a code (`CUS_...`) is passed where it filters by the numeric ID, so a wrong
+    # value would otherwise look like "no results". An Integer, or a string of digits, passes.
+    #
+    # @param value [Integer, String, nil] The identifier to validate
+    # @param name [String] Name of the parameter for error messages
+    # @param allow_nil [Boolean] Whether nil is acceptable (default: true)
+    # @raise [PaystackSdk::MissingParamError] If value is nil and nil is not allowed
+    # @raise [PaystackSdk::InvalidValueError] If value is not a positive whole number
+    def validate_numeric_id!(value:, name: "Parameter", allow_nil: true)
+      if value.nil?
+        raise PaystackSdk::MissingParamError.new(name) unless allow_nil
+      elsif !(value.is_a?(Integer) || value.is_a?(String)) || !value.to_s.match?(/\A[1-9]\d*\z/)
+        raise PaystackSdk::InvalidValueError.new(name, "must be the numeric ID (for example 123456), not a code or a name")
+      end
+    end
+
     # Validates a transaction reference format.
     #
     # @param reference [String] The reference to validate

data/lib/paystack_sdk/version.rb

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

data/lib/paystack_sdk/webhook.rb

@@ -37,15 +37,21 @@ module PaystackSdk
     # The only addresses Paystack sends webhooks from, for both test and live.
     IP_ADDRESSES = %w[52.31.139.75 52.49.173.169 52.214.14.220].freeze
 
-    # Events Paystack documents. Paystack adds events over time, so an event
-    # outside this list is still returned by {Webhook.construct_event}.
+    # Events Paystack documents, plus ones Paystack was seen sending that its Webhooks page does not list.
+    # Paystack adds events over time, so an event outside this list is still returned by
+    # {Webhook.construct_event}.
+    #
+    # Documented on the Webhooks page, except `refund.needs-attention`, which only the Refunds guide
+    # names. Seen in the event log of a test integration (Webhook Events API) and not on the Webhooks
+    # page: `paymentrequest.draft`, `product.create`, `product.update` and `product.delete`.
     EVENTS = %w[
       charge.dispute.create charge.dispute.remind charge.dispute.resolve charge.success
       customeridentification.failed customeridentification.success
       dedicatedaccount.assign.failed dedicatedaccount.assign.success
       invoice.create invoice.payment_failed invoice.update
-      paymentrequest.pending paymentrequest.success
-      refund.failed refund.pending refund.processed refund.processing
+      paymentrequest.draft paymentrequest.pending paymentrequest.success
+      product.create product.delete product.update
+      refund.failed refund.needs-attention refund.pending refund.processed refund.processing
       subscription.create subscription.disable subscription.expiring_cards subscription.not_renew
       transfer.failed transfer.reversed transfer.success
     ].freeze
@@ -70,7 +76,7 @@ module PaystackSdk
         @data = payload.key?("data") ? Response.new(payload["data"]) : nil
       end
 
-      # @return [Boolean] Whether Paystack documents this event name
+      # @return [Boolean] Whether this event name is in {EVENTS} (documented, or seen sent by Paystack)
       def known?
         EVENTS.include?(event)
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paystack_sdk
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Maxwell Nana Forson (theLazyProgrammer)
@@ -149,7 +149,8 @@ description: |
   such as initiating transactions, verifying payments, managing customers, and more.
 email:
 - nanaforsonjnr@gmail.com
-executables: []
+executables:
+- paystack_sdk
 extensions: []
 extra_rdoc_files: []
 files:
@@ -161,7 +162,10 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- exe/paystack_sdk
+- lib/generators/paystack_sdk/skills_generator.rb
 - lib/paystack_sdk.rb
+- lib/paystack_sdk/cli.rb
 - lib/paystack_sdk/client.rb
 - lib/paystack_sdk/middleware/transport_errors.rb
 - lib/paystack_sdk/request_helpers.rb
@@ -194,7 +198,18 @@ files:
 - lib/paystack_sdk/resources/transfer_recipients.rb
 - lib/paystack_sdk/resources/transfers.rb
 - lib/paystack_sdk/resources/virtual_terminals.rb
+- lib/paystack_sdk/resources/webhook_events.rb
 - lib/paystack_sdk/response.rb
+- lib/paystack_sdk/skills.rb
+- lib/paystack_sdk/skills/paystack-sdk-charge-statuses/SKILL.md
+- lib/paystack_sdk/skills/paystack-sdk-mobile-money/SKILL.md
+- lib/paystack_sdk/skills/paystack-sdk-money-safety/SKILL.md
+- lib/paystack_sdk/skills/paystack-sdk-overview/SKILL.md
+- lib/paystack_sdk/skills/paystack-sdk-payments/SKILL.md
+- lib/paystack_sdk/skills/paystack-sdk-refunds/SKILL.md
+- lib/paystack_sdk/skills/paystack-sdk-saved-card-renewals/SKILL.md
+- lib/paystack_sdk/skills/paystack-sdk-testing/SKILL.md
+- lib/paystack_sdk/skills/paystack-sdk-webhooks/SKILL.md
 - lib/paystack_sdk/utils/connection_utils.rb
 - lib/paystack_sdk/validations.rb
 - lib/paystack_sdk/version.rb