424 error code returned if one or more notifications fail (#12)

apprise_api/api/tests/test_notify.py

@@ -70,6 +70,50 @@ class NotifyTests(SimpleTestCase):
         assert response.status_code == 200
         assert mock_notify.call_count == 1
 
+    @patch('apprise.NotifyBase.notify')
+    def test_partial_notify_by_loaded_urls(self, mock_notify):
+        """
+        Test notification handling when one or more of the services
+        can not be notified.
+        """
+
+        # our key to use
+        key = 'test_partial_notify_by_loaded_urls'
+
+        # Add some content
+        response = self.client.post(
+            '/add/{}'.format(key),
+            {
+                'urls': ', '.join([
+                    'mailto://user:pass@hotmail.com',
+                    'mailto://user:pass@gmail.com',
+                    ],
+                ),
+            })
+        assert response.status_code == 200
+
+        # Preare our form data
+        form_data = {
+            'body': 'test notifiction',
+        }
+
+        # At a minimum, just a body is required
+        form = NotifyForm(data=form_data)
+        assert form.is_valid()
+
+        # we always set a type if one wasn't done so already
+        assert form.cleaned_data['type'] == apprise.NotifyType.INFO
+
+        # Set our return value; first we return a true, then we fail
+        # on the second call
+        mock_notify.side_effect = (True, False)
+
+        # Send our notification
+        response = self.client.post(
+            '/notify/{}'.format(key), form.cleaned_data)
+        assert response.status_code == 424
+        assert mock_notify.call_count == 2
+
     @patch('apprise.Apprise.notify')
     def test_notify_by_loaded_urls_with_json(self, mock_notify):
         """

apprise_api/api/tests/test_stateless_notify.py

@@ -58,6 +58,33 @@ class StatelessNotifyTests(SimpleTestCase):
         assert response.status_code == 200
         assert mock_notify.call_count == 1
 
+    @patch('apprise.NotifyBase.notify')
+    def test_partial_notify(self, mock_notify):
+        """
+        Test sending multiple notifications where one fails
+        """
+
+        # Set our return value; first we return a true, then we fail
+        # on the second call
+        mock_notify.side_effect = (True, False)
+
+        # Preare our form data
+        form_data = {
+            'urls': ', '.join([
+                'mailto://user:pass@hotmail.com',
+                'mailto://user:pass@gmail.com',
+                ]),
+            'body': 'test notifiction',
+        }
+
+        # At a minimum 'body' is requred
+        form = NotifyByUrlForm(data=form_data)
+        assert form.is_valid()
+
+        response = self.client.post('/notify', form.cleaned_data)
+        assert response.status_code == 424
+        assert mock_notify.call_count == 2
+
     @override_settings(APPRISE_STATELESS_URLS="windows://")
     @patch('apprise.Apprise.notify')
     def test_notify_default_urls(self, mock_notify):

apprise_api/api/views.py

@@ -80,6 +80,7 @@ class ResponseCode(object):
     bad_request = 400
     not_found = 404
     method_not_allowed = 405
+    failed_dependency = 424
     internal_server_error = 500
 
 
@@ -407,13 +408,20 @@ class NotifyView(View):
                 a_obj.add(ac_obj)
 
                 # Perform our notification at this point
-                a_obj.notify(
+                result = a_obj.notify(
                     content.get('body'),
                     title=content.get('title', ''),
                     notify_type=content.get('type', apprise.NotifyType.INFO),
                     tag=content.get('tag'),
                 )
 
+                if not result:
+                    # If at least one notification couldn't be sent; change up
+                    # the response to a 424 error code
+                    return HttpResponse(
+                        _('One or more notification could not be sent.'),
+                        status=ResponseCode.failed_dependency)
+
         except OSError:
             # We could not write the temporary file to disk
             return HttpResponse(
@@ -488,13 +496,20 @@ class StatelessNotifyView(View):
             )
 
         # Perform our notification at this point
-        a_obj.notify(
+        result = a_obj.notify(
             content.get('body'),
             title=content.get('title', ''),
             notify_type=content.get('type', apprise.NotifyType.INFO),
             tag='all',
         )
 
+        if not result:
+            # If at least one notification couldn't be sent; change up the
+            # response to a 424 error code
+            return HttpResponse(
+                _('One or more notification could not be sent.'),
+                status=ResponseCode.failed_dependency)
+
         # Return our retrieved content
         return HttpResponse(
             _('Notification(s) sent.'),