SP-582 Python - Implement better refund exceptions

Author: mwarzybok-sumoheavy

src/bitpay/client.py

@@ -22,6 +22,8 @@
 from bitpay.clients.wallet_client import WalletClient
 from .config import Config
 from .environment import Environment
+from .exceptions.bitpay_exception_provider import BitPayExceptionProvider
+from .exceptions.bitpay_generic_exception import BitPayGenericException
 from .models.facade import Facade
 from .models.bill.bill import Bill
 from .models.invoice.invoice_event_token import InvoiceEventToken
@@ -69,7 +71,7 @@ def __init__(
                 guid_generator = GuidGenerator()
             self.__guid_generator = guid_generator
         except Exception as exe:
-            raise BitPayException("failed to initiate clients: " + str(exe))
+            BitPayExceptionProvider.throw_generic_exception_with_message("failed to initiate clients: " + str(exe))
 
     @staticmethod
     def create_pos_client(self, pos_token: str, environment: Environment = Environment.PROD):  # type: ignore
@@ -87,6 +89,9 @@ def create_client(  # type: ignore
         environment: Environment = Environment.PROD,
         proxy: Optional[str] = None,
     ):
+        """
+        :raises BitPayGenericException
+        """
         try:
             base_url = Client.get_base_url(environment)
             ec_key = Client.get_ec_key(private_key_or_private_key_path)
@@ -95,12 +100,15 @@ def create_client(  # type: ignore
 
             return Client(bitpay_client, token_container, guid_generator)
         except Exception as exe:
-            raise BitPayException("failed to process configuration: " + str(exe))
+            BitPayExceptionProvider.throw_generic_exception_with_message("failed to process configuration: " + str(exe))
 
     @staticmethod
     def create_client_by_config_file_path(config_file_path: str):  # type: ignore
+        """
+        :raises BitPayGenericException
+        """
         if not os.path.exists(config_file_path):
-            raise BitPayException("Configuration file not found")
+            BitPayExceptionProvider.throw_generic_exception_with_message("Configuration file not found")
 
         try:
             with open(config_file_path, "r") as read_file:
@@ -129,12 +137,16 @@ def create_client_by_config_file_path(config_file_path: str):  # type: ignore
                 private_key_or_private_key_path, token_container, environment, proxy
             )
         except Exception as exe:
-            raise BitPayException("Error when reading configuration file. " + str(exe))
+            BitPayExceptionProvider.throw_generic_exception_with_message("Error when reading configuration file. " + str(exe))
 
     @staticmethod
     def get_ec_key(private_key_or_private_key_path: Optional[str]) -> str:
+        """
+        :raises BitPayGenericException
+        """
         if private_key_or_private_key_path is None:
-            raise BitPayException("Private Key file not found")
+            BitPayExceptionProvider.throw_generic_exception_with_message("Private Key file not found")
+            raise BitPayGenericException("Private Key file not found")
 
         if os.path.exists(private_key_or_private_key_path):
             with open(private_key_or_private_key_path, "r") as read_file:
@@ -151,12 +163,15 @@ def get_base_url(environment: Environment) -> str:
         )
 
     def get_access_token(self, facade: Facade) -> str:
+        """
+        :raises BitPayGenericException
+        """
         try:
             return self.__token_container.get_access_token(facade)
         except Exception as exe:
-            raise BitPayException(
-                "There is no token for the specified key: " + facade.value
-            )
+            message = "There is no token for the specified key: " + facade.value
+            BitPayExceptionProvider.throw_generic_exception_with_message(message)
+            raise BitPayGenericException(message)
 
     # //////////////////////////////////////////////////////////////////////////////
     # //////////////////////////////////////////////////////////////////////////////

src/bitpay/clients/bill_client.py

@@ -1,11 +1,9 @@
 from typing import List, Optional
 
 from bitpay.clients.bitpay_client import BitPayClient
