From 3eb95011065befa6f6e6f06c67778789367fa4e4 Mon Sep 17 00:00:00 2001 From: Brian Martinez <100006298+bamart-dev@users.noreply.github.com> Date: Thu, 1 May 2025 13:37:10 -0700 Subject: [PATCH 01/29] set up project and generate migrations directory --- 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 162a90cf70e2d8e8655136262204b21fff3563a0 Mon Sep 17 00:00:00 2001 From: Brian Martinez <100006298+bamart-dev@users.noreply.github.com> Date: Thu, 1 May 2025 17:06:25 -0700 Subject: [PATCH 02/29] implement Task class and helper methods --- app/models/task.py | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/app/models/task.py b/app/models/task.py index 5d99666a4..53fbb0d46 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -1,5 +1,36 @@ from sqlalchemy.orm import Mapped, mapped_column +from datetime import 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] + completed_at: Mapped[datetime] + + def to_dict(self): + """Return object attributes in dictionary format. + + When called on a Task object, the method returns a dictionary + containing key value pairs corresponding to the object's attributes. + """ + return { + "id": self.id, + "title": self.title, + "description": self.description, + "completed_at": self.completed_at, + } + + + @classmethod + def create_from_dict(cls, task_data): + """Create new task from dictionary items. + + Instantiates and returns a new Task object with attribute values + derived from a provided dictionary. + """ + return cls( + title = task_data["title"], + description = task_data["description"], + completed_at = task_data["completed_at"], + ) From bfdc3da67b1df0ea631fd32e4f4e4307f4364e41 Mon Sep 17 00:00:00 2001 From: Brian Martinez <100006298+bamart-dev@users.noreply.github.com> Date: Tue, 6 May 2025 16:58:36 -0700 Subject: [PATCH 03/29] update Task class --- app/models/task.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/app/models/task.py b/app/models/task.py index 53fbb0d46..7cd4537a4 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -1,3 +1,4 @@ +from typing import Optional from sqlalchemy.orm import Mapped, mapped_column from datetime import datetime from ..db import db @@ -6,7 +7,7 @@ class Task(db.Model): id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True) title: Mapped[str] description: Mapped[str] - completed_at: Mapped[datetime] + completed_at: Mapped[Optional[datetime]] def to_dict(self): """Return object attributes in dictionary format. @@ -18,7 +19,7 @@ def to_dict(self): "id": self.id, "title": self.title, "description": self.description, - "completed_at": self.completed_at, + "is_complete": bool(self.completed_at), } From 576e3d4d83917f019d5d796edb86fbc10049978c Mon Sep 17 00:00:00 2001 From: Brian Martinez <100006298+bamart-dev@users.noreply.github.com> Date: Tue, 6 May 2025 18:50:40 -0700 Subject: [PATCH 04/29] add line to register blueprint --- app/__init__.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/app/__init__.py b/app/__init__.py index 3c581ceeb..dc38d5494 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,5 +1,7 @@ from flask import Flask from .db import db, migrate +from .models import task +from .routes.task_routes import tasks_bp from .models import task, goal import os @@ -18,5 +20,5 @@ def create_app(config=None): migrate.init_app(app, db) # Register Blueprints here - + app.register_blueprint(tasks_bp) return app From 72f192ea4f4b580b7e84ad7b752fa6abc54c9d48 Mon Sep 17 00:00:00 2001 From: Brian Martinez <100006298+bamart-dev@users.noreply.github.com> Date: Tue, 6 May 2025 18:51:40 -0700 Subject: [PATCH 05/29] slight refactoring of Task model & add missing __init__.py file to routes/ --- app/routes/__init__.py | 0 migrations/versions/4f59200e1074_.py | 39 ++++++++++++++++++++++++++++ 2 files changed, 39 insertions(+) create mode 100644 app/routes/__init__.py create mode 100644 migrations/versions/4f59200e1074_.py diff --git a/app/routes/__init__.py b/app/routes/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/migrations/versions/4f59200e1074_.py b/migrations/versions/4f59200e1074_.py new file mode 100644 index 000000000..7feb76b25 --- /dev/null +++ b/migrations/versions/4f59200e1074_.py @@ -0,0 +1,39 @@ +"""empty message + +Revision ID: 4f59200e1074 +Revises: +Create Date: 2025-05-06 18:08:56.709624 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '4f59200e1074' +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(), 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 9bd2194b45057cf9a7a9674c8c458f53e059fb17 Mon Sep 17 00:00:00 2001 From: Brian Martinez <100006298+bamart-dev@users.noreply.github.com> Date: Tue, 6 May 2025 21:13:19 -0700 Subject: [PATCH 06/29] update blueprint registration --- app/__init__.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/app/__init__.py b/app/__init__.py index dc38d5494..5c0ea4b64 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,7 +1,7 @@ from flask import Flask from .db import db, migrate from .models import task -from .routes.task_routes import tasks_bp +from .routes.task_routes import bp from .models import task, goal import os @@ -20,5 +20,5 @@ def create_app(config=None): migrate.init_app(app, db) # Register Blueprints here - app.register_blueprint(tasks_bp) + app.register_blueprint(bp) return app From 021d8315aa7ec659a90a209e3418dbd2050b3ff7 Mon Sep 17 00:00:00 2001 From: Brian Martinez <100006298+bamart-dev@users.noreply.github.com> Date: Tue, 6 May 2025 22:11:40 -0700 Subject: [PATCH 07/29] update create_from_dict method to use .get() dict method for completed_at attribute --- app/models/task.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/models/task.py b/app/models/task.py index 7cd4537a4..e6e5a33bb 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -33,5 +33,5 @@ def create_from_dict(cls, task_data): return cls( title = task_data["title"], description = task_data["description"], - completed_at = task_data["completed_at"], + completed_at = task_data.get("completed_at"), ) From ec5e99ae1ce5de35b06c9baafedd9c25e8292664 Mon Sep 17 00:00:00 2001 From: Brian Martinez <100006298+bamart-dev@users.noreply.github.com> Date: Tue, 6 May 2025 22:13:47 -0700 Subject: [PATCH 08/29] implemented basic CRUD routes and created route helper functions --- app/routes/route_utilities.py | 51 +++++++++++++++++++++++++++++++++ app/routes/task_routes.py | 53 ++++++++++++++++++++++++++++++++++- 2 files changed, 103 insertions(+), 1 deletion(-) 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..3b3d2d8be --- /dev/null +++ b/app/routes/route_utilities.py @@ -0,0 +1,51 @@ +from flask import abort, make_response +from app.db import db + + +def validate_model(cls, model_id): + """Check given model ID and return model if ID is valid. + + Returns a model matching the provided ID if ID is an integer and + a corresponding model exists. + """ + try: + model_id = int(model_id) + except ValueError: + message = {"error": f"{cls.__name__} ID ({model_id}) not valid."} + abort(make_response(message, 400)) + + query = db.select(cls).where(cls.id == model_id) + model = db.session.scalar(query) + + if not model: + message = {"error": f"{cls.__name__} ID ({model_id}) not found."} + abort(make_response(message, 404)) + + return model + + +def create_model(cls, model_info): + """Create model from provided dictionary and save in database. + + Creates a model using the contents of a given dictionary, commits + it to the database, then returns a response. Raises KeyError if + attributes are missing from request. + """ + try: + model = cls.create_from_dict(model_info) + except KeyError as error: + response = {"details": "Invalid data"} + abort(make_response(response, 400)) + + db.session.add(model) + db.session.commit() + + return {"task": model.to_dict()}, 201 + + +def get_all_models(cls): + """Retrieve all models from database.""" + query = db.select(cls).order_by(cls.id) + models = db.session.scalars(query) + + return [model.to_dict() for model in models] diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index 3aae38d49..8036fd882 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -1 +1,52 @@ -from flask import Blueprint \ No newline at end of file +from flask import Blueprint, request, Response, abort, make_response +from .route_utilities import validate_model, create_model, get_all_models +from app.db import db +from app.models.task import Task + +bp = Blueprint("task_bp", __name__, url_prefix="/tasks") + + +@bp.post("") +def create_task(): + request_body = request.get_json() + + return create_model(Task, request_body) + + +@bp.get("") +def get_all_tasks(): + return get_all_models(Task) + + +@bp.get("/") +def get_one_task(task_id): + task = validate_model(Task, task_id) + + return {"task": task.to_dict()} + + +@bp.put("/") +def update_task(task_id): + task = validate_model(Task, task_id) + request_body = request.get_json() + try: + task.title = request_body["title"] + task.description = request_body["description"] + task.completed_at = request_body.get("completed_at") + except KeyError as e: + response = {"details": f"Invalid request: missing {e.args[0]}"} + abort(make_response(response, 400)) + + db.session.commit() + + return Response(status=204, mimetype="application/json") + + +@bp.delete("/") +def delete_task(task_id): + task = validate_model(Task, task_id) + + db.session.delete(task) + db.session.commit() + + return Response(status=204, mimetype="application/json") From a4a722f7a12131b44802e004c85010a484b5dc3c Mon Sep 17 00:00:00 2001 From: Brian Martinez <100006298+bamart-dev@users.noreply.github.com> Date: Tue, 6 May 2025 22:16:40 -0700 Subject: [PATCH 09/29] Unskipped/ran all wave 1 tests; all tests passing (Wave 1 complete) --- tests/test_wave_01.py | 35 +++++++++++++++++------------------ 1 file changed, 17 insertions(+), 18 deletions(-) diff --git a/tests/test_wave_01.py b/tests/test_wave_01.py index 55475db79..d36153101 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") @@ -61,13 +61,13 @@ 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 response_body == {"error": "Task ID (1) not found."} -@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={ @@ -87,7 +87,7 @@ def test_create_task(client): "is_complete": False } } - + query = db.select(Task).where(Task.id == 1) new_task = db.session.scalar(query) @@ -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={ @@ -116,8 +116,7 @@ def test_update_task(client, one_task): assert 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_not_found(client): # Act response = client.put("/tasks/1", json={ @@ -129,13 +128,13 @@ 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 response_body == {"error": "Task ID (1) not found."} -@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 +145,8 @@ 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") @@ -155,15 +155,14 @@ 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 response_body == {"error": "Task ID (1) not found."} 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 +179,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={ @@ -194,4 +193,4 @@ def test_create_task_must_contain_description(client): assert response_body == { "details": "Invalid data" } - assert db.session.scalars(db.select(Task)).all() == [] \ No newline at end of file + assert db.session.scalars(db.select(Task)).all() == [] From 875a36bdbb1223c17c2c1b834f785f74f0bded17 Mon Sep 17 00:00:00 2001 From: Brian Martinez <100006298+bamart-dev@users.noreply.github.com> Date: Tue, 6 May 2025 22:19:50 -0700 Subject: [PATCH 10/29] minor clean up of create_model code --- app/routes/route_utilities.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/routes/route_utilities.py b/app/routes/route_utilities.py index 3b3d2d8be..eadb256f9 100644 --- a/app/routes/route_utilities.py +++ b/app/routes/route_utilities.py @@ -33,7 +33,7 @@ def create_model(cls, model_info): """ try: model = cls.create_from_dict(model_info) - except KeyError as error: + except KeyError: response = {"details": "Invalid data"} abort(make_response(response, 400)) From 697c2e563f2f403ed3caf42c94bdfecd098efe75 Mon Sep 17 00:00:00 2001 From: Brian Martinez <100006298+bamart-dev@users.noreply.github.com> Date: Tue, 6 May 2025 23:22:05 -0700 Subject: [PATCH 11/29] refactor get_all_models to accept sort parameter --- app/routes/route_utilities.py | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/app/routes/route_utilities.py b/app/routes/route_utilities.py index eadb256f9..a0a491afd 100644 --- a/app/routes/route_utilities.py +++ b/app/routes/route_utilities.py @@ -1,4 +1,5 @@ -from flask import abort, make_response +from sqlalchemy import desc +from flask import abort, make_response, request from app.db import db @@ -45,7 +46,14 @@ def create_model(cls, model_info): def get_all_models(cls): """Retrieve all models from database.""" - query = db.select(cls).order_by(cls.id) - models = db.session.scalars(query) + query = db.select(cls) + order = request.args.get("sort") + + if order == "desc": + models = db.session.scalars(query.order_by(desc(cls.title))) + elif order == "asc": + models = db.session.scalars(query.order_by(cls.title)) + else: + models = db.session.scalars(query.order_by(cls.id)) return [model.to_dict() for model in models] From 5eaa3278e702343291988b2884bb56cda063b374 Mon Sep 17 00:00:00 2001 From: Brian Martinez <100006298+bamart-dev@users.noreply.github.com> Date: Tue, 6 May 2025 23:22:49 -0700 Subject: [PATCH 12/29] Unskipped/ran tests; all wave 2 tests passed (Wave 2 complete) --- 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 f555510745abde5d70a1fae8152abbca5be99af6 Mon Sep 17 00:00:00 2001 From: Brian Martinez <100006298+bamart-dev@users.noreply.github.com> Date: Wed, 7 May 2025 14:18:48 -0700 Subject: [PATCH 13/29] implement two additional patch routes --- app/routes/task_routes.py | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index 8036fd882..7dd52f65a 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -1,3 +1,4 @@ +from datetime import datetime, timezone from flask import Blueprint, request, Response, abort, make_response from .route_utilities import validate_model, create_model, get_all_models from app.db import db @@ -42,6 +43,26 @@ def update_task(task_id): return Response(status=204, mimetype="application/json") +@bp.patch("//mark_complete") +def mark_task_complete(task_id): + task = validate_model(Task, task_id) + + task.completed_at = datetime.now(tz=timezone.utc) + db.session.commit() + + return Response(status=204, mimetype="application/json") + + +@bp.patch("//mark_incomplete") +def mark_task_incomplete(task_id): + task = validate_model(Task, task_id) + + task.completed_at = None + db.session.commit() + + return Response(status=204, mimetype="application/json") + + @bp.delete("/") def delete_task(task_id): task = validate_model(Task, task_id) From 99b5f83072378ce28e98d0a7b342d1bfd5fe074b Mon Sep 17 00:00:00 2001 From: Brian Martinez <100006298+bamart-dev@users.noreply.github.com> Date: Wed, 7 May 2025 14:20:00 -0700 Subject: [PATCH 14/29] unskipped/ran all wave 3 tests; all tests passed (Wave 3 complete) --- tests/test_wave_03.py | 27 +++++++++++++++------------ 1 file changed, 15 insertions(+), 12 deletions(-) diff --git a/tests/test_wave_03.py b/tests/test_wave_03.py index d7d441695..2c3e2cce5 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 """ @@ -29,16 +29,16 @@ def test_mark_complete_on_incomplete_task(client, one_task): # Assert assert response.status_code == 204 - + 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_complete_task(client, completed_task): # Act response = client.patch("/tasks/1/mark_incomplete") - + # Assert assert response.status_code == 204 @@ -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 """ @@ -66,7 +66,7 @@ def test_mark_complete_on_completed_task(client, completed_task): # Act response = client.patch("/tasks/1/mark_complete") - + # Assert assert response.status_code == 204 @@ -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") @@ -95,13 +95,14 @@ def test_mark_complete_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 ID (1) not found.", + } - -@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") @@ -110,7 +111,9 @@ 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 ID (1) not found.", + } From a91b77586b3ecaf9861bc2af92dff1de00469d94 Mon Sep 17 00:00:00 2001 From: Brian Martinez <100006298+bamart-dev@users.noreply.github.com> Date: Wed, 7 May 2025 18:56:02 -0700 Subject: [PATCH 15/29] add Slack API call to post task completion message in a channel (Wave 4 complete) --- app/routes/task_routes.py | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index 7dd52f65a..d10aebff9 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -3,6 +3,8 @@ from .route_utilities import validate_model, create_model, get_all_models from app.db import db from app.models.task import Task +import os +import requests bp = Blueprint("task_bp", __name__, url_prefix="/tasks") @@ -50,6 +52,17 @@ def mark_task_complete(task_id): task.completed_at = datetime.now(tz=timezone.utc) db.session.commit() + api_token = os.environ.get("SLACKBOT_API_KEY") + channel_id = os.environ.get("SLACK_CHANNEL_ID") + url = "https://slack.com/api/chat.postMessage" + body = { + "channel": f"{channel_id}", + "text": f"Someone just completed the task {task.title} :kirby_dance:", + } + headers = {"Authorization": f"Bearer {api_token}"} + + requests.post(url, json=body, headers=headers) + return Response(status=204, mimetype="application/json") From 435a6e4911f8271d5ecbb7811eaad1941a42cc3e Mon Sep 17 00:00:00 2001 From: Brian Martinez <100006298+bamart-dev@users.noreply.github.com> Date: Wed, 7 May 2025 21:06:11 -0700 Subject: [PATCH 16/29] modify blueprint registration --- app/__init__.py | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/app/__init__.py b/app/__init__.py index 5c0ea4b64..d7322044b 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 -from .routes.task_routes import bp +from .routes.task_routes import bp as task_bp +from .routes.goal_routes import bp as goal_bp from .models import task, goal import os @@ -20,5 +21,7 @@ def create_app(config=None): migrate.init_app(app, db) # Register Blueprints here - app.register_blueprint(bp) + app.register_blueprint(task_bp) + app.register_blueprint(goal_bp) + return app From 345e4aadb435e25b2d75543e60164972c421514d Mon Sep 17 00:00:00 2001 From: Brian Martinez <100006298+bamart-dev@users.noreply.github.com> Date: Wed, 7 May 2025 21:23:17 -0700 Subject: [PATCH 17/29] update create_model and validate_model --- app/routes/route_utilities.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/app/routes/route_utilities.py b/app/routes/route_utilities.py index a0a491afd..8892ddc3d 100644 --- a/app/routes/route_utilities.py +++ b/app/routes/route_utilities.py @@ -19,7 +19,7 @@ def validate_model(cls, model_id): model = db.session.scalar(query) if not model: - message = {"error": f"{cls.__name__} ID ({model_id}) not found."} + message = {"message": f"{cls.__name__} ID ({model_id}) not found."} abort(make_response(message, 404)) return model @@ -40,8 +40,9 @@ def create_model(cls, model_info): db.session.add(model) db.session.commit() + model_name = cls.__name__.lower() - return {"task": model.to_dict()}, 201 + return {f"{model_name}": model.to_dict()}, 201 def get_all_models(cls): From d316d44088165f87f8852fa9598be01952b8ac5b Mon Sep 17 00:00:00 2001 From: Brian Martinez <100006298+bamart-dev@users.noreply.github.com> Date: Wed, 7 May 2025 21:39:07 -0700 Subject: [PATCH 18/29] update assert statements in 'not found' tests --- tests/test_wave_01.py | 6 +++--- tests/test_wave_03.py | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/tests/test_wave_01.py b/tests/test_wave_01.py index d36153101..73e36c4d0 100644 --- a/tests/test_wave_01.py +++ b/tests/test_wave_01.py @@ -64,7 +64,7 @@ def test_get_task_not_found(client): # ***************************************************************** # **Complete test with assertion about response body*************** # ***************************************************************** - assert response_body == {"error": "Task ID (1) not found."} + assert response_body == {"message": "Task ID (1) not found."} # @pytest.mark.skip(reason="No way to test this feature yet") @@ -131,7 +131,7 @@ def test_update_task_not_found(client): # ***************************************************************** # **Complete test with assertion about response body*************** # ***************************************************************** - assert response_body == {"error": "Task ID (1) not found."} + assert response_body == {"message": "Task ID (1) not found."} # @pytest.mark.skip(reason="No way to test this feature yet") @@ -158,7 +158,7 @@ def test_delete_task_not_found(client): # ***************************************************************** # **Complete test with assertion about response body*************** # ***************************************************************** - assert response_body == {"error": "Task ID (1) not found."} + assert response_body == {"message": "Task ID (1) not found."} assert db.session.scalars(db.select(Task)).all() == [] diff --git a/tests/test_wave_03.py b/tests/test_wave_03.py index 2c3e2cce5..29fabefb6 100644 --- a/tests/test_wave_03.py +++ b/tests/test_wave_03.py @@ -99,7 +99,7 @@ def test_mark_complete_missing_task(client): # **Complete test with assertion about response body*************** # ***************************************************************** assert response_body == { - "error": "Task ID (1) not found.", + "message": "Task ID (1) not found.", } # @pytest.mark.skip(reason="No way to test this feature yet") @@ -115,5 +115,5 @@ def test_mark_incomplete_missing_task(client): # **Complete test with assertion about response body*************** # ***************************************************************** assert response_body == { - "error": "Task ID (1) not found.", + "message": "Task ID (1) not found.", } From cec9e2ed55bf4a02f136456694d1df917e2ae141 Mon Sep 17 00:00:00 2001 From: Brian Martinez <100006298+bamart-dev@users.noreply.github.com> Date: Wed, 7 May 2025 21:47:24 -0700 Subject: [PATCH 19/29] implement Goal model --- app/models/goal.py | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/app/models/goal.py b/app/models/goal.py index 44282656b..ac6e77e30 100644 --- a/app/models/goal.py +++ b/app/models/goal.py @@ -3,3 +3,28 @@ class Goal(db.Model): id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True) + title: Mapped[str] + + + def to_dict(self): + """Return object attributes in dictionary format. + + Returns a dictionary containing key value pairs corresponding + to the Goal object's attributes. + """ + return { + "id": self.id, + "title": self.title, + } + + + @classmethod + def create_from_dict(cls, goal_data): + """Create new goal from dictionary. + + Instantiates and returns a new Goal object with attributes + derived from the provided dictionary. + """ + return cls( + title = goal_data["title"], + ) From 7da4902f6e9c4af42b0d4e376c2079a7230a662b Mon Sep 17 00:00:00 2001 From: Brian Martinez <100006298+bamart-dev@users.noreply.github.com> Date: Wed, 7 May 2025 21:51:10 -0700 Subject: [PATCH 20/29] implemented routes --- app/routes/goal_routes.py | 51 ++++++++++++++++++++++++++++++++++++++- 1 file changed, 50 insertions(+), 1 deletion(-) diff --git a/app/routes/goal_routes.py b/app/routes/goal_routes.py index 3aae38d49..062309dc1 100644 --- a/app/routes/goal_routes.py +++ b/app/routes/goal_routes.py @@ -1 +1,50 @@ -from flask import Blueprint \ No newline at end of file +from flask import Blueprint, request, Response, abort, make_response +from .route_utilities import validate_model, create_model, get_all_models +from app.db import db +from app.models.goal import Goal + +bp = Blueprint("goal_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(): + return get_all_models(Goal) + + +@bp.get("/") +def get_one_goal(goal_id): + goal = validate_model(Goal, goal_id) + + return {"goal": goal.to_dict()} + + +@bp.put("/") +def update_goal(goal_id): + goal = validate_model(Goal, goal_id) + request_body = request.get_json() + try: + goal.title = request_body["title"] + except KeyError as e: + response = {"details": f"Invalid request: missing {e.args[0]}"} + abort(make_response(response, 400)) + + db.session.commit() + + 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") From 1d91331a17598fc6aea8ab3cd2c61f45ef43f49e Mon Sep 17 00:00:00 2001 From: Brian Martinez <100006298+bamart-dev@users.noreply.github.com> Date: Wed, 7 May 2025 21:52:38 -0700 Subject: [PATCH 21/29] implemented Goal model and ran flask migration/upgrade --- migrations/versions/a2a0c4644ee9_.py | 32 ++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 migrations/versions/a2a0c4644ee9_.py diff --git a/migrations/versions/a2a0c4644ee9_.py b/migrations/versions/a2a0c4644ee9_.py new file mode 100644 index 000000000..95528e563 --- /dev/null +++ b/migrations/versions/a2a0c4644ee9_.py @@ -0,0 +1,32 @@ +"""empty message + +Revision ID: a2a0c4644ee9 +Revises: 4f59200e1074 +Create Date: 2025-05-07 19:36:21.626008 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'a2a0c4644ee9' +down_revision = '4f59200e1074' +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 8f5d8e3dd57116cb84132d8f524afd7d397a085a Mon Sep 17 00:00:00 2001 From: Brian Martinez <100006298+bamart-dev@users.noreply.github.com> Date: Wed, 7 May 2025 21:55:27 -0700 Subject: [PATCH 22/29] unskipped and ran wave 5 tests; all tests passed (Wave 5 complete) --- tests/test_wave_05.py | 63 ++++++++++++++++++++++--------------------- 1 file changed, 32 insertions(+), 31 deletions(-) diff --git a/tests/test_wave_05.py b/tests/test_wave_05.py index 222d10cf0..054f519d8 100644 --- a/tests/test_wave_05.py +++ b/tests/test_wave_05.py @@ -1,7 +1,9 @@ +from app.models.goal import Goal +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_get_goals_no_saved_goals(client): # Act response = client.get("/goals") @@ -12,7 +14,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 +31,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") @@ -46,22 +48,20 @@ 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 # ---- Complete Test ---- - # assertion 1 goes here - # assertion 2 goes here + assert response.status_code == 404 + assert response_body == {"message": "Goal ID (1) not found."} # ---- 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,34 +80,37 @@ 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 - # ---- Complete Act Here ---- - + response = client.put("/goals/1", json={ + "title": "Updated Goal Title", + }) + query = db.select(Goal).where(Goal.id == 1) + goal = db.session.scalar(query) # Assert # ---- Complete Assertions Here ---- - # assertion 1 goes here - # assertion 2 goes here - # assertion 3 goes here + assert response.status_code == 204 + assert goal.title == "Updated Goal Title" # ---- 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 - # ---- 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 response_body == {"message": "Goal ID (1) not found."} # ---- 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") @@ -122,27 +125,25 @@ 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 response_body == {"message": "Goal ID (1) not found."} - -@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") - # 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 response_body == {"message": "Goal ID (1) not found."} # ---- 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 cec2e65bca88eabe3937767faccace3d0bfc3ea5 Mon Sep 17 00:00:00 2001 From: Brian Martinez <100006298+bamart-dev@users.noreply.github.com> Date: Thu, 8 May 2025 14:47:58 -0700 Subject: [PATCH 23/29] refactor goal and task models to establish relationship; ran flask db migration/upgrade --- app/models/goal.py | 6 ++++- app/models/task.py | 9 ++++++-- migrations/versions/aa86ae04e6c5_.py | 34 ++++++++++++++++++++++++++++ 3 files changed, 46 insertions(+), 3 deletions(-) create mode 100644 migrations/versions/aa86ae04e6c5_.py diff --git a/app/models/goal.py b/app/models/goal.py index ac6e77e30..d7223072e 100644 --- a/app/models/goal.py +++ b/app/models/goal.py @@ -1,9 +1,13 @@ -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") def to_dict(self): diff --git a/app/models/task.py b/app/models/task.py index e6e5a33bb..eb9441b19 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -1,12 +1,17 @@ -from typing import Optional -from sqlalchemy.orm import Mapped, mapped_column +from sqlalchemy.orm import Mapped, mapped_column, relationship +from sqlalchemy import ForeignKey from datetime import datetime from ..db import db +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] + goal_id: Mapped[Optional[int]] = mapped_column(ForeignKey("goal.id")) + goal: Mapped[Optional["Goal"]] = relationship(back_populates="tasks") completed_at: Mapped[Optional[datetime]] def to_dict(self): diff --git a/migrations/versions/aa86ae04e6c5_.py b/migrations/versions/aa86ae04e6c5_.py new file mode 100644 index 000000000..1f7c26dc9 --- /dev/null +++ b/migrations/versions/aa86ae04e6c5_.py @@ -0,0 +1,34 @@ +"""empty message + +Revision ID: aa86ae04e6c5 +Revises: a2a0c4644ee9 +Create Date: 2025-05-08 14:46:32.732682 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'aa86ae04e6c5' +down_revision = 'a2a0c4644ee9' +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 bf6c459f7bcfff64e1ad03d876f71b0aea2a97fd Mon Sep 17 00:00:00 2001 From: Brian Martinez <100006298+bamart-dev@users.noreply.github.com> Date: Thu, 8 May 2025 23:05:13 -0700 Subject: [PATCH 24/29] implemented add_tasks_to_goal and get_tasks_by_goal routes --- app/routes/goal_routes.py | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/app/routes/goal_routes.py b/app/routes/goal_routes.py index 062309dc1..83bda92d6 100644 --- a/app/routes/goal_routes.py +++ b/app/routes/goal_routes.py @@ -2,6 +2,7 @@ from .route_utilities import validate_model, create_model, get_all_models from app.db import db from app.models.goal import Goal +from app.models.task import Task bp = Blueprint("goal_bp", __name__, url_prefix="/goals") @@ -13,6 +14,23 @@ def create_goal(): return create_model(Goal, request_body) +@bp.post("//tasks") +def add_tasks_to_goal(goal_id): + goal = validate_model(Goal, goal_id) + task_ids = request.get_json()["task_ids"] + task_list = [] + + for task_id in task_ids: + task = validate_model(Task, task_id) + task.goal_id = goal_id + task_list.append(task) + + goal.tasks = task_list + db.session.commit() + + return {"id": goal.id, "task_ids": task_ids} + + @bp.get("") def get_all_goals(): return get_all_models(Goal) @@ -25,6 +43,16 @@ def get_one_goal(goal_id): return {"goal": goal.to_dict()} +@bp.get("/tasks") +def get_tasks_by_goal(goal_id): + goal = validate_model(Goal, goal_id) + goal_tasks = goal.to_dict() + + goal_tasks["tasks"] = [task.to_dict() for task in goal.tasks] + + return goal_tasks + + @bp.put("/") def update_goal(goal_id): goal = validate_model(Goal, goal_id) From f45898aaedb22926cdabe92579266b4e8970aae8 Mon Sep 17 00:00:00 2001 From: Brian Martinez <100006298+bamart-dev@users.noreply.github.com> Date: Thu, 8 May 2025 23:30:20 -0700 Subject: [PATCH 25/29] add comment --- app/models/task.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/app/models/task.py b/app/models/task.py index eb9441b19..57398f3c6 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -20,12 +20,16 @@ def to_dict(self): When called on a Task object, the method returns a dictionary containing key value pairs corresponding to the object's attributes. """ - return { + task = { "id": self.id, "title": self.title, "description": self.description, "is_complete": bool(self.completed_at), } + if self.goal_id: # adds "goal_id" field if goal_id exists + task["goal_id"] = self.goal_id + + return task @classmethod From 6ac392dac7434235e63686e3bb1f84450a05b33e Mon Sep 17 00:00:00 2001 From: Brian Martinez <100006298+bamart-dev@users.noreply.github.com> Date: Thu, 8 May 2025 23:31:21 -0700 Subject: [PATCH 26/29] unskipped and ran all wave 6 tests; all tests passed (Wave 6 complete) --- tests/test_wave_06.py | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/tests/test_wave_06.py b/tests/test_wave_06.py index 0317f835a..1298df99b 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,12 @@ def test_get_tasks_for_specific_goal_no_goal(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 == {"message": "Goal ID (1) not found."} - -@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 +75,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 +100,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() From 1045e755cd0166f0b4aa2343b72a8a7e8fb438e2 Mon Sep 17 00:00:00 2001 From: Brian Martinez <100006298+bamart-dev@users.noreply.github.com> Date: Fri, 9 May 2025 01:10:03 -0700 Subject: [PATCH 27/29] add strict_slashes flag to goal/task routes --- app/routes/goal_routes.py | 14 +++++++------- app/routes/task_routes.py | 14 +++++++------- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/app/routes/goal_routes.py b/app/routes/goal_routes.py index 83bda92d6..2a4bfce06 100644 --- a/app/routes/goal_routes.py +++ b/app/routes/goal_routes.py @@ -7,14 +7,14 @@ bp = Blueprint("goal_bp", __name__, url_prefix="/goals") -@bp.post("") +@bp.post("", strict_slashes=False) def create_goal(): request_body = request.get_json() return create_model(Goal, request_body) -@bp.post("//tasks") +@bp.post("//tasks", strict_slashes=False) def add_tasks_to_goal(goal_id): goal = validate_model(Goal, goal_id) task_ids = request.get_json()["task_ids"] @@ -31,19 +31,19 @@ def add_tasks_to_goal(goal_id): return {"id": goal.id, "task_ids": task_ids} -@bp.get("") +@bp.get("", strict_slashes=False) def get_all_goals(): return get_all_models(Goal) -@bp.get("/") +@bp.get("/", strict_slashes=False) def get_one_goal(goal_id): goal = validate_model(Goal, goal_id) return {"goal": goal.to_dict()} -@bp.get("/tasks") +@bp.get("/tasks", strict_slashes=False) def get_tasks_by_goal(goal_id): goal = validate_model(Goal, goal_id) goal_tasks = goal.to_dict() @@ -53,7 +53,7 @@ def get_tasks_by_goal(goal_id): return goal_tasks -@bp.put("/") +@bp.put("/", strict_slashes=False) def update_goal(goal_id): goal = validate_model(Goal, goal_id) request_body = request.get_json() @@ -68,7 +68,7 @@ def update_goal(goal_id): return Response(status=204, mimetype="application/json") -@bp.delete("/") +@bp.delete("/", strict_slashes=False) def delete_goal(goal_id): goal = validate_model(Goal, goal_id) diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index d10aebff9..81e305712 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -9,26 +9,26 @@ bp = Blueprint("task_bp", __name__, url_prefix="/tasks") -@bp.post("") +@bp.post("", strict_slashes=False) def create_task(): request_body = request.get_json() return create_model(Task, request_body) -@bp.get("") +@bp.get("", strict_slashes=False) def get_all_tasks(): return get_all_models(Task) -@bp.get("/") +@bp.get("/", strict_slashes=False) def get_one_task(task_id): task = validate_model(Task, task_id) return {"task": task.to_dict()} -@bp.put("/") +@bp.put("/", strict_slashes=False) def update_task(task_id): task = validate_model(Task, task_id) request_body = request.get_json() @@ -45,7 +45,7 @@ def update_task(task_id): return Response(status=204, mimetype="application/json") -@bp.patch("//mark_complete") +@bp.patch("//mark_complete", strict_slashes=False) def mark_task_complete(task_id): task = validate_model(Task, task_id) @@ -66,7 +66,7 @@ def mark_task_complete(task_id): return Response(status=204, mimetype="application/json") -@bp.patch("//mark_incomplete") +@bp.patch("//mark_incomplete", strict_slashes=False) def mark_task_incomplete(task_id): task = validate_model(Task, task_id) @@ -76,7 +76,7 @@ def mark_task_incomplete(task_id): return Response(status=204, mimetype="application/json") -@bp.delete("/") +@bp.delete("/", strict_slashes=False) def delete_task(task_id): task = validate_model(Task, task_id) From 45b2aa45a524a3c347fd96a476ce7d8f8cc219c6 Mon Sep 17 00:00:00 2001 From: Brian Martinez <100006298+bamart-dev@users.noreply.github.com> Date: Wed, 18 Jun 2025 18:40:13 -0700 Subject: [PATCH 28/29] refactor __init__.py to include flask-cors --- app/__init__.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/app/__init__.py b/app/__init__.py index d7322044b..f8d5a9b76 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,4 +1,5 @@ from flask import Flask +from flask_cors import CORS from .db import db, migrate from .models import task from .routes.task_routes import bp as task_bp @@ -8,9 +9,11 @@ def create_app(config=None): app = Flask(__name__) + CORS(app) app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get('SQLALCHEMY_DATABASE_URI') + app.config['CORS_HEADERS'] = 'Content-Type' if config: # Merge `config` into the app's configuration From 5676ff09ab764eadd25d07c885805a3d3c940ffa Mon Sep 17 00:00:00 2001 From: "Brian M." <100006298+bamart-dev@users.noreply.github.com> Date: Wed, 18 Jun 2025 18:47:16 -0700 Subject: [PATCH 29/29] Create env-example --- env-example | 1 + 1 file changed, 1 insertion(+) create mode 100644 env-example diff --git a/env-example b/env-example new file mode 100644 index 000000000..2c37da55e --- /dev/null +++ b/env-example @@ -0,0 +1 @@ +SQLALCHEMY_DATABASE_URI=postgresql+psycopg2://postgres:postgres@localhost:5432/task_list_api_development