Record whether a download came from an instructor or a student (#1776)

Author: mwvolo

salesforce/management/commands/update_resource_downloads.py

@@ -32,6 +32,7 @@ def handle(self, *args, **options):
                                       'Book__c': nrd.book.salesforce_abbreviation,
                                       'Book_Format__c': nrd.book_format,
                                       'Source__c': nrd.source,
+                                      'Role__c': nrd.role,
                                       'Accounts_UUID__c': str(nrd.account_uuid)}
                     new_data.append(data_dict_item)
 

salesforce/migrations/0118_resourcedownload_role.py

@@ -0,0 +1,20 @@
+# Generated by Django 6.0.6 on 2026-08-20 10:40
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("salesforce", "0117_resourcedownload_source"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="resourcedownload",
+            name="role",
+            field=models.CharField(
+                blank=True, help_text="Whether the reader was an instructor or a student", max_length=20, null=True
+            ),
+        ),
+    ]

salesforce/models.py

@@ -351,6 +351,8 @@ class ResourceDownload(models.Model):
     # here to show up in the data.
     source = models.CharField(max_length=255, null=True, blank=True,
                               help_text="Path of the page the reader downloaded from")
+    role = models.CharField(max_length=20, null=True, blank=True,
+                            help_text="Whether the reader was an instructor or a student")
 
     class Meta:
         indexes = [

salesforce/serializers.py

@@ -142,7 +142,7 @@ def create(self, validated_data):
         # An empty string and NULL both mean "not provided", and every one of
         # these is part of the key - so letting the two differ would file one
         # reader's download twice.
-        for field in ('book_format', 'resource_name', 'source', 'contact_id'):
+        for field in ('book_format', 'resource_name', 'source', 'contact_id', 'role'):
             if validated_data.get(field) == '':
                 validated_data[field] = None
 
@@ -158,19 +158,24 @@ def create(self, validated_data):
             return ResourceDownload.objects.create(**validated_data)
 
         contact_id = validated_data.get('contact_id')
+        role = validated_data.get('role')
 
         existing.last_access = validated_data.get('last_access', existing.last_access)
         # Signed-in students have no Salesforce contact, so an incoming
         # download without one must not erase a contact we already know.
         if contact_id:
             existing.contact_id = contact_id
+        # A student who gets verified keeps the same rows; report the role they
+        # hold now rather than the one they held the first time.
+        if role:
+            existing.role = role
         existing.save()
 
         return existing
 
     class Meta:
         model = ResourceDownload
-        fields = ('id', 'book', 'book_format', 'account_uuid', 'contact_id', 'last_access', 'resource_name', 'source', 'created')
+        fields = ('id', 'book', 'book_format', 'account_uuid', 'contact_id', 'last_access', 'resource_name', 'source', 'role', 'created')
         read_only_fields = ('id', 'created', 'last_access')
 
 

salesforce/tests.py

@@ -275,6 +275,16 @@ def test_sends_a_student_download_that_has_no_contact(self, salesforce):
         self.assertEqual(1, len(sent))
         self.assertIsNone(sent[0]['Contact__c'])
 
+    @patch('salesforce.management.commands.update_resource_downloads.Salesforce')
+    def test_sends_the_role_of_the_person_who_downloaded(self, salesforce):
+        sf = salesforce.return_value.__enter__.return_value
+        self.make_download('310bb96b-0df8-4d10-a759-c7d366c1f527', role='instructor')
+
+        call_command('update_resource_downloads')
+
+        sent = sf.bulk.Resource__c.insert.call_args[0][0]
+        self.assertEqual('instructor', sent[0]['Role__c'])
+
     @patch('salesforce.management.commands.update_resource_downloads.Salesforce')
     def test_needs_no_salesforce_query_to_build_the_batch(self, salesforce):
         sf = salesforce.return_value.__enter__.return_value
@@ -698,3 +708,28 @@ def test_a_download_without_a_contact_keeps_the_one_already_known(self):
         self.post_download(book=book.pk, resource_name="Test Bank")
 
         self.assertEqual("0032f00003zYVdSAAZ", ResourceDownload.objects.get().contact_id)
+
+    def test_role_is_stored_as_sent(self):
+        book = self.make_book()
+
+        response = self.post_download(book=book.pk, resource_name="Test Bank", role="instructor")
+
+        self.assertEqual("instructor", response.data['role'])
+        self.assertEqual("instructor", ResourceDownload.objects.get().role)
+
+    def test_a_verified_student_keeps_one_row_and_reports_the_role_they_hold_now(self):
+        book = self.make_book()
+
+        self.post_download(book=book.pk, resource_name="Test Bank", role="student")
+        self.post_download(book=book.pk, resource_name="Test Bank", role="instructor")
+
+        self.assertEqual(1, ResourceDownload.objects.count())
+        self.assertEqual("instructor", ResourceDownload.objects.get().role)
+
+    def test_a_download_without_a_role_keeps_the_one_already_known(self):
+        book = self.make_book()
+
+        self.post_download(book=book.pk, resource_name="Test Bank", role="instructor")
+        self.post_download(book=book.pk, resource_name="Test Bank", role="")
+
+        self.assertEqual("instructor", ResourceDownload.objects.get().role)