refactor project

Author: nioperas06

.gitignore

@@ -6,4 +6,5 @@ dist
 build
 venv
 .idea
-__pycache__
+__pycache__
+.env

kkiapay/__init__.py

@@ -1 +1 @@
-from .core import Kkiapay
+from .api import Kkiapay

kkiapay/api.py

@@ -0,0 +1,26 @@
+from .base import KkiapayBase
+
+
+class Kkiapay(KkiapayBase):
+    def __init__(self, public_key: str, private_key: str, secret: str, sandbox=False) -> None:
+        r"""Initialize Kkiapay client.
+        :param public_key: Public key from https://app.kkiapay.me/dashboard/developers/keys.
+        :param private_key: Provate key from https://app.kkiapay.me/dashboard/developers/keys.
+        :param secret: Kiapay secret from https://app.kkiapay.me/dashboard/developers/keys.
+        :param sandbox: A boolean value to specify the environment (Sandbox or Live).
+        """
+        self._initialize_credentials(public_key, private_key, secret, sandbox)
+
+
+    def verify_transaction(self, transaction_id: str) -> dict:
+        r"""Verify a transaction.
+        :param transaction_id: transaction ID
+        """
+        return self._verify_transaction(transaction_id)
+
+
+    def refund_transaction(self, transaction_id: str) -> dict:
+        r"""Refund a specific transaction.
+        :param transaction_id: transaction ID
+        """
+        return self._refund_transaction(transaction_id)

kkiapay/base.py

@@ -0,0 +1,40 @@
+from .utils import make_request
+
+SANDBOX_BASE_URL = "https://api-sandbox.kkiapay.me"
+PRODUCTION_BASE_URL = "https://api.kkiapay.me"
+
+
+class KkiapayBase:
+    def _initialize_credentials(self, public_key: str, private_key: str, secret: str, sandbox: bool) -> None:
+        self.public_key             = public_key
+        self.private_key            = private_key
+        self.secret                 = secret
+        self.is_sandbox_environment = sandbox
+
+    def _build_request_headers(self) -> dict:
+        return {
+            "Accept": "application/json",
+            "X-SECRET-KEY": self.secret,
+            "X-API-KEY": self.public_key,
+            "X-PRIVATE-KEY": self.private_key,
+        }
+
+    def _build_request_url(self, path: str) -> str:
+        BASE_URL = SANDBOX_BASE_URL if self.is_sandbox_environment else PRODUCTION_BASE_URL
+        return f"{BASE_URL}/{path}"
+
+    def _verify_transaction(self, transaction_id: str):
+        return make_request(
+            "post",
+            self._build_request_url("api/v1/transactions/status"),
+            json={"transactionId": transaction_id},
+            headers=self._build_request_headers()
+        )
+
+    def _refund_transaction(self, transaction_id: str):
+        return make_request(
+            "post",
+            self._build_request_url("api/v1/transactions/revert"),
+            json={"transactionId": transaction_id},
+            headers=self._build_request_headers()
+        )

kkiapay/core.py

@@ -0,0 +1,23 @@
+import requests
+from requests.auth import HTTPBasicAuth
+
+
+def make_request(method: str, url: str, data=None, json=None, auth=None, **kwargs):
+    """Perform a request.
+    Usage::
+      >>> from shared.helpers import make_request
+      >>> req = make_request('get', 'https://api-sandbox.kkiapay.me')
+    """
+
+    try:
+        r = getattr(requests, method)(
+            url,
+            data=data,
+            json=json,
+            auth=auth if not auth else HTTPBasicAuth(**auth),
+            **kwargs,
+        )
+
+        return r.json()
+    except requests.exceptions.RequestException as e:
+        raise e

kkiapay/exceptions.py

