cfl-common 8.8.1__tar.gz → 8.8.3__tar.gz

{cfl_common-8.8.1 → cfl_common-8.8.3}/PKG-INFO

@@ -1,18 +1,20 @@
 Metadata-Version: 2.4
 Name: cfl-common
-Version: 8.8.1
+Version: 8.8.3
 Classifier: Programming Language :: Python :: 3
 Classifier: Operating System :: OS Independent
-Requires-Dist: asgiref==3.8.1; python_version >= "3.8"
-Requires-Dist: certifi==2025.6.15; python_version >= "3.7"
-Requires-Dist: charset-normalizer==3.4.2; python_version >= "3.7"
+Requires-Dist: asgiref==3.9.1; python_version >= "3.9"
+Requires-Dist: certifi==2025.8.3; python_version >= "3.7"
+Requires-Dist: cffi==1.17.1; platform_python_implementation != "PyPy"
+Requires-Dist: charset-normalizer==3.4.3; python_version >= "3.7"
+Requires-Dist: cryptography==44.0.1; python_version >= "3.7" and python_full_version not in "3.9.0, 3.9.1"
 Requires-Dist: diff-match-patch==20241021; python_version >= "3.7"
 Requires-Dist: django==5.1.10; python_version >= "3.10"
 Requires-Dist: django-countries==7.6.1
 Requires-Dist: django-csp==3.8
 Requires-Dist: django-formtools==2.5.1; python_version >= "3.8"
 Requires-Dist: django-import-export==4.2.0; python_version >= "3.9"
-Requires-Dist: django-otp==1.6.0; python_version >= "3.7"
+Requires-Dist: django-otp==1.6.1; python_version >= "3.7"
 Requires-Dist: django-phonenumber-field==8.1.0; python_version >= "3.9"
 Requires-Dist: django-pipeline==4.0.0; python_version >= "3.9"
 Requires-Dist: django-two-factor-auth==1.17.0; python_version >= "3.8"
@@ -20,9 +22,10 @@ Requires-Dist: djangorestframework==3.16.0; python_version >= "3.9"
 Requires-Dist: idna==3.10; python_version >= "3.6"
 Requires-Dist: libsass==0.23.0; python_version >= "3.8"
 Requires-Dist: more-itertools==8.7.0; python_version >= "3.5"
-Requires-Dist: numpy==2.3.0; python_version >= "3.11"
-Requires-Dist: pandas==2.3.0; python_version >= "3.9"
+Requires-Dist: numpy==2.3.2; python_version >= "3.11"
+Requires-Dist: pandas==2.3.1; python_version >= "3.9"
 Requires-Dist: pgeocode==0.4.0; python_version >= "3.8"
+Requires-Dist: pycparser==2.22; python_version >= "3.8"
 Requires-Dist: pyjwt==2.6.0; python_version >= "3.7"
 Requires-Dist: pypng==0.20220715.0
 Requires-Dist: python-dateutil==2.9.0.post0; python_version >= "2.7" and python_version not in "3.0, 3.1, 3.2, 3.3"
@@ -33,7 +36,7 @@ Requires-Dist: setuptools==80.9.0; python_version >= "3.9"
 Requires-Dist: six==1.17.0; python_version >= "2.7" and python_version not in "3.0, 3.1, 3.2, 3.3"
 Requires-Dist: sqlparse==0.5.3; python_version >= "3.8"
 Requires-Dist: tablib==3.7.0; python_version >= "3.9"
-Requires-Dist: typing-extensions==4.14.0; python_version >= "3.9"
+Requires-Dist: typing-extensions==4.14.1; python_version >= "3.9"
 Requires-Dist: tzdata==2025.2; python_version >= "2"
 Requires-Dist: urllib3==2.5.0; python_version >= "3.9"
 Requires-Dist: wheel==0.45.1; python_version >= "3.8"

{cfl_common-8.8.1 → cfl_common-8.8.3}/cfl_common.egg-info/PKG-INFO

@@ -1,18 +1,20 @@
 Metadata-Version: 2.4
 Name: cfl-common
