Merge pull request #8 from barreeeiroo/master

feat!: Improve search/find methods

Author: fronugget

.gitignore

@@ -5,3 +5,5 @@ paymentrails/exception/__pycache__
 *.pyc
 .env
 *.egg-info
+.idea/
+venv-*/

paymentrails/client.py

@@ -42,13 +42,13 @@ def sendRequest(self,endpoint,method,body=""):
                        'Authorization': authorization,
                        'X-PR-Timestamp': str(timestamp)}
 
-            if method is "GET":
+            if method == "GET":
                 request = requests.get(self.config.enviroment + endpoint, headers=headers)
-            elif method is "POST":
+            elif method == "POST":
                 request = requests.post(self.config.enviroment + endpoint, headers=headers, json=body)
-            elif method is "PATCH":
+            elif method == "PATCH":
                 request = requests.patch(self.config.enviroment + endpoint, headers=headers, json=body)
-            elif method is "DELETE":
+            elif method == "DELETE":
                 request = requests.delete(self.config.enviroment + endpoint, headers=headers)
             else:
                 self.throw_status_code_exception(None, "Invalid Method")

paymentrails/payment_gateway.py

@@ -28,6 +28,8 @@ def find(self, payment_id, batch_id):
     def create(self, body, batch_id):
         if body is None:
             raise InvalidFieldException("Body cannot be None.")
+        elif batch_id is None:
+            raise InvalidFieldException("Batch ID cannot be None.")
         endpoint = '/v1/batches/' + batch_id + '/payments/'
         response = paymentrails.configuration.Configuration.client(
             self.config).post(endpoint, body)

paymentrails/recipient_gateway.py

@@ -1,6 +1,8 @@
 from collections import namedtuple
 from paymentrails.exceptions.invalidFieldException import InvalidFieldException
 import paymentrails.configuration
+from paymentrails.utils import UrlUtils
+
 
 class RecipientGateway(object):
     """
@@ -46,7 +48,6 @@ def update(self, recipient_id, body):
         paymentrails.configuration.Configuration.client(
             self.config).patch(endpoint, body)
         return True
-       
 
     def delete(self, recipient_id):
         if recipient_id is None:
@@ -56,9 +57,10 @@ def delete(self, recipient_id):
             self.config).delete(endpoint)
         return True
 
-    def search(self, page, page_number, term):
-        endpoint = '/v1/recipients?search=' + term + '&page=' + \
-            str(page) + '&pageSize=' + str(page_number)
+    def search(self, page=None, page_size=None, search=None, name=None, email=None, reference_id=None, start_date=None,
+               end_date=None, status=None, compliance_status=None, country=None, payout_method=None, currency=None,
+               order_by=None, sort_by=None):
+        endpoint = '/v1/recipients?' + UrlUtils.parse(locals())
         response = paymentrails.configuration.Configuration.client(
             self.config).get(endpoint)
         recipients = []

paymentrails/utils.py

@@ -0,0 +1,53 @@
+import urllib.parse
+
+
+class UrlUtils:
+    """
+    Helper class which allows automatic conversion from Python function parameters to Payment
+    Rails supported API parameters.
+    """
+
+    @staticmethod
+    def __to_came_case(string):
+        """
+        Converts the given string from snake_case (Python PEP) to lowerCamelCase (Payment Rails API)
+        See: https://stackoverflow.com/a/19053800/6626193
+
+        :param string: the given snake_case string
+        :return: the equivalent lowerCamelCase string
+        """
+        components = string.split('_')
+        return components[0] + ''.join(x.title() for x in components[1:])
+
+    @staticmethod
+    def parse(attributes):
+        """
+        Given a series of attributes in a dictionary, parses such dictionary removing all None values and
+        returns a URL compatible parameter string.
+        To use this method, invoke it like UrlUtils.parse(locals()), as locals() will return all parameters that
+        the function is receiving.
+        For an example, see RecipientGateway.search.
+
+        :param: attributes: dictionary of all attributes, including None ones
+        :return: url compatible parameter string
+        """
+
+        # List containing already parsed params [key1=value1, key2=value2]
+        params = []
+        # Iterate over attribute keys
+        for key in attributes.keys():
+            # Note that locals() also returns the "self" attribute, so just ignore it
+            if key == "self":
+                continue
+
+            # Ignore None attributes as well
+            if attributes[key] is None:
+                continue
+
+            # Convert the valid parameter to a Payment Rails API compatible one
+            param = UrlUtils.__to_came_case(key) + "=" + urllib.parse.quote(str(attributes[key]))
+            # And add it to the list
+            params.append(param)
+
+        # Return the list as a string with "&" as the join character
+        return "&".join(params)