Bump/v0.05 (#4)

E-wave112 · web-flow · commit 737b7d143dff · 2023-07-23T23:54:32.000+01:00
* added the get_businesses and generate checkout methods

* updated the readme and added type hinting

* remove the type hint from postioal args

* updated get_businesses method and test cases

* updated user links

* updated documentation for get_businesseses and generate_checkout methods and bump version to 0.05

* updated python matrices versions for ci/cd pipeline

* updated python matrices versions for ci/cd pipeline

* removed py.8 from matrix versions
diff --git a/.github/workflows/pytests.yml b/.github/workflows/pytests.yml
@@ -14,7 +14,7 @@ jobs:
 
     strategy:
       matrix:
-        python-version: [3.6, 3.7, 3.8, 3.9]
+        python-version: ["3.9", "3.10", "3.11"]
 
     steps:
       # Checkout the latest code from the repo
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,14 +1,14 @@
 default_stages: [commit, push]
 default_language_version:
-  python: python3.7
+  python: python3.9
 repos:
   - repo: https://github.com/psf/black
     rev: 22.3.0
     hooks:
     - id: black
       args: [
         --line-length=100,
-        --target-version=py37,
+        --target-version=py39,
       ]
       exclude: ^(venv/|docs/)
       types: ['python']
@@ -20,7 +20,7 @@ repos:
     - id: check-docstring-first
     - id: check-yaml
     - id: debug-statements
-    - id: name-tests-test
+    # - id: name-tests-test
     - id: requirements-txt-fixer
   - repo: https://github.com/PyCQA/flake8
     rev: 4.0.1
diff --git a/README.md b/README.md
@@ -16,10 +16,9 @@ pip install pythepeer
 ## Usage
 Instantiate ```Thepeer``` class like so:
 ```python
-import thepeer
 from thepeer import Thepeer
 
-# create an instance of ThepeerInit class
+# create an instance of Thepeer class
 
 thepeer_instance = Thepeer("YOUR_API_KEY_HERE")
 
@@ -30,8 +29,9 @@ thepeer_instance = Thepeer("YOUR_API_KEY_HERE")
 **Note:**
  - For more info about the exposed methods, please refer to the general [documentation](https://docs.thepeer.co/)
  - Be sure to keep your API Credentials securely in [environment variables](https://www.twilio.com/blog/environment-variables-python)
+
 ### Indexing a user
-This describes how to index a user on your account (this is usually the first step before using other methods)
+This method describes how to index a user on your account (this is usually the first step before using other methods)
 
 ```python
 test = thepeer_instance.index_user("Osagie Iyayi", "iyayiemmanuel1@gmail.com", "iyayiemmanuel1@gmail.com")
@@ -90,7 +90,7 @@ test = thepeer_instance.all_users(1,15)
 
 
 ### Update an indexed user
-This methods helps to update the details of an indexed user
+This method helps to update the details of an indexed user
 
 ```python
 test = thepeer_instance.update_user(reference,**data)
@@ -109,7 +109,7 @@ test = thepeer_instance.update_user("3bbb0fbf-82fa-48a0-80eb-d2c0338fe7dd", iden
     email="dwave101@gmail.com")
 ```
 ### Remove an indexed user
-This methods helps to remove the details of an indexed user from a specific account
+This method helps to remove the details of an indexed user from a specific account
 
 ```python
 test = thepeer_instance.delete_user("3bbb0fbf-82fa-48a0-80eb-d2c0338fe7dd")
@@ -121,9 +121,53 @@ test = thepeer_instance.delete_user("3bbb0fbf-82fa-48a0-80eb-d2c0338fe7dd")
 |----------------------|---------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | ```reference```            | ```string```                  |  ```true```    | ```the unique reference returned when the user was indexed```
 
+
+
+
+ ### Get Businesses
+This method returns businesses based on the API they integrated.
+
+```python
+test = thepeer_instance.get_businesses("checkout")
+```
+
+#### Parameters supported
+
+
+| Parameters           | Data type                 | Required | Description                                                                                                                                                                                                                                         |
+|----------------------|---------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| ```channel```            | ```string```                  |  ```true```    | ```The specific API to return businesses of. supported values are send, checkout, and direct_charge```
+
+
+### Generate a Checkout
+This method allows you to generate a link for your customer to make a one-time payment with
+```python
+test = thepeer_instance.generate_checkout({
+    "amount": 1000000,
+    "currency": "NGN",
+    "redirect_url": "https://esportfolio.netlify.app",
+    "email": "jevede6918@muzitp.com",
+    "meta":{
+        "name": "Eddie Kirsch",
+        "identifier": "eddiekirsch",
+    }
+})
+```
+
+#### Parameters required
+
+| Parameters           | Data type                 | Required | Description                                                                                                                                                                                                                                         |
+|----------------------|---------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| ```redirect_url```        | ```string```                   | ```false```     | ```The url Thepeer should redirect to after the customer completes payment.```
+| ```amount```            | ```integer```               |  ```true```    | ```The amount you are debiting the customer. This should be in kobo. The minimum value is 10000```
+| ```email```        | ```string```                   | ```true```     | ```The customer’s email address```                                                                     |
+| ```currency```               | ```string```                    | ```true```    | ```The currency the transaction should be carried out in. The supported value is NGN.```
+| ```meta```               | ```dictionary```                    | ```false```    | ```An object containing additional attributes you will like to have in your transaction response.```
+
+
 ### Get user links
 
-This method gets all payment links associated to an indexed user
+This method returns all linked accounts of a user, the user’s account details, as well as the business the account is on.
 ```python
 test = thepeer_instance.get_user_links("3bbb0fbf-82fa-48a0-80eb-d2c0338fe7dd")
 ```
@@ -134,9 +178,9 @@ test = thepeer_instance.get_user_links("3bbb0fbf-82fa-48a0-80eb-d2c0338fe7dd")
 | ```reference```            | ```string```                  |  ```true```    | ```the unique reference returned when the user was indexed```
 
 
-### Get single link
+### Get single link (linked account)
 
-This method gets the payment information located in a payment link
+This method returns a user's linked account's details.
 
 ```python
 test = thepeer_instance.get_single_link("da14a90c-61c2-4cf7-a837-e3112a2d0c3d")
@@ -146,7 +190,7 @@ test = thepeer_instance.get_single_link("da14a90c-61c2-4cf7-a837-e3112a2d0c3d")
 
 | Parameters           | Data type                 | Required | Description                                                                                                                                                                                                                                         |
 |----------------------|---------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| ```link_id```           | ```string```                  |  ```true```    | ```the unique link_id containing the payment information```
+| ```link_id```           | ```string```                  |  ```true```    | ```The link’s identifier```
 
 
 ### Charge a link
@@ -159,7 +203,7 @@ test = thepeer_instance.charge_link(link_id, amount, remark, currency)
 
 | Parameters           | Data type                 | Required | Description                                                                                                                                                                                                                                         |
 |----------------------|---------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| ```link_id```        | ```string```                   | ```true```     | ```the unique link_id containing the payment information```
+| ```link_id```        | ```string```                   | ```true```     | ```The link’s identifier```
 | ```amount```            | ```integer```               |  ```true```    | ```the amount of the whole transaction```
 | ```remark```        | ```string```                   | ```true```     | ```short detail about the transaction```                                                                     |
 | ```currency```               | ```string```                    | ```false```    | ```The denomination medium of paying (either one of NGN and USD). defaults to NGN```
@@ -177,7 +221,7 @@ test = thepeer_instance.authorize_charge(charge_reference, event)
 | ```charge_reference```            | ```string```          |  ```true```   | ```the reference associated to a pending charge request```
 |  ```event```     | ```string```                | ```true```     | ```the type of webhook event```                                              |
 
-**Pro Tip:** the various types of webhook events are available [here](https://docs.thepeer.co/authorization/process-authorization-requests#supported-events)
+**Pro Tip:** the various types of webhook events are available [here](https://docs.thepeer.co/webhooks/overview)
 
 
 ### Get transaction detail
diff --git a/setup.py b/setup.py
@@ -12,7 +12,7 @@
 
 setup(
     name="pythepeer",
-    version="0.0.4",
+    version="0.0.5",
     description="official python sdk for interacting with thepeer payment processing \
     infrastructure",
     author="Osagie Iyayi",
@@ -36,6 +36,7 @@
         "Programming Language :: Python :: 3.8",
         "Programming Language :: Python :: 3.9",
         "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
         "Topic :: Software Development :: Libraries",
     ],
     long_description=README,
diff --git a/tests/test_thepeer.py b/tests/test_thepeer.py
@@ -26,16 +26,16 @@ def test_index_user(self):
     def test_view_user(self):
         self.assertEqual.__self__.maxDiff = None
         self.assertEqual(
-            thepeer_test_suites.view_user("3bbb0fbf-82fa-48a0-80eb-d2c0338fe7dd"),
+            thepeer_test_suites.view_user("d2cb0c2c-7bd4-40a0-9744-824fbce176b7"),
             {
                 "indexed_user": {
+                    "reference": "d2cb0c2c-7bd4-40a0-9744-824fbce176b7",
                     "name": "Osagie Iyayi",
                     "identifier": "iyayiemmanuel1@gmail.com",
                     "identifier_type": "email",
                     "email": "iyayiemmanuel1@gmail.com",
-                    "reference": "3bbb0fbf-82fa-48a0-80eb-d2c0338fe7dd",
-                    "created_at": "2022-04-30T21:30:29.000000Z",
-                    "updated_at": "2022-05-04T07:37:45.000000Z",
+                    "created_at": "2022-05-04T07:37:44.000000Z",
+                    "updated_at": "2022-05-04T07:37:44.000000Z",
                 }
             },
         )
@@ -48,34 +48,43 @@ def test_all_users(self):
                 "indexed_users": {
                     "data": [
                         {
-                            "name": "Osagie Iyayi",
-                            "identifier": "iyayiemmanuel1@gmail.com",
+                            "reference": "5c4961bf-56ca-4a28-80af-214543cdf382",
+                            "name": "Adesubomi Jaiyeola",
+                            "identifier": "08095743249",
                             "identifier_type": "email",
-                            "email": "iyayiemmanuel1@gmail.com",
-                            "reference": "3bbb0fbf-82fa-48a0-80eb-d2c0338fe7dd",
-                            "created_at": "2022-04-30T21:30:29.000000Z",
-                            "updated_at": "2022-05-04T07:37:45.000000Z",
+                            "email": "subomi.ja@gmail.com",
+                            "created_at": "2023-04-04T14:49:30.000000Z",
+                            "updated_at": "2023-04-04T14:49:30.000000Z",
                         },
                         {
+                            "reference": "d2cb0c2c-7bd4-40a0-9744-824fbce176b7",
                             "name": "Osagie Iyayi",
                             "identifier": "iyayiemmanuel1@gmail.com",
                             "identifier_type": "email",
                             "email": "iyayiemmanuel1@gmail.com",
-                            "reference": "d2cb0c2c-7bd4-40a0-9744-824fbce176b7",
                             "created_at": "2022-05-04T07:37:44.000000Z",
                             "updated_at": "2022-05-04T07:37:44.000000Z",
                         },
-                    ],
-                    "meta": {"page": 1, "total": 2, "pageCount": 1, "perPage": 15},
-                }
+                        {
+                            "reference": "e9d09152-fb47-4bb7-a162-7a326cd35c32",
+                            "name": "Jenni Madu",
+                            "identifier": "jennifermadu903@gmail.com",
+                            "identifier_type": "email",
+                            "email": "jennifermadu903@gmail.com",
+                            "created_at": "2023-04-13T14:04:32.000000Z",
+                            "updated_at": "2023-04-13T14:04:32.000000Z",
+                        },
+                    ]
+                },
+                "meta": {"page": 1, "total": 3, "pageCount": 1, "perPage": 15},
             },
         )
 
     def test_user_links(self):
         self.assertEqual.__self__.maxDiff = None
         self.assertEqual(
-            thepeer_test_suites.get_user_links("3bbb0fbf-82fa-48a0-80eb-d2c0338fe7dd"),
-            {"links": []},
+            thepeer_test_suites.get_user_links("d2cb0c2c-7bd4-40a0-9744-824fbce176b7"),
+            {"links": None},
         )
 
     def test_single_link(self):
