mpesa_stk 2.0.0 → 3.0.0

data/lib/mpesa_stk/access_token.rb

@@ -25,6 +25,7 @@
 require 'base64'
 require 'json'
 require 'redis'
+require 'mpesa_stk/config'
 
 module MpesaStk
   # Handles OAuth access token generation, caching, and refreshing for M-Pesa APIs
@@ -36,8 +37,8 @@ module MpesaStk
     end
 
     def initialize(key = nil, secret = nil)
-      @key = key.nil? ? ENV.fetch('key', nil) : key
-      @secret = secret.nil? ? ENV.fetch('secret', nil) : secret
+      @key = key.nil? ? Config.fetch('key') : key
+      @secret = secret.nil? ? Config.fetch('secret') : secret
       begin
         @redis = Redis.new
       rescue Redis::CannotConnectError, Redis::ConnectionError => e
@@ -100,7 +101,7 @@ module MpesaStk
     private
 
     def url
-      "#{ENV.fetch('base_url', nil)}#{ENV.fetch('token_generator_url', nil)}"
+      "#{Config.fetch('base_url')}#{Config.fetch('token_generator_url')}"
     end
 
     def headers

data/lib/mpesa_stk/account_balance.rb

@@ -1,142 +1,30 @@
 # frozen_string_literal: true
 
-# Copyright (c) 2018 mboya
-#
-# MIT License
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
-
-require 'mpesa_stk/access_token'
+require 'mpesa_stk/client'
 
 module MpesaStk
-  # Query account balance for PayBill or Till Number
-  class AccountBalance
+  # Query account balance for a PayBill or Till number.
+  class AccountBalance < Client
     class << self
-      def query(hash = {})
-        new(hash).query_balance
+      def call(**options)
+        new(**options).query_balance
       end
     end
 
-    attr_reader :token, :initiator, :security_credential, :party_a, :identifier_type, :result_url, :queue_timeout_url
-
-    def initialize(hash = {})
-      @token = MpesaStk::AccessToken.call(hash['key'], hash['secret'])
-      @initiator = hash['initiator'] || ENV.fetch('initiator', nil)
-      @security_credential = hash['security_credential'] || ENV.fetch('security_credential', nil)
-      @party_a = hash['party_a'] || ENV.fetch('business_short_code', nil)
-      @identifier_type = hash['identifier_type'] || '4'
-      @result_url = hash['result_url'] || ENV.fetch('result_url', nil)
-      @queue_timeout_url = hash['queue_timeout_url'] || ENV.fetch('queue_timeout_url', nil)
-    end
-
     def query_balance
