Added Simplepush. Closed #10 (#15)

* Added simplepush provider

* Added tests

* Updated readme

* Added negative test

* Revert "Added negative test"

This reverts commit 811d96f

.travis.yml

@@ -16,6 +16,8 @@ env:
   - secure: "eKxRf8pUHoCOx1ror0VQuQ53BIR0fM0QeeYobANJjlKQNsnbY80VWilWN0Bn1532ObqynTlBUqlq8jJge4ho3emz01BBAvSDddg4/037EoP64vpNzEWxxorR8jop8rfDpbh3917Gqd8NzAOf8v4PkVJq+wB3c0DV/BE/SV6v5cdnsTa8GAJM6zQpj2Sg2kgGHoAaT37npD5q4zKTqpJT1WgAht9RJ3Od10aBT8QABz+wpUVLxg9FnthmznbgO9seeZhctTGuCSj1TAz/XQjJD8fS8XiEjhwAoTmJec58Zqk6pjhEnWV9L91Z9s4ICyN2+tnrjOSl5apo98nRZ8yappSwilLCjQ4VhlSdOCwLv/LjN2HT+XTQS/W068wuEtSkbLMoV2eE87wD86iiiIBMax9I5Kw69xYZk7kNQYzxlrBYk9lj3vlrI8YwXBnHdaIWyZlWgNSQy9vsk2ZIxSBLdeKj+z2DNBqJ3UMn636oncgPvphZBhmrbeSBS5jcc2hwdCGtcbWvRNKmKcP8xa02Nfv1zCTSW2T3IdI7XfTEX7WUwEMy1heuCgTXdm4XBT3Uemte4AOKVKgamT/6bchlo+tFBQSK6ot841GMPYftVNTjcLUlJYr5mUJkotRY6uQK/vvpBWI4eAWM58GwidG5Oi3whZiAGKl8Xv0M1SXlAuI="
   # Pushover token
   - secure: "i0/6+uzOG63I119PodRGXlB7edSIsNfQo5C9F/WGS45hVzdPCTfxn8pCzpd9lEaYQU5SGxp7ZdkjGfx0DjrQPxk5M352eLi1eWvEQn+S7628j//mZtYnfWk/716uKThfLP+zEU3Kl1swJyBkxYEUu0M2SUPvhFjEX7Ss7H416xgnmFX5omEScR8WrIoVACvbhgQoqWgnv4urRt+MmJh5D254lEU3TXnf1wc3o8J+ocg2pigQyExCYE0xxhQAq07Sjb1jHi0x0sfYRR2Ir5O5fsropm1ndDCtMk1eEMJUFSbvANkeqXet5XBNybb6FyfEDpQQ//ZDyKYouPZioWLjfYqw0Yq1yTKHLhnO732BoJBPQxTEt1ZnaA6/MJXK8ok18V/LTyIQuTbioMKHCkKumH1gZKCbTbITzX8hgdcEcCV1hANAR56Ew+gWjlj5EpupgB4mL7KLG83xPHQhVheuUc5tQv8QLCpEidpHX6iEktx+KAfzVIX7GS3vfvNzr3svfTEVOq3odgW09l1D5QXXzpjuNuGbiWeQkDiqrQp+niLPMXzC7Sv01AfwwybJ8DkYBwPbjmOMRXy7T/g683ERmHrVnbHnqWVdzBgrnPCHIzBxpu6G5AqQNqNtxTYWxALZr87W1bH6POUzKRXdYnJizpFqC615LcxiwipNlo+jCR0="
