codeforlife-portal 5.32.2__py2.py3-none-any.whl → 8.9.9__py2.py3-none-any.whl

cfl_common/common/mail.py

@@ -0,0 +1,201 @@
+import typing as t
+from dataclasses import dataclass
+
+import requests
+from common import app_settings
+from common.app_settings import MODULE_NAME, domain
+from django.core.mail import EmailMultiAlternatives
+from django.template import loader
+
+campaign_ids = {
+    "admin_given": 1569057,
+    "admin_revoked": 1569071,
+    "delete_account": 1567477,
+    "email_change_notification": 1551600,
+    "email_change_verification": 1551594,
+    "invite_teacher_with_account": 1569599,
+    "invite_teacher_without_account": 1569607,
+    "level_creation": 1570259,
+    "reset_password": 1557153,
+    "student_join_request_notification": 1569486,
+    "student_join_request_rejected": 1569470,
+    "student_join_request_sent": 1569477,
+    "teacher_released": 1569537,
+    "user_already_registered": 1569539,
+    "verify_new_user": 1551577,
+    "verify_new_user_first_reminder": 1557170,
+    "verify_new_user_second_reminder": 1557173,
+    "verify_new_user_via_parent": 1551587,
+    "verify_released_student": 1580574,
+    "inactive_users_on_website_first_reminder": 1604381,
+    "inactive_users_on_website_second_reminder": 1606208,
+    "inactive_users_on_website_final_reminder": 1606215,
+}
+
+address_book_ids = {
+    "newsletter": 9705772,
+    "donors": 37649245,
+}
+
+
+def add_contact(email: str):
+    """Add a new contact to Dotdigital."""
+    # TODO: implement
+
+
+def remove_contact(email: str):
+    """Remove an existing contact from Dotdigital."""
+    # TODO: implement
+
+
+@dataclass
+class EmailAttachment:
+    """An email attachment for a Dotdigital triggered campaign."""
+
+    file_name: str
+    mime_type: str
+    content: str
+
+
+def django_send_email(
+    sender,
+    recipients,
+    subject,
+    text_content,
+    title,
+    replace_url=None,
+    plaintext_template="email.txt",
+    html_template="email.html",
+):
+    # add in template for templates to message
+
+    # setup templates
+    plaintext = loader.get_template(plaintext_template)
+    html = loader.get_template(html_template)
+    plaintext_email_context = {"content": text_content}
+    html_email_context = {
+        "content": text_content,
+        "title": title,
+        "url_prefix": domain(),
+    }
+
+    # render templates
+    plaintext_body = plaintext.render(plaintext_email_context)
+    original_html_body = html.render(html_email_context)
+    html_body = original_html_body
+
+    if replace_url:
+        verify_url = replace_url["verify_url"]
+        verify_replace_url = re.sub(
+            f"(.*/verify_email/)(.*)", f"\\1", verify_url
+        )
+        html_body = re.sub(
+            f"({verify_url})(.*){verify_url}",
+            f"\\1\\2{verify_replace_url}",
+            original_html_body,
+        )
+
+    # make message using templates
+    message = EmailMultiAlternatives(
+        subject, plaintext_body, sender, recipients
+    )
+    message.attach_alternative(html_body, "text/html")
+
+    message.send()
+
+
+# pylint: disable-next=too-many-arguments
+def send_dotdigital_email(
+    campaign_id: int,
+    to_addresses: t.List[str],
+    cc_addresses: t.Optional[t.List[str]] = None,
+    bcc_addresses: t.Optional[t.List[str]] = None,
+    from_address: t.Optional[str] = None,
+    personalization_values: t.Optional[t.Dict[str, str]] = None,
+    metadata: t.Optional[str] = None,
+    attachments: t.Optional[t.List[EmailAttachment]] = None,
+    region: str = "r1",
+    auth: t.Optional[str] = None,
+    timeout: int = 30,
+):
+    # pylint: disable=line-too-long
+    """Send a triggered email campaign using DotDigital's API.
+
+    https://developer.dotdigital.com/reference/send-transactional-email-using-a-triggered-campaign
+
+    Args:
+        campaign_id: The ID of the triggered campaign, which needs to be included within the request body.
+        to_addresses: The email address(es) to send to.
+        cc_addresses: The CC email address or address to to send to. separate email addresses with a comma. Maximum: 100.
+        bcc_addresses: The BCC email address or address to to send to. separate email addresses with a comma. Maximum: 100.
+        from_address: The From address for your email. Note: The From address must already be added to your account. Otherwise, your account's default From address is used.
+        personalization_values: Each personalisation value is a key-value pair; the placeholder name of the personalization value needs to be included in the request body.
+        metadata: The metadata for your email. It can be either a single value or a series of values in a JSON object.
+        attachments: A Base64 encoded string. All attachment types are supported. Maximum file size: 15 MB.
+        region: The Dotdigital region id your account belongs to e.g. r1, r2 or r3.
+        auth: The authorization header used to enable API access. If None, the value will be retrieved from the DOTDIGITAL_AUTH environment variable.
+        timeout: Send timeout to avoid hanging.
+
+    Raises:
+        AssertionError: If failed to send email.
+    """
+    # pylint: enable=line-too-long
+
+    # Dotdigital emails don't work locally, so if testing emails locally use Django to send a dummy email instead
+    if MODULE_NAME == "local":
+        django_send_email(
+            from_address,
+            to_addresses,
+            "dummy_subject",
+            "dummy_text_content",
+            "dummy_title",
+        )
+    else:
+        if auth is None:
+            auth = app_settings.DOTDIGITAL_AUTH
+
+        body = {
+            "campaignId": campaign_id,
+            "toAddresses": to_addresses,
+        }
+        if cc_addresses is not None:
+            body["ccAddresses"] = cc_addresses
+        if bcc_addresses is not None:
+            body["bccAddresses"] = bcc_addresses
+        if from_address is not None:
+            body["fromAddress"] = from_address
+        if personalization_values is not None:
+            body["personalizationValues"] = [
+                {
+                    "name": key,
+                    "value": value,
+                }
+                for key, value in personalization_values.items()
+            ]
+        if metadata is not None:
+            body["metadata"] = metadata
+        if attachments is not None:
+            body["attachments"] = [
+                {
+                    "fileName": attachment.file_name,
+                    "mimeType": attachment.mime_type,
+                    "content": attachment.content,
+                }
+                for attachment in attachments
+            ]
+
+        response = requests.post(
+            url=f"https://{region}-api.dotdigital.com/v2/email/triggered-campaign",
+            json=body,
+            headers={
+                "accept": "text/plain",
+                "authorization": auth,
+            },
+            timeout=timeout,
+        )
+
+        assert response.ok, (
+            "Failed to send email."
+            f" Reason: {response.reason}."
+            f" Text: {response.text}."
+        )

