Merge branch 'develop' into feature/keyboard-shortcuts

Author: YairEn

.gitignore

@@ -138,7 +138,6 @@ dmypy.json
 # Pyre type checker
 .pyre/
 
-
 # VScode
 .vscode/
 app/.vscode/

app/config.py.example

@@ -13,7 +13,7 @@ class Settings(BaseSettings):
         env_file = ".env"
 
 
-# general
+# GENERAL
 DOMAIN = 'Our-Domain'
 
 # DATABASE
@@ -29,11 +29,11 @@ AVATAR_SIZE = (120, 120)
 # API-KEYS
 WEATHER_API_KEY = os.getenv('WEATHER_API_KEY')
 
-# export
+# EXPORT
 ICAL_VERSION = '2.0'
 PRODUCT_ID = '-//Our product id//'
 
-# email
+# EMAIL
 email_conf = ConnectionConfig(
     MAIL_USERNAME=os.getenv("MAIL_USERNAME") or "user",
     MAIL_PASSWORD=os.getenv("MAIL_PASSWORD") or "password",
@@ -47,3 +47,14 @@ email_conf = ConnectionConfig(
 
 # PATHS
 STATIC_ABS_PATH = os.path.abspath("static")
+
+# LOGGER
+LOG_PATH = "./var/log"
+LOG_FILENAME = "calendar.log"
+LOG_LEVEL = "error"
+LOG_ROTATION_INTERVAL = "20 days"
+LOG_RETENTION_INTERVAL = "1 month"
+LOG_FORMAT = ("<level>{level: <8}</level>"
+              " <green>{time:YYYY-MM-DD HH:mm:ss.SSS}</green>"
+              " - <cyan>{name}</cyan>:<cyan>{function}</cyan>"
+              " - <level>{message}</level>")

app/database/models.py

@@ -108,3 +108,11 @@ def __repr__(self):
             f'({self.event.owner}'
             f'to {self.recipient})>'
         )
+
+
+class Quote(Base):
+    __tablename__ = "quotes"
+
+    id = Column(Integer, primary_key=True, index=True)
+    text = Column(String, nullable=False)
+    author = Column(String)

app/internal/logger_customizer.py

@@ -0,0 +1,94 @@
+import sys
+
+from pathlib import Path
+from loguru import logger, _Logger as Logger
+
+
+class LoggerConfigError(Exception):
+    pass
+
+
+class LoggerCustomizer:
+
+    @classmethod
+    def make_logger(cls, log_path: Path,
+                    log_filename: str,
+                    log_level: str,
+                    log_rotation_interval: str,
+                    log_retention_interval: str,
+                    log_format: str) -> Logger:
+        """Creates a logger from given configurations
+
+        Args:
+            log_path (Path): Path where the log file is located
+            log_filename (str):
+
+            log_level (str): The level we want to start logging from
+            log_rotation_interval (str): Every how long the logs
+                would be rotated
+            log_retention_interval (str): Amount of time in words defining
+                how long the log will be kept
+            log_format (str): The logging format
+
+        Raises:
+            LoggerConfigError: Error raised when the configuration is invalid
+
+        Returns:
+            Logger: Loguru logger instance
+        """
+        try:
+            logger = cls.customize_logging(
+                file_path=Path(log_path) / Path(log_filename),
+                level=log_level,
+                retention=log_retention_interval,
+                rotation=log_rotation_interval,
+                format=log_format
+            )
+        except (TypeError, ValueError) as err:
+            raise LoggerConfigError(
+                f"You have an issue with the logger configuration: {err!r}, "
+                "fix it please")
+
+        return logger
+
+    @classmethod
+    def customize_logging(cls,
+                          file_path: Path,
+                          level: str,
+                          rotation: str,
+                          retention: str,
+                          format: str
+                          ) -> Logger:
+        """Used to customize the logger instance
+
+        Args:
+            file_path (Path): Path where the log file is located
+            level (str): The level wanted to start logging from
+            rotation (str): Every how long the logs would be
+                rotated(creation of new file)
+            retention (str): Amount of time in words defining how
+                long a log is kept
+            format (str): The logging format
+
+        Returns:
+            Logger: Instance of a logger mechanism
+        """
+        logger.remove()
+        logger.add(
+            sys.stdout,
+            enqueue=True,
+            backtrace=True,
+            level=level.upper(),
+            format=format
+        )
+        logger.add(
+            str(file_path),
+            rotation=rotation,
+            retention=retention,
+            enqueue=True,
+            backtrace=True,
+            level=level.upper(),
+            format=format
+        )
+
+        return logger

app/internal/quotes/daily_quotes.py

@@ -0,0 +1,21 @@
+from datetime import date
+from typing import Optional
+
+from app.database.models import Quote
+
+from sqlalchemy.orm import Session
+from sqlalchemy.sql.expression import func
+
+TOTAL_DAYS = 366
+
+
+def quote_per_day(
+        session: Session, date: date = date.today()
+        ) -> Optional[Quote]:
+    """This function provides a daily quote, relevant to the current
+    day of the year. The quote is randomally selected from a set
+    of quotes matching to the given day"""
+    day_num = date.timetuple().tm_yday
+    quote = session.query(Quote).filter(
+        Quote.id % TOTAL_DAYS == day_num).order_by(func.random()).first()
+    return quote

app/internal/quotes/load_quotes.py

@@ -0,0 +1,41 @@
+import json
+from typing import Dict, List, Optional
+
+from app.database.models import Quote
+
+from sqlalchemy.orm import Session
+
+
+def get_quotes_from_json() -> List[Dict[str, Optional[str]]]:
+    """This function reads all of the daily quotes from a specific JSON file.
+    The JSON file content is copied from the free API:
+    'https://type.fit/api/quotes'. I saved the content so the API won't be
+    called every time the app is initialized."""
+    try:
+        with open('app/resources/quotes.json', 'r') as f:
+            quotes_list = json.load(f)
+    except (IOError, ValueError):
+        return []
+    return quotes_list
+
+
+def add_quotes_to_db(session: Session) -> None:
+    """This function reads the quotes and inserts them into the db"""
+    all_quotes = get_quotes_from_json()
+    quotes_objects = [
+        Quote(text=quote['text'], author=quote['author'])
+        for quote in all_quotes
+        ]
+    session.add_all(quotes_objects)
+    session.commit()
+
+
+def is_quotes_table_empty(session: Session) -> bool:
+    return session.query(Quote).count() == 0
+
+
+def load_daily_quotes(session: Session) -> None:
+    """This function loads the daily quotes to the db,
+    if they weren't already loaden"""
+    if is_quotes_table_empty(session):
+        add_quotes_to_db(session)

app/main.py

@@ -1,14 +1,19 @@
-from fastapi import FastAPI, Request
+from fastapi import Depends, FastAPI, Request
 from fastapi.staticfiles import StaticFiles
+from sqlalchemy.orm import Session
 
 from app.config import PSQL_ENVIRONMENT
 from app.database import models
-from app.database.database import engine
+from app.database.database import engine, get_db
 from app.dependencies import (
     MEDIA_PATH, STATIC_PATH, templates)
+from app.internal.quotes import load_quotes, daily_quotes
 from app.routers import (
-    agenda, dayview, email, event, invitation, profile, search, telegram, keyboard_shortcuts)
+    agenda, dayview, email, event, invitation, profile, search, telegram, keyboard_shortcuts, whatsapp)
+
 from app.telegram.bot import telegram_bot
