From ef5618a5a564e33b479d2f628a0a3fd5e5b0dc8f Mon Sep 17 00:00:00 2001 From: Tsz Tin Vivian Soo Date: Thu, 30 Oct 2025 17:02:27 -0400 Subject: [PATCH 01/23] Add initial migration configuration files for Alembic --- migrations/README | 1 + migrations/alembic.ini | 50 +++++++++++++++++ migrations/env.py | 113 ++++++++++++++++++++++++++++++++++++++ migrations/script.py.mako | 24 ++++++++ 4 files changed, 188 insertions(+) create mode 100644 migrations/README create mode 100644 migrations/alembic.ini create mode 100644 migrations/env.py create mode 100644 migrations/script.py.mako diff --git a/migrations/README b/migrations/README new file mode 100644 index 000000000..0e0484415 --- /dev/null +++ b/migrations/README @@ -0,0 +1 @@ +Single-database configuration for Flask. diff --git a/migrations/alembic.ini b/migrations/alembic.ini new file mode 100644 index 000000000..ec9d45c26 --- /dev/null +++ b/migrations/alembic.ini @@ -0,0 +1,50 @@ +# A generic, single database configuration. + +[alembic] +# template used to generate migration files +# file_template = %%(rev)s_%%(slug)s + +# set to 'true' to run the environment during +# the 'revision' command, regardless of autogenerate +# revision_environment = false + + +# Logging configuration +[loggers] +keys = root,sqlalchemy,alembic,flask_migrate + +[handlers] +keys = console + +[formatters] +keys = generic + +[logger_root] +level = WARN +handlers = console +qualname = + +[logger_sqlalchemy] +level = WARN +handlers = +qualname = sqlalchemy.engine + +[logger_alembic] +level = INFO +handlers = +qualname = alembic + +[logger_flask_migrate] +level = INFO +handlers = +qualname = flask_migrate + +[handler_console] +class = StreamHandler +args = (sys.stderr,) +level = NOTSET +formatter = generic + +[formatter_generic] +format = %(levelname)-5.5s [%(name)s] %(message)s +datefmt = %H:%M:%S diff --git a/migrations/env.py b/migrations/env.py new file mode 100644 index 000000000..4c9709271 --- /dev/null +++ b/migrations/env.py @@ -0,0 +1,113 @@ +import logging +from logging.config import fileConfig + +from flask import current_app + +from alembic import context + +# this is the Alembic Config object, which provides +# access to the values within the .ini file in use. +config = context.config + +# Interpret the config file for Python logging. +# This line sets up loggers basically. +fileConfig(config.config_file_name) +logger = logging.getLogger('alembic.env') + + +def get_engine(): + try: + # this works with Flask-SQLAlchemy<3 and Alchemical + return current_app.extensions['migrate'].db.get_engine() + except (TypeError, AttributeError): + # this works with Flask-SQLAlchemy>=3 + return current_app.extensions['migrate'].db.engine + + +def get_engine_url(): + try: + return get_engine().url.render_as_string(hide_password=False).replace( + '%', '%%') + except AttributeError: + return str(get_engine().url).replace('%', '%%') + + +# add your model's MetaData object here +# for 'autogenerate' support +# from myapp import mymodel +# target_metadata = mymodel.Base.metadata +config.set_main_option('sqlalchemy.url', get_engine_url()) +target_db = current_app.extensions['migrate'].db + +# other values from the config, defined by the needs of env.py, +# can be acquired: +# my_important_option = config.get_main_option("my_important_option") +# ... etc. + + +def get_metadata(): + if hasattr(target_db, 'metadatas'): + return target_db.metadatas[None] + return target_db.metadata + + +def run_migrations_offline(): + """Run migrations in 'offline' mode. + + This configures the context with just a URL + and not an Engine, though an Engine is acceptable + here as well. By skipping the Engine creation + we don't even need a DBAPI to be available. + + Calls to context.execute() here emit the given string to the + script output. + + """ + url = config.get_main_option("sqlalchemy.url") + context.configure( + url=url, target_metadata=get_metadata(), literal_binds=True + ) + + with context.begin_transaction(): + context.run_migrations() + + +def run_migrations_online(): + """Run migrations in 'online' mode. + + In this scenario we need to create an Engine + and associate a connection with the context. + + """ + + # this callback is used to prevent an auto-migration from being generated + # when there are no changes to the schema + # reference: http://alembic.zzzcomputing.com/en/latest/cookbook.html + def process_revision_directives(context, revision, directives): + if getattr(config.cmd_opts, 'autogenerate', False): + script = directives[0] + if script.upgrade_ops.is_empty(): + directives[:] = [] + logger.info('No changes in schema detected.') + + conf_args = current_app.extensions['migrate'].configure_args + if conf_args.get("process_revision_directives") is None: + conf_args["process_revision_directives"] = process_revision_directives + + connectable = get_engine() + + with connectable.connect() as connection: + context.configure( + connection=connection, + target_metadata=get_metadata(), + **conf_args + ) + + with context.begin_transaction(): + context.run_migrations() + + +if context.is_offline_mode(): + run_migrations_offline() +else: + run_migrations_online() diff --git a/migrations/script.py.mako b/migrations/script.py.mako new file mode 100644 index 000000000..2c0156303 --- /dev/null +++ b/migrations/script.py.mako @@ -0,0 +1,24 @@ +"""${message} + +Revision ID: ${up_revision} +Revises: ${down_revision | comma,n} +Create Date: ${create_date} + +""" +from alembic import op +import sqlalchemy as sa +${imports if imports else ""} + +# revision identifiers, used by Alembic. +revision = ${repr(up_revision)} +down_revision = ${repr(down_revision)} +branch_labels = ${repr(branch_labels)} +depends_on = ${repr(depends_on)} + + +def upgrade(): + ${upgrades if upgrades else "pass"} + + +def downgrade(): + ${downgrades if downgrades else "pass"} From 86d366d1b1abf557967e644e319389639a5ba7a8 Mon Sep 17 00:00:00 2001 From: Tsz Tin Vivian Soo Date: Thu, 30 Oct 2025 21:54:52 -0400 Subject: [PATCH 02/23] Implement task creation endpoint and define Task model with return_dict method --- app/__init__.py | 2 ++ app/models/task.py | 14 ++++++++++ app/routes/task_routes.py | 23 +++++++++++++++- migrations/versions/077ed6acc8d9_.py | 39 ++++++++++++++++++++++++++++ 4 files changed, 77 insertions(+), 1 deletion(-) create mode 100644 migrations/versions/077ed6acc8d9_.py diff --git a/app/__init__.py b/app/__init__.py index 3c581ceeb..d43f651f0 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,6 +1,7 @@ from flask import Flask from .db import db, migrate from .models import task, goal +from .routes.task_routes import tasks_bp import os def create_app(config=None): @@ -18,5 +19,6 @@ def create_app(config=None): migrate.init_app(app, db) # Register Blueprints here + app.register_blueprint(tasks_bp) return app diff --git a/app/models/task.py b/app/models/task.py index 5d99666a4..50d88558d 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -1,5 +1,19 @@ from sqlalchemy.orm import Mapped, mapped_column from ..db import db +from datetime import datetime +from sqlalchemy import DateTime +from typing import Optional class Task(db.Model): id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True) + title: Mapped[str] + description: Mapped[str] + completed_at: Mapped[Optional[datetime]] = mapped_column(DateTime(timezone=True), nullable=True) + + def return_dict(self): + return { + "id": self.id, + "title": self.title, + "description": self.description, + "completed_at": self.completed_at if self.completed_at else None + } diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index 3aae38d49..ebacac0cb 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -1 +1,22 @@ -from flask import Blueprint \ No newline at end of file +from flask import Blueprint, abort, make_response, request, Response +from app.models.task import Task +from ..db import db +tasks_bp = Blueprint("tasks_bp", __name__, url_prefix="/tasks") + + + +@tasks_bp.post("") +def create_task(): + request_body = request.get_json() + title = request_body["title"] + description = request_body["description"] + completed_at = request_body.get("completed_at") + + new_task = Task(title=title, description=description, completed_at=completed_at) + + db.session.add(new_task) + db.session.commit() + + response = new_task.return_dict() + + return response, 201 \ No newline at end of file diff --git a/migrations/versions/077ed6acc8d9_.py b/migrations/versions/077ed6acc8d9_.py new file mode 100644 index 000000000..c33c14e41 --- /dev/null +++ b/migrations/versions/077ed6acc8d9_.py @@ -0,0 +1,39 @@ +"""empty message + +Revision ID: 077ed6acc8d9 +Revises: +Create Date: 2025-10-30 18:16:13.699874 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '077ed6acc8d9' +down_revision = None +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.create_table('goal', + sa.Column('id', sa.Integer(), autoincrement=True, nullable=False), + sa.PrimaryKeyConstraint('id') + ) + op.create_table('task', + sa.Column('id', sa.Integer(), autoincrement=True, nullable=False), + sa.Column('title', sa.String(), nullable=False), + sa.Column('description', sa.String(), nullable=False), + sa.Column('completed_at', sa.DateTime(timezone=True), nullable=True), + sa.PrimaryKeyConstraint('id') + ) + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.drop_table('task') + op.drop_table('goal') + # ### end Alembic commands ### From f41620a8deaf4aa9f34f28583a138d9413240561 Mon Sep 17 00:00:00 2001 From: Tsz Tin Vivian Soo Date: Fri, 31 Oct 2025 09:24:28 -0400 Subject: [PATCH 03/23] Add task retrieval functions to task_routes.py --- app/routes/task_routes.py | 27 +++++++++++++++++++++++++-- 1 file changed, 25 insertions(+), 2 deletions(-) diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index ebacac0cb..040e05d49 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -3,7 +3,10 @@ from ..db import db tasks_bp = Blueprint("tasks_bp", __name__, url_prefix="/tasks") - +# To do: +# make helper functions: +# 1: retrieve a model instance by id +# 2: handle the creation of new instances of a model from a dictionary, return expected response @tasks_bp.post("") def create_task(): @@ -19,4 +22,24 @@ def create_task(): response = new_task.return_dict() - return response, 201 \ No newline at end of file + return response, 201 + +@tasks_bp.get("") +def get_all_tasks(): + query = db.select(Task).order_by(Task.id) + + tasks = db.session.scalars(query) + + tasks_response = [task.return_dict() for task in tasks] + + return tasks_response + +@tasks_bp.get("/") +def get_task(task_id): + query = db.select(Task).where(Task.id == task_id) + + task = db.session.scalar(query) + + tasks_response = task.return_dict() + + return tasks_response \ No newline at end of file From 7911d54555801695c8478d8949a12ad78da13e70 Mon Sep 17 00:00:00 2001 From: Tsz Tin Vivian Soo Date: Fri, 31 Oct 2025 16:41:26 -0400 Subject: [PATCH 04/23] Implement update and delete task endpoints in task_routes.py --- app/routes/task_routes.py | 30 +++++++++++++++++++++++++++++- 1 file changed, 29 insertions(+), 1 deletion(-) diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index 040e05d49..769254165 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -42,4 +42,32 @@ def get_task(task_id): tasks_response = task.return_dict() - return tasks_response \ No newline at end of file + return tasks_response + +@tasks_bp.put("/") +def update_task(task_id): + request_body = request.get_json() + title = request_body["title"] + description = request_body["description"] + completed_at = request_body.get("completed_at") + + query = db.select(Task).where(Task.id == task_id) + task = db.session.scalar(query) + + task.title = title + task.description = description + task.completed_at = completed_at + + db.session.commit() + + return Response(status=204, mimetype="application/json") + +@tasks_bp.delete("/") +def delete_task(task_id): + query = db.Select(Task).where(Task.id == task_id) + task = db.session.scalar(query) + + db.session.delete(task) + db.session.commit() + + return Response(status=204, mimetype="application/json") \ No newline at end of file From e873b07cfddaae1d0a6bbd093cd60e7251df53ce Mon Sep 17 00:00:00 2001 From: Tsz Tin Vivian Soo Date: Fri, 31 Oct 2025 17:38:26 -0400 Subject: [PATCH 05/23] Refactor task retrieval logic into validate_task function for improved code reuse and clarity --- app/routes/task_routes.py | 41 +++++++++++++++++++++++++-------------- 1 file changed, 26 insertions(+), 15 deletions(-) diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index 769254165..97b724507 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -8,6 +8,24 @@ # 1: retrieve a model instance by id # 2: handle the creation of new instances of a model from a dictionary, return expected response +def validate_task(task_id): + try: + task_id = int(task_id) + except: + response = {"message": f"Task {task_id} invalid"} + + abort(make_response(response, 400)) + + query = db.select(Task).where(Task.id == task_id) + task = db.session.scalar(query) + + if not task: + response = {"message": f"Task {task_id} not found"} + abort(make_response(response, 404)) + + return task + + @tasks_bp.post("") def create_task(): request_body = request.get_json() @@ -36,9 +54,7 @@ def get_all_tasks(): @tasks_bp.get("/") def get_task(task_id): - query = db.select(Task).where(Task.id == task_id) - - task = db.session.scalar(query) + task = validate_task(task_id) tasks_response = task.return_dict() @@ -46,17 +62,13 @@ def get_task(task_id): @tasks_bp.put("/") def update_task(task_id): - request_body = request.get_json() - title = request_body["title"] - description = request_body["description"] - completed_at = request_body.get("completed_at") + task = validate_task(task_id) - query = db.select(Task).where(Task.id == task_id) - task = db.session.scalar(query) - - task.title = title - task.description = description - task.completed_at = completed_at + request_body = request.get_json() + + task.title = request_body["title"] + task.description = request_body["description"] + task.completed_at = request_body.get("completed_at") db.session.commit() @@ -64,8 +76,7 @@ def update_task(task_id): @tasks_bp.delete("/") def delete_task(task_id): - query = db.Select(Task).where(Task.id == task_id) - task = db.session.scalar(query) + task = validate_task(task_id) db.session.delete(task) db.session.commit() From 281568b16d61ec2526d9959c65806a7cca371449 Mon Sep 17 00:00:00 2001 From: Tsz Tin Vivian Soo Date: Fri, 31 Oct 2025 18:05:10 -0400 Subject: [PATCH 06/23] Refactor task creation logic into separate function for improved clarity and reuse --- app/routes/task_routes.py | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index 97b724507..634647fe6 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -3,10 +3,6 @@ from ..db import db tasks_bp = Blueprint("tasks_bp", __name__, url_prefix="/tasks") -# To do: -# make helper functions: -# 1: retrieve a model instance by id -# 2: handle the creation of new instances of a model from a dictionary, return expected response def validate_task(task_id): try: @@ -25,16 +21,20 @@ def validate_task(task_id): return task - -@tasks_bp.post("") -def create_task(): - request_body = request.get_json() +def create_task_from_dict(request_body): title = request_body["title"] description = request_body["description"] completed_at = request_body.get("completed_at") new_task = Task(title=title, description=description, completed_at=completed_at) + return new_task + +@tasks_bp.post("") +def create_task(): + request_body = request.get_json() + new_task = create_task_from_dict(request_body) + db.session.add(new_task) db.session.commit() From cb14871c477a79fb4b768230b5fa0aa233fc5255 Mon Sep 17 00:00:00 2001 From: Tsz Tin Vivian Soo Date: Sat, 1 Nov 2025 02:15:53 -0400 Subject: [PATCH 07/23] Refactor Task model methods for improved clarity and add from_dict method for task creation --- app/models/task.py | 17 +++++++++++++++-- app/routes/task_routes.py | 17 ++++------------- tests/test_wave_01.py | 34 +++++++++++++++++----------------- 3 files changed, 36 insertions(+), 32 deletions(-) diff --git a/app/models/task.py b/app/models/task.py index 50d88558d..a1276ce4b 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -10,10 +10,23 @@ class Task(db.Model): description: Mapped[str] completed_at: Mapped[Optional[datetime]] = mapped_column(DateTime(timezone=True), nullable=True) - def return_dict(self): + # for the response when we get or create a task + def to_dict(self): return { "id": self.id, "title": self.title, "description": self.description, - "completed_at": self.completed_at if self.completed_at else None + "is_complete": self.completed_at is not None } + + # for creating a Task from a dictionary from a request body + @classmethod + def from_dict(cls, task_dict): + is_complete = task_dict.get("is_complete", False) + completed_at = datetime.now(datetime) if is_complete else None + + return cls( + title=task_dict["title"], + description=task_dict["description"], + completed_at=completed_at + ) \ No newline at end of file diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index 634647fe6..48cd636d6 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -21,24 +21,15 @@ def validate_task(task_id): return task -def create_task_from_dict(request_body): - title = request_body["title"] - description = request_body["description"] - completed_at = request_body.get("completed_at") - - new_task = Task(title=title, description=description, completed_at=completed_at) - - return new_task - @tasks_bp.post("") def create_task(): request_body = request.get_json() - new_task = create_task_from_dict(request_body) + new_task = Task.from_dict(request_body) db.session.add(new_task) db.session.commit() - response = new_task.return_dict() + response = new_task.to_dict() return response, 201 @@ -48,7 +39,7 @@ def get_all_tasks(): tasks = db.session.scalars(query) - tasks_response = [task.return_dict() for task in tasks] + tasks_response = [task.to_dict() for task in tasks] return tasks_response @@ -56,7 +47,7 @@ def get_all_tasks(): def get_task(task_id): task = validate_task(task_id) - tasks_response = task.return_dict() + tasks_response = task.to_dict() return tasks_response diff --git a/tests/test_wave_01.py b/tests/test_wave_01.py index fac95a0a3..bb0eae126 100644 --- a/tests/test_wave_01.py +++ b/tests/test_wave_01.py @@ -2,7 +2,7 @@ from app.db import db import pytest -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_task_to_dict(): #Arrange new_task = Task(id = 1, title="Make My Bed", @@ -19,7 +19,7 @@ def test_task_to_dict(): assert task_dict["description"] == "Start the day off right!" assert task_dict["is_complete"] == False -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_task_to_dict_missing_id(): #Arrange new_task = Task(title="Make My Bed", @@ -36,7 +36,7 @@ def test_task_to_dict_missing_id(): assert task_dict["description"] == "Start the day off right!" assert task_dict["is_complete"] == False -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_task_to_dict_missing_title(): #Arrange new_task = Task(id = 1, @@ -53,7 +53,7 @@ def test_task_to_dict_missing_title(): assert task_dict["description"] == "Start the day off right!" assert task_dict["is_complete"] == False -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_task_from_dict(): #Arrange task_dict = { @@ -70,7 +70,7 @@ def test_task_from_dict(): assert task_obj.description == "Start the day off right!" assert task_obj.completed_at is None -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_task_from_dict_no_title(): #Arrange task_dict = { @@ -82,7 +82,7 @@ def test_task_from_dict_no_title(): with pytest.raises(KeyError, match = 'title'): Task.from_dict(task_dict) -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_task_from_dict_no_description(): #Arrange task_dict = { @@ -94,7 +94,7 @@ def test_task_from_dict_no_description(): with pytest.raises(KeyError, match = 'description'): Task.from_dict(task_dict) -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_get_tasks_no_saved_tasks(client): # Act response = client.get("/tasks") @@ -105,7 +105,7 @@ def test_get_tasks_no_saved_tasks(client): assert response_body == [] -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_get_tasks_one_saved_tasks(client, one_task): # Act response = client.get("/tasks") @@ -124,7 +124,7 @@ def test_get_tasks_one_saved_tasks(client, one_task): ] -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_get_task(client, one_task): # Act response = client.get("/tasks/1") @@ -140,7 +140,7 @@ def test_get_task(client, one_task): } -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_get_task_not_found(client): # Act response = client.get("/tasks/1") @@ -155,7 +155,7 @@ def test_get_task_not_found(client): # ***************************************************************** -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_create_task(client): # Act response = client.post("/tasks", json={ @@ -181,7 +181,7 @@ def test_create_task(client): assert new_task.description == "Test Description" assert new_task.completed_at == None -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_update_task(client, one_task): # Act response = client.put("/tasks/1", json={ @@ -201,7 +201,7 @@ def test_update_task(client, one_task): -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_update_task_not_found(client): # Act response = client.put("/tasks/1", json={ @@ -219,7 +219,7 @@ def test_update_task_not_found(client): # ***************************************************************** -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_delete_task(client, one_task): # Act response = client.delete("/tasks/1") @@ -230,7 +230,7 @@ def test_delete_task(client, one_task): query = db.select(Task).where(Task.id == 1) assert db.session.scalar(query) == None -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_delete_task_not_found(client): # Act response = client.delete("/tasks/1") @@ -247,7 +247,7 @@ def test_delete_task_not_found(client): assert db.session.scalars(db.select(Task)).all() == [] -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_create_task_must_contain_title(client): # Act response = client.post("/tasks", json={ @@ -264,7 +264,7 @@ def test_create_task_must_contain_title(client): assert db.session.scalars(db.select(Task)).all() == [] -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_create_task_must_contain_description(client): # Act response = client.post("/tasks", json={ From e80aa931c2b4502cda17f5725d7fafe6b0cd092f Mon Sep 17 00:00:00 2001 From: Tsz Tin Vivian Soo Date: Sat, 1 Nov 2025 03:32:17 -0400 Subject: [PATCH 08/23] Refactor Task model to update completed_at column type and add comments from_dict and to_dict methods for self-reminders --- app/models/task.py | 35 ++++++++++------- ...cb5134_add_from_dict_and_to_dict_method.py | 38 +++++++++++++++++++ 2 files changed, 60 insertions(+), 13 deletions(-) create mode 100644 migrations/versions/f266d7cb5134_add_from_dict_and_to_dict_method.py diff --git a/app/models/task.py b/app/models/task.py index a1276ce4b..383401cc5 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -8,25 +8,34 @@ class Task(db.Model): id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True) title: Mapped[str] description: Mapped[str] - completed_at: Mapped[Optional[datetime]] = mapped_column(DateTime(timezone=True), nullable=True) + completed_at: Mapped[Optional[datetime]] = mapped_column(DateTime, nullable=True) - # for the response when we get or create a task - def to_dict(self): - return { - "id": self.id, - "title": self.title, - "description": self.description, - "is_complete": self.completed_at is not None - } - - # for creating a Task from a dictionary from a request body + # for creating/updating a Task from a dictionary from a request body + # which came in json format + # then converted to a dictionary by request.get_json() + # and here we create a Task object from that dictionary + # so that we can add it to the database + # flow: from request body in json --> from_dict() --> to Task object @classmethod def from_dict(cls, task_dict): is_complete = task_dict.get("is_complete", False) - completed_at = datetime.now(datetime) if is_complete else None + completed_at = datetime.now() if is_complete else None return cls( title=task_dict["title"], description=task_dict["description"], completed_at=completed_at - ) \ No newline at end of file + ) + + # to return a response with the new info including newlyy generated id + # after we get or create a task record in database + # return a dictionary representation of the Task object + # flow: from database --> Task object --> to_dict() --> to json response + def to_dict(self): + return { + "id": self.id, + "title": self.title, + "description": self.description, + "is_complete": self.completed_at is not None + } + \ No newline at end of file diff --git a/migrations/versions/f266d7cb5134_add_from_dict_and_to_dict_method.py b/migrations/versions/f266d7cb5134_add_from_dict_and_to_dict_method.py new file mode 100644 index 000000000..b14887de5 --- /dev/null +++ b/migrations/versions/f266d7cb5134_add_from_dict_and_to_dict_method.py @@ -0,0 +1,38 @@ +"""add from_dict and to_dict method + +Revision ID: f266d7cb5134 +Revises: 077ed6acc8d9 +Create Date: 2025-11-01 03:29:15.796893 + +""" +from alembic import op +import sqlalchemy as sa +from sqlalchemy.dialects import postgresql + +# revision identifiers, used by Alembic. +revision = 'f266d7cb5134' +down_revision = '077ed6acc8d9' +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + with op.batch_alter_table('task', schema=None) as batch_op: + batch_op.alter_column('completed_at', + existing_type=postgresql.TIMESTAMP(timezone=True), + type_=sa.DateTime(), + existing_nullable=True) + + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + with op.batch_alter_table('task', schema=None) as batch_op: + batch_op.alter_column('completed_at', + existing_type=sa.DateTime(), + type_=postgresql.TIMESTAMP(timezone=True), + existing_nullable=True) + + # ### end Alembic commands ### From 789340d379e728774729f95a42cae76fd391a55c Mon Sep 17 00:00:00 2001 From: Tsz Tin Vivian Soo Date: Sun, 2 Nov 2025 00:25:10 -0400 Subject: [PATCH 09/23] Refactor Task model and task_routes to improve method documentation and error handling --- app/models/task.py | 12 ++---------- app/routes/task_routes.py | 11 ++++++++--- tests/test_wave_01.py | 12 +++++++++--- 3 files changed, 19 insertions(+), 16 deletions(-) diff --git a/app/models/task.py b/app/models/task.py index 383401cc5..d2166cd04 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -10,14 +10,9 @@ class Task(db.Model): description: Mapped[str] completed_at: Mapped[Optional[datetime]] = mapped_column(DateTime, nullable=True) - # for creating/updating a Task from a dictionary from a request body - # which came in json format - # then converted to a dictionary by request.get_json() - # and here we create a Task object from that dictionary - # so that we can add it to the database - # flow: from request body in json --> from_dict() --> to Task object @classmethod def from_dict(cls, task_dict): + """Create a Task instance from a dictionary.""" is_complete = task_dict.get("is_complete", False) completed_at = datetime.now() if is_complete else None @@ -27,11 +22,8 @@ def from_dict(cls, task_dict): completed_at=completed_at ) - # to return a response with the new info including newlyy generated id - # after we get or create a task record in database - # return a dictionary representation of the Task object - # flow: from database --> Task object --> to_dict() --> to json response def to_dict(self): + """Return a dictionary representation of the Task.""" return { "id": self.id, "title": self.title, diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index 48cd636d6..26a76cc21 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -5,13 +5,13 @@ def validate_task(task_id): + """Retrieves a task by ID or aborts with 400/404.""" try: task_id = int(task_id) except: response = {"message": f"Task {task_id} invalid"} - abort(make_response(response, 400)) - + query = db.select(Task).where(Task.id == task_id) task = db.session.scalar(query) @@ -23,8 +23,13 @@ def validate_task(task_id): @tasks_bp.post("") def create_task(): + """Create a task with the data from the request body.""" request_body = request.get_json() - new_task = Task.from_dict(request_body) + try: + new_task = Task.from_dict(request_body) + except: + response = {"details": "Invalid data"} + abort(make_response(response, 400)) db.session.add(new_task) db.session.commit() diff --git a/tests/test_wave_01.py b/tests/test_wave_01.py index bb0eae126..f5a72a550 100644 --- a/tests/test_wave_01.py +++ b/tests/test_wave_01.py @@ -148,8 +148,10 @@ def test_get_task_not_found(client): # Assert assert response.status_code == 404 + assert "message" in response_body + assert response_body == {"message": "Task 1 not found"} - raise Exception("Complete test with assertion about response body") + # raise Exception("Complete test with assertion about response body") # ***************************************************************** # **Complete test with assertion about response body*************** # ***************************************************************** @@ -212,8 +214,10 @@ def test_update_task_not_found(client): # Assert assert response.status_code == 404 + assert "message" in response_body + assert response_body == {"message": "Task 1 not found"} - raise Exception("Complete test with assertion about response body") + # raise Exception("Complete test with assertion about response body") # ***************************************************************** # **Complete test with assertion about response body*************** # ***************************************************************** @@ -238,8 +242,10 @@ def test_delete_task_not_found(client): # Assert assert response.status_code == 404 + assert "message" in response_body + assert response_body == {"message": "Task 1 not found"} - raise Exception("Complete test with assertion about response body") + # raise Exception("Complete test with assertion about response body") # ***************************************************************** # **Complete test with assertion about response body*************** # ***************************************************************** From 7f0f333bdd056aa28d278cf8f4f5d03773431133 Mon Sep 17 00:00:00 2001 From: Tsz Tin Vivian Soo Date: Sun, 2 Nov 2025 01:14:32 -0400 Subject: [PATCH 10/23] Add sorting functionality to task retrieval and update tests to remove skip markers --- app/routes/task_routes.py | 8 +++++++- tests/test_wave_02.py | 4 ++-- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index 26a76cc21..973920d5f 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -40,7 +40,13 @@ def create_task(): @tasks_bp.get("") def get_all_tasks(): - query = db.select(Task).order_by(Task.id) + query = db.select(Task) + + sort_param = request.args.get("sort") + if sort_param == "asc": + query = query.order_by(Task.title.asc()) + elif sort_param == "desc": + query = query.order_by(Task.title.desc()) tasks = db.session.scalars(query) diff --git a/tests/test_wave_02.py b/tests/test_wave_02.py index a087e0909..651e3aebd 100644 --- a/tests/test_wave_02.py +++ b/tests/test_wave_02.py @@ -1,7 +1,7 @@ import pytest -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_get_tasks_sorted_asc(client, three_tasks): # Act response = client.get("/tasks?sort=asc") @@ -29,7 +29,7 @@ def test_get_tasks_sorted_asc(client, three_tasks): ] -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_get_tasks_sorted_desc(client, three_tasks): # Act response = client.get("/tasks?sort=desc") From a8dcc4fe7b22c8cad1cd781601ec1c924ffb9dd5 Mon Sep 17 00:00:00 2001 From: Tsz Tin Vivian Soo Date: Mon, 3 Nov 2025 19:05:38 -0500 Subject: [PATCH 11/23] Implement task completion and incompletion endpoints with corresponding database updates --- app/routes/task_routes.py | 17 +++++++++++++++++ tests/test_wave_03.py | 8 ++++---- 2 files changed, 21 insertions(+), 4 deletions(-) diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index 973920d5f..89fc703a3 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -1,6 +1,7 @@ from flask import Blueprint, abort, make_response, request, Response from app.models.task import Task from ..db import db +from datetime import datetime tasks_bp = Blueprint("tasks_bp", __name__, url_prefix="/tasks") @@ -76,6 +77,22 @@ def update_task(task_id): return Response(status=204, mimetype="application/json") +@tasks_bp.patch("//mark_complete") +def mark_task_complete(task_id): + task = validate_task(task_id) + task.completed_at = datetime.now() + db.session.commit() + + return Response(status=204, mimetype="application/json") + +@tasks_bp.patch("//mark_incomplete") +def mark_task_incomplete(task_id): + task = validate_task(task_id) + task.completed_at = None + db.session.commit() + + return Response(status=204, mimetype="application/json") + @tasks_bp.delete("/") def delete_task(task_id): task = validate_task(task_id) diff --git a/tests/test_wave_03.py b/tests/test_wave_03.py index d7d441695..188894d48 100644 --- a/tests/test_wave_03.py +++ b/tests/test_wave_03.py @@ -6,7 +6,7 @@ import pytest -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_mark_complete_on_incomplete_task(client, one_task): # Arrange """ @@ -34,7 +34,7 @@ def test_mark_complete_on_incomplete_task(client, one_task): assert db.session.scalar(query).completed_at -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_mark_incomplete_on_complete_task(client, completed_task): # Act response = client.patch("/tasks/1/mark_incomplete") @@ -46,7 +46,7 @@ def test_mark_incomplete_on_complete_task(client, completed_task): assert db.session.scalar(query).completed_at == None -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_mark_complete_on_completed_task(client, completed_task): # Arrange """ @@ -74,7 +74,7 @@ def test_mark_complete_on_completed_task(client, completed_task): query = db.select(Task).where(Task.id == 1) assert db.session.scalar(query).completed_at -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_mark_incomplete_on_incomplete_task(client, one_task): # Act response = client.patch("/tasks/1/mark_incomplete") From 586d1d099ae57ec8ed4f6f5aa65a676dcfb50638 Mon Sep 17 00:00:00 2001 From: Tsz Tin Vivian Soo Date: Mon, 3 Nov 2025 19:41:57 -0500 Subject: [PATCH 12/23] Refactor tests for missing task scenarios to include response body assertions --- tests/test_wave_03.py | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/tests/test_wave_03.py b/tests/test_wave_03.py index 188894d48..5e915c1c1 100644 --- a/tests/test_wave_03.py +++ b/tests/test_wave_03.py @@ -86,7 +86,7 @@ def test_mark_incomplete_on_incomplete_task(client, one_task): assert db.session.scalar(query).completed_at == None -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_mark_complete_missing_task(client): # Act response = client.patch("/tasks/1/mark_complete") @@ -94,14 +94,15 @@ def test_mark_complete_missing_task(client): # Assert assert response.status_code == 404 - - raise Exception("Complete test with assertion about response body") + assert "message" in response_body + assert response_body == {"message": "Task 1 not found"} + # raise Exception("Complete test with assertion about response body") # ***************************************************************** # **Complete test with assertion about response body*************** # ***************************************************************** -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_mark_incomplete_missing_task(client): # Act response = client.patch("/tasks/1/mark_incomplete") @@ -109,8 +110,10 @@ def test_mark_incomplete_missing_task(client): # Assert assert response.status_code == 404 + assert "message" in response_body + assert response_body == {"message": "Task 1 not found"} - raise Exception("Complete test with assertion about response body") + # raise Exception("Complete test with assertion about response body") # ***************************************************************** # **Complete test with assertion about response body*************** # ***************************************************************** From e8dabb85956fc61e96bfba93895a06bf2fdc7f89 Mon Sep 17 00:00:00 2001 From: Tsz Tin Vivian Soo Date: Tue, 4 Nov 2025 03:33:57 -0500 Subject: [PATCH 13/23] Add Slack notification for task completion --- app/routes/task_routes.py | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index 89fc703a3..c9e0eeccf 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -2,6 +2,13 @@ from app.models.task import Task from ..db import db from datetime import datetime +import requests +import os + +path = "https://slack.com/api/chat.postMessage" +token = os.environ.get("SLACK_API_TOKEN") + + tasks_bp = Blueprint("tasks_bp", __name__, url_prefix="/tasks") @@ -83,6 +90,15 @@ def mark_task_complete(task_id): task.completed_at = datetime.now() db.session.commit() + query_params = { + "channel": "#test-slack-api", + "text": f"Someone just completed the task {task.title}" + } + + headers = {"Authorization": f"Bearer {token}"} + + requests.post(path, json=query_params, headers=headers) + return Response(status=204, mimetype="application/json") @tasks_bp.patch("//mark_incomplete") From 43b401bc684e3c92fc6f017e831ec56421a1d6eb Mon Sep 17 00:00:00 2001 From: Tsz Tin Vivian Soo Date: Tue, 4 Nov 2025 12:11:43 -0500 Subject: [PATCH 14/23] Refactor task routes to use centralized model validation and improve code consistency --- app/routes/route_utilities.py | 19 ++++++++++++++++ app/routes/task_routes.py | 43 ++++++++++++----------------------- 2 files changed, 33 insertions(+), 29 deletions(-) create mode 100644 app/routes/route_utilities.py diff --git a/app/routes/route_utilities.py b/app/routes/route_utilities.py new file mode 100644 index 000000000..353fff912 --- /dev/null +++ b/app/routes/route_utilities.py @@ -0,0 +1,19 @@ +from flask import abort, make_response +from ..db import db + +def validate_model(cls, model_id): + """Retrieves a model instance by ID or aborts with 400/404.""" + try: + model_id = int(model_id) + except: + response = {"message": f"{cls.__name__} {model_id} invalid"} + abort(make_response(response, 400)) + + query = db.select(cls).where(cls.id == model_id) + task = db.session.scalar(query) + + if not task: + response = {"message": f"{cls.__name__} {model_id} not found"} + abort(make_response(response, 404)) + + return task \ No newline at end of file diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index c9e0eeccf..99d077304 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -4,32 +4,17 @@ from datetime import datetime import requests import os +from .route_utilities import validate_model path = "https://slack.com/api/chat.postMessage" token = os.environ.get("SLACK_API_TOKEN") -tasks_bp = Blueprint("tasks_bp", __name__, url_prefix="/tasks") +bp = Blueprint("tasks_bp", __name__, url_prefix="/tasks") -def validate_task(task_id): - """Retrieves a task by ID or aborts with 400/404.""" - try: - task_id = int(task_id) - except: - response = {"message": f"Task {task_id} invalid"} - abort(make_response(response, 400)) - - query = db.select(Task).where(Task.id == task_id) - task = db.session.scalar(query) - - if not task: - response = {"message": f"Task {task_id} not found"} - abort(make_response(response, 404)) - - return task -@tasks_bp.post("") +@bp.post("") def create_task(): """Create a task with the data from the request body.""" request_body = request.get_json() @@ -46,7 +31,7 @@ def create_task(): return response, 201 -@tasks_bp.get("") +@bp.get("") def get_all_tasks(): query = db.select(Task) @@ -62,17 +47,17 @@ def get_all_tasks(): return tasks_response -@tasks_bp.get("/") +@bp.get("/") def get_task(task_id): - task = validate_task(task_id) + task = validate_model(Task, task_id) tasks_response = task.to_dict() return tasks_response -@tasks_bp.put("/") +@bp.put("/") def update_task(task_id): - task = validate_task(task_id) + task = validate_model(Task, task_id) request_body = request.get_json() @@ -84,9 +69,9 @@ def update_task(task_id): return Response(status=204, mimetype="application/json") -@tasks_bp.patch("//mark_complete") +@bp.patch("//mark_complete") def mark_task_complete(task_id): - task = validate_task(task_id) + task = validate_model(Task, task_id) task.completed_at = datetime.now() db.session.commit() @@ -101,17 +86,17 @@ def mark_task_complete(task_id): return Response(status=204, mimetype="application/json") -@tasks_bp.patch("//mark_incomplete") +@bp.patch("//mark_incomplete") def mark_task_incomplete(task_id): - task = validate_task(task_id) + task = validate_model(Task, task_id) task.completed_at = None db.session.commit() return Response(status=204, mimetype="application/json") -@tasks_bp.delete("/") +@bp.delete("/") def delete_task(task_id): - task = validate_task(task_id) + task = validate_model(Task, task_id) db.session.delete(task) db.session.commit() From 5fb92da32367ca3e40ee21c9427e4d6ed5e29435 Mon Sep 17 00:00:00 2001 From: Tsz Tin Vivian Soo Date: Tue, 4 Nov 2025 21:38:10 -0500 Subject: [PATCH 15/23] Add goal model and implement CRUD operations for goals --- app/__init__.py | 4 +- app/models/goal.py | 15 ++++++++ app/routes/goal_routes.py | 37 ++++++++++++++++++- app/routes/route_utilities.py | 17 ++++++++- .../versions/8c0bdc46c172_adds_goal_model.py | 32 ++++++++++++++++ 5 files changed, 102 insertions(+), 3 deletions(-) create mode 100644 migrations/versions/8c0bdc46c172_adds_goal_model.py diff --git a/app/__init__.py b/app/__init__.py index d43f651f0..68730cb49 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,7 +1,8 @@ from flask import Flask from .db import db, migrate from .models import task, goal -from .routes.task_routes import tasks_bp +from .routes.task_routes import bp as tasks_bp +from .routes.goal_routes import bp as goals_bp import os def create_app(config=None): @@ -20,5 +21,6 @@ def create_app(config=None): # Register Blueprints here app.register_blueprint(tasks_bp) + app.register_blueprint(goals_bp) return app diff --git a/app/models/goal.py b/app/models/goal.py index 44282656b..2a7318260 100644 --- a/app/models/goal.py +++ b/app/models/goal.py @@ -3,3 +3,18 @@ class Goal(db.Model): id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True) + title: Mapped[str] + + @classmethod + def from_dict(cls, goal_dict): + """Create a Goal instance from a dictionary.""" + return cls( + title=goal_dict["title"] + ) + + def to_dict(self): + """Return a dictionary representation of the Goal.""" + return { + "id": self.id, + "title": self.title + } \ No newline at end of file diff --git a/app/routes/goal_routes.py b/app/routes/goal_routes.py index 3aae38d49..629eda624 100644 --- a/app/routes/goal_routes.py +++ b/app/routes/goal_routes.py @@ -1 +1,36 @@ -from flask import Blueprint \ No newline at end of file +from flask import Blueprint +from .route_utilities import validate_model, create_model +from app.models.goal import Goal +from ..db import db +from flask import request, make_response, abort, Response +bp = Blueprint("goals_bp", __name__, url_prefix="/goals") + +@bp.post("") +def create_goal(): + request_body = request.get_json() + return create_model(Goal, request_body) + +@bp.get("") +def get_all_goals(): + query = db.select(Goal).order_by(Goal.id) + + goals = db.session.scalars(query) + + goals_response = [goal.to_dict() for goal in goals] + + return goals_response + + +@bp.put("/") +def update_goal(goal_id): + goal = validate_model(Goal, goal_id) + + request_body = request.get_json() + + goal.title = request_body["title"] + + db.session.commit() + + return Response(status=204, mimetype="application/json") + + diff --git a/app/routes/route_utilities.py b/app/routes/route_utilities.py index 353fff912..b0242076a 100644 --- a/app/routes/route_utilities.py +++ b/app/routes/route_utilities.py @@ -16,4 +16,19 @@ def validate_model(cls, model_id): response = {"message": f"{cls.__name__} {model_id} not found"} abort(make_response(response, 404)) - return task \ No newline at end of file + return task + + +def create_model(cls, model_data): + try: + new_model = cls.from_dict(model_data) + except KeyError: + response = {"details": "Invalid data"} + abort(make_response(response, 400)) + + db.session.add(new_model) + db.session.commit() + + response = new_model.to_dict() + + return response, 201 \ No newline at end of file diff --git a/migrations/versions/8c0bdc46c172_adds_goal_model.py b/migrations/versions/8c0bdc46c172_adds_goal_model.py new file mode 100644 index 000000000..65dff06f6 --- /dev/null +++ b/migrations/versions/8c0bdc46c172_adds_goal_model.py @@ -0,0 +1,32 @@ +"""Adds goal model + +Revision ID: 8c0bdc46c172 +Revises: f266d7cb5134 +Create Date: 2025-11-04 19:58:14.226967 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '8c0bdc46c172' +down_revision = 'f266d7cb5134' +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + with op.batch_alter_table('goal', schema=None) as batch_op: + batch_op.add_column(sa.Column('title', sa.String(), nullable=False)) + + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + with op.batch_alter_table('goal', schema=None) as batch_op: + batch_op.drop_column('title') + + # ### end Alembic commands ### From 1518918b5f81764798a5f4598cf28ae107af50bb Mon Sep 17 00:00:00 2001 From: Tsz Tin Vivian Soo Date: Tue, 4 Nov 2025 23:00:26 -0500 Subject: [PATCH 16/23] Refactor goal and task routes to improve response handling and add goal deletion functionality --- app/routes/goal_routes.py | 20 ++++++++- app/routes/route_utilities.py | 6 +-- app/routes/task_routes.py | 8 ++-- tests/test_wave_05.py | 81 ++++++++++++++++++++++++++--------- 4 files changed, 85 insertions(+), 30 deletions(-) diff --git a/app/routes/goal_routes.py b/app/routes/goal_routes.py index 629eda624..57657fda1 100644 --- a/app/routes/goal_routes.py +++ b/app/routes/goal_routes.py @@ -16,10 +16,18 @@ def get_all_goals(): goals = db.session.scalars(query) - goals_response = [goal.to_dict() for goal in goals] + response = [goal.to_dict() for goal in goals] - return goals_response + return response +@bp.get("/") +def get_goal(goal_id): + goal = validate_model(Goal, goal_id) + + response = goal.to_dict() + + return response + @bp.put("/") def update_goal(goal_id): @@ -33,4 +41,12 @@ def update_goal(goal_id): return Response(status=204, mimetype="application/json") +@bp.delete("/") +def delete_goal(goal_id): + goal = validate_model(Goal, goal_id) + + db.session.delete(goal) + db.session.commit() + + return Response(status=204, mimetype="application/json") diff --git a/app/routes/route_utilities.py b/app/routes/route_utilities.py index b0242076a..39c76e18a 100644 --- a/app/routes/route_utilities.py +++ b/app/routes/route_utilities.py @@ -10,13 +10,13 @@ def validate_model(cls, model_id): abort(make_response(response, 400)) query = db.select(cls).where(cls.id == model_id) - task = db.session.scalar(query) + model = db.session.scalar(query) - if not task: + if not model: response = {"message": f"{cls.__name__} {model_id} not found"} abort(make_response(response, 404)) - return task + return model def create_model(cls, model_data): diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index 99d077304..f67d8c75b 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -43,17 +43,17 @@ def get_all_tasks(): tasks = db.session.scalars(query) - tasks_response = [task.to_dict() for task in tasks] + response = [task.to_dict() for task in tasks] - return tasks_response + return response @bp.get("/") def get_task(task_id): task = validate_model(Task, task_id) - tasks_response = task.to_dict() + response = task.to_dict() - return tasks_response + return response @bp.put("/") def update_task(task_id): diff --git a/tests/test_wave_05.py b/tests/test_wave_05.py index b7cc330ae..00ddfbf86 100644 --- a/tests/test_wave_05.py +++ b/tests/test_wave_05.py @@ -1,7 +1,7 @@ from app.models.goal import Goal import pytest -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_goal_to_dict(): #Arrange new_goal = Goal(id=1, title="Seize the Day!") @@ -13,7 +13,7 @@ def test_goal_to_dict(): assert goal_dict["id"] == 1 assert goal_dict["title"] == "Seize the Day!" -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_goal_to_dict_no_id(): #Arrange new_goal = Goal(title="Seize the Day!") @@ -25,7 +25,7 @@ def test_goal_to_dict_no_id(): assert goal_dict["id"] is None assert goal_dict["title"] == "Seize the Day!" -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_goal_to_dict_no_title(): #Arrange new_goal = Goal(id=1) @@ -39,7 +39,7 @@ def test_goal_to_dict_no_title(): -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_goal_from_dict(): #Arrange goal_dict = { @@ -52,7 +52,7 @@ def test_goal_from_dict(): #Assert assert goal_obj.title == "Seize the Day!" -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_goal_from_dict_no_title(): #Arrange goal_dict = { @@ -63,7 +63,7 @@ def test_goal_from_dict_no_title(): Goal.from_dict(goal_dict) -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_get_goals_no_saved_goals(client): # Act response = client.get("/goals") @@ -74,7 +74,7 @@ def test_get_goals_no_saved_goals(client): assert response_body == [] -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_get_goals_one_saved_goal(client, one_goal): # Act response = client.get("/goals") @@ -91,7 +91,7 @@ def test_get_goals_one_saved_goal(client, one_goal): ] -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_get_goal(client, one_goal): # Act response = client.get("/goals/1") @@ -105,14 +105,19 @@ def test_get_goal(client, one_goal): } -@pytest.mark.skip(reason="test to be completed by student") +# @pytest.mark.skip(reason="test to be completed by student") def test_get_goal_not_found(client): pass # Act response = client.get("/goals/1") response_body = response.get_json() - raise Exception("Complete test") + assert response.status_code == 404 + assert response_body == { + "message": "Goal 1 not found" + } + + # raise Exception("Complete test") # Assert # ---- Complete Test ---- # assertion 1 goes here @@ -120,7 +125,7 @@ def test_get_goal_not_found(client): # ---- Complete Test ---- -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_create_goal(client): # Act response = client.post("/goals", json={ @@ -129,16 +134,26 @@ def test_create_goal(client): response_body = response.get_json() # Assert - assert response.status_code == 201 + assert response.status_code == 204 assert response_body == { "id": 1, "title": "My New Goal" } -@pytest.mark.skip(reason="test to be completed by student") +# @pytest.mark.skip(reason="test to be completed by student") def test_update_goal(client, one_goal): - raise Exception("Complete test") + + test_data = { + "title": "Updated Goal Title" + } + + response = client.put("/goals/1", json=test_data) + + assert response.status_code == 204 + assert response.content_length == None + + # raise Exception("Complete test") # Act # ---- Complete Act Here ---- @@ -150,9 +165,19 @@ def test_update_goal(client, one_goal): # ---- Complete Assertions Here ---- -@pytest.mark.skip(reason="test to be completed by student") +# @pytest.mark.skip(reason="test to be completed by student") def test_update_goal_not_found(client): - raise Exception("Complete test") + + test_data = { + "title": "Updated Goal TTitle" + } + + response = client.put("/goals/1", json=test_data) + assert response.status_code == 404 + assert response.get_json() =={ + "message": "Goal 1 not found" + } + # raise Exception("Complete test") # Act # ---- Complete Act Here ---- @@ -163,7 +188,7 @@ def test_update_goal_not_found(client): # ---- Complete Assertions Here ---- -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_delete_goal(client, one_goal): # Act response = client.delete("/goals/1") @@ -178,15 +203,29 @@ def test_delete_goal(client, one_goal): response_body = response.get_json() assert "message" in response_body - raise Exception("Complete test with assertion about response body") + assert response_body == { + "message": "Goal 1 not found" + } + + # raise Exception("Complete test with assertion about response body") # ***************************************************************** # **Complete test with assertion about response body*************** # ***************************************************************** -@pytest.mark.skip(reason="test to be completed by student") +# @pytest.mark.skip(reason="test to be completed by student") def test_delete_goal_not_found(client): - raise Exception("Complete test") + response = client.delete("/goals/1") + + assert response.status_code == 404 + response_body = response.get_json() + assert response_body == { + "message": "Goal 1 not found" + } + + + + # raise Exception("Complete test") # Act # ---- Complete Act Here ---- @@ -198,7 +237,7 @@ def test_delete_goal_not_found(client): # ---- Complete Assertions Here ---- -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_create_goal_missing_title(client): # Act response = client.post("/goals", json={}) From 7def879edd4268b5657eda57b692411e39cfccb6 Mon Sep 17 00:00:00 2001 From: Tsz Tin Vivian Soo Date: Wed, 5 Nov 2025 00:05:39 -0500 Subject: [PATCH 17/23] Implement goal-task relationship in models and add task creation endpoint for goals --- app/models/goal.py | 8 ++++- app/models/task.py | 22 ++++++++---- app/routes/goal_routes.py | 27 +++++++++++++++ ...9e9_update_task_and_goal_model_to_form_.py | 34 +++++++++++++++++++ 4 files changed, 84 insertions(+), 7 deletions(-) create mode 100644 migrations/versions/93f8a8cfc9e9_update_task_and_goal_model_to_form_.py diff --git a/app/models/goal.py b/app/models/goal.py index 2a7318260..8457f95ee 100644 --- a/app/models/goal.py +++ b/app/models/goal.py @@ -1,9 +1,15 @@ -from sqlalchemy.orm import Mapped, mapped_column +from sqlalchemy.orm import Mapped, mapped_column, relationship from ..db import db +from typing import TYPE_CHECKING +if TYPE_CHECKING: + from .task import Task + + class Goal(db.Model): id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True) title: Mapped[str] + tasks: Mapped[list["Task"]] = relationship(back_populates="goal") @classmethod def from_dict(cls, goal_dict): diff --git a/app/models/task.py b/app/models/task.py index d2166cd04..5b223e848 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -1,33 +1,43 @@ -from sqlalchemy.orm import Mapped, mapped_column +from sqlalchemy.orm import Mapped, mapped_column, relationship +from sqlalchemy import ForeignKey, DateTime from ..db import db from datetime import datetime -from sqlalchemy import DateTime -from typing import Optional +from typing import Optional, TYPE_CHECKING +if TYPE_CHECKING: + from .goal import Goal + class Task(db.Model): id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True) title: Mapped[str] description: Mapped[str] completed_at: Mapped[Optional[datetime]] = mapped_column(DateTime, nullable=True) + goal_id: Mapped[Optional[int]] = mapped_column(ForeignKey("goal.id")) + goal: Mapped[Optional["Goal"]] = relationship(back_populates="tasks") @classmethod def from_dict(cls, task_dict): """Create a Task instance from a dictionary.""" + goal_id = task_dict.get("goal_id") is_complete = task_dict.get("is_complete", False) completed_at = datetime.now() if is_complete else None return cls( title=task_dict["title"], description=task_dict["description"], - completed_at=completed_at + completed_at=completed_at, + goal_id=goal_id ) def to_dict(self): """Return a dictionary representation of the Task.""" - return { + task_dict = { "id": self.id, "title": self.title, "description": self.description, "is_complete": self.completed_at is not None } - \ No newline at end of file + if self.goal: + task_dict["goal_id"] = self.goal.id + + return task_dict diff --git a/app/routes/goal_routes.py b/app/routes/goal_routes.py index 57657fda1..467c4bb15 100644 --- a/app/routes/goal_routes.py +++ b/app/routes/goal_routes.py @@ -1,6 +1,7 @@ from flask import Blueprint from .route_utilities import validate_model, create_model from app.models.goal import Goal +from app.models.task import Task from ..db import db from flask import request, make_response, abort, Response bp = Blueprint("goals_bp", __name__, url_prefix="/goals") @@ -50,3 +51,29 @@ def delete_goal(goal_id): return Response(status=204, mimetype="application/json") +@bp.post("//tasks") +def create_tasks_for_goal(goal_id): + goal = validate_model(Goal, goal_id) + + # retrieve python dictionary from request body + request_body = request.get_json() + + # get list of task ids from dictionary + task_ids = request_body.get("task_ids", []) + + # associate each task with the goal + for task_id in task_ids: + task = validate_model(Task, task_id) + task.goal = goal + task.goal_id = goal.id + + # commit the changes to the database + db.session.commit() + + + response = { + "id": goal.id, + "task_ids": task_ids + } + + return response, 200 \ No newline at end of file diff --git a/migrations/versions/93f8a8cfc9e9_update_task_and_goal_model_to_form_.py b/migrations/versions/93f8a8cfc9e9_update_task_and_goal_model_to_form_.py new file mode 100644 index 000000000..64a021eb8 --- /dev/null +++ b/migrations/versions/93f8a8cfc9e9_update_task_and_goal_model_to_form_.py @@ -0,0 +1,34 @@ +"""Update task and goal model to form relationship + +Revision ID: 93f8a8cfc9e9 +Revises: 8c0bdc46c172 +Create Date: 2025-11-04 23:15:06.719163 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '93f8a8cfc9e9' +down_revision = '8c0bdc46c172' +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + with op.batch_alter_table('task', schema=None) as batch_op: + batch_op.add_column(sa.Column('goal_id', sa.Integer(), nullable=True)) + batch_op.create_foreign_key(None, 'goal', ['goal_id'], ['id']) + + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + with op.batch_alter_table('task', schema=None) as batch_op: + batch_op.drop_constraint(None, type_='foreignkey') + batch_op.drop_column('goal_id') + + # ### end Alembic commands ### From cebf1aaa1ccd83d6debb763444add03d527da519 Mon Sep 17 00:00:00 2001 From: Tsz Tin Vivian Soo Date: Wed, 5 Nov 2025 10:24:50 -0500 Subject: [PATCH 18/23] Fix task association logic in goal routes and update response status in tests --- app/routes/goal_routes.py | 12 +++++++++++- tests/test_wave_05.py | 2 +- tests/test_wave_06.py | 4 ++-- 3 files changed, 14 insertions(+), 4 deletions(-) diff --git a/app/routes/goal_routes.py b/app/routes/goal_routes.py index 467c4bb15..3dc6b95df 100644 --- a/app/routes/goal_routes.py +++ b/app/routes/goal_routes.py @@ -60,12 +60,17 @@ def create_tasks_for_goal(goal_id): # get list of task ids from dictionary task_ids = request_body.get("task_ids", []) + + for task in goal.tasks: + task.goal = None + task.goal_id = None # associate each task with the goal for task_id in task_ids: task = validate_model(Task, task_id) task.goal = goal task.goal_id = goal.id + # commit the changes to the database db.session.commit() @@ -76,4 +81,9 @@ def create_tasks_for_goal(goal_id): "task_ids": task_ids } - return response, 200 \ No newline at end of file + return response, 200 + +@bp.get("/goal_id>/tasks") +def get_tasks_of_one_goal(goal_id): + goal = validate_model(goal_id) + diff --git a/tests/test_wave_05.py b/tests/test_wave_05.py index 00ddfbf86..16038971a 100644 --- a/tests/test_wave_05.py +++ b/tests/test_wave_05.py @@ -134,7 +134,7 @@ def test_create_goal(client): response_body = response.get_json() # Assert - assert response.status_code == 204 + assert response.status_code == 201 assert response_body == { "id": 1, "title": "My New Goal" diff --git a/tests/test_wave_06.py b/tests/test_wave_06.py index 727fce93a..8020274f9 100644 --- a/tests/test_wave_06.py +++ b/tests/test_wave_06.py @@ -3,7 +3,7 @@ import pytest -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_post_task_ids_to_goal(client, one_goal, three_tasks): # Act response = client.post("/goals/1/tasks", json={ @@ -25,7 +25,7 @@ def test_post_task_ids_to_goal(client, one_goal, three_tasks): assert len(db.session.scalar(query).tasks) == 3 -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_post_task_ids_to_goal_overwrites_existing_tasks(client, one_task_belongs_to_one_goal, three_tasks): # Act response = client.post("/goals/1/tasks", json={ From 2a63792e3136d1b60684700e7314f30806d4fa51 Mon Sep 17 00:00:00 2001 From: Tsz Tin Vivian Soo Date: Wed, 5 Nov 2025 13:12:28 -0500 Subject: [PATCH 19/23] Enhance goal and task routes with improved model validation and task retrieval functionality --- app/routes/goal_routes.py | 14 +++++++++++--- app/routes/route_utilities.py | 21 ++++++++++++++++++++- app/routes/task_routes.py | 30 ++++-------------------------- tests/test_wave_06.py | 6 +++--- tests/test_wave_07.py | 10 +++++----- 5 files changed, 43 insertions(+), 38 deletions(-) diff --git a/app/routes/goal_routes.py b/app/routes/goal_routes.py index 3dc6b95df..ce7dc08f0 100644 --- a/app/routes/goal_routes.py +++ b/app/routes/goal_routes.py @@ -1,5 +1,5 @@ from flask import Blueprint -from .route_utilities import validate_model, create_model +from .route_utilities import validate_model, create_model, get_models_with_filters from app.models.goal import Goal from app.models.task import Task from ..db import db @@ -83,7 +83,15 @@ def create_tasks_for_goal(goal_id): return response, 200 -@bp.get("/goal_id>/tasks") +@bp.get("//tasks") def get_tasks_of_one_goal(goal_id): - goal = validate_model(goal_id) + goal = validate_model(Goal, goal_id) + tasks = [task.to_dict() for task in goal.tasks] + + response = { + "id": goal.id, + "title": goal.title, + "tasks": tasks + } + return response, 200 \ No newline at end of file diff --git a/app/routes/route_utilities.py b/app/routes/route_utilities.py index 39c76e18a..2312449ba 100644 --- a/app/routes/route_utilities.py +++ b/app/routes/route_utilities.py @@ -31,4 +31,23 @@ def create_model(cls, model_data): response = new_model.to_dict() - return response, 201 \ No newline at end of file + return response, 201 + +def get_models_with_filters(cls, filters=None, sort_param=None): + """Retrieve all model instances, optionally applying filters.""" + query = db.select(cls) + + if filters: + for attribute, value in filters.items(): + query = query.where(getattr(cls, attribute) == value) + + if sort_param == "asc": + query = query.order_by(cls.title.asc()) + elif sort_param == "desc": + query = query.order_by(cls.title.desc()) + + models = db.session.scalars(query) + + response = [model.to_dict() for model in models] + + return response \ No newline at end of file diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index f67d8c75b..0cdf510d7 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -4,7 +4,7 @@ from datetime import datetime import requests import os -from .route_utilities import validate_model +from .route_utilities import validate_model, create_model, get_models_with_filters path = "https://slack.com/api/chat.postMessage" token = os.environ.get("SLACK_API_TOKEN") @@ -18,34 +18,12 @@ def create_task(): """Create a task with the data from the request body.""" request_body = request.get_json() - try: - new_task = Task.from_dict(request_body) - except: - response = {"details": "Invalid data"} - abort(make_response(response, 400)) - - db.session.add(new_task) - db.session.commit() - - response = new_task.to_dict() - - return response, 201 + return create_model(Task, request_body) @bp.get("") def get_all_tasks(): - query = db.select(Task) - - sort_param = request.args.get("sort") - if sort_param == "asc": - query = query.order_by(Task.title.asc()) - elif sort_param == "desc": - query = query.order_by(Task.title.desc()) - - tasks = db.session.scalars(query) - - response = [task.to_dict() for task in tasks] - - return response + return get_models_with_filters(Task, + sort_param=request.args.get("sort")) @bp.get("/") def get_task(task_id): diff --git a/tests/test_wave_06.py b/tests/test_wave_06.py index 8020274f9..9aa1c8463 100644 --- a/tests/test_wave_06.py +++ b/tests/test_wave_06.py @@ -60,7 +60,7 @@ def test_get_tasks_for_specific_goal_no_goal(client): # ***************************************************************** -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_get_tasks_for_specific_goal_no_tasks(client, one_goal): # Act response = client.get("/goals/1/tasks") @@ -77,7 +77,7 @@ def test_get_tasks_for_specific_goal_no_tasks(client, one_goal): } -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_get_tasks_for_specific_goal(client, one_task_belongs_to_one_goal): # Act response = client.get("/goals/1/tasks") @@ -102,7 +102,7 @@ def test_get_tasks_for_specific_goal(client, one_task_belongs_to_one_goal): } -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_get_task_includes_goal_id(client, one_task_belongs_to_one_goal): response = client.get("/tasks/1") response_body = response.get_json() diff --git a/tests/test_wave_07.py b/tests/test_wave_07.py index 7e7cef55a..617823b5d 100644 --- a/tests/test_wave_07.py +++ b/tests/test_wave_07.py @@ -4,7 +4,7 @@ from app.models.task import Task from app.routes.route_utilities import create_model, validate_model -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_route_utilities_validate_model_with_task(client, three_tasks): #Act task_1 = validate_model(Task, 1) @@ -53,7 +53,7 @@ def test_route_utilities_validate_model_with_task_missing_id(client, three_tasks # ***************************************************************************** -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_route_utilities_validate_model_with_goal(client, one_goal): #Act goal_1 = validate_model(Goal, 1) @@ -84,7 +84,7 @@ def test_route_utilities_validate_model_with_goal_missing_id(client, one_goal): # **Complete test with assertion about status code response body*************** # ***************************************************************************** -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_route_utilities_create_model_with_task(client): #Arrange request_body = { @@ -103,7 +103,7 @@ def test_route_utilities_create_model_with_task(client): assert response[0]["is_complete"] == False assert response[1] == 201 -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_route_utilities_create_model_with_task_missing_title(client): #Arrange request_body = { @@ -120,7 +120,7 @@ def test_route_utilities_create_model_with_task_missing_title(client): assert response.get_json() == {"details": "Invalid data"} -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_route_utilities_create_model_with_goal(client): #Arrange request_body = { From 595b0774acb7fda54cbd7bdfd6ac457c9db0c997 Mon Sep 17 00:00:00 2001 From: Tsz Tin Vivian Soo Date: Wed, 5 Nov 2025 23:42:11 -0500 Subject: [PATCH 20/23] Refactor tests to remove skip markers and add assertions for error responses in task and goal validation --- tests/test_wave_06.py | 7 +++++-- tests/test_wave_07.py | 40 +++++++++++++++++++++++++++++----------- 2 files changed, 34 insertions(+), 13 deletions(-) diff --git a/tests/test_wave_06.py b/tests/test_wave_06.py index 9aa1c8463..5fc31a2f4 100644 --- a/tests/test_wave_06.py +++ b/tests/test_wave_06.py @@ -45,7 +45,7 @@ def test_post_task_ids_to_goal_overwrites_existing_tasks(client, one_task_belong assert len(db.session.scalar(query).tasks) == 2 -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_get_tasks_for_specific_goal_no_goal(client): # Act response = client.get("/goals/1/tasks") @@ -53,8 +53,11 @@ def test_get_tasks_for_specific_goal_no_goal(client): # Assert assert response.status_code == 404 + assert response_body == { + "message": "Goal 1 not found" + } - raise Exception("Complete test with assertion about response body") + # raise Exception("Complete test with assertion about response body") # ***************************************************************** # **Complete test with assertion about response body*************** # ***************************************************************** diff --git a/tests/test_wave_07.py b/tests/test_wave_07.py index 617823b5d..a44e96d74 100644 --- a/tests/test_wave_07.py +++ b/tests/test_wave_07.py @@ -24,7 +24,7 @@ def test_route_utilities_validate_model_with_task(client, three_tasks): assert task_3.title == "Pay my outstanding tickets 😭" -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_route_utilities_validate_model_with_task_invalid_id(client, three_tasks): #Act & Assert # Calling `validate_model` without being invoked by a route will @@ -35,19 +35,25 @@ def test_route_utilities_validate_model_with_task_invalid_id(client, three_tasks # Test that the correct status code and response message are returned response = e.value.get_response() assert response.status_code == 400 + assert response.get_json() == {"message": "Task One invalid"} + - raise Exception("Complete test with an assertion about the response body") + # raise Exception("Complete test with an assertion about the response body") # ***************************************************************************** # ** Complete test with an assertion about the response body **************** # ***************************************************************************** -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_route_utilities_validate_model_with_task_missing_id(client, three_tasks): #Act & Assert with pytest.raises(HTTPException) as e: result_task = validate_model(Task, 4) + + response = e.value.get_response() + assert response.status_code == 404 + assert response.get_json() == {"message": "Task 4 not found"} - raise Exception("Complete test with assertion status code and response body") + # raise Exception("Complete test with assertion status code and response body") # ***************************************************************************** # **Complete test with assertion about status code response body*************** # ***************************************************************************** @@ -62,24 +68,32 @@ def test_route_utilities_validate_model_with_goal(client, one_goal): assert goal_1.id == 1 assert goal_1.title == "Build a habit of going outside daily" -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_route_utilities_validate_model_with_goal_invalid_id(client, one_goal): #Act & Assert with pytest.raises(HTTPException) as e: result_task = validate_model(Goal, "One") - raise Exception("Complete test with assertion status code and response body") + response = e.value.get_response() + assert response.status_code == 400 + assert response.get_json() == {"message": "Goal One invalid"} + + # raise Exception("Complete test with assertion status code and response body") # ***************************************************************************** # **Complete test with assertion about status code response body*************** # ***************************************************************************** -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_route_utilities_validate_model_with_goal_missing_id(client, one_goal): #Act & Assert with pytest.raises(HTTPException) as e: result_task = validate_model(Goal, 4) - raise Exception("Complete test with assertion status code and response body") + response = e.value.get_response() + assert response.status_code == 404 + assert response.get_json() == {"message": "Goal 4 not found"} + + # raise Exception("Complete test with assertion status code and response body") # ***************************************************************************** # **Complete test with assertion about status code response body*************** # ***************************************************************************** @@ -135,7 +149,7 @@ def test_route_utilities_create_model_with_goal(client): assert response[0]["title"] == "Seize the Day!" assert response[1] == 201 -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_route_utilities_create_model_with_goal_missing_title(client): #Arrange request_body = { @@ -144,8 +158,12 @@ def test_route_utilities_create_model_with_goal_missing_title(client): #Act with pytest.raises(HTTPException) as e: create_model(Goal, request_body) - - raise Exception("Complete test with assertion status code and response body") + + response = e.value.get_response() + assert response.status_code == 400 + assert e.value.get_response().get_json() == {"details": "Invalid data"} + + # raise Exception("Complete test with assertion status code and response body") # ***************************************************************************** # **Complete test with assertion about status code response body*************** # ***************************************************************************** From 68c292be44dda25e219f09a59349355f19c5b53c Mon Sep 17 00:00:00 2001 From: Tsz Tin Vivian Soo Date: Thu, 6 Nov 2025 00:16:23 -0500 Subject: [PATCH 21/23] Refactor goal and task retrieval to support filtering and sorting through utility functions --- app/routes/goal_routes.py | 10 +++------- app/routes/route_utilities.py | 3 ++- app/routes/task_routes.py | 3 ++- 3 files changed, 7 insertions(+), 9 deletions(-) diff --git a/app/routes/goal_routes.py b/app/routes/goal_routes.py index ce7dc08f0..53b3bd046 100644 --- a/app/routes/goal_routes.py +++ b/app/routes/goal_routes.py @@ -13,13 +13,9 @@ def create_goal(): @bp.get("") def get_all_goals(): - query = db.select(Goal).order_by(Goal.id) - - goals = db.session.scalars(query) - - response = [goal.to_dict() for goal in goals] - - return response + return get_models_with_filters(Goal, + sort_param=request.args.get("sort"), + filters=request.args.get("filters")) @bp.get("/") def get_goal(goal_id): diff --git a/app/routes/route_utilities.py b/app/routes/route_utilities.py index 2312449ba..293e02a23 100644 --- a/app/routes/route_utilities.py +++ b/app/routes/route_utilities.py @@ -39,7 +39,8 @@ def get_models_with_filters(cls, filters=None, sort_param=None): if filters: for attribute, value in filters.items(): - query = query.where(getattr(cls, attribute) == value) + if hasattr(cls, attribute): + query = query.where(getattr(cls, attribute).ilike(f"%{value}%")) if sort_param == "asc": query = query.order_by(cls.title.asc()) diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index 0cdf510d7..6a5b44019 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -23,7 +23,8 @@ def create_task(): @bp.get("") def get_all_tasks(): return get_models_with_filters(Task, - sort_param=request.args.get("sort")) + sort_param=request.args.get("sort"), + filters=request.args.get("filters")) @bp.get("/") def get_task(task_id): From dd3d8db11f713a7a5b2ba7a2bfe79aaf981e00d4 Mon Sep 17 00:00:00 2001 From: Tsz Tin Vivian Soo Date: Thu, 6 Nov 2025 18:12:39 -0500 Subject: [PATCH 22/23] Enhance goal and task retrieval with additional filtering options for title and description --- app/routes/goal_routes.py | 5 +++-- app/routes/route_utilities.py | 26 ++++++++++++++++++-------- app/routes/task_routes.py | 6 ++++-- 3 files changed, 25 insertions(+), 12 deletions(-) diff --git a/app/routes/goal_routes.py b/app/routes/goal_routes.py index 53b3bd046..ac6f07564 100644 --- a/app/routes/goal_routes.py +++ b/app/routes/goal_routes.py @@ -14,8 +14,9 @@ def create_goal(): @bp.get("") def get_all_goals(): return get_models_with_filters(Goal, - sort_param=request.args.get("sort"), - filters=request.args.get("filters")) + sort=request.args.get("sort"), + title=request.args.get("title"), + description=request.args.get("description")) @bp.get("/") def get_goal(goal_id): diff --git a/app/routes/route_utilities.py b/app/routes/route_utilities.py index 293e02a23..f233997d1 100644 --- a/app/routes/route_utilities.py +++ b/app/routes/route_utilities.py @@ -33,18 +33,28 @@ def create_model(cls, model_data): return response, 201 -def get_models_with_filters(cls, filters=None, sort_param=None): - """Retrieve all model instances, optionally applying filters.""" +def get_models_with_filters(cls, sort=None, title=None, description=None): + """Return list of model dicts, optionally sorted and filtered. + + If the requested filter/sort field doesn't exist on `cls`, the function will + ignore that filter/sort and return unfiltered/unordered results (i.e. "just return all"). + """ query = db.select(cls) - if filters: - for attribute, value in filters.items(): - if hasattr(cls, attribute): - query = query.where(getattr(cls, attribute).ilike(f"%{value}%")) + # Apply filter using getattr; if the attribute doesn't exist, ignore the filter + if title: + attr = getattr(cls, "title", None) + if attr is not None: + query = query.where(attr.ilike(f"%{title}%")) + + if description: + attr = getattr(cls, "description", None) + if attr is not None: + query = query.where(attr.ilike(f"%{description}%")) - if sort_param == "asc": + if sort == "asc": query = query.order_by(cls.title.asc()) - elif sort_param == "desc": + else: query = query.order_by(cls.title.desc()) models = db.session.scalars(query) diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index 6a5b44019..a5e1cb7aa 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -23,8 +23,10 @@ def create_task(): @bp.get("") def get_all_tasks(): return get_models_with_filters(Task, - sort_param=request.args.get("sort"), - filters=request.args.get("filters")) + sort=request.args.get("sort"), + title=request.args.get("title"), + description=request.args.get("description")) + @bp.get("/") def get_task(task_id): From 0b85b252f239ec4c409085624c7a17c1d2e20701 Mon Sep 17 00:00:00 2001 From: Tsz Tin Vivian Soo Date: Thu, 6 Nov 2025 18:16:12 -0500 Subject: [PATCH 23/23] Remove description filtering from goal retrieval since goal doesn't have description attribute --- app/routes/goal_routes.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/app/routes/goal_routes.py b/app/routes/goal_routes.py index ac6f07564..cf5b83f21 100644 --- a/app/routes/goal_routes.py +++ b/app/routes/goal_routes.py @@ -15,8 +15,7 @@ def create_goal(): def get_all_goals(): return get_models_with_filters(Goal, sort=request.args.get("sort"), - title=request.args.get("title"), - description=request.args.get("description")) + title=request.args.get("title")) @bp.get("/") def get_goal(goal_id):