cfl_common/common/migrations/0001_initial.py

@@ -0,0 +1,240 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.11.24 on 2020-07-16 16:28
+from __future__ import unicode_literals
+
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+import django_countries.fields
+
+
+class Migration(migrations.Migration):
+    initial = True
+
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+    ]
+
+    operations = [
+        migrations.SeparateDatabaseAndState(
+            state_operations=[
+                migrations.CreateModel(
+                    name="Class",
+                    fields=[
+                        (
+                            "id",
+                            models.AutoField(
+                                auto_created=True,
+                                primary_key=True,
+                                serialize=False,
+                                verbose_name="ID",
+                            ),
+                        ),
+                        ("name", models.CharField(max_length=200)),
+                        ("access_code", models.CharField(max_length=5)),
+                        (
+                            "classmates_data_viewable",
+                            models.BooleanField(default=False),
+                        ),
+                        ("always_accept_requests", models.BooleanField(default=False)),
+                        ("accept_requests_until", models.DateTimeField(null=True)),
+                        (
+                            "teacher",
+                            models.ForeignKey(
+                                on_delete=django.db.models.deletion.CASCADE,
+                                related_name="class_teacher",
+                                to="common.Teacher",
+                            ),
+                        ),
+                    ],
+                    options={
+                        "verbose_name_plural": "classes",
+                    },
+                ),
+            ],
+            database_operations=[],
+        ),
+        migrations.SeparateDatabaseAndState(
+            state_operations=[
+                migrations.CreateModel(
+                    name="School",
+                    fields=[
+                        (
+                            "id",
+                            models.AutoField(
+                                auto_created=True,
+                                primary_key=True,
+                                serialize=False,
+                                verbose_name="ID",
+                            ),
+                        ),
+                        ("name", models.CharField(max_length=200)),
+                        ("postcode", models.CharField(max_length=10)),
+                        ("town", models.CharField(max_length=200)),
+                        ("latitude", models.CharField(max_length=20)),
+                        ("longitude", models.CharField(max_length=20)),
+                        ("country", django_countries.fields.CountryField(max_length=2)),
+                    ],
+                    options={
+                        "permissions": (
+                            (
+                                "view_aggregated_data",
+                                "Can see available aggregated data",
+                            ),
+                            (
+                                "view_map_data",
+                                "Can see schools' location displayed on map",
+                            ),
+                        ),
+                    },
+                ),
+            ],
+            database_operations=[],
+        ),
+        migrations.SeparateDatabaseAndState(
+            state_operations=[
+                migrations.CreateModel(
+                    name="Student",
+                    fields=[
+                        (
+                            "id",
+                            models.AutoField(
+                                auto_created=True,
+                                primary_key=True,
+                                serialize=False,
+                                verbose_name="ID",
+                            ),
+                        ),
+                        (
+                            "class_field",
+                            models.ForeignKey(
+                                null=True,
+                                on_delete=django.db.models.deletion.CASCADE,
+                                related_name="students",
+                                to="common.Class",
+                            ),
+                        ),
+                        (
+                            "new_user",
+                            models.OneToOneField(
+                                blank=True,
+                                null=True,
+                                on_delete=django.db.models.deletion.CASCADE,
+                                related_name="new_student",
+                                to=settings.AUTH_USER_MODEL,
+                            ),
+                        ),
+                        (
+                            "pending_class_request",
+                            models.ForeignKey(
+                                null=True,
+                                on_delete=django.db.models.deletion.SET_NULL,
+                                related_name="class_request",
+                                to="common.Class",
+                            ),
+                        ),
+                        (
+                            "user",
+                            models.OneToOneField(
+                                on_delete=django.db.models.deletion.CASCADE,
+                                to="common.UserProfile",
+                            ),
+                        ),
+                    ],
+                ),
+            ],
+            database_operations=[],
+        ),
+        migrations.SeparateDatabaseAndState(
+            state_operations=[
+                migrations.CreateModel(
+                    name="Teacher",
+                    fields=[
+                        (
+                            "id",
+                            models.AutoField(
+                                auto_created=True,
+                                primary_key=True,
+                                serialize=False,
+                                verbose_name="ID",
+                            ),
+                        ),
+                        ("title", models.CharField(max_length=35)),
+                        ("is_admin", models.BooleanField(default=False)),
+                        (
+                            "new_user",
+                            models.OneToOneField(
+                                blank=True,
+                                null=True,
+                                on_delete=django.db.models.deletion.CASCADE,
+                                related_name="new_teacher",
+                                to=settings.AUTH_USER_MODEL,
+                            ),
+                        ),
+                        (
+                            "pending_join_request",
+                            models.ForeignKey(
+                                blank=True,
+                                null=True,
+                                on_delete=django.db.models.deletion.SET_NULL,
+                                related_name="join_request",
+                                to="common.School",
+                            ),
+                        ),
+                        (
+                            "school",
+                            models.ForeignKey(
+                                null=True,
+                                on_delete=django.db.models.deletion.SET_NULL,
+                                related_name="teacher_school",
+                                to="common.School",
+                            ),
+                        ),
+                        (
+                            "user",
+                            models.OneToOneField(
+                                on_delete=django.db.models.deletion.CASCADE,
+                                to="common.UserProfile",
+                            ),
+                        ),
+                    ],
+                ),
+            ],
+            database_operations=[],
+        ),
+        migrations.SeparateDatabaseAndState(
+            state_operations=[
+                migrations.CreateModel(
+                    name="UserProfile",
+                    fields=[
+                        (
+                            "id",
+                            models.AutoField(
+                                auto_created=True,
+                                primary_key=True,
+                                serialize=False,
+                                verbose_name="ID",
+                            ),
+                        ),
+                        (
+                            "can_view_aggregated_data",
+                            models.BooleanField(default=False),
+                        ),
+                        ("developer", models.BooleanField(default=False)),
+                        (
+                            "awaiting_email_verification",
+                            models.BooleanField(default=False),
+                        ),
+                        (
+                            "user",
+                            models.OneToOneField(
+                                on_delete=django.db.models.deletion.CASCADE,
+                                to=settings.AUTH_USER_MODEL,
+                            ),
+                        ),
+                    ],
+                ),
+            ],
+            database_operations=[],
+        ),
+    ]