-Version: 8.8.1
+Version: 8.8.3
 Classifier: Programming Language :: Python :: 3
 Classifier: Operating System :: OS Independent
-Requires-Dist: asgiref==3.8.1; python_version >= "3.8"
-Requires-Dist: certifi==2025.6.15; python_version >= "3.7"
-Requires-Dist: charset-normalizer==3.4.2; python_version >= "3.7"
+Requires-Dist: asgiref==3.9.1; python_version >= "3.9"
+Requires-Dist: certifi==2025.8.3; python_version >= "3.7"
+Requires-Dist: cffi==1.17.1; platform_python_implementation != "PyPy"
+Requires-Dist: charset-normalizer==3.4.3; python_version >= "3.7"
+Requires-Dist: cryptography==44.0.1; python_version >= "3.7" and python_full_version not in "3.9.0, 3.9.1"
 Requires-Dist: diff-match-patch==20241021; python_version >= "3.7"
 Requires-Dist: django==5.1.10; python_version >= "3.10"
 Requires-Dist: django-countries==7.6.1
 Requires-Dist: django-csp==3.8
 Requires-Dist: django-formtools==2.5.1; python_version >= "3.8"
 Requires-Dist: django-import-export==4.2.0; python_version >= "3.9"
-Requires-Dist: django-otp==1.6.0; python_version >= "3.7"
+Requires-Dist: django-otp==1.6.1; python_version >= "3.7"
 Requires-Dist: django-phonenumber-field==8.1.0; python_version >= "3.9"
 Requires-Dist: django-pipeline==4.0.0; python_version >= "3.9"
 Requires-Dist: django-two-factor-auth==1.17.0; python_version >= "3.8"
@@ -20,9 +22,10 @@ Requires-Dist: djangorestframework==3.16.0; python_version >= "3.9"
 Requires-Dist: idna==3.10; python_version >= "3.6"
 Requires-Dist: libsass==0.23.0; python_version >= "3.8"
 Requires-Dist: more-itertools==8.7.0; python_version >= "3.5"
-Requires-Dist: numpy==2.3.0; python_version >= "3.11"
-Requires-Dist: pandas==2.3.0; python_version >= "3.9"
+Requires-Dist: numpy==2.3.2; python_version >= "3.11"
+Requires-Dist: pandas==2.3.1; python_version >= "3.9"
 Requires-Dist: pgeocode==0.4.0; python_version >= "3.8"
+Requires-Dist: pycparser==2.22; python_version >= "3.8"
 Requires-Dist: pyjwt==2.6.0; python_version >= "3.7"
 Requires-Dist: pypng==0.20220715.0
 Requires-Dist: python-dateutil==2.9.0.post0; python_version >= "2.7" and python_version not in "3.0, 3.1, 3.2, 3.3"
@@ -33,7 +36,7 @@ Requires-Dist: setuptools==80.9.0; python_version >= "3.9"
 Requires-Dist: six==1.17.0; python_version >= "2.7" and python_version not in "3.0, 3.1, 3.2, 3.3"
 Requires-Dist: sqlparse==0.5.3; python_version >= "3.8"
 Requires-Dist: tablib==3.7.0; python_version >= "3.9"
-Requires-Dist: typing-extensions==4.14.0; python_version >= "3.9"
+Requires-Dist: typing-extensions==4.14.1; python_version >= "3.9"
 Requires-Dist: tzdata==2025.2; python_version >= "2"
 Requires-Dist: urllib3==2.5.0; python_version >= "3.9"
 Requires-Dist: wheel==0.45.1; python_version >= "3.8"

{cfl_common-8.8.1 → cfl_common-8.8.3}/cfl_common.egg-info/SOURCES.txt

@@ -80,6 +80,7 @@ common/migrations/0054_delete_aimmo_models.py
 common/migrations/0055_alter_schoolteacherinvitation_token.py
 common/migrations/0056_set_non_school_teachers_as_non_admins.py
 common/migrations/0057_teacher_teacher__is_admin.py
