feat: adding holidays to calendar as events

app/internal/import_holidays.py

@@ -0,0 +1,64 @@
+import re
+from datetime import datetime, timedelta
+
+from app.database.models import User, Event, UserEvent
+from sqlalchemy.orm import Session
+from typing import List, Match
+
+REGEX_EXTRACT_HOLIDAYS = re.compile(
+    r'SUMMARY:(?P<title>.*)(\n.*){1,8}DTSTAMP:(?P<date>\w{8})',
+    re.MULTILINE)
+
+
+def get_holidays_from_file(file: List[Event], session: Session) -> List[Event]:
+    """
+    This function using regex to extract holiday title
+    and date from standrd ics file
+    :param file:standard ics file
+    :param session:current connection
+    :return:list of holidays events
+    """
+    parsed_holidays = REGEX_EXTRACT_HOLIDAYS.finditer(file)
+    holidays = []
+    for holiday in parsed_holidays:
+        holiday_event = create_holiday_event(
+            holiday, session.query(User).filter_by(id=1).first().id)
+        holidays.append(holiday_event)
+    return holidays
+
+
+def create_holiday_event(holiday: Match[str], owner_id: int) -> Event:
+    valid_ascii_chars_range = 128
+    title = holiday.groupdict()['title'].strip()
+    title_to_save = ''.join(i if ord(i) < valid_ascii_chars_range
+                            else '' for i in title)
+    date = holiday.groupdict()['date'].strip()
+    format_string = '%Y%m%d'
+    holiday = Event(
+        title=title_to_save,
+        start=datetime.strptime(date, format_string),
+        end=datetime.strptime(date, format_string) + timedelta(days=1),
+        content='holiday',
+        owner_id=owner_id
+    )
+    return holiday
+
+
+def save_holidays_to_db(holidays: List[Event], session: Session):
+    """
+    this function saves holiday list into database.
+    :param holidays: list of holidays events
+    :param session: current connection
+    """
+    session.add_all(holidays)
+    session.commit()
+    session.flush(holidays)
+    userevents = []
+    for holiday in holidays:
+        userevent = UserEvent(
+            user_id=holiday.owner_id,
+            event_id=holiday.id
+        )
+        userevents.append(userevent)
+    session.add_all(userevents)
+    session.commit()

app/routers/profile.py

@@ -1,14 +1,18 @@
 import io
 
+from loguru import logger
 from fastapi import APIRouter, Depends, File, Request, UploadFile
 from PIL import Image
 from starlette.responses import RedirectResponse
 from starlette.status import HTTP_302_FOUND
+from sqlalchemy.exc import SQLAlchemyError
 
 from app import config
 from app.database.models import User
 from app.dependencies import get_db, MEDIA_PATH, templates
 from app.internal.on_this_day_events import get_on_this_day_events
+from app.internal.import_holidays import (get_holidays_from_file,
+                                          save_holidays_to_db)
 
 PICTURE_EXTENSION = config.PICTURE_EXTENSION
 PICTURE_SIZE = config.AVATAR_SIZE
@@ -135,6 +139,13 @@ async def update_telegram_id(
     return RedirectResponse(url=url, status_code=HTTP_302_FOUND)
 
 
+@router.get("/holidays/import")
+def import_holidays(request: Request):
+    return templates.TemplateResponse("import_holidays.html", {
+        "request": request,
+    })
+
+
 async def process_image(image, user):
     img = Image.open(io.BytesIO(image))
     width, height = img.size
@@ -152,3 +163,17 @@ def get_image_crop_area(width, height):
         return delta, 0, width - delta, height
     delta = (height - width) // 2
     return 0, delta, width, width + delta
+
+
+@router.post("/holidays/update")
+async def update_holidays(
+        file: UploadFile = File(...), session=Depends(get_db)):
+    icsfile = await file.read()
+    holidays = get_holidays_from_file(icsfile.decode(), session)
+    try:
+        save_holidays_to_db(holidays, session)
+    except SQLAlchemyError as ex:
+        logger.exception(ex)
+    finally:
+        url = router.url_path_for("profile")
+        return RedirectResponse(url=url, status_code=HTTP_302_FOUND)

app/static/style.css

@@ -64,3 +64,7 @@ body {
   border: none;
   background-color: whitesmoke;
 }
+
+.subtitle {
+    font-size: 20px;
+}

app/templates/import_holidays.html

@@ -0,0 +1,19 @@
+{% extends "base.html" %}
+
+
+{% block content %}
+
+<form class="m-3" action="update_holidays" method="post" enctype="multipart/form-data">
+    <h1 class="title">Import holidays using ics file</h1>
+    <p class="subtitle">Use the upload button to choose ics file</p>
+    <a href="https://www.feiertagskalender.ch/export.php?geo=3542&hl=en#" target="_blank">Check this website to export holidays by country</a>
+    <div class="input-group">
+            <label for="file"></label>
+            <input type="file" class="form-control-sm" accept=".ics" id="file">
+    </div>
+    <div class="mt-4">
+        <button type="submit" class="btn btn-sm btn-success">Add events from file to calender</button>
+    </div>
+</form>
+
+{% endblock %}

app/templates/profile.html

@@ -219,6 +219,9 @@ <h6 class="card-title text-center mb-1">{{ user.full_name }}</h6>
               <li class="list-group-item list-group-item-action no-border">
                 <a class="text-decoration-none text-secondary" href="#">Export my calendar</a>
               </li>
+              <li class="list-group-item list-group-item-action no-border">
+                <a class="text-decoration-none text-secondary" href="{{ url_for('import_holidays') }}">Add holidays to calendar</a>
+              </li>
               <li class="list-group-item list-group-item-action no-border">
                 <a class="text-decoration-none text-secondary" href="#">Your feature</a>
               </li>

tests/resources/ics_example.txt

@@ -0,0 +1,36 @@
+STATUS:CONFIRMED
+DTSTAMP:20210225T000000
+DTSTART;VALUE=DATE:20210225
+UID:feiertag2021-0323-3542-fcal.ch
+CATEGORIES:Public holidays
+END:VEVENT
+BEGIN:VEVENT
+SUMMARY:Purim
+DESCRIPTION:Feiertagskalender.ch - free data for private /internal use only.
+STATUS:CONFIRMED
+DTSTAMP:20210226T000000
+DTSTART;VALUE=DATE:20210226
+UID:feiertag2021-0324-3542-fcal.ch
+CATEGORIES:Public holidays
+END:VEVENT
+BEGIN:VEVENT
+SUMMARY:Pesach
+DESCRIPTION:Feiertagskalender.ch - free data for private /internal use only.
+STATUS:CONFIRMED
+DTSTAMP:20210328T000000
+DTSTART;VALUE=DATE:20210328
+UID:feiertag2021-0336-3542-fcal.ch
+CATEGORIES:Public holidays
+END:VEVENT
+BEGIN:VEVENT
+SUMMARY:Pesach
+DESCRIPTION:Feiertagskalender.ch - free data for private /internal use only.
+STATUS:CONFIRMED
+DTSTAMP:20210329T010000
+DTSTART;VALUE=DATE:20210329
+UID:feiertag2021-0336-3542-fcal.ch
+CATEGORIES:Public holidays
+END:VEVENT
+BEGIN:VEVENT
+SUMMARY:One More Holiday For Test
+DTSTAMP:20210101T010000

tests/resources/wrong_ics_example.txt

@@ -0,0 +1,25 @@
+STATUS:CONFIRMED
+DTSTAMP:20210225T000000
+DTSTART;VALUE=DATE:20210225
+UID:feiertag2021-0323-3542-fcal.ch
+CATEGORIES:Public holidays
+END:VEVENT
+BEGIN:VEVENT
+DESCRIPTION:Feiertagskalender.ch - free data for private /internal use only.
+STATUS:CONFIRMED
+DTSTAMP:20210226T000000
+DTSTART;VALUE=DATE:20210226
+UID:feiertag2021-0324-3542-fcal.ch
+CATEGORIES:Public holidays
+END:VEVENT
+BEGIN:VEVENT
+SUMMARY:Pesach
+DESCRIPTION:Feiertagskalender.ch - free data for private /internal use only.
+STATUS:CONFIRMED
+DTSTART;VALUE=DATE:20210328
+UID:feiertag2021-0336-3542-fcal.ch
+CATEGORIES:Public holidays
+END:VEVENT
+BEGIN:VEVENT
+SUMMARY:Pesach
+DESCRIPTION:Feiertagskalender.ch - free data for private /internal use only.

tests/test_holidays.py

@@ -0,0 +1,34 @@
+import os
+from app.database.models import Event, User
+from app.routers import profile
+from sqlalchemy.orm import Session
+
+
+class TestHolidaysImport:
+    HOLIDAYS = '/profile/holidays/import'
+
+    @staticmethod
+    def test_import_holidays_page_exists(client):
+        resp = client.get(TestHolidaysImport.HOLIDAYS)
+        assert resp.ok
+        assert b'Import holidays using ics file' in resp.content
+
+    def test_get_holidays(self, session: Session, user: User):
+        current_folder = os.path.dirname(os.path.realpath(__file__))
+        resource_folder = os.path.join(current_folder, 'resources')
+        test_file = os.path.join(resource_folder, 'ics_example.txt')
+        with open(test_file) as file:
+            ics_content = file.read()
+            holidays = profile.get_holidays_from_file(ics_content, session)
+            profile.save_holidays_to_db(holidays, session)
+        assert len(session.query(Event).all()) == 4
+
+    def test_wrong_file_get_holidays(self, session: Session, user: User):
+        current_folder = os.path.dirname(os.path.realpath(__file__))
+        resource_folder = os.path.join(current_folder, 'resources')
+        test_file = os.path.join(resource_folder, 'wrong_ics_example.txt')
+        with open(test_file) as file:
+            ics_content = file.read()
+            holidays = profile.get_holidays_from_file(ics_content, session)
+            profile.save_holidays_to_db(holidays, session)
+        assert len(session.query(Event).all()) == 0