cfl_common/common/migrations/0002_emailverification.py

@@ -0,0 +1,55 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.11.24 on 2020-09-10 08:46
+from __future__ import unicode_literals
+
+from django.conf import settings
+from django.db import migrations, models
+from django.db.migrations.operations.special import SeparateDatabaseAndState
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+        ("common", "0001_initial"),
+    ]
+
+    operations = [
+        migrations.SeparateDatabaseAndState(
+            state_operations=[
+                migrations.CreateModel(
+                    name="EmailVerification",
+                    fields=[
+                        (
+                            "id",
+                            models.AutoField(
+                                auto_created=True,
+                                primary_key=True,
+                                serialize=False,
+                                verbose_name="ID",
+                            ),
+                        ),
+                        ("token", models.CharField(max_length=30)),
+                        (
+                            "email",
+                            models.CharField(blank=True, default=None, max_length=200, null=True),
+                        ),
+                        ("expiry", models.DateTimeField()),
+                        ("verified", models.BooleanField(default=False)),
+                        (
+                            "user",
+                            models.ForeignKey(
+                                blank=True,
+                                null=True,
+                                on_delete=django.db.models.deletion.CASCADE,
+                                related_name="email_verifications",
+                                to=settings.AUTH_USER_MODEL,
+                            ),
+                        ),
+                    ],
+                )
+            ],
+            # Table already exists. See portal/migrations/0058_move_to_common_models.py
+            database_operations=[],
+        ),
+    ]

