Added auto loading of events.py modules in INSTALLED_APPS, ala django.contrib.admin.autodiscover(), for ensuring event handlers are always regisrered. Closes stephenmcd#16.

Author: stephenmcd

README.rst

@@ -188,7 +188,9 @@ Events
 The ``django_socketio.events`` module provides a handful of events
 that can be subscribed to, very much like connecting receiver
 functions to Django signals. Each of these events are raised
-throughout the relevant stages of a Socket.IO request.
+throughout the relevant stages of a Socket.IO request. These events
+represent the main approach for implementing your socket handling
+logic when using django-socketio.
 
 Events are subscribed to by applying each event as a decorator
 to your event handler functions::
@@ -199,6 +201,14 @@ to your event handler functions::
     def my_message_handler(request, socket, context, message):
         ...
 
+Where should these event handlers live in your Django project? They
+can go anywhere, so long as they're imported by Django at startup
+time. To ensure that your event handlers are always loaded, you can
+put them into a module called ``events.py`` in one of your apps listed
+in Django's ``INSTALLED_APPS`` setting. django-socketio looks for these
+modules, and will always import them to ensure your event handlers are
+loaded.
+
 Each event handler takes at least three arguments: the current Django
 ``request``, the Socket.IO ``socket`` the event occurred for, and a
 ``context``, which is simply a dictionary that can be used to persist

django_socketio/example_project/chat/views.py

@@ -1,58 +1,11 @@
 
 from django.contrib.auth.decorators import user_passes_test
 from django.shortcuts import get_object_or_404, render, redirect
-from django.utils.html import strip_tags
-from django_socketio import events, broadcast, broadcast_channel, NoSocket
+from django_socketio import broadcast, broadcast_channel
 
-from chat.models import ChatRoom, ChatUser
+from chat.models import ChatRoom
 
 
-@events.on_subscribe
-def message(request, socket, context, channel):
-    print "subscribed to " + channel
-
-@events.on_message(channel="^room-")
-def message(request, socket, context, message):
-    """
-    Event handler for a room receiving a message. First validates a
-    joining user's name and sends them the list of users.
-    """
-    room = get_object_or_404(ChatRoom, id=message["room"])
-    if message["action"] == "start":
-        user, created = room.users.get_or_create(name=strip_tags(message["name"]))
-        if not created:
-            socket.send({"action": "in-use"})
-        else:
-            context["user"] = user
-            users = [u.name for u in room.users.exclude(id=user.id)]
-            socket.send({"action": "started", "users": users})
-            user.session = socket.session.session_id
-            user.save()
-            joined = {"action": "join", "name": user.name, "id": user.id}
-            socket.send_and_broadcast_channel(joined)
-    else:
-        try:
-            user = context["user"]
-        except KeyError:
-            return
-        if message["action"] == "message":
-            message["message"] = strip_tags(message["message"])
-            message["name"] = user.name
-            socket.send_and_broadcast_channel(message)
-
-@events.on_finish(channel="^room-")
-def finish(request, socket, context):
-    """
-    Event handler for a socket session ending in a room. Broadcast
-    the user leaving and delete them from the DB.
-    """
-    try:
-        user = context["user"]
-    except KeyError:
-        return
-    socket.broadcast_channel({"action": "leave", "name": user.name, "id": user.id})
-    user.delete()
-
 def rooms(request, template="rooms.html"):
     """
     Homepage - lists all rooms.

django_socketio/urls.py

@@ -1,5 +1,16 @@
 
 from django.conf.urls.defaults import patterns, url
+from django.conf import settings
+from django.utils.importlib import import_module
+
+
+# Try and import an ``events`` module in each installed app,
+# to ensure all event handlers are connected.
+for app in settings.INSTALLED_APPS:
+    try:
+        import_module("%s.events" % app)
+    except ImportError:
+        pass
 
 
 urlpatterns = patterns("django_socketio.views",