django-pesapal 0.2

=============================
django-pesapal
=============================

.. image:: https://badge.fury.io/py/django-pesapal.png
:target: https://badge.fury.io/py/django-pesapal

.. image:: https://travis-ci.org/odero/django-pesapal.png?branch=master
:target: https://travis-ci.org/odero/django-pesapal

.. image:: https://coveralls.io/repos/odero/django-pesapal/badge.png?branch=master
:target: https://coveralls.io/r/odero/django-pesapal?branch=master

.. image:: https://pypip.in/status/django-pesapal/badge.svg
:target: https://pypi.python.org/pypi/django-pesapal/
:alt: Development Status

A django port of pesapal payment gateway

Documentation
-------------

The full documentation is at https://django-pesapal.readthedocs.org.

Quickstart
----------

Install django-pesapal::

pip install django-pesapal

Then use it in a project::

import django_pesapal


#. Add `django_pesapal` to your `INSTALLED_APPS` setting like this::

INSTALLED_APPS = (
...
'django_pesapal',
)

#. Include the `django_pesapal` URLconf in your project urls.py like this::

url(r'^payments/', include('django_pesapal.urls')),

This is optional. You can set your own return url by adding this to `settings.py`::

PESAPAL_OAUTH_CALLBACK_URL = 'app_name:url_name' # this needs to be a reversible

The url has the 'merchant_reference' GET parameter which can be extracted for further processing, or ignored.

for example it can be extracted using

self.merchant_reference = request.GET.get('merchant_reference', '')

in the destination view set as the PESAPAL_OAUTH_CALLBACK_URL.

#. Run `python manage.py syncdb` to create the models.

#. Create a method that receives payment details and returns the pesapal iframe url::

from django_pesapal.app import get_payment_url

def get_pesapal_payment_iframe():
'''
Authenticates with pesapal to get the payment iframe src
'''

order_info = {
'amount': 100,
'description': 'Payment for X',
'reference': 2, # some object id
'email': 'user@example.com'
}

iframe_src_url = get_payment_url(**order_info)
return iframe_src_url


**NB:** `get_payment_url` is defined as::

def get_payment_url(**kwargs):
'''
Use the computed order information to generate a url for the Pesapal iframe.

Params should include the following keys:
Required params: `amount`, `description`, `reference`, `email`
Optional params: `first_name`, `last_name`
'''

#. `get_payment_status` is used get the payment status and is defined as::

def get_payment_status(**kwargs):

'''
Query the payment status from pesapal using the transaction id and the merchant reference id

Params should include the following keys:
Required params: `pesapal_merchant_reference`, `pesapal_transaction_tracking_id`
'''


# It returns a dictionary with the following keys

response_data['_raw_request'] # The params that the request were made with
response_data['_raw_response'] # Useful for debugging
response_data['_comm_success'] # A bool communication status
response_data['_payment_status'] # The payment status
response_data['_response_time'] # Time taken for the response

Configuration
=============

+---------------------------------------------+--------------------------------------------------------+
| Setting | Default Value |
+=============================================+========================================================+
| PESAPAL_DEMO | True |
+---------------------------------------------+--------------------------------------------------------+
| PESAPAL_CONSUMER_KEY | '' |
+---------------------------------------------+--------------------------------------------------------+
| PESAPAL_CONSUMER_SECRET | '' |
+---------------------------------------------+--------------------------------------------------------+
| PESAPAL_IFRAME_LINK (if PESAPAL_DEMO=True) | 'http://demo.pesapal.com/api/PostPesapalDirectOrderV4' |
+---------------------------------------------+--------------------------------------------------------+
| PESAPAL_IFRAME_LINK (if PESAPAL_DEMO=False) | 'https://www.pesapal.com/api/PostPesapalDirectOrderV4' |
+---------------------------------------------+--------------------------------------------------------+
| PESAPAL_QUERY_STATUS_LINK (Demo Mode=True) | 'http://demo.pesapal.com/API/QueryPaymentStatus' |
+---------------------------------------------+--------------------------------------------------------+
| PESAPAL_QUERY_STATUS_LINK (Demo Mode=False) | 'https://www.pesapal.com/API/QueryPaymentStatus' |
+---------------------------------------------+--------------------------------------------------------+
| PESAPAL_OAUTH_CALLBACK_URL | 'transaction_completed' |
+---------------------------------------------+--------------------------------------------------------+
| PESAPAL_OAUTH_SIGNATURE_METHOD | 'SignatureMethod_HMAC_SHA1' |
+---------------------------------------------+--------------------------------------------------------+
| PESAPAL_TRANSACTION_DEFAULT_REDIRECT_URL | '' |
+---------------------------------------------+--------------------------------------------------------+
| PESAPAL_TRANSACTION_FAILED_REDIRECT_URL | '' |
+---------------------------------------------+--------------------------------------------------------+
| PESAPAL_REDIRECT_WITH_REFERENCE | True |
+---------------------------------------------+--------------------------------------------------------+



History
-------
0.1.6 (2015-03-17)
++++++++++++++++++
- Support anonymous checkouts
- Add support for getting payment status
- Major structural refactoring. Use mixins
- Use Mixins and XML Builder

0.1.5 (2014-09-25)
++++++++++++++++++
- Pin dependencies to specific versions
- Update how imports should be done
- Remove imports from __init__.py

0.1.4 (2014-09-23)
++++++++++++++++++
- Fix import bug. Tests for projects using this fail in Shippable
- Set max Django version to 1.7

0.1.3 (2014-07-18)
++++++++++++++++++
- Packaging for PyPi

0.1.2 (2014-06-30)
++++++++++++++++++
- Fix import bug in urls.py
- Fix how callback url is constructed
- Fix: Live URL uses https

0.1.1 (2014-06-30)
++++++++++++++++++
- Refactor handling of redirect urls. Model validation of transaction and merchant reference
- Rename settings to conf. Set default oauth redirect url
- Add django-uuidfield to dependencies

0.1.0 (2014-06-30)
++++++++++++++++++

* First release on PyPI.