Improved STK push functionality.

Author: martinmogusu

django_daraja/mpesa/core.py

@@ -24,7 +24,7 @@ def __init__(self):
 	def access_token(self):
 		return mpesa_access_token()
 
-	def stk_push(self, phone_number, amount, account_reference, transaction_desc = 'Description'):
+	def stk_push(self, phone_number, amount, account_reference, transaction_desc, callback_url):
 		phone_number = format_phone_number(phone_number)
 		url = api_base_url() + 'mpesa/stkpush/v1/processrequest'
 		passkey = mpesa_config('MPESA_PASSKEY')
@@ -40,35 +40,32 @@ def stk_push(self, phone_number, amount, account_reference, transaction_desc = '
 		transaction_type = 'CustomerPayBillOnline'
 		party_a = phone_number
 		party_b = business_short_code
-		callback_url = 'https://darajambili.herokuapp.com/express-payment'
 
 		data = {
 			'BusinessShortCode': business_short_code,
-			  'Password': password,
-			  'Timestamp': timestamp,
-			  'TransactionType': transaction_type,
-			  'Amount': '1',
-			  'PartyA': party_a,
-			  'PartyB': party_b,
-			  'PhoneNumber': phone_number,
-			  'CallBackURL': callback_url,
-			  'AccountReference': account_reference,
-			  'TransactionDesc': transaction_desc
+			'Password': password,
+			'Timestamp': timestamp,
+			'TransactionType': transaction_type,
+			'Amount': '1',
+			'PartyA': party_a,
+			'PartyB': party_b,
+			'PhoneNumber': phone_number,
+			'CallBackURL': callback_url,
+			'AccountReference': account_reference,
+			'TransactionDesc': transaction_desc
 		}
 
 		headers = {
 			'Authorization': 'Bearer ' + mpesa_access_token(),
 			'Content-type': 'application/json'
 		}
 
-		print('Password: ', password)
-		print('Password: ', password)
-
 		try:
 			r = requests.post(url, json=data, headers=headers)
+			response = mpesa_response(r)
 			return r
 		except requests.exceptions.ConnectionError:
 			raise MpesaConnectionError('Connection failed')
-		except Exception:
-			return ex.message
+		except Exception as ex:
+			raise MpesaConnectionError(str(ex))
 

django_daraja/mpesa/utils.py

@@ -9,6 +9,27 @@
 from django.utils import timezone
 from decouple import config, UndefinedValueError
 import os
+from requests import Response
+
+class MpesaResponse(Response):
+	response_description = ''
+	error_code = None
+	error_message = ''
+
+def mpesa_response(r):
+	'''
+	Creates MpesaResponse object from requests.Response object
+	
+	Arguments:
+		r {requests.Response} -- The response to convert
+	'''
+
+	r.__class__ = MpesaResponse
+	json_response = r.json()
+	r.response_description = json_response.get('ResponseDescription', '')
+	r.error_code = json_response.get('errorCode')
+	r.error_message = json_response.get('errorMessage', '')
+	return r
 
 def mpesa_config(key):
 	'''
@@ -21,6 +42,7 @@ def mpesa_config(key):
 	try:
 		value = config(key)
 	except UndefinedValueError:
+		# Check key in settings file
 		raise MpesaConfigurationException('Mpesa environment not configured properly - ' + key + ' not found')
 
 	return value
@@ -48,7 +70,14 @@ def generate_access_token_request(consumer_key = None, consumer_secret = None):
 	url = api_base_url() + 'oauth/v1/generate?grant_type=client_credentials'
 	consumer_key = consumer_key if consumer_key is not None else mpesa_config('MPESA_CONSUMER_KEY') 
 	consumer_secret = consumer_secret if consumer_secret is not None else mpesa_config('MPESA_CONSUMER_SECRET')
-	r = requests.get(url, auth=(consumer_key, consumer_secret))
+
+	try:
+		r = requests.get(url, auth=(consumer_key, consumer_secret))
+	except requests.exceptions.ConnectionError:
+		raise MpesaConnectionError('Connection failed')
+	except Exception:
+		return ex.message
+	
 	return r
 
 def generate_access_token():
@@ -79,6 +108,7 @@ def mpesa_access_token():
 	else:
 		delta = timezone.now() - access_token.created_at
 		minutes = (delta.total_seconds()//60)%60
+		print('minutes: ', minutes)
 		if minutes > 50:
 			# Access token expired
 			access_token = generate_access_token()	

django_daraja/views.py

@@ -5,9 +5,8 @@
 from django.http import HttpResponse, JsonResponse
 from django.views.generic import View
 from django_daraja.mpesa.core import *
-
+from decouple import config
 from datetime import datetime
-
 cl = MpesaClient()
 
 def index(request):
@@ -19,8 +18,10 @@ def oauth_success(request):
 	return JsonResponse(r, safe=False)
 
 def stk_push_success(request):
-	phone_number = '0719748260'
+	phone_number = config('LNM_PHONE_NUMBER')
 	amount = '1'
 	account_reference = 'ABC001'
-	r = cl.stk_push(phone_number, amount, account_reference)
-	return JsonResponse(r.json())
+	transaction_desc = 'Description'
+	callback_url = 'https://darajambili.herokuapp.com/express-payment'
+	r = cl.stk_push(phone_number, amount, account_reference, transaction_desc, callback_url)
+	return JsonResponse(r.response_description, safe=False)

tests/test_oauth.py

@@ -36,4 +36,4 @@ def test_access_token_valid(self):
 		token = generate_access_token()
 		delta = timezone.now() - token.created_at
 		minutes = (delta.total_seconds()//60)%60
-		self.assertLessEqual(minutes, 50)
+		self.assertLessEqual(minutes, 30)

tests/test_stk_push.py

@@ -0,0 +1,39 @@
+# -*- coding: utf-8 -*-
+'''
+Test STK Push
+'''
+
+from django.test import TestCase
+from django_daraja.mpesa.core import MpesaClient
+from decouple import config
+
+class MpesaStkPushTestCase(TestCase):
+
+	cl = MpesaClient()
+
+	def test_stk_push_success(self):
+		'''
+		Test successful STK push
+		'''
+
+		phone_number = config('LNM_PHONE_NUMBER')
+		amount = 1
+		account_reference = 'reference'
+		transaction_desc = 'Description'
+		callback_url = 'https://darajambili.herokuapp.com/express-payment'
+		response = self.cl.stk_push(phone_number, amount, account_reference, transaction_desc, callback_url)
+		self.assertEqual(response.response_description, 'Success. Request accepted for processing')
+
+	def test_stk_push_invalid_phone_number(self):
+		'''
+		Test STK push with invalid phone number
+		'''
+
+		phone_number = '254733000'
+		amount = 1
+		account_reference = 'reference'
+		transaction_desc = 'Description'
+		callback_url = 'https://darajambili.herokuapp.com/express-payment'
+		response = self.cl.stk_push(phone_number, amount, account_reference, transaction_desc, callback_url)
+		self.assertEqual(response.status_code, 500)
+		

tox.ini

@@ -26,6 +26,7 @@ passenv =
 	MPESA_EXPRESS_SHORTCODE
 	MPESA_SHORTCODE_TYPE
 	MPESA_PASSKEY
+    LNM_PHONE_NUMBER
 
 commands =
     python {toxinidir}/setup.py test