+common/migrations/0058_userprofile_google_refresh_token_and_more.py
 common/migrations/__init__.py
 common/static/common/img/RR_logo.svg
 common/static/common/img/brain.svg

{cfl_common-8.8.1 → cfl_common-8.8.3}/cfl_common.egg-info/requires.txt

@@ -3,6 +3,9 @@ django-csp==3.8
 pypng==0.20220715.0
 pytz==2025.2
 
+[:platform_python_implementation != "PyPy"]
+cffi==1.17.1
+
 [:python_version >= "2"]
 tzdata==2025.2
 
@@ -14,7 +17,7 @@ six==1.17.0
 django==5.1.10
 
 [:python_version >= "3.11"]
-numpy==2.3.0
+numpy==2.3.2
 
 [:python_version >= "3.5"]
 more-itertools==8.7.0
@@ -23,30 +26,34 @@ more-itertools==8.7.0
 idna==3.10
 
 [:python_version >= "3.7"]
-certifi==2025.6.15
-charset-normalizer==3.4.2
+certifi==2025.8.3
+charset-normalizer==3.4.3
 diff-match-patch==20241021
-django-otp==1.6.0
+django-otp==1.6.1
 pyjwt==2.6.0
 qrcode==7.4.2
 
+[:python_version >= "3.7" and python_full_version not in "3.9.0, 3.9.1"]
+cryptography==44.0.1
+
 [:python_version >= "3.8"]
-asgiref==3.8.1
 django-formtools==2.5.1
 django-two-factor-auth==1.17.0
 libsass==0.23.0
 pgeocode==0.4.0
+pycparser==2.22
 requests==2.32.4
 sqlparse==0.5.3
 wheel==0.45.1
 
 [:python_version >= "3.9"]
+asgiref==3.9.1
 django-import-export==4.2.0
 django-phonenumber-field==8.1.0
 django-pipeline==4.0.0
 djangorestframework==3.16.0
-pandas==2.3.0
+pandas==2.3.1
 setuptools==80.9.0
 tablib==3.7.0
-typing-extensions==4.14.0
+typing-extensions==4.14.1
 urllib3==2.5.0

{cfl_common-8.8.1 → cfl_common-8.8.3}/common/app_settings.py

@@ -44,6 +44,9 @@ DOTMAILER_SEND_CAMPAIGN_URL = getattr(settings, "DOTMAILER_SEND_CAMPAIGN_URL", "
 # ID of the "Thanks for staying!" campaign in Dotmailer
 DOTMAILER_THANKS_FOR_STAYING_CAMPAIGN_ID = getattr(settings, "DOTMAILER_THANKS_FOR_STAYING_CAMPAIGN_ID", "")
 
+# Fernet encryption for OAuth2 sign in
+ENCRYPTION_KEY = getattr(settings, "ENCRYPTION_KEY", "")
+
 # The name of the google app engine service the application is running on, local otherwise
 MODULE_NAME = getattr(settings, "MODULE_NAME", "local")
 

cfl_common-8.8.3/common/migrations/0058_userprofile_google_refresh_token_and_more.py

@@ -0,0 +1,24 @@
+# Generated by Django 5.1.10 on 2025-08-12 12:51
+
+import common.models
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("common", "0057_teacher_teacher__is_admin"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="userprofile",
+            name="google_refresh_token",
+            field=common.models.EncryptedCharField(blank=True, max_length=1004, null=True),
+        ),
+        migrations.AddField(
+            model_name="userprofile",
+            name="google_sub",
+            field=models.CharField(blank=True, max_length=255, null=True),
+        ),
+    ]

{cfl_common-8.8.1 → cfl_common-8.8.3}/common/models.py

@@ -3,6 +3,8 @@ import typing as t
 from datetime import timedelta
 from uuid import uuid4
 
+from cryptography.fernet import Fernet
+from django.conf import settings
 from django.contrib.auth.models import User
 from django.db import models
 from django.utils import timezone
@@ -13,6 +15,64 @@ if t.TYPE_CHECKING:
     from game.models import Worksheet
 
 
