pesapal 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2b77c7352914478f5db52c64dd9e5611cd9c8652
-  data.tar.gz: 382a808b6a1d6464587477cd0ab30aa4c6e53b5b
+  metadata.gz: 0f47532ca078e1d0e6b8c6fb305548d86266ce79
+  data.tar.gz: 53f602f715e320d6a71bdad0bca49d1fd68a1f75
 SHA512:
-  metadata.gz: 74576337022966c7ae613394507be8f2a4d1611fee53067430b80ae7d2376a8c34acb21cf933ab6c9f8697c119892c3608b17e9fd4604c59977fea2c6dd4e646
-  data.tar.gz: 35fe01d3f3a0dbe097474e85710e65862f14a041ea5726df5c21ff2f1c13e94796b7ea07036acca4b800f672f034f4572481126939cdd0ea1bc8c680c6c7ea5f
+  metadata.gz: ab791fe5a5e3f889cbb2f40ff13aca5dc707bde0b9eb0e1db82a85d5dff0d103027a95de8d144c37081760382f41abd77649eb057a6cd46333a10e0b308e7aef
+  data.tar.gz: 32183c04ac5bfd5faa4dd85e607d19105d7fbffb1ff897ed23b8434af64f780ae5afb1dec5fb8f95b50b8b328ac880b101677a850ce6a0e68898169363bb4fce

data/README.md

@@ -35,7 +35,8 @@ Or install it yourself as:
 
     $ gem install pesapal
 
-For Rails, you need to run the generator to set up some necessary stuff:
+For Rails, you need to run the generator to set up some necessary stuff (create
+initializer and config.yml file):
 
     rails generate pesapal:install
 
@@ -91,7 +92,7 @@ override, there's the assumption that you chose the right one).
 
 ```ruby
 # set pesapal api configuration manually (override YAML & bogus credentials)
-pesapal.config = {  :callback_url => 'http://0.0.0.0:3000/pesapal/callback'
+pesapal.config = {  :callback_url => 'http://0.0.0.0:3000/pesapal/callback',
                     :consumer_key => '<YOUR_CONSUMER_KEY>',
                     :consumer_secret => '<YOUR_CONSUMER_SECRET>'
                   }
@@ -196,14 +197,40 @@ The result is a hash that looks something like this ...
 
 ```
 { 
-  :method=>"MPESA",
-  :status=>"COMPLETED",
-  :merchant_reference=>"<MERCHANT_REFERENCE>",
-  :transaction_tracking_id=>"<TRANSACTION_ID>"
+  :method => "<PAYMENT_METHOD>",
+  :status => "<PAYMENT_STATUS>",
+  :merchant_reference => "<MERCHANT_REFERENCE>",
+  :transaction_tracking_id => "<TRANSACTION_ID>"
 }
 ```
 
 
+### IPN Listening ###
+
+Use the `ipn_listener` method to listen to Pesapal IPN calls to easily create an
+appropriate response, example below.
+
+```ruby
+# pass in the notification type, merchant reference and transaction id
+response_to_ipn = pesapal.ipn_listener("<NOTIFICATION_TYPE>", "<MERCHANT_REFERENCE>","<TRANSACTION_ID>")
+```
+
+The variable, `response_to_ipn`, now holds a response as the one shown below.
+Using the status you can customise any actions (e.g. database inserts and
+updates) and finally, it's upto you to send the `:response` back to pesapal. The
+hard part is done for you.
+
+```
+{ 
+  :status => "<PAYMENT_STATUS>",
+  :response => "<IPN_RESPONSE>"
+}
+```
+
+_Ps: Refer to Pesapal official documentation to make sure you understand what
+data Pesapal sends to IPN and what result they expect back._
+
+
 Contributing
 ------------
 

data/lib/pesapal/merchant.rb

@@ -133,6 +133,24 @@ module Pesapal
                 set_endpoints
             end
 
+            # listen to ipn response
+            def ipn_listener(notification_type, merchant_reference, transaction_tracking_id)
+                
+                status = query_payment_status(merchant_reference, transaction_tracking_id)
+
+                output = { :status => status }
+
+                if status == "COMPLETED"
+                    output[:response] = "pesapal_notification_type=CHANGE&pesapal_transaction_tracking_id=#{transaction_tracking_id}&pesapal_merchant_reference=#{merchant_reference}"
+                elsif status == "FAILED"
+                    output[:response] = "pesapal_notification_type=CHANGE&pesapal_transaction_tracking_id=#{transaction_tracking_id}&pesapal_merchant_reference=#{merchant_reference}"
+                else
+                    output[:response] = ""
+                end
+
+                output
+            end
+
         private
 
             # set endpoints

data/lib/pesapal/version.rb

@@ -1,3 +1,3 @@
 module Pesapal
-    VERSION = "1.0.0"
+    VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pesapal
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Job King'ori Maina
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-13 00:00:00.000000000 Z
+date: 2013-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler