Merge pull request #43 from Women-in-Computing-at-RIT/feature/confirmations

Feature/confirmations

Author: ha1lie

api/.DS_Store

@@ -0,0 +1,62 @@
+import logging
+
+from flask_restful import Resource, reqparse
+from flask import request
+from data.application import createApplication, updateApplication
+from data.users import getUserByAuthID, getUserIdFromAuthID
+from utils.authentication import authenticate
+from data.permissions import canUpdateApplicationStatus
+from data.email import sendConfirmedEmail, CONFIRMED, ACCEPTED
+
+logger = logging.getLogger("Confirmation")
+
+
+class Confirmation(Resource):
+    PATH = '/user/application/confirm'
+
+    def post(self):
+        """
+        Update user application status to CONFIRMED
+        :return:
+        """
+        authenticationPayload = authenticate(request.headers)
+        if authenticationPayload is None:
+            return {"message": "Authorization Header Failure"}, 401
+        auth0_id = authenticationPayload['sub']
+
+        userData = getUserByAuthID(auth0_id)
+        if userData is None:
+            return {"message": "Internal Server Error"}, 500
+        if len(userData.keys()) == 0:
+            return {"message": "Could Not Find User"}, 400
+        if not userData['status'] == ACCEPTED:
+            if userData['status'] == CONFIRMED:
+                return {"message": "User Already Confirmed"}
+            return {"message": "User Status Failed"}, 400
+
+        # update status by retrieving and re-saving application
+        applicationUpdated = updateApplication(applicationId=userData['application_id'],
+                                               status=CONFIRMED,
+                                               major=userData['major'],
+                                               levelOfStudy=userData['level_of_study'],
+                                               age=userData['age'],
+                                               shirtSize=userData['shirt_size'],
+                                               hasAttendedWiCHacks=userData['has_attended_wichacks'],
+                                               hasAttendedHackathons=userData['has_attended_hackathons'],
+                                               university=userData['university'],
+                                               gender=userData['gender'],
+                                               busRider=userData['bus_rider'],
+                                               busStop=userData['bus_stop'],
+                                               dietaryRestrictions=userData['dietary_restrictions'],
+                                               specialAccommodations=userData['special_accommodations'],
+                                               affirmedAgreements=userData['affirmed_agreements'],
+                                               isVirtual=userData['is_virtual'],
+                                               mlhEmailsAllowed=userData['allowMlhEmails']
+                                               )
+        if applicationUpdated is None:
+            return {"message": "Internal Server Error"}, 500
+        elif not applicationUpdated:
+            return {"message": "Application Update Failure"}, 400
+
+        sendConfirmedEmail(getUserIdFromAuthID(auth_id=auth0_id))
+        return {"message": "Application Updated"}, 200

api/src/controller/confirmation.py

@@ -0,0 +1,41 @@
+from flask_restful import Resource, reqparse
+from flask import request
+
+from data.users import getUserEmailsWithFilter
+from utils.authentication import authenticate, getAuthToken
+from data.permissions import canSendEmails
+from data.email import sendGroupEmail
+
+
+class Email(Resource):
+    PATH = '/email'
+
+    def post(self):
+        parser = reqparse.RequestParser()
+        parser.add_argument('body', type=str, required=True)
+        parser.add_argument('subjectLine', type=str, required=True)
+        parser.add_argument('recipientStatusFilter', type=str, required=True, action="append")
+        args = parser.parse_args()
+
+        authenticationPayload = authenticate(request.headers)
+        if authenticationPayload is None:
+            return {"message": "Must be logged in"}, 401
+        auth0_id = authenticationPayload['sub']
+
+        permissions = canSendEmails(auth0_id)
+        if permissions is None:
+            return {"message": "Internal Server Error"}, 500
+        if not permissions:
+            return {"message": "Permission Denied"}, 403
+
+        userEmails = getUserEmailsWithFilter(args['recipientStatusFilter'])
+
+        if len(userEmails) == 0:
+            # no recipients
+            return {"message": "No Recipients"}, 400
+
+        failedEmailList, didSucceed = sendGroupEmail(emailAddresses=userEmails, subject=args['subjectLine'], content=args['body'])
+        if didSucceed:
+            return {"message": "Email Successfully Sent"}
+        else:
+            return {"message": "Email Failed", "failedEmailAddresses": failedEmailList}, 500