-      response = HTTParty.post(url, headers: headers, body: body)
-
-      raise StandardError, "Failed to query account balance: #{response.code} - #{response.body}" unless response.success?
-
-      JSON.parse(response.body)
-    end
-
-    private
-
-    def url
-      "#{ENV.fetch('base_url', nil)}#{ENV.fetch('account_balance_url', nil)}"
-    end
-
-    def headers
-      {
-        'Authorization' => "Bearer #{token}",
-        'Content-Type' => 'application/json'
-      }
-    end
-
-    def body
-      {
-        Initiator: get_initiator,
-        SecurityCredential: get_security_credential,
-        CommandID: 'AccountBalance',
-        PartyA: get_party_a,
-        IdentifierType: identifier_type,
-        ResultURL: get_result_url,
-        QueueTimeOutURL: get_queue_timeout_url
-      }.to_json
-    end
-
-    def get_initiator
-      if initiator.nil? || initiator.eql?('')
-        raise ArgumentError, 'Initiator is not defined' if ENV['initiator'].nil? || ENV['initiator'].eql?('')
-
-        ENV.fetch('initiator', nil)
-
-      else
-        initiator
-      end
-    end
-
-    def get_security_credential
-      if security_credential.nil? || security_credential.eql?('')
-        if ENV['security_credential'].nil? || ENV['security_credential'].eql?('')
-          raise ArgumentError, 'Security Credential is not defined'
-        end
-
-        ENV.fetch('security_credential', nil)
-
-      else
-        security_credential
-      end
-    end
-
-    def get_party_a
-      if party_a.nil? || party_a.eql?('')
-        if ENV['business_short_code'].nil? || ENV['business_short_code'].eql?('')
-          raise ArgumentError, 'PartyA (Business Short Code) is not defined'
-        end
-
-        ENV.fetch('business_short_code', nil)
-
-      else
-        party_a
-      end
-    end
-
-    def get_result_url
-      if result_url.nil? || result_url.eql?('')
-        raise ArgumentError, 'Result URL is not defined' if ENV['result_url'].nil? || ENV['result_url'].eql?('')
-
-        ENV.fetch('result_url', nil)
-
-      else
-        result_url
-      end
-    end
-
-    def get_queue_timeout_url
-      if queue_timeout_url.nil? || queue_timeout_url.eql?('')
-        if ENV['queue_timeout_url'].nil? || ENV['queue_timeout_url'].eql?('')
-          raise ArgumentError, 'Queue Timeout URL is not defined'
-        end
-
-        ENV.fetch('queue_timeout_url', nil)
-
-      else
-        queue_timeout_url
-      end
+      post(
+        'account_balance_url',
+        {
+          Initiator: option('initiator'),
+          SecurityCredential: option('security_credential'),
+          CommandID: 'AccountBalance',
+          PartyA: option('business_short_code', :party_a),
+          IdentifierType: @options.fetch(:identifier_type, '4'),
+          ResultURL: option('result_url'),
+          QueueTimeOutURL: option('queue_timeout_url')
+        },
+        error_message: 'Failed to query account balance'
+      )
     end
   end
 end

data/lib/mpesa_stk/b2b.rb

@@ -1,153 +1,44 @@
 # frozen_string_literal: true
 
-# Copyright (c) 2018 mboya
-#
-# MIT License
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
-
-require 'mpesa_stk/access_token'
+require 'mpesa_stk/client'
 
 module MpesaStk
-  # Business to Business payment API - send money between businesses
-  class B2B
+  # Business-to-business payments via Daraja B2B API.
+  class B2B < Client
     class << self
-      def pay(amount, receiver_party, hash = {})
-        new(amount, receiver_party, hash).send_payment
+      def call(amount, receiver_party, **options)
+        new(amount, receiver_party, **options).send_payment
       end
     end
 
-    attr_reader :token, :amount, :receiver_party, :initiator, :security_credential, :command_id,
-                :sender_identifier_type, :receiver_identifier_type, :party_a, :account_reference,
-                :result_url, :queue_timeout_url
+    attr_reader :amount, :receiver_party
 
-    def initialize(amount, receiver_party, hash = {})
-      @token = MpesaStk::AccessToken.call(hash['key'], hash['secret'])
+    def initialize(amount, receiver_party, **options)
+      super(**options)
       @amount = amount
       @receiver_party = receiver_party
-      @initiator = hash['initiator'] || ENV.fetch('initiator', nil)
-      @security_credential = hash['security_credential'] || ENV.fetch('security_credential', nil)
-      @command_id = hash['command_id'] || 'BusinessPayBill'
-      @sender_identifier_type = hash['sender_identifier_type'] || '4'
-      @receiver_identifier_type = hash['receiver_identifier_type'] || '4'
-      @party_a = hash['party_a'] || ENV.fetch('business_short_code', nil)
-      @account_reference = hash['account_reference'] || ''
-      @result_url = hash['result_url'] || ENV.fetch('result_url', nil)
-      @queue_timeout_url = hash['queue_timeout_url'] || ENV.fetch('queue_timeout_url', nil)
     end
 
     def send_payment
-      response = HTTParty.post(url, headers: headers, body: body)
-
-      raise StandardError, "Failed to send B2B payment: #{response.code} - #{response.body}" unless response.success?
-
-      JSON.parse(response.body)
+      post('b2b_url', b2b_payload, error_message: 'Failed to send B2B payment')
     end
 
     private
 
