Merge pull request #358 from J-Priebe/handle-403

Explicitly handle SENDER_ID_MISMATCH 403 error response

CHANGES.rst

@@ -158,3 +158,7 @@ Unreleased
 - Replace deprecated urllib3.Retry options v2
 
 .. _Łukasz Rogowski: https://github.com/Rogalek
+
+- Explicitly handle 403 SENDER_ID_MISMATCH response
+
+.. _James Priebe: https://github.com/J-Priebe/

pyfcm/baseapi.py

@@ -16,6 +16,7 @@
     AuthenticationError,
     InvalidDataError,
     FCMError,
+    FCMSenderIdMismatchError,
     FCMServerError,
     FCMNotRegisteredError,
 )
@@ -185,12 +186,14 @@ def parse_response(self, response):
         Parses the json response sent back by the server and tries to get out the important return variables
 
         Returns:
-            dict: name (str) - uThe identifier of the message sent, in the format of projects/*/messages/{message_id}
+            dict: name (str) - The identifier of the message sent, in the format of projects/*/messages/{message_id}
 
         Raises:
             FCMServerError: FCM is temporary not available
             AuthenticationError: error authenticating the sender account
             InvalidDataError: data passed to FCM was incorrecly structured
+            FCMSenderIdMismatchError: the authenticated sender is different from the sender registered to the token
+            FCMNotRegisteredError: device token is missing, not registered, or invalid
         """
 
         if response.status_code == 200:
@@ -210,6 +213,10 @@ def parse_response(self, response):
             )
         elif response.status_code == 400:
             raise InvalidDataError(response.text)
+        elif response.status_code == 403:
+            raise FCMSenderIdMismatchError(
+                "The authenticated sender ID is different from the sender ID for the registration token."
+            )
         elif response.status_code == 404:
             raise FCMNotRegisteredError("Token not registered")
         else:

pyfcm/errors.py

@@ -23,6 +23,15 @@ class FCMNotRegisteredError(FCMError):
     pass
 
 
+class FCMSenderIdMismatchError(FCMError):
+    """
+    Sender is not allowed for the given device tokens
+    https://firebase.google.com/docs/reference/fcm/rest/v1/ErrorCode
+    """
+
+    pass
+
+
 class FCMServerError(FCMError):
     """
     Internal server error or timeout error on Firebase cloud messaging server

pyfcm/fcm.py

@@ -41,13 +41,14 @@ def notify(
             timeout (int, optional): Set time limit for the request
 
         Returns:
-            dict: Response from FCM server (`multicast_id`, `success`, `failure`, `canonical_ids`, `results`)
+            dict: name (str) - The identifier of the message sent, in the format of projects/*/messages/{message_id}
 
         Raises:
-            AuthenticationError: If api_key is not set or provided or there is an error authenticating the sender.
-            FCMServerError: Internal server error or timeout error on Firebase cloud messaging server
-            InvalidDataError: Invalid data provided
-            InternalPackageError: Mostly from changes in the response of FCM, contact the project owner to resolve the issue
+            FCMServerError: FCM is temporary not available
+            AuthenticationError: error authenticating the sender account
+            InvalidDataError: data passed to FCM was incorrecly structured
+            FCMSenderIdMismatchError: the authenticated sender is different from the sender registered to the token
+            FCMNotRegisteredError: device token is missing, not registered, or invalid
         """
         payload = self.parse_payload(
             fcm_token=fcm_token,