Added payout recipient model, method and exceptions,tested setup method in test cases with different scenarios

Author: ppatidar2021

src/bitpay_sdk/client.py

@@ -9,7 +9,6 @@
 import json
 
 from .config import Config
-from .exceptions.invoice_creation_exception import InvoiceCreationException
 from .tokens import Tokens
 from .models.facade import Facade
 from .models.bill.bill import Bill
@@ -20,6 +19,8 @@
 from .models.invoice.invoice import Invoice
 from .models.ledger.ledger_entry import LedgerEntry
 from .exceptions.bitpay_exception import BitPayException
+from .models.payout.payout_recipient import PayoutRecipient
+from .models.payout.payout_recipients import PayoutRecipients
 from .exceptions.bill_query_exception import BillQueryException
 from .exceptions.bill_update_exception import BillUpdateException
 from .exceptions.ledger_query_exception import LedgerQueryException
@@ -31,10 +32,16 @@
 from .exceptions.invoice_query_exception import InvoiceQueryException
 from .exceptions.invoice_update_exception import InvoiceUpdateException
 from .exceptions.refund_creation_exception import RefundCreationException
+from .exceptions.invoice_creation_exception import InvoiceCreationException
 from .exceptions.refund_notification_exception import RefundNotificationException
 from .exceptions.refund_cancellation_exception import RefundCancellationException
 from .exceptions.invoice_cancellation_exception import InvoiceCancellationException
 from .exceptions.invoice_notification_exception import InvoiceNotificationException
+from .exceptions.payout_recipient_query_exception import PayoutRecipientQueryException
+from .exceptions.payout_recipient_update_exception import PayoutRecipientUpdateException
+from .exceptions.payout_recipient_creation_exception import PayoutRecipientCreationException
+from .exceptions.payout_recipient_cancellation_exception import PayoutRecipientCancellationException
+from .exceptions.payout_recipient_notification_exception import PayoutRecipientNotificationException
 
 
 class Client:
@@ -100,6 +107,7 @@ def build_config(self, private_key_path: str, tokens: Tokens):
                 read_file = open(private_key_path, 'r')
                 plain_private_key = read_file.read()
                 self.__ec_key = plain_private_key
+                read_file.close()
             else:
                 raise BitPayException("Private Key file not found")
 
@@ -132,7 +140,10 @@ def init_keys(self):
 
     def init(self):
         try:
-            proxy = self.__configuration.get_envconfig()[self.__env]["proxy"]
+            proxy = None
+            if "proxy" in self.__configuration.get_envconfig()[self.__env]:
+                proxy = self.__configuration.get_envconfig()[self.__env]["proxy"]
+
             self.__restcli = RESTcli(self.__env, self.__ec_key, proxy)
             self.load_access_tokens()
             self.__currencies_info = self.load_currencies()
@@ -754,3 +765,102 @@ def get_ledgers(self) -> [Ledger]:
             raise LedgerQueryException("failed to deserialize BitPay server response"
                                        " (Ledger) : %s" % str(exe))
         return ledgers
