Merge pull request #825 from ubyssey/492-push-notifications

492 push notifications

Author: JamieRL

dispatch/api/exceptions.py

@@ -25,6 +25,10 @@ class InvalidPoll(APIException):
     status_code = status.HTTP_400_BAD_REQUEST
     default_detail = 'Invalid poll'
 
+class AlreadySubscribed(APIException):
+    status_code = status.HTTP_202_ACCEPTED
+    default_detail = 'User is already subscribed'
+
 class UnpermittedActionError(APIException):
     status_code = status.HTTP_401_UNAUTHORIZED
     default_detail = 'You do not have permission to perform this action'

dispatch/api/mixins.py

@@ -1,10 +1,16 @@
+import json
+from pywebpush import webpush, WebPushException
+from django.utils import timezone
+
 from rest_framework.response import Response
 from rest_framework.decorators import detail_route
 from rest_framework.viewsets import ModelViewSet
 from rest_framework.serializers import HyperlinkedModelSerializer
+from django.conf import settings
 from django.db.models import F
 
 from dispatch.core.signals import post_create, post_update, post_publish, post_unpublish
+from dispatch.models import Subscription, Notification, Article
 
 class DispatchModelViewSet(ModelViewSet):
     """Custom viewset to add Dispatch signals to default ModelViewSet"""
@@ -70,6 +76,13 @@ def publish(self, request, parent_id=None):
 
         self.perform_publish(serializer)
 
+        if isinstance(instance, Article):
+            if instance.is_breaking:
+                self.push_notification(instance)
+            elif instance.scheduled_notification is not None and instance.scheduled_notification > timezone.now():
+                Notification.objects.filter(article__parent_id=instance.parent_id).delete()
+                Notification.objects.create(article=instance, scheduled_push_time=instance.scheduled_notification)
+
         return Response(serializer.data)
 
     @detail_route(methods=['post'])
@@ -83,6 +96,42 @@ def unpublish(self, request, parent_id=None):
 
         return Response(serializer.data)
 
+    @classmethod
+    def push_notification(self, article):
+        # grab each endpoint from list in database and make a push
+        data = {
+            'headline': article.headline,
+            'url': article.get_absolute_url(),
+            'snippet': article.snippet,
+            'tag': 'ubyssey'
+        }
+
+        if article.is_breaking:
+            data['tag'] = 'breaking'
+        if article.featured_image is not None:
+            data['image'] = article.featured_image.image.get_thumbnail_url()
+
+        subscriptions = Subscription.objects.all()
+        for sub in subscriptions:
+            try:
+                webpush(
+                    subscription_info={
+                        "endpoint": sub.endpoint,
+                        "keys": {
+                            "p256dh": sub.p256dh,
+                            "auth": sub.auth
+                        }},
+                    data=json.dumps(data),
+                    vapid_private_key=settings.NOTIFICATION_KEY,
+                    vapid_claims={
+                            "sub": "mailto:[email protected]===",
+                        }
+                )
+            except WebPushException as ex:
+                if ex.response.status_code == 410:
+                    sub.delete()
+
+
 class DispatchModelSerializer(HyperlinkedModelSerializer):
     def __init__(self, *args, **kwargs):
         # Override default constructor to call hide_authenticated_fields

dispatch/api/serializers.py

@@ -3,8 +3,9 @@
 from rest_framework.validators import UniqueValidator
 
 from dispatch.modules.content.models import (
-    Article, Image, ImageAttachment, ImageGallery, Issue,
-    File, Page, Author, Section, Tag, Topic, Video, VideoAttachment, Poll, PollAnswer, PollVote)
+    Article, Image, ImageAttachment, ImageGallery, Issue, Subscription,
+    File, Page, Author, Section, Tag, Topic, Video, VideoAttachment,
+    Poll, PollAnswer, PollVote, Notification, SubscriptionCount)
 from dispatch.modules.auth.models import Person, User, Invite
 from dispatch.admin.registration import send_invitation
 from dispatch.theme.exceptions import WidgetNotFound, InvalidField
@@ -563,6 +564,7 @@ class ArticleSerializer(DispatchModelSerializer, DispatchPublishableSerializer):
 
     integrations = JSONField(required=False)
 
+    scheduled_notification = serializers.DateTimeField(required=False, allow_null=True)
     currently_breaking = serializers.BooleanField(source='is_currently_breaking', read_only=True)
 
     class Meta:
@@ -578,6 +580,7 @@ class Meta:
             'content',
             'authors',
             'author_ids',