-    def url
-      "#{ENV.fetch('base_url', nil)}#{ENV.fetch('b2b_url', nil)}"
-    end
-
-    def headers
-      {
-        'Authorization' => "Bearer #{token}",
-        'Content-Type' => 'application/json'
-      }
-    end
-
-    def body
+    def b2b_payload
       {
-        Initiator: get_initiator,
-        SecurityCredential: get_security_credential,
-        CommandID: command_id,
-        SenderIdentifierType: sender_identifier_type,
-        RecieverIdentifierType: receiver_identifier_type,
+        Initiator: option('initiator'),
+        SecurityCredential: option('security_credential'),
+        CommandID: @options.fetch(:command_id, 'BusinessPayBill'),
+        SenderIdentifierType: @options.fetch(:sender_identifier_type, '4'),
+        RecieverIdentifierType: @options.fetch(:receiver_identifier_type, '4'),
         Amount: amount.to_s,
-        PartyA: get_party_a,
+        PartyA: option('business_short_code', :party_a),
         PartyB: receiver_party,
-        AccountReference: account_reference,
-        QueueTimeOutURL: get_queue_timeout_url,
-        ResultURL: get_result_url
-      }.to_json
-    end
-
-    def get_initiator
-      if initiator.nil? || initiator.eql?('')
-        raise ArgumentError, 'Initiator is not defined' if ENV['initiator'].nil? || ENV['initiator'].eql?('')
-
-        ENV.fetch('initiator', nil)
-
-      else
-        initiator
-      end
-    end
-
-    def get_security_credential
-      if security_credential.nil? || security_credential.eql?('')
-        if ENV['security_credential'].nil? || ENV['security_credential'].eql?('')
-          raise ArgumentError, 'Security Credential is not defined'
-        end
-
-        ENV.fetch('security_credential', nil)
-
-      else
-        security_credential
-      end
-    end
-
-    def get_party_a
-      if party_a.nil? || party_a.eql?('')
-        if ENV['business_short_code'].nil? || ENV['business_short_code'].eql?('')
-          raise ArgumentError, 'PartyA (Business Short Code) is not defined'
-        end
-
-        ENV.fetch('business_short_code', nil)
-
-      else
-        party_a
-      end
-    end
-
-    def get_result_url
-      if result_url.nil? || result_url.eql?('')
-        raise ArgumentError, 'Result URL is not defined' if ENV['result_url'].nil? || ENV['result_url'].eql?('')
-
-        ENV.fetch('result_url', nil)
-
-      else
-        result_url
-      end
-    end
-
-    def get_queue_timeout_url
-      if queue_timeout_url.nil? || queue_timeout_url.eql?('')
-        if ENV['queue_timeout_url'].nil? || ENV['queue_timeout_url'].eql?('')
-          raise ArgumentError, 'Queue Timeout URL is not defined'
-        end
-
-        ENV.fetch('queue_timeout_url', nil)
-
-      else
-        queue_timeout_url
-      end
+        AccountReference: @options.fetch(:account_reference, ''),
+        QueueTimeOutURL: option('queue_timeout_url'),
+        ResultURL: option('result_url')
+      }
     end
   end
 end

data/lib/mpesa_stk/b2c.rb

@@ -1,151 +1,39 @@
 # frozen_string_literal: true
 
-# Copyright (c) 2018 mboya
-#
-# MIT License
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
-
-require 'mpesa_stk/access_token'
+require 'mpesa_stk/client'
 
 module MpesaStk
-  # Business to Customer payment API - send money from business to customers
-  class B2C
+  # Business-to-customer payments (salary, promotions, etc.).
+  class B2C < Client
     class << self
-      def pay(amount, phone_number, hash = {})
-        new(amount, phone_number, hash).send_payment
+      def call(amount, phone_number, **options)
+        new(amount, phone_number, **options).send_payment
       end
     end
 
-    attr_reader :token, :amount, :phone_number, :initiator_name, :security_credential, :command_id, :party_a, :remarks,
-                :result_url, :queue_timeout_url, :occasion
+    attr_reader :amount, :phone_number
 
-    def initialize(amount, phone_number, hash = {})
-      @token = MpesaStk::AccessToken.call(hash['key'], hash['secret'])
+    def initialize(amount, phone_number, **options)
+      super(**options)
       @amount = amount
       @phone_number = phone_number
