feat: Change obj field to GenericForeignKey (#73)

* chore: reformat with black
* dep: Upgrade django-json-field backport to 1.0.4
* dep: Upgrade `Django` to >= 2.2

Author: danidee10

docs/conf.py

@@ -30,11 +30,7 @@
 # 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']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

docs/usage.rst

@@ -18,7 +18,8 @@ To Create/Send a notification import the notify function and call it with the fo
         'recipient': recipent_user, 'category': 'Chat',
         'action': 'Sent', 'obj': message.id,
         'short_description': 'You a new message', 'url': url,
-        'channels': ('email', 'websocket', 'slack'), 'silent': True
+        'channels': ('email', 'websocket', 'slack'), 'silent': True,
+        'content_object': self.request.user
     }
     notify(**kwargs)
 
@@ -32,14 +33,14 @@ Notification Fields
 
 The fields in the `args` dictionary map to the fields in the `Notification` model
 
-- **source: A ForeignKey to Django's User model (Can be null if it's not a User to User Notification).**
+- **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: The id of the object associated with the notification (Can be null).**
+- **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 (Can be null).**
+- **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 a dictionary.**
 - **channels: Delivery channels that should be used to deliver the message (Tuple/List)**
@@ -56,8 +57,6 @@ Simply pass in a dictionary as the extra_data argument.
 .. note::
     The dictionary is serialized using python's json module so make sure the dictionary contains objects that can be serialized by the json module
 
-    Internally, the JSON is stored as plain text with django's standard ``TextField``.
-
 
 Writing custom delivery channels
 --------------------------------

notifications/__init__.py

@@ -3,6 +3,7 @@
 
 class NotificationError(Exception):
     """Custom error type for the app."""
+
     pass
 
 

notifications/backends/base.py

@@ -4,7 +4,6 @@
 
 
 class BaseBackend(metaclass=abc.ABCMeta):
-
     def __init__(self, notification):
         self.notification = notification.to_json()
 

notifications/backends/celery.py

@@ -21,7 +21,7 @@
 @shared_task(
     autoretry_for=autoretry_for,
     retry_backoff=settings.NOTIFICATIONS_RETRY_INTERVAL,
-    max_retries=settings.NOTIFICATIONS_MAX_RETRIES
+    max_retries=settings.NOTIFICATIONS_MAX_RETRIES,
 )
 def send_notification(notification, channel_alias):
     """Send notification via a channel to celery."""
@@ -34,5 +34,5 @@ def run(self, countdown):
             send_notification.apply_async(
                 args=[self.notification, channel_alias],
                 queue=settings.NOTIFICATIONS_QUEUE_NAME,
-                countdown=countdown
+                countdown=countdown,
             )

notifications/backends/django_channels.py

@@ -10,7 +10,6 @@
 
 
 class ChannelsBackend(BaseBackend):
-
     def run(self, countdown):
         channel_layer = channels.layers.get_channel_layer(
             settings.NOTIFICATIONS_QUEUE_NAME
@@ -22,6 +21,7 @@ def run(self, countdown):
                 {
                     'notification': self.notification,
                     'countdown': countdown,
-                    'channel_alias': channel_alias, 'type': 'notify'
-                }
+                    'channel_alias': channel_alias,
+                    'type': 'notify',
+                },
             )

notifications/backends/rq.py

@@ -18,16 +18,19 @@
 if settings.NOTIFICATIONS_RETRY:
     retry = Retry(
         max=settings.NOTIFICATIONS_MAX_RETRIES,
-        interval=settings.NOTIFICATIONS_RETRY_INTERVAL
+        interval=settings.NOTIFICATIONS_RETRY_INTERVAL,
     )
 
 
 class RQBackend(BaseBackend):
-
     def run(self, countdown):
         for channel_alias in self.notification['channels']:
             queue = django_rq.get_queue(settings.NOTIFICATIONS_QUEUE_NAME)
             queue.enqueue_in(
-                timedelta(seconds=countdown), _send_notification,
-                self.notification, channel_alias, logger, retry=retry
+                timedelta(seconds=countdown),
+                _send_notification,
+                self.notification,
+                channel_alias,
+                logger,
+                retry=retry,
             )

notifications/backends/synchronous.py

@@ -12,7 +12,6 @@
 
 
 class SynchronousBackend(BaseBackend):
-
     def run(self, countdown):
         for channel_alias in self.notification['channels']:
             time.sleep(countdown)

notifications/backends/utils.py

@@ -16,6 +16,6 @@ def _send_notification(notification, channel_alias, logger):
     message = channel.construct_message()
     channel.notify(message)
     logger.info(
-        'Sent notification with the %s channel. kwargs: %s\n' %
-        (channel_alias, notification)
+        'Sent notification with the %s channel. kwargs: %s\n'
+        % (channel_alias, notification)
     )

notifications/channels/__init__.py

@@ -1,5 +1,6 @@
 from .console import ConsoleChannel  # noqa
 from .base import BaseNotificationChannel  # noqa
+
 try:
     from .channels_websocket import WebSocketChannel  # noqa
 except ImportError: