Merge 73def22 into 3c22c8c

Author: Liad-n

app/database/models.py

@@ -499,6 +499,19 @@ def __repr__(self):
         )
 
 
+class UserMenstrualPeriodLength(Base):
+    __tablename__ = "user_menstrual_period_length"
+
+    id = Column(Integer, primary_key=True, index=True)
+    user_id = Column(
+        Integer,
+        ForeignKey("users.id"),
+        nullable=False,
+        unique=True,
+    )
+    period_length = Column(Integer, nullable=False)
+
+
 class SharedListItem(Base):
     __tablename__ = "shared_list_item"
 

app/internal/menstrual_predictor_utils.py

@@ -0,0 +1,147 @@
+import datetime
+from datetime import timedelta
+from typing import List, Union
+
+from fastapi import Depends
+from loguru import logger
+from sqlalchemy import asc
+from sqlalchemy.exc import SQLAlchemyError
+from sqlalchemy.orm import Session
+
+from app.database.models import Event, UserMenstrualPeriodLength
+from app.dependencies import get_db
+from app.internal.security.dependencies import current_user
+from app.internal.security.schema import CurrentUser
+from app.routers.event import create_event
+
+MENSTRUAL_PERIOD_CATEGORY_ID = 111
+
+
+def get_avg_period_gap(db: Session, user_id: int) -> int:
+    GAP_IN_CASE_NO_PERIODS = 30
+
+    period_days = get_all_period_days(db, user_id)
+    gaps_list = []
+
+    if len(period_days) <= 1:
+        return GAP_IN_CASE_NO_PERIODS
+
+    for i in range(len(period_days) - 1):
+        gap = get_date_diff(period_days[i].start, period_days[i + 1].start)
+        gaps_list.append(gap.days)
+    return get_list_avg(gaps_list)
+
+
+def get_date_diff(date_1: datetime, date_2: datetime) -> timedelta:
+    return date_2 - date_1
+
+
+def get_list_avg(received_list: List) -> int:
+    return sum(received_list) // len(received_list)
+
+
+def remove_existing_period_dates(db: Session, user_id: int) -> None:
+    (
+        db.query(Event)
+        .filter(Event.owner_id == user_id)
+        .filter(Event.category_id == MENSTRUAL_PERIOD_CATEGORY_ID)
+        .filter(Event.start > datetime.datetime.now())
+        .delete()
+    )
+    db.commit()
+    logger.info("Removed all period predictions to create new ones")
+
+
+def generate_predicted_period_dates(
+    db: Session,
+    period_length: str,
+    period_start_date: datetime,
+    user_id: int,
+) -> Event:
+    delta = datetime.timedelta(int(period_length))
+    period_end_date = period_start_date + delta
+    period_event = create_event(
+        db,
+        "period",
+        period_start_date,
+        period_end_date,
+        user_id,
+        category_id=MENSTRUAL_PERIOD_CATEGORY_ID,
+    )
+    return period_event
+
+
+def add_3_month_predictions(
+    db: Session,
+    period_length: str,
+    period_start_date: datetime,
+    user_id: int,
+) -> List[Event]:
+    avg_gap = get_avg_period_gap(db, user_id)
+    avg_gap_delta = datetime.timedelta(avg_gap)
+    generated_3_months = []
+    for _ in range(4):
+        generated_period = generate_predicted_period_dates(
+            db,
+            period_length,
+            period_start_date,
+            user_id,
+        )
+        generated_3_months.append(generated_period)
+        period_start_date += avg_gap_delta
+    logger.info(f"Generated predictions: {generated_3_months}")
+    return generated_3_months
+
+
+def add_prediction_events_if_valid(
+    period_start_date: datetime,
+    db: Session = Depends(get_db),
+    user: CurrentUser = Depends(current_user),
+) -> None:
+    current_user_id = user.user_id
+    user_period_length = is_user_signed_up_to_menstrual_predictor(
+        db,
+        current_user_id,
+    )
+
+    remove_existing_period_dates(db, current_user_id)
+    if user_period_length:
+        add_3_month_predictions(
+            db,
+            user_period_length,
+            period_start_date,
+            current_user_id,
+        )
+
+
+def get_all_period_days(session: Session, user_id: int) -> List[Event]:
+    """Returns all period days filtered by user id."""
+
+    try:
+        period_days = (
+            session.query(Event)
+            .filter(Event.owner_id == user_id)
+            .filter(Event.category_id == MENSTRUAL_PERIOD_CATEGORY_ID)
+            .order_by(asc(Event.start))
+            .all()
+        )
+
+    except SQLAlchemyError as err:
+        logger.exception(err)
+        return []
+
+    return period_days
+
+
+def is_user_signed_up_to_menstrual_predictor(
+    session: Session,
+    user_id: int,
+) -> Union[bool, int]:
+    user_menstrual_period_length = (
+        session.query(UserMenstrualPeriodLength)
+        .filter(user_id == user_id)
+        .first()
+    )
+    if user_menstrual_period_length:
+        return user_menstrual_period_length.period_length
+    return False