-from bitpay.exceptions.bill_creation_exception import BillCreationException
-from bitpay.exceptions.bill_delivery_exception import BillDeliveryException
-from bitpay.exceptions.bill_query_exception import BillQueryException
-from bitpay.exceptions.bill_update_exception import BillUpdateException
-from bitpay.exceptions.bitpay_exception import BitPayException
+from bitpay.clients.response_parser import ResponseParser
+from bitpay.exceptions.bitpay_exception_provider import BitPayExceptionProvider
+from bitpay.exceptions.bitpay_generic_exception import BitPayGenericException
 from bitpay.models.bill.bill import Bill
 from bitpay.models.facade import Facade
 from bitpay.utils.token_container import TokenContainer
@@ -16,13 +14,13 @@ class BillClient:
     __token_container = TokenContainer
 
     def __init__(
-        self, bitpay_client: BitPayClient, token_container: TokenContainer
+            self, bitpay_client: BitPayClient, token_container: TokenContainer
     ) -> None:
         self.__bitpay_client = bitpay_client
         self.__token_container = token_container
 
     def create(
-        self, bill: Bill, facade: Facade = Facade.MERCHANT, sign_request: bool = True
+            self, bill: Bill, facade: Facade = Facade.MERCHANT, sign_request: bool = True
     ) -> Bill:
         """
         Create a BitPay Bill.
@@ -32,29 +30,22 @@ def create(
         :param bool sign_request: Signed request.
         :return: A BitPay generated Bill object.
         :rtype: Bill
-        :raises BitPayException
-        :raises BillCreationException
+        :raises BitPayApiException
+        :raises BitPayGenericException
         """
-        try:
-            bill.token = self.__token_container.get_access_token(facade)
-            response_json = self.__bitpay_client.post(
-                "bills", bill.to_json(), sign_request
-            )
-        except BitPayException as exe:
-            raise BillCreationException(
-                "failed to serialize bill object :  %s" % str(exe),
-                api_code=exe.get_api_code(),
-            )
+        bill.token = self.__token_container.get_access_token(facade)
+        response = self.__bitpay_client.post(
+            "bills", bill.to_json(), sign_request
+        )
+        response_json = ResponseParser.response_to_json_string(response)
 
         try:
             return Bill(**response_json)
         except Exception as exe:
-            raise BillCreationException(
-                "failed to deserialize BitPay server response (Bill) : %s" % str(exe)
-            )
+            BitPayExceptionProvider.throw_deserialize_resource_exception("Bill", str(exe))
 
     def get(
-        self, bill_id: str, facade: Facade = Facade.MERCHANT, sign_request: bool = True
+            self, bill_id: str, facade: Facade = Facade.MERCHANT, sign_request: bool = True
     ) -> Bill:
         """
         Retrieve a BitPay bill by bill id using the specified facade.
@@ -64,26 +55,19 @@ def get(
         :param bool sign_request: Signed request.
         :return: A BitPay Bill object.
         :rtype: Bill
-        :raises BitPayException
-        :raises BillQueryException
+        :raises BitPayApiException
+        :raises BitPayGenericException
         """
-        try:
-            params = {"token": self.__token_container.get_access_token(facade)}
-            response_json = self.__bitpay_client.get(
-                "bills/%s" % bill_id, params, sign_request
-            )
-        except BitPayException as exe:
-            raise BillQueryException(
-                "failed to serialize bill object :  %s" % str(exe),
-                api_code=exe.get_api_code(),
-            )
+        params = {"token": self.__token_container.get_access_token(facade)}
+        response = self.__bitpay_client.get(
+            "bills/%s" % bill_id, params, sign_request
+        )
+        response_json = ResponseParser.response_to_json_string(response)
 
         try:
             return Bill(**response_json)
         except Exception as exe:
-            raise BillQueryException(
-                "failed to deserialize BitPay server response" " (Bill) : %s" % str(exe)
-            )
+            BitPayExceptionProvider.throw_deserialize_resource_exception("Bill", str(exe))
 
     def get_bills(self, status: Optional[str] = None) -> List[Bill]:
         """
@@ -92,28 +76,22 @@ def get_bills(self, status: Optional[str] = None) -> List[Bill]:
         :param str status: The status to filter the bills.
         :return: A list of BitPay Bill objects.
         :rtype: [Bill]
-        :raises BitPayException
-        :raises BillQueryException
+        :raises BitPayApiException
+        :raises BitPayGenericException
         """
