WIP: add polls

README.md

@@ -122,7 +122,7 @@ as a package in editable more.
     python -m flask init-db
     ```
 5. Create an `instance/config.py` file and fill it in as needed.
-Default values are included in `tlapbot/default_config.py`, and values in
+Default values are included in `tlapbot/defaults/default_config.py`, and values in
 `config.py` overwrite them. (The database also lives in the instance folder
 by default.)
 
@@ -133,7 +133,7 @@ by default.)
     OWNCAST_INSTANCE_URL # default points to localhost owncast on default port
     ```
 6. OPTIONAL: Create an `instance/redeems.py` file and add your custom redeems.  
-  If you don't add a redeems file, the bot will initialize the default redeems from `tlapbot/default_redeems.py`.  
+  If you don't add a redeems file, the bot will initialize the default redeems from `tlapbot/defaults/default_redeems.py`.  
   More details on how to write the config and redeems files are written later in the readme.
 7. If you've added any new counters or milestones, run `refresh-counters` or `refresh-milestones` commands to initialize them into the database.
 
@@ -299,7 +299,7 @@ Including these values is mandatory if you want tlapbot to work.
 - `OWNCAST_ACCESS_TOKEN` is the owncast access token that owncast will use to get list of users in chat. Generate one in your owncast instance.
 - `OWNCAST_INSTANCE_URL` is the full URL of your owncast instance, like `"http://MyTlapbotServer.example"`
 #### Optional
-Including these values will overwrite their defaults from `/tlapbot/default_config.py`.
+Including these values will overwrite their defaults from `/tlapbot/defaults/default_config.py`.
 - `POINTS_CYCLE_TIME` decides how often channel points are given to users in chat,
 in seconds. 
 - `POINTS_AMOUNT_GIVEN` decides how many channel points users receive.
