From 589ee3e2b75581081577769d1fd83c39cd5e588e Mon Sep 17 00:00:00 2001 From: Tatyana Venanzi Date: Thu, 31 Oct 2024 13:54:07 -0700 Subject: [PATCH 1/9] initial 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 0317e7a02e530e2158e81c60360ed8aa2ec0be48 Mon Sep 17 00:00:00 2001 From: Tatyana Venanzi Date: Fri, 1 Nov 2024 16:21:16 -0700 Subject: [PATCH 2/9] added CRUD to task_routes.py file and ran all tests in wave 1 --- app/__init__.py | 2 + app/models/task.py | 12 +++ app/routes/task_routes.py | 115 ++++++++++++++++++++++++++- migrations/versions/c5c1e5da8e8d_.py | 39 +++++++++ requirements.txt | 4 + tests/test_wave_01.py | 44 +++++----- 6 files changed, 193 insertions(+), 23 deletions(-) create mode 100644 migrations/versions/c5c1e5da8e8d_.py diff --git a/app/__init__.py b/app/__init__.py index 3c581ceeb..b9b10a134 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,5 +1,6 @@ from flask import Flask from .db import db, migrate +from .routes.task_routes import tasks_bp from .models import task, goal import os @@ -18,5 +19,6 @@ def create_app(config=None): migrate.init_app(app, db) # Register Blueprints here + app.register_blueprint(tasks_bp) return app diff --git a/app/models/task.py b/app/models/task.py index 5d99666a4..1e383a32c 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -1,5 +1,17 @@ from sqlalchemy.orm import Mapped, mapped_column from ..db import db +from datetime import datetime class Task(db.Model): id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True) + title: Mapped[str] + description: Mapped[str] + completed_at: Mapped[datetime] = mapped_column(nullable=True, default=None) + + def task_dict(self): + return dict( + id=self.id, + title=self.title, + description=self.description, + completed_at=self.completed_at is not None + ) diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index 3aae38d49..a0eab028f 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -1 +1,114 @@ -from flask import Blueprint \ No newline at end of file +from flask import Blueprint, request, jsonify, make_response, abort +from app.models.task import Task +from ..db import db + +tasks_bp = Blueprint("tasks_bp", __name__, url_prefix="/tasks") + +def validate_task(task_id): + try: + task_id = int(task_id) + except: + abort(make_response({"message": f"Task {task_id} not found"}, 400)) + + task = Task.query.get(task_id) + if not task: + abort(make_response({"message": f"Task {task_id} not found"}, 404)) + return task + +# POST: Create a new task +@tasks_bp.post("") +def create_task(): + request_body = request.get_json() + + if "title" not in request_body or "description" not in request_body: + abort(make_response({"details": "Invalid data"}, 400)) + + new_task = Task( + title=request_body["title"], + description=request_body["description"], + completed_at=None + ) + db.session.add(new_task) + db.session.commit() + + return make_response({ + "task": { + "id": new_task.id, + "title": new_task.title, + "description": new_task.description, + "is_complete": False + } + }, 201) + +# GET all tasks +@tasks_bp.get("") +def get_all_tasks(): + tasks = Task.query.all() + 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 jsonify(tasks_response), 200 + +# GET one task +@tasks_bp.get("/") +def get_one_task(task_id): + task = validate_task(task_id) # Call validate_task + + return { + "task": { + "id": task.id, + "title": task.title, + "description": task.description, + "is_complete": task.completed_at is not None + } + }, 200 + + +# PUT: Update an existing task +@tasks_bp.put("/") +def update_task(task_id): + task = Task.query.get(task_id) + + if task is None: + abort(make_response({"message": f"Task {task_id} not found"}, 404)) + + request_body = request.get_json() + + if "title" not in request_body or "description" not in request_body: + abort(make_response({"details": "Invalid data"}, 400)) + + + task.title = request_body.get("title", task.title) + task.description = request_body.get("description", task.description) + + db.session.commit() + + return { + "task": { + "id": task.id, + "title": task.title, + "description": task.description, + "is_complete": task.completed_at is not None + } + }, 200 + +# DELETE: Delete a task +@tasks_bp.delete("/") +def delete_task(task_id): + task = validate_task(task_id) + + db.session.delete(task) + db.session.commit() + + return make_response({ + "details": f"Task {task_id} \"{task.title}\" successfully deleted" + }, 200) + + + diff --git a/migrations/versions/c5c1e5da8e8d_.py b/migrations/versions/c5c1e5da8e8d_.py new file mode 100644 index 000000000..5860a84d6 --- /dev/null +++ b/migrations/versions/c5c1e5da8e8d_.py @@ -0,0 +1,39 @@ +"""empty message + +Revision ID: c5c1e5da8e8d +Revises: +Create Date: 2024-10-31 14:22:04.207714 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'c5c1e5da8e8d' +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/requirements.txt b/requirements.txt index af8fc4cf4..c0d3e4f0f 100644 --- a/requirements.txt +++ b/requirements.txt @@ -3,12 +3,14 @@ blinker==1.7.0 certifi==2024.8.30 charset-normalizer==3.3.2 click==8.1.7 +exceptiongroup==1.2.2 Flask==3.0.2 Flask-Migrate==4.0.5 Flask-SQLAlchemy==3.1.1 greenlet==3.0.3 gunicorn==21.2.0 idna==3.10 +importlib_metadata==8.5.0 iniconfig==2.0.0 itsdangerous==2.1.2 Jinja2==3.1.3 @@ -21,6 +23,8 @@ pytest==8.0.0 python-dotenv==1.0.1 requests==2.32.3 SQLAlchemy==2.0.25 +tomli==2.0.2 typing_extensions==4.9.0 urllib3==2.2.3 Werkzeug==3.0.1 +zipp==3.20.2 diff --git a/tests/test_wave_01.py b/tests/test_wave_01.py index dca626d78..3162a89ef 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,11 @@ def test_get_task_not_found(client): # Assert assert response.status_code == 404 + assert response_body == { + "message": "Task 1 not found" + } - raise Exception("Complete test with assertion about response body") - # ***************************************************************** - # **Complete test with assertion about response body*************** - # ***************************************************************** - - -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_create_task(client): # Act response = client.post("/tasks", json={ @@ -93,7 +90,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 +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={ @@ -130,14 +127,14 @@ def test_update_task_not_found(client): # Assert assert response.status_code == 404 + assert response_body == { + "message": "Task 1 not found" + } - raise Exception("Complete test with assertion about response body") - # ***************************************************************** - # **Complete test with assertion about response body*************** - # ***************************************************************** -@pytest.mark.skip(reason="No way to test this feature yet") + +# @pytest.mark.skip(reason="No way to test this feature yet") def test_delete_task(client, one_task): # Act response = client.delete("/tasks/1") @@ -152,7 +149,7 @@ def test_delete_task(client, one_task): 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 +157,11 @@ def test_delete_task_not_found(client): # Assert assert response.status_code == 404 + assert response_body == { + "message": "Task 1 not found" + } - raise Exception("Complete test with assertion about response body") + # raise Exception("Complete test with assertion about response body") # ***************************************************************** # **Complete test with assertion about response body*************** # ***************************************************************** @@ -169,7 +169,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 +186,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 9df886ea9e0c5b33a4f54b504e1e81320252f332 Mon Sep 17 00:00:00 2001 From: Tatyana Venanzi Date: Wed, 6 Nov 2024 07:45:28 -0800 Subject: [PATCH 3/9] added order_by param to sort by asc and desc for titles. passed wave 2 tests --- app/routes/task_routes.py | 29 +++++++++++++++++++---------- tests/test_wave_02.py | 4 ++-- 2 files changed, 21 insertions(+), 12 deletions(-) diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index a0eab028f..e133dfa78 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -43,16 +43,25 @@ def create_task(): # GET all tasks @tasks_bp.get("") def get_all_tasks(): - tasks = Task.query.all() - 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 - }) + # Start the base query without resetting it + query = db.select(Task) + sort_order = request.args.get("sort", "asc") + if sort_order == "desc": + query = query.order_by(Task.title.desc()) + else: + query = query.order_by(Task.title.asc()) + + # Execute the query + tasks = db.session.scalars(query) + + # Build the response + tasks_response = [{ + "id": task.id, + "title": task.title, + "description": task.description, + "is_complete": task.completed_at is not None + } for task in tasks] + return jsonify(tasks_response), 200 # GET one task 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 2a6066ab9dcf0ed6fd5a757730d41280036cb379 Mon Sep 17 00:00:00 2001 From: Tatyana Venanzi Date: Wed, 6 Nov 2024 09:51:47 -0800 Subject: [PATCH 4/9] added patch request and passed tests for wave 3 --- app/routes/task_routes.py | 40 +++++++++++++++++++++++++++++++++++++++ tests/test_wave_03.py | 32 ++++++++++++++----------------- 2 files changed, 54 insertions(+), 18 deletions(-) diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index e133dfa78..cbda7047b 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -1,6 +1,7 @@ from flask import Blueprint, request, jsonify, make_response, abort from app.models.task import Task from ..db import db +from datetime import datetime tasks_bp = Blueprint("tasks_bp", __name__, url_prefix="/tasks") @@ -107,6 +108,45 @@ def update_task(task_id): } }, 200 +# PATCH: Partial update tasks +@tasks_bp.patch("//mark_complete") +def mark_task_complete(task_id): + task = db.session.get(Task, task_id) + + if task is None: + abort(make_response({"message": f"Task {task_id} not found"}, 404)) + + task.completed_at = datetime.now().date() + db.session.commit() + + return { + "task": { + "id": task.id, + "title": task.title, + "description": task.description, + "is_complete": task.completed_at is not None + } + }, 200 + +@tasks_bp.patch("//mark_incomplete") +def mark_task_incomplete(task_id): + task = db.session.get(Task, task_id) + + if task is None: + abort(make_response({"message": f"Task {task_id} not found"}, 404)) + + task.completed_at = None + db.session.commit() + + return { + "task": { + "id": task.id, + "title": task.title, + "description": task.description, + "is_complete": task.completed_at is not None + } + }, 200 + # DELETE: Delete a task @tasks_bp.delete("/") def delete_task(task_id): diff --git a/tests/test_wave_03.py b/tests/test_wave_03.py index 32d379822..0e04ea21f 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 """ @@ -24,7 +24,7 @@ def test_mark_complete_on_incomplete_task(client, one_task): mock_get.return_value.status_code = 200 # Act - response = client.patch("/tasks/1/mark_complete") + response = client.patch("/tasks/1/mark_complete") response_body = response.get_json() # Assert @@ -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 """ @@ -81,7 +81,7 @@ def test_mark_complete_on_completed_task(client, completed_task): mock_get.return_value.status_code = 200 # Act - response = client.patch("/tasks/1/mark_complete") + response = client.patch("/tasks/1/mark_complete") response_body = response.get_json() # Assert @@ -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,12 @@ 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 == { + "message": "Task 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") @@ -142,8 +140,6 @@ 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 == { + "message": "Task 1 not found" + } From 16a4397d1611c82c4740c35ddcaa2bb2e8729be9 Mon Sep 17 00:00:00 2001 From: Tatyana Venanzi Date: Thu, 7 Nov 2024 11:01:40 -0800 Subject: [PATCH 5/9] wave 4 commit - created patch endpoint for partial updates and included Slack post message API --- app/routes/task_routes.py | 4 ++++ app/slack_service.py | 28 ++++++++++++++++++++++++++++ 2 files changed, 32 insertions(+) create mode 100644 app/slack_service.py diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index cbda7047b..599798eae 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -2,6 +2,8 @@ from app.models.task import Task from ..db import db from datetime import datetime +from app.slack_service import send_slack_message + tasks_bp = Blueprint("tasks_bp", __name__, url_prefix="/tasks") @@ -119,6 +121,8 @@ def mark_task_complete(task_id): task.completed_at = datetime.now().date() db.session.commit() + send_slack_message(task.title) + return { "task": { "id": task.id, diff --git a/app/slack_service.py b/app/slack_service.py new file mode 100644 index 000000000..b48eaa67d --- /dev/null +++ b/app/slack_service.py @@ -0,0 +1,28 @@ +import os +import requests + +SLACK_CHANNEL = "task-notifications" +SLACK_BASE_URL = "https://slack.com/api/chat.postMessage" + +def send_slack_message(task_title): + slack_token = os.environ.get("SLACK_API_TOKEN") + + if not slack_token: + return "Slack API token not found" + + message = f"Someone just completed the task: {task_title}" + + headers = { + "Authorization": f"Bearer {slack_token}", + "Content-Type": "application/json" + } + + notification = { + "channel": SLACK_CHANNEL, + "text": message + } + + response = requests.post(SLACK_BASE_URL, json=notification, headers=headers) + + if response.status_code != 200: + return (f"Failed to send Slack Message: {response.status_code}, {response.text}") \ No newline at end of file From 4edef9c0e6359098d2d4413449a2cfa05ddc0037 Mon Sep 17 00:00:00 2001 From: Tatyana Venanzi Date: Thu, 7 Nov 2024 13:38:59 -0800 Subject: [PATCH 6/9] created goal_routes and passed wave 5 --- app/__init__.py | 2 + app/models/goal.py | 7 +++ app/routes/goal_routes.py | 69 +++++++++++++++++++++++- app/routes/task_routes.py | 1 + migrations/versions/986d7fc91229_.py | 32 +++++++++++ tests/test_wave_05.py | 81 ++++++++++++++-------------- 6 files changed, 151 insertions(+), 41 deletions(-) create mode 100644 migrations/versions/986d7fc91229_.py diff --git a/app/__init__.py b/app/__init__.py index b9b10a134..f022a7179 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,6 +1,7 @@ from flask import Flask from .db import db, migrate from .routes.task_routes import tasks_bp +from .routes.goal_routes import goals_bp from .models import task, goal import os @@ -20,5 +21,6 @@ def create_app(config=None): # Register Blueprints here app.register_blueprint(tasks_bp) + app.register_blueprint(goals_bp) return app diff --git a/app/models/goal.py b/app/models/goal.py index 44282656b..c0c015124 100644 --- a/app/models/goal.py +++ b/app/models/goal.py @@ -3,3 +3,10 @@ class Goal(db.Model): id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True) + title: Mapped[str] = mapped_column(nullable=False) + + def goal_dict(self): + return dict( + id=self.id, + title=self.title + ) diff --git a/app/routes/goal_routes.py b/app/routes/goal_routes.py index 3aae38d49..bda492c58 100644 --- a/app/routes/goal_routes.py +++ b/app/routes/goal_routes.py @@ -1 +1,68 @@ -from flask import Blueprint \ No newline at end of file +from flask import Blueprint, request, make_response, abort, Response +from app.models.goal import Goal +from ..db import db + +goals_bp = Blueprint("goals_bp", __name__, url_prefix="/goals") + +def validate_goal(goal_id): + try: + goal_id = int(goal_id) + except ValueError: + abort(make_response({"message": f"Goal {goal_id} is invalid"}, 400)) + + goal = Goal.query.get(goal_id) + if not goal: + abort(make_response({"message": f"Goal {goal_id} not found"}, 404)) + return goal + +@goals_bp.post("") +def create_goal(): + request_body = request.get_json() + + if "title" not in request_body: + abort(make_response({"details": "Invalid data"}, 400)) + + new_goal = Goal(title=request_body["title"]) + + db.session.add(new_goal) + db.session.commit() + + response = {"goal" : new_goal.goal_dict()} + return response, 201 + +@goals_bp.get("") +def get_all_goals(): + goals = Goal.query.all() + goals_response = [goal.goal_dict() for goal in goals] + + return make_response(goals_response, 200) + +@goals_bp.get("/") +def get_one_goal(goal_id): + goal = validate_goal(goal_id) + + return {"goal": goal.goal_dict()}, 200 + +@goals_bp.put("/") +def update_goal(goal_id): + goal = validate_goal(goal_id) + request_body = request.get_json() + + if "title" not in request_body: + abort(make_response({"details": "Invalid data"}, 400)) + + goal.title = request_body["title"] + db.session.commit() + + return {"goal": goal.goal_dict()}, 200 + +@goals_bp.delete("/") +def delete_goal(goal_id): + goal = validate_goal(goal_id) + + db.session.delete(goal) + db.session.commit() + + return make_response({ + "details": f"Goal {goal_id} \"{goal.title}\" successfully deleted" + }, 200) \ No newline at end of file diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index 599798eae..a167e7781 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -118,6 +118,7 @@ def mark_task_complete(task_id): if task is None: abort(make_response({"message": f"Task {task_id} not found"}, 404)) + # task.title = request.json.get("title", task.title) task.completed_at = datetime.now().date() db.session.commit() diff --git a/migrations/versions/986d7fc91229_.py b/migrations/versions/986d7fc91229_.py new file mode 100644 index 000000000..e96c25ef4 --- /dev/null +++ b/migrations/versions/986d7fc91229_.py @@ -0,0 +1,32 @@ +"""added goal model + +Revision ID: 986d7fc91229 +Revises: c5c1e5da8e8d +Create Date: 2024-11-07 12:16:09.790107 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '986d7fc91229' +down_revision = 'c5c1e5da8e8d' +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..018e14d57 100644 --- a/tests/test_wave_05.py +++ b/tests/test_wave_05.py @@ -1,7 +1,7 @@ import pytest -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_get_goals_no_saved_goals(client): # Act response = client.get("/goals") @@ -12,7 +12,7 @@ def test_get_goals_no_saved_goals(client): assert response_body == [] -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_get_goals_one_saved_goal(client, one_goal): # Act response = client.get("/goals") @@ -29,7 +29,7 @@ def test_get_goals_one_saved_goal(client, one_goal): ] -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_get_goal(client, one_goal): # Act response = client.get("/goals/1") @@ -46,22 +46,21 @@ 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": "Goal 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_goal(client): # Act response = client.post("/goals", json={ @@ -80,34 +79,39 @@ 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" + }) + response_body = response.get_json() # Assert - # ---- Complete Assertions Here ---- - # assertion 1 goes here - # assertion 2 goes here - # assertion 3 goes here - # ---- Complete Assertions Here ---- + assert response.status_code == 200 + assert "goal" in response_body + assert response_body == { + "goal": { + "id": 1, + "title": "Updated Goal Title" + } + } -@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/999", json={ + "title": "Non-existent Goal" + }) + response_body = response.get_json() # Assert - # ---- Complete Assertions Here ---- - # assertion 1 goes here - # assertion 2 goes here - # ---- Complete Assertions Here ---- + assert response.status_code == 404 + assert response_body == {"message": "Goal 999 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_goal(client, one_goal): # Act response = client.delete("/goals/1") @@ -122,29 +126,26 @@ def test_delete_goal(client, one_goal): # Check that the goal was deleted response = client.get("/goals/1") + response_body = response.get_json() + assert response.status_code == 404 + assert response_body == {"message": "Goal 1 not found"} - raise Exception("Complete test with assertion about response body") - # ***************************************************************** - # **Complete test with assertion about response body*************** - # ***************************************************************** + -@pytest.mark.skip(reason="test to be completed by student") +# @pytest.mark.skip(reason="test to be completed by student") def test_delete_goal_not_found(client): - raise Exception("Complete test") - # Act - # ---- Complete Act Here ---- + response = client.delete("/goals/999") # Assumes no goal with id=999 exists + response_body = response.get_json() # Assert - # ---- Complete Assertions Here ---- - # assertion 1 goes here - # assertion 2 goes here - # ---- Complete Assertions Here ---- + assert response.status_code == 404 + assert response_body == {"message": "Goal 999 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_goal_missing_title(client): # Act response = client.post("/goals", json={}) From 0c3a03cd82f3c9305c8843fcba3b58ee1b7b9859 Mon Sep 17 00:00:00 2001 From: Tatyana Venanzi Date: Thu, 7 Nov 2024 18:48:40 -0800 Subject: [PATCH 7/9] created one to many relationship between Goal and Task and passed wave 6 tests --- app/__init__.py | 2 + app/models/goal.py | 5 ++- app/models/task.py | 17 ++++++--- app/routes/goal_routes.py | 37 ++++++++++++++++++- app/routes/task_routes.py | 11 ++---- ...d_create_relationship_between_goal_and_.py | 34 +++++++++++++++++ tests/test_wave_05.py | 2 +- tests/test_wave_06.py | 21 +++++------ 8 files changed, 101 insertions(+), 28 deletions(-) create mode 100644 migrations/versions/0040a23258cd_create_relationship_between_goal_and_.py diff --git a/app/__init__.py b/app/__init__.py index f022a7179..5aaa40040 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -24,3 +24,5 @@ def create_app(config=None): app.register_blueprint(goals_bp) return app + + diff --git a/app/models/goal.py b/app/models/goal.py index c0c015124..5274fb20a 100644 --- a/app/models/goal.py +++ b/app/models/goal.py @@ -1,12 +1,15 @@ -from sqlalchemy.orm import Mapped, mapped_column +from sqlalchemy.orm import Mapped, mapped_column, relationship +from typing import List from ..db import db class Goal(db.Model): id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True) title: Mapped[str] = mapped_column(nullable=False) + tasks: Mapped[List["Task"]] = relationship("Task", back_populates="goal") def goal_dict(self): return dict( id=self.id, title=self.title ) + diff --git a/app/models/task.py b/app/models/task.py index 1e383a32c..d0444a712 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -1,17 +1,22 @@ -from sqlalchemy.orm import Mapped, mapped_column +from sqlalchemy.orm import Mapped, mapped_column, relationship +from sqlalchemy import ForeignKey +from typing import Optional from ..db import db from datetime import datetime class Task(db.Model): id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True) - title: Mapped[str] - description: Mapped[str] - completed_at: Mapped[datetime] = mapped_column(nullable=True, default=None) + title: Mapped[str] = mapped_column(nullable=False) + description: Mapped[str] = mapped_column(nullable=False) + completed_at: Mapped[Optional[datetime]] = mapped_column(nullable=True, default=None) + goal_id: Mapped[Optional[int]] = mapped_column(ForeignKey('goal.id'), nullable=True) + goal: Mapped["Goal"] = relationship("Goal", back_populates="tasks") def task_dict(self): return dict( id=self.id, title=self.title, description=self.description, - completed_at=self.completed_at is not None - ) + is_complete=self.completed_at is not None, + goal_id=self.goal_id + ) diff --git a/app/routes/goal_routes.py b/app/routes/goal_routes.py index bda492c58..ed15d88fb 100644 --- a/app/routes/goal_routes.py +++ b/app/routes/goal_routes.py @@ -1,5 +1,6 @@ from flask import Blueprint, request, make_response, abort, Response from app.models.goal import Goal +from app.models.task import Task from ..db import db goals_bp = Blueprint("goals_bp", __name__, url_prefix="/goals") @@ -30,6 +31,23 @@ def create_goal(): response = {"goal" : new_goal.goal_dict()} return response, 201 +@goals_bp.post("//tasks") +def associated_tasks_with_goal(goal_id): + goal = validate_goal(goal_id) + request_body = request.get_json() + + if "task_ids" not in request_body: + return {"details": "Invalid data"}, 400 + + task_ids = request_body["task_ids"] + for task_id in task_ids: + task = Task.query.get(task_id) + if task: + task.goal_id = goal.id + + db.session.commit() + return {"id": goal.id, "task_ids": task_ids}, 200 + @goals_bp.get("") def get_all_goals(): goals = Goal.query.all() @@ -43,6 +61,23 @@ def get_one_goal(goal_id): return {"goal": goal.goal_dict()}, 200 +@goals_bp.get("//tasks") +def get_tasks_for_goal(goal_id): + goal = validate_goal(goal_id) + tasks_response = [{ + "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] + + return { + "id": goal.id, + "title": goal.title, + "tasks": tasks_response + }, 200 + @goals_bp.put("/") def update_goal(goal_id): goal = validate_goal(goal_id) @@ -65,4 +100,4 @@ def delete_goal(goal_id): return make_response({ "details": f"Goal {goal_id} \"{goal.title}\" successfully deleted" - }, 200) \ No newline at end of file + }, 200) diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index a167e7781..7f63bd991 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -70,15 +70,10 @@ def get_all_tasks(): # GET one task @tasks_bp.get("/") def get_one_task(task_id): - task = validate_task(task_id) # Call validate_task + task = validate_task(task_id) return { - "task": { - "id": task.id, - "title": task.title, - "description": task.description, - "is_complete": task.completed_at is not None - } + "task": task.task_dict() }, 200 @@ -165,4 +160,4 @@ def delete_task(task_id): }, 200) - + diff --git a/migrations/versions/0040a23258cd_create_relationship_between_goal_and_.py b/migrations/versions/0040a23258cd_create_relationship_between_goal_and_.py new file mode 100644 index 000000000..2fb0371ee --- /dev/null +++ b/migrations/versions/0040a23258cd_create_relationship_between_goal_and_.py @@ -0,0 +1,34 @@ +"""create relationship between Goal and Task + +Revision ID: 0040a23258cd +Revises: 986d7fc91229 +Create Date: 2024-11-07 14:08:31.708647 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '0040a23258cd' +down_revision = '986d7fc91229' +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_05.py b/tests/test_wave_05.py index 018e14d57..e548a7144 100644 --- a/tests/test_wave_05.py +++ b/tests/test_wave_05.py @@ -64,6 +64,7 @@ def test_get_goal_not_found(client): def test_create_goal(client): # Act response = client.post("/goals", json={ + "id": 1, "title": "My New Goal" }) response_body = response.get_json() @@ -78,7 +79,6 @@ def test_create_goal(client): } } - # @pytest.mark.skip(reason="test to be completed by student") def test_update_goal(client, one_goal): # Act diff --git a/tests/test_wave_06.py b/tests/test_wave_06.py index 8afa4325e..d2ff85ae6 100644 --- a/tests/test_wave_06.py +++ b/tests/test_wave_06.py @@ -1,8 +1,9 @@ from app.models.goal import Goal +import app.routes.route_utilities 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 +24,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 +43,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 +51,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 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") @@ -74,7 +73,7 @@ def test_get_tasks_for_specific_goal_no_tasks(client, one_goal): } -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_get_tasks_for_specific_goal(client, one_task_belongs_to_one_goal): # Act response = client.get("/goals/1/tasks") @@ -99,7 +98,7 @@ def test_get_tasks_for_specific_goal(client, one_task_belongs_to_one_goal): } -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_get_task_includes_goal_id(client, one_task_belongs_to_one_goal): response = client.get("/tasks/1") response_body = response.get_json() From dd83bda4398241da9e9a2d311cb2869c41115153 Mon Sep 17 00:00:00 2001 From: Tatyana Venanzi Date: Thu, 7 Nov 2024 18:55:49 -0800 Subject: [PATCH 8/9] updated task_dict in task.py to fix test in wave 1 --- app/models/task.py | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/app/models/task.py b/app/models/task.py index d0444a712..1ae92402e 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -13,10 +13,14 @@ class Task(db.Model): goal: Mapped["Goal"] = relationship("Goal", back_populates="tasks") def task_dict(self): - return dict( - id=self.id, - title=self.title, - description=self.description, - is_complete=self.completed_at is not None, - goal_id=self.goal_id - ) + task_data = { + "id": self.id, + "title": self.title, + "description": self.description, + "is_complete": self.completed_at is not None + } + + if self.goal_id is not None: + task_data["goal_id"] = self.goal_id + return task_data + \ No newline at end of file From 1bf7d50bb678f4dbfdffefa1e23611f4dd8901cf Mon Sep 17 00:00:00 2001 From: Tatyana Venanzi Date: Fri, 8 Nov 2024 08:27:41 -0800 Subject: [PATCH 9/9] deleted "complete test assert" comment block --- tests/test_wave_01.py | 5 ----- 1 file changed, 5 deletions(-) diff --git a/tests/test_wave_01.py b/tests/test_wave_01.py index 3162a89ef..4eb0baff3 100644 --- a/tests/test_wave_01.py +++ b/tests/test_wave_01.py @@ -161,11 +161,6 @@ def test_delete_task_not_found(client): "message": "Task 1 not found" } - # raise Exception("Complete test with assertion about response body") - # ***************************************************************** - # **Complete test with assertion about response body*************** - # ***************************************************************** - assert Task.query.all() == []