allow to remove aid param and redirect

Author: st4lk

README.md

@@ -134,3 +134,4 @@ Define in settings.py
 - AFFILIATE_SAVE_IN_SESSION - save affiliate id in session or not. Default `True`.
 - AFFILIATE_SESSION_AGE - how long keep affiliate id in session, in seconds. Default `5 * 24 * 60 * 60` seconds (5 days).
 - AFFILIATE_DEFAULT_LINK - default link, that will be used by `Affiliate.build_absolute_affiliate_uri` and `.build_affiliate_url`. Default `'/'`.
+- AFFILIATE_REMOVE_PARAM_AND_REDIRECT - if True, remove affiliate param from url and redirect to same url (affiliate data will be saved in session). Default `False`.

affiliate/app_settings.py

@@ -10,6 +10,7 @@
 SAVE_IN_SESSION = getattr(settings, 'AFFILIATE_SAVE_IN_SESSION', True)
 SESSION_AGE = getattr(settings, 'AFFILIATE_SESSION_AGE', 5 * 24 * 60 * 60)
 DEFAULT_LINK = getattr(settings, 'AFFILIATE_DEFAULT_LINK', '/')
+REMOVE_PARAM_AND_REDIRECT = getattr(settings, 'AFFILIATE_REMOVE_PARAM_AND_REDIRECT', False)
 # deprecated
 BANNER_FOLDER = getattr(settings, 'AFFILIATE_BANNER_PATH', 'affiliate')
 START_AID = getattr(settings, 'AFFILIATE_START_AID', "1000")

affiliate/middleware.py

@@ -5,14 +5,15 @@
 from django.utils.functional import SimpleLazyObject
 from django.utils import timezone
 from django.utils.dateparse import parse_datetime
+from django.http import HttpResponseRedirect
 
 from .models import NoAffiliate
-from .utils import get_model
+from . import utils
 
 l = logging.getLogger(__name__)
 
 
-AffiliateModel = get_model(app_settings.AFFILIATE_MODEL)
+AffiliateModel = utils.get_affiliate_model()
 
 def get_affiliate(request, new_aid, prev_aid, prev_aid_dt):
     if not hasattr(request, '_cached_affiliate'):
@@ -53,6 +54,9 @@ def process_request(self, request):
             if app_settings.SAVE_IN_SESSION:
                 session['_aid'] = new_aid
                 session['_aid_dt'] = now.isoformat()
+            if app_settings.REMOVE_PARAM_AND_REDIRECT:
+                url = utils.remove_affiliate_code(request.get_full_path())
+                return HttpResponseRedirect(url)
         if prev_aid and app_settings.SAVE_IN_SESSION:
             if prev_aid_dt is None:
                 l.error('_aid_dt not found in session')

affiliate/models.py

@@ -45,8 +45,7 @@ def exists(self):
         return True
 
     def build_absolute_affiliate_uri(self, request, location=None):
-        location = location or app_settings.DEFAULT_LINK
-        uri = request.build_absolute_uri(location)
+        uri = request.build_absolute_uri(self.build_affiliate_url(location))
         return add_affiliate_code(uri, self.pk)
 
     def build_affiliate_url(self, location=None):

tests/test_affiliate_middleware.py

@@ -6,6 +6,8 @@
 from django.core.urlresolvers import reverse
 from django.core.exceptions import ImproperlyConfigured
 from django.conf import settings
+from django.test.utils import override_settings
+from django.utils import six
 from model_mommy import mommy
 from freezegun import freeze_time
 
@@ -88,6 +90,29 @@ def test_affiliate_code_in_post_request(self):
         self.assertEqual(resp.context['request'].affiliate.pk, affiliate.pk)
 
 
+@override_settings(AFFILIATE_REMOVE_PARAM_AND_REDIRECT=True)
+class TestAffiliateMiddlewareRemoveAndRedirect(TestCase):
+    def setUp(self):
+        super(TestAffiliateMiddlewareRemoveAndRedirect, self).setUp()
+        six.moves.reload_module(app_settings)
+
+    def test_affiliate_code_remove_from_url(self):
+        affiliate = mommy.make(settings.AFFILIATE_AFFILIATE_MODEL)
+        resp = self.client.get(get_aid_url('/', affiliate.aid))
+        self.assertRedirects(resp, '/')
+        resp = self.client.get('/')
+        self.assertTrue(resp.context['request'].affiliate.exists())
+        self.assertEqual(resp.context['request'].affiliate.pk, affiliate.pk)
+
+    def test_affiliate_code_remove_from_url_other_params_kept(self):
+        affiliate = mommy.make(settings.AFFILIATE_AFFILIATE_MODEL)
+        resp = self.client.get(get_aid_url('/', affiliate.aid) + '&other=param')
+        self.assertRedirects(resp, '/?other=param')
+        resp = self.client.get('/')
+        self.assertTrue(resp.context['request'].affiliate.exists())
+        self.assertEqual(resp.context['request'].affiliate.pk, affiliate.pk)
+
+
 @modify_settings(MIDDLEWARE_CLASSES={
     'remove': [
         'django.contrib.sessions.middleware.SessionMiddleware',
@@ -100,6 +125,10 @@ def test_affiliate_code_in_post_request(self):
     ]
 })
 class TestAffiliateMiddlewareNoSession(TestCase):
+    def setUp(self):
+        super(TestAffiliateMiddlewareNoSession, self).setUp()
+        six.moves.reload_module(app_settings)
+
     def test_no_session_affiliate_in_url(self):
         app_settings.SAVE_IN_SESSION = False