Add django sms backend (#80)

* Add django sms backend

Author: danidee10

docs/backends.rst

@@ -131,8 +131,10 @@ The ``sqs-lambda-worker`` folder includes four files that are of interest:
 
 You can use this file (after renaming it to ``.env``) to configure the environment variables for the autogenerated Lambda function.
 You can replace this step by:
-    - Configuring the environment variables in your CI/CD environment **(Recommended)**
-    - Exporting them in the current shell.
+
+    * Configuring the environment variables in your CI/CD environment **(Recommended)**
+    * Exporting them in the current shell.
+
 This is useful if you want to test the serverless deployment locally before moving it to your CI/CD
 
 ``requirements.txt``

docs/conf.py

@@ -17,20 +17,31 @@
 
 # -- Project information -----------------------------------------------------
 
+import os
+import sys
+
+import django
+
 project = 'django-notifs'
 copyright = '2021, Daniel Osaetin'
 author = 'Daniel Osaetin'
 
-# The full version, including alpha/beta/rc tags
-release = '2.6.4'
+sys.path.append(os.path.abspath('../../'))
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'notifs.settings')
+django.setup()
 
 
 # -- General configuration ---------------------------------------------------
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ['m2r2', 'sphinx_rtd_theme', 'sphinx.ext.autosectionlabel']
+extensions = [
+    'm2r2',
+    'sphinx_rtd_theme',
+    'sphinx.ext.autosectionlabel',
+    'sphinx.ext.autodoc',
+]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

docs/providers.rst

@@ -1,23 +1,27 @@
 Providers
 **************
 
-.. _documentation: https://channels.readthedocs.io/en/stable/index.html
-.. _channels deployment documentation: https://channels.readthedocs.io/en/stable/deploying.html
+.. module:: notifications.providers
+
+.. _django-sms: https://django-sms.readthedocs.io/en/stable/
+.. _django-sms documentation: https://django-sms.readthedocs.io/en/stable/
 
 Django notifs comes with a set of inbuilt providers. These providers are typically classes that accept a payload
-and contain the logic for delivery that payload to an external service.
+and contain the logic for delivering the payload to an external service.
 
 Below are the list of supported providers:
 
 
 Email
 =====
 
-The email provider uses the standard ``django.core.mail`` module.
-This opens up support for multiple ESP's (Mailjet, Mailchimp, sendgrid etc)
+.. autoclass:: EmailNotificationProvider
 
 name: ``'email'``
 
+The email provider uses the standard ``django.core.mail`` module.
+This opens up support for multiple ESP's (Mailjet, Mailchimp, sendgrid etc)
+
 
 Installation
 ------------
@@ -30,7 +34,7 @@ Optional dependency for django-anymail::
 Settings
 --------
 
-If you use ``django-anymail`` or a custom Email backend, all you have to do configure the settings as you'd
+If you use ``django-anymail`` or a custom Email backend, all you have to do configure the settings and dependencies as you'd
 normally do and the email provider should pick it up.
 
 
@@ -55,14 +59,58 @@ Single::
 
 ``extra_esp`` is any extra data that you want to pass to your custom Email backend.
 
-
-|
 |
 
+SMS (with django-sms)
+=====================
+
+.. autoclass:: DjangoSMSNotificationProvider
+
+name: ``'django_sms'``
+
+The SMS provider uses a third-party app called `django-sms`_ this also opens up support for multiple SMS providers.
+
+Supported providers are:
+
+* Twilio
+* Message bird
+
+
+Installation
+------------
+
+::
+
+    pip install django-notifs[sms]
+
+Extra dependencies can be installed by::
+
+    pip install django-sms[twilio,messagebird]
+
+Settings
+--------
+
+See the `django-sms documentation`_ for more information on how to configure your preferred backend. Once it is configured,
+``django-notifs`` should pick it up
+
+Payload
+-------
+
+Single::
+
+    {
+        'body': 'Sample message',
+        'originator': '+10000000000',
+        'recipients': ['+20000000000', '+30000000000']  # list of recipients
+    }
+
+|
 
 Slack
 =====
 
+.. autoclass:: SlackNotificationProvider
+
 name: ``'slack'``
 
 
@@ -90,13 +138,13 @@ Single::
         'text': 'message',
     }
 
-
-|
 |
 
 Pusher Channels
 ===============
 
+.. autoclass:: PusherChannelsNotificationProvider
+
 name: ``'pusher_channels'``
 
 Installation
