Merge branch 'develop' of https://github.com/PythonFreeCourse/calendar into horoscope

Author: nadav-pesach

.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

README.md

@@ -1,7 +1,7 @@
 # PyLander
 
-<p align="center">
-  <img title="Apache-2.0" src="https://img.shields.io/github/license/PythonFreeCourse/calendar.svg">
+<p style="text-align:center">
+  <img title="Apache-2.0" alt="License Apache-2.0 icon" src="https://img.shields.io/github/license/PythonFreeCourse/calendar.svg">
 </p>
 
 👋 Welcome to Open Source Calendar built with Python. 🐍
@@ -39,5 +39,11 @@ cp app/config.py.example app/configuration.py
 # Edit the variables' values.
 uvicorn app.main:app --reload
 ```
+### Running tests
+```shell
+python -m pytest --cov-report term-missing --cov=app tests
+```
+
 ## Contributing
 View [contributing guidelines](https://github.com/PythonFreeCourse/calendar/blob/master/CONTRIBUTING.md).
+

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"
@@ -30,6 +31,7 @@ class User(Base):
     email = Column(String, unique=True, nullable=False)
     password = Column(String, nullable=False)
     full_name = Column(String)
+    language = Column(String)
     description = Column(String, default="Happy new user!")
     avatar = Column(String, default="profile.png")
     telegram_id = Column(String, unique=True)

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/translation.py

@@ -0,0 +1,82 @@
+from typing import Optional
+
+from iso639 import languages
+from textblob import TextBlob, download_corpora
+from textblob.exceptions import NotTranslated
+
+from app.database.database import SessionLocal
+from loguru import logger
+
+from app.routers.user import get_users
+
+download_corpora.download_all()
+
+
+def translate_text(text: str,
+                   target_lang: str,
+                   original_lang: Optional[str] = None
+                   ) -> str:
+    """
+    Translate text to the target language
+    optionally given the original language
+    """
+    if not text.strip():
+        return ""
+    if original_lang is None:
+        original_lang = _detect_text_language(text)
+    else:
+        original_lang = _lang_full_to_short(original_lang)
+
+    if original_lang == _lang_full_to_short(target_lang):
+        return text
+
+    try:
+        return str(TextBlob(text).translate(
+            from_lang=original_lang,
+            to=_lang_full_to_short(target_lang)))
+    except NotTranslated:
+        return text
+
+
+def _detect_text_language(text: str) -> str:
+    """
+    Gets some text and returns the language it is in
+    Uses external API
+    """
+    return str(TextBlob(text).detect_language())
+
+
+def _get_user_language(user_id: int, session: SessionLocal) -> str:
+    """
+    Gets a user-id and returns the language he speaks
+    Uses the DB"""
+    try:
+        user = get_users(session, id=user_id)[0]
+    except IndexError:
+        logger.exception(
+            "User was not found in the database."
+        )
+        return ""
+    else:
+        return user.language
+
+
+def translate_text_for_user(text: str,
+                            session: SessionLocal,
+                            user_id: int) -> str:
+    """
+    Gets a text and a user-id and returns the text,
+    translated to the language the user speaks
+    """
+    target_lang = _get_user_language(user_id, session)
+    if not target_lang:
+        return text
+    return translate_text(text, target_lang)
+
+
+def _lang_full_to_short(full_lang: str) -> str:
+    """
+    Gets the full language name and
+    converts it to a two-letter language name
+    """
+    return languages.get(name=full_lang.capitalize()).alpha2

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/__init__.py

@@ -1,4 +1,3 @@
 import nltk
 
-
 nltk.download('punkt')

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)