mpesa_stk 2.0.0 → 3.0.0

data/lib/mpesa_stk/transaction_status.rb

@@ -1,145 +1,38 @@
 # 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 the status of any M-Pesa transaction
-  class TransactionStatus
+  # Query the status of any M-Pesa transaction by ID.
+  class TransactionStatus < Client
     class << self
-      def query(transaction_id, hash = {})
-        new(transaction_id, hash).query_status
+      def call(transaction_id, **options)
+        new(transaction_id, **options).query_status
       end
     end
 
-    attr_reader :token, :transaction_id, :initiator, :security_credential, :party_a, :result_url, :queue_timeout_url,
-                :identifier_type
+    attr_reader :transaction_id
 
-    def initialize(transaction_id, hash = {})
-      @token = MpesaStk::AccessToken.call(hash['key'], hash['secret'])
+    def initialize(transaction_id, **options)
+      super(**options)
       @transaction_id = transaction_id
-      @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)
-      @result_url = hash['result_url'] || ENV.fetch('result_url', nil)
-      @queue_timeout_url = hash['queue_timeout_url'] || ENV.fetch('queue_timeout_url', nil)
-      @identifier_type = hash['identifier_type'] || '4'
     end
 
     def query_status
-      response = HTTParty.post(url, headers: headers, body: body)
-
-      raise StandardError, "Failed to query transaction status: #{response.code} - #{response.body}" unless response.success?
-
-      JSON.parse(response.body)
-    end
-
-    private
-
-    def url
-      "#{ENV.fetch('base_url', nil)}#{ENV.fetch('transaction_status_url', nil)}"
-    end
-
-    def headers
-      {
-        'Authorization' => "Bearer #{token}",
-        'Content-Type' => 'application/json'
-      }
-    end
-
-    def body
-      {
-        Initiator: get_initiator,
-        SecurityCredential: get_security_credential,
-        CommandID: 'TransactionStatusQuery',
-        TransactionID: transaction_id,
-        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(
+        'transaction_status_url',
+        {
+          Initiator: option('initiator'),
+          SecurityCredential: option('security_credential'),
+          CommandID: 'TransactionStatusQuery',
+          TransactionID: transaction_id,
+          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 transaction status'
+      )
     end
   end
 end

data/lib/mpesa_stk/version.rb

@@ -1,27 +1,5 @@
 # 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.
-
 module MpesaStk
-  VERSION = '2.0.0'
+  VERSION = '3.0.0'
 end

data/lib/mpesa_stk.rb

@@ -1,29 +1,9 @@
 # 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/version'
-require 'mpesa_stk/push_payment'
+require 'mpesa_stk/config'
+require 'mpesa_stk/client'
+require 'mpesa_stk/access_token'
 require 'mpesa_stk/push'
 require 'mpesa_stk/transaction_status'
 require 'mpesa_stk/stk_push_query'
@@ -36,6 +16,14 @@ require 'mpesa_stk/ratiba'
 require 'mpesa_stk/iot'
 require 'mpesa_stk/imsi'
 require 'mpesa_stk/pull_transactions'
-require 'dotenv/load'
+
+require 'dotenv/load' unless ENV['MPESA_STK_SKIP_DOTENV'] == 'true'
 require 'httparty'
 require 'securerandom'
+
+# Ruby client for Safaricom Daraja M-Pesa APIs (STK Push, B2C, B2B, C2B, and related services).
+module MpesaStk
+  def self.configure(&block)
+    Config.configure(&block)
+  end
+end

data/mpesa_stk.gemspec

@@ -31,7 +31,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'base64', '>= 0.1.0'
   spec.add_dependency 'csv', '>= 3.0.0'
-  spec.add_dependency 'httparty', '>= 0.15.6', '< 0.22.0'
+  spec.add_dependency 'httparty', '>= 0.15.6', '< 0.25.0'
   spec.add_dependency 'redis', '>= 4.0'
   spec.add_dependency 'redis-namespace', '~> 1.5', '>= 1.5.3'
   spec.add_dependency 'redis-rack', '~> 2.0', '>= 2.0.2'
@@ -40,9 +40,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'minitest', '~> 5.20'
   spec.add_development_dependency 'rake', '>= 12.3.3'
 
-  spec.add_development_dependency 'dotenv', '~> 2.8'
-  spec.add_development_dependency 'pry', '~> 0.12'
-  spec.add_development_dependency 'pry-nav', '~> 0.3'
+  spec.add_development_dependency 'dotenv', '~> 3.0'
+  spec.add_development_dependency 'pry', '~> 0.14'
+  spec.add_development_dependency 'pry-nav', '~> 1.0'
   spec.add_development_dependency 'rubocop', '~> 1.0'
+  spec.add_development_dependency 'simplecov', '~> 0.22'
   spec.add_development_dependency 'webmock', '~> 3.18'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mpesa_stk
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - mboya
@@ -47,7 +47,7 @@ dependencies:
         version: 0.15.6
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.22.0
+        version: 0.25.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -57,7 +57,7 @@ dependencies:
         version: 0.15.6
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.22.0
+        version: 0.25.0
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
@@ -160,42 +160,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0.14'
 - !ruby/object:Gem::Dependency
   name: pry-nav
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -210,6 +210,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -242,6 +256,7 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
+- MIGRATION.md
 - README.md
 - Rakefile
 - SECURITY.md
@@ -254,11 +269,12 @@ files:
 - lib/mpesa_stk/b2b.rb
 - lib/mpesa_stk/b2c.rb
 - lib/mpesa_stk/c2b.rb
+- lib/mpesa_stk/client.rb
+- lib/mpesa_stk/config.rb
 - lib/mpesa_stk/imsi.rb
 - lib/mpesa_stk/iot.rb
 - lib/mpesa_stk/pull_transactions.rb
 - lib/mpesa_stk/push.rb
-- lib/mpesa_stk/push_payment.rb
 - lib/mpesa_stk/ratiba.rb
 - lib/mpesa_stk/reversal.rb
 - lib/mpesa_stk/stk_push_query.rb
@@ -287,7 +303,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.1
+rubygems_version: 4.0.9
 specification_version: 4
 summary: Lipa na M-Pesa Online Payment.
 test_files: []

data/lib/mpesa_stk/push_payment.rb

@@ -1,99 +0,0 @@
-# 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 'date'
-require 'mpesa_stk/access_token'
-
-module MpesaStk
-  # Initiates STK Push payment for a single application using ENV variables
-  class PushPayment
-    class << self
-      def call(amount, phone_number)
-        new(amount, phone_number).push_payment
-      end
-    end
-
-    attr_reader :token, :amount, :phone_number
-
-    def initialize(amount, phone_number)
-      @token = MpesaStk::AccessToken.call
-      @amount = amount
-      @phone_number = phone_number
-    end
-
-    def push_payment
-      response = HTTParty.post(url, headers: headers, body: body)
-
-      raise StandardError, "Failed to push payment: #{response.code} - #{response.body}" unless response.success?
-
-      JSON.parse(response.body)
-    end
-
-    private
-
-    def url
-      "#{ENV.fetch('base_url', nil)}#{ENV.fetch('process_request_url', nil)}"
-    end
-
-    def headers
-      {
-        'Authorization' => "Bearer #{token}",
-        'Content-Type' => 'application/json'
-      }
-    end
-
-    def body
-      {
-        BusinessShortCode: ENV.fetch('business_short_code', nil).to_s,
-        Password: generate_password,
-        Timestamp: timestamp.to_s,
-        TransactionType: 'CustomerPayBillOnline',
-        Amount: amount.to_s,
-        PartyA: phone_number.to_s,
-        PartyB: ENV.fetch('business_short_code', nil).to_s,
-        PhoneNumber: phone_number.to_s,
-        CallBackURL: ENV.fetch('callback_url', nil).to_s,
-        AccountReference: generate_bill_reference_number(5),
-        TransactionDesc: generate_bill_reference_number(5)
-      }.to_json
-    end
-
-    def generate_bill_reference_number(number)
-      charset = Array('A'..'Z') + Array('a'..'z')
-      Array.new(number) { charset.sample }.join
-    end
-
-    def timestamp
-      DateTime.now.strftime('%Y%m%d%H%M%S').to_i
-    end
-
-    # shortcode
-    # passkey
-    # timestamp
-    def generate_password
-      key = "#{ENV.fetch('business_short_code', nil)}#{ENV.fetch('business_passkey', nil)}#{timestamp}"
-      Base64.encode64(key).split("\n").join
-    end
-  end
-end