From 5995626e1d0bc2237060db888000f3e75fbdb4d1 Mon Sep 17 00:00:00 2001 From: Collette Date: Thu, 1 May 2025 14:37:01 -0600 Subject: [PATCH 01/12] set up project --- 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 b6179df110328998177845cac2c4babce72e6b4d Mon Sep 17 00:00:00 2001 From: Collette Date: Thu, 1 May 2025 14:42:14 -0600 Subject: [PATCH 02/12] remove py skip in wave 01 --- tests/test_wave_01.py | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/tests/test_wave_01.py b/tests/test_wave_01.py index 55475db79..9f465a166 100644 --- a/tests/test_wave_01.py +++ b/tests/test_wave_01.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_get_tasks_no_saved_tasks(client): # Act response = client.get("/tasks") @@ -14,7 +14,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") @@ -33,7 +33,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") @@ -52,7 +52,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") @@ -67,7 +67,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={ @@ -97,7 +97,7 @@ def test_create_task(client): 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={ @@ -117,7 +117,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={ @@ -135,7 +135,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") @@ -146,7 +146,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") @@ -163,7 +163,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={ @@ -180,7 +180,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 82ffcc906fffd69eba8ecf8b7fb702df3a5e5792 Mon Sep 17 00:00:00 2001 From: Collette Date: Thu, 1 May 2025 14:57:02 -0600 Subject: [PATCH 03/12] complete tests --- tests/test_wave_01.py | 27 ++++++++++++--------------- 1 file changed, 12 insertions(+), 15 deletions(-) diff --git a/tests/test_wave_01.py b/tests/test_wave_01.py index 9f465a166..71489090a 100644 --- a/tests/test_wave_01.py +++ b/tests/test_wave_01.py @@ -60,11 +60,10 @@ def test_get_task_not_found(client): # Assert assert response.status_code == 404 - - raise Exception("Complete test with assertion about response body") - # ***************************************************************** - # **Complete test with assertion about response body*************** - # ***************************************************************** + assert "error" in response_body + assert response_body == { + "error": "Task not found" + } # @pytest.mark.skip(reason="No way to test this feature yet") @@ -128,11 +127,10 @@ def test_update_task_not_found(client): # Assert assert response.status_code == 404 - - raise Exception("Complete test with assertion about response body") - # ***************************************************************** - # **Complete test with assertion about response body*************** - # ***************************************************************** + assert "error" in response_body + assert response_body == { + "error": "Task not found" + } # @pytest.mark.skip(reason="No way to test this feature yet") @@ -154,11 +152,10 @@ def test_delete_task_not_found(client): # Assert assert response.status_code == 404 - - raise Exception("Complete test with assertion about response body") - # ***************************************************************** - # **Complete test with assertion about response body*************** - # ***************************************************************** + assert "error" in response_body + assert response_body == { + "error": "Task not found" + } assert db.session.scalars(db.select(Task)).all() == [] From 4c69eb5470cbc1a1fbd9743ca8c265af08d02fc2 Mon Sep 17 00:00:00 2001 From: Collette Date: Thu, 8 May 2025 21:29:41 -0500 Subject: [PATCH 04/12] add task model --- app/__init__.py | 2 + app/models/task.py | 22 +++++ app/routes/task_routes.py | 91 ++++++++++++++++++- .../versions/a889c0234cc0_add_task_model.py | 39 ++++++++ 4 files changed, 153 insertions(+), 1 deletion(-) create mode 100644 migrations/versions/a889c0234cc0_add_task_model.py diff --git a/app/__init__.py b/app/__init__.py index 3c581ceeb..80dc0d60a 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..8c55c17e8 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -1,5 +1,27 @@ +from datetime import datetime from sqlalchemy.orm import Mapped, mapped_column +from sqlalchemy import Text, DateTime from ..db import db + class Task(db.Model): id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True) + title: Mapped[str] + description: Mapped[str] = mapped_column(Text) + completed_at: Mapped[datetime] = mapped_column(DateTime, nullable=True) + + def to_dict(self): + return { + "id": self.id, + "title": self.title, + "description": self.description, + "is_complete": self.completed_at is not None + } + + @classmethod + def from_dict(cls, task_data): + return cls( + title=task_data["title"], + description=task_data["description"], + completed_at=task_data.get("completed_at") + ) diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index 3aae38d49..b3b12ebe3 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -1 +1,90 @@ -from flask import Blueprint \ No newline at end of file +from flask import Blueprint, request, make_response, abort, Response +from ..db import db +from app.models.task import Task + +tasks_bp = Blueprint("tasks_bp", __name__, url_prefix="/tasks") + + +def validate_task(task_id): + """ + Validates that a task with the given ID exists. + Returns the task if it exists, otherwise aborts with 404. + """ + try: + task_id = int(task_id) + except ValueError: + response = {"message": f"Task id {task_id} is 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 with id:{task_id} not found"} + abort(make_response(response, 404)) + + return task + + +@tasks_bp.post("") +def create_task(): + """Create a new task""" + request_body = request.get_json() + + # Validate required fields + if "title" not in request_body or "description" not in request_body: + return {"details": "Invalid data"}, 400 + + try: + new_task = Task.from_dict(request_body) + except KeyError: + return {"details": "Invalid data"}, 400 + + db.session.add(new_task) + db.session.commit() + + return {"task": new_task.to_dict()}, 201 + + +@tasks_bp.get("") +def get_all_tasks(): + """Get all tasks""" + query = db.select(Task) + tasks = db.session.scalars(query) + + return [task.to_dict() for task in tasks] + + +@tasks_bp.get("/") +def get_task(task_id): + """Get a specific task by ID""" + task = validate_task(task_id) + + return {"task": task.to_dict()} + + +@tasks_bp.put("/") +def update_task(task_id): + """Update a task by ID""" + task = validate_task(task_id) + request_body = request.get_json() + + if "title" in request_body: + task.title = request_body["title"] + if "description" in request_body: + task.description = request_body["description"] + + db.session.commit() + + return Response(status=204, mimetype="application/json") + + +@tasks_bp.delete("/") +def delete_task(task_id): + """Delete a task by ID""" + task = validate_task(task_id) + + db.session.delete(task) + db.session.commit() + + return Response(status=204, mimetype="application/json") \ No newline at end of file diff --git a/migrations/versions/a889c0234cc0_add_task_model.py b/migrations/versions/a889c0234cc0_add_task_model.py new file mode 100644 index 000000000..510a61ae0 --- /dev/null +++ b/migrations/versions/a889c0234cc0_add_task_model.py @@ -0,0 +1,39 @@ +"""Add Task model + +Revision ID: a889c0234cc0 +Revises: +Create Date: 2025-05-08 21:02:49.483981 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'a889c0234cc0' +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.Text(), nullable=False), + sa.Column('completed_at', sa.DateTime(), 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 b3757a050b3bf315eb9f29a51ca6f4c623b5fc29 Mon Sep 17 00:00:00 2001 From: Collette Date: Thu, 8 May 2025 21:32:11 -0500 Subject: [PATCH 05/12] fix for tasks not found --- app/routes/task_routes.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index b3b12ebe3..aa26eb39b 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -13,14 +13,14 @@ def validate_task(task_id): try: task_id = int(task_id) except ValueError: - response = {"message": f"Task id {task_id} is invalid"} + response = {"error": "Invalid task ID"} 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 with id:{task_id} not found"} + response = {"error": "Task not found"} abort(make_response(response, 404)) return task From 8ef9eb8ffbd12697b1f258e75a3164eef2a74f6c Mon Sep 17 00:00:00 2001 From: Collette Date: Thu, 8 May 2025 21:33:59 -0500 Subject: [PATCH 06/12] remove pystest skip wave 2 --- tests/test_wave_02.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) 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 8efd4951245494897457e4c6617cec882509a316 Mon Sep 17 00:00:00 2001 From: Collette Date: Fri, 9 May 2025 20:58:55 -0500 Subject: [PATCH 07/12] and case for sorting by title --- app/routes/task_routes.py | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index aa26eb39b..284cff069 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -49,9 +49,18 @@ def create_task(): @tasks_bp.get("") def get_all_tasks(): """Get all tasks""" + sort_param = request.args.get("sort") + query = db.select(Task) + + # sort by title + 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) - + return [task.to_dict() for task in tasks] From a09e0935b343f0a415945890a21b3ad172b55248 Mon Sep 17 00:00:00 2001 From: Collette Date: Fri, 9 May 2025 21:04:54 -0500 Subject: [PATCH 08/12] finish wave 3 tests --- tests/test_wave_03.py | 24 ++++++++---------------- 1 file changed, 8 insertions(+), 16 deletions(-) diff --git a/tests/test_wave_03.py b/tests/test_wave_03.py index d7d441695..db0068cde 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") @@ -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,10 @@ def test_mark_complete_missing_task(client): # Assert assert response.status_code == 404 + assert response_body["error"] == "Task 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 +105,4 @@ def test_mark_incomplete_missing_task(client): # Assert assert response.status_code == 404 - - raise Exception("Complete test with assertion about response body") - # ***************************************************************** - # **Complete test with assertion about response body*************** - # ***************************************************************** + assert response_body["error"] == "Task not found" From 0eab9510dd1068ebf7c2479277b830154648bea2 Mon Sep 17 00:00:00 2001 From: Collette Date: Fri, 9 May 2025 21:12:03 -0500 Subject: [PATCH 09/12] add routes for incomplete tasked and completing tasks by date --- 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 284cff069..cb3d25334 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -1,6 +1,7 @@ from flask import Blueprint, request, make_response, abort, Response from ..db import db from app.models.task import Task +from datetime import datetime tasks_bp = Blueprint("tasks_bp", __name__, url_prefix="/tasks") @@ -92,8 +93,30 @@ def update_task(task_id): def delete_task(task_id): """Delete a task by ID""" task = validate_task(task_id) - + db.session.delete(task) db.session.commit() - + + return Response(status=204, mimetype="application/json") + + +@tasks_bp.patch("//mark_complete") +def mark_task_complete(task_id): + """Mark a task as complete""" + 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): + """Mark a task as incomplete""" + task = validate_task(task_id) + + task.completed_at = None + db.session.commit() + return Response(status=204, mimetype="application/json") \ No newline at end of file From e3feaa0c26bbde32c12e2eefe42a98db373b1929 Mon Sep 17 00:00:00 2001 From: Collette Date: Sat, 10 May 2025 22:03:23 -0500 Subject: [PATCH 10/12] add slack api --- app/routes/task_routes.py | 38 ++++++++++++++++++++++++++++++++++++++ tests/test_wave_05.py | 21 ++++++++++----------- 2 files changed, 48 insertions(+), 11 deletions(-) diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index cb3d25334..825e908a6 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -2,9 +2,43 @@ from ..db import db from app.models.task import Task from datetime import datetime +import requests +import os tasks_bp = Blueprint("tasks_bp", __name__, url_prefix="/tasks") +# Slack API +SLACK_API_TOKEN = os.environ.get('SLACK_API_TOKEN') +SLACK_CHANNEL = os.environ.get('SLACK_CHANNEL', 'task-notifications') + +def send_slack_notification(message): + if not SLACK_API_TOKEN: + print("Warning: SLACK_API_TOKEN not configured.") + return False + + url = "https://slack.com/api/chat.postMessage" + headers = { + "Authorization": f"Bearer {SLACK_API_TOKEN}", + "Content-Type": "application/json" + } + payload = { + "channel": SLACK_CHANNEL, + "text": message + } + + try: + response = requests.post(url, json=payload, headers=headers) + data = response.json() + + if data.get("ok"): + return True + else: + print(f"Slack API error: {data.get('error')}") + return False + except Exception as e: + print(f"Error sending Slack notification: {str(e)}") + return False + def validate_task(task_id): """ @@ -108,6 +142,10 @@ def mark_task_complete(task_id): task.completed_at = datetime.now() db.session.commit() + # Send Slack notification when a task is marked complete + notification_message = f"Someone just completed the task {task.title}" + send_slack_notification(notification_message) + return Response(status=204, mimetype="application/json") diff --git a/tests/test_wave_05.py b/tests/test_wave_05.py index 222d10cf0..70829b277 100644 --- a/tests/test_wave_05.py +++ b/tests/test_wave_05.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_goals_no_saved_goals(client): # Act response = client.get("/goals") @@ -12,7 +12,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") @@ -29,7 +29,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") @@ -45,8 +45,7 @@ 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 @@ -61,7 +60,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={ @@ -80,7 +79,7 @@ def test_create_goal(client): } -@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") # Act @@ -94,7 +93,7 @@ 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") # Act @@ -107,7 +106,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") @@ -128,7 +127,7 @@ def test_delete_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_delete_goal_not_found(client): raise Exception("Complete test") @@ -142,7 +141,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 f3a3faaaeedccceeb0db0387fa4bc295074e7407 Mon Sep 17 00:00:00 2001 From: Collette Date: Sun, 11 May 2025 10:56:59 -0500 Subject: [PATCH 11/12] Add goal model and routes, completed wave 5 tests --- app/__init__.py | 2 + app/models/goal.py | 20 ++++- app/models/task.py | 7 +- app/routes/goal_routes.py | 85 ++++++++++++++++++- ...dd_goal_model_and_relationship_to_tasks.py | 40 +++++++++ tests/test_wave_05.py | 47 +++++----- 6 files changed, 172 insertions(+), 29 deletions(-) create mode 100644 migrations/versions/4109d3270061_add_goal_model_and_relationship_to_tasks.py diff --git a/app/__init__.py b/app/__init__.py index 80dc0d60a..de06dac09 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -2,6 +2,7 @@ from .db import db, migrate from .models import task, goal from .routes.task_routes import tasks_bp +from .routes.goal_routes import 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..2a43abf39 100644 --- a/app/models/goal.py +++ b/app/models/goal.py @@ -1,5 +1,23 @@ -from sqlalchemy.orm import Mapped, mapped_column +from sqlalchemy.orm import Mapped, mapped_column, relationship from ..db import db +from typing import Dict, Any, List class Goal(db.Model): id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True) + title: Mapped[str] = mapped_column(nullable=False) + + tasks = relationship("Task", back_populates="goal", cascade="all, delete-orphan") + + @classmethod + def from_dict(cls, goal_data: Dict[str, Any]) -> "Goal": + """Create a Goal instance from a dictionary.""" + return cls( + title=goal_data["title"] + ) + + def to_dict(self) -> Dict[str, Any]: + """Convert the Goal instance to a dictionary.""" + return { + "id": self.id, + "title": self.title + } diff --git a/app/models/task.py b/app/models/task.py index 8c55c17e8..9eca35c29 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -1,6 +1,6 @@ from datetime import datetime -from sqlalchemy.orm import Mapped, mapped_column -from sqlalchemy import Text, DateTime +from sqlalchemy.orm import Mapped, mapped_column, relationship +from sqlalchemy import Text, DateTime, ForeignKey from ..db import db @@ -10,6 +10,9 @@ class Task(db.Model): description: Mapped[str] = mapped_column(Text) completed_at: Mapped[datetime] = mapped_column(DateTime, nullable=True) + goal_id = mapped_column(ForeignKey("goal.id"), nullable=True) + goal = relationship("Goal", back_populates="tasks") + def to_dict(self): return { "id": self.id, diff --git a/app/routes/goal_routes.py b/app/routes/goal_routes.py index 3aae38d49..64eaaa35e 100644 --- a/app/routes/goal_routes.py +++ b/app/routes/goal_routes.py @@ -1 +1,84 @@ -from flask import Blueprint \ No newline at end of file +from flask import Blueprint, request, make_response, abort, Response +from ..db import db +from app.models.goal import Goal + +goals_bp = Blueprint("goals_bp", __name__, url_prefix="/goals") + + +def validate_goal(goal_id): + try: + goal_id = int(goal_id) + except ValueError: + response = {"message": "Invalid goal ID"} + abort(make_response(response, 400)) + + query = db.select(Goal).where(Goal.id == goal_id) + goal = db.session.scalar(query) + + if not goal: + response = {"message": "Goal not found"} + abort(make_response(response, 404)) + + return goal + + +@goals_bp.post("") +def create_goal(): + """Create a new goal""" + request_body = request.get_json() + + # Required fields + if "title" not in request_body: + return {"details": "Invalid data"}, 400 + + try: + new_goal = Goal.from_dict(request_body) + except KeyError: + return {"details": "Invalid data"}, 400 + + db.session.add(new_goal) + db.session.commit() + + return {"goal": new_goal.to_dict()}, 201 + + +@goals_bp.get("") +def get_all_goals(): + """Get all goals""" + query = db.select(Goal) + goals = db.session.scalars(query) + + return [goal.to_dict() for goal in goals] + + +@goals_bp.get("/") +def get_goal(goal_id): + """Get a specific goal by ID""" + goal = validate_goal(goal_id) + + return {"goal": goal.to_dict()} + + +@goals_bp.put("/") +def update_goal(goal_id): + """Update a goal by ID""" + goal = validate_goal(goal_id) + request_body = request.get_json() + + if "title" in request_body: + goal.title = request_body["title"] + + db.session.commit() + + return Response(status=204, mimetype="application/json") + + +@goals_bp.delete("/") +def delete_goal(goal_id): + """Delete a goal by ID""" + goal = validate_goal(goal_id) + + db.session.delete(goal) + db.session.commit() + + return Response(status=204, mimetype="application/json") \ No newline at end of file diff --git a/migrations/versions/4109d3270061_add_goal_model_and_relationship_to_tasks.py b/migrations/versions/4109d3270061_add_goal_model_and_relationship_to_tasks.py new file mode 100644 index 000000000..a1fd87980 --- /dev/null +++ b/migrations/versions/4109d3270061_add_goal_model_and_relationship_to_tasks.py @@ -0,0 +1,40 @@ +"""add goal model and relationship to tasks + +Revision ID: 4109d3270061 +Revises: a889c0234cc0 +Create Date: 2025-05-10 22:20:36.857828 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '4109d3270061' +down_revision = 'a889c0234cc0' +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)) + + 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') + + with op.batch_alter_table('goal', schema=None) as batch_op: + batch_op.drop_column('title') + + # ### end Alembic commands ### diff --git a/tests/test_wave_05.py b/tests/test_wave_05.py index 70829b277..0edd7fb66 100644 --- a/tests/test_wave_05.py +++ b/tests/test_wave_05.py @@ -45,18 +45,15 @@ def test_get_goal(client, one_goal): } } -# @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 # ---- Complete Test ---- - # assertion 1 goes here - # assertion 2 goes here + assert response.status_code == 404 + assert "message" in response_body # ---- Complete Test ---- @@ -79,30 +76,35 @@ def test_create_goal(client): } -# @pytest.mark.skip(reason="test to be completed by student") def test_update_goal(client, one_goal): - raise Exception("Complete test") # Act - # ---- Complete Act Here ---- + response = client.put("/goals/1", json={ + "title": "Updated Goal Title" + }) # Assert # ---- Complete Assertions Here ---- - # assertion 1 goes here - # assertion 2 goes here - # assertion 3 goes here + assert response.status_code == 204 + assert response.mimetype == "application/json" + + get_response = client.get("/goals/1") + response_body = get_response.get_json() + assert response_body["goal"]["title"] == "Updated Goal Title" # ---- Complete Assertions Here ---- # @pytest.mark.skip(reason="test to be completed by student") def test_update_goal_not_found(client): - raise Exception("Complete test") # Act - # ---- Complete Act Here ---- + response = client.put("/goals/1", json={ + "title": "Updated Goal Title" + }) + response_body = response.get_json() # Assert # ---- Complete Assertions Here ---- - # assertion 1 goes here - # assertion 2 goes here + assert response.status_code == 404 + assert "message" in response_body # ---- Complete Assertions Here ---- @@ -121,23 +123,18 @@ 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") - # ***************************************************************** - # **Complete test with assertion about response body*************** - # ***************************************************************** + assert "Goal not found" in response_body["message"] or "not found" in response_body["message"] -# @pytest.mark.skip(reason="test to be completed by student") def test_delete_goal_not_found(client): - raise Exception("Complete test") - # Act - # ---- Complete Act Here ---- + response = client.delete("/goals/1") + response_body = response.get_json() # Assert # ---- Complete Assertions Here ---- - # assertion 1 goes here - # assertion 2 goes here + assert response.status_code == 404 + assert "message" in response_body # ---- Complete Assertions Here ---- From 60e78d32aab086584946e5b456a868627ef6fd6f Mon Sep 17 00:00:00 2001 From: Collette Date: Sun, 11 May 2025 12:43:51 -0500 Subject: [PATCH 12/12] Routes for task goal relationship --- app/models/task.py | 8 +++++- app/routes/goal_routes.py | 57 ++++++++++++++++++++++++++++++++++++++- tests/test_wave_06.py | 20 ++++++-------- 3 files changed, 71 insertions(+), 14 deletions(-) diff --git a/app/models/task.py b/app/models/task.py index 9eca35c29..f8edfc383 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -14,13 +14,19 @@ class Task(db.Model): goal = relationship("Goal", back_populates="tasks") def to_dict(self): - return { + task_dict = { "id": self.id, "title": self.title, "description": self.description, "is_complete": self.completed_at is not None } + # add goal_id if the task belongs to a goal + if self.goal_id: + task_dict["goal_id"] = self.goal_id + + return task_dict + @classmethod def from_dict(cls, task_data): return cls( diff --git a/app/routes/goal_routes.py b/app/routes/goal_routes.py index 64eaaa35e..b2ef16a10 100644 --- a/app/routes/goal_routes.py +++ b/app/routes/goal_routes.py @@ -1,9 +1,26 @@ from flask import Blueprint, request, make_response, abort, Response from ..db import db from app.models.goal import Goal +from app.models.task import Task goals_bp = Blueprint("goals_bp", __name__, url_prefix="/goals") +def validate_task(task_id): + try: + task_id = int(task_id) + except ValueError: + response = {"message": "Invalid task ID"} + abort(make_response(response, 400)) + + query = db.select(Task).where(Task.id == task_id) + task = db.session.scalar(query) + + if not task: + response = {"message": "Task not found"} + abort(make_response(response, 404)) + + return task + def validate_goal(goal_id): try: @@ -81,4 +98,42 @@ def delete_goal(goal_id): db.session.delete(goal) db.session.commit() - return Response(status=204, mimetype="application/json") \ No newline at end of file + return Response(status=204, mimetype="application/json") + + +@goals_bp.get("//tasks") +def get_tasks_for_goal(goal_id): + """Get all tasks associated with a specific goal""" + goal = validate_goal(goal_id) + + response = { + "id": goal.id, + "title": goal.title, + "tasks": [task.to_dict() for task in goal.tasks] + } + + return response + + +@goals_bp.post("//tasks") +def add_tasks_to_goal(goal_id): + """Associate multiple tasks with a goal""" + goal = validate_goal(goal_id) + request_body = request.get_json() + + if "task_ids" not in request_body: + return {"message": "Missing task_ids field"}, 400 + + goal.tasks = [] + + # Add each task from the task_ids list + for task_id in request_body["task_ids"]: + task = validate_task(task_id) + goal.tasks.append(task) + + db.session.commit() + + return { + "id": goal.id, + "task_ids": [task.id for task in goal.tasks] + } \ No newline at end of file diff --git a/tests/test_wave_06.py b/tests/test_wave_06.py index 0317f835a..c28d0d3a6 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_already_with_goals(client, one_task_belongs_to_one_goal, three_tasks): # Act response = client.post("/goals/1/tasks", json={ @@ -45,7 +45,7 @@ def test_post_task_ids_to_goal_already_with_goals(client, one_task_belongs_to_on 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,14 +53,10 @@ def test_get_tasks_for_specific_goal_no_goal(client): # Assert assert response.status_code == 404 + assert "message" in response_body + assert "not found" in response_body["message"].lower() or "goal not found" in response_body["message"].lower() - 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_get_tasks_for_specific_goal_no_tasks(client, one_goal): # Act response = client.get("/goals/1/tasks") @@ -77,7 +73,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 +98,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()