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

Author: nadav-pesach

.gitignore

@@ -13,6 +13,8 @@ __pycache__/
 # Distribution / packaging
 .Python
 build/
+Scripts/
+include/
 develop-eggs/
 dist/
 downloads/
@@ -30,6 +32,8 @@ share/python-wheels/
 .installed.cfg
 *.egg
 MANIFEST
+pyvenv.cfg
+
 
 # PyInstaller
 #  Usually these files are written by a python script from a template
@@ -116,6 +120,7 @@ venv/
 ENV/
 env.bak/
 venv.bak/
+.vscode/
 Scripts/*
 pyvenv.cfg
 

README.md

@@ -35,7 +35,7 @@ uvicorn app.main:app --reload
 python -m venv venv
 source venv/bin/activate
 pip install -r requirements.txt
-cp app/config.py.example app/configuration.py
+cp app/config.py.example app/config.py
 # Edit the variables' values.
 uvicorn app.main:app --reload
 ```

app/database/database.py

@@ -2,7 +2,7 @@
 
 from sqlalchemy import create_engine
 from sqlalchemy.ext.declarative import declarative_base
-from sqlalchemy.orm import sessionmaker
+from sqlalchemy.orm import Session, sessionmaker
 
 from app import config
 
@@ -25,7 +25,7 @@ def create_env_engine(psql_environment, sqlalchemy_database_url):
 Base = declarative_base()
 
 
-def get_db():
+def get_db() -> Session:
     db = SessionLocal()
     try:
         yield db

app/database/models.py

@@ -1,12 +1,17 @@
+from __future__ import annotations
+
 from datetime import datetime
+from typing import Dict, Any
 
 from sqlalchemy import (DDL, Boolean, Column, DateTime, ForeignKey, Index,
-                        Integer, String, event)
+                        Integer, String, event, UniqueConstraint)
 from sqlalchemy.dialects.postgresql import TSVECTOR
-from sqlalchemy.orm import relationship
+from sqlalchemy.exc import IntegrityError, SQLAlchemyError
+from sqlalchemy.orm import relationship, Session
 
 from app.config import PSQL_ENVIRONMENT
 from app.database.database import Base
+from app.dependencies import logger
 
 
 class UserEvent(Base):
@@ -52,11 +57,12 @@ class Event(Base):
     end = Column(DateTime, nullable=False)
     content = Column(String)
     location = Column(String)
+    color = Column(String, nullable=True)
 
-    owner = relationship("User")
     owner_id = Column(Integer, ForeignKey("users.id"))
-    color = Column(String, nullable=True)
+    category_id = Column(Integer, ForeignKey("categories.id"))
 
+    owner = relationship("User")
     participants = relationship("UserEvent", back_populates="events")
 
     # PostgreSQL
@@ -66,12 +72,45 @@ class Event(Base):
             'events_tsv_idx',
             'events_tsv',
             postgresql_using='gin'),
-            )
+        )
 
     def __repr__(self):
         return f'<Event {self.id}>'
 
 
+class Category(Base):
+    __tablename__ = "categories"
+
+    __table_args__ = (
+        UniqueConstraint('user_id', 'name', 'color'),
+    )
+    id = Column(Integer, primary_key=True, index=True)
+    name = Column(String, nullable=False)
+    color = Column(String, nullable=False)
+    user_id = Column(Integer, ForeignKey("users.id"), nullable=False)
+
+    @staticmethod
+    def create(db_session: Session, name: str, color: str,
+               user_id: int) -> Category:
+        try:
+            category = Category(name=name, color=color, user_id=user_id)
+            db_session.add(category)
+            db_session.flush()
+            db_session.commit()
+            db_session.refresh(category)
+        except (SQLAlchemyError, IntegrityError) as e:
+            logger.error(f"Failed to create category: {e}")
+            raise e
+        else:
+            return category
+
+    def to_dict(self) -> Dict[str, Any]:
+        return {c.name: getattr(self, c.name) for c in self.__table__.columns}
+
+    def __repr__(self) -> str:
+        return f'<Category {self.id} {self.name} {self.color}>'
+
+
 class PSQLEnvironmentError(Exception):
     pass
 
@@ -89,7 +128,7 @@ class PSQLEnvironmentError(Exception):
         Event.__table__,
         'after_create',
         trigger_snippet.execute_if(dialect='postgresql')
-        )
+    )
 
 
 class Invitation(Base):
@@ -118,3 +157,22 @@ class Quote(Base):
     id = Column(Integer, primary_key=True, index=True)
     text = Column(String, nullable=False)
     author = Column(String)
+
+
+class Zodiac(Base):
+    __tablename__ = "zodiac-signs"
+
+    id = Column(Integer, primary_key=True, index=True)
+    name = Column(String, nullable=False)
+    start_month = Column(Integer, nullable=False)
+    start_day_in_month = Column(Integer, nullable=False)
+    end_month = Column(Integer, nullable=False)
+    end_day_in_month = Column(Integer, nullable=False)
+
+    def __repr__(self):
+        return (
+            f'<Zodiac '
+            f'{self.name} '
+            f'{self.start_day_in_month}/{self.start_month}-'
+            f'{self.end_day_in_month}/{self.end_month}>'
+        )

app/internal/quotes/daily_quotes.py renamed to app/internal/daily_quotes.py

@@ -1,5 +1,5 @@
 from datetime import date
-from typing import Optional
+from typing import Dict, Optional
 
 from app.database.models import Quote
 
@@ -9,6 +9,15 @@
 TOTAL_DAYS = 366
 
 
+def create_quote_object(quotes_fields: Dict[str, Optional[str]]) -> Quote:
+    """This function create a quote object from given fields dictionary.
+    It is used for adding the data from the json into the db"""
+    return Quote(
+        text=quotes_fields['text'],
+        author=quotes_fields['author']
+        )
+
+
 def quote_per_day(
         session: Session, date: date = date.today()
         ) -> Optional[Quote]:

app/internal/json_data_loader.py

@@ -0,0 +1,57 @@
+import json
+import os
+from typing import Dict, List, Callable, Union
+
+from loguru import logger
+from sqlalchemy.orm import Session
+
+from app.database.database import Base
+from app.database.models import Quote, Zodiac
+from app.internal import daily_quotes, zodiac
+
+
+def get_data_from_json(path: str) -> List[Dict[str, Union[str, int, None]]]:
+    """This function reads all of the data from a specific JSON file.
+    The json file consists of list of dictionaries"""
+    try:
+        with open(path, 'r') as f:
+            json_content_list = json.load(f)
+    except (IOError, ValueError):
+        file_name = os.path.basename(path)
+        logger.exception(
+            f"An error occurred during reading of json file: {file_name}")
+        return []
+    return json_content_list
+
+
+def is_table_empty(session: Session, table: Base) -> bool:
+    return session.query(table).count() == 0
+
+
+def load_data(
+        session: Session, path: str,
+        table: Base, object_creator_function: Callable) -> None:
+    """This function loads the specific data to the db,
+    if it wasn't already loaded"""
+    if not is_table_empty(session, table):
+        return None
+    json_objects_list = get_data_from_json(path)
+    objects = [
+        object_creator_function(json_object)
+        for json_object in json_objects_list]
+    session.add_all(objects)
+    session.commit()
+
+
+def load_to_db(session) -> None:
+    """This function loads all the data for features
+    based on pre-defind json data"""
+    load_data(
+        session, 'app/resources/zodiac.json',
+        Zodiac, zodiac.create_zodiac_object)
+    load_data(
+        session, 'app/resources/quotes.json',
+        Quote, daily_quotes.create_quote_object)
+    """The quotes 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."""

app/internal/quotes/load_quotes.py

@@ -0,0 +1,42 @@
+from datetime import date
+from typing import Dict, Union
+
+from sqlalchemy.orm import Session
+from sqlalchemy import and_, or_
+
+from app.database.models import Zodiac
+
+
+def create_zodiac_object(zodiac_fields: Dict[str, Union[str, int]]) -> Zodiac:
+    """This function create a zodiac object from given fields dictionary.
+    It is used for adding the data from the json into the db"""
+    return Zodiac(
+        name=zodiac_fields['name'],
+        start_month=zodiac_fields['start_month'],
+        start_day_in_month=zodiac_fields['start_day_in_month'],
+        end_month=zodiac_fields['end_month'],
+        end_day_in_month=zodiac_fields['end_day_in_month']
+        )
+
+
+def get_zodiac_of_day(session: Session, date: date) -> Zodiac:
+    """This function return a zodiac object
+    according to the current day."""
+    first_month_of_sign_filter = and_(
+        Zodiac.start_month == date.month,
+        Zodiac.start_day_in_month <= date.day)
+    second_month_of_sign_filter = and_(
+        Zodiac.end_month == date.month,
+        Zodiac.end_day_in_month >= date.day)
+    zodiac_obj = session.query(Zodiac).filter(
+        or_(first_month_of_sign_filter, second_month_of_sign_filter)).first()
+    return zodiac_obj
+
+
+# TODO: Call this function from the month view
+def get_zodiac_of_month(session: Session, date: date) -> Zodiac:
+    """This function return a zodiac object
+    according to the current month."""
+    zodiac_obj = session.query(Zodiac).filter(
+        Zodiac.end_month == date.month).first()
+    return zodiac_obj

app/internal/zodiac.py

@@ -6,10 +6,10 @@
 from app.database import models
 from app.database.database import engine, get_db
 from app.dependencies import (logger, MEDIA_PATH, STATIC_PATH, templates)
-from app.internal.quotes import daily_quotes, load_quotes
+from app.internal import daily_quotes, json_data_loader
 from app.routers import (
-    agenda, dayview, email, event, invitation, profile, search, telegram,
-    whatsapp
+    agenda, calendar, categories, dayview, email,
+    event, invitation, profile, search, telegram, whatsapp
 )
 from app.telegram.bot import telegram_bot
 
@@ -30,25 +30,32 @@ 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()))
+json_data_loader.load_to_db(next(get_db()))
 
 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)
+routers_to_include = [
+    agenda.router,
+    calendar.router,
+    categories.router,
+    dayview.router,
+    email.router,
+    event.router,
+    invitation.router,
+    profile.router,
+    search.router,
+    telegram.router,
+    whatsapp.router,
+]
+
+for router in routers_to_include:
+    app.include_router(router)
 
 telegram_bot.set_webhook()
 
 
 # TODO: I add the quote day to the home page
-# until the relavent calendar view will be developed.
+# until the relevant calendar view will be developed.
 @app.get("/")
 @logger.catch()
 async def home(request: Request, db: Session = Depends(get_db)):