store http referrer for ReferralResponse

README.md

@@ -410,6 +410,7 @@ You may need to do this if you use a custom user model and upgrade Django.
 ### 4.3.0 (2023-06-07)
 
 * added tolerance to the ending slash in URL
+* ReferralResponse now stores http_referrer
 
 ### 4.2.0 (2023-01-12)
 

pinax/referrals/admin.py

@@ -29,6 +29,7 @@ class ReferralResponseAdmin(admin.ModelAdmin):
         "session_key",
         "user",
         "ip_address",
+        "http_referrer",
         "action",
         "target_object_link",
     ]

pinax/referrals/migrations/0004_referralresponse_http_referrer.py

@@ -0,0 +1,18 @@
+# Generated by Django 4.2.13 on 2024-06-03 15:40
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("referrals", "0003_auto_20190918_1831"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="referralresponse",
+            name="http_referrer",
+            field=models.CharField(blank=True, max_length=1024),
+        ),
+    ]

pinax/referrals/models.py

@@ -132,7 +132,8 @@ def respond(self, request, action_string, user=None, target=None):
             "session_key": request.session.session_key,
             "ip_address": ip_address,
             "action": action_string,
-            "user": user
+            "user": user,
+            "http_referrer": request.META.get("HTTP_REFERER", ""),
         }
         if target:
             kwargs.update({"target": target})
@@ -152,6 +153,7 @@ class ReferralResponse(models.Model):
     user = models.ForeignKey(AUTH_USER_MODEL, null=True, on_delete=models.SET_NULL)
     ip_address = models.CharField(max_length=265)
     action = models.CharField(max_length=128)
+    http_referrer = models.CharField(max_length=1024, blank=True)
 
     target_content_type = models.ForeignKey(ContentType, null=True, blank=True, on_delete=models.SET_NULL)
     target_object_id = models.PositiveIntegerField(null=True, blank=True)

pinax/referrals/tests/tests.py

@@ -28,36 +28,39 @@ def test_process_referral_authenticated(self):
         self.assertFalse(referral.responses.exists())
         referred_user = get_user_model().objects.create_user("janedoe", "jane@doe.com", "notsosecret")
         self.assertTrue(self.client.login(username=referred_user.username, password="notsosecret"))
-        response = self.client.get(referral.url)
+        response = self.client.get(referral.url, HTTP_REFERER="https://referrer.com")
         self.assertEqual(response.status_code, 302)
         self.assertEqual(response["Location"], "https://example.com/")
         self.assertEqual(referral.responses.count(), 1)
         referral_response = referral.responses.first()
         self.assertEqual(referral_response.user, referred_user)
+        self.assertEqual(referral_response.http_referrer, "https://referrer.com")
 
-    def test_process_referral_authenticated_anonomous(self):
+    def test_process_referral_anonymous(self):
         referral = Referral.create(redirect_to="https://example.com/")
         self.assertFalse(referral.responses.exists())
-        response = self.client.get(referral.url)
+        response = self.client.get(referral.url, HTTP_REFERER="https://referrer.com")
         self.assertEqual(response.status_code, 302)
         self.assertEqual(response["Location"], "https://example.com/")
         self.assertEqual(referral.responses.count(), 1)
         referral_response = referral.responses.first()
         self.assertIsNone(referral_response.user)
         self.assertEqual(response.cookies["pinax-referral"].value, f"{referral.code}:{referral_response.session_key}")
+        self.assertEqual(referral_response.http_referrer, "https://referrer.com")
 
     def test_process_referral_authenticated_next(self):
         """The process_referral view should redirect user to the url from redirect_to queryset parameter."""
         referral = Referral.create(redirect_to="https://example.com/")
         self.assertFalse(referral.responses.exists())
         referred_user = get_user_model().objects.create_user("janedoe", "jane@doe.com", "notsosecret")
         self.assertTrue(self.client.login(username=referred_user.username, password="notsosecret"))
-        response = self.client.get(referral.url + "?redirect_to=/foo/bar/")
+        response = self.client.get(referral.url + "?redirect_to=/foo/bar/", HTTP_REFERER="https://referrer.com")
         self.assertEqual(response.status_code, 302)
         self.assertEqual(response["Location"], "/foo/bar/")
         self.assertEqual(referral.responses.count(), 1)
         referral_response = referral.responses.first()
         self.assertEqual(referral_response.user, referred_user)
+        self.assertEqual(referral_response.http_referrer, "https://referrer.com")
 
     def test_process_referral_authenticated_next_unsafe(self):
         """
@@ -68,12 +71,13 @@ def test_process_referral_authenticated_next_unsafe(self):
         self.assertFalse(referral.responses.exists())
         referred_user = get_user_model().objects.create_user("janedoe", "jane@doe.com", "notsosecret")
         self.assertTrue(self.client.login(username=referred_user.username, password="notsosecret"))
-        response = self.client.get(referral.url + "?redirect_to=https://www.google.com/")
+        response = self.client.get(referral.url + "?redirect_to=https://www.google.com/", HTTP_REFERER="https://referrer.com")
         self.assertEqual(response.status_code, 302)
         self.assertEqual(response["Location"], "https://example.com/")
         self.assertEqual(referral.responses.count(), 1)
         referral_response = referral.responses.first()
         self.assertEqual(referral_response.user, referred_user)
+        self.assertEqual(referral_response.http_referrer, "https://referrer.com")
 
     def test_process_referral_slash_both_variants(self):
         referral = Referral.create(redirect_to="https://example.com/")

setup.py

@@ -1,6 +1,6 @@
 from setuptools import find_packages, setup
 
-VERSION = "4.2.0"
+VERSION = "4.3.0"
 LONG_DESCRIPTION = """
 .. image:: http://pinaxproject.com/pinax-design/patches/pinax-referrals.svg
     :target: https://pypi.python.org/pypi/pinax-referrals/