codeforlife-portal 6.43.0__py2.py3-none-any.whl → 6.43.1__py2.py3-none-any.whl

cfl_common/common/email_messages.py

@@ -29,30 +29,6 @@ def kickedEmail(request, schoolName):
     }
 
 
-def adminGivenEmail(request, schoolName):
-
-    url = request.build_absolute_uri(reverse("dashboard"))
-
-    return {
-        "subject": f"You have been made a school or club administrator",
-        "message": (
-            f"Administrator control of the school or club '{schoolName}' has been "
-            f"given to you. Go to {url} to start managing your school or club."
-        ),
-    }
-
-
-def adminRevokedEmail(request, schoolName):
-    return {
-        "subject": f"You are no longer a school or club administrator",
-        "message": (
-            f"Your administrator control of the school or club '{schoolName}' has been "
-            f"revoked. If you think this is an error, please contact one of the other "
-            f"administrators in your school or club."
-        ),
-    }
-
-
 def studentJoinRequestSentEmail(request, schoolName, accessCode):
     return {
         "subject": f"School or club join request sent",

cfl_common/common/helpers/emails.py

@@ -6,14 +6,11 @@ from uuid import uuid4
 
 import jwt
 from common import app_settings
-from common.app_settings import domain
-from common.mail import campaign_ids, send_dotdigital_email
+from common.mail import campaign_ids, django_send_email, send_dotdigital_email
 from common.models import Student, Teacher
 from django.conf import settings
 from django.contrib.auth.models import User
-from django.core.mail import EmailMultiAlternatives
 from django.http import HttpResponse
-from django.template import loader
 from django.urls import reverse
 from django.utils import timezone
 from requests import delete, get, post, put
@@ -31,41 +28,6 @@ class DotmailerUserType(Enum):
     NO_ACCOUNT = auto()
 
 
-def 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()
-
-
 def generate_token(user, new_email="", preverified=False):
     if preverified:
         user.userprofile.is_verified = preverified
@@ -91,6 +53,19 @@ def _newsletter_ticked(data):
     return "newsletter_ticked" in data and data["newsletter_ticked"]
 
 
+def send_email(
+    sender,
+    recipients,
+    subject,
+    text_content,
+    title,
+    replace_url=None,
+    plaintext_template="email.txt",
+    html_template="email.html",
+):
+    django_send_email(sender, recipients, subject, text_content, title, replace_url, plaintext_template, html_template)
+
+
 def send_verification_email(request, user, data, new_email=None, age=None):
     """
     Sends emails relating to email address verification.

cfl_common/common/mail.py

@@ -3,8 +3,13 @@ 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,
     "email_change_notification": 1551600,
     "email_change_verification": 1551594,
     "reset_password": 1557153,
@@ -34,6 +39,41 @@ class EmailAttachment:
     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,
@@ -71,47 +111,51 @@ def send_dotdigital_email(
     """
     # pylint: enable=line-too-long
 
-    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}."
+    # 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}."

{codeforlife_portal-6.43.0.dist-info → codeforlife_portal-6.43.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: codeforlife-portal
-Version: 6.43.0
+Version: 6.43.1
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Framework :: Django
@@ -24,7 +24,7 @@ Requires-Dist: django-classy-tags ==2.0.0
 Requires-Dist: libsass ==0.23.0
 Requires-Dist: phonenumbers ==8.12.12
 Requires-Dist: more-itertools ==8.7.0
-Requires-Dist: cfl-common ==6.43.0
+Requires-Dist: cfl-common ==6.43.1
 Requires-Dist: django-ratelimit ==3.0.1
 Requires-Dist: django-preventconcurrentlogins ==0.8.2
 Requires-Dist: django-csp ==3.7

{codeforlife_portal-6.43.0.dist-info → codeforlife_portal-6.43.1.dist-info}/RECORD

@@ -5,14 +5,14 @@ cfl_common/common/app_settings.py,sha256=x2ROLY5Xl5LgqjxyTiChZvQorZYUXpFzEkaLsjh
 cfl_common/common/apps.py,sha256=49UXZ3bSkFKvIEOL4zM7y1sAhccQJyRtsoOg5XVd_8Y,129
 cfl_common/common/context_processors.py,sha256=X0iuX5qu9kMWa7q8osE9CJ2LgM7pPOYQFGdjm8X3rk0,236
 cfl_common/common/csp_config.py,sha256=sZT6s9zMT5FFIqNODsURT0ifxbDgXpDlki8UxaBq2iE,2940
-cfl_common/common/email_messages.py,sha256=DRiz6MCKUGdFsC-pN9EwFqzPhpzMWXaT9HPcji1BkvE,4437
-cfl_common/common/mail.py,sha256=5iwvedYfaJUv7v8vVpV1kyBtnw04EJhHPy3FRGI9WHM,4223
+cfl_common/common/email_messages.py,sha256=oK8cb5wrDbxq6xoEoILHJggs3P35aEyk9eFJHIR6y74,3644
+cfl_common/common/mail.py,sha256=qgsgBc0drFIG8ik4ZBjaqjSvk0LVDIJV2fNYWFrbzHU,5990
 cfl_common/common/models.py,sha256=EunFsc7sOWfWiFf4IQwuy56gu8pu3YpPoOgVtsMhbRM,14958
 cfl_common/common/permissions.py,sha256=gC6RQGZI2QDBbglx-xr_V4Hl2C2nf1V2_uPmEuoEcJo,2416
 cfl_common/common/utils.py,sha256=Nn2Npao9Uqad5Js_IdHwF-ow6wrPNpBLW4AO1LxoEBc,1727
 cfl_common/common/helpers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 cfl_common/common/helpers/data_migration_loader.py,sha256=_BhS5lPmhcuVUbryBmJytlWdHyT02KYyxPkHar32mOE,1748
-cfl_common/common/helpers/emails.py,sha256=u2X2brjHIlUDNIgQ6-Ld23Y4zyouJGTFH-G7HNQDBYs,11041
+cfl_common/common/helpers/emails.py,sha256=6xY8YxYY3ywcFWguys2G_36HTaBBah4ma1p20s4mpKU,10099
 cfl_common/common/helpers/generators.py,sha256=kTL5e91I8wgmjJ-mu4jr9vIacjccUZ5pZSAz5cUNhdM,1505
 cfl_common/common/helpers/organisation.py,sha256=e-JKumKoXrkMTzZPv0H4ViWL8vtCt7oXJjn_zZ1ec00,427
 cfl_common/common/migrations/0001_initial.py,sha256=Y2kt2xmdCbrmDXCgqmhXeacicNg26Zj7L7SANSsgAAI,9664
@@ -106,7 +106,7 @@ example_project/portal_test_settings.py,sha256=frp_XMpd-z1g3VFCRxB2w7AaFW2ivRVKn
 example_project/settings.py,sha256=XRZZvASoIl5a9xe3masTq_CUBleuJq9ByHx8f_e2UFc,5613
 example_project/urls.py,sha256=OVeRQ-TCpzHISBRuzqD0yd3ewF7H5U3c-f2p2alfUD0,430
 example_project/wsgi.py,sha256=U1W6WzZxZaIdYZ5tks7w9fqp5WS5qvn2iThsVcskrWw,829
-portal/__init__.py,sha256=QcuQSlJPY-R1FVgen2wz3xT3Zw5oZBeORJW5UieLYIU,23
+portal/__init__.py,sha256=Ngar-CylGsb6FZcYQn3kMXH5BOJ1Ub5AefCQXyRW8-E,23
 portal/admin.py,sha256=k5Hsiln43DlVPoufnrx5AXWu_RijX8xi_n7wwBuuCJo,5132
 portal/app_settings.py,sha256=DhWLQOwM0zVOXE3O5TNKbMM9K6agfLuCsHOdr1J7xEI,651
 portal/backends.py,sha256=2Dss6_WoQwPuDzJUF1yEaTQTNG4eUrD12ujJQ5cp5Tc,812
@@ -548,7 +548,7 @@ portal/tests/test_independent_student.py,sha256=ysWpkYiwjPdB7gO3ow-5JuxqLi0IywRS
 portal/tests/test_invite_teacher.py,sha256=oeOaoJV1IqJSYPlaPFjnhVXdB2mq8otCTLp_lfjuCfk,12224
 portal/tests/test_middleware.py,sha256=b6jfNmiRZ2snqLKsyJUG-RivoX5fmrqLlQkG9MeVnqM,8034
 portal/tests/test_newsletter_footer.py,sha256=MdVUX53mEoDTa4Krq-jg9LFNo-QyghqvTvhHeNXBGnE,838
-portal/tests/test_organisation.py,sha256=fOtck-0MkPM2F0V4RFH-QUeWEk6yUIXDv_GI5cl8sdg,7649
+portal/tests/test_organisation.py,sha256=kCMUNzLN6EzaMUBcFkqXwnqLGgOuQxQWIHHt63nhqBs,7574
 portal/tests/test_partials.py,sha256=ydh1nef6BqvMfah2BSBS9QDiKY0xopY74k_W1YVobAE,3687
 portal/tests/test_ratelimit.py,sha256=XWq1A9XgRrlcMHibGoJ0kc4gLc5U_u5UhKHjthxCfYA,19376
 portal/tests/test_school_student.py,sha256=bFZwY4twaFHQLp0cltMq8cLNDZGgCHTZBCZHK0JcV8s,8604
@@ -636,14 +636,14 @@ portal/views/student/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hS
 portal/views/student/edit_account_details.py,sha256=keMakqgqy5xB76QbpwsnkadxbMg_dGsAxLuP2CoWbvc,8551
 portal/views/student/play.py,sha256=-v9lBjHF3_PAKRgWcCGGt_bEOpIkmJDJnzgR5JvqrMo,8908
 portal/views/teacher/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-portal/views/teacher/dashboard.py,sha256=_zKAEIaMwCI5LdF5QN2kLy59UTkNhNnx5mYhe-mfdVA,24991
+portal/views/teacher/dashboard.py,sha256=nNA7XxylunLjyCpKmq7h_CYITi7wM3YnmjqzUL0A-bI,25236
 portal/views/teacher/teach.py,sha256=B71jReMJ4BYFmo7NtJVK3-4DeXEwxfu_WA3Ij1RYzdI,34725
 portal/views/two_factor/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 portal/views/two_factor/core.py,sha256=O_wcBeFqdPYSGNGv-pT_vbs5-Dj1Z-Jfkd6f9-E5yZI,760
 portal/views/two_factor/form.py,sha256=lnHNKI-BMlpncTuW3zUzjPaJJNuEra2I_nOam0eOKFY,257
 portal/views/two_factor/profile.py,sha256=tkl_ludo8arMtd5LKNmohM66vpC_YQiP-0nspTSJiJ4,383
-codeforlife_portal-6.43.0.dist-info/LICENSE.md,sha256=9AbRlCDqD2D1tPibimysFv3zg3AIc49-eyv9aEsyq9w,115
-codeforlife_portal-6.43.0.dist-info/METADATA,sha256=YnRGpJH354nDAr6qgrjVk7parxVg530N5gvYp6EtDNk,1137
-codeforlife_portal-6.43.0.dist-info/WHEEL,sha256=DZajD4pwLWue70CAfc7YaxT1wLUciNBvN_TTcvXpltE,110
-codeforlife_portal-6.43.0.dist-info/top_level.txt,sha256=8e5pdsuIoTqEAMqpelHBjGjLbffcBtgOoggmd2q7nMw,41
-codeforlife_portal-6.43.0.dist-info/RECORD,,
+codeforlife_portal-6.43.1.dist-info/LICENSE.md,sha256=9AbRlCDqD2D1tPibimysFv3zg3AIc49-eyv9aEsyq9w,115
+codeforlife_portal-6.43.1.dist-info/METADATA,sha256=tFzxDaekn6AVyuunmE_TYU1KveLBu1erHq8KPawpbzs,1137
+codeforlife_portal-6.43.1.dist-info/WHEEL,sha256=DZajD4pwLWue70CAfc7YaxT1wLUciNBvN_TTcvXpltE,110
+codeforlife_portal-6.43.1.dist-info/top_level.txt,sha256=8e5pdsuIoTqEAMqpelHBjGjLbffcBtgOoggmd2q7nMw,41
+codeforlife_portal-6.43.1.dist-info/RECORD,,

portal/__init__.py

@@ -1 +1 @@
-__version__ = "6.43.0"
+__version__ = "6.43.1"

portal/tests/test_organisation.py

@@ -4,9 +4,11 @@ import time
 
 from common.models import Teacher
 from common.tests.utils.classes import create_class_directly
-from common.tests.utils.organisation import (create_organisation,
-                                             create_organisation_directly,
-                                             join_teacher_to_organisation)
+from common.tests.utils.organisation import (
+    create_organisation,
+    create_organisation_directly,
+    join_teacher_to_organisation,
+)
 from common.tests.utils.student import create_school_student_directly
 from common.tests.utils.teacher import signup_teacher_directly
 from selenium.webdriver.common.by import By

portal/views/teacher/dashboard.py

@@ -2,12 +2,24 @@ from datetime import timedelta
 from uuid import uuid4
 
 from common import email_messages
-from common.helpers.emails import (INVITE_FROM, NOTIFICATION_EMAIL,
-                                   DotmailerUserType, add_to_dotmailer,
-                                   generate_token, send_email, update_email)
+from common.helpers.emails import (
+    INVITE_FROM,
+    NOTIFICATION_EMAIL,
+    DotmailerUserType,
+    add_to_dotmailer,
+    generate_token,
+    send_email,
+    update_email,
+)
 from common.helpers.generators import get_random_username
-from common.models import (Class, JoinReleaseStudent, SchoolTeacherInvitation,
-                           Student, Teacher)
+from common.mail import campaign_ids, send_dotdigital_email
+from common.models import (
+    Class,
+    JoinReleaseStudent,
+    SchoolTeacherInvitation,
+    Student,
+    Teacher,
+)
 from common.permissions import check_teacher_authorised, logged_in_as_teacher
 from common.utils import using_two_factor
 from django.contrib import messages as messages
@@ -16,7 +28,7 @@ from django.contrib.auth.decorators import login_required, user_passes_test
 from django.contrib.auth.models import User
 from django.http import Http404, HttpResponseRedirect
 from django.shortcuts import get_object_or_404, render
-from django.urls import reverse_lazy
+from django.urls import reverse, reverse_lazy
 from django.utils import timezone
 from django.views.decorators.http import require_POST
 from game.level_management import levels_shared_with, unshare_level
@@ -25,14 +37,20 @@ from two_factor.utils import devices_for_user
 from portal.forms.invite_teacher import InviteTeacherForm
 from portal.forms.organisation import OrganisationForm
 from portal.forms.registration import DeleteAccountForm
-from portal.forms.teach import (ClassCreationForm, InvitedTeacherForm,
-                                TeacherAddExternalStudentForm,
-                                TeacherEditAccountForm)
+from portal.forms.teach import (
+    ClassCreationForm,
+    InvitedTeacherForm,
+    TeacherAddExternalStudentForm,
+    TeacherEditAccountForm,
+)
 from portal.helpers.decorators import ratelimit
 from portal.helpers.password import check_update_password
-from portal.helpers.ratelimit import (RATELIMIT_LOGIN_GROUP,
-                                      RATELIMIT_LOGIN_RATE, RATELIMIT_METHOD,
-                                      clear_ratelimit_cache_for_user)
+from portal.helpers.ratelimit import (
+    RATELIMIT_LOGIN_GROUP,
+    RATELIMIT_LOGIN_RATE,
+    RATELIMIT_METHOD,
+    clear_ratelimit_cache_for_user,
+)
 
 from .teach import create_class
 
@@ -380,19 +398,22 @@ def invite_toggle_admin(request, invite_id):
 
     if invite.invited_teacher_is_admin:
         messages.success(request, "Administrator invite status has been given successfully")
-        emailMessage = email_messages.adminGivenEmail(request, invite.school)
+        send_dotdigital_email(
+            campaign_ids["admin_given"],
+            [invite.invited_teacher_email],
+            personalization_values={
+                "SCHOOL_CLUB_NAME": invite.school,
+                "MANAGEMENT_LINK": request.build_absolute_uri(reverse("dashboard")),
+            },
+        )
 
     else:
         messages.success(request, "Administrator invite status has been revoked successfully")
-        emailMessage = email_messages.adminRevokedEmail(request, invite.school)
-
-    send_email(
-        NOTIFICATION_EMAIL,
-        [invite.invited_teacher_email],
-        emailMessage["subject"],
-        emailMessage["message"],
-        emailMessage["subject"],
-    )
+        send_dotdigital_email(
+            campaign_ids["admin_revoked"],
+            [invite.invited_teacher_email],
+            personalization_values={"SCHOOL_CLUB_NAME": invite.school},
+        )
 
     return HttpResponseRedirect(reverse_lazy("dashboard"))
 
@@ -411,7 +432,14 @@ def organisation_toggle_admin(request, pk):
 
     if teacher.is_admin:
         messages.success(request, "Administrator status has been given successfully.")
-        email_message = email_messages.adminGivenEmail(request, teacher.school.name)
+        send_dotdigital_email(
+            campaign_ids["admin_given"],
+            [teacher.new_user.email],
+            personalization_values={
+                "SCHOOL_CLUB_NAME": teacher.school.name,
+                "MANAGEMENT_LINK": request.build_absolute_uri(reverse("dashboard")),
+            },
+        )
     else:
         # Remove access to all levels that are from other teachers' students
         [
@@ -420,15 +448,11 @@ def organisation_toggle_admin(request, pk):
             if hasattr(level.owner, "student") and not teacher.teaches(level.owner)
         ]
         messages.success(request, "Administrator status has been revoked successfully.")
-        email_message = email_messages.adminRevokedEmail(request, teacher.school.name)
-
-    send_email(
-        NOTIFICATION_EMAIL,
-        [teacher.new_user.email],
-        email_message["subject"],
-        email_message["message"],
-        email_message["subject"],
-    )
+        send_dotdigital_email(
+            campaign_ids["admin_revoked"],
+            [teacher.new_user.email],
+            personalization_values={"SCHOOL_CLUB_NAME": teacher.school.name},
+        )
 
     return HttpResponseRedirect(reverse_lazy("dashboard"))