-        try:
-            params = {"token": self.__token_container.get_access_token(Facade.MERCHANT)}
-            if status is not None:
-                params["status"] = status
-            response_json = self.__bitpay_client.get("bills", params, True)
-        except BitPayException as exe:
-            raise BillQueryException(
-                "failed to serialize bill object :  %s" % str(exe),
-                api_code=exe.get_api_code(),
-            )
+        params = {"token": self.__token_container.get_access_token(Facade.MERCHANT)}
+        if status is not None:
+            params["status"] = status
+        response = self.__bitpay_client.get("bills", params, True)
+        response_json = ResponseParser.response_to_json_string(response)
+
+        bills = []
 
         try:
-            bills = []
             for bill_data in response_json:
                 bills.append(Bill(**bill_data))
         except Exception as exe:
-            raise BillQueryException(
-                "failed to deserialize BitPay server response" " (Bill) : %s" % str(exe)
-            )
+            BitPayExceptionProvider.throw_deserialize_resource_exception("Bill", str(exe))
 
         return bills
 
@@ -125,28 +103,21 @@ def update(self, bill: Bill, bill_id: str) -> Bill:
         :param str bill_id: The Id of the Bill to update.
         :return: An updated Bill object.
         :rtype: Bill
-        :raises BitPayException
-        :raises BillUpdateException
+        :raises BitPayApiException
+        :raises BitPayGenericException
         """
-        try:
-            if bill.token is None:
-                raise BillUpdateException("missing Bill token")
-
-            response_json = self.__bitpay_client.update(
-                "bills/%s" % bill_id, bill.to_json()
-            )
-        except BitPayException as exe:
-            raise BillUpdateException(
-                "failed to serialize bill object :  %s" % str(exe),
-                api_code=exe.get_api_code(),
-            )
+        if bill.token is None:
+            BitPayExceptionProvider.throw_missing_parameter_exception()
+
+        response = self.__bitpay_client.update(
+            "bills/%s" % bill_id, bill.to_json()
+        )
+        response_json = ResponseParser.response_to_json_string(response)
 
         try:
             return Bill(**response_json)
         except Exception as exe:
-            raise BillUpdateException(
-                "failed to deserialize BitPay server response" " (Bill) : %s" % str(exe)
-            )
+            BitPayExceptionProvider.throw_deserialize_resource_exception("Bill", str(exe))
 
     def deliver(self, bill_id: str, bill_token: str) -> bool:
         """
@@ -156,23 +127,17 @@ def deliver(self, bill_id: str, bill_token: str) -> bool:
         :param str bill_token: The token of the requested bill.
         :return: A response status returned from the API.
         :rtype: bool
-        :raises BitPayException
-        :raises BillDeliveryException
+        :raises BitPayApiException
+        :raises BitPayGenericException
         """
-        try:
-            params = {"token": bill_token}
-            response_json = self.__bitpay_client.post(
-                "bills/%s" % bill_id + "/deliveries", params
-            )
-        except BitPayException as exe:
-            raise BillDeliveryException(
-                "failed to serialize bill object :  %s" % str(exe),
-                api_code=exe.get_api_code(),
-            )
+        params = {"token": bill_token}
+        response = self.__bitpay_client.post(
+            "bills/%s" % bill_id + "/deliveries", params
+        )
+        response_json = ResponseParser.response_to_json_string(response)
 
         try:
             return response_json.lower() == "success"
         except Exception as exe:
-            raise BillDeliveryException(
-                "failed to deserialize BitPay server response" " (Bill) : %s" % str(exe)
-            )
+            BitPayExceptionProvider.throw_deserialize_resource_exception("Bill", str(exe))
+            raise BitPayGenericException