api/src/controller/email.py

@@ -0,0 +1,29 @@
+from flask_restful import Resource, reqparse
+from flask import request
+
+from data.users import getUserEmailsWithFilter
+from utils.authentication import authenticate, getAuthToken
+from data.permissions import canSendEmails
+from data.email import sendPresetEmail
+
+
+class EmailPreset(Resource):
+    PATH = '/email/preset/<emailName>'
+
+    def post(self, emailName):
+        authenticationPayload = authenticate(request.headers)
+        if authenticationPayload is None:
+            return {"message": "Must be logged in"}, 401
+        auth0_id = authenticationPayload['sub']
+
+        permissions = canSendEmails(auth0_id)
+        if permissions is None:
+            return {"message": "Internal Server Error"}, 500
+        if not permissions:
+            return {"message": "Permission Denied"}, 403
+
+        failedEmailList, didSucceed = sendPresetEmail(emailName)
+        if didSucceed:
+            return {"message": "Email Successfully Sent"}
+        else:
+            return {"message": "Email Failed", "failedEmailAddresses": failedEmailList}, 500

api/src/controller/emailPreset.py

@@ -1,28 +1,49 @@
 import os
 
-from data.users import getUserByAuthID, getUserByUserID
+from data.users import getUserByAuthID, getUserByUserID, getUserEmailsWithFilter
 from data.emailTemplates.applied import getAppliedEmail, getAppliedSubjectLine
 from data.emailTemplates.accepted import getAcceptedEmail, getAcceptedSubjectLine
 from data.emailTemplates.rejected import getRejectedEmail, getRejectedSubjectLine
-from data.emailTemplates.confirmed import getConfirmedEmail, getConfirmedSubjectLine
+from data.emailTemplates.confirmed import getConfirmedEmail, getConfirmedSubjectLine, getRequestConfirmedEmail, \
+    getRequestConfirmedSubjectLine
 import logging
 from sendgrid import SendGridAPIClient
-from sendgrid.helpers.mail import Mail
-from typing import Union, List
+from sendgrid.helpers.mail import Mail, Personalization, Bcc
+from typing import Union, List, Tuple
 from utils.aws import getSendgridAPIKey
 
 logger = logging.getLogger("email")
 WICHACKS_EMAIL = "organizers@wichacks.io"
 
+ACCEPTED = "ACCEPTED"
+REJECTED = "REJECTED"
+CONFIRMED = "CONFIRMED"
+
+
+def sendPresetEmail(emailName) -> Tuple[List[str], bool]:
+    """
+    Send preset email
+    :param emailName:
+    :return:
+    """
+    if emailName == "requestConfirmation":
+        return sendRequestConfirmedEmail()
+
+    # default behavior mimic crash
+    return None, False
+
+
 def sendEmailByStatus(userID, status) -> bool:
-    if status == "ACCEPTED":
+    if status == ACCEPTED:
         return sendAcceptedEmail(userID)
-    elif status == "REJECTED":
+    elif status == REJECTED:
         return sendRejectedEmail(userID)
-    elif status == "CONFIRMED":
+    elif status == CONFIRMED:
         return sendConfirmedEmail(userID)
     else:
         logger.error("Application Status Change, Status not recognized: %s for user %s", status, userID)
+
+
 def sendAppliedEmail(auth0ID) -> bool:
     """
     Wrapper of send email for applied email
@@ -39,7 +60,7 @@ def sendAppliedEmail(auth0ID) -> bool:
         return False
     messageContent = getAppliedEmail(firstName, lastName)
     subjectLine = getAppliedSubjectLine()
-    return sendEmail(emailAddresses=emailAddress, subject=subjectLine, content=messageContent)
+    return sendEmailToSingleRecipient(emailAddress=emailAddress, subject=subjectLine, content=messageContent)
 
 
 def sendConfirmedEmail(userId) -> bool:
@@ -53,9 +74,6 @@ def sendConfirmedEmail(userId) -> bool:
         :param auth0ID:
         :return: bool success
         """
-    logger.error("Confirmation Email Not Enabled")
-    return False  # REMOVE BEFORE ENABLING
-
     userData = getUserByUserID(userId)
     emailAddress = userData.get("email", None)
     firstName = userData.get("first_name", None)
