mpesa_stk 1.2.1.1 → 1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aac00cb985abf7274869098214e1736ba90c0b26803d4bb0a37537b740ae6b7b
-  data.tar.gz: 5969725cfc65d13c3a969773fd33da9d040b84a50a9e01aefc95a3be2a8ca71c
+  metadata.gz: 12e1c2a4f60b943357593f37099a3ef7e5a9f4c272a0aca0960452b504789fe0
+  data.tar.gz: 14c3633244b9867b275a1e10949f4b6880b62c04e42213c6b5b2f4ded24e4dc1
 SHA512:
-  metadata.gz: 34f7c15f99680ef3f3f916b06bb03a85e880b6fe598a6d0997816739f108ac6f5c32086cb7d60c53389a539a0811f1d1ee68b0a2c98e9baf47e035b17b52cf4d
-  data.tar.gz: 9ff781d747187f656c97cc33921a0fb55e31692e8fa264b0be9f99a22c5caaa162489d1bf67c9c61d5b28ce2b3efb1d69114911271f99a5ff15d380fc4a5981b
+  metadata.gz: 7fe982c6d29a14a7ab22e2acc16d97b9411666c47edf664c5f77a9e0b398d7b6cf3c031bdd9c9e55003f4fb31a21ecaef65e5eeadb4f7893721c3c466ba06e57
+  data.tar.gz: c2dbf612bd39861047a24cf0497a01893ec6b0018ec20ee6f33cc8a36d0964e87172566f0090bcf4e29f076d099192dab6b0e859951029db8d32b38feb04171a

data/.sample.env

@@ -6,4 +6,5 @@ key=""
 secret=""
 business_short_code=""
 business_passkey=""
-callback_url=""
+callback_url="https://api.endpoint/callback"
+till_number=""

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    mpesa_stk (1.2.1)
-      httparty (~> 0.15.6)
+    mpesa_stk (1.3)
+      httparty (>= 0.15.6, < 0.19.0)
       redis-namespace (~> 1.5, >= 1.5.3)
       redis-rack (~> 2.0, >= 2.0.2)
 
@@ -14,11 +14,15 @@ GEM
     coderay (1.1.2)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
-    dotenv (2.2.1)
+    dotenv (2.7.5)
     hashdiff (1.0.1)
-    httparty (0.15.7)
+    httparty (0.18.1)
+      mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
     method_source (0.8.2)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2020.0512)
     minitest (5.14.0)
     multi_xml (0.6.0)
     pry (0.10.4)
@@ -29,8 +33,8 @@ GEM
       pry (>= 0.9.10, < 0.11.0)
     public_suffix (4.0.4)
     rack (2.2.2)
-    rake (12.3.3)
-    redis (4.1.3)
+    rake (13.0.1)
+    redis (4.2.1)
     redis-namespace (1.7.0)
       redis (>= 3.0.4)
     redis-rack (2.1.2)
@@ -50,7 +54,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler
-  dotenv (= 2.2.1)
+  dotenv (= 2.7.5)
   minitest (~> 5.0)
   mpesa_stk!
   pry (~> 0.10.4)

data/README.md

@@ -1,7 +1,8 @@
 # MpesaStk
 Lipa na M-Pesa Online Payment API is used to initiate a M-Pesa transaction on behalf of a customer using STK Push. This is the same technique mySafaricom App uses whenever the app is used to make payments.
 
