Merge branch 'develop' into feature/i18n

Author: Gonzom

.gitignore

@@ -148,3 +148,5 @@ app/.vscode/
 
 # PyCharm
 .idea
+
+junit/

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/config.py.example

@@ -32,6 +32,8 @@ AVATAR_SIZE = (120, 120)
 WEBSITE_LANGUAGE = "en"
 
 # API-KEYS
+# Get a free API KEY for Astronomy feature @ www.weatherapi.com/signup.aspx
+ASTRONOMY_API_KEY = os.getenv('ASTRONOMY_API_KEY')
 WEATHER_API_KEY = os.getenv('WEATHER_API_KEY')
 
 # EXPORT

app/database/models.py

@@ -3,14 +3,15 @@
 from datetime import datetime
 from typing import Dict, Any
 
+
+from app.config import PSQL_ENVIRONMENT
+from app.database.database import Base
 from sqlalchemy import (DDL, Boolean, Column, DateTime, ForeignKey, Index,
-                        Integer, String, event, UniqueConstraint)
+                        Integer, String, event, UniqueConstraint, JSON)
 from sqlalchemy.dialects.postgresql import TSVECTOR
 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
 
 
@@ -158,6 +159,16 @@ def __repr__(self):
         )
 
 
+class WikipediaEvents(Base):
+    __tablename__ = "wikipedia_events"
+
+    id = Column(Integer, primary_key=True, index=True)
+    date_ = Column(String, nullable=False)
+    wikipedia = Column(String, nullable=False)
+    events = Column(JSON, nullable=True)
+    date_inserted = Column(DateTime, default=datetime.utcnow)
+
+
 class Quote(Base):
     __tablename__ = "quotes"
 

app/internal/astronomy.py

@@ -0,0 +1,70 @@
+import datetime
+import functools
+import httpx
+from typing import Dict
+
+from app import config
+
+
+# This feature requires an API KEY - get yours free @ www.weatherapi.com
+
+ASTRONOMY_URL = "http://api.weatherapi.com/v1/astronomy.json"
+NO_API_RESPONSE = "No response from server"
+
+
+@functools.lru_cache(maxsize=128, typed=False)
+async def get_data_from_api(formatted_date: str, location: str)\
+        -> Dict[str, int]:
+    """ get the relevant astronomical data by calling the "weather api" API.
+    Args:
+        formatted_date (date) - relevant date.
+        location (str) - location name.
+    Returns:
+        response_json (json dict) including:
+        relevant part (data / error) of the JSON returned by the API.
+        Success (bool)
+        ErrorDescription (str) - error message.
+    """
+    input_query_string = {'key': config.ASTRONOMY_API_KEY, 'q': location,
+                          'dt': formatted_date}
+    output = {}
+    try:
+        async with httpx.AsyncClient() as client:
+            response = await client.get(ASTRONOMY_URL,
+                                        params=input_query_string)
+    except httpx.HTTPError:
+        output["Success"] = False
+        output["ErrorDescription"] = NO_API_RESPONSE
+        return output
+    if response.status_code != httpx.codes.OK:
+        output["Success"] = False
+        output["ErrorDescription"] = NO_API_RESPONSE
+        return output
+    output["Success"] = True
+    try:
+        output.update(response.json()['location'])
+        return output
+    except KeyError:
+        output["Success"] = False
+        output["ErrorDescription"] = response.json()['error']['message']
+        return output
+
+
+async def get_astronomical_data(requested_date: datetime.datetime,
+                                location: str) -> Dict[str, int]:
+    """ get astronomical data (Sun & Moon) for date & location -
+        main function.
+    Args:
+        requested_date (date) - date requested for astronomical data.
+        location (str) - location name.
+    Returns: dictionary with the following entries:
+        Status - success / failure.
+        ErrorDescription - error description (relevant only in case of error).
+        location - relevant location values(relevant only in case of success).
+            name, region, country, lat, lon etc.
+        astronomy - relevant astronomy values, all time in local time -
+            (relevant only in case of success):
+            sunrise, sunset, moonrise, moonset, moon_phase, moon_illumination.
+    """
+    formatted_date = requested_date.strftime('%Y-%m-%d')
+    return await get_data_from_api(formatted_date, location)

app/internal/on_this_day_events.py

@@ -0,0 +1,48 @@
+import json
+from datetime import date, datetime
+from typing import Any, Dict
+import requests
+from fastapi import Depends
+from loguru import logger
+from sqlalchemy import func
+from sqlalchemy.exc import SQLAlchemyError
+from sqlalchemy.orm import Session
+from sqlalchemy.orm.exc import NoResultFound
+
+from app.database.database import get_db
+from app.database.models import WikipediaEvents
+
+
+def insert_on_this_day_data(
+    db: Session = Depends(get_db)
+) -> Dict[str, Any]:
+    now = datetime.now()
+    day, month = now.day, now.month
+
+    res = requests.get(
+        f'https://byabbe.se/on-this-day/{month}/{day}/events.json')
+    text = json.loads(res.text)
+    res_events = text.get('events')
+    res_date = text.get('date')
+    res_wiki = text.get('wikipedia')
+    db.add(WikipediaEvents(events=res_events,
+                           date_=res_date, wikipedia=res_wiki))
+    db.commit()
+    return text
+
+
+def get_on_this_day_events(
+    db: Session = Depends(get_db)
+) -> Dict[str, Any]:
+    try:
+        data = (db.query(WikipediaEvents).
+                filter(
+                    func.date(WikipediaEvents.date_inserted) == date.today()).
+                one())
+
+    except NoResultFound:
+        data = insert_on_this_day_data(db)
+    except (SQLAlchemyError, AttributeError) as e:
+        logger.error(f'on this day failed with error: {e}')
+        data = {'events': [], 'wikipedia': 'https://en.wikipedia.org/'}
+    return data