app/main.py

@@ -73,6 +73,7 @@ def create_tables(engine, psql_environment):
     login,
     logout,
     meds,
+    menstrual_predictor,
     notification,
     profile,
     register,
@@ -125,6 +126,7 @@ async def swagger_ui_redirect():
     login.router,
     logout.router,
     meds.router,
+    menstrual_predictor.router,
     notification.router,
     profile.router,
     register.router,

app/routers/menstrual_predictor.py

@@ -0,0 +1,103 @@
+import datetime
+
+from fastapi import APIRouter, Depends, HTTPException, Request
+from fastapi.responses import RedirectResponse, Response
+from loguru import logger
+from sqlalchemy.exc import SQLAlchemyError
+from sqlalchemy.orm import Session
+from starlette.status import HTTP_302_FOUND, HTTP_400_BAD_REQUEST
+
+from app.database.models import UserMenstrualPeriodLength
+from app.dependencies import get_db, templates
+from app.internal.menstrual_predictor_utils import (
+    add_prediction_events_if_valid,
+    generate_predicted_period_dates,
+    is_user_signed_up_to_menstrual_predictor,
+)
+from app.internal.security.dependencies import current_user
+from app.internal.security.schema import CurrentUser
+from app.internal.utils import create_model
+
+router = APIRouter(
+    prefix="/menstrual_predictor",
+    tags=["menstrual_predictor"],
+    dependencies=[Depends(get_db)],
+)
+
+MENSTRUAL_PERIOD_CATEGORY_ID = 111
+
+
+@router.get("/")
+def join_menstrual_predictor(
+    request: Request,
+    db: Session = Depends(get_db),
+    user: CurrentUser = Depends(current_user),
+) -> Response:
+    current_user_id = user.user_id
+
+    if not is_user_signed_up_to_menstrual_predictor(db, current_user_id):
+        return templates.TemplateResponse(
+            "join_menstrual_predictor.html",
+            {
+                "request": request,
+            },
+        )
+    return RedirectResponse(url="/", status_code=HTTP_302_FOUND)
+
+
+@router.get("/add-period-start/{start_date}")
+def add_period_start(
+    request: Request,
+    start_date: str,
+    db: Session = Depends(get_db),
+    user: CurrentUser = Depends(current_user),
+) -> RedirectResponse:
+    try:
+        period_start_date = datetime.datetime.strptime(start_date, "%Y-%m-%d")
+    except ValueError as err:
+        logger.exception(err)
+        raise HTTPException(
+            status_code=HTTP_400_BAD_REQUEST,
+            detail="The given date doesn't match a date format YYYY-MM-DD",
+        )
+    else:
+        add_prediction_events_if_valid(period_start_date, db, user)
+    logger.info("Adding menstrual start date")
+    return RedirectResponse("/", status_code=HTTP_302_FOUND)
+
+
+@router.post("/")
+async def submit_join_form(
+    request: Request,
+    db: Session = Depends(get_db),
+    user: CurrentUser = Depends(current_user),
+) -> RedirectResponse:
+
+    data = await request.form()
+
+    user_menstrual_period_length = {
+        "user_id": user.user_id,
+        "period_length": data["avg-period-length"],
+    }
+    last_period_date = datetime.datetime.strptime(
+        data["last-period-date"],
+        "%Y-%m-%d",
+    )
+    try:
+        create_model(
+            session=db,
+            model_class=UserMenstrualPeriodLength,
+            **user_menstrual_period_length,
+        )
+    except SQLAlchemyError:
+        logger.info("Current user already signed up to the service, hurray")
+        db.rollback()
+    url = "/"
+    generate_predicted_period_dates(
+        db,
+        data["avg-period-length"],
+        last_period_date,
+        user.user_id,
+    )
+
+    return RedirectResponse(url=url, status_code=HTTP_302_FOUND)