@@ -320,7 +320,7 @@ LIST_REDEEMS=True
 ACTIVE_CATEGORIES=["gaming"]
 ```
 ### redeems.py
-`redeems.py` is a file where you define all your custom redeems. Tlapbot will work without it, but it will load a few default, generic redeems from `tlapbot/default_redeems.py`.
+`redeems.py` is a file where you define all your custom redeems. Tlapbot will work without it, but it will load a few default, generic redeems from `tlapbot/defaults/default_redeems.py`.
 
 (`redeems.py` should be in the instance folder: `instance/redeems.py` for folder install.)
 #### `default_redeems.py`:

tlapbot/__init__.py

@@ -20,11 +20,16 @@ def create_app(test_config: None = None) -> Flask:
     app.config.from_mapping(
         DATABASE=os.path.join(app.instance_path, "tlapbot.sqlite")
     )
-    app.config.from_object('tlapbot.default_config')
+    app.config.from_object('tlapbot.defaults.default_config')
-    app.config.from_object('tlapbot.default_redeems')
+    app.config.from_object('tlapbot.defaults.default_redeems')
     app.config.from_pyfile('config.py', silent=True)
     app.config.from_pyfile('redeems.py', silent=True)
 
+    # set up polls if they're enabled
+    if app.config['POLLS']:
+        app.config.from_object('tlapbot.defaults.default_polls')
+        app.config.from_pyfile('polls.py', silent=True)
+
     # Make logging work for gunicorn-ran instances of tlapbot.
     if app.config['GUNICORN']:
         gunicorn_logger = logging.getLogger('gunicorn.error')

tlapbot/db.py

@@ -4,7 +4,7 @@ import click
 from flask import current_app, g, Flask
 from flask.cli import with_appcontext
 
-from tlapbot.redeems import milestone_complete
+from tlapbot.redeems.milestones import milestone_complete
 
 
 def get_db() -> sqlite3.Connection:
@@ -40,6 +40,20 @@ def insert_counters(db: sqlite3.Connection) -> bool:
     return True
 
 
+def insert_polls(db: sqlite3.Connection) -> bool:
+    for poll, poll_info in current_app.config['POLLS'].items():
+        for option in poll_info["options"]:
+            try:
+                db.execute(
+                    "INSERT INTO polls(poll_name, option, points) VALUES(?, ?, 0)",
+                    (poll, option)
+                )
+            except sqlite3.Error as e:
+                print(f"Failed inserting poll option {poll} {option} to db: {e.args[0]}")
+                return False
+    return True
+
+
 def init_db() -> bool:
     db = get_db()
 
@@ -78,6 +92,32 @@ def refresh_counters() -> bool:
     return insert_counters(db)
 
 
+def refresh_polls() -> bool:
+    db = get_db()
+
+    try:
+        db.execute("DELETE FROM polls")
+        db.commit()
+    except sqlite3.Error as e:
+        print("Error occurred deleting old counters:", e.args[0])
+        return False
+    return insert_polls(db)
+
+
+def reset_poll(poll: str) -> bool:
+    try:
+        db = get_db()
+        db.execute(
+            "UPDATE polls SET points = 0 WHERE poll_name = ?",
+            (poll,)
+        )
+        db.commit()
+        return True
+    except sqlite3.Error as e:
+        current_app.logger.error(f"Error occurred adding a milestone: {e.args[0]}")
+        return False
+
+
 def refresh_milestones() -> bool:
     db = get_db()
     # delete old milestones
@@ -208,6 +248,25 @@ def hard_reset_milestone_command(milestone: str) -> None:
         click.echo(f"Hard reset milestone {milestone}.")
 
 
+@click.command('refresh-polls')
+@with_appcontext
+def refresh_polls_command() -> None:
+    """Initialize all polls from the polls file,
+    delete polls not in polls file."""
+    if refresh_polls():
+        click.echo('Refreshed polls.')
+
+
+@click.command('reset-polls')
+@click.argument('milestone')
+def reset_poll_command(poll: str) -> None:
+    """Resets polls progress back to zero."""
+    if reset_poll(poll):
+        click.echo(f"Reset poll {poll}.")
+    else:
+        click.echo(f"Could not reset poll {poll}.")
+
+
 def init_app(app: Flask) -> None:
     app.teardown_appcontext(close_db)
     app.cli.add_command(init_db_command)

tlapbot/defaults/default_config.py

@@ -7,4 +7,5 @@ PASSIVE=False
 LIST_REDEEMS=False
 ACTIVE_CATEGORIES=[]
 GUNICORN=False
-PREFIX='!'
+PREFIX='!'
+POLLS=True

tlapbot/defaults/default_polls.py

@@ -0,0 +1,3 @@
+POLLS={
+    "favourite_food": {"info": "Vote for your favourite food.", "options": ["pizza", "soup", "curry", "schnitzel"]}
+}

tlapbot/owncast_webhooks.py

@@ -7,6 +7,7 @@ from tlapbot.owncast_helpers import (add_user_to_database, change_display_name,
         read_users_points, remove_duplicate_usernames)
 from tlapbot.help_message import send_help
 from tlapbot.redeems_handler import handle_redeem
+from tlapbot.poll_handler import handle_poll_vote
 
 
 bp = Blueprint('owncast_webhooks', __name__)
@@ -57,6 +58,8 @@ def owncast_webhook() -> Any | None:
                 change_display_name(db, user_id, display_name)
                 if data["eventData"]["user"]["authenticated"]:
                     remove_duplicate_usernames(db, user_id, display_name)
+            elif data["eventData"]["rawBody"].startswith(f"{prefix}vote"):
+                handle_poll_vote(data["eventData"]["rawBody"], user_id)
             elif data["eventData"]["rawBody"].startswith(prefix):
                 handle_redeem(data["eventData"]["rawBody"], user_id)
     return data

tlapbot/poll_handler.py

@@ -0,0 +1,31 @@
+from sqlite3 import Connection
+from tlapbot.db import get_db
+from tlapbot.owncast_requests import send_chat
+from tlapbot.owncast_helpers import read_users_points, use_points
+from tlapbot.redeems.polls import poll_option_exists, vote_in_poll
+
+
+def handle_poll_vote(message: str, user_id: str) -> None:
+    split_message = message[5:].split(maxsplit=1)
+    if len(split_message < 3):
+        send_chat("Can't vote for poll, not enough arguments in message.")
+    poll_name = split_message[0]
+    option = split_message[1]
+    poll_points = split_message[2]
+
+    db: Connection = get_db()
+    if not poll_option_exists(db, poll_name, option):
+        send_chat("Can't vote for poll, poll and option combination not found.")
+        return
+    if not poll_points.isdigit():
+        send_chat(f"Can't vote in {poll_name} poll, donation amount is not a number.")
+        return
+    user_points = read_users_points(db, user_id)
+    if not user_points:
+        send_chat(f"Can't vote in {poll_name} poll, failed to read users' points.")
+        return
+    if user_points < poll_points:
+        send_chat(f"Can't vote in {poll_name} poll, you're voting with more points than you have.")
+    if (vote_in_poll(db, poll_name, option, poll_points) and 
+            use_points(db, user_id, poll_points)):
+        send_chat(f"{poll_points} donated to {option} in poll {poll_name}")

tlapbot/redeems.py

@@ -1,207 +0,0 @@
-from flask import current_app
-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: Connection, counter_name: str) -> bool | None:
-    """Returns None only if error was logged."""
-    try:
-        cursor = db.execute(
-            "SELECT count FROM counters WHERE name = ?",
-            (counter_name,)
-        )
-        counter = cursor.fetchone()
-        if counter is None:
-            current_app.logger.warning("Counter not found in database.")
-            current_app.logger.warning("Maybe you forgot to run the refresh-counters CLI command "
-                                       "after you added a new counter to the config?")
-            return False
-        return True
-    except Error as e:
-        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: Connection, counter_name: str) -> bool:
-    if counter_exists(db, counter_name):
-        try:
-            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 occurred adding to counter: {e.args[0]}")
-            current_app.logger.error(f"To counter: {counter_name}")
-    return False
-
-# TODO: test if the new default works
-def add_to_redeem_queue(db: Connection, user_id: str, redeem_name: str, note: str="") -> bool:
-    try:
-        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 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: Connection, user_id: str, redeem_name: str, points_donated: int) -> bool:
-    try:
-        cursor = db.execute(
-            "SELECT progress, goal 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?")
-            return False
-        progress, goal = row
-        if progress + points_donated > goal:
-            points_donated = goal - progress
-            if points_donated < 0:
-                points_donated = 0
-        if use_points(db, user_id, points_donated):
-            cursor = db.execute(
-                "UPDATE milestones SET progress = ? WHERE name = ?",
-                (progress + points_donated, redeem_name)
-            )
-            db.commit()
-            return True
-    except Error as e:
-        current_app.logger.error(f"Error occurred updating milestone: {e.args[0]}")
-    return False
-
-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 = ?",
-            (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:
-            progress, goal = row
-            if progress == goal:
-                return True
-            return False
-    except Error as e:
-        current_app.logger.error(f"Error occurred checking if milestone is complete: {e.args[0]}")
-
-
-
-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 occurred selecting all milestones: {e.args[0]}")
-
-
-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):
-                all_active_milestones.append((name, progress, goal))
-        return all_active_milestones
-
-
-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():
-        if redeem_dict.get('category', None):
-            for category in redeem_dict['category']:
-                if category in current_app.config['ACTIVE_CATEGORIES']:
-                    all_active_redeems[redeem_name] = redeem_dict
-                    break
-        else:
-            all_active_redeems[redeem_name] = redeem_dict
-    return all_active_redeems
-
-
-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
-            FROM redeem_queue
-            INNER JOIN points
-            on redeem_queue.redeemer_id = points.id"""
-        )
-        return cursor.fetchall()
-    except Error as e:
-        current_app.logger.error(f"Error occurred selecting pretty redeem queue: {e.args[0]}")
-
-
-def whole_redeem_queue(db: Connection) -> list[Any] | None:
-    """Returns None if error was logged."""
-    try:
-        cursor = db.execute(
-            "SELECT * from redeem_queue" #TODO: specify columns to fetch
-        )
-        return cursor.fetchall()
-    except Error as e:
-        current_app.logger.error(f"Error occurred selecting redeem queue: {e.args[0]}")
-
-
-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 redeem_dict.get('category', None):
-            for category in redeem_dict["category"]:
-                if category in active_categories:
-                    return True
-            return False
-        else:
-            return True
-    return None # redeem does not exist, unknown active state

tlapbot/redeems/counters.py

@@ -0,0 +1,63 @@
+from flask import current_app
+from sqlite3 import Error, Connection
+from typing import Tuple
+from tlapbot.redeems.redeems import is_redeem_active
+
+
+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 = ?",
+            (counter_name,)
+        )
+        counter = cursor.fetchone()
+        if counter is None:
+            current_app.logger.warning("Counter not found in database.")
+            current_app.logger.warning("Maybe you forgot to run the refresh-counters CLI command "
+                                       "after you added a new counter to the config?")
+            return False
+        return True
+    except Error as e:
+        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: Connection, counter_name: str) -> bool:
+    if counter_exists(db, counter_name):
+        try:
+            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 occurred adding to counter: {e.args[0]}")
+            current_app.logger.error(f"To counter: {counter_name}")
+    return False
+
+
+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
+

tlapbot/redeems/milestones.py

@@ -0,0 +1,79 @@
+from flask import current_app
+from sqlite3 import Error, Connection
+from typing import Tuple, Any
+from tlapbot.owncast_helpers import use_points
+from tlapbot.redeems import is_redeem_active
+
+
+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 = ?",
+            (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?")
+            return False
+        progress, goal = row
+        if progress + points_donated > goal:
+            points_donated = goal - progress
+            if points_donated < 0:
+                points_donated = 0
+        if use_points(db, user_id, points_donated):
+            cursor = db.execute(
+                "UPDATE milestones SET progress = ? WHERE name = ?",
+                (progress + points_donated, redeem_name)
+            )
+            db.commit()
+            return True
+    except Error as e:
+        current_app.logger.error(f"Error occurred updating milestone: {e.args[0]}")
+    return False
+
+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 = ?",
+            (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:
+            progress, goal = row
+            if progress == goal:
+                return True
+            return False
+    except Error as e:
+        current_app.logger.error(f"Error occurred checking if milestone is complete: {e.args[0]}")
+
+
+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 occurred selecting all milestones: {e.args[0]}")
+
+
+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):
+                all_active_milestones.append((name, progress, goal))
+        return all_active_milestones
+

tlapbot/redeems/polls.py

@@ -0,0 +1,38 @@
+from flask import current_app
+from sqlite3 import Error, Connection
+
+
+def poll_option_exists(db: Connection, poll_name: str, option: str) -> bool | None:
+    """Returns None only if error was logged."""
+    try:
+        cursor = db.execute(
+            "SELECT poll_name, option FROM polls WHERE poll_name = ? and option = ?",
+            (poll_name, option)
+        )
+        counter = cursor.fetchone()
+        if counter is None:
+            current_app.logger.warning("Poll and option combination not found in database.")
+            current_app.logger.warning("Maybe you forgot to run the refresh-polls CLI command "
+                                       "after you added a new poll to the config?")
+            return False
+        return True
+    except Error as e:
+        current_app.logger.error(f"Error occurred checking if poll exists: {e.args[0]}")
+        current_app.logger.error(f"For poll&option: {poll_name}:{option}")
+
+
+def vote_in_poll(db: Connection, poll_name: str, option: str, points: int) -> bool | None:
+    if points <= 0:
+        current_app.logger.warning(f"Vote for {poll_name}:{option} was not a positive integer.")
+        return
+    if poll_option_exists(db, poll_name, option):
+        try:
+            cursor = db.execute(
+                "UPDATE polls SET progress = progress + ? WHERE poll_name = ? and option = ?",
+                (points, poll_name, option)
+                )
+            db.commit()
+            return True
+        except Error as e:
+            current_app.logger.error(f"Error occurred updating milestone: {e.args[0]}")
+        return False

tlapbot/redeems/redeems.py

@@ -0,0 +1,74 @@
+from flask import current_app
+from sqlite3 import Error, Connection
+from typing import Tuple, Any
+from tlapbot.tlapbot_types import Redeems
+
+# TODO: test if the new default works
+def add_to_redeem_queue(db: Connection, user_id: str, redeem_name: str, note: str="") -> bool:
+    try:
+        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 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 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():
+        if redeem_dict.get('category', None):
+            for category in redeem_dict['category']:
+                if category in current_app.config['ACTIVE_CATEGORIES']:
+                    all_active_redeems[redeem_name] = redeem_dict
+                    break
+        else:
+            all_active_redeems[redeem_name] = redeem_dict
+    return all_active_redeems
+
+
+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
+            FROM redeem_queue
+            INNER JOIN points
+            on redeem_queue.redeemer_id = points.id"""
+        )
+        return cursor.fetchall()
+    except Error as e:
+        current_app.logger.error(f"Error occurred selecting pretty redeem queue: {e.args[0]}")
+
+
+def whole_redeem_queue(db: Connection) -> list[Any] | None:
+    """Returns None if error was logged."""
+    try:
+        cursor = db.execute(
+            "SELECT * from redeem_queue" #TODO: specify columns to fetch
+        )
+        return cursor.fetchall()
+    except Error as e:
+        current_app.logger.error(f"Error occurred selecting redeem queue: {e.args[0]}")
+
+
+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 redeem_dict.get('category', None):
+            for category in redeem_dict["category"]:
+                if category in active_categories:
+                    return True
+            return False
+        else:
+            return True
+    return None # redeem does not exist, unknown active state

tlapbot/redeems_handler.py

@@ -1,8 +1,9 @@
 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,
+from tlapbot.redeems.redeems import add_to_redeem_queue, is_redeem_active
-        milestone_complete, is_redeem_active)
+from tlapbot.redeems.counters import add_to_counter
+from tlapbot.redeems.milestones import  add_to_milestone, milestone_complete
 from tlapbot.owncast_helpers import use_points, read_users_points
 
 

tlapbot/schema.sql

@@ -28,4 +28,11 @@ CREATE TABLE redeem_queue (
   redeemer_id TEXT NOT NULL,
   note TEXT,
   FOREIGN KEY (redeemer_id) REFERENCES points (id)
-);
+);
+
+CREATE TABLE polls (
+  id INTEGER PRIMARY KEY AUTOINCREMENT,
+  points INTEGER NOT NULL,
+  option TEXT NOT NULL,
+  poll_name TEXT NOT NULL,
+)

tlapbot/tlapbot_dashboard.py

@@ -1,6 +1,8 @@
 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.redeems.redeems import all_active_redeems, pretty_redeem_queue
+from tlapbot.redeems.counters import all_active_counters
+from tlapbot.redeems.milestones import all_active_milestones
 from tlapbot.owncast_helpers import read_all_users_with_username
 from datetime import timezone