mpesa_stk 1.3 → 2.0.0

data/lib/mpesa_stk/transaction_status.rb

@@ -0,0 +1,145 @@
+# 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'
+
+module MpesaStk
+  # Query the status of any M-Pesa transaction
+  class TransactionStatus
+    class << self
+      def query(transaction_id, hash = {})
+        new(transaction_id, hash).query_status
+      end
+    end
+
+    attr_reader :token, :transaction_id, :initiator, :security_credential, :party_a, :result_url, :queue_timeout_url,
+                :identifier_type
+
+    def initialize(transaction_id, hash = {})
+      @token = MpesaStk::AccessToken.call(hash['key'], hash['secret'])
+      @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
+    end
+  end
+end

data/lib/mpesa_stk/version.rb

@@ -1,3 +1,27 @@
+# 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 = "1.3"
+  VERSION = '2.0.0'
 end

data/lib/mpesa_stk.rb

@@ -1,5 +1,41 @@
-require "mpesa_stk/version"
+# 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/push'
+require 'mpesa_stk/transaction_status'
+require 'mpesa_stk/stk_push_query'
+require 'mpesa_stk/b2c'
+require 'mpesa_stk/b2b'
+require 'mpesa_stk/c2b'
+require 'mpesa_stk/account_balance'
+require 'mpesa_stk/reversal'
+require 'mpesa_stk/ratiba'
+require 'mpesa_stk/iot'
+require 'mpesa_stk/imsi'
+require 'mpesa_stk/pull_transactions'
 require 'dotenv/load'
 require 'httparty'
+require 'securerandom'

data/mpesa_stk.gemspec

@@ -1,36 +1,48 @@
+# frozen_string_literal: true
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "mpesa_stk/version"
+require 'mpesa_stk/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "mpesa_stk"
+  spec.name          = 'mpesa_stk'
   spec.version       = MpesaStk::VERSION
-  spec.authors       = ["mboya", "cess"]
-  spec.email         = ["mboyaberry@gmail.com", "cessmbuguar@gmail.com"]
+  spec.authors       = %w[mboya cess]
+  spec.email         = ['mboyaberry@gmail.com', 'cessmbuguar@gmail.com']
 
-  spec.summary       = %q{Lipa na M-Pesa Online Payment.}
-  spec.description   = %q{initiate a M-Pesa transaction on behalf of a customer using STK Push.}
-  spec.homepage      = "https://github.com/mboya/mpesa_stk"
-  spec.license       = "MIT"
+  spec.summary       = 'Lipa na M-Pesa Online Payment.'
+  spec.description   = 'initiate a M-Pesa transaction on behalf of a customer using STK Push.'
+  spec.homepage      = 'https://github.com/mboya/mpesa_stk'
+  spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.required_ruby_version = '>= 2.6.0'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency 'httparty', '>= 0.15.6', '< 0.19.0'
-  spec.add_dependency 'redis-rack', '~> 2.0', '>= 2.0.2'
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = "#{spec.homepage}.git"
+  spec.metadata['changelog_uri'] = "#{spec.homepage}/blob/master/CHANGELOG.md"
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  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 'redis', '>= 4.0'
   spec.add_dependency 'redis-namespace', '~> 1.5', '>= 1.5.3'
+  spec.add_dependency 'redis-rack', '~> 2.0', '>= 2.0.2'
 
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake", ">= 12.3.3"
-  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'minitest', '~> 5.20'
+  spec.add_development_dependency 'rake', '>= 12.3.3'
 
-  spec.add_development_dependency 'pry', '~> 0.10.4'
-  spec.add_development_dependency 'pry-nav', '~> 0.2.4'
-  spec.add_development_dependency 'webmock', '~> 3.0', '>= 3.0.1'
-  spec.add_development_dependency "dotenv", "2.7.5"
+  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 'rubocop', '~> 1.0'
+  spec.add_development_dependency 'webmock', '~> 3.18'
 end

metadata

@@ -1,16 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: mpesa_stk
 version: !ruby/object:Gem::Version
-  version: '1.3'
+  version: 2.0.0
 platform: ruby
 authors:
 - mboya
 - cess
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-06-17 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
@@ -20,7 +47,7 @@ dependencies:
         version: 0.15.6
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.19.0
+        version: 0.22.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -30,27 +57,21 @@ dependencies:
         version: 0.15.6
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.19.0
+        version: 0.22.0
 - !ruby/object:Gem::Dependency
-  name: redis-rack
+  name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: redis-namespace
   requirement: !ruby/object:Gem::Requirement
@@ -72,19 +93,53 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.5.3
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: redis-rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: 2.0.2
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.20'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -100,81 +155,75 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 12.3.3
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: dotenv
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '2.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '2.8'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.4
+        version: '0.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.4
+        version: '0.12'
 - !ruby/object:Gem::Dependency
   name: pry-nav
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.4
+        version: '0.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.4
+        version: '0.3'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.0.1
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.0.1
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: dotenv
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.7.5
+        version: '3.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.7.5
+        version: '3.18'
 description: initiate a M-Pesa transaction on behalf of a customer using STK Push.
 email:
 - mboyaberry@gmail.com
@@ -183,29 +232,47 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/codeql-analysis.yml"
 - ".github/workflows/cop.yml"
 - ".gitignore"
+- ".rubocop.yml"
 - ".sample.env"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
+- SECURITY.md
 - bin/console
 - bin/index.jpeg
 - bin/setup
 - lib/mpesa_stk.rb
 - lib/mpesa_stk/access_token.rb
+- lib/mpesa_stk/account_balance.rb
+- lib/mpesa_stk/b2b.rb
+- lib/mpesa_stk/b2c.rb
+- lib/mpesa_stk/c2b.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
+- lib/mpesa_stk/transaction_status.rb
 - lib/mpesa_stk/version.rb
 - mpesa_stk.gemspec
 homepage: https://github.com/mboya/mpesa_stk
 licenses:
 - MIT
-metadata: {}
-post_install_message:
+metadata:
+  homepage_uri: https://github.com/mboya/mpesa_stk
+  source_code_uri: https://github.com/mboya/mpesa_stk.git
+  changelog_uri: https://github.com/mboya/mpesa_stk/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -213,15 +280,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
-signing_key:
+rubygems_version: 4.0.1
 specification_version: 4
 summary: Lipa na M-Pesa Online Payment.
 test_files: []