cfl_common/common/migrations/0003_aimmocharacter.py

@@ -0,0 +1,31 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.11.24 on 2020-09-23 10:48
+from __future__ import unicode_literals
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [("common", "0002_emailverification")]
+
+    operations = [
+        migrations.CreateModel(
+            name="AimmoCharacter",
+            fields=[
+                (
+                    "id",
+                    models.AutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("name", models.CharField(max_length=255)),
+                ("description", models.TextField()),
+                ("image_path", models.CharField(max_length=255)),
+                ("sort_order", models.IntegerField()),
+            ],
+        )
+    ]

cfl_common/common/migrations/0004_add_aimmocharacters.py

@@ -0,0 +1,17 @@
+from common.helpers.data_migration_loader import load_data_from_file
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [("common", "0003_aimmocharacter")]
+
+    def dummy_reverse_code(app, schema_editor):
+        pass
+
+    operations = [
+        migrations.RunPython(
+            load_data_from_file("aimmo_characters.json"),
+            reverse_code=dummy_reverse_code,
+        )
+    ]

cfl_common/common/migrations/0005_add_worksheets.py

@@ -0,0 +1,8 @@
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [("common", "0004_add_aimmocharacters")]
+
+    operations = [migrations.RunPython(migrations.RunPython.noop, reverse_code=migrations.RunPython.noop)]

cfl_common/common/migrations/0006_update_aimmo_character_image_path.py

@@ -0,0 +1,17 @@
+from common.helpers.data_migration_loader import load_data_from_file
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [("common", "0005_add_worksheets")]
+
+    def dummy_reverse_code(app, schema_editor):
+        pass
+
+    operations = [
+        migrations.RunPython(
+            load_data_from_file("aimmo_characters2.json"),
+            reverse_code=dummy_reverse_code,
+        )
+    ]

cfl_common/common/migrations/0007_add_pdf_names_to_first_two_worksheets.py

@@ -0,0 +1,8 @@
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [("common", "0006_update_aimmo_character_image_path")]
+
+    operations = [migrations.RunPython(migrations.RunPython.noop, reverse_code=migrations.RunPython.noop)]

cfl_common/common/migrations/0008_unlock_worksheet_3.py

@@ -0,0 +1,11 @@
+from common.helpers.data_migration_loader import load_data_from_file
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("common", "0007_add_pdf_names_to_first_two_worksheets"),
+    ]
+
+    operations = [migrations.RunPython(migrations.RunPython.noop, reverse_code=migrations.RunPython.noop)]

cfl_common/common/migrations/0009_add_blocked_time_to_teacher_and_student.py

@@ -0,0 +1,24 @@
+# Generated by Django 2.2.20 on 2021-05-05 11:40
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("common", "0008_unlock_worksheet_3"),
+        ("portal", "0058_move_to_common_models"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="student",
+            name="blocked_time",
+            field=models.DateTimeField(null=True),
+        ),
+        migrations.AddField(
+            model_name="teacher",
+            name="blocked_time",
+            field=models.DateTimeField(null=True),
+        ),
+    ]

cfl_common/common/migrations/0010_remove_teacher_title.py

@@ -0,0 +1,18 @@
+# Generated by Django 2.2.24 on 2021-08-18 15:51
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("common", "0009_add_blocked_time_to_teacher_and_student"),
+        ("portal", "0062_verify_portaladmin"),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name="teacher",
+            name="title",
+        ),
+    ]

cfl_common/common/migrations/0011_student_login_id.py

@@ -0,0 +1,18 @@
+# Generated by Django 2.2.24 on 2021-09-24 16:36
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("common", "0010_remove_teacher_title"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="student",
+            name="login_id",
+            field=models.CharField(max_length=64, null=True),
+        ),
+    ]