+
+    def submit_payout_recipients(self, recipients: PayoutRecipients) -> [PayoutRecipient]:
+        try:
+            recipients.set_token(self.get_access_token(Facade.Payout))
+            recipients.to_json()
+
+            response_json = self.__restcli.post("recipients", recipients, True)
+        except BitPayException as exe:
+            raise PayoutRecipientCreationException("failed to serialize PayoutRecipients object :  %s" % str(exe),
+                                                   exe.get_api_code())
+
+        try:
+            payout_recipients = PayoutRecipient(**response_json)
+        except Exception as exe:
+            raise PayoutRecipientCreationException("failed to deserialize BitPay server response "
+                                                   " (PayoutRecipients) : %s" % str(exe))
+        return payout_recipients
+
+    def get_payout_recipient(self, recipient_id: str) -> PayoutRecipient:
+        try:
+            params = {"token": self.get_access_token(Facade.Payout)}
+            response_json = self.__restcli.get("recipients/%s" % recipient_id, params)
+        except BitPayException as exe:
+            raise PayoutRecipientQueryException("failed to serialize PayoutRecipients object :  %s" % str(exe),
+                                                exe.get_api_code())
+
+        try:
+            payout_recipient = PayoutRecipient(**response_json)
+        except Exception as exe:
+            raise PayoutRecipientQueryException("failed to deserialize BitPay server response "
+                                                " (PayoutRecipients) : %s" % str(exe))
+        return payout_recipient
+
+    def get_payout_recipients(self, status, limit=100, offset=0) -> [PayoutRecipient]:
+        try:
+            params = {"token": self.get_access_token(Facade.Payout),
+                      "limit": str(limit), "offset": str(offset)}
+            if status:
+                params["status"] = status
+
+            response_json = self.__restcli.get("recipients", params)
+        except BitPayException as exe:
+            raise PayoutRecipientQueryException("failed to serialize PayoutRecipients object :  %s" % str(exe),
+                                                exe.get_api_code())
+
+        try:
+            payout_recipients = []
+            for payout_recipient in response_json:
+                payout_recipients.append(PayoutRecipient(**payout_recipient))
+        except Exception as exe:
+            raise PayoutRecipientQueryException("failed to deserialize BitPay server response "
+                                                " (PayoutRecipients) : %s" % str(exe))
+        return payout_recipients
+
+    def update_payout_recipient(self, recipient_id, recipient: PayoutRecipient) -> PayoutRecipient:
+        try:
+            recipient.set_token(self.get_access_token(Facade.Payout))
+
+            response_json = self.__restcli.update("recipients/%s" % recipient_id, recipient.to_json())
+        except BitPayException as exe:
+            raise PayoutRecipientUpdateException("failed to serialize PayoutRecipients object :  %s" % str(exe),
+                                                 exe.get_api_code())
+
+        try:
+            payout_recipient = PayoutRecipient(**response_json)
+        except Exception as exe:
+            raise PayoutRecipientUpdateException("failed to deserialize BitPay server response "
+                                                 " (PayoutRecipients) : %s" % str(exe))
+        return payout_recipient
+
+    def delete_payout_recipient(self, recipient_id) -> bool:
+        try:
+            params = {"token": self.get_access_token(Facade.Payout)}
+            response_json = self.__restcli.delete("recipients/%s" % recipient_id, params)
+        except BitPayException as exe:
+            raise PayoutRecipientCancellationException("failed to serialize PayoutRecipients object :  %s" % str(exe),
+                                                       exe.get_api_code())
+
+        try:
+            payout_recipient = PayoutRecipient(**response_json)
+        except Exception as exe:
+            raise PayoutRecipientCancellationException("failed to deserialize BitPay server response "
+                                                       " (PayoutRecipients) : %s" % str(exe))
+        return payout_recipient
+
+    def request_payout_recipient_notification(self, recipient_id) -> bool:
+        try:
+            params = {"token": self.get_access_token(Facade.Payout)}
+            response_json = self.__restcli.post("recipients/%s" % recipient_id + "/notifications", params)
+        except BitPayException as exe:
+            raise PayoutRecipientNotificationException("failed to serialize PayoutRecipients object :  %s" % str(exe),
+                                                       exe.get_api_code())
+
+        try:
+            payout_recipient = PayoutRecipient(**response_json)
+        except Exception as exe:
+            raise PayoutRecipientNotificationException("failed to deserialize BitPay server response "
+                                                       " (PayoutRecipients) : %s" % str(exe))
+        return payout_recipient

src/bitpay_sdk/exceptions/payout_recipient_cancellation_exception.py

@@ -0,0 +1,31 @@
+"""
+PayoutRecipient Cancellation exception gets raised when it fails to cancel payout recipient.
+"""
+from .payout_recipient_exception import PayoutRecipientException
+
+
+class PayoutRecipientCancellationException(PayoutRecipientException):
+    """
+    PayoutRecipientCancellationException
+    """
+    __bitpay_message = "Failed to cancel payout recipient"
+    __bitpay_code = "BITPAY-PAYOUT-RECIPIENT-CANCEL"
+    __api_code = ""
+
+    def __init__(self, message, code=194, api_code="000000"):
+        """
+        Construct the PayoutRecipientCancellationException.
+
+        :param message: The Exception message to throw.
+        :param code: [optional] The Exception code to throw.
+        :param api_code: [optional] The API Exception code to throw.
+        """
+        message = self.__bitpay_code + ": " + self.__bitpay_message + ":" + message
+        self.__api_code = api_code
+        super().__init__(message, code)
+
+    # def get_api_code(self):
+    #     """
+    #     :return: Error code provided by the BitPay REST API
+    #     """
+    #     return self.__api_code

src/bitpay_sdk/exceptions/payout_recipient_creation_exception.py

@@ -0,0 +1,28 @@
+"""
+PayoutRecipientCreation Exception gets raised when request for recipient creation gets failed.
+"""
+from .payout_recipient_exception import PayoutRecipientException
+
+
+class PayoutRecipientCreationException(PayoutRecipientException):
+    """
+    PayoutRecipientCreationException
+    """
+    __bitpay_message = "Failed to create payout recipient"
+    __bitpay_code = "BITPAY-PAYOUT-RECIPIENT-SUBMIT"
+    __api_code = ""
+
+    def __init__(self, message, code=112, api_code="000000"):
+        """
+        Construct the PayoutRecipientCreationException.
+
+        :param message: The Exception message to throw.
+        :param code: [optional] The Exception code to throw.
+        :param api_code: [optional] The API Exception code to throw.
+        """
+        message = self.__bitpay_code + ": " + self.__bitpay_message + ":" + message
+        self.__api_code = api_code
+        super().__init__(message, code)
+
+    # def get_api_code(self):
+    #     return self.__api_code

