Feature/send email (#88)

* Added files for sending invitations by email

This includes
- templates
- routes and internal code
- configuration
- tests

Co-authored-by: leddest <46251307+leddest@users.noreply.github.com>
Co-authored-by: Ellen <ellenc345@gmail.com>

Author: 3 people

.gitignore

@@ -1,7 +1,6 @@
 dev.db
 test.db
 config.py
-.vscode/settings.json
 
 # Byte-compiled / optimized / DLL files
 __pycache__/
@@ -142,4 +141,5 @@ dmypy.json
 .vscode/
 app/.vscode/
 
-app/routers/stam
+# PyCharm
+.idea

app/config.py.example

@@ -2,6 +2,7 @@ import os
 
 from fastapi_mail import ConnectionConfig
 from pydantic import BaseSettings
+from starlette.templating import Jinja2Templates
 
 
 class Settings(BaseSettings):
@@ -45,6 +46,15 @@ email_conf = ConnectionConfig(
     USE_CREDENTIALS=True,
 )
 
+templates = Jinja2Templates(directory=os.path.join("app", "templates"))
+
+# application name
+CALENDAR_SITE_NAME = "Calendar"
+# link to the home page of the application
+CALENDAR_HOME_PAGE = "calendar.pythonic.guru"
+# link to the application registration page
+CALENDAR_REGISTRATION_PAGE = r"calendar.pythonic.guru/registration"
+
 # import
 MAX_FILE_SIZE_MB = 5  # 5MB
 VALID_FILE_EXTENSION = (".txt", ".csv", ".ics")  # Can import only these files.
@@ -54,6 +64,7 @@ EVENT_HEADER_NOT_EMPTY = 1  # 1- for not empty, 0- for empty.
 EVENT_HEADER_LIMIT = 50  # Max characters for event header.
 EVENT_CONTENT_LIMIT = 500  # Max characters for event characters.
 MAX_EVENTS_START_DATE = 10  # Max Events with the same start date.
+
 # PATHS
 STATIC_ABS_PATH = os.path.abspath("static")
 

app/database/models.py

@@ -1,12 +1,13 @@
 from datetime import datetime
 
-from app.config import PSQL_ENVIRONMENT
-from app.database.database import Base
 from sqlalchemy import (DDL, Boolean, Column, DateTime, ForeignKey, Index,
                         Integer, String, event)
 from sqlalchemy.dialects.postgresql import TSVECTOR
 from sqlalchemy.orm import relationship
 
+from app.config import PSQL_ENVIRONMENT
+from app.database.database import Base
+
 
 class UserEvent(Base):
     __tablename__ = "user_event"

app/internal/email.py

@@ -1,7 +1,15 @@
-from app.config import email_conf
+import os
+from typing import List, Optional
+
+
+from app.config import (email_conf, templates,
+                        CALENDAR_SITE_NAME, CALENDAR_HOME_PAGE,
+                        CALENDAR_REGISTRATION_PAGE)
 from app.database.models import Event, User
-from fastapi import BackgroundTasks
+from fastapi import BackgroundTasks, UploadFile
 from fastapi_mail import FastMail, MessageSchema
+from pydantic import EmailStr
+from pydantic.errors import EmailError
 from sqlalchemy.orm.session import Session
 
 mail = FastMail(email_conf)
@@ -31,10 +39,142 @@ def send(
         User.id == user_to_send).first()
     if not user_to_send or not event_used:
         return False
-    message = MessageSchema(
-        subject=f"{title} {event_used.title}",
-        recipients={"email": [user_to_send.email]}.get("email"),
-        body=f"begins at:{event_used.start} : {event_used.content}",
-    )
-    background_tasks.add_task(mail.send_message, message)
+    if not verify_email_pattern(user_to_send.email):
+        return False
+
+    subject = f"{title} {event_used.title}"
+    recipients = {"email": [user_to_send.email]}.get("email")
+    body = f"begins at:{event_used.start} : {event_used.content}"
+
+    background_tasks.add_task(send_internal,
+                              subject=subject,
+                              recipients=recipients,
+                              body=body)
     return True
+
+
+def send_email_invitation(sender_name: str,
+                          recipient_name: str,
+                          recipient_mail: str,
+                          background_tasks: BackgroundTasks = BackgroundTasks
+                          ) -> bool:
+    """
+    This function takes as parameters the sender's name,
+    the recipient's name and his email address, configuration, and
+    sends the recipient an invitation to his email address in
+    the format HTML.
+    :param sender_name: str, the sender's name
+    :param recipient_name: str, the recipient's name
+    :param recipient_mail: str, the recipient's email address
+    :param background_tasks: (BackgroundTasks): Function from fastapi that lets
+            you apply tasks in the background.
+    :return: bool, True if the invitation was successfully
+    sent to the recipient, and False if the entered
+    email address is incorrect.
+    """
+    if not verify_email_pattern(recipient_mail):
+        return False
+
+    if not recipient_name:
+        return False
+
+    if not sender_name:
+        return False
+
+    template = templates.get_template("invite_mail.html")
+    html = template.render(recipient=recipient_name, sender=sender_name,
+                           site_name=CALENDAR_SITE_NAME,
+                           registration_link=CALENDAR_REGISTRATION_PAGE,
+                           home_link=CALENDAR_HOME_PAGE,
+                           addr_to=recipient_mail)
+
+    subject = "Invitation"
+    recipients = [recipient_mail]
+    body = html
+    subtype = "html"
+
+    background_tasks.add_task(send_internal,
+                              subject=subject,
+                              recipients=recipients,
+                              body=body,
+                              subtype=subtype)
+    return True
+
+
+def send_email_file(file_path: str,
+                    recipient_mail: str,
+                    background_tasks: BackgroundTasks = BackgroundTasks):
+    """
+    his function takes as parameters the file's path,
+    the recipient's email address, configuration, and
+    sends the recipient an file to his email address.
+    :param file_path: str, the file's path
+    :param recipient_mail: str, the recipient's email address
+    :param background_tasks: (BackgroundTasks): Function from fastapi that lets
+            you apply tasks in the background.
+    :return: bool, True if the file was successfully
+    sent to the recipient, and False if the entered
+    email address is incorrect or file does not exist.
+    """
+    if not verify_email_pattern(recipient_mail):
+        return False
+
+    if not os.path.exists(file_path):
+        return False
+
+    subject = "File"
+    recipients = [recipient_mail]
+    body = "file"
+    file_attachments = [file_path]
+
+    background_tasks.add_task(send_internal,
+                              subject=subject,
+                              recipients=recipients,
+                              body=body,
+                              file_attachments=file_attachments)
+    return True
+
+
+async def send_internal(subject: str,
+                        recipients: List[str],
+                        body: str,
+                        subtype: Optional[str] = None,
+                        file_attachments: Optional[List[str]] = None):
+    if file_attachments is None:
+        file_attachments = []
+
+    message = MessageSchema(
+         subject=subject,
+         recipients=[EmailStr(recipient) for recipient in recipients],
+         body=body,
+         subtype=subtype,
+         attachments=[UploadFile(file_attachment)
+                      for file_attachment in file_attachments])
+
+    return await send_internal_internal(message)
+
+
+async def send_internal_internal(msg: MessageSchema):
+    """
+    This function receives message and
+    configuration as parameters and sends the message.
+    :param msg: MessageSchema, message
+    :return: None
+    """
+    await mail.send_message(msg)
+
+
+def verify_email_pattern(email: str) -> bool:
+    """
+    This function checks the correctness
+    of the entered email address
+    :param email: str, the entered email address
+    :return: bool,
+    True if the entered email address is correct,
+    False if the entered email address is incorrect.
+    """
+    try:
+        EmailStr.validate(email)
+        return True
+    except EmailError:
+        return False

app/internal/search.py

@@ -1,8 +1,9 @@
 from typing import List
 
+from sqlalchemy.exc import SQLAlchemyError
+
 from app.database.database import SessionLocal
 from app.database.models import Event
-from sqlalchemy.exc import SQLAlchemyError
 
 
 def get_stripped_keywords(keywords: str) -> str:

app/internal/weather_forecast.py

@@ -1,11 +1,11 @@
 import datetime
-import frozendict
 import functools
+
+import frozendict
 import requests
 
 from app import config
 
-
 # This feature requires an API KEY
 #  get yours free @ visual-crossing-weather.p.rapidapi.com
 

app/routers/dayview.py

@@ -9,7 +9,6 @@
 from app.database.models import Event, User
 from app.dependencies import TEMPLATES_PATH
 
-
 templates = Jinja2Templates(directory=TEMPLATES_PATH)
 
 

app/routers/email.py

@@ -1,6 +1,9 @@
 from app.database.database import get_db
 from app.internal.email import send as internal_send
+from app.internal.email import send_email_invitation
 from fastapi import APIRouter, BackgroundTasks, Depends, Form, HTTPException
+from pydantic import BaseModel, EmailStr
+from pydantic.errors import EmailError
 from sqlalchemy.orm.session import Session
 from starlette.responses import RedirectResponse
 
@@ -26,3 +29,42 @@ async def send(
             background_tasks=background_tasks, session=db):
         raise HTTPException(status_code=404, detail="Couldn't send the email!")
     return RedirectResponse(send_to, status_code=303)
+
+
+INVALID_EMAIL_ADDRESS_ERROR_MESSAGE = "Please enter valid email address"
+SUCCESSFULLY_SENT_EMAIL_MESSAGE = "Your message was sent successfully"
+
+
+class InvitationParams(BaseModel):
+    send_to: str = "/"
+    sender_name: str
+    recipient_name: str
+    recipient_mail: str
+
+
+@router.post("/invitation/")
+def send_invitation(invitation: InvitationParams,
+                    background_task: BackgroundTasks):
+    """
+    This function sends the recipient an invitation
+    to his email address in the format HTML.
+    :param invitation: InvitationParams, invitation parameters
+    :param background_task: BackgroundTasks
+    :return: json response message,
+    error message if the entered email address is incorrect,
+    confirmation message if the invitation was successfully sent
+    """
+    try:
+        EmailStr.validate(invitation.recipient_mail)
+    except EmailError:
+        raise HTTPException(
+            status_code=422,
+            detail=INVALID_EMAIL_ADDRESS_ERROR_MESSAGE)
+
+    if not send_email_invitation(
+            sender_name=invitation.sender_name,
+            recipient_name=invitation.recipient_name,
+            recipient_mail=invitation.recipient_mail,
+            background_tasks=background_task):
+        raise HTTPException(status_code=422, detail="Couldn't send the email!")
+    return RedirectResponse(invitation.send_to, status_code=303)

app/routers/event_images.py

@@ -1,11 +1,11 @@
-from app import config
+import re
 from functools import lru_cache
-from nltk.tokenize import word_tokenize
 from typing import Optional
-from word_forms.lemmatizer import lemmatize
 
-import re
+from nltk.tokenize import word_tokenize
+from word_forms.lemmatizer import lemmatize
 
+from app import config
 
 FLAIRS_EXTENSION = '.jpg'
 FLAIRS_REL_PATH = f'{config.STATIC_ABS_PATH}\\event_flairs'

app/routers/export.py

@@ -1,8 +1,8 @@
 from datetime import datetime
 from typing import List
 
-from icalendar import Calendar, Event, vCalAddress, vText
 import pytz
+from icalendar import Calendar, Event, vCalAddress, vText
 
 from app.config import DOMAIN, ICAL_VERSION, PRODUCT_ID
 from app.database.models import Event as UserEvent