+class EncryptedCharField(models.CharField):
+    """
+    A custom CharField that encrypts data before saving and decrypts it when
+    retrieved.
+    """
+
+    _fernet = Fernet(settings.ENCRYPTION_KEY)
+    _prefix = "ENC:"
+
+    # pylint: disable-next=unused-argument
+    def from_db_value(self, value: t.Optional[str], expression, connection):
+        """
+        Converts a value as returned by the database to a Python object. It is
+        the reverse of get_prep_value().
+
+        https://docs.djangoproject.com/en/5.1/howto/custom-model-fields/#converting-values-to-python-objects
+        """
+        if isinstance(value, str):
+            return self.decrypt_value(value)
+        return value
+
+    def to_python(self, value: t.Optional[str]):
+        """
+        Converts the value into the correct Python object. It acts as the
+        reverse of value_to_string(), and is also called in clean().
+
+        https://docs.djangoproject.com/en/5.1/howto/custom-model-fields/#converting-values-to-python-objects
+        """
+        if isinstance(value, str):
+            return self.decrypt_value(value)
+        return value
+
+    def get_prep_value(self, value: t.Optional[str]):
+        """
+        'value' is the current value of the model's attribute, and the method
+        should return data in a format that has been prepared for use as a
+        parameter in a query.
+
+        https://docs.djangoproject.com/en/5.1/howto/custom-model-fields/#converting-python-objects-to-query-values
+        """
+        if isinstance(value, str):
+            return self.encrypt_value(value)
+        return value
+
+    def encrypt_value(self, value: str):
+        """Encrypt the value if it's not encrypted."""
+        if not value.startswith(self._prefix):
+            return self._prefix + self._fernet.encrypt(value.encode()).decode()
+        return value
+
+    def decrypt_value(self, value: str):
+        """Decrpyt the value if it's encrypted.."""
+        if value.startswith(self._prefix):
+            value = value[len(self._prefix) :]
+            return self._fernet.decrypt(value).decode()
+        return value
+
+
 class UserProfile(models.Model):
     user = models.OneToOneField(User, on_delete=models.CASCADE)
 
@@ -32,6 +92,12 @@ class UserProfile(models.Model):
     username = models.CharField(max_length=200, null=True, blank=True)
     _username = models.BinaryField(null=True, blank=True)
 
+    # Google.
+    google_refresh_token = EncryptedCharField(
+        max_length=1000 + len(EncryptedCharField._prefix), null=True, blank=True
+    )
+    google_sub = models.CharField(max_length=255, null=True, blank=True)
+
     def __str__(self):
         return f"{self.user.first_name} {self.user.last_name}"
 
@@ -48,7 +114,9 @@ class SchoolModelManager(models.Manager):
 
 class School(models.Model):
     name = models.CharField(max_length=200, unique=True)
-    country = CountryField(blank_label="(select country)", null=True, blank=True)
+    country = CountryField(
+        blank_label="(select country)", null=True, blank=True
+    )
     # TODO: Create an Address model to house address details
     county = models.CharField(max_length=50, blank=True, null=True)
     creation_time = models.DateTimeField(default=timezone.now, null=True)
@@ -71,7 +139,11 @@ class School(models.Model):
 
     def admins(self):
         teachers = self.teacher_school.all()
-        return [teacher for teacher in teachers if teacher.is_admin] if teachers else None
+        return (
+            [teacher for teacher in teachers if teacher.is_admin]
+            if teachers
+            else None
+        )
 
     def anonymise(self):
         self.name = uuid4().hex
@@ -140,7 +212,10 @@ class Teacher(models.Model):
     def teaches(self, userprofile):
         if hasattr(userprofile, "student"):
             student = userprofile.student
-            return not student.is_independent() and student.class_field.teacher == self
+            return (
+                not student.is_independent()
+                and student.class_field.teacher == self
+            )
 
     def has_school(self):
         return self.school is not (None or "")
@@ -172,10 +247,14 @@ class SchoolTeacherInvitation(models.Model):
         null=True,
         on_delete=models.SET_NULL,
     )
