Move notifications into customer app

oscar/__init__.py

@@ -36,7 +36,6 @@ OSCAR_CORE_APPS = [
     'oscar.apps.checkout',
     'oscar.apps.shipping',
     'oscar.apps.catalogue',
-    'oscar.apps.notifications',
     'oscar.apps.catalogue.reviews',
     'oscar.apps.basket',
     'oscar.apps.payment',

oscar/apps/customer/abstract_models.py

@@ -116,3 +116,44 @@ class AbstractCommunicationEventType(models.Model):
 
     def is_user_related(self):
         return self.category == self.USER_RELATED
+
+
+class AbstractNotification(models.Model):
+    recipient = models.ForeignKey('auth.User', related_name='notifications',
+                                  db_index=True)
+
+    # Not all notifications will have a sender.
+    sender = models.ForeignKey('auth.User', null=True)
+
+    # HTML is allowed in this field as it can contain links
+    subject = models.CharField(max_length=255)
+    body = models.TextField()
+
+    # Some projects may want to categorise their notifications.  You may want
+    # to use this field to show a different icons next to the notification.
+    category = models.CharField(max_length=255, null=True)
+
+    INBOX, ARCHIVE = 'Inbox', 'Archive'
+    choices = (
+        (INBOX, _(INBOX)),
+        (ARCHIVE, _(ARCHIVE)))
+    location = models.CharField(max_length=32, choices=choices,
+                                default=INBOX)
+
+    date_sent = models.DateTimeField(auto_now_add=True)
+    date_read = models.DateTimeField(null=True)
+
+    class Meta:
+        ordering = ('-date_sent',)
+        abstract = True
+
+    def __unicode__(self):
+        return self.subject
+
+    def archive(self):
+        self.location = self.ARCHIVE
+        self.save()
+
+    @property
+    def is_read(self):
+        return self.date_read is not None

oscar/apps/customer/app.py

@@ -2,7 +2,8 @@ from django.conf.urls import patterns, url
 from django.contrib.auth.decorators import login_required
 from django.views import generic
 
-from oscar.apps.customer import views, notification_views
+from oscar.apps.customer import views
+from oscar.apps.customer.notifications import views as notification_views
 from oscar.core.application import Application
 
 

oscar/apps/customer/models.py

@@ -1,4 +1,5 @@
-from oscar.apps.customer.abstract_models import AbstractEmail, AbstractCommunicationEventType
+from oscar.apps.customer.abstract_models import (
+    AbstractEmail, AbstractCommunicationEventType, AbstractNotification)
 
 
 class Email(AbstractEmail):
@@ -9,4 +10,8 @@ class CommunicationEventType(AbstractCommunicationEventType):
     pass
 
 
+class Notification(AbstractNotification):
+    pass
+
+
 from oscar.apps.customer.history_helpers import *

oscar/apps/notifications/context_processors.py → oscar/apps/customer/notifications/context_processors.py

@@ -1,6 +1,6 @@
 from django.db.models import get_model
 
-Notification = get_model('notifications', 'Notification')
+Notification = get_model('customer', 'Notification')
 
 
 def notifications(request):

oscar/apps/customer/services.py → oscar/apps/customer/notifications/services.py

@@ -1,6 +1,6 @@
 from django.db.models import get_model
 
-Notification = get_model('notifications', 'Notification')
+Notification = get_model('customer', 'Notification')
 
 
 def notify_user(user, msg, category=None):

oscar/apps/customer/notification_views.py → oscar/apps/customer/notifications/views.py

@@ -9,7 +9,7 @@ from django.db.models import get_model
 
 from oscar.views.generic import BulkEditMixin
 
-Notification = get_model('notifications', 'Notification')
+Notification = get_model('customer', 'Notification')
 
 
 class NotificationListView(generic.ListView):

oscar/apps/notifications/abstract_models.py

@@ -1,43 +0,0 @@
-from django.db import models
-from django.utils.translation import ugettext_lazy as _
-
-
-class AbstractNotification(models.Model):
-    recipient = models.ForeignKey('auth.User', related_name='notifications',
-                                  db_index=True)
-
-    # Not all notifications will have a sender.
-    sender = models.ForeignKey('auth.User', null=True)
-
-    # HTML is allowed in this field as it can contain links
-    subject = models.CharField(max_length=255)
-    body = models.TextField()
-
-    # Some projects may want to categorise their notifications.  You may want
-    # to use this field to show a different icons next to the notification.
-    category = models.CharField(max_length=255, null=True)
-
-    INBOX, ARCHIVE = 'Inbox', 'Archive'
-    choices = (
-        (INBOX, _(INBOX)),
-        (ARCHIVE, _(ARCHIVE)))
-    location = models.CharField(max_length=32, choices=choices,
-                                default=INBOX)
-
-    date_sent = models.DateTimeField(auto_now_add=True)
-    date_read = models.DateTimeField(null=True)
-
-    class Meta:
-        ordering = ('-date_sent',)
-        abstract = True
-
-    def __unicode__(self):
-        return self.subject
-
-    def archive(self):
-        self.location = self.ARCHIVE
-        self.save()
-
-    @property
-    def is_read(self):
-        return self.date_read is not None

oscar/apps/notifications/models.py

@@ -1,5 +0,0 @@
-from oscar.apps.notifications import abstract_models
-
-
-class Notification(abstract_models.AbstractNotification):
-    pass

oscar/apps/notifications/tmp.py

@@ -1,41 +0,0 @@
-from django.db import models
-from django.utils.translation import ugettext_lazy as _
-
-
-class Notification(models.Model):
-    sender = models.ForeignKey('auth.User', null=True)
-    recipient = models.ForeignKey('auth.User', related_name='notifications')
-
-    subject = models.CharField(max_length=255)
-    body = models.TextField()
-
-    # Some projects may want to categorise their notifications.  You may want
-    # to use this field to show a different icons next to the notification.
-    category = models.CharField(max_length=255, null=True)
-
-    INBOX, ARCHIVE = 'Inbox', 'Archive'
-    choices = (
-        (INBOX, _(INBOX)),
-        (ARCHIVE, _(ARCHIVE)))
-    location = models.CharField(max_length=32, choices=choices,
-                                default=INBOX)
-
-    date_sent = models.DateTimeField(auto_now_add=True)
-    date_read = models.DateTimeField(null=True)
-
-
-class StockReminder(models.Model):
-    user = models.ForeignKey('auth.User', related_name='stock_reminders')
-    # + other fields so anonymous users can get reminders too
-    product = models.ForeignKey('catalogue.Product')
-    UNCONFIRMED, ACTIVE, INACTIVE = ('unconfirmed', 'active', 'inactive')
-    STATUS_TYPES = (
-        (UNCONFIRMED, _('Not yet confirmed')),
-        (ACTIVE, _('Active')),
-        (INACTIVE, _('Inactive')),
-    )
-    status = models.CharField(max_length=20, choices=STATUS_TYPES,
-                              default=INACTIVE)
-
-    date_created = models.DateTimeField(auto_now_add=True)
-    date_notified = models.DateTimeField(null=True)

sites/demo/settings.py

@@ -99,7 +99,7 @@ TEMPLATE_CONTEXT_PROCESSORS = (
     'oscar.apps.search.context_processors.search_form',
     'oscar.apps.promotions.context_processors.promotions',
     'oscar.apps.checkout.context_processors.checkout',
-    'oscar.apps.notifications.context_processors.notifications',
+    'oscar.apps.customer.notifications.context_processors.notifications',
     'oscar.core.context_processors.metadata',
 )
 

sites/sandbox/settings.py

@@ -108,7 +108,7 @@ TEMPLATE_CONTEXT_PROCESSORS = (
     'oscar.apps.promotions.context_processors.promotions',
     'oscar.apps.checkout.context_processors.checkout',
     'oscar.core.context_processors.metadata',
-    'oscar.apps.notifications.context_processors.notifications',
+    'oscar.apps.customer.notifications.context_processors.notifications',
 )
 
 MIDDLEWARE_CLASSES = (

tests/config.py

@@ -36,6 +36,7 @@ def configure(nose_args=None):
                 "django.core.context_processors.static",
                 "django.contrib.messages.context_processors.messages",
                 'oscar.apps.search.context_processors.search_form',
+                'oscar.apps.customer.notifications.context_processors.notifications',
                 'oscar.apps.promotions.context_processors.promotions',
                 'oscar.apps.checkout.context_processors.checkout',
                 ),

tests/functional/customer/notification_tests.py

@@ -0,0 +1,17 @@
+from django.contrib.auth.models import User
+from django_dynamic_fixture import G
+
+from oscar.test import WebTestCase
+from oscar.apps.customer.notifications import services
+
+
+class TestAUserWithUnreadNotifications(WebTestCase):
+
+    def setUp(self):
+        self.user = G(User)
+        services.notify_user(self.user, "Test message")
+
+    def test_can_see_them_in_page_header(self):
+        homepage = self.app.get('/', user=self.user)
+        self.assertTrue('num_unread_notifications' in homepage.context)
+        self.assertEqual(1, homepage.context['num_unread_notifications'])

tests/unit/notification_tests.py → tests/unit/customer/notification_tests.py

@@ -2,7 +2,8 @@ from django.test import TestCase
 from django.contrib.auth.models import User
 from django_dynamic_fixture import G
 
-from oscar.apps.notifications.models import Notification
+from oscar.apps.customer.models import Notification
+from oscar.apps.customer.notifications import services
 
 
 class TestANewNotification(TestCase):
@@ -30,3 +31,19 @@ class TestANotification(TestCase):
     def test_can_be_archived(self):
         self.notification.archive()
         self.assertEqual(Notification.ARCHIVE, self.notification.location)
+
+
+class TestAServiceExistsTo(TestCase):
+
+    def test_notify_a_single_user(self):
+        user = G(User)
+        services.notify_user(user, "Hello you!")
+        self.assertEqual(1, Notification.objects.filter(
+            recipient=user).count())
+
+    def test_notify_a_set_of_users(self):
+        users = [G(User) for i in range(5)]
+        services.notify_users(User.objects.all(), "Hello everybody!")
+        for user in users:
+            self.assertEqual(1, Notification.objects.filter(
+                recipient=user).count())