+            'scheduled_notification',
             'tags',
             'tag_ids',
             'topic',
@@ -630,6 +633,7 @@ def update(self, instance, validated_data):
 
         # Update basic fields
         instance.headline = validated_data.get('headline', instance.headline)
+        instance.scheduled_notification = validated_data.get('scheduled_notification', instance.scheduled_notification)
         instance.section_id = validated_data.get('section_id', instance.section_id)
         instance.slug = validated_data.get('slug', instance.slug)
         instance.snippet = validated_data.get('snippet', instance.snippet)
@@ -642,7 +646,7 @@ def update(self, instance, validated_data):
         instance.integrations = validated_data.get('integrations', instance.integrations)
         instance.template = template
         instance.template_data = template_data
-        
+
         instance.save()
 
         instance.content = validated_data.get('content', instance.content)
@@ -926,3 +930,50 @@ def update(self, instance, validated_data, is_new=False):
             instance.save_answers(answers, is_new)
 
         return instance
+
+class SubscriptionSerializer(DispatchModelSerializer):
+    """Serializes the Subscription model."""
+
+    endpoint = serializers.CharField(required=True, write_only=True)
+    auth = serializers.CharField(required=True, write_only=True)
+    p256dh = serializers.CharField(required=True, write_only=True)
+
+    class Meta:
+        model = Subscription
+        fields = (
+            'id',
+            'endpoint',
+            'auth',
+            'p256dh'
+        )
+
+class NotificationSerializer(DispatchModelSerializer):
+    """Serializes the Notification model."""
+
+    article_id = serializers.IntegerField()
+    created_at = serializers.DateTimeField(read_only=True)
+    scheduled_push_time = serializers.DateTimeField(required=True)
+    article_headline = serializers.CharField(source='get_article_headline', read_only=True)
+
+    class Meta:
+        model = Notification
+        fields = (
+            'id',
+            'created_at',
+            'article_id',
+            'article_headline',
+            'scheduled_push_time'
+        )
+
+class SubscriptionCountSerializer(DispatchModelSerializer):
+    """Serializes the SubscriptionCount model."""
+
+    date = serializers.DateTimeField(read_only=True)
+
+    class Meta:
+        model = SubscriptionCount
+        fields = (
+            'id',
+            'count',
+            'date'
+        )

dispatch/api/urls.py

@@ -26,12 +26,14 @@
 router.register(r'videos', views.VideoViewSet, base_name='api-videos')
 router.register(r'invites', views.InviteViewSet, base_name='api-invites')
 router.register(r'polls', views.PollViewSet, base_name='api-polls')
+router.register(r'notifications', views.NotificationsViewSet, base_name='api-notifications')
+router.register(r'subscriptioncount', views.SubscriptionCountViewSet, base_name='api-subscriptioncount')
 
 dashboard_recent_articles = views.DashboardViewSet.as_view({'get': 'list_recent_articles'})
 dashboard_user_actions = views.DashboardViewSet.as_view({'get': 'list_actions'})
 
 urlpatterns = format_suffix_patterns([
     # Dashboard routes
     url(r'^dashboard/recent', dashboard_recent_articles, name='dashboard_recent_articles'),
-    url(r'^dashboard/actions', dashboard_user_actions, name='dashboard_user_actions')
+    url(r'^dashboard/actions', dashboard_user_actions, name='dashboard_user_actions'),
 ]) + router.urls

dispatch/api/views.py

@@ -1,14 +1,20 @@
+import json
+import datetime
+
+from pywebpush import webpush, WebPushException
+
 from django.db.models import Q, ProtectedError, Prefetch
-from django.contrib.auth import authenticate
 from django.conf import settings
+from django.contrib.auth import authenticate
 from django.db import IntegrityError
+from django.utils import timezone
 
 from rest_framework import viewsets, mixins, filters, status
 from rest_framework.response import Response
 from rest_framework.permissions import (
     AllowAny, IsAuthenticated, DjangoModelPermissions)
 from rest_framework.decorators import (
-    detail_route, api_view, authentication_classes, permission_classes)
+    list_route, detail_route, api_view, authentication_classes, permission_classes)
 from rest_framework.generics import get_object_or_404
 from rest_framework.exceptions import APIException, NotFound
 from rest_framework.authtoken.models import Token