app/main.py

@@ -33,8 +33,8 @@ def create_tables(engine, psql_environment):
 set_ui_language()
 
 from app.routers import (  # noqa: E402
-    agenda, calendar, categories, dayview, email,
-    event, invitation, profile, search, telegram, whatsapp,
+    agenda, calendar, categories, currency, dayview, email,
+    event, invitation, profile, search, telegram, whatsapp
 )
 
 json_data_loader.load_to_db(next(get_db()))
@@ -43,6 +43,7 @@ def create_tables(engine, psql_environment):
     agenda.router,
     calendar.router,
     categories.router,
+    currency.router,
     dayview.router,
     email.router,
     event.router,

app/routers/agenda.py

@@ -17,7 +17,7 @@ def calc_dates_range_for_agenda(
         start: Optional[date],
         end: Optional[date],
         days: Optional[int],
-        ) -> Tuple[date, date]:
+) -> Tuple[date, date]:
     """Create start and end dates according to the parameters in the page."""
     if days is not None:
         start = date.today()
@@ -35,7 +35,7 @@ def agenda(
         start_date: Optional[date] = None,
         end_date: Optional[date] = None,
         days: Optional[int] = None,
-        ) -> _TemplateResponse:
+) -> _TemplateResponse:
     """Route for the agenda page, using dates range or exact amount of days."""
 
     user_id = 1  # there is no user session yet, so I use user id- 1.

app/routers/calendar.py

@@ -20,7 +20,7 @@ async def calendar(request: Request) -> Response:
     user_local_time = cg.Day.get_user_local_time()
     day = cg.create_day(user_local_time)
     return templates.TemplateResponse(
-        "calendar/calendar.html",
+        "calendar_monthly_view.html",
         {
             "request": request,
             "day": day,
@@ -34,6 +34,7 @@ async def calendar(request: Request) -> Response:
 async def update_calendar(request: Request, date: str) -> HTMLResponse:
     last_day = cg.Day.convert_str_to_date(date)
     next_weeks = cg.create_weeks(cg.get_n_days(last_day, ADD_DAYS_ON_SCROLL))
-    template = templates.get_template('calendar/add_week.html')
+    template = templates.get_template(
+        'partials/calendar/monthly_view/add_week.html')
     content = template.render(weeks_block=next_weeks)
     return HTMLResponse(content=content, status_code=HTTPStatus.OK)

app/routers/calendar_grid.py

@@ -29,7 +29,7 @@ def __init__(self, date: datetime):
         self.date: datetime = date
         self.sday: str = self.date.strftime("%A")
         self.dailyevents: List[Tuple] = []
-        self.events:  List[Tuple] = []
+        self.events: List[Tuple] = []
         self.css: Dict[str, str] = {
             'day_container': 'day',
             'date': 'day-number',
@@ -79,7 +79,7 @@ def __init__(self, date: datetime):
         super().__init__(date)
         self.css = {
             'day_container': 'day ',
-            'date': ' '.join(['day-number',  'text-gray']),
+            'date': ' '.join(['day-number', 'text-gray']),
             'daily_event': 'month-event',
             'daily_event_front': ' '.join([
                 'daily',
@@ -100,7 +100,7 @@ class Today(Day):
     def __init__(self, date: datetime):
         super().__init__(date)
         self.css = {
-            'day_container':  ' '.join([
+            'day_container': ' '.join([
                 'day',
                 'text-darkblue',
                 'background-yellow'
@@ -134,7 +134,7 @@ def __init__(self, date: datetime):
             ]),
             'date': 'day-number',
             'daily_event': 'month-event',
-            'daily_event_front':  ' '.join([
+            'daily_event_front': ' '.join([
                 'daily front',
                 'text-lightgray',
                 'background-red'
@@ -196,8 +196,8 @@ def get_n_days(date: datetime, n: int) -> Iterator[Day]:
 
 
 def create_weeks(
-    days: Iterator[Day],
-    length: int = Week.WEEK_DAYS
+        days: Iterator[Day],
+        length: int = Week.WEEK_DAYS
 ) -> List[Week]:
     """Return lists of Weeks objects."""
     ndays: List[Day] = list(days)

app/routers/categories.py

@@ -21,6 +21,15 @@ class CategoryModel(BaseModel):
     color: str
     user_id: int
 
+    class Config:
+        schema_extra = {
+            "example": {
+                "name": "Guitar lessons",
+                "color": "#aabbcc",
+                "user_id": 1,
+            }
+        }
+
 
 # TODO(issue#29): get current user_id from session
 @router.get("/")

app/routers/currency.py

@@ -0,0 +1,32 @@
+import datetime
+
+from app.dependencies import templates
+from fastapi import APIRouter, Request
+
+
+router = APIRouter()
+
+# TODO: Add this as a feature to the calendar view/
+#           day view/features panel frontend
+
+
+@router.get("/currency")
+def today_currency(request: Request):
+    """Current day currency router"""
+
+    date = datetime.date.today().strftime("%Y-%m-%d")
+    return currency(request, date)
+
+
+@router.get("/currency/{date}")
+def currency(request: Request, date: str):
+    """Custom date currency router"""
+
+    # TODO: get user default/preferred currency
+    base = "USD"
+
+    return templates.TemplateResponse("currency.html", {
+        "request": request,
+        "base": base,
+        "date": date
+    })