-      @initiator_name = hash['initiator_name'] || ENV.fetch('initiator_name', nil)
-      @security_credential = hash['security_credential'] || ENV.fetch('security_credential', nil)
-      @command_id = hash['command_id'] || 'BusinessPayment'
-      @party_a = hash['party_a'] || ENV.fetch('business_short_code', nil)
-      @remarks = hash['remarks'] || 'Payment'
-      @result_url = hash['result_url'] || ENV.fetch('result_url', nil)
-      @queue_timeout_url = hash['queue_timeout_url'] || ENV.fetch('queue_timeout_url', nil)
-      @occasion = hash['occasion']
     end
 
     def send_payment
-      response = HTTParty.post(url, headers: headers, body: body)
-
-      raise StandardError, "Failed to send B2C payment: #{response.code} - #{response.body}" unless response.success?
-
-      JSON.parse(response.body)
-    end
-
-    private
-
-    def url
-      "#{ENV.fetch('base_url', nil)}#{ENV.fetch('b2c_url', nil)}"
-    end
-
-    def headers
-      {
-        'Authorization' => "Bearer #{token}",
-        'Content-Type' => 'application/json'
-      }
-    end
-
-    def body
-      body_hash = {
-        InitiatorName: get_initiator_name,
-        SecurityCredential: get_security_credential,
-        CommandID: command_id,
+      body = {
+        InitiatorName: option('initiator_name'),
+        SecurityCredential: option('security_credential'),
+        CommandID: @options.fetch(:command_id, 'BusinessPayment'),
         Amount: amount.to_s,
-        PartyA: get_party_a,
+        PartyA: option('business_short_code', :party_a),
         PartyB: phone_number,
-        Remarks: remarks,
-        QueueTimeOutURL: get_queue_timeout_url,
-        ResultURL: get_result_url
+        Remarks: @options.fetch(:remarks, 'Payment'),
+        QueueTimeOutURL: option('queue_timeout_url'),
+        ResultURL: option('result_url')
       }
-      body_hash[:Occasion] = occasion if occasion
-      body_hash.to_json
-    end
-
-    def get_initiator_name
-      if initiator_name.nil? || initiator_name.eql?('')
-        raise ArgumentError, 'Initiator Name is not defined' if ENV['initiator_name'].nil? || ENV['initiator_name'].eql?('')
-
-        ENV.fetch('initiator_name', nil)
-
-      else
-        initiator_name
-      end
-    end
-
-    def get_security_credential
-      if security_credential.nil? || security_credential.eql?('')
-        if ENV['security_credential'].nil? || ENV['security_credential'].eql?('')
-          raise ArgumentError, 'Security Credential is not defined'
-        end
+      body[:Occasion] = @options[:occasion] if @options[:occasion]
 
-        ENV.fetch('security_credential', nil)
-
-      else
-        security_credential
-      end
-    end
-
-    def get_party_a
-      if party_a.nil? || party_a.eql?('')
-        if ENV['business_short_code'].nil? || ENV['business_short_code'].eql?('')
-          raise ArgumentError, 'PartyA (Business Short Code) is not defined'
-        end
-
-        ENV.fetch('business_short_code', nil)
-
-      else
-        party_a
-      end
-    end
-
-    def get_result_url
-      if result_url.nil? || result_url.eql?('')
-        raise ArgumentError, 'Result URL is not defined' if ENV['result_url'].nil? || ENV['result_url'].eql?('')
-
-        ENV.fetch('result_url', nil)
-
-      else
-        result_url
-      end
-    end
-
-    def get_queue_timeout_url
-      if queue_timeout_url.nil? || queue_timeout_url.eql?('')
-        if ENV['queue_timeout_url'].nil? || ENV['queue_timeout_url'].eql?('')
-          raise ArgumentError, 'Queue Timeout URL is not defined'
-        end
-
-        ENV.fetch('queue_timeout_url', nil)
-
-      else
-        queue_timeout_url
-      end
+      post('b2c_url', body, error_message: 'Failed to send B2C payment')
     end
   end
 end