@@ -20,7 +26,8 @@
 from dispatch.models import (
     Article, File, Image, ImageAttachment, ImageGallery, Issue,
     Page, Author, Person, Section, Tag, Topic, User, Video,
-    Poll, PollAnswer, PollVote, Invite)
+    Poll, PollAnswer, PollVote, Invite, Notification, Subscription,
+    SubscriptionCount)
 
 from dispatch.core.settings import get_settings
 from dispatch.admin.registration import reset_password
@@ -31,10 +38,11 @@
     FileSerializer, IssueSerializer, ImageGallerySerializer, TagSerializer,
     TopicSerializer, PersonSerializer, UserSerializer, IntegrationSerializer,
     ZoneSerializer, WidgetSerializer, TemplateSerializer, VideoSerializer,
-    PollSerializer, PollVoteSerializer, InviteSerializer)
+    PollSerializer, PollVoteSerializer, NotificationSerializer, InviteSerializer,
+    SubscriptionSerializer, SubscriptionCountSerializer)
 from dispatch.api.exceptions import (
     ProtectedResourceError, BadCredentials, PollClosed, InvalidPoll,
-    UnpermittedActionError)
+    UnpermittedActionError, AlreadySubscribed)
 
 from dispatch.theme import ThemeManager
 from dispatch.theme.exceptions import ZoneNotFound, TemplateNotFound
@@ -87,7 +95,7 @@ def get_queryset(self):
                 'authors'
             )
 
-        queryset = queryset.order_by('-updated_at') 
+        queryset = queryset.order_by('-updated_at')
 
         q = self.request.query_params.get('q', None)
         section = self.request.query_params.get('section', None)
@@ -99,7 +107,7 @@ def get_queryset(self):
 
         if section is not None:
             queryset = queryset.filter(section_id=section)
-        
+
         if tags is not None:
             for tag in tags:
                 queryset = queryset.filter(tags__id=tag)
@@ -387,6 +395,78 @@ def vote(self, request, pk=None):
 
         return Response(serializer.data)
 
+class SubscriptionCountViewSet(DispatchModelViewSet):
+    """Viewset for the SubscriptionCount model views."""
+
+    model = SubscriptionCount
+    serializer_class = SubscriptionCountSerializer
+    queryset = SubscriptionCount.objects.filter(date__gte=timezone.now() - datetime.timedelta(days=90)).order_by('-date')
+
+    def get_permissions(self):
+        """
+        Instantiates and returns the list of permissions that this view requires.
+        """
+        if self.action == 'create':
+            permission_classes = [AllowAny,]
+        else:
+            permission_classes = [IsAuthenticated,]
+        return [permission() for permission in permission_classes]
+
+    def create(self, request):
+        try:
+            subscription_count = Subscription.objects.all().count()
+            data = {
+                'count': subscription_count
+            }
+            serializer = SubscriptionCountSerializer(data=data)
+            serializer.is_valid(raise_exception=True)
+            serializer.save()
+
+            return Response({ 'detail': 'Subscriber count recorded' })
+        except:
+            return Response({ 'detail': 'Subscriber count for today has already been created' }, status.HTTP_400_BAD_REQUEST)
+
+class NotificationsViewSet(DispatchModelViewSet):
+    """Viewset for the Poll model views."""
+
+    model = Notification
+    serializer_class = NotificationSerializer
+    permission_classes = (IsAuthenticated,)
+    queryset = Notification.objects.all().order_by('scheduled_push_time')
+
+    @detail_route(permission_classes=[AllowAny], methods=['post', 'patch'],)
+    def subscribe(self, request, pk=None):
+        data = {
+            'endpoint': request.data['endpoint'],
+            'auth': request.data['keys']['auth'],
+            'p256dh': request.data['keys']['p256dh'],
+        }
+
+        try:
+            serializer = SubscriptionSerializer(data=data)
+            serializer.is_valid(raise_exception=True)
+            serializer.save()
+            return Response(serializer.data)
+        except:
+            raise AlreadySubscribed()
+
+        return Response(serializer.data)
+
+    @list_route(permission_classes=[AllowAny], methods=['post'],)
+    def push(self, request):
+        notification = Notification.objects \
+        .filter(scheduled_push_time__lte=timezone.now()) \
+        .order_by('scheduled_push_time') \
+        .first()
+
+        if notification is not None:
+            article = Article.objects.get(parent__id=notification.article.parent_id, is_published=True)
+            if article is not None:
+                DispatchPublishableMixin.push_notification(article)
+                notification.delete()
+
+        return Response(status=status.HTTP_200_OK)
+
 class TemplateViewSet(viewsets.GenericViewSet):
     """Viewset for Template views."""
     permission_classes = (IsAuthenticated,)