Merge pull request #5 from v411e/feature/database

[Feature] Implement database caching and notifications

Author: v411e

README.md

@@ -4,7 +4,20 @@
 # OvGU Mensa Bot (matrix)
 A [maubot](https://github.com/maubot) bot for the canteen at Otto-von-Guericke-Universität Magdeburg.
 
-## Usage
+## Setup
 - Load the *.mbp file into your Maubot Manager
 - Create client and instance in Maubot Manager
-- Use `!hunger` in [matrix](https://matrix.to/#/@mensabot:valentinriess.com) to get the current menu at the OvGU canteen
+
+## Commands
+- `!hunger`: Get the menu (before 14:00 - today // after 14:00 - next available day)
+  - Combine with keyword to query specific day (e.g. `!hunger monday` or `!hunger 01.04.2042`):
+    - `today`
+    - `tomorrow`
+    - `dd.mm.yyyy`
+    - `monday`
+    - `tuesday`
+    - `wednesday`
+    - ...
+  - Combine with `fetch` to update internal cache (e.g. `!hunger fetch` or `!hunger fetch tomorrow`)
+- `!subscribe` Enable notifications for the menu on the next day
+- `!unsubscribe` Disable notifications for the menu on the next day

maubot.yaml

@@ -1,11 +1,11 @@
 # Target maubot version
-maubot: 0.1.0
+maubot: 0.2.0
 
 # The unique ID for the plugin. Java package naming style. (i.e. use your own domain, not xyz.maubot)
 id: com.valentinriess.mensa
 
 # A PEP 440 compliant version string.
-version: 0.0.5
+version: 0.0.6
 
 # The SPDX license identifier for the plugin. https://spdx.org/licenses/
 # Optional, assumes all rights reserved if omitted.
@@ -25,7 +25,7 @@ modules:
 main_class: MensaBot
 
 # Whether or not instances need a database
-database: false
+database: true
 
 #  Extra files that the upcoming build tool should include in the mbp file.
 extra_files:
@@ -36,8 +36,6 @@ extra_files:
 dependencies:
 - requests
 - beautifulsoup4
-- maubot
-- mautrix
 
 #soft_dependencies:
 #- bar>=0.1

ovgumensabot/db.py

@@ -0,0 +1,114 @@
+import datetime
+import logging
+from typing import List, Iterator
+
+from sqlalchemy import (Column, String, DateTime, Date, ForeignKey, Table, MetaData,
+                        select, func)
+from sqlalchemy.engine.base import Engine
+
+from ovgumensabot.meal import Meal
+from ovgumensabot.menu import Menu
+
+
+class MenuDatabase:
+    menus: Table
+    meals: Table
+    subscriptions: Table
+    db: Engine
+
+    def __init__(self, db: Engine) -> None:
+        self.db = db
+
+        meta = MetaData()
+        meta.bind = db
+
+        self.menus = Table("menus", meta,
+                           Column("day", Date, primary_key=True),
+                           Column("last_updated", DateTime, nullable=False))
+
+        self.meals = Table("meals", meta,
+                           Column("menu_day", Date, ForeignKey("menus.day", ondelete="CASCADE", primary_key=True)),
+                           Column("price", String(255), nullable=False),
+                           Column("name", String(255), nullable=False))
+
+        self.subscriptions = Table("subscriptions", meta,
+                                   Column("room_id", String(255), primary_key=True))
+
+        meta.create_all()
+
+    def upsert_menu(self, menu: Menu) -> bool:
+        logging.getLogger("maubot").info(f"Inserted menu from {menu.day} into database.")
+        with self.db.begin() as tx:
+            if self.menu_day_exists(menu):
+                tx.execute(self.menus.update()
+                           .where(self.menus.c.day == menu.day).values(day=menu.day, last_updated=menu.last_updated))
+                tx.execute(self.meals.delete().where(self.meals.c.menu_day == menu.day))
+                tx.execute(self.meals.insert(),
+                           [{"menu_day": menu.day, "price": meal.price,
+                             "name": meal.name}
+                            for meal in menu.meals])
+                return False  # menu was already existent
+            else:
+                tx.execute(self.menus.insert()
+                           .values(day=menu.day, last_updated=menu.last_updated))
+                tx.execute(self.meals.insert(),
+                           [{"menu_day": menu.day, "price": meal.price,
+                             "name": meal.name}
+                            for meal in menu.meals])
+                return True  # menu is new
+
+    def add_meals_to_menu(self, menu: Menu):
+        logging.getLogger("maubot").info(f"Add meals to menu from {menu.day}.")
+        if self.menu_day_exists(menu):
+            self.db.execute(self.meals.insert(),
+                           [{"menu_day": menu.day, "price": meal.price,
+                             "name": meal.name}
+                            for meal in menu.meals])
+
+    def subscriptions_not_empty(self) -> bool:
+        rows = self.db.execute(select([func.count()]).select(self.subscriptions)).scalar()
+        return rows and rows > 0
+
+    def subscription_exists(self, room_id: str) -> bool:
+        rows = self.db.execute(
+            select([func.count()]).select(self.subscriptions).where(self.subscriptions.c.room_id == room_id)).scalar()
+        return rows and rows > 0
+
+    def menu_day_exists(self, menu: Menu) -> bool:
+        rows = self.db.execute(select([func.count()]).select(self.menus).where(self.menus.c.day == menu.day)).scalar()
+        return rows and rows > 0
+
+    def get_menu_on_day(self, day: datetime.date) -> Iterator[Menu]:
+        logging.getLogger("maubot").info(f"Search for day {day}")
+        menu_rows = self.db.execute(select([self.menus]).where(self.menus.c.day.like(day)))
+        return self._rows_to_menus(menu_rows)
+
+    def get_latest_menu(self) -> Iterator[Menu]:
+        menu_row = self.db.execute(select([self.menus]).order_by(self.menus.c.last_updated.desc()).limit(1))
+        logging.getLogger("maubot").info(f"first menu_row {menu_row}")
+        return self._rows_to_menus(menu_row)
+
+    def _rows_to_menus(self, menu_rows) -> Iterator[Menu]:
+        for menu_row in menu_rows:
+            logging.getLogger("maubot").info(f"menu_row {menu_row}")
+            meal_rows = self.db.execute(select([self.meals]).where(self.meals.c.menu_day == menu_row[0]))
+            meals_of_the_day = []
+            for meal_row in meal_rows:
+                meals_of_the_day.append(Meal(menu_day=meal_row[0], price=meal_row[1], name=meal_row[2]))
+            yield Menu(day=menu_row[0], last_updated=menu_row[1], meals=meals_of_the_day)
+
+    def insert_subscription(self, room_id: str) -> None:
+        self.db.execute(self.subscriptions.insert().values(room_id=room_id))
+
+    def get_subscriptions(self) -> List:
+        rows = self.db.execute(self.subscriptions.select())
+        for row in rows:
+            yield row[0]
+
+    def delete_subscription(self, room_id: str) -> None:
+        self.db.execute(self.subscriptions.delete().where(self.subscriptions.c.room_id == room_id))
+
+    def get_menu_days(self) -> Iterator[datetime.date]:
+        rows = self.db.execute(select([self.menus.c.day]))
+        for row in rows:
+            yield row[0]

ovgumensabot/meal.py

@@ -1,15 +1,14 @@
 from typing import List, Dict
+from attr import dataclass
 
 
+@dataclass
 class Meal:
     """This class represents a meal"""
+    menu_day: str = None
     name: str = ""
     price: str = ""
 
-    def __init__(self, name: str, price: str):
-        self.name = name
-        self.price = price
-
     def __str__(self) -> str:
         return self.name + "\n" + self.price