@@ -66,7 +84,24 @@ def sendConfirmedEmail(userId) -> bool:
         return False
     messageContent = getConfirmedEmail(firstName, lastName)
     subjectLine = getConfirmedSubjectLine()
-    return sendEmail(emailAddresses=emailAddress, subject=subjectLine, content=messageContent)
+    return sendEmailToSingleRecipient(emailAddress=emailAddress, subject=subjectLine, content=messageContent)
+
+
+def sendRequestConfirmedEmail() -> Tuple[List[str], bool]:
+    """
+        Wrapper of send email for requesting confirmation email
+        :param: applicationStatusFilterList list of application statuses that will receive the email, default is email goes to nobody
+        :return: list of failed email addresses
+        """
+    """
+        Wrapper of send email for applied email
+        :return: bool success
+        """
+    userEmails = getUserEmailsWithFilter([ACCEPTED])
+    messageContent = getRequestConfirmedEmail()
+    subjectLine = getRequestConfirmedSubjectLine()
+
+    return sendGroupEmail(emailAddresses=userEmails, subject=subjectLine, content=messageContent)
 
 
 def sendAcceptedEmail(userId) -> bool:
@@ -85,7 +120,7 @@ def sendAcceptedEmail(userId) -> bool:
         return False
     messageContent = getAcceptedEmail(firstName, lastName)
     subjectLine = getAcceptedSubjectLine()
-    return sendEmail(emailAddresses=emailAddress, subject=subjectLine, content=messageContent)
+    return sendEmailToSingleRecipient(emailAddress=emailAddress, subject=subjectLine, content=messageContent)
 
 
 def sendRejectedEmail(userId) -> bool:
@@ -104,21 +139,21 @@ def sendRejectedEmail(userId) -> bool:
         return False
     messageContent = getRejectedEmail(firstName, lastName)
     subjectLine = getRejectedSubjectLine()
-    return sendEmail(emailAddresses=emailAddress, subject=subjectLine, content=messageContent)
+    return sendEmailToSingleRecipient(emailAddress=emailAddress, subject=subjectLine, content=messageContent)
 
 
-def sendEmail(emailAddresses: Union[List[str], str], subject, content) -> bool:
+def sendEmailToSingleRecipient(emailAddress: str, subject, content) -> bool:
     """
-    Send emailType to user based on id
+    Send email with subject line and content to email address
     :param subject: subject line of the email
-    :param emailAddresses:  single or list of string email addresses to send email to
+    :param emailAddress:  single email address to send email to
     :param content: HTML to send
     :return:
     """
 
     message = Mail(
         from_email=WICHACKS_EMAIL,
-        to_emails=emailAddresses,
+        to_emails=emailAddress,
         subject=subject,
         html_content=content
     )
@@ -132,6 +167,26 @@ def sendEmail(emailAddresses: Union[List[str], str], subject, content) -> bool:
     return True
 
 