@@ -125,11 +173,12 @@ Single::
     }
 
 |
-|
 
 FCM (Firebase Web push)
 =======================
 
+.. autoclass:: FCMWebNotificationProvider
+
 name: ``'fcm_web'``
 
 Settings
@@ -153,11 +202,12 @@ Single::
     }
 
 |
-|
 
 django-channels
 ===============
 
+.. autoclass:: DjangoChannelsNotificationProvider
+
 name: ``'django_channels'``
 
 Installation
@@ -206,6 +256,9 @@ Single::
         'message': {},
     }
 
+|
+|
+
 Writing custom Providers
 ========================
 

docs/usage.rst

@@ -91,19 +91,21 @@ or::
 
 
 Notification Model
------------------
+------------------
 
 Django notifs includes an inbuilt notification model with the following fields:
 
 * **source: A ForeignKey to Django's User model (optional if it's not a User to User Notification).**
 * **source_display_name: A User Friendly name for the source of the notification.**
+
 - **recipient: The Recipient of the notification. It's a ForeignKey to Django's User model.**
 - **category: Arbitrary category that can be used to group messages.**
 - **action: Verbal action for the notification E.g Sent, Cancelled, Bought e.t.c**
 - **obj: An arbitrary object associated with the notification using the `contenttypes` app (optional).**
 - **short_description: The body of the notification.**
 - **url: The url of the object associated with the notification (optional).**
 - **silent: If this Value is set, the notification won't be persisted to the database.**
+
 * **extra_data: Arbitrary data as in a JSONField.**
 * **channels: Notification channels related to the notification (Tuple/List in a JSONField)**
 

notifications/providers/__init__.py

@@ -8,16 +8,21 @@
     pass
 
 try:
-    from .fcm import FCMWebNotificationProvider  # noqa
+    from .fcm_web import FCMWebNotificationProvider  # noqa
+except ImportError as e:
+    raise Exception(e)
+
+try:
+    from .django_channels import DjangoChannelsNotificationProvider  # noqa
 except ImportError:
     pass
 
 try:
-    from .django_channels import DjangoChannelsProvider  # noqa
+    from .slack import SlackNotificationProvider  # noqa
 except ImportError:
     pass
 
 try:
-    from .slack import SlackNotificationProvider  # noqa
+    from .django_sms import DjangoSMSNotificationProvider  # noqa
 except ImportError:
     pass

notifications/providers/django_channels.py

@@ -6,7 +6,7 @@
 from .base import BaseNotificationProvider
 
 
-class DjangoChannelsProvider(BaseNotificationProvider):
+class DjangoChannelsNotificationProvider(BaseNotificationProvider):
     """django-channels websocket provider"""
 
     name = 'django_channels'

notifications/providers/django_sms.py

@@ -0,0 +1,24 @@
+from sms import Message, get_connection
+
+from . import BaseNotificationProvider
+
+
+class DjangoSMSNotificationProvider(BaseNotificationProvider):
+    name = 'django_sms'
+
+    @staticmethod
+    def _get_sms_message(payload):
+        message = Message()
+        for key, value in payload.items():
+            setattr(message, key, value)
+
+        return message
+
+    def send(self, payload):
+        sms_message = self._get_sms_message(payload)
+        sms_message.send()
+
+    def send_bulk(self, payloads):
+        messages = (self._get_sms_message(payload) for payload in payloads)
+        connection = get_connection()
+        connection.send_messages(messages)

requirements.txt

@@ -2,12 +2,13 @@ celery==4.1.0
 channels==3.0.3
 channels-redis==3.2.0
 django-anymail==8.4
+django-sms[twilio,messagebird]==0.5.0
 docutils<=0.16
 django-jsonfield-backport==1.0.4
 django-rq==2.4.0
 m2r2==0.2.7
-pusher==3.0.0
 pre-commit==2.15.0
+pusher==3.0.0
 pytz==2017.2
 requests==2.25.1
 slack_sdk==3.11.2

setup.py

@@ -30,6 +30,7 @@
     'pusher_channels': ['pusher>=3.0.0'],
     'slack': ['slack_sdk>=3.11.2'],
     'anymail': ['django-anymail>=8.4'],
+    'sms': ['django-sms>=0.5.0'],
 }
 EXCLUDE = ['notifs', 'tests', '*.tests', '*.tests.*', 'tests.*']