remove the complete column from milestones table

need to test slight change

README.md

@@ -2,9 +2,12 @@
 Tlapbot is an [Owncast](https://owncast.online/) bot that adds channel points and
 channel point redeems to your Owncast page.
 
-The goal is to have an experience similar
-to [Twitch channel points](https://help.twitch.tv/s/article/viewer-channel-point-guide) by making use of [Owncast webhooks](https://owncast.online/thirdparty/webhooks/) and 
-[External actions](https://owncast.online/thirdparty/actions/).
+Similar
+to [Twitch channel points](https://help.twitch.tv/s/article/viewer-channel-point-guide), Tlapbot rewards your viewers with points for watching, and allows them to spend their points on fun gimmicks, challenges, reaction requests, or whatever else you decide.
+
+Tlapbot makes use of [Owncast webhooks](https://owncast.online/thirdparty/webhooks/) for chat interactions and 
+[Owncast external actions](https://owncast.online/thirdparty/actions/) to display an informative dashboard.
+
 ## Features
 The bot gives points to everyone in chat -- 10 points every 10 minutes by
 default, but the time interval and amount of points can be changed.
@@ -12,11 +15,13 @@ default, but the time interval and amount of points can be changed.
 The users in chat can then use their points on redeems -- rewards like "choose my
 background music", "choose what level to play next", "react to this video" etc.
 You can configure redeems to fit your stream and the activities you're
-doing.
+doing, and sort them into categories that can be turned on and off.
 
 The redeems then show on a "Redeems dashboard" that everyone can view
 as an External Action on the Owncast stream, or at its standalone URL.
-This allows easy browsing of active challenges and recent redeems.
+This allows easy browsing of active challenges and recent redeems, without quitting the stream.
+
+**Tlapbot currently doesn't support any automated integrations (or an API). That means no 'Crowd Control' plugin, no instant effects in OBS or VTube Studio, etc. The streamer decides how they respond to redeems or how to make them take effect.** (I'd love to support more seamless, automatic redeems in the future!)
 ### Tlapbot bot commands
 Tlapbot has these basic commands:
 - `!help` sends a help string in the chat, explaining how tlapbot works.
@@ -27,12 +32,6 @@ Tlapbot has these basic commands:
 use the new prefix instead.)
 
 Tlapbot also automatically adds a command for each redeem in the redeems file.
-### Passive mode
-Tlapbot can also be run in passive mode. In passive mode, no redeems will be available, and Tlapbot will not send any messages.
-
-However, it will still give points to viewers, and track username changes.
-
-The Tlapbot dashboard will display a passive mode disclaimer instead of redeems.
 
 ### Tlapbot dashboard
 Tlapbot dashboard is a standalone page available at `/dashboard`, made to be easily viewable as an owncast external action. The Tlapbot dashboard shows all redeems and active counters.
@@ -52,8 +51,16 @@ The redeem queue shows a chronological list of note and list redeems with timest
 #### Redeems help tab
 The dashboard also has a "Redeems help" tab. It shows an explanation of redeem types,
 and lists all active redeems, along with their price, type and description.
+
+### Passive mode
+Tlapbot can also be run in passive mode. In passive mode, no redeems will be available, and Tlapbot will not send any messages.
+
+However, it will still give points to viewers, and track username changes.
+
+The Tlapbot dashboard will display a passive mode disclaimer instead of redeems.
+
 ### Tlapbot redeems types
-Tlapbot currently supports three different redeem types. Each type of a redeem
+Tlapbot currently supports four different redeem types. Each type of a redeem
 works slightly differently, and displays differently on the redeems dashboard.
 
 Redeems can also optionally be sorted into "categories" that can be turned on
@@ -323,22 +330,22 @@ REDEEMS={
     "lurk": {"price": 1, "type": "counter", "info": "Let us know you're going to lurk."},
     "react": {"price": 200, "type": "note", "info": "Attach link to a video for me to react to."},
     "request": {"price": 100, "type": "note", "info": "Request a level, gamemode, skin, etc."},
-    "go_nap": {"type": "milestone", "info": "Streamer will go nap when the goal is reached.", "goal": 1000},
+    "go_nap": {"goal": 1000, "type": "milestone", "info": "Streamer will go nap when the goal is reached."},
     "inactive": {"price": 100, "type": "note", "info": "Example redeem that is inactive by default", "category": ["inactive"]}
 }
 ```
 #### File format
 `redeems.py` is a config file with just a `REDEEMS` key, that assigns a dictionary of redeems to it.
-Each dictionary entry is a redeem, and the dictionary keys are strings that decides the chat command for the redeem.
-The value is another dictionary that needs to have entries for `"type"`,
-an entry for `"price"` unless the redeem is a milestone,
-and optionally `"info"` and `"category"`.
-If the `"type"` is `"milestone"`, there's an additional required `"goal"` field as well.
+Each dictionary entry is a redeem, and the dictionary keys are strings that decide the chat command for the redeem.
+The redeem names shouldn't have spaces in them.
+The value is another dictionary that needs to have an entry for `"type"` and
+an entry for `"price"` for non-milestones or `"goal"` for milestones.
+Optionally, each redeem can also have `"info"` and `"category"` entries.
 
-- `"price"` value should be an integer that decides how many points the redeem will cost. Milestone redeems don't use the `"price"` value.
+- `"price"` value should be an integer that decides how many points the redeem will cost. Milestone redeems don't use the `"price"` value, they instead need to have a `"goal"`.
+- `"goal"` is a required field for milestone goals. It should be an integer, deciding the amount of points required to complete the milestone.
 - `"type"` value should be either `"list"`, `"counter"`, `"note"` or `"milestone"`. This decided the redeem's type, and whether it will show up as a counter at the top of the dashboard or as an entry in the "recent redeems" chart.
 - `"info"` value should be a string that describes what the command does. It's optional, but I recommend writing one for all `"list"`, `"note"` and `"milestone"` redeems (so that chatters know what they're redeeming and whether they should leave a note).
-- `"goal"` is a required field for milestone goals. It should be an integer, deciding the amount of points required to complete the milestone.
 - `"category"` is an optional list of strings, the categories the redeem is in.
 If a category from the list is in `ACTIVE_CATEGORIES` from `config.py`,
 then the redeem will be active. It will not be active if none of the categories

setup.py

@@ -2,7 +2,7 @@ from setuptools import find_packages, setup
 
 setup(
     name='tlapbot',
-    version='1.2.1',
+    version='1.2.2',
     packages=find_packages(),
     include_package_data=True,
     install_requires=[

tlapbot/__init__.py

@@ -4,9 +4,9 @@ from flask import Flask
 from apscheduler.schedulers.background import BackgroundScheduler
 from tlapbot.db import get_db
 from tlapbot.owncast_requests import is_stream_live, give_points_to_chat
-from tlapbot.redeems import remove_inactive_redeems 
 
-def create_app(test_config=None):
+
+def create_app(test_config: None = None) -> Flask:
     app = Flask(__name__, instance_relative_config=True)
 
     # ensure the instance folder exists
@@ -36,6 +36,12 @@ def create_app(test_config=None):
         raise RuntimeError("Prefix is >1 character. "
                            "Change your config to set 1-character prefix.")
 
+    # Check for spaces in redeems (they won't work)
+    for redeem in app.config['REDEEMS']:
+        if ' ' in redeem:
+            app.logger.warning(f"Redeem '{redeem}' has spaces in its name.")
+            app.logger.warning("Redeems with spaces are impossible to redeem.")
+
     # prepare webhooks and redeem dashboard blueprints
     from . import owncast_webhooks
     from . import tlapbot_dashboard
@@ -53,7 +59,7 @@ def create_app(test_config=None):
     app.cli.add_command(db.hard_reset_milestone_command)
 
     # scheduler job for giving points to users
-    def proxy_job():
+    def proxy_job() -> None:
         with app.app_context():
             if is_stream_live():
                 app.logger.info("Stream is LIVE. Giving points to chat.")

tlapbot/db.py

@@ -1,12 +1,13 @@
 import sqlite3
 
 import click
-from flask import current_app, g
+from flask import current_app, g, Flask
 from flask.cli import with_appcontext
 
 from tlapbot.redeems import milestone_complete
 
-def get_db():
+
+def get_db() -> sqlite3.Connection:
     if 'db' not in g:
         g.db = sqlite3.connect(
             current_app.config['DATABASE'],
@@ -17,14 +18,14 @@ def get_db():
     return g.db
 
 
-def close_db(e=None):
-    db = g.pop('db', None)
+def close_db() -> None:
+    db: sqlite3.Connection = g.pop('db', None)
 
     if db is not None:
         db.close()
 
 
-def insert_counters(db):
+def insert_counters(db: sqlite3.Connection) -> bool:
     for redeem, redeem_info in current_app.config['REDEEMS'].items():
         if redeem_info["type"] == "counter":
             try:
@@ -39,17 +40,16 @@ def insert_counters(db):
     return True
 
 
-def init_db():
+def init_db() -> bool:
     db = get_db()
 
     with current_app.open_resource('schema.sql') as f:
         db.executescript(f.read().decode('utf8'))
 
-    if insert_counters(db):
-        return True
+    return insert_counters(db)
 
 
-def clear_redeem_queue():
+def clear_redeem_queue() -> bool:
     db = get_db()
 
     try:
@@ -61,25 +61,24 @@ def clear_redeem_queue():
         )
         db.commit()
     except sqlite3.Error as e:
-        print("Error occured deleting redeem queue:", e.args[0])
+        print("Error occurred deleting redeem queue:", e.args[0])
         return False
     return True
 
 
-def refresh_counters():
+def refresh_counters() -> bool:
     db = get_db()
 
     try:
         db.execute("DELETE FROM counters")
         db.commit()
     except sqlite3.Error as e:
-        print("Error occured deleting old counters:", e.args[0])
+        print("Error occurred deleting old counters:", e.args[0])
         return False
-    if insert_counters(db):
-        return True
+    return insert_counters(db)
 
 
-def refresh_milestones():
+def refresh_milestones() -> bool:
     db = get_db()
     # delete old milestones
     try:
@@ -110,7 +109,7 @@ def refresh_milestones():
                 result = cursor.fetchone()
                 if result is None:
                     cursor.execute(
-                        "INSERT INTO milestones(name, progress, goal, complete) VALUES(?, 0, ?, FALSE)",
+                        "INSERT INTO milestones(name, progress, goal) VALUES(?, 0, ?)",
                         (redeem, redeem_info['goal'])
                     )
                 # update existing milestone to new goal
@@ -126,8 +125,8 @@ def refresh_milestones():
     return True
 
 
-def reset_milestone(milestone):
-    if not milestone in current_app.config['REDEEMS']:
+def reset_milestone(milestone: str) -> bool:
+    if milestone not in current_app.config['REDEEMS']:
         print(f"Failed resetting milestone, {milestone} not in redeems file.")
         return False
     try:
@@ -137,20 +136,19 @@ def reset_milestone(milestone):
             (milestone,)
         )
         db.execute(
-            "INSERT INTO milestones(name, progress, goal, complete) VALUES(?, ?, ?, FALSE)",
+            "INSERT INTO milestones(name, progress, goal) VALUES(?, ?, ?)",
             (milestone, 0, current_app.config['REDEEMS'][milestone]['goal'])
         )
         db.commit()
         return True
     except sqlite3.Error as e:
-        current_app.logger.error(f"Error occured adding a milestone: {e.args[0]}")
+        current_app.logger.error(f"Error occurred adding a milestone: {e.args[0]}")
         return False
 
 
-
 @click.command('init-db')
 @with_appcontext
-def init_db_command():
+def init_db_command() -> None:
     """Clear the existing data and create new tables."""
     if init_db():
         click.echo('Initialized the database.')
@@ -158,7 +156,7 @@ def init_db_command():
 
 @click.command('clear-queue')
 @with_appcontext
-def clear_queue_command():
+def clear_queue_command() -> None:
     """Remove all redeems from the redeem queue."""
     if clear_redeem_queue():
         click.echo('Cleared redeem queue.')
@@ -166,7 +164,7 @@ def clear_queue_command():
 
 @click.command('refresh-counters')
 @with_appcontext
-def refresh_counters_command():
+def refresh_counters_command() -> None:
     """Refresh counters from current config file.
     (Remove old ones, add new ones.)"""
     if refresh_counters():
@@ -175,7 +173,7 @@ def refresh_counters_command():
 
 @click.command('clear-refresh')
 @with_appcontext
-def refresh_and_clear_command():
+def refresh_and_clear_command() -> None:
     """Refresh counters and clear queue."""
     if refresh_counters() and clear_redeem_queue():
         click.echo('Counters refreshed and queue cleared.')
@@ -183,7 +181,7 @@ def refresh_and_clear_command():
 
 @click.command('refresh-milestones')
 @with_appcontext
-def refresh_milestones_command():
+def refresh_milestones_command() -> None:
     """Initialize all milestones from the redeems file,
     delete milestones not in redeem file."""
     if refresh_milestones():
@@ -192,7 +190,7 @@ def refresh_milestones_command():
 
 @click.command('reset-milestone')
 @click.argument('milestone')
-def reset_milestone_command(milestone):
+def reset_milestone_command(milestone: str) -> None:
     """Resets a completed milestone back to zero."""
     if milestone_complete(get_db(), milestone):
         if reset_milestone(milestone):
@@ -204,12 +202,12 @@ def reset_milestone_command(milestone):
 
 @click.command('hard-reset-milestone')
 @click.argument('milestone')
-def hard_reset_milestone_command(milestone):
+def hard_reset_milestone_command(milestone: str) -> None:
     """Resets any milestone back to zero."""
     if reset_milestone(milestone):
         click.echo(f"Hard reset milestone {milestone}.")
 
 
-def init_app(app):
+def init_app(app: Flask) -> None:
     app.teardown_appcontext(close_db)
     app.cli.add_command(init_db_command)

tlapbot/default_redeems.py

@@ -3,6 +3,6 @@ REDEEMS={
     "lurk": {"price": 1, "type": "counter", "info": "Let us know you're going to lurk."},
     "react": {"price": 200, "type": "note", "info": "Attach link to a video for me to react to."},
     "request": {"price": 100, "type": "note", "info": "Request a level, gamemode, skin, etc."},
-    "go_nap": {"type": "milestone", "info": "Streamer will go nap when the goal is reached.", "goal": 1000},
+    "go_nap": {"goal": 1000, "type": "milestone", "info": "Streamer will go nap when the goal is reached."},
     "inactive": {"price": 100, "type": "note", "info": "Example redeem that is inactive by default", "category": ["inactive"]}
 }

tlapbot/help_message.py

@@ -2,22 +2,29 @@ from flask import current_app
 from tlapbot.owncast_requests import send_chat
 
 
-def send_help():
+def send_help() -> None:
     message = []
-    message.append("Tlapbot gives you points for being in chat, and then allows you to spend those points.\n")
-    message.append(f"People connected to chat receive {current_app.config['POINTS_AMOUNT_GIVEN']} points every {current_app.config['POINTS_CYCLE_TIME']} seconds.\n")
-    message.append("You can see your points and recent redeems in the Tlapbot dashboard. Look for a button to click under the stream window.\n")
-    message.append("""Tlapbot commands:
-        !help to see this help message.
-        !points to see your points.\n"""
+    message.append("Tlapbot gives you points for being in chat, and then allows you to spend those points. <br>")
+    message.append(f"People connected to chat receive {current_app.config['POINTS_AMOUNT_GIVEN']} points every {current_app.config['POINTS_CYCLE_TIME']} seconds. <br>")
+    message.append("You can see your points and recent redeems in the Tlapbot dashboard. Look for a button to click under the stream window. <br>")
+    message.append("""Tlapbot commands: <br>
+        !help to see this help message. <br>
+        !points to see your points. <br>"""
     )
     if current_app.config['LIST_REDEEMS']:
-        message.append("Active redeems:\n")
+        message.append("Active redeems: <br>")
         for redeem, redeem_info in current_app.config['REDEEMS'].items():
-            if 'info' in redeem_info:
-                message.append(f"!{redeem} for {redeem_info['price']} points. {redeem_info['info']}\n")
+            if redeem_info.get('category', None):
+                if not set(redeem_info['category']).intersection(set(current_app.config['ACTIVE_CATEGORIES'])):
+                    continue
+            if 'type' in redeem_info and redeem_info['type'] == 'milestone':
+                message.append(f"!{redeem} milestone with goal of {redeem_info['goal']}.")
             else:
-                message.append(f"!{redeem} for {redeem_info['price']} points.\n")
+                message.append(f"!{redeem} for {redeem_info['price']} points.")
+            if 'info' in redeem_info:
+                message.append(f" {redeem_info['info']} <br>")
+            else:
+                message.append("<br>")
     else:
         message.append("Check the dashboard for a list of currently active redeems.")
     send_chat(''.join(message))

tlapbot/owncast_helpers.py

@@ -1,10 +1,12 @@
 from flask import current_app
-from sqlite3 import Error
+from sqlite3 import Error, Connection
 from re import sub
+from typing import Tuple
+
 
 # # # db stuff # # #
-def read_users_points(db, user_id):
-    """Errors out if user doesn't exist."""
+def read_users_points(db: Connection, user_id: str) -> int | None:
+    """Returns None and logs error in case of error, or if user doesn't exist."""
     try:
         cursor = db.execute(
             "SELECT points FROM points WHERE id = ?",
@@ -12,11 +14,12 @@ def read_users_points(db, user_id):
         )
         return cursor.fetchone()[0]
     except Error as e:
-        current_app.logger.error(f"Error occured reading points: {e.args[0]}")
-        current_app.logger.error(f"To user: {user_id}")
+        current_app.logger.error(f"Error occurred reading points: {e.args[0]}")
+        current_app.logger.error(f"Of user: {user_id}")
 
 
-def read_all_users_with_username(db, username):
+def read_all_users_with_username(db: Connection, username: str) -> list[Tuple[str, int]] | None:
+    """Returns None only if Error was logged."""
     try:
         cursor = db.execute(
             "SELECT name, points FROM points WHERE name = ?",
@@ -25,11 +28,11 @@ def read_all_users_with_username(db, username):
         users = cursor.fetchall()
         return users
     except Error as e:
-        current_app.logger.error(f"Error occured reading points by username: {e.args[0]}")
-        current_app.logger.error(f"To everyone with username: {username}")
+        current_app.logger.error(f"Error occurred reading points by username: {e.args[0]}")
+        current_app.logger.error(f"Of everyone with username: {username}")
 
 
-def give_points_to_user(db, user_id, points):
+def give_points_to_user(db: Connection, user_id: str, points: int) -> None:
     try:
         db.execute(
             "UPDATE points SET points = points + ? WHERE id = ?",
@@ -37,11 +40,11 @@ def give_points_to_user(db, user_id, points):
         )
         db.commit()
     except Error as e:
-        current_app.logger.error(f"Error occured giving points: {e.args[0]}")
+        current_app.logger.error(f"Error occurred giving points: {e.args[0]}")
         current_app.logger.error(f"To user: {user_id} amount of points: {points}")
 
 
-def use_points(db, user_id, points):
+def use_points(db: Connection, user_id: str, points: int) -> bool:
     try:
         db.execute(
             "UPDATE points SET points = points - ? WHERE id = ?",
@@ -50,12 +53,13 @@ def use_points(db, user_id, points):
         db.commit()
         return True
     except Error as e:
-        current_app.logger.error(f"Error occured using points: {e.args[0]}")
+        current_app.logger.error(f"Error occurred using points: {e.args[0]}")
         current_app.logger.error(f"From user: {user_id} amount of points: {points}")
         return False
 
 
-def user_exists(db, user_id):
+def user_exists(db: Connection, user_id: str) -> bool | None:
+    """Returns None only if an error was logged."""
     try:
         cursor = db.execute(
             "SELECT points FROM points WHERE id = ?",
@@ -65,11 +69,11 @@ def user_exists(db, user_id):
             return False
         return True
     except Error as e:
-        current_app.logger.error(f"Error occured checking if user exists: {e.args[0]}")
+        current_app.logger.error(f"Error occurred checking if user exists: {e.args[0]}")
         current_app.logger.error(f"To user: {user_id}")
 
 
-def add_user_to_database(db, user_id, display_name):
+def add_user_to_database(db: Connection, user_id: str, display_name: str) -> None:
     """ Adds a new user to the database. Does nothing if user is already in."""
     try:
         cursor = db.execute(
@@ -91,25 +95,25 @@ def add_user_to_database(db, user_id, display_name):
             )
         db.commit()
     except Error as e:
-        current_app.logger.error(f"Error occured adding user to db: {e.args[0]}")
+        current_app.logger.error(f"Error occurred adding user to db: {e.args[0]}")
         current_app.logger.error(f"To user id: {user_id}, with display name: {display_name}")
 
 
-def change_display_name(db, user_id, new_name):
+def change_display_name(db: Connection, user_id: str, new_name: str) -> None:
     try:
-        cursor = db.execute(
+        db.execute(
             "UPDATE points SET name = ? WHERE id = ?",
             (new_name, user_id)
         )
         db.commit()
     except Error as e:
-        current_app.logger.error(f"Error occured changing display name: {e.args[0]}")
+        current_app.logger.error(f"Error occurred changing display name: {e.args[0]}")
         current_app.logger.error(f"To user id: {user_id}, with display name: {new_name}")
 
 
-def remove_duplicate_usernames(db, user_id, username):
+def remove_duplicate_usernames(db: Connection, user_id: str, username: str) -> None:
     try:
-        cursor = db.execute(
+        db.execute(
             """UPDATE points
             SET name = NULL
             WHERE name = ? AND NOT id = ?""",
@@ -117,11 +121,12 @@ def remove_duplicate_usernames(db, user_id, username):
         )
         db.commit()
     except Error as e:
-        current_app.logger.error(f"Error occured removing duplicate usernames: {e.args[0]}")
+        current_app.logger.error(f"Error occurred removing duplicate usernames: {e.args[0]}")
 
 
 # # # misc. stuff # # #
-def remove_emoji(message):
+# This is now unused since rawBody attribute of the webhook now returns cleaned-up emotes.
+def remove_emoji(message: str) -> str:
     return sub(
         r'<img class="emoji" alt="(:.*?:)" title=":.*?:" src="/img/emoji/.*?">',
         r'\1',

tlapbot/owncast_requests.py

@@ -1,28 +1,30 @@
 import requests
 from flask import current_app
 from tlapbot.owncast_helpers import give_points_to_user
+from sqlite3 import Connection
+from typing import Any
 
 
-def is_stream_live():
+def is_stream_live() -> bool:
     url = current_app.config['OWNCAST_INSTANCE_URL'] + '/api/status'
     try:
         r = requests.get(url)
     except requests.exceptions.RequestException as e:
-        current_app.logger.error(f"Error occured checking if stream is live: {e.args[0]}")
+        current_app.logger.error(f"Error occurred checking if stream is live: {e.args[0]}")
         return False
     return r.json()["online"]
 
 
-def give_points_to_chat(db):
+def give_points_to_chat(db: Connection) -> None:
     url = current_app.config['OWNCAST_INSTANCE_URL'] + '/api/integrations/clients'
     headers = {"Authorization": "Bearer " + current_app.config['OWNCAST_ACCESS_TOKEN']}
     try:
         r = requests.get(url, headers=headers)
     except requests.exceptions.RequestException as e:
-        current_app.logger.error(f"Error occured getting users to give points to: {e.args[0]}")
+        current_app.logger.error(f"Error occurred getting users to give points to: {e.args[0]}")
         return
     if r.status_code != 200:
-        current_app.logger.error(f"Error occured when giving points: Response code not 200.")
+        current_app.logger.error(f"Error occurred when giving points: Response code not 200.")
         current_app.logger.error(f"Response code received: {r.status_code}.")
         current_app.logger.error(f"Check owncast instance url and access key.")
         return
@@ -31,18 +33,17 @@ def give_points_to_chat(db):
         give_points_to_user(db, user_id, current_app.config['POINTS_AMOUNT_GIVEN'])
 
 
-def send_chat(message):
+def send_chat(message: str) -> Any:
     url = current_app.config['OWNCAST_INSTANCE_URL'] + '/api/integrations/chat/send'
     headers = {"Authorization": "Bearer " + current_app.config['OWNCAST_ACCESS_TOKEN']}
     try:
         r = requests.post(url, headers=headers, json={"body": message})
     except requests.exceptions.RequestException as e:
-        current_app.logger.error(f"Error occured sending chat message: {e.args[0]}")
+        current_app.logger.error(f"Error occurred sending chat message: {e.args[0]}")
         return
     if r.status_code != 200:
-        current_app.logger.error(f"Error occured when sending chat: Response code not 200.")
+        current_app.logger.error(f"Error occurred when sending chat: Response code not 200.")
         current_app.logger.error(f"Response code received: {r.status_code}.")
         current_app.logger.error(f"Check owncast instance url and access key.")
         return
     return r.json()
-

tlapbot/owncast_webhooks.py

@@ -1,4 +1,6 @@
 from flask import Flask, request, json, Blueprint, current_app
+from sqlite3 import Connection
+from typing import Any
 from tlapbot.db import get_db
 from tlapbot.owncast_requests import send_chat
 from tlapbot.owncast_helpers import (add_user_to_database, change_display_name,
@@ -11,9 +13,12 @@ bp = Blueprint('owncast_webhooks', __name__)
 
 
 @bp.route('/owncastWebhook', methods=['POST'])
-def owncast_webhook():
-    data = request.json
-    db = get_db()
+def owncast_webhook() -> Any | None:
+    """Reads webhook json -- adds new users, removes duplicate usernames,
+    handles name changes and chat messages with commands.
+    Returns the 'data' json from the request."""
+    data: Any | None = request.json
+    db: Connection = get_db()
 
     # Make sure user is in db before doing anything else.
     if data["type"] in ["CHAT", "NAME_CHANGED", "USER_JOINED"]:
@@ -36,22 +41,22 @@ def owncast_webhook():
             user_id = data["eventData"]["user"]["id"]
             display_name = data["eventData"]["user"]["displayName"]
             current_app.logger.debug(f'New chat message from {display_name}:')
-            current_app.logger.debug(f'{data["eventData"]["body"]}')
-            if data["eventData"]["body"].startswith(f"{prefix}help"):
+            current_app.logger.debug(f'{data["eventData"]["rawBody"]}')
+            if data["eventData"]["rawBody"].startswith(f"{prefix}help"):
                 send_help()
-            elif data["eventData"]["body"].startswith(f"{prefix}points"):
+            elif data["eventData"]["rawBody"].startswith(f"{prefix}points"):
                 points = read_users_points(db, user_id)
                 if points is None:
                     send_chat("Error reading points.")
                 else:
                     send_chat(f"{display_name}'s points: {points}")
-            elif data["eventData"]["body"].startswith(f"{prefix}name_update"):
+            elif data["eventData"]["rawBody"].startswith(f"{prefix}name_update"):
                 # Forces name update in case bot didn't catch the NAME_CHANGE
                 # event. Also removes saved usernames from users with same name
                 # if user is authenticated.
                 change_display_name(db, user_id, display_name)
                 if data["eventData"]["user"]["authenticated"]:
                     remove_duplicate_usernames(db, user_id, display_name)
-            elif data["eventData"]["body"].startswith(prefix):
-                handle_redeem(data["eventData"]["body"], user_id)
+            elif data["eventData"]["rawBody"].startswith(prefix):
+                handle_redeem(data["eventData"]["rawBody"], user_id)
     return data

tlapbot/redeems.py

@@ -1,8 +1,11 @@
 from flask import current_app
-from sqlite3 import Error
+from sqlite3 import Error, Connection
+from typing import Tuple, Any
 from tlapbot.owncast_helpers import use_points
+from tlapbot.tlapbot_types import Redeems
 
-def counter_exists(db, counter_name):
+def counter_exists(db: Connection, counter_name: str) -> bool | None:
+    """Returns None only if error was logged."""
     try:
         cursor = db.execute(
             "SELECT count FROM counters WHERE name = ?",
@@ -16,40 +19,40 @@ def counter_exists(db, counter_name):
             return False
         return True
     except Error as e:
-        current_app.logger.error(f"Error occured checking if counter exists: {e.args[0]}")
+        current_app.logger.error(f"Error occurred checking if counter exists: {e.args[0]}")
         current_app.logger.error(f"For counter: {counter_name}")
 
 
-def add_to_counter(db, counter_name):
+def add_to_counter(db: Connection, counter_name: str) -> bool:
     if counter_exists(db, counter_name):
         try:
-            cursor = db.execute(
+            db.execute(
                 "UPDATE counters SET count = count + 1 WHERE name = ?",
                 (counter_name,)
             )
             db.commit()
             return True
         except Error as e:
-            current_app.logger.error(f"Error occured adding to counter: {e.args[0]}")
+            current_app.logger.error(f"Error occurred adding to counter: {e.args[0]}")
             current_app.logger.error(f"To counter: {counter_name}")
     return False
 
-
-def add_to_redeem_queue(db, user_id, redeem_name, note=None):
+# TODO: test if the new default works
+def add_to_redeem_queue(db: Connection, user_id: str, redeem_name: str, note: str="") -> bool:
     try:
-        cursor = db.execute(
+        db.execute(
             "INSERT INTO redeem_queue(redeem, redeemer_id, note) VALUES(?, ?, ?)",
             (redeem_name, user_id, note)
             )
         db.commit()
         return True
     except Error as e:
-        current_app.logger.error(f"Error occured adding to redeem queue: {e.args[0]}")
+        current_app.logger.error(f"Error occurred adding to redeem queue: {e.args[0]}")
         current_app.logger.error(f"To user: {user_id} with redeem: {redeem_name} with note: {note}")
     return False
 
 
-def add_to_milestone(db, user_id, redeem_name, points_donated):
+def add_to_milestone(db: Connection, user_id: str, redeem_name: str, points_donated: int) -> bool:
     try:
         cursor = db.execute(
             "SELECT progress, goal FROM milestones WHERE name = ?",
@@ -74,28 +77,11 @@ def add_to_milestone(db, user_id, redeem_name, points_donated):
             db.commit()
             return True
     except Error as e:
-        current_app.logger.error(f"Error occured updating milestone: {e.args[0]}")
+        current_app.logger.error(f"Error occurred updating milestone: {e.args[0]}")
     return False
 
-
-def milestone_complete(db, redeem_name):
-    try:
-        cursor = db.execute(
-            "SELECT complete FROM milestones WHERE name = ?",
-            (redeem_name,)
-        )
-        row = cursor.fetchone()
-        if row is None:
-            current_app.logger.warning("Milestone not found in database.")
-            current_app.logger.warning("Maybe you forgot to run the refresh-milestones CLI command "
-                                       "after you added a new milestone to the config?")
-        else:
-            return row[0]
-    except Error as e:
-        current_app.logger.error(f"Error occured checking if milestone is complete: {e.args[0]}")
-
-
-def check_apply_milestone_completion(db, redeem_name):
+def milestone_complete(db: Connection, redeem_name: str) -> bool | None:
+    """Returns None only if error was logged."""
     try:
         cursor = db.execute(
             "SELECT progress, goal FROM milestones WHERE name = ?",
@@ -109,49 +95,30 @@ def check_apply_milestone_completion(db, redeem_name):
         else:
             progress, goal = row
             if progress == goal:
-                cursor = db.execute(
-                    "UPDATE milestones SET complete = TRUE WHERE name = ?",
-                    (redeem_name,)
-                )
-                db.commit()
                 return True
             return False
     except Error as e:
-        current_app.logger.error(f"Error occured applying milestone completion: {e.args[0]}")
-        return False
+        current_app.logger.error(f"Error occurred checking if milestone is complete: {e.args[0]}")
 
 
-def all_milestones(db):
+
+def all_milestones(db: Connection) -> list[Tuple[str, int, int]] | None:
+    """Returns list of all (even inactive) milestones, their progress and their goal.
+    Returns None only if error was logged."""
     try:
         cursor = db.execute(
             """SELECT name, progress, goal FROM milestones"""
         )
         return cursor.fetchall()
     except Error as e:
-        current_app.logger.error(f"Error occured selecting all milestones: {e.args[0]}")
+        current_app.logger.error(f"Error occurred selecting all milestones: {e.args[0]}")
 
 
-def all_counters(db):
-    try:
-        cursor = db.execute(
-            """SELECT counters.name, counters.count FROM counters"""
-        )
-        return cursor.fetchall()
-    except Error as e:
-        current_app.logger.error(f"Error occured selecting all counters: {e.args[0]}")
-
-
-def all_active_counters(db):
-    counters = all_counters(db)
-    all_active_counters = []
-    for name, count in counters:
-        if is_redeem_active(name):
-            all_active_counters.append((name, count))
-    return all_active_counters
-
-
-def all_active_milestones(db):
+def all_active_milestones(db: Connection) -> list[Tuple[str, int, int]] | None:
+    """Returns list of all active milestones, their progress and their goal.
+    Returns None only if error was logged."""
     milestones = all_milestones(db)
+    if milestones is not None:
         all_active_milestones = []
         for name, progress, goal in milestones:
             if is_redeem_active(name):
@@ -159,7 +126,32 @@ def all_active_milestones(db):
         return all_active_milestones
 
 
-def all_active_redeems(db):
+def all_counters(db: Connection) -> list[Tuple[str, int]] | None:
+    """Returns list of all (even inactive) counters and their current value.
+    Returns None only if error was logged."""
+    try:
+        cursor = db.execute(
+            """SELECT name, count FROM counters"""
+        )
+        return cursor.fetchall()
+    except Error as e:
+        current_app.logger.error(f"Error occurred selecting all counters: {e.args[0]}")
+
+
+def all_active_counters(db: Connection) -> list[Tuple[str, int]] | None:
+    """Returns list of all active counters, and their current value.
+    Returns None if error was logged."""
+    counters = all_counters(db)
+    if counters is not None:
+        all_active_counters = []
+        for name, count in counters:
+            if is_redeem_active(name):
+                all_active_counters.append((name, count))
+        return all_active_counters
+
+
+def all_active_redeems() -> Redeems:
+    """Returns list of all active redeems."""
     redeems = current_app.config['REDEEMS']
     all_active_redeems = {}
     for redeem_name, redeem_dict in redeems.items():
@@ -173,7 +165,9 @@ def all_active_redeems(db):
     return all_active_redeems
 
 
-def pretty_redeem_queue(db):
+def pretty_redeem_queue(db: Connection) -> list[Tuple[str, str, str, str]] | None:
+    """Returns a 'pretty' redeem queue, with name of the redeemer joined instead of ID.
+    Returns None only if error was logged."""
     try:
         cursor = db.execute(
             """SELECT redeem_queue.created, redeem_queue.redeem, redeem_queue.note, points.name
@@ -183,25 +177,27 @@ def pretty_redeem_queue(db):
         )
         return cursor.fetchall()
     except Error as e:
-        current_app.logger.error(f"Error occured selecting pretty redeem queue: {e.args[0]}")
+        current_app.logger.error(f"Error occurred selecting pretty redeem queue: {e.args[0]}")
 
 
-def whole_redeem_queue(db):
+def whole_redeem_queue(db: Connection) -> list[Any] | None:
+    """Returns None if error was logged."""
     try:
         cursor = db.execute(
-            "SELECT * from redeem_queue"
+            "SELECT * from redeem_queue" #TODO: specify columns to fetch
         )
         return cursor.fetchall()
     except Error as e:
-        current_app.logger.error(f"Error occured selecting redeem queue: {e.args[0]}")
+        current_app.logger.error(f"Error occurred selecting redeem queue: {e.args[0]}")
 
 
-def is_redeem_active(redeem_name):
-    """Checks if redeem is active. Pulls the redeem by name from config."""
+def is_redeem_active(redeem_name: str) -> bool | None:
+    """Checks if redeem is active. Pulls the redeem by name from config.
+    Returns None if the redeem doesn't exist."""
     active_categories = current_app.config['ACTIVE_CATEGORIES']
     redeem_dict = current_app.config['REDEEMS'].get(redeem_name, None)
     if redeem_dict:
-        if "category" in redeem_dict:
+        if redeem_dict.get('category', None):
             for category in redeem_dict["category"]:
                 if category in active_categories:
                     return True
@@ -209,19 +205,3 @@ def is_redeem_active(redeem_name):
         else:
             return True
     return None # redeem does not exist, unknown active state
-
-
-
-def is_redeem_from_config_active(redeem, active_categories):
-    """Checks if redeem is active. `redeem` is a whole key:value pair from redeems config."""
-    if "category" in redeem[1] and redeem[1]["category"]:
-        for category in redeem[1]["category"]:
-            if category in active_categories:
-                return True
-        return False
-    return True
-
-
-def remove_inactive_redeems(redeems, active_categories):
-    return dict(filter(lambda redeem: is_redeem_from_config_active(redeem, active_categories),
-                       redeems.items()))

tlapbot/redeems_handler.py

@@ -2,11 +2,11 @@ from flask import current_app
 from tlapbot.db import get_db
 from tlapbot.owncast_requests import send_chat
 from tlapbot.redeems import (add_to_redeem_queue, add_to_counter, add_to_milestone,
-        check_apply_milestone_completion, milestone_complete, is_redeem_active)
-from tlapbot.owncast_helpers import use_points, read_users_points, remove_emoji
+        milestone_complete, is_redeem_active)
+from tlapbot.owncast_helpers import use_points, read_users_points
 
 
-def handle_redeem(message, user_id):
+def handle_redeem(message: str, user_id: str) -> None:
     split_message = message[1:].split(maxsplit=1)
     redeem = split_message[0]
     if len(split_message) == 1:
@@ -25,6 +25,11 @@ def handle_redeem(message, user_id):
     redeem_type = current_app.config['REDEEMS'][redeem]["type"]
     points = read_users_points(db, user_id)
 
+    if points is None:
+        send_chat(f"Can't redeem {redeem}, failed to read users' points.")
+        return
+
+
     # handle milestone first because it doesn't have a price
     if redeem_type == "milestone":
         if milestone_complete(db, redeem):
@@ -32,12 +37,14 @@ def handle_redeem(message, user_id):
         elif not note:
             send_chat(f"Cannot redeem {redeem}, no amount of points specified.")
         elif not note.isdigit():
-            send_chat(f"Cannot redeem {redeem}, amount of points is not an integer.")
+            send_chat(f"Cannot redeem {redeem}, amount of points is not a positive integer.")
         elif int(note) > points:
             send_chat(f"Can't redeem {redeem}, you're donating more points than you have.")
+        elif int(note) == 0:
+            send_chat(f"Can't donate zero points.")
         elif add_to_milestone(db, user_id, redeem, int(note)):
             send_chat(f"Succesfully donated to {redeem} milestone!")
-            if check_apply_milestone_completion(db, redeem):
+            if milestone_complete(db, redeem):
                 send_chat(f"Milestone goal {redeem} complete!")
         else:
             send_chat(f"Redeeming milestone {redeem} failed.")
@@ -64,7 +71,7 @@ def handle_redeem(message, user_id):
         if not note:
             send_chat(f"Cannot redeem {redeem}, no note included.")
             return
-        if (add_to_redeem_queue(db, user_id, redeem, remove_emoji(note)) and
+        if (add_to_redeem_queue(db, user_id, redeem, note) and
                 use_points(db, user_id, price)):
             send_chat(f"{redeem} redeemed for {price} points.")
         else:

tlapbot/schema.sql

@@ -12,8 +12,7 @@ CREATE TABLE milestones (
   id INTEGER PRIMARY KEY AUTOINCREMENT,
   name TEXT NOT NULL,
   progress INTEGER NOT NULL,
-  goal INTEGER NOT NULL,
-  complete BOOLEAN NOT NULL
+  goal INTEGER NOT NULL
 );
 
 CREATE TABLE counters (

tlapbot/templates/dashboard.html

@@ -30,12 +30,14 @@
                         <th>Your points balance</th>
                     </tr>
                 </thead>
-                {% for user in users %}
                 <tbody>
+                {% for user in users %}
+                    <tr>
                         <td> {{ user[0] }} </td>
                         <td> {{ user[1] }} </td>
-                </tbody>
+                    </tr>
                 {% endfor %}
+                </tbody>
             </table>
             {% endif %}
 
@@ -52,12 +54,14 @@
                         <th>Active counters</th>
                     </tr>
                 </thead>
-                {% for counter in counters %}
                 <tbody>
+                {% for counter in counters %}
+                    <tr>
                         <td> {{ counter[0] }} </td>
                         <td> {{ counter[1] }} </td>
-                </tbody>
+                    </tr>
                 {% endfor %}
+                </tbody>
             </table>
             {% endif %}
             {% if milestones %}
@@ -68,13 +72,15 @@
                         <th>Progress</th>
                     </tr>
                 </thead>
-                {% for milestone in milestones %}
                 <tbody>
+                {% for milestone in milestones %}
+                    <tr>
                         <td> {{ milestone[0] }} </td>
                         <td> <progress id="file" max={{ milestone[2] }} value={{ milestone[1] }}></progress></td>
                         <td> {{ milestone[1] }} / {{ milestone[2] }}</td>
-                </tbody>
+                    </tr>
                 {% endfor %}
+                </tbody>
             </table>
             {% endif %}
             {% endif %}
@@ -99,16 +105,18 @@
                         <th>Note</th>
                     </tr>
                 </thead>
-                {% for row in queue %}
                 <tbody>
+                {% for row in queue %}
+                    <tr>
                         <td>{{ row[0].replace(tzinfo=utc_timezone).astimezone().strftime("%H:%M") }}</td>
                         <td>{{ row[1] }}</td>
                         <td>{{ row[3] }}</td>
                         {% if row[2] %}
                         <td>{{ row[2] }}</td>
                         {% endif %}
-                </tbody>
+                    </tr>
                 {% endfor %}
+                </tbody>
             </table>
             {% endif %}
         </body>
@@ -136,8 +144,9 @@
                         <th>Description</th>
                     </tr>
                 </thead>
-                {% for redeem, redeem_info in redeems.items() %}
                 <tbody>
+                {% for redeem, redeem_info in redeems.items() %}
+                    <tr>
                         <td>{{ prefix }}{{ redeem }}</td>
                         {% if redeem_info["type"] == "milestone" %}
                         <td></td>
@@ -148,8 +157,9 @@
                         {% if redeem_info["info"] %}
                         <td>{{ redeem_info["info"] }}</td>
                         {% endif %}
-                </tbody>
+                    </tr>
                 {% endfor %}
+                </tbody>
             </table>
             {% endif %}
         </body>

tlapbot/tlapbot_dashboard.py

@@ -2,13 +2,13 @@ from flask import render_template, Blueprint, request, current_app
 from tlapbot.db import get_db
 from tlapbot.redeems import all_active_counters, all_active_milestones, all_active_redeems, pretty_redeem_queue
 from tlapbot.owncast_helpers import read_all_users_with_username
-from datetime import datetime, timezone
+from datetime import timezone
 
 bp = Blueprint('redeem_dashboard', __name__)
 
 
 @bp.route('/dashboard', methods=['GET'])
-def dashboard():
+def dashboard() -> str:
     db = get_db()
     username = request.args.get("username")
     if username is not None:
@@ -20,7 +20,7 @@ def dashboard():
                            queue=pretty_redeem_queue(db),
                            counters=all_active_counters(db),
                            milestones=all_active_milestones(db),
-                           redeems=all_active_redeems(db),
+                           redeems=all_active_redeems(),
                            prefix=current_app.config['PREFIX'],
                            passive=current_app.config['PASSIVE'],
                            username=username,

tlapbot/tlapbot_types.py

@@ -0,0 +1,4 @@
+from typing import Any, TypeAlias
+
+Redeems: TypeAlias = dict[str, dict[str, Any]]
+# at the moment the Any could be specialized to str | int | list[str]