paystack-gateway 0.1.1 → 0.2.0

data/lib/paystack_gateway/charge.rb

@@ -0,0 +1,346 @@
+# frozen_string_literal: true
+
+module PaystackGateway
+  # https://paystack.com/docs/api/charge
+  #
+  # Charges
+  # A collection of endpoints for configuring and managing the payment channels when initiating a payment
+  module Charge
+    include PaystackGateway::RequestModule
+
+    # Successful response from calling #create.
+    class CreateResponse < PaystackGateway::Response
+      delegate :id,
+               :domain,
+               :reference,
+               :receipt_number,
+               :amount,
+               :gateway_response,
+               :paid_at,
+               :created_at,
+               :channel,
+               :currency,
+               :ip_address,
+               :metadata,
+               :log,
+               :fees,
+               :fees_split,
+               :authorization,
+               :customer,
+               :plan,
+               :split,
+               :order_id,
+               :paidAt,
+               :createdAt,
+               :requested_amount,
+               :pos_transaction_data,
+               :source,
+               :fees_breakdown,
+               :connect,
+               :transaction_date,
+               :plan_object,
+               :subaccount, to: :data
+    end
+
+    # Error response from #create.
+    class CreateError < ApiError; end
+
+    # https://paystack.com/docs/api/charge/#create
+    # Create Charge: POST /charge
+    # Initiate a payment by integrating the payment channel of your choice.
+    #
+    # @param email [String] (required)
+    #        Customer's email address
+    # @param amount [Integer] (required)
+    #        Amount should be in kobo if currency is NGN, pesewas, if currency is GHS, and cents,
+    #        if currency is ZAR
+    # @param authorization_code [String]
+    #        An authorization code to charge.
+    # @param pin [String]
+    #        4-digit PIN (send with a non-reusable authorization code)
+    # @param reference [String]
+    #        Unique transaction reference. Only -, .`, = and alphanumeric characters allowed.
+    # @param birthday [String]
+    #        The customer's birthday in the format YYYY-MM-DD e.g 2017-05-16
+    # @param device_id [String]
+    #        This is the unique identifier of the device a user uses in making payment. Only
+    #        -, .`, = and alphanumeric characters are allowed.
+    # @param metadata [Hash]
+    #        JSON object of custom data
+    # @param bank [Hash]
+    #        The bank object if charging a bank account
+    #   @option bank [String] :code
+    #           Customer's bank code
+    #   @option bank [String] :account_number
+    #           Customer's account number
+    # @param mobile_money [Hash]
+    #        Details of the mobile service provider
+    #   @option mobile_money [String] :phone
+    #           Customer's phone number
+    #   @option mobile_money [String] :provider
+    #           The telco provider of customer's phone number. This can be fetched from the List
+    #           Bank endpoint
+    # @param ussd [Hash]
+    #        The USSD code for the provider to charge
+    #   @option ussd ["737", "919", "822", "966"] :type
+    #           The three-digit USSD code.
+    # @param eft [Hash]
+    #        Details of the EFT provider
+    #   @option eft [String] :provider
+    #           The EFT provider
+    #
+    # @return [CreateResponse] successful response
+    # @raise [CreateError] if the request fails
+    api_method def self.create(
+      email:,
+      amount:,
+      authorization_code: nil,
+      pin: nil,
+      reference: nil,
+      birthday: nil,
+      device_id: nil,
+      metadata: nil,
+      bank: nil,
+      mobile_money: nil,
+      ussd: nil,
+      eft: nil
+    )
+      use_connection do |connection|
+        connection.post(
+          '/charge',
+          {
+            email:,
+            amount:,
+            authorization_code:,
+            pin:,
+            reference:,
+            birthday:,
+            device_id:,
+            metadata:,
+            bank:,
+            mobile_money:,
+            ussd:,
+            eft:,
+          }.compact,
+        )
+      end
+    end
+
+    # Successful response from calling #submit_pin.
+    class SubmitPinResponse < PaystackGateway::Response
+      delegate :amount,
+               :currency,
+               :transaction_date,
+               :reference,
+               :domain,
+               :redirect_url,
+               :metadata,
+               :gateway_response,
+               :channel,
+               :fees,
+               :authorization,
+               :customer, to: :data
+    end
+
+    # Error response from #submit_pin.
+    class SubmitPinError < ApiError; end
+
+    # https://paystack.com/docs/api/charge/#submit_pin
+    # Submit PIN: POST /charge/submit_pin
+    # Submit PIN to continue a charge
+    #
+    # @param pin [String] (required)
+    #        Customer's PIN for the ongoing transaction
+    # @param reference [String] (required)
+    #        Transaction reference that requires the PIN
+    #
+    # @return [SubmitPinResponse] successful response
+    # @raise [SubmitPinError] if the request fails
+    api_method def self.submit_pin(pin:, reference:)
+      use_connection do |connection|
+        connection.post(
+          '/charge/submit_pin',
+          { pin:, reference: }.compact,
+        )
+      end
+    end
+
+    # Successful response from calling #submit_otp.
+    class SubmitOtpResponse < PaystackGateway::Response
+      delegate :amount,
+               :currency,
+               :transaction_date,
+               :reference,
+               :domain,
+               :redirect_url,
+               :metadata,
+               :gateway_response,
+               :channel,
+               :fees,
+               :authorization,
+               :customer, to: :data
+    end
+
+    # Error response from #submit_otp.
+    class SubmitOtpError < ApiError; end
+
+    # https://paystack.com/docs/api/charge/#submit_otp
+    # Submit OTP: POST /charge/submit_otp
+    # Submit OTP to complete a charge
+    #
+    # @param otp [String] (required)
+    #        Customer's OTP for ongoing transaction
+    # @param reference [String] (required)
+    #        The reference of the ongoing transaction
+    #
+    # @return [SubmitOtpResponse] successful response
+    # @raise [SubmitOtpError] if the request fails
+    api_method def self.submit_otp(otp:, reference:)
+      use_connection do |connection|
+        connection.post(
+          '/charge/submit_otp',
+          { otp:, reference: }.compact,
+        )
+      end
+    end
+
+    # Successful response from calling #submit_phone.
+    class SubmitPhoneResponse < PaystackGateway::Response
+      delegate :amount,
+               :currency,
+               :transaction_date,
+               :reference,
+               :domain,
+               :redirect_url,
+               :metadata,
+               :gateway_response,
+               :channel,
+               :fees,
+               :authorization,
+               :customer,
+               :display_text, to: :data
+    end
+
+    # Error response from #submit_phone.
+    class SubmitPhoneError < ApiError; end
+
+    # https://paystack.com/docs/api/charge/#submit_phone
+    # Submit Phone: POST /charge/submit_phone
+    # Submit phone number when requested
+    #
+    # @param phone [String] (required)
+    #        Customer's mobile number
+    # @param reference [String] (required)
+    #        The reference of the ongoing transaction
+    #
+    # @return [SubmitPhoneResponse] successful response
+    # @raise [SubmitPhoneError] if the request fails
+    api_method def self.submit_phone(phone:, reference:)
+      use_connection do |connection|
+        connection.post(
+          '/charge/submit_phone',
+          { phone:, reference: }.compact,
+        )
+      end
+    end
+
+    # Successful response from calling #submit_birthday.
+    class SubmitBirthdayResponse < PaystackGateway::Response
+      delegate :display_text, to: :data
+    end
+
+    # Error response from #submit_birthday.
+    class SubmitBirthdayError < ApiError; end
+
+    # https://paystack.com/docs/api/charge/#submit_birthday
+    # Submit Birthday: POST /charge/submit_birthday
+    # Submit the customer's birthday when requested
+    #
+    # @param birthday [String] (required)
+    #        Customer's birthday in the format YYYY-MM-DD e.g 2016-09-21
+    # @param reference [String] (required)
+    #        The reference of the ongoing transaction
+    #
+    # @return [SubmitBirthdayResponse] successful response
+    # @raise [SubmitBirthdayError] if the request fails
+    api_method def self.submit_birthday(birthday:, reference:)
+      use_connection do |connection|
+        connection.post(
+          '/charge/submit_birthday',
+          { birthday:, reference: }.compact,
+        )
+      end
+    end
+
+    # Successful response from calling #submit_address.
+    class SubmitAddressResponse < PaystackGateway::Response; end
+
+    # Error response from #submit_address.
+    class SubmitAddressError < ApiError; end
+
+    # https://paystack.com/docs/api/charge/#submit_address
+    # Submit Address: POST /charge/submit_address
+    # Send the details of the customer's address for address verification
+    #
+    # @param address [String] (required)
+    #        Customer's address
+    # @param city [String] (required)
+    #        Customer's city
+    # @param state [String] (required)
+    #        Customer's state
+    # @param zip_code [String] (required)
+    #        Customer's zipcode
+    # @param reference [String] (required)
+    #        The reference of the ongoing transaction
+    #
+    # @return [SubmitAddressResponse] successful response
+    # @raise [SubmitAddressError] if the request fails
+    api_method def self.submit_address(address:, city:, state:, zip_code:, reference:)
+      use_connection do |connection|
+        connection.post(
+          '/charge/submit_address',
+          { address:, city:, state:, zip_code:, reference: }.compact,
+        )
+      end
+    end
+
+    # Successful response from calling #check.
+    class CheckResponse < PaystackGateway::Response
+      delegate :amount,
+               :currency,
+               :transaction_date,
+               :reference,
+               :domain,
+               :redirect_url,
+               :metadata,
+               :gateway_response,
+               :channel,
+               :fees,
+               :authorization,
+               :customer, to: :data
+    end
+
+    # Error response from #check.
+    class CheckError < ApiError; end
+
+    # https://paystack.com/docs/api/charge/#check
+    # Check pending charge: GET /charge/{reference}
+    # When you get `pending` as a charge status or if there was an exception when calling
+    # any of the `/charge` endpoints, wait 10 seconds or more, then make a check to see
+    # if its status has changed. Don't call too early as you may get a lot more pending
+    # than you should.
+    #
+    # @param reference [String] (required)
+    #        The reference of the ongoing transaction
+    #
+    # @return [CheckResponse] successful response
+    # @raise [CheckError] if the request fails
+    api_method def self.check(reference:)
+      use_connection do |connection|
+        connection.get(
+          "/charge/#{reference}",
+        )
+      end
+    end
+  end
+end

data/lib/paystack_gateway/configuration.rb

@@ -7,11 +7,22 @@ module PaystackGateway
   # Encapsulates the configuration options for PaystackGateway including the
   # secret key, logger, logging_options, and log filter.
   class Configuration
-    attr_accessor :secret_key, :logger, :logging_options, :log_filter
+    attr_accessor :secret_key, :logger, :logging_options, :log_filter, :use_extensions
 
     def initialize
-      @logger = Logger.new($stdout)
+      @logger = Logger.new($stdout, level: :info)
       @log_filter = lambda(&:dup)
+      @use_extensions = true
     end
   end
+
+  class << self
+    attr_writer :config
+
+    delegate :secret_key, :logger, :logging_options, :log_filter, :use_extensions,
+             to: :config
+
+    def config = @config ||= Configuration.new
+    def configure = yield(config)
+  end
 end