+from app.internal.logger_customizer import LoggerCustomizer
+from app import config
 
 
 def create_tables(engine, psql_environment):
@@ -27,22 +32,39 @@ def create_tables(engine, psql_environment):
 app.mount("/static", StaticFiles(directory=STATIC_PATH), name="static")
 app.mount("/media", StaticFiles(directory=MEDIA_PATH), name="media")
 
+load_quotes.load_daily_quotes(next(get_db()))
+
+# Configure logger
+logger = LoggerCustomizer.make_logger(config.LOG_PATH,
+                                      config.LOG_FILENAME,
+                                      config.LOG_LEVEL,
+                                      config.LOG_ROTATION_INTERVAL,
+                                      config.LOG_RETENTION_INTERVAL,
+                                      config.LOG_FORMAT)
+app.logger = logger
+
 app.include_router(profile.router)
 app.include_router(event.router)
 app.include_router(agenda.router)
 app.include_router(telegram.router)
 app.include_router(dayview.router)
 app.include_router(email.router)
 app.include_router(invitation.router)
+app.include_router(whatsapp.router)
 app.include_router(search.router)
 app.include_router(keyboard_shortcuts.router)
 
 telegram_bot.set_webhook()
 
 
+# TODO: I add the quote day to the home page
+# until the relavent calendar view will be developed.
 @app.get("/")
-async def home(request: Request):
+@app.logger.catch()
+async def home(request: Request, db: Session = Depends(get_db)):
+    quote = daily_quotes.quote_per_day(db)
     return templates.TemplateResponse("home.html", {
         "request": request,
         "message": "Hello, World!",
+        "quote": quote
     })