src/bitpay_sdk/exceptions/payout_recipient_exception.py

@@ -0,0 +1,29 @@
+"""
+PayoutRecipient Exception gets raised when some unexpected error occurs while processing a request
+or trying to manage recipients.
+"""
+from .bitpay_exception import BitPayException
+
+
+class PayoutRecipientException(BitPayException):
+    """
+    PayoutRecipientException
+    """
+    __bitpay_message = "An unexpected error occurred while trying to manage the payout recipient"
+    __bitpay_code = "BITPAY-PAYOUT-RECIPIENT-GENERIC"
+    __api_code = ""
+
+    def __init__(self, message="", code=191, api_code="000000"):
+        """
+        Construct the Payout Recipient Exception.
+
+        :param message: The Exception message to throw.
+        :param code: [optional] The Exception code to throw.
+        :param api_code: [optional] The API Exception code to throw.
+        """
+        message = self.__bitpay_code + ": " + self.__bitpay_message + ":" + message
+        self.__api_code = api_code
+        super().__init__(message, code)
+
+    # def get_api_code(self):
+    #     return self.__api_code

src/bitpay_sdk/exceptions/payout_recipient_notification_exception.py

@@ -0,0 +1,31 @@
+"""
+PayoutRecipientNotification Exception gets raised when webhook fails to send notification
+"""
+from .payout_recipient_exception import PayoutRecipientException
+
+
+class PayoutRecipientNotificationException(PayoutRecipientException):
+    """
+    PayoutRecipientNotificationException
+    """
+    __bitpay_message = "Failed to send payout recipient notification"
+    __bitpay_code = "BITPAY-PAYOUT-RECIPIENT-NOTIFICATION"
+    __api_code = ""
+
+    def __init__(self, message, code=196, api_code="000000"):
+        """
+        Construct the PayoutRecipientNotificationException.
+
+        :param message: The Exception message to throw.
+        :param code: [optional] The Exception code to throw.
+        :param api_code: [optional] The API Exception code to throw.
+        """
+        message = self.__bitpay_code + ": " + self.__bitpay_message + ":" + message
+        self.__api_code = api_code
+        super().__init__(message, code)
+
+    # def get_api_code(self):
+    #     """
+    #     :return: Error code provided by the BitPay REST API
+    #     """
+    #     return self.__api_code

src/bitpay_sdk/exceptions/payout_recipient_query_exception.py

@@ -0,0 +1,31 @@
+"""
+PayoutRecipientQuery Exception gets raised when request for recipient retrieval gets failed .
+"""
+from .invoice_exception import InvoiceException
+
+
+class PayoutRecipientQueryException(InvoiceException):
+    """
+    PayoutRecipientQueryException
+    """
+    __bitpay_message = "Failed to retrieve payout recipient"
+    __bitpay_code = "BITPAY-PAYOUT-RECIPIENT-GET"
+    __api_code = ""
+
+    def __init__(self, message, code=193, api_code="000000"):
+        """
+        Construct the PayoutRecipientQueryException.
+
+        :param message: The Exception message to throw.
+        :param code: [optional] The Exception code to throw.
+        :param api_code: [optional] The API Exception code to throw.
+        """
+        message = self.__bitpay_code + ": " + self.__bitpay_message + ":" + message
+        self.__api_code = api_code
+        super().__init__(message, code)
+
+    # def get_api_code(self):
+    #     """
+    #     :return: Error code provided by the BitPay REST API
+    #     """
+    #     return self.__api_code

src/bitpay_sdk/exceptions/payout_recipient_update_exception.py

@@ -0,0 +1,28 @@
+"""
+PayoutRecipientUpdate Exception gets raised when it fails to update recipient
+"""
+from .payout_recipient_exception import PayoutRecipientException
+
+
+class PayoutRecipientUpdateException(PayoutRecipientException):
+    """
+    PayoutRecipientUpdateException
+    """
+    __bitpay_message = "Failed to update payout recipient"
+    __bitpay_code = "BITPAY-PAYOUT-RECIPIENT-UPDATE"
+    __api_code = ""
+
+    def __init__(self, message, code=195, api_code="000000"):
+        """
+        Construct the PayoutRecipientUpdateException.
+
+        :param message: The Exception message to throw.
+        :param code: [optional] The Exception code to throw.
+        :param api_code: [optional] The API Exception code to throw.
+        """
+        message = self.__bitpay_code + ": " + self.__bitpay_message + ":" + message
+        self.__api_code = api_code
+        super().__init__(message, code)
+
+    # def get_api_code(self):
+    #     return self.__api_code