Merge branch 'master' of github.com:ui/django-cached_authentication_middleware

Author: selwin

cached_auth/__init__.py

@@ -15,7 +15,6 @@
 except ImportError:
     from django.contrib.auth.models import User
 
-
 CACHE_KEY = 'cached_auth_middleware:%s'
 
 
@@ -26,6 +25,30 @@
     profile_model = None
 
 
+def profile_preprocessor(user, request):
+    """ Cache user profile """
+    if profile_model:
+        try:
+            user.get_profile()
+        # Handle exception for user with no profile and AnonymousUser
+        except (profile_model.DoesNotExist, AttributeError):
+            pass
+    return user
+
+
+user_preprocessor = None
+if hasattr(settings, 'CACHED_AUTH_PREPROCESSOR'):
+    tmp = settings.CACHED_AUTH_PREPROCESSOR.split(".")
+    module_name, function_name = ".".join(tmp[0:-1]), tmp[-1]
+    func = getattr(__import__(module_name, fromlist=['']), function_name)
+    if callable(func):
+        user_preprocessor = func
+    else:
+        raise Exception("CACHED_AUTH_PREPROCESSOR must be callable with 2 arguments user and request")
+else:
+    user_preprocessor = profile_preprocessor
+
+
 def invalidate_cache(sender, instance, **kwargs):
     if isinstance(instance, User):
         key = CACHE_KEY % instance.id
@@ -41,17 +64,10 @@ def get_cached_user(request):
             user = cache.get(key)
         except KeyError:
             user = AnonymousUser()
-
         if user is None:
             user = get_user(request)
-
-            # Try to populate profile cache if profile is installed
-            if profile_model:
-                try:
-                    user.get_profile()
-                # Handle exception for user with no profile and AnonymousUser
-                except (profile_model.DoesNotExist, AttributeError):
-                    pass
+            if user_preprocessor:
+                user = user_preprocessor(user, request)
             cache.set(key, user)
         request._cached_user = user
     return request._cached_user

cached_auth/tests.py

@@ -2,8 +2,11 @@
 from django.core.urlresolvers import reverse
 from django.test import TestCase
 from django.test.client import Client
-
+from django.test.utils import override_settings
 from cached_auth import CACHE_KEY
+from django.conf import settings
+
+import cached_auth
 
 try:
     from django.contrib.auth import get_user_model
@@ -12,6 +15,11 @@
     from django.contrib.auth.models import User
 
 
+def auth_preprocessor(user, request):
+    user.username = 'test_auth'
+    return user
+
+
 class MiddlewareTest(TestCase):
 
     def setUp(self):
@@ -25,18 +33,17 @@ def test_anonymous(self):
         # Anonymous user doesn't cause cache to be set
         client = Client()
         key = CACHE_KEY % self.user.id
-        response = client.get(reverse('admin:index'))
+        client.get(reverse('admin:index'))
         self.assertEqual(cache.get(key), None)
 
-
     def test_cached_middleware(self):
         client = Client()
         key = CACHE_KEY % self.user.id
         self.assertEqual(cache.get(key), None)
 
         # Visiting admin causes the cache to be populated
         client.login(username='test', password='a')
-        response = client.get(reverse('admin:index'))
+        client.get(reverse('admin:index'))
         self.assertEqual(cache.get(key), self.user)
 
         # Changing user model invalidates cache
@@ -48,3 +55,15 @@ def test_cached_middleware(self):
         self.assertEqual(cache.get(key), self.user)
         self.user.delete()
         self.assertEqual(cache.get(key), None)
+
+    @override_settings(CACHED_AUTH_PREPROCESSOR='cached_auth.tests.auth_preprocessor')
+    def test_cached_auth_preprocessor_function(self):
+        reload(cached_auth)
+        client = Client()
+        key = CACHE_KEY % self.user.id
+        self.assertEqual(cache.get(key), None)
+
+        client.login(username='test', password='a')
+        client.get(reverse('admin:index'))
+        user = cache.get(key)
+        self.assertEqual(user.username, 'test_auth')