@@ -3,7 +3,6 @@
 - [Introduction](#introduction)
 - [Installation](#installation)
 - [Usage](#usage)
-- [Road map](#road-map)
 - [Contributing](#contributing)
 - [License](#license)
 
@@ -23,6 +22,8 @@ pip install kkiapay
 
 Behold, the power of `kkiapay-python`:
 
+### Verify a transaction
+
 ```python
 from kkiapay import Kkiapay
 
@@ -31,84 +32,42 @@ k = Kkiapay('public_key', 'private_key', 'secret', sandbox=True)
 transaction = k.verify_transaction('LVFNrK1nx')
 
 print(transaction)
-# => KkiapayTransaction(
-#       performed_at='2019-07-11T11:24:42.687Z',
-#       type='DEBIT',
-#       status='FAILED',
-#       source='MOBILE_MONEY',
-#       amount=1,
-#       fees=0,
-#       country='BJ',
-#       reason='invalid_number',
-#       transactionId='LVFNrK1nx',
-#       performedAt='07/11/2019'
-#   )
-
-print(transaction.status)
-# => FAILED
-print(transaction.amount)
-# => 1
+# => {
+#    "performed_at":"2023-02-20T17:44:47.842Z",
+#    "received_at":1676915100302,
+#    "type":"DEBIT",
+#    "status":"SUCCESS",
+#    "source":"MOBILE_MONEY",
+#    "source_common_name":"mtn-benin",
+#    "amount":100,
+#    "fees":2,
+#    "net":0,
+#    "externalTransactionId":"test",
+#    "transactionId":"123",
+#    ...
+# }
 ```
 
-## Road map
-
-`kkiapay-python` is still under heavy development, we decided to ship it in this early stage so you can help us make it better.
+### Refund a transaction
 
-Here's the plan for what's coming:
-
-- [x] Sandbox and Live environments
-- [x] Verify Transaction
-- [x] Refund Transaction - `Only available on Live`
-- [x] Schedule Payout
-- [ ] Add better errors and exceptions handling
-- [ ] Add tests.
+```python
+from kkiapay import Kkiapay
 
+k = Kkiapay('public_key', 'private_key', 'secret', sandbox=True)
 
-## Schedule Payout
+transaction = k.refund_transaction('LVFNrK1nx')
 
-### Example
-Below is an example of the function usage:
-```python
-# Setup Scheduled Payout using 'ROOF' algorithm
-schedule_payout = k.setup_payout(algorithm = '2',
-                                 roof_amount = '10000',
-                                 destination = '61000000',
-                                 destination_type = '1',
-                                 send_notification = True,
-                                 country_code = '229'
-                                )
-
-print(schedule_payout)
-#{
-#	'response':
-#	{
-#		'merchant': '5d34445784deb700073a0281',
-#		'meta_data': '',
-#		'algorithm': 'roof',
-#		'rate_frequency': '',
-#		'roof_amount': '10000',
-#		'active': True,
-#		'send_notification': True,
-#		'destination_type': 'MOBILE_MONEY',
-#		'destination': '22961000000',
-#		'job_name': '',
-#		'account': '5d34445784deb700073a0282'
-#	},
-#	'status_code': 200
-#}
+print(transaction)
+# => {
+#    "code":"SUCCESS",
+#    "description":"REVERTED",
+#    "transactionId":"123"
+# }
 ```
 
-### Attribute Matrix
-|        Name       | Required |               Possible Values              |                                    Description                                    |
-|:-----------------:|:--------:|:------------------------------------------:|:---------------------------------------------------------------------------------:|
-|     **algorithm**     |     **M**    |         {"1": 'rate', "2": 'roof'}         |                         Specify the algorithm to be used.                         |
-|  **destination_type** |     **M**    | {"1": 'MOBILE_MONEY', "2": 'BANK_ACCOUNT'} |                            Specify the Destination type                           |
-|    **destination**    |     **M**    |                 '61000000'                 |                              Specify the Destination number/account Number                                                     |
-|   **rate_frequency**  |    M/O   	|      {"1": '3d', "2": '1w', "3": '1m'}     |       Specify the Rate Frequency. Required in case 'rate' algorithm is used       |
-|    **roof_amount**    |    M/O   |                   '10000'                  |                              Specify the Roof amount.                             |
-| **send_notification** |     O    |            Boolean (True, False)           |                      Specify is a Notification should be sent                     |
-|    **country_code**   |     O    |                    '229'                   | Specify the Country Code of the destination number is case 'MOBILE MONEY' is used |
+### Schedule Payout
 
+Schedule payout API is deprecated and no longer supported as of Feb 20th, 2023 from the API and can be done only on the [dashboard](https://app.kkiapay.me/dashboard) until further notice.
 
 ## Contributing
 

kkiapay/utils.py

@@ -1,32 +1,3 @@
-appdirs==1.4.3
-atomicwrites==1.3.0
-attrs==19.1.0
-black==19.3b0
-bleach==3.1.4
-certifi==2019.6.16
-chardet==3.0.4
-Click==7.0
-docutils==0.14
-idna==2.8
-importlib-metadata==0.18
-mock==3.0.5
-more-itertools==7.1.0
-packaging==19.0
-pkginfo==1.5.0.1
-pluggy==0.12.0
-py==1.8.0
-Pygments==2.4.2
-pyparsing==2.4.0
-pytest==5.0.1
-readme-renderer==24.0
 requests==2.22.0
-requests-mock==1.6.0
-requests-toolbelt==0.9.1
-six==1.12.0
-toml==0.10.0
-tqdm==4.32.2
-twine==1.13.0
-urllib3==1.25.3
-wcwidth==0.1.7
-webencodings==0.5.1
-zipp==0.5.2
+responses==0.22.0
+pytest==7.2.1