-<!-- [![Gem Version](https://badge.fury.io/rb/mpesa_stk.svg)](https://badge.fury.io/rb/mpesa_stk.svg) -->
+[![Gem Version](https://badge.fury.io/rb/mpesa_stk.svg)](https://badge.fury.io/rb/mpesa_stk.svg)
+![Cop](https://github.com/mboya/mpesa_stk/workflows/Cop/badge.svg?branch=master)
 
 ## Installation
 
@@ -22,6 +23,14 @@ This gem has a [Redis](https://redis.io/) dependency, so make sure it running
 ```ruby
 $ redis-server
 ```
+You can use command line to determine if redis is running:
+```ruby
+redis-cli ping
+```
+you should get back
+```ruby
+PONG
+```
 
 you need to setup your environment variables, checkout `.sample.env` for the values you need.
 or run
@@ -35,12 +44,19 @@ secret=""
 business_short_code=""
 business_passkey=""
 callback_url=""
+till_number=""
 ```
 
 * `key` and `secret` of the app created on your [developer account](https://developer.safaricom.co.ke/user/me/apps).
 * `business_short_code`  and `business_pass_key` this can be found in [Test Credentials](https://developer.safaricom.co.ke/test_credentials).
 * `callback_url` the url of your application where response will be sent. `make sure its a reachable/active url`
 
+`Prod:`
+
+when going live there information will be sent to your email.
+
+for `buy_goods` push  `business_short_code` will be equivalent to `store number` and `till_number` will remain as is.
+
 ### Testing out the gem in an actual Rails application
 
 To test out the app on an actual rails application, do check out the following link:
@@ -53,18 +69,39 @@ https://github.com/mboya/stk
 #### Sample application
 Check out a rails sample application [here](https://github.com/mboya/stk)
 
-### Testing the gem on the console
+### Testing the gem on the console/app
+When running the gem on a single safaricom app.
 
 ```ruby
 $ irb
+2.5.0 :001 > require 'mpesa_stk'
+2.5.0 :002 > MpesaStk::PushPayment.call("500", "<YOUR PHONE NUMBER: 254711222333>")
 ```
 
+When running the app on multiple safaricom apps, within the same project.
 ```ruby
-2.5.0 :001 > require 'mpesa_stk'
+$ irb
+2.5.3 :001 > require 'mpesa_stk'
+2.5.3 :002 > hash = Hash.new
+2.5.3 :003 > 
+2.5.3 :004 > hash['key'] = key
+2.5.3 :005 > hash['secret'] = secret
+2.5.3 :006 > hash['business_short_code'] = business_short_code
+2.5.3 :007 > hash['business_passkey'] = business_passkey
+2.5.3 :008 > hash['callback_url'] = callback_url
+2.5.3 :009 > hash['till_number'] = till_number 
 ```
-
+for STK push
 ```ruby
-2.5.0 :002 > MpesaStk::PushPayment.call("500", "<YOUR PHONE NUMBER: 254711222333>")
+2.5.3 :010 > MpesaStk::Push.pay_bill('05', "<YOUR PHONE NUMBER: 254711222333>", hash)
+```
+for Till Number push
+```ruby
+2.5.3 :010 > MpesaStk::Push.buy_goods('05', "<YOUR PHONE NUMBER: 254711222333>", hash)
+```
+possible error format if the request is not successful
+```hash
+{"requestId"=>"13022-8633727-1", "errorCode"=>"500.001.1001", "errorMessage"=>"Error Message"}
 ```
 
 expected irb output after the command
@@ -82,12 +119,21 @@ the above response means the response has been successfully sent to Safaricom fo
 
 ### Mpesa Checkout/Express
 This is the expected output on the mobile phone
+
 ![alt tag](./bin/index.jpeg)
 
 ### Callback url
 
 After the pin code is entered on the checkout/express prompt. you will receive a request on the provided  `callback_url` with the status of the action
 
+sample payload that you will be getting on your callback
+```hash
+{"Body"=>{"stkCallback"=>{"MerchantRequestID"=>"3968-94214-1", "CheckoutRequestID"=>"ws_CO_160620191218268004", "ResultCode"=>0, "ResultDesc"=>"The service request is processed successfully.", 
+"CallbackMetadata"=>{"Item"=>[{"Name"=>"Amount", "Value"=>"05"}, {"Name"=>"MpesaReceiptNumber", "Value"=>"OFG4Z5EE9Y"}, {"Name"=>"TransactionDate", "Value"=>20190616121848}, 
+{"Name"=>"PhoneNumber", "Value"=>254711222333}]}}}, "push"=>{"Body"=>{"stkCallback"=>{"MerchantRequestID"=>"3968-94214-1", "CheckoutRequestID"=>"ws_CO_160620191218268004", "ResultCode"=>0, 
+"ResultDesc"=>"The service request is processed successfully.", "CallbackMetadata"=>{"Item"=>[{"Name"=>"Amount", "Value"=>"05"}, {"Name"=>"MpesaReceiptNumber", "Value"=>"OFG4Z5EE9Y"}, {"Name"=>"TransactionDate", 
+"Value"=>20190616121848}, {"Name"=>"PhoneNumber", "Value"=>254711222333}]}}}}}
+```
 
 ## Development
 

data/lib/mpesa_stk.rb

@@ -1,4 +1,5 @@
 require "mpesa_stk/version"
 require 'mpesa_stk/push_payment'
+require 'mpesa_stk/push'
 require 'dotenv/load'
 require 'httparty'

data/lib/mpesa_stk/access_token.rb

@@ -4,14 +4,14 @@ require 'redis'
 module MpesaStk
   class AccessToken
     class << self
-      def call
-        new.access_token
+      def call(key = nil, secret = nil)
+        new(key, secret).access_token
       end
     end
 
-    def initialize
-      @key = ENV['key']
-      @secret = ENV['secret']
+    def initialize(key = nil, secret = nil)
+      @key = key.nil? ? ENV['key'] : key
+      @secret = secret.nil? ? ENV['secret'] : secret
       @redis = Redis.new
 
       load_from_redis
@@ -73,14 +73,14 @@ module MpesaStk
 
     def headers
       encode = encode_credentials @key, @secret
-      headers = {
-          "Authorization" => "Basic #{encode}"
+      {
+        "Authorization" => "Basic #{encode}"
       }
     end
 
     def encode_credentials key, secret
       credentials = "#{key}:#{secret}"
-      encoded_credentials = Base64.encode64(credentials).split("\n").join
+      Base64.encode64(credentials).split("\n").join
     end
   end
 end

data/lib/mpesa_stk/push.rb

@@ -0,0 +1,131 @@
+require "mpesa_stk/access_token"
+
+module MpesaStk
+  class Push
+    class << self
+      def pay_bill(amount, phone_number, hash = {})
+        new(amount, phone_number, "CustomerPayBillOnline", nil, hash["business_short_code"], hash["callback_url"], hash["business_passkey"], hash["key"], hash["secret"]).push_payment
+      end
+
+      def buy_goods(amount, phone_number, hash = {})
+        new(amount, phone_number, "CustomerBuyGoodsOnline", hash["till_number"], hash["business_short_code"], hash["callback_url"], hash["business_passkey"], hash["key"], hash["secret"]).push_payment
+      end
+    end
+
+    attr_reader :token, :amount, :phone_number, :till_number, :business_short_code, :callback_url, :business_passkey, :transaction_type
+
+    def initialize(amount, phone_number, transaction_type, till_number = nil, business_short_code = nil, callback_url = nil, business_passkey = nil, key = nil, secret = nil)
+      @token = MpesaStk::AccessToken.call(key, secret)
+      @transaction_type = transaction_type
+      @till_number = till_number
+      @business_short_code = business_short_code
+      @callback_url = callback_url
+      @business_passkey = business_passkey
+      @amount = amount
+      @phone_number = phone_number
+    end
+
+    def push_payment
+      response = HTTParty.post(url, headers: headers, body: body)
+      JSON.parse(response.body)
+    end
+
+    private
+
+    def url
+      "#{ENV['base_url']}#{ENV['process_request_url']}"
+    end
+
+    def headers
+      {
+        "Authorization" => "Bearer #{token}",
+        "Content-Type" => "application/json"
+      }
+    end
+
+    def body
+      {
+        BusinessShortCode: get_business_short_code,
+        Password: generate_password,
+        Timestamp: "#{timestamp}",
+        TransactionType: transaction_type,
+        Amount: "#{amount}",
+        PartyA: "#{phone_number}",
+        PartyB: get_till_number,
+        PhoneNumber: "#{phone_number}",
+        CallBackURL: get_callback_url,
+        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 = "#{get_business_short_code}#{get_business_passkey}#{timestamp}"
+      Base64.encode64(key).split("\n").join
+    end
+
+    def get_business_short_code
+      if business_short_code.nil? || business_short_code.eql?("")
+        if ENV['business_short_code'].nil? || ENV['business_short_code'].eql?("")
+          raise Exception.new "Business Short Code is not defined"
+        else
+          ENV['business_short_code']
+        end
+      else
+        business_short_code
+      end
+    end
+
+    def get_business_passkey
+      if business_passkey.nil? || business_passkey.eql?("")
+        if ENV['business_passkey'].nil? || ENV['business_passkey'].eql?("")
+          raise Exception.new "Business Passkey is not defined"
+        else
+          ENV['business_passkey']
+        end
+      else
+        business_passkey
+      end
+    end
+
+    def get_callback_url
+      if callback_url.nil? || callback_url.eql?("")
+        if ENV['callback_url'].nil? || ENV['callback_url'].eql?("")
+          raise Exception.new "Callback URL is not defined"
+        else
+          ENV['callback_url']
+        end
+      else
+        callback_url
+      end
+    end
+
+    def get_till_number
+      if transaction_type.eql?("CustomerPayBillOnline")
+        get_business_short_code
+      else
+        if till_number.nil?
+          if ENV['till_number'].nil? || ENV['till_number'].eql?("")
+            raise Exception.new "Till number is not defined"
+          else
+            ENV['till_number']
+          end
+        else
+          till_number
+        end
+      end
+    end
+  end
+end

data/lib/mpesa_stk/push_payment.rb

@@ -10,7 +10,7 @@ module MpesaStk
 
     attr_reader :token, :amount, :phone_number
 
-    def initialize amount, phone_number
+    def initialize(amount, phone_number)
       @token = MpesaStk::AccessToken.call
       @amount = amount
       @phone_number = phone_number
@@ -28,25 +28,25 @@ module MpesaStk
     end
 
     def headers
-      headers = {
-          "Authorization" => "Bearer #{token}",
-          "Content-Type" => "application/json"
+      {
+        "Authorization" => "Bearer #{token}",
+        "Content-Type" => "application/json"
       }
     end
 
     def body
       {
-          BusinessShortCode: "#{ENV['business_short_code']}",
-          Password: generate_password,
-          Timestamp: "#{timestamp}",
-          TransactionType: "CustomerPayBillOnline",
-          Amount: "#{amount}",
-          PartyA: "#{phone_number}",
-          PartyB: "#{ENV['business_short_code']}",
-          PhoneNumber: "#{phone_number}",
-          CallBackURL: "#{ENV['callback_url']}",
-          AccountReference: generate_bill_reference_number(5),
-          TransactionDesc: generate_bill_reference_number(5)
+        BusinessShortCode: "#{ENV['business_short_code']}",
+        Password: generate_password,
+        Timestamp: "#{timestamp}",
+        TransactionType: "CustomerPayBillOnline",
+        Amount: "#{amount}",
+        PartyA: "#{phone_number}",
+        PartyB: "#{ENV['business_short_code']}",
+        PhoneNumber: "#{phone_number}",
+        CallBackURL: "#{ENV['callback_url']}",
+        AccountReference: generate_bill_reference_number(5),
+        TransactionDesc: generate_bill_reference_number(5)
       }.to_json
     end
 

data/lib/mpesa_stk/version.rb

@@ -1,3 +1,3 @@
 module MpesaStk
-  VERSION = "1.2.1.1"
+  VERSION = "1.3"
 end

data/mpesa_stk.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'httparty', '~> 0.15.6'
+  spec.add_dependency 'httparty', '>= 0.15.6', '< 0.19.0'
   spec.add_dependency 'redis-rack', '~> 2.0', '>= 2.0.2'
   spec.add_dependency 'redis-namespace', '~> 1.5', '>= 1.5.3'
 
@@ -32,5 +32,5 @@ Gem::Specification.new do |spec|
   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.2.1"
+  spec.add_development_dependency "dotenv", "2.7.5"
 end

metadata

@@ -1,30 +1,36 @@
 --- !ruby/object:Gem::Specification
 name: mpesa_stk
 version: !ruby/object:Gem::Version
-  version: 1.2.1.1
+  version: '1.3'
 platform: ruby
 authors:
 - mboya
 - cess
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-04-10 00:00:00.000000000 Z
+date: 2020-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.15.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.19.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.15.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.19.0
 - !ruby/object:Gem::Dependency
   name: redis-rack
   requirement: !ruby/object:Gem::Requirement
@@ -161,14 +167,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.2.1
+        version: 2.7.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.2.1
+        version: 2.7.5
 description: initiate a M-Pesa transaction on behalf of a customer using STK Push.
 email:
 - mboyaberry@gmail.com
@@ -191,6 +197,7 @@ files:
 - bin/setup
 - lib/mpesa_stk.rb
 - lib/mpesa_stk/access_token.rb
+- lib/mpesa_stk/push.rb
 - lib/mpesa_stk/push_payment.rb
 - lib/mpesa_stk/version.rb
 - mpesa_stk.gemspec
@@ -198,7 +205,7 @@ homepage: https://github.com/mboya/mpesa_stk
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -213,8 +220,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.0.8
+signing_key:
 specification_version: 4
 summary: Lipa na M-Pesa Online Payment.
 test_files: []