From b9c4b87784dbdcb291f8c7b48539bee8ad114b94 Mon Sep 17 00:00:00 2001 From: Madina-j Date: Thu, 31 Oct 2024 13:37:44 -0700 Subject: [PATCH 1/8] project set up --- 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 45791b31e26f2193a08b997cf8623e9038381b3f Mon Sep 17 00:00:00 2001 From: Madina-j Date: Fri, 1 Nov 2024 15:10:36 -0700 Subject: [PATCH 2/8] add task model, create a db _development and _test, migrated model, uprgated db --- app/models/task.py | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/app/models/task.py b/app/models/task.py index 5d99666a4..f6ef7db15 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -1,5 +1,12 @@ from sqlalchemy.orm import Mapped, mapped_column from ..db import db +from datetime import datetime +from typing import Optional class Task(db.Model): id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True) + title: Mapped[str] + description: Mapped[str] + completed_at: Mapped[Optional[datetime]] + + From 99363f756da7bb5dfc931167fa0a1538efe4c923 Mon Sep 17 00:00:00 2001 From: Madina-j Date: Tue, 5 Nov 2024 12:46:49 -0800 Subject: [PATCH 3/8] Wave1 and tests are completed --- app/routes/__init__.py | 0 app/routes/task_routes.py | 112 +++++++++++++++++++++++++++++++++++++- tests/test_wave_01.py | 35 ++++++------ 3 files changed, 129 insertions(+), 18 deletions(-) create mode 100644 app/routes/__init__.py diff --git a/app/routes/__init__.py b/app/routes/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index 3aae38d49..42b9c7367 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -1 +1,111 @@ -from flask import Blueprint \ No newline at end of file +from flask import Blueprint, abort, make_response, request, Response +from app.models.task import Task +from datetime import datetime +from ..db import db + +tasks_bp = Blueprint("tasks_bp", __name__, url_prefix="/tasks") + +@tasks_bp.post("") +def create_task(): + request_body = request.get_json() + + if "title" not in request_body: + return {"details": "Invalid data"}, 400 + if "description" not in request_body: + return {"details": "Invalid data"}, 400 + + title = request_body["title"] + description = request_body["description"] + completed_at= request_body.get("completed_at") + + new_task = Task(title=title, description=description, completed_at= None if completed_at is None else datetime.fromisoformat(completed_at) + ) + db.session.add(new_task) + db.session.commit() + + + response = { "task" : { + "id": new_task.id, + "title": new_task.title, + "description": new_task.description, + "is_complete": new_task.completed_at is not None + } + } + return response, 201 + +@tasks_bp.get("") +def get_all_tasks(): + query = db.select(Task).order_by(Task.id) + tasks = db.session.scalars(query) + + tasks_response = [] + for task in tasks: + tasks_response.append( + { + "id": task.id, + "title": task.title, + "description": task.description, + "is_complete": task.completed_at is not None + } + ) + return tasks_response, 200 + +@tasks_bp.get("/") +def get_one_task(task_id): + task = validate_task(task_id) + + return { "task" : { + "id": task.id, + "title": task.title, + "description": task.description, + "is_complete": task.completed_at is not None + } + } + +def validate_task(task_id): + try: + task_id = int(task_id) + except: + response = {"message": f"task {task_id} invalid"} + abort(make_response(response , 400)) + + query = db.select(Task).where(Task.id == task_id) + task = db.session.scalar(query) + + if not task: + response = {"message": f"task {task_id} not found"} + abort(make_response(response, 404)) + return task + +@tasks_bp.put("/") +def update_task(task_id): + task = validate_task(task_id) + request_body = request.get_json() + + task.title = request_body["title"] + task.description = request_body["description"] + task.completed_at= request_body.get("completed_at") + db.session.commit() + + + response = { "task" : { + "id": task.id, + "title": task.title, + "description": task.description, + "is_complete": task.completed_at is not None + } + } + return response, 200 + +@tasks_bp.delete("/") +def delete_task(task_id): + task = validate_task(task_id) + + db.session.delete(task) + db.session.commit() + + response = { + "details": f"Task {task.id} \"{task.title}\" successfully deleted" + } + + return response, 200 \ No newline at end of file diff --git a/tests/test_wave_01.py b/tests/test_wave_01.py index dca626d78..58cd9c2ca 100644 --- a/tests/test_wave_01.py +++ b/tests/test_wave_01.py @@ -2,7 +2,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") @@ -13,7 +13,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") @@ -32,7 +32,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") @@ -51,7 +51,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") @@ -59,14 +59,14 @@ def test_get_task_not_found(client): # Assert assert response.status_code == 404 - - raise Exception("Complete test with assertion about response body") + assert response_body == {"message": f"task 1 not found"} + # raise Exception("Complete test with assertion about response body") # ***************************************************************** # **Complete test with assertion about response body*************** # ***************************************************************** -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_create_task(client): # Act response = client.post("/tasks", json={ @@ -93,7 +93,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={ @@ -119,7 +119,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={ @@ -130,14 +130,14 @@ def test_update_task_not_found(client): # Assert assert response.status_code == 404 - - raise Exception("Complete test with assertion about response body") + assert response_body == {"message": f"task 1 not found"} + # raise Exception("Complete test with assertion about response body") # ***************************************************************** # **Complete test with assertion about response body*************** # ***************************************************************** -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_delete_task(client, one_task): # Act response = client.delete("/tasks/1") @@ -146,13 +146,14 @@ def test_delete_task(client, one_task): # Assert assert response.status_code == 200 assert "details" in response_body + assert response_body == { "details": 'Task 1 "Go on my daily walk 🏞" successfully deleted' } assert Task.query.get(1) == 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") @@ -160,8 +161,8 @@ def test_delete_task_not_found(client): # Assert assert response.status_code == 404 - - raise Exception("Complete test with assertion about response body") + assert response_body == {"message": f"task 1 not found"} + # raise Exception("Complete test with assertion about response body") # ***************************************************************** # **Complete test with assertion about response body*************** # ***************************************************************** @@ -169,7 +170,7 @@ def test_delete_task_not_found(client): assert Task.query.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={ @@ -186,7 +187,7 @@ def test_create_task_must_contain_title(client): assert Task.query.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 2fe95e334aad324b161d64c8e5f8d129468c21d3 Mon Sep 17 00:00:00 2001 From: Madina-j Date: Tue, 5 Nov 2024 13:34:52 -0800 Subject: [PATCH 4/8] Wave 2 implemented --- app/__init__.py | 3 ++ app/routes/task_routes.py | 12 +++++- .../versions/77f3031e9921_add_task_model.py | 39 +++++++++++++++++++ tests/test_wave_02.py | 4 +- 4 files changed, 54 insertions(+), 4 deletions(-) create mode 100644 migrations/versions/77f3031e9921_add_task_model.py diff --git a/app/__init__.py b/app/__init__.py index 3c581ceeb..2571f80a5 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): @@ -19,4 +20,6 @@ def create_app(config=None): # Register Blueprints here + app.register_blueprint(tasks_bp) + return app diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index 42b9c7367..7fd632618 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -35,7 +35,15 @@ def create_task(): @tasks_bp.get("") def get_all_tasks(): - query = db.select(Task).order_by(Task.id) + sort_order = request.args.get("sort") + + if sort_order == "asc": + query = db.select(Task).order_by(Task.title.asc()) + elif sort_order == "desc": + query = db.select(Task).order_by(Task.title.desc()) + else: + query = db.select(Task).order_by(Task.id) + tasks = db.session.scalars(query) tasks_response = [] @@ -108,4 +116,4 @@ def delete_task(task_id): "details": f"Task {task.id} \"{task.title}\" successfully deleted" } - return response, 200 \ No newline at end of file + return response, 200 diff --git a/migrations/versions/77f3031e9921_add_task_model.py b/migrations/versions/77f3031e9921_add_task_model.py new file mode 100644 index 000000000..790984020 --- /dev/null +++ b/migrations/versions/77f3031e9921_add_task_model.py @@ -0,0 +1,39 @@ +"""add task model + +Revision ID: 77f3031e9921 +Revises: +Create Date: 2024-11-01 14:08:24.325563 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '77f3031e9921' +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 ### 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 51b33df418737eafb31b44f26f6e433ed950ffa6 Mon Sep 17 00:00:00 2001 From: Madina-j Date: Wed, 6 Nov 2024 17:04:34 -0800 Subject: [PATCH 5/8] Wave3 and Tests completed --- app/routes/task_routes.py | 32 +++++++++++++++++++++++++++++++- tests/test_wave_03.py | 20 ++++++++++---------- 2 files changed, 41 insertions(+), 11 deletions(-) diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index 7fd632618..e29b84b8a 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -18,7 +18,7 @@ def create_task(): description = request_body["description"] completed_at= request_body.get("completed_at") - new_task = Task(title=title, description=description, completed_at= None if completed_at is None else datetime.fromisoformat(completed_at) + new_task = Task(title=title, description=description, completed_at= None if completed_at is None else datetime.datetime(completed_at) ) db.session.add(new_task) db.session.commit() @@ -117,3 +117,33 @@ def delete_task(task_id): } return response, 200 + +@tasks_bp.patch("//mark_complete") +def update_task_to_complete(task_id): + task = validate_task(task_id) + task.completed_at = datetime.now() + db.session.commit() + + response_body = { "task": { + "id": task.id, + "title": task.title, + "description": task.description, + "is_complete": task.completed_at is not None + } + } + return response_body, 200 + +@tasks_bp.patch("//mark_incomplete") +def update_task_to_incomplete(task_id): + task = validate_task(task_id) + task.completed_at = None + db.session.commit() + + response_body = { "task": { + "id": task.id, + "title": task.title, + "description": task.description, + "is_complete": task.completed_at is not None + } + } + return response_body, 200 \ No newline at end of file diff --git a/tests/test_wave_03.py b/tests/test_wave_03.py index 32d379822..a5de27aba 100644 --- a/tests/test_wave_03.py +++ b/tests/test_wave_03.py @@ -5,7 +5,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 """ @@ -42,7 +42,7 @@ def test_mark_complete_on_incomplete_task(client, one_task): assert Task.query.get(1).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") @@ -62,7 +62,7 @@ def test_mark_incomplete_on_complete_task(client, completed_task): assert Task.query.get(1).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 """ @@ -99,7 +99,7 @@ def test_mark_complete_on_completed_task(client, completed_task): assert Task.query.get(1).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") @@ -119,7 +119,7 @@ def test_mark_incomplete_on_incomplete_task(client, one_task): assert Task.query.get(1).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") @@ -127,14 +127,14 @@ def test_mark_complete_missing_task(client): # Assert assert response.status_code == 404 - - raise Exception("Complete test with assertion about response body") + assert response_body == {"message": f"task 1 not found"} + # raise Exception("Complete test with assertion about response body") # ***************************************************************** # **Complete test with assertion about response body*************** # ***************************************************************** -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_mark_incomplete_missing_task(client): # Act response = client.patch("/tasks/1/mark_incomplete") @@ -142,8 +142,8 @@ def test_mark_incomplete_missing_task(client): # Assert assert response.status_code == 404 - - raise Exception("Complete test with assertion about response body") + assert response_body == {"message": f"task 1 not found"} + # raise Exception("Complete test with assertion about response body") # ***************************************************************** # **Complete test with assertion about response body*************** # ***************************************************************** From e4ce4fa54df998cd5a1df864f20b2b69d0ec37ae Mon Sep 17 00:00:00 2001 From: Madina-j Date: Thu, 7 Nov 2024 14:47:01 -0800 Subject: [PATCH 6/8] Wave 4 completed --- app/__init__.py | 1 + app/routes/task_routes.py | 19 ++++++++++++++++--- 2 files changed, 17 insertions(+), 3 deletions(-) diff --git a/app/__init__.py b/app/__init__.py index 2571f80a5..c3c2aa712 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -9,6 +9,7 @@ def create_app(config=None): app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get('SQLALCHEMY_DATABASE_URI') + # app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get('SLACK_API_TOKEN') if config: # Merge `config` into the app's configuration diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index e29b84b8a..98a11ace4 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -2,6 +2,8 @@ from app.models.task import Task from datetime import datetime from ..db import db +import requests +import os tasks_bp = Blueprint("tasks_bp", __name__, url_prefix="/tasks") @@ -123,15 +125,26 @@ def update_task_to_complete(task_id): task = validate_task(task_id) task.completed_at = datetime.now() db.session.commit() + token = os.environ.get('SLACK_API_TOKEN') + headers = { + "Authorization": f"Bearer {token}" + } + url = "https://slack.com/api/chat.postMessage" - response_body = { "task": { + message = {"channel": "D07V10LPBM4", + "text": f"Someone just completed the task {task.title}"} + + response = requests.post(url, headers=headers, data=message) + + print(response.text) + response = { "task": { "id": task.id, "title": task.title, "description": task.description, "is_complete": task.completed_at is not None } } - return response_body, 200 + return response, 200 @tasks_bp.patch("//mark_incomplete") def update_task_to_incomplete(task_id): @@ -146,4 +159,4 @@ def update_task_to_incomplete(task_id): "is_complete": task.completed_at is not None } } - return response_body, 200 \ No newline at end of file + return response_body, 200 From a16c0c29254757e32034b55be55f4a30afa6d55a Mon Sep 17 00:00:00 2001 From: Madina-j Date: Thu, 7 Nov 2024 19:29:16 -0800 Subject: [PATCH 7/8] Wave 5 compete --- app/__init__.py | 2 + app/models/goal.py | 2 + app/routes/goal_routes.py | 100 ++++++++++++++++++++++++++- migrations/versions/251ac0f157f8_.py | 32 +++++++++ tests/test_wave_05.py | 81 +++++++++++++--------- 5 files changed, 185 insertions(+), 32 deletions(-) create mode 100644 migrations/versions/251ac0f157f8_.py diff --git a/app/__init__.py b/app/__init__.py index c3c2aa712..97e086401 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): @@ -22,5 +23,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..427d49b37 100644 --- a/app/models/goal.py +++ b/app/models/goal.py @@ -3,3 +3,5 @@ class Goal(db.Model): id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True) + title: Mapped[str] + \ No newline at end of file diff --git a/app/routes/goal_routes.py b/app/routes/goal_routes.py index 3aae38d49..9d5206c95 100644 --- a/app/routes/goal_routes.py +++ b/app/routes/goal_routes.py @@ -1 +1,99 @@ -from flask import Blueprint \ No newline at end of file +from flask import Blueprint, abort, make_response, request, Response +from app.models.goal import Goal +from datetime import datetime +from ..db import db + +goals_bp = Blueprint("goals_bp", __name__, url_prefix="/goals") + +@goals_bp.post("") +def create_goal(): + request_body = request.get_json() + + if "title" not in request_body: + return {"details": "Invalid data"}, 400 + + title = request_body["title"] + + + new_goal = Goal(title=title) + db.session.add(new_goal) + db.session.commit() + + + response = { "goal" : { + "id": new_goal.id, + "title": new_goal.title + } + } + return response, 201 + +@goals_bp.get("") +def get_all_goals(): + query = db.select(Goal) + goals = db.session.scalars(query) + + goals_response = [] + for goal in goals: + goals_response.append( + { + "id": goal.id, + "title": goal.title + } + ) + return goals_response, 200 + +@goals_bp.get("/") +def get_one_goal(goal_id): + goal = validate_goal(goal_id) + + return { "goal" : { + "id": goal.id, + "title": goal.title + } + } + +def validate_goal(goal_id): + try: + goal_id = int(goal_id) + except: + response = {"message": f"goal {goal_id} invalid"} + abort(make_response(response , 400)) + + query = db.select(Goal).where(Goal.id == goal_id) + goal = db.session.scalar(query) + + if not goal: + response = {"message": f"goal {goal_id} not found"} + abort(make_response(response, 404)) + return goal + + +@goals_bp.put("/") +def update_goal(goal_id): + goal = validate_goal(goal_id) + request_body = request.get_json() + + goal.title = request_body["title"] + db.session.commit() + + + response = { "goal" : { + "id": goal.id, + "title": goal.title + } + } + return response, 200 + + +@goals_bp.delete("/") +def delete_goal(goal_id): + goal = validate_goal(goal_id) + + db.session.delete(goal) + db.session.commit() + + response = { + "details": f"Goal {goal.id} \"{goal.title}\" successfully deleted" + } + + return response, 200 \ No newline at end of file diff --git a/migrations/versions/251ac0f157f8_.py b/migrations/versions/251ac0f157f8_.py new file mode 100644 index 000000000..e53491f18 --- /dev/null +++ b/migrations/versions/251ac0f157f8_.py @@ -0,0 +1,32 @@ +"""empty message + +Revision ID: 251ac0f157f8 +Revises: 77f3031e9921 +Create Date: 2024-11-07 14:56:50.969636 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '251ac0f157f8' +down_revision = '77f3031e9921' +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 ### diff --git a/tests/test_wave_05.py b/tests/test_wave_05.py index aee7c52a1..209427a84 100644 --- a/tests/test_wave_05.py +++ b/tests/test_wave_05.py @@ -1,7 +1,7 @@ import pytest +from app.models.goal import 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_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") @@ -46,22 +46,24 @@ 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 - # ---- Complete Test ---- + assert response.status_code == 404 + assert response_body == {"message": f"goal 1 not found"} + # raise Exception("Complete test") + # # Assert + # # ---- Complete Test ---- + # # assertion 1 goes here + # # assertion 2 goes here + # # ---- 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 +82,48 @@ 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") + # raise Exception("Complete test") # Act + response = client.put("/goals/1", json={ + "title": "Updated Title", + }) + response_body = response.get_json() # ---- Complete Act Here ---- # Assert # ---- Complete Assertions Here ---- - # assertion 1 goes here - # assertion 2 goes here - # assertion 3 goes here + goal = Goal.query.get(1) + assert response.status_code == 200 + assert goal.title == "Updated Title" + assert "goal" in response_body + assert response_body == { + "goal": { + "id": 1, + "title": "Updated 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 + # raise Exception("Complete test") + response = client.put("/goals/1", json={ + "title": "Updated Title" + }) + response_body = response.get_json() # ---- Complete Act Here ---- # Assert # ---- Complete Assertions Here ---- - # assertion 1 goes here - # assertion 2 goes here + assert response.status_code == 404 + assert response_body == {"message": f"goal 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") @@ -123,28 +139,31 @@ def test_delete_goal(client, one_goal): # Check that the goal was deleted response = client.get("/goals/1") assert response.status_code == 404 - - raise Exception("Complete test with assertion about response body") + assert response_body == { + "details": "Goal 1 \"Build a habit of going outside daily\" successfully deleted" +} + # raise Exception("Complete test with assertion about response body") # ***************************************************************** # **Complete test with assertion about response body*************** # ***************************************************************** -@pytest.mark.skip(reason="test to be completed by student") +# @pytest.mark.skip(reason="test to be completed by student") def test_delete_goal_not_found(client): - raise Exception("Complete test") + # 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": f"goal 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 ec300a8050051b0713012c0db1cc1d145318a24c Mon Sep 17 00:00:00 2001 From: Madina-j Date: Fri, 8 Nov 2024 13:30:12 -0800 Subject: [PATCH 8/8] Wave 6 completed --- README.md | 4 +++ app/models/goal.py | 4 ++- app/models/task.py | 8 +++-- app/routes/goal_routes.py | 48 +++++++++++++++++++++++++++- app/routes/task_routes.py | 31 +++++++++++++----- migrations/versions/cbf4f7f9c046_.py | 34 ++++++++++++++++++++ tests/test_wave_06.py | 16 +++++----- 7 files changed, 124 insertions(+), 21 deletions(-) create mode 100644 migrations/versions/cbf4f7f9c046_.py diff --git a/README.md b/README.md index 85e1c0f69..736c528f6 100644 --- a/README.md +++ b/README.md @@ -55,3 +55,7 @@ This project is designed to fulfill the features described in detail in each wav 1. [Wave 6: Establishing a one-to-many relationship between two models](ada-project-docs/wave_06.md) 1. [Wave 7: Deployment](ada-project-docs/wave_07.md) 1. [Optional Enhancements](ada-project-docs/optional-enhancements.md) + + + + diff --git a/app/models/goal.py b/app/models/goal.py index 427d49b37..933188e22 100644 --- a/app/models/goal.py +++ b/app/models/goal.py @@ -1,7 +1,9 @@ -from sqlalchemy.orm import Mapped, mapped_column +from sqlalchemy.orm import Mapped, mapped_column, relationship from ..db import db 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") + \ No newline at end of file diff --git a/app/models/task.py b/app/models/task.py index f6ef7db15..a98912fba 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -1,12 +1,14 @@ -from sqlalchemy.orm import Mapped, mapped_column +from sqlalchemy.orm import Mapped, mapped_column, relationship from ..db import db from datetime import datetime from typing import Optional - +from sqlalchemy import ForeignKey class Task(db.Model): id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True) title: Mapped[str] description: Mapped[str] completed_at: Mapped[Optional[datetime]] + goal_id: Mapped[Optional[int]] = mapped_column(ForeignKey("goal.id")) + goal: Mapped[Optional["Goal"]] = relationship(back_populates="tasks") - + \ No newline at end of file diff --git a/app/routes/goal_routes.py b/app/routes/goal_routes.py index 9d5206c95..d9f47d705 100644 --- a/app/routes/goal_routes.py +++ b/app/routes/goal_routes.py @@ -1,7 +1,9 @@ from flask import Blueprint, abort, make_response, request, Response from app.models.goal import Goal +from app.models.task import Task from datetime import datetime from ..db import db +from .task_routes import validate_task goals_bp = Blueprint("goals_bp", __name__, url_prefix="/goals") @@ -96,4 +98,48 @@ def delete_goal(goal_id): "details": f"Goal {goal.id} \"{goal.title}\" successfully deleted" } - return response, 200 \ No newline at end of file + return response, 200 + + + +@goals_bp.post("//tasks") +def create_task_with_goal(goal_id): + goal = validate_goal(goal_id) + + request_data = request.get_json() + task_ids = request_data.get("task_ids") + + if not task_ids: + response = {"message": "No task_ids provided"} + abort(make_response(response, 400)) + + for task_id in task_ids: + task = validate_task(task_id) + task.goal = goal + + db.session.commit() + + response_body = { + "id": goal.id, + "task_ids": task_ids + } + return response_body, 200 + +@goals_bp.get("//tasks") +def get_tasks_of_goal(goal_id): + goal = validate_goal(goal_id) + + tasks = [{ + "id": task.id, + "goal_id": goal.id, + "title": task.title, + "description": task.description, + "is_complete": task.completed_at is not None + } for task in goal.tasks] + + response_body = {"id": goal.id, + "title": goal.title, + "tasks": tasks} + + return response_body, 200 + diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index 98a11ace4..b8facc876 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -1,16 +1,17 @@ from flask import Blueprint, abort, make_response, request, Response from app.models.task import Task +from app.models.goal import Goal from datetime import datetime from ..db import db import requests import os + tasks_bp = Blueprint("tasks_bp", __name__, url_prefix="/tasks") @tasks_bp.post("") def create_task(): request_body = request.get_json() - if "title" not in request_body: return {"details": "Invalid data"}, 400 if "description" not in request_body: @@ -53,6 +54,7 @@ def get_all_tasks(): tasks_response.append( { "id": task.id, + # "goal_id": task.goal_id is not None, "title": task.title, "description": task.description, "is_complete": task.completed_at is not None @@ -64,13 +66,25 @@ def get_all_tasks(): def get_one_task(task_id): task = validate_task(task_id) - return { "task" : { - "id": task.id, - "title": task.title, - "description": task.description, - "is_complete": task.completed_at is not None - } - } + if task.goal_id is not None: + return { + "task": { + "id": task.id, + "goal_id": task.goal_id, + "title": task.title, + "description": task.description, + "is_complete": task.completed_at is not None + } + } + else: + return { + "task": { + "id": task.id, + "title": task.title, + "description": task.description, + "is_complete": task.completed_at is not None + } + } def validate_task(task_id): try: @@ -95,6 +109,7 @@ def update_task(task_id): task.title = request_body["title"] task.description = request_body["description"] task.completed_at= request_body.get("completed_at") + # task.goal_id= request_body.get("goal_id") db.session.commit() diff --git a/migrations/versions/cbf4f7f9c046_.py b/migrations/versions/cbf4f7f9c046_.py new file mode 100644 index 000000000..e51137599 --- /dev/null +++ b/migrations/versions/cbf4f7f9c046_.py @@ -0,0 +1,34 @@ +"""empty message + +Revision ID: cbf4f7f9c046 +Revises: 251ac0f157f8 +Create Date: 2024-11-07 19:50:17.613446 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'cbf4f7f9c046' +down_revision = '251ac0f157f8' +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 ### diff --git a/tests/test_wave_06.py b/tests/test_wave_06.py index 8afa4325e..122b58463 100644 --- a/tests/test_wave_06.py +++ b/tests/test_wave_06.py @@ -2,7 +2,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={ @@ -23,7 +23,7 @@ def test_post_task_ids_to_goal(client, one_goal, three_tasks): assert len(Goal.query.get(1).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={ @@ -42,7 +42,7 @@ def test_post_task_ids_to_goal_already_with_goals(client, one_task_belongs_to_on assert len(Goal.query.get(1).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") @@ -50,14 +50,14 @@ 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") + assert response_body == {"message": "goal 1 not found"} + # raise Exception("Complete test with assertion about response body") # ***************************************************************** # **Complete test with assertion about response body*************** # ***************************************************************** -@pytest.mark.skip(reason="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") @@ -74,7 +74,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") @@ -99,7 +99,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()