Merge branch 'develop' into 'master'

Develop

See merge request Modules/fasterpay-python3!3

Author: prashantbd

CHANGES.txt

@@ -0,0 +1 @@
+1.0 - 19/09/2019 --- Initial Release

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 FasterPay
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

MANIFEST.in

@@ -0,0 +1,2 @@
+include *.txt
+recursive-include docs *.txt

README.md

@@ -0,0 +1,81 @@
+# Welcome to FasterPay Python SDK
+
+FasterPay Python SDK enables you to integrate the FasterPay's Checkout Page seamlessly without having the hassle of integrating everything from Scratch.
+Once your customer is ready to pay, FasterPay will take care of the payment, notify your system about the payment and return the customer back to your Thank You page.
+
+## Downloading the FasterPay Python SDK
+
+```sh
+$ git clone https://github.com/FasterPay/fasterpay-python3.git
+```
+
+## Installing the FasterPay Python SDK.
+```sh
+$ cd fasterpay-python3
+$ sudo python setup.py install
+```
+
+## Initiating Payment Request using Python SDK
+
+```python
+from fasterpay.gateway import Gateway
+
+if __name__ == "__main__":
+
+  gateway = Gateway("<your private key>", "<your public key>", True)
+
+  parameters = {
+        "payload": {
+            "description": "Golden Ticket",
+            "amount": "0.01",
+            "currency": "EUR",
+            "merchant_order_id": str(random.randint(1000, 9999)),
+            "success_url": "https://4f9f73c1.ngrok.io/success",
+            "sign_version": "v2",
+            "pingback_url": "https://4f9f73c1.ngrok.io/pingback",
+        }
+    }
+
+  paymentForm = gateway.payment_form().build_form(parameters)
+  print paymentForm
+```
+
+For more information on the API Parameters, refer to our entire API Documentation [here](https://docs.fasterpay.com/api#section-custom-integration)
+
+## Handling FasterPay Pingbacks
+
+```python
+from flask import request
+from fasterpay.gateway import FP_Gateway
+gateway = Gateway("<your private key>", "<your public key>", True)
+pingback_data = request.get_data()
+if request.headers.get("X-Fasterpay-Signature-Version") == "v2":
+    headers = {
+        "X-Fasterpay-Signature": str(request.headers.get("X-Fasterpay-Signature")),
+        "X-Fasterpay-Signature-Version": str(request.headers.get("X-Fasterpay-Signature-Version"))
+    }
+else:
+    headers = {
+        "X-ApiKey": str(request.headers.get("X-ApiKey"))
+    }
+
+if gateway.pingback().validate(pingback_data, headers) is True:
+    return "OK"
+else:
+    return "NOK"
+```
+
+## FasterPay Test Mode
+FasterPay has a Sandbox environment called Test Mode. Test Mode is a virtual testing environment which is an exact replica of the live FasterPay environment. This allows businesses to integrate and test the payment flow without being in the live environment. Businesses can create a FasterPay account, turn on the **Test Mode** and begin to integrate the widget using the test integration keys.
+
+### Initiating FasterPay Gateway in Test-Mode
+```python
+from fasterpay.gateway import Gateway
+gateway = Gateway("<your private key>", "<your public key>", True)
+```
+
+### Questions?
+* Common questions are covered in the [FAQ](https://www.fasterpay.com/support).
+* For integration and API questions, feel free to reach out Integration Team via [integration@fasterpay.com](mailto:integration@fasterpay.com)
+* For business support, email us at [merchantsupport@fasterpay.com](mailto:merchantsupport@fasterpay.com)
+* To contact sales, email [sales@fasterpay.com](mailto:sales@fasterpay.com).

fasterpay/__init__.py

@@ -0,0 +1,26 @@
+class Config:
+
+    def __init__(self, privateKey, publicKey, is_test = False, apiVersion = None):
+        self.publicKey = publicKey
+        self.privateKey = privateKey
+        if is_test is True :
+            self.API_BASE_URL = "http://pay.fasterpay.com"
+        else:
+            self.API_BASE_URL = "http://pay.sandbox.fasterpay.com"
+
+        if apiVersion is not None :
+            self.VERSION = apiVersion
+        else:
+            self.VERSION = "1.0.0"
+
+    def get_public_key(self):
+        return self.publicKey
+
+    def get_private_key(self):
+        return self.privateKey
+
+    def get_api_url(self):
+        return self.API_BASE_URL
+
+    def get_api_version(self):
+        return self.VERSION

fasterpay/config.py

@@ -0,0 +1,33 @@
+from fasterpay.config import Config
+from fasterpay.signature import Signature
+from fasterpay.pingback import Pingback
+from fasterpay.paymentform import PaymentForm
+from fasterpay.refund import Refund
+from fasterpay.subscription import Subscription
+
+
+class Gateway:
+
+    def __init__(self, private_key, public_key, api_url=None, api_version=None):
+        self.config = Config(private_key, public_key, api_url, api_version)
+
+    def payment_form(self):
+        return PaymentForm(self)
+
+    def signature(self):
+        return Signature(self)
+
+    def pingback(self):
+        return Pingback(self)
+
+    def get_config(self):
+        return self.config
+
+    def refund(self):
+        return Refund(self)
+
+    def subscription(self):
+        return Subscription(self)
+
+
+

fasterpay/gateway.py

@@ -0,0 +1,26 @@
+class PaymentForm:
+
+    def __init__(self, gateway):
+        self.gateway = gateway
+
+    def build_form(self, parameters):
+        payload = parameters.get("payload")
+        payload.update({"api_key": self.gateway.config.get_public_key()})
+
+        if "sign_version" in payload:
+            hash = self.gateway.signature().calculate_hash(payload, payload.get("sign_version"))
+        else:
+            hash = self.gateway.signature().calculate_hash(payload)
+
+        payload.update({"hash": hash})
+
+        form = '<form align="center" method="post" action="' + self.gateway.config.get_api_url() + '/payment/form">'
+        for param in payload:
+            form  += '<input type="hidden" name="' + param + '" value="' + str(payload[param]) + '" />'
+
+        form += '<input type="Submit" value="Pay Now" id="fasterpay-submit"/></form>'
+
+        if "auto_submit_form" in parameters:
+            form += "<script type=\"text/javascript\">document.getElementById(\"fasterpay-submit\").click(); </script>"
+
+        return form

fasterpay/paymentform.py

@@ -0,0 +1,21 @@
+class Pingback:
+
+    def __init__(self, gateway):
+        self.gateway = gateway
+
+    def validate(self, pingbackdata, headers):
+        if len(headers) == 0:
+            return False
+
+        if len(pingbackdata) == 0:
+            return False
+
+        if headers.get("X-Fasterpay-Signature-Version") == "v2":
+            generated_hash = self.gateway.signature().calculate_pingback_hash(pingbackdata)
+            if generated_hash == headers.get("X-Fasterpay-Signature"):
+                return True
+        else:
+            if headers.get("X-ApiKey") == self.gateway.config.get_private_key():
+                return True
+
+        return False

fasterpay/pingback.py

@@ -0,0 +1,14 @@
+import requests
+import json
+
+class Refund:
+
+    def __init__(self, gateway):
+        self.gateway = gateway
+
+    def process(self, order_id=None, amount=None):
+        response = requests.post(self.gateway.config.get_api_url() + "/payment/" + str(order_id) + "/refund",
+                                 data=json.dumps({"amount": amount}),
+                                 headers={"X-ApiKey": self.gateway.config.get_private_key()})
+
+        return response