app/templates/join_menstrual_predictor.html

@@ -0,0 +1,39 @@
+{% extends "base.html" %}
+{% block content %}
+    <div class="container">
+        <h3>Please fill in your details</h3>
+        <form method="post">
+            <div class="row">
+                <label for="avg-period-length" class="col-sm-2 col-form-label">Average period length</label>
+                <div class="col-auto">
+                    <input type="number" class="form-control" name="avg-period-length" id="avg-period-length" min=1 placeholder="Required" autofocus required><br>
+                </div>
+                <div class="col-auto">
+                    <span id="PeriodLengthHelpInline" class="form-text">
+                        Must be above 1 day.
+                    </span>
+                </div>
+            </div>
+            <div class="row">
+                <label for="last-period-date" class="col-sm-2 col-form-label">Last period date</label>
+                <div class="col-auto">
+                    <input type="date" class="form-control" name="last-period-date" id="last-period-date" placeholder="Required" required><br>
+                </div>
+            </div>
+
+            <input type="submit" class="btn-sm btn btn-outline-primary" value="Sign Up">
+        </form>
+    </div>
+    <script>
+        function change_max_to_today_date(el){
+            today = new Date();
+            today_str = today.toISOString().substring(0,10);
+            el.max = today_str;
+        }
+        function validate_date_older_than_today(received_date){
+            return received_date < new Date();
+        }
+        let last_period_date_element = document.getElementById("last-period-date");
+        change_max_to_today_date(last_period_date_element);
+    </script>
+{% endblock %}

tests/test_menstrual_predictor.py

@@ -0,0 +1,32 @@
+class TestMenstrualPredictor:
+    PREDICTOR_PREFIX = "/menstrual_predictor"
+    ADD_PERIOD_START = "/add-period-start"
+
+    @staticmethod
+    def test_menstrual_predictor_page_not_signed_up(client, session):
+        resp = client.get(TestMenstrualPredictor.PREDICTOR_PREFIX)
+        assert resp.ok
+
+    @staticmethod
+    def test_menstrual_predictor_sign_up(client, session):
+        resp = client.post(
+            TestMenstrualPredictor.PREDICTOR_PREFIX,
+            json={"avg-period-length": 8, "last-period-date": "2020-11-07"},
+        )
+        assert resp.ok
+
+        resp = client.get(
+            TestMenstrualPredictor.PREDICTOR_PREFIX
+            + TestMenstrualPredictor.ADD_PERIOD_START
+            + "/2020-12-11",
+        )
+        assert resp.ok
+
+    @staticmethod
+    def test_add_period_date(client, session):
+        resp = client.get(
+            TestMenstrualPredictor.PREDICTOR_PREFIX
+            + TestMenstrualPredictor.ADD_PERIOD_START
+            + "/2020-12-11",
+        )
+        assert resp.ok