+  # simplepush key
+  - secure: "uzVKtIPLvba+3Y9l9RBW1faW3jORG6Reu5AteKnzBmrj1ielNhrrXVB5WS7AMMO7+HNxl/e12nIQk3DVW8kpPQqA8S0ngCe3UrVQZQvJU5NWiVrb4RSxr8NGjqxAdcu5Yj/0mzzGnXpLDT1FMDy5l/ZFzOHQOIw9XVoKCLy536SyJh5/Y7XNr9prflikUtAUvkkZJZ12kXBY4AbZKcbotTDT63f6EUvWIRwDNNeGeJT7mfbsx+H7Qzy6X/F84r47Lt34WxWuIbWduvQ1rnge95J4y2aihMI4x3qgEU46dSghVhpLEkNcb6S2PMxrd2Z7XKQrMpmWY+yk0etJzulKQ0TF8n2Wi/3zGC0NRQ7pbViCvWz/OOx8DJmM8t450MIJ5CZbbFQatMFTlaaVQ95/m4+sIdOteanLIW9hl7fclb0zH7n6RgxdPAvRlxEXx+B1DI5tfPgXI4pDLOyfhck1D3vXhwVGU1lvgnGBah5lfoHn8Rm5fRYtiQejxbRmhMSDX7cYXB+ecOoSHrKi00/NGQ3RB3DIXqUiSvJ+008Li07NIZkvD6L/3/FCniUExZVyLzLhppmJojwmxg/Z/xPQT9zS3yYD+q2U/DEe3CsdhuvD1Rk9BZfH+DwsiN+fF9sK2kMn4EW0DtWtPyy8hDQKnXqIqv3fiPBDjZEFyhz9SQg="
 script: pytest --cov=./
 after_success:
   codecov

README.rst

@@ -157,6 +157,7 @@ Supported providers
 -------------------
 
 - `Pushover <https://pushover.net/>`_
+- `Simplepush <https://simplepush.io/>`_
 
 In the near future
 ------------------

notifiers/providers/__init__.py

@@ -1,5 +1,6 @@
-from . import pushover
+from . import pushover, simplepush
 
 _all_providers = {
-    'pushover': pushover.Pushover
+    'pushover': pushover.Pushover,
+    'simplepush': simplepush.SimplePush
 }

notifiers/providers/simplepush.py

@@ -0,0 +1,48 @@
+import requests
+
+from ..core import Provider, Response
+
+
+class SimplePush(Provider):
+    base_url = 'https://api.simplepush.io/send'
+    site_url = 'https://simplepush.io/'
+    provider_name = 'simplepush'
+
+    @property
+    def schema(self):
+        return {
+            'type': 'object',
+            'properties': {
+                'key': {'type': 'string',
+                        'title': 'your user key'},
+                'message': {'type': 'string',
+                            'title': 'your message'},
+            },
+            'required': ['key', 'message'],
+            'additionalProperties': False
+        }
+
+    def _prepare_data(self, data: dict):
+        data['msg'] = data.pop('message')
+        return data
+
+    def _send_notification(self, data):
+        status = 'Success'
+        errors = []
+        response = None
+        try:
+            response = requests.post(self.base_url, data=data)
+            response.raise_for_status()
+        except requests.RequestException as e:
+            status = 'Failure'
+            if e.response is not None:
+                response = e.response
+                errors = [response.json()['message']]
+            else:
+                errors.append(str(e))
+        finally:
+            return Response(status=status,
+                            provider=self.provider_name,
+                            data=data,
+                            response=response,
+                            errors=errors)

tests/providers/test_simplepush.py

@@ -0,0 +1,36 @@
+import pytest
+
+from notifiers import get_notifier
+from notifiers.exceptions import BadArguments, NotificationError
+
+
+class TestSimplePush(object):
+    """SimplePush notifier tests
+
+    Note: These tests assume correct environs set for NOTIFIERS_SIMPLEPUSH_KEY
+    """
+
+    def test_simplepush_metadata(self):
+        p = get_notifier('simplepush')
+        assert p.metadata == {'base_url': 'https://api.simplepush.io/send',
+                              'site_url': 'https://simplepush.io/',
+                              'provider_name': 'simplepush'}
+
+    @pytest.mark.parametrize('data, message', [
+        ({}, 'key'),
+        ({'key': 'foo'}, 'message'),
+    ])
+    def test_simplepush_missing_required(self, data, message):
+        p = get_notifier('simplepush')
+        data['env_prefix'] = 'test'
+        with pytest.raises(BadArguments) as e:
+            p.notify(**data)
+        assert f'\'{message}\' is a required property' in e.value.message
+
+    @pytest.mark.online
+    def test_simplepush_sanity(self):
+        """Successful simplepush notification"""
+        p = get_notifier('simplepush')
+        data = {'message': 'foo'}
+        rsp = p.notify(**data)
+        rsp.raise_on_errors()