+def sendGroupEmail(emailAddresses: List[str], subject, content) -> Tuple[List[str], bool]:
+    """
+    Send email to group of users
+    :param subject: subject line of the email
+    :param emailAddresses:  single or list of string email addresses to send email to
+    :param content: HTML to send
+    :return: list of emails that the email failed to send to
+    """
+    failedEmailList = []
+    for email in emailAddresses:
+        emailSuccessfullySent = sendEmailToSingleRecipient(emailAddress=email, subject=subject, content=content)
+        if not emailSuccessfullySent:
+            failedEmailList.append(email)
+    emailsSuccessful = True
+    if len(failedEmailList) > 0:
+        emailsSuccessful = False
+        logger.error("Sending Group Email Failed. Email errors for: %s", failedEmailList)
+    return failedEmailList, emailsSuccessful
+
+
 def getSendGridClient():
     """
     Return Send Grid Api Client

api/src/data/email.py

@@ -0,0 +1,47 @@
+<body style="margin: 0; padding: 0;">
+    <div style="font-family: Verdana, Geneva, Tahoma, sans-serif; margin: 0; padding: 0;">
+        <div style="align-content: center;"> <!-- header -->
+            <img alt="WiCHacks 2023 Banner" src="https://raw.githubusercontent.com/Women-in-Computing-at-RIT/WicHacker-Manager/main/assets/centered-banner.png" style="max-width: 100%; max-height: 100%;"/>
+        </div>
+
+        <div style="margin: 10px"> <!-- Email Body -->
+            <p>Hi first_name last_name,</p>
+            <p>Thank you for confirming your attendance of WiCHacks! Keep an eye on your email in the coming days for more information including instructions for how to join our Discord server for the event, as well as how to best prepare!</p>
+            <p>We can't wait to see you online or in person, it's going to be a great event!</p>
+
+            <p>Until Next Time,</p>
+            <p>The WiCHacks Team</p>
+
+            <div style="background-color: #f0e1f4; border-radius: 10px; padding: 10px; margin: 10px;"> <!-- FAQ Section -->
+                <h3 style="padding: 0%;">FAQs</h3>
+                <h4>I still have questions! What do I do?</h4>
+                <p>Send us an email! You can reach us at <a href="mailto:wichacks@rit.edu">wichacks@rit.edu</a></p>
+            </div>
+        </div>
+
+        <div style="color: black; background-color: lightgray; font-size: small; text-align: center; padding: 10px;"> <!-- footer -->
+            <p>WiCHacks 2023</p>
+            <p>Women in Computing @ Rochester Institute of Technology</p>
+            <a href="https://wichacks.io" target="_blank" style="display: inline-block; text-decoration: none; color: #4e1560;">
+                <div> <!-- Link to website -->
+                    <svg style="display: inline-block; vertical-align: middle;" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512" width="20" height="20"><!--! Font Awesome Pro 6.2.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license (Commercial License) Copyright 2022 Fonticons, Inc. --><path fill="#4e1560" d="M0 336c0 79.5 64.5 144 144 144H512c70.7 0 128-57.3 128-128c0-61.9-44-113.6-102.4-125.4c4.1-10.7 6.4-22.4 6.4-34.6c0-53-43-96-96-96c-19.7 0-38.1 6-53.3 16.2C367 64.2 315.3 32 256 32C167.6 32 96 103.6 96 192c0 2.7 .1 5.4 .2 8.1C40.2 219.8 0 273.2 0 336z"/></svg>
+                    <p style="display: inline-block; vertical-align: middle; text-decoration: underline;">https://wichacks.io</p>
+                </div>
+            </a>
+            <div> <!-- Social Medias -->
+                <!-- Instagram Icon -->
+                <a href="https://www.instagram.com/wichacks/" target="_blank" style="text-decoration: none;">
+                    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512" width="30" height="30"><!--! Font Awesome Pro 6.2.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license (Commercial License) Copyright 2022 Fonticons, Inc. --><path fill="#4e1560" d="M224.1 141c-63.6 0-114.9 51.3-114.9 114.9s51.3 114.9 114.9 114.9S339 319.5 339 255.9 287.7 141 224.1 141zm0 189.6c-41.1 0-74.7-33.5-74.7-74.7s33.5-74.7 74.7-74.7 74.7 33.5 74.7 74.7-33.6 74.7-74.7 74.7zm146.4-194.3c0 14.9-12 26.8-26.8 26.8-14.9 0-26.8-12-26.8-26.8s12-26.8 26.8-26.8 26.8 12 26.8 26.8zm76.1 27.2c-1.7-35.9-9.9-67.7-36.2-93.9-26.2-26.2-58-34.4-93.9-36.2-37-2.1-147.9-2.1-184.9 0-35.8 1.7-67.6 9.9-93.9 36.1s-34.4 58-36.2 93.9c-2.1 37-2.1 147.9 0 184.9 1.7 35.9 9.9 67.7 36.2 93.9s58 34.4 93.9 36.2c37 2.1 147.9 2.1 184.9 0 35.9-1.7 67.7-9.9 93.9-36.2 26.2-26.2 34.4-58 36.2-93.9 2.1-37 2.1-147.8 0-184.8zM398.8 388c-7.8 19.6-22.9 34.7-42.6 42.6-29.5 11.7-99.5 9-132.1 9s-102.7 2.6-132.1-9c-19.6-7.8-34.7-22.9-42.6-42.6-11.7-29.5-9-99.5-9-132.1s-2.6-102.7 9-132.1c7.8-19.6 22.9-34.7 42.6-42.6 29.5-11.7 99.5-9 132.1-9s102.7-2.6 132.1 9c19.6 7.8 34.7 22.9 42.6 42.6 11.7 29.5 9 99.5 9 132.1s2.7 102.7-9 132.1z"/></svg>
+                </a>
+                <!-- Twitter Icon -->
+                <a href="https://twitter.com/wichacks?lang=en" target="_blank" style="text-decoration: none; margin-left: 10px;">
+                    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" width="30" height="30"><!--! Font Awesome Pro 6.2.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license (Commercial License) Copyright 2022 Fonticons, Inc. --><path fill="#4e1560" d="M459.37 151.716c.325 4.548.325 9.097.325 13.645 0 138.72-105.583 298.558-298.558 298.558-59.452 0-114.68-17.219-161.137-47.106 8.447.974 16.568 1.299 25.34 1.299 49.055 0 94.213-16.568 130.274-44.832-46.132-.975-84.792-31.188-98.112-72.772 6.498.974 12.995 1.624 19.818 1.624 9.421 0 18.843-1.3 27.614-3.573-48.081-9.747-84.143-51.98-84.143-102.985v-1.299c13.969 7.797 30.214 12.67 47.431 13.319-28.264-18.843-46.781-51.005-46.781-87.391 0-19.492 5.197-37.36 14.294-52.954 51.655 63.675 129.3 105.258 216.365 109.807-1.624-7.797-2.599-15.918-2.599-24.04 0-57.828 46.782-104.934 104.934-104.934 30.213 0 57.502 12.67 76.67 33.137 23.715-4.548 46.456-13.32 66.599-25.34-7.798 24.366-24.366 44.833-46.132 57.827 21.117-2.273 41.584-8.122 60.426-16.243-14.292 20.791-32.161 39.308-52.628 54.253z"/></svg>
+                </a>
+                <!-- Facebook Icon -->
+                <a href="https://www.facebook.com/wic.hacks.rit/" target="_blank" style="text-decoration: none; margin-left: 10px;">
+                    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" width="30" height="30"><!--! Font Awesome Pro 6.2.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license (Commercial License) Copyright 2022 Fonticons, Inc. --><path fill="#4e1560" d="M504 256C504 119 393 8 256 8S8 119 8 256c0 123.78 90.69 226.38 209.25 245V327.69h-63V256h63v-54.64c0-62.15 37-96.48 93.67-96.48 27.14 0 55.52 4.84 55.52 4.84v61h-31.28c-30.8 0-40.41 19.12-40.41 38.73V256h68.78l-11 71.69h-57.78V501C413.31 482.38 504 379.78 504 256z"/></svg>
+                </a>
+            </div>
+        </div>
+    </div>
+</body>

api/src/data/emailTemplates/confirmed.html

@@ -1,6 +1,47 @@
 def getConfirmedEmail(firstName, lastName):
-    return f'Confirmed Email Template'
+    try:
+        appliedEmail = open('./src/data/emailTemplates/confirmed.html', 'r')
+        contents = appliedEmail.read()
+        appliedEmail.close()
+        contents = contents.replace("first_name", firstName).replace("last_name", lastName)
+        return contents
+    except:
+        return f'<div>' \
+               f'   <div>' \
+               f'       <h3>Hello {firstName} {lastName}</h3>' \
+               f'       <p>' \
+               f'           Thank you, your attendance has been confirmed.' \
+               f'       </p>' \
+               f'   </div>' \
+               f'</div>'
 
 
 def getConfirmedSubjectLine() -> str:
     return "WiCHacks Confirmation"
+
+
+def getRequestConfirmedEmail():
+    try:
+        appliedEmail = open('./src/data/emailTemplates/requestConfirmed.html', 'r')
+        contents = appliedEmail.read()
+        appliedEmail.close()
+        return contents
+    except:
+        return f'<div>' \
+               f'   <div>' \
+               f'       <h3>Hello!</h3>' \
+               f'       <p>' \
+               f'           As WiCHacks approaches, we ask you to confirm your attendance of WiCHacks. ' \
+               f'           This helps the organizers finalize our planning to provide the best event possible.' \
+               f'' \
+               f'           Please login to your application homepage at apply.wichacks.io confirm your attendance' \
+               f'' \
+               f'           Thank you,' \
+               f'           WiCHacks Organizers' \
+               f'       </p>' \
+               f'   </div>' \
+               f'</div>'
+
+
+def getRequestConfirmedSubjectLine() -> str:
+    return "WiCHacks RSVP"