mpesa_stk 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 98e4c3a1cb59910334ad8f893a329fc65409a371
-  data.tar.gz: 72fb8592512e4b94bbb9b66210ae03498d39bd5d
+SHA256:
+  metadata.gz: a1448032d6f42e8d0ae52779d2aa3e564fc2fc7c3f612f5d1a7ab38dc6c63172
+  data.tar.gz: a1a7f8569dab22b228de03928b48e02b1994ddfa6f8dd7f9ebbf0519d05c86c1
 SHA512:
-  metadata.gz: 81237f220cacb76cd23d80209467b687f25ca21bf88090d2ff46e41fadd2ba3601caba8065c3ed7a33eb8e5ef3adbd0c42b91a106af719292e56881edf532b60
-  data.tar.gz: f55930075c931fc4cf98a1d999394ff2f59cef8bc31b0f4a8e68a87ed4fbbefef92408d4b758dac04d45013ecb24daf75f29739a95e85489abf18b606fa348ab
+  metadata.gz: 3f0d19bd38006f073b5be5e78ed49bc3fbf4a40fcee04eaa0b34f0fa2c63a604799a298a11cb52ba11d55ba8a9de0ccf4193d0f5b72aefc89be7a4b067143f21
+  data.tar.gz: e01e9e3964f4828f91acca1cb671c8278b1b0ad3ff0294e6d950b27a2a6d9b014be7e46051cd6a3c93bdfbe36be5b00dc3767c3d7afaba0e921527863cdafef5

data/.sample.env

@@ -2,8 +2,8 @@ base_url="https://sandbox.safaricom.co.ke"
 token_generator_url="/oauth/v1/generate?grant_type=client_credentials"
 process_request_url="/mpesa/stkpush/v1/processrequest"
 
-key=""
-secret=""
-business_short_code=""
-business_passkey="
-callback_url="
+key="Abcr7aDsOzaPlf5Cd6FWBJqxh6zRJ2dy"
+secret="9UVzOHhDq44nkZWP"
+business_short_code="174379"
+business_passkey="bfb279f9aa9bdbcf158e97dd71a467cd2e0c893059b10f78e6b72ada1ed2c919"
+callback_url="https://c90593e0.ngrok.io"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mpesa_stk (1.0.0)
+    mpesa_stk (1.1.0)
       httparty (~> 0.15.6)
       redis-namespace (~> 1.5, >= 1.5.3)
       redis-rack (~> 2.0, >= 2.0.2)
@@ -28,7 +28,7 @@ GEM
     pry-nav (0.2.4)
       pry (>= 0.9.10, < 0.11.0)
     public_suffix (3.0.2)
-    rack (2.0.4)
+    rack (2.0.5)
     rake (10.5.0)
     redis (4.0.1)
     redis-namespace (1.6.0)
@@ -36,7 +36,7 @@ GEM
     redis-rack (2.0.4)
       rack (>= 1.5, < 3)
       redis-store (>= 1.2, < 2)
-    redis-store (1.4.1)
+    redis-store (1.5.0)
       redis (>= 2.2, < 5)
     safe_yaml (1.0.4)
     slop (3.6.0)

data/README.md

@@ -8,54 +8,73 @@ Add this line to your application's Gemfile:
 ```ruby
 gem 'mpesa_stk'
 ```
-
-And then execute:
-
-    $ bundle or $ bundle install
+and run the `bundle install` command
 
 Or install it yourself as:
+```ruby
+gem install mpesa_stk
+```
 
-    $ gem install mpesa_stk
-
-## Version
- Mpesa_stk is currently at `1.0.0 version`
-
-## Usage
-
-one needs to setup there environment variables, checkout `.sample.env`
+# Getting Started
+This gem has a `[redis](https://redis.io/)` dependency, so make sure it running
+```ruby
+$ redis-server
 ```
-base_url="https://sandbox.safaricom.co.ke"
-token_generator_url="/oauth/v1/generate?grant_type=client_credentials"
-process_request_url="/mpesa/stkpush/v1/processrequest"
 
+you need to setup your environment variables, checkout `.sample.env` for the values you need.
+or run
+```ruby
+$ cp .sample.env .env
+```
+open `.env` on youe editor and add the missing variable
+```
 key=""
 secret=""
 business_short_code=""
-business_passkey="
-callback_url="
+business_passkey=""
+callback_url=""
 ```
+
+* `key` and `secret` of the app created on your [developer account](https://developer.safaricom.co.ke/user/me/apps).
 this can be found in [Test Credentials](https://developer.safaricom.co.ke/test_credentials)
-* `key` and `secret` of your application key.
 * `business_short_code`  and `business_pass_key` from safaricom.
-* `callback_url` the url of your application.
-
+this is the url where response will be sent
+* `callback_url` the url of your application. `make sure its a reachable/active url`
 
-### Implementation
+## Testing
 
-This now becomes the easy part. After all the pieces above have been set all you need to do is:
-open your console and add.
+```ruby
+$ irb
 ```
-require 'mpesa_stk'
+
+```ruby
+2.5.0 :001 > require 'mpesa_stk'
 ```
 
+```ruby
+2.5.0 :002 > MpesaStk::PushPayment.call("500", "<YOUR PHONE NUMBER: 254711222333>")
 ```
-MpesaStk::PushPayment.call("500", "<YOUR PHONE NUMBER: 254711222333>")
+
+expected irb output after the command
+```hash
+=> {
+    "MerchantRequestID"=>"7909-1302368-1", 
+    "CheckoutRequestID"=>"ws_CO_DMZ_40472724_16062018092359957", 
+    "ResponseCode"=>"0", 
+    "ResponseDescription"=>"Success. Request accepted for processing", 
+    "CustomerMessage"=>"Success. Request accepted for processing"
+  }
 ```
 
-### Output
-This is the expected output
- ![alt tag](./bin/index.jpeg)
+the above response means the response has been successfully sent to Safaricom for processing and you should be able to see the checkout/express prompt on the sender number.
+
+### 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
 
 
 ## Development

data/lib/mpesa_stk/push_payment.rb

@@ -44,8 +44,8 @@ module MpesaStk
           PartyB: "#{ENV['business_short_code']}",
           PhoneNumber: "#{phone_number}",
           CallBackURL: "#{ENV['callback_url']}",
-          AccountReference: generate_bill_reference_number(20),
-          TransactionDesc: generate_bill_reference_number(20)
+          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.0.2"
+  VERSION = "1.1.0"
 end

data/mpesa_stk.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
 
   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.homepage      = "https://mboya.github.io/mpesa_stk/"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mpesa_stk
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - mboya
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-15 00:00:00.000000000 Z
+date: 2018-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -194,7 +194,7 @@ files:
 - lib/mpesa_stk/push_payment.rb
 - lib/mpesa_stk/version.rb
 - mpesa_stk.gemspec
-homepage: https://github.com/mboya/mpesa_stk
+homepage: https://mboya.github.io/mpesa_stk/
 licenses:
 - MIT
 metadata: {}
@@ -214,7 +214,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Lipa na M-Pesa Online Payment.