@@ -92,8 +101,10 @@ def test_charge_link(self):
                 "3bbb0fbf-82fa-48a0-80eb-d2c0338fe7dd", 2000, "try thepeer"
             ),
             {
-                "message": "The given data was invalid.",
-                "errors": {"amount": ["The amount must be at least 10000."]},
+                "errors": {
+                    "amount": ["The amount field must be numeric value between 10000 and 100000000"]
+                },
+                "message": "The given data was invalid",
             },
         )
 
@@ -109,25 +120,82 @@ def test_charge_link_2(self):
     def test_authorize_charge(self):
         self.assertEqual.__self__.maxDiff = None
         self.assertEqual(
-            thepeer_test_suites.authorize_charge("3bbb0fbf-82fa-48a0-80eb-d2c0338fe7dd", "charge"),
-            {
-                "message": "The given data was invalid.",
-                "errors": {"event": ["The selected event is invalid."]},
-            },
+            thepeer_test_suites.authorize_charge("3bbb0fbf-82fa-48a0-80eb-d2c0338fe7dd", "success"),
+            {"message": "resource not found"},
         )
 
     def test_transaction_detail(self):
         self.assertEqual.__self__.maxDiff = None
         self.assertEqual(
-            thepeer_test_suites.get_transaction_detail("3bbb0fbf-82fa-48a0-80eb-d2c0338fe7dd"),
-            {"message": "transaction not found"},
+            thepeer_test_suites.get_transaction_detail("d761e113-1e6d-456d-8341-79a963234511"),
+            {
+                "transaction": {
+                    "id": "d761e113-1e6d-456d-8341-79a963234511",
+                    "amount": 1000000,
+                    "channel": "checkout",
+                    "refund": False,
+                    "checkout": {
+                        "id": "402bc104-b17e-4046-bef5-4e3df34aac5c",
+                        "amount": 1000000,
+                        "email": "iyayiemmanuel1@gmail.com",
+                        "currency": "NGN",
+                        "status": "paid",
+                        "linked_account": {
+                            "user": {
+                                "name": "Trojan Okoh",
+                                "identifier": "trojan",
+                                "identifier_type": "username",
+                            },
+                            "business": {
+                                "name": "Cash App",
+                                "logo": "https://palaciodepeer.s3.us-east-2.amazonaws.com/business_logos/UJimBqYOu7KQIM3DwCWOuKjkDbBbVLYRuYRTgxKh.png",  # noqa: E501
+                                "logo_colour": "#77cc33",
+                            },
+                        },
+                        "meta": {},
+                        "updated_at": "2023-07-22T23:55:21.000000Z",
+                        "created_at": "2023-07-22T23:48:15.000000Z",
+                    },
+                    "user": {
+                        "reference": "2992e5b4-acb7-49b4-848d-f5a7ca225413",
+                        "name": "Checkout",
+                        "identifier": "checkout",
+                        "identifier_type": "email",
+                        "email": "iyayiemmanuel1@gmail.com",
+                        "created_at": "2023-07-22T23:55:19.000000Z",
+                        "updated_at": "2023-07-22T23:55:19.000000Z",
+                    },
+                    "charge": 10000,
+                    "currency": "NGN",
+                    "mode": "credit",
+                    "reference": "c3f0a7b1ec0dbb3242eeaea7f380e96e",
+                    "remark": "checkout",
+                    "status": "success",
+                    "type": "peer",
+                    "meta": None,
+                    "peer": {
+                        "business": {
+                            "name": "Cash App",
+                            "logo": "https://palaciodepeer.s3.us-east-2.amazonaws.com/business_logos/UJimBqYOu7KQIM3DwCWOuKjkDbBbVLYRuYRTgxKh.png",  # noqa: E501
+                            "logo_colour": "#77cc33",
+                        },
+                        "user": {
+                            "name": "Trojan Okoh",
+                            "identifier": "trojan",
+                            "identifier_type": "username",
+                        },
+                    },
+                    "updated_at": "2023-07-22T23:55:20.000000Z",
+                    "created_at": "2023-07-22T23:55:20.000000Z",
+                }
+            },
         )
 
     def test_refund_transaction(self):
         self.assertEqual.__self__.maxDiff = None
         self.assertEqual(
             thepeer_test_suites.refund_transaction(
-                "3bbb0fbf-82fa-48a0-80eb-d2c0338fe7dd", "possibly fraudulent"
+                "d761e113-1e6d-456d-8341-79a963234511", "possibly fraudulent"
             ),
-            {"message": "this feature is only available on live mode"},
+            {"message": "transactions can only be refunded on live mode"},
         )
diff --git a/thepeer/main.py b/thepeer/main.py