-    invited_teacher_first_name = models.CharField(max_length=150)  # Same as User model
+    invited_teacher_first_name = models.CharField(
+        max_length=150
+    )  # Same as User model
     # TODO: Make not nullable once data has been transferred
     _invited_teacher_first_name = models.BinaryField(null=True, blank=True)
-    invited_teacher_last_name = models.CharField(max_length=150)  # Same as User model
+    invited_teacher_last_name = models.CharField(
+        max_length=150
+    )  # Same as User model
     # TODO: Make not nullable once data has been transferred
     _invited_teacher_last_name = models.BinaryField(null=True, blank=True)
     # TODO: Switch to a CharField to be able to hold hashed value
@@ -228,7 +307,9 @@ class Class(models.Model):
     locked_worksheets: "ManyToManyField[Worksheet]"
 
     name = models.CharField(max_length=200)
-    teacher = models.ForeignKey(Teacher, related_name="class_teacher", on_delete=models.CASCADE)
+    teacher = models.ForeignKey(
+        Teacher, related_name="class_teacher", on_delete=models.CASCADE
+    )
     access_code = models.CharField(max_length=5, null=True)
     classmates_data_viewable = models.BooleanField(default=False)
     always_accept_requests = models.BooleanField(default=False)
@@ -252,7 +333,9 @@ class Class(models.Model):
     def active_game(self):
         games = self.game_set.filter(game_class=self, is_archived=False)
         if len(games) >= 1:
-            assert len(games) == 1  # there should NOT be more than one active game
+            assert (
+                len(games) == 1
+            )  # there should NOT be more than one active game
             return games[0]
         return None
 
@@ -262,8 +345,13 @@ class Class(models.Model):
 
     def get_requests_message(self):
         if self.always_accept_requests:
-            external_requests_message = "This class is currently set to always accept requests."
-        elif self.accept_requests_until is not None and (self.accept_requests_until - timezone.now()) >= timedelta():
+            external_requests_message = (
+                "This class is currently set to always accept requests."
+            )
+        elif (
+            self.accept_requests_until is not None
+            and (self.accept_requests_until - timezone.now()) >= timedelta()
+        ):
             external_requests_message = (
                 "This class is accepting external requests until "
                 + self.accept_requests_until.strftime("%d-%m-%Y %H:%M")
@@ -271,7 +359,9 @@ class Class(models.Model):
                 + timezone.get_current_timezone_name()
             )
         else:
-            external_requests_message = "This class is not currently accepting external requests."
+            external_requests_message = (
+                "This class is not currently accepting external requests."
+            )
 
         return external_requests_message
 
@@ -293,7 +383,9 @@ class UserSession(models.Model):
     login_time = models.DateTimeField(default=timezone.now)
     school = models.ForeignKey(School, null=True, on_delete=models.SET_NULL)
     class_field = models.ForeignKey(Class, null=True, on_delete=models.SET_NULL)
-    login_type = models.CharField(max_length=100, null=True)  # for student login
+    login_type = models.CharField(
+        max_length=100, null=True
+    )  # for student login
 
     def __str__(self):
         return f"{self.user} login: {self.login_time} type: {self.login_type}"
@@ -322,7 +414,9 @@ class StudentModelManager(models.Manager):
         )
 
     def independentStudentFactory(self, name, email, password):
-        user = User.objects.create_user(username=email, email=email, password=password, first_name=name)
+        user = User.objects.create_user(
+            username=email, email=email, password=password, first_name=name
+        )
 
         user_profile = UserProfile.objects.create(user=user)
 
@@ -381,7 +475,9 @@ class JoinReleaseStudent(models.Model):
     JOIN = "join"
     RELEASE = "release"
 
-    student = models.ForeignKey(Student, related_name="student", on_delete=models.CASCADE)
+    student = models.ForeignKey(
+        Student, related_name="student", on_delete=models.CASCADE
+    )
     # either "release" or "join"
     action_type = models.CharField(max_length=64)
     action_time = models.DateTimeField(default=timezone.now)