From 8636f9b3c00e7d6f63fd11e220ab89abbe3aa230 Mon Sep 17 00:00:00 2001 From: Paje Date: Mon, 7 Nov 2022 23:48:48 -0600 Subject: [PATCH 1/4] All tests pass, awaiting refactor --- app/__init__.py | 7 +- app/goal_routes.py | 105 ++++++++++++++++ app/models/goal.py | 4 +- app/models/task.py | 7 +- app/routes.py | 176 ++++++++++++++++++++++++++- migrations/README | 1 + migrations/alembic.ini | 45 +++++++ migrations/env.py | 96 +++++++++++++++ migrations/script.py.mako | 24 ++++ migrations/versions/48860be4fad8_.py | 40 ++++++ migrations/versions/f417695ff730_.py | 30 +++++ tests/test_wave_01.py | 40 +++--- tests/test_wave_02.py | 4 +- tests/test_wave_03.py | 23 ++-- tests/test_wave_05.py | 63 ++++++---- tests/test_wave_06.py | 18 ++- 16 files changed, 604 insertions(+), 79 deletions(-) create mode 100644 app/goal_routes.py create mode 100644 migrations/README create mode 100644 migrations/alembic.ini create mode 100644 migrations/env.py create mode 100644 migrations/script.py.mako create mode 100644 migrations/versions/48860be4fad8_.py create mode 100644 migrations/versions/f417695ff730_.py diff --git a/app/__init__.py b/app/__init__.py index 2764c4cc8..6ce107417 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -29,6 +29,11 @@ def create_app(test_config=None): db.init_app(app) migrate.init_app(app, db) - # Register Blueprints here + from app.routes import tasks_bp + from app.goal_routes import goals_bp + # Register Blueprints here + app.register_blueprint(tasks_bp) + app.register_blueprint(goals_bp) + return app diff --git a/app/goal_routes.py b/app/goal_routes.py new file mode 100644 index 000000000..17d253e22 --- /dev/null +++ b/app/goal_routes.py @@ -0,0 +1,105 @@ +from flask import Blueprint, jsonify, request, make_response, abort +from app.models.task import Task +from app.models.goal import Goal +from app.routes import validate_model_id +from sqlalchemy import desc, asc +import datetime +import requests +import os +from app import db + +goals_bp = Blueprint("goals", __name__, url_prefix="/goals") + +@goals_bp.route("", methods=["GET"]) +def retrieve_goals(): + goals = Goal.query.all() + goals_response = [] + + for goal in goals: + goals_response.append({ + "id": goal.goal_id, + "title": goal.title + }) + return jsonify(goals_response) + +@goals_bp.route("", methods=["POST"]) +def create_goal(): + request_body = request.get_json() + + if not request_body.get("title"): + return {"details": "Invalid data"}, 400 + + new_goal = Goal(title = request_body["title"]) + db.session.add(new_goal) + db.session.commit() + + return { "goal": { + "id": new_goal.goal_id, + "title": new_goal.title + }}, 201 + +@goals_bp.route("/", methods=["GET"]) +def handle_goal(goal_id): + goal = validate_model_id(Goal, goal_id) + + return {"goal": { + "id": goal.goal_id, + "title": goal.title, + } + } + +@goals_bp.route("/", methods=["PUT"]) +def update_goal(goal_id): + goal = validate_model_id(Goal, goal_id) + + request_body = request.get_json() + + goal.title = request_body["title"] + db.session.commit() + + return make_response({ + "goal": { + "id": goal.goal_id, + "title": goal.title + }}) + +@goals_bp.route("/", methods=["DELETE"]) +def delete_goal(goal_id): + goal = validate_model_id(Goal, goal_id) + + db.session.delete(goal) + db.session.commit() + + return make_response({ + "details": f"Goal {goal_id} \"{goal.title}\" successfully deleted" + }) + +@goals_bp.route("//tasks", methods=["GET"]) +def add_task_to_goal(goal_id): + goal = validate_model_id(Goal, goal_id) + tasks_response = [] + for task in Goal.query.get(goal_id).tasks: + task.goal_id = goal.goal_id + tasks_response.append({ + "id": task.task_id, + "goal_id": goal.goal_id, + "title": task.title, + "description": task.description, + "is_complete": (task.completed_at == True) + }) + + return {"id": goal.goal_id, "title": goal.title, "tasks": tasks_response} + +@goals_bp.route("//tasks", methods=["POST"]) +def retrieve_tasks_from_goal(goal_id): + goal = validate_model_id(Goal, goal_id) + request_body = request.get_json() + task_ids = [] + for task_id in request_body["task_ids"]: + task = validate_model_id(Task, task_id) + task.goal_id = goal.goal_id + task_ids.append(task.task_id) + + db.session.commit() + + return {"id": goal.goal_id, "task_ids": task_ids} diff --git a/app/models/goal.py b/app/models/goal.py index b0ed11dd8..b58ffb803 100644 --- a/app/models/goal.py +++ b/app/models/goal.py @@ -2,4 +2,6 @@ class Goal(db.Model): - goal_id = db.Column(db.Integer, primary_key=True) + goal_id = db.Column(db.Integer, primary_key=True, autoincrement=True) + title = db.Column(db.String) + tasks = db.relationship("Task", back_populates="goal") \ No newline at end of file diff --git a/app/models/task.py b/app/models/task.py index c91ab281f..e41fd759d 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -2,4 +2,9 @@ class Task(db.Model): - task_id = db.Column(db.Integer, primary_key=True) + task_id = db.Column(db.Integer, primary_key=True, autoincrement=True) + title = db.Column(db.String) + description = db.Column(db.String) + completed_at = db.Column(db.DateTime, nullable=True) + goal_id = db.Column(db.Integer, db.ForeignKey("goal.goal_id")) + goal = db.relationship("Goal", back_populates="tasks") \ No newline at end of file diff --git a/app/routes.py b/app/routes.py index 3aae38d49..523f48209 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1 +1,175 @@ -from flask import Blueprint \ No newline at end of file +from flask import Blueprint, jsonify, request, make_response, abort +from app.models.task import Task +from sqlalchemy import desc, asc +import datetime +import requests +import os +from app import db + +def slackbot_call(message): + PATH = "https://slack.com/api/chat.postMessage" + parameters = { + "channel": "task-notifications", + "text": message + } + + requests.post( + PATH, + params=parameters, + headers={"Authorization": os.environ.get("SLACKBOT_API_KEY")} + ) + +def validate_model_id(cls, model_id): + try: + model_id = int(model_id) + except ValueError: + abort(make_response( + f"{model_id} is an invalid input. Please input an integer.", 400 + ) + ) + + model = cls.query.get(model_id) + if model: + return model + else: + abort(make_response({"error": f"Item #{model_id} cannot be found"}, 404)) + + + +tasks_bp = Blueprint("tasks", __name__, url_prefix="/tasks") + +@tasks_bp.route("", methods = ["GET"]) +def retrieve_tasks(): + tasks = Task.query.all() + tasks_response = [] + sort_query = request.args.get("sort") + + if sort_query == "asc": + tasks = Task.query.order_by(asc("title")) + elif sort_query == "desc": + tasks = Task.query.order_by(desc("title")) + + for task in tasks: + tasks_response.append({ + "id": task.task_id, + "title": task.title, + "description": task.description, + "is_complete": (task.completed_at == True) + }) + + if sort_query == "asc": + tasks = Task.query.order_by(asc("title")) + elif sort_query == "desc": + tasks = Task.query.order_by(desc("title")) + return jsonify(tasks_response) + +@tasks_bp.route("", methods = ["POST"]) +def create_task(): + request_body = request.get_json() + + if not request_body.get("title") or not request_body.get("description"): + return {"details": "Invalid data"}, 400 + + new_task = Task( + title=request_body["title"], + description=request_body["description"], + completed_at=request_body.get("completed_at") + ) + db.session.add(new_task) + db.session.commit() + return {"task": { + "id": new_task.task_id, + "title": new_task.title, + "description": new_task.description, + "is_complete": (new_task.completed_at == True) + } + }, 201 + +@tasks_bp.route("/", methods=["GET"]) +def handle_task(task_id): + task = validate_model_id(Task, task_id) + if task.goal_id: + return {"task": { + "id": task.task_id, + "goal_id": task.goal_id, + "title": task.title, + "description": task.description, + "is_complete": (task.completed_at == True) + } + } + else: + return {"task": { + "id": task.task_id, + "title": task.title, + "description": task.description, + "is_complete": (task.completed_at == True) + } + } + +@tasks_bp.route("/", methods=["PUT"]) +def update_task(task_id): + task = validate_model_id(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() + + return make_response({ + "task": { + "id": task.task_id, + "title": task.title, + "description": task.description, + "is_complete": (task.completed_at == True) + } + }) + +@tasks_bp.route("/", methods=["DELETE"]) +def delete_task(task_id): + task = validate_model_id(Task, task_id) + + db.session.delete(task) + db.session.commit() + + return make_response({ + "details": f"Task {task_id} \"{task.title}\" successfully deleted" + }) + +@tasks_bp.route("//mark_complete", methods=["PATCH"]) +def update_task_as_complete(task_id): + task = validate_model_id(Task, task_id) + task.completed_at = datetime.datetime.now() + db.session.commit() + + slackbot_call(f"Someone just completed the task {task.title}") + + return make_response({ + "task": { + "id": task.task_id, + "title": task.title, + "description": task.description, + "is_complete": (bool(task.completed_at)) + } + }) + + + +@tasks_bp.route("//mark_incomplete", methods=["PATCH"]) +def update_task_as_incomplete(task_id): + task = validate_model_id(Task, task_id) + + task.completed_at = None + + db.session.commit() + + return make_response({ + "task": { + "id": task.task_id, + "title": task.title, + "description": task.description, + "is_complete": (bool(task.completed_at)) + } + }) diff --git a/migrations/README b/migrations/README new file mode 100644 index 000000000..98e4f9c44 --- /dev/null +++ b/migrations/README @@ -0,0 +1 @@ +Generic single-database configuration. \ No newline at end of file diff --git a/migrations/alembic.ini b/migrations/alembic.ini new file mode 100644 index 000000000..f8ed4801f --- /dev/null +++ b/migrations/alembic.ini @@ -0,0 +1,45 @@ +# 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 + +[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 + +[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..8b3fb3353 --- /dev/null +++ b/migrations/env.py @@ -0,0 +1,96 @@ +from __future__ import with_statement + +import logging +from logging.config import fileConfig + +from sqlalchemy import engine_from_config +from sqlalchemy import pool +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') + +# 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', + str(current_app.extensions['migrate'].db.engine.url).replace('%', '%%')) +target_metadata = current_app.extensions['migrate'].db.metadata + +# 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 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=target_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.') + + connectable = engine_from_config( + config.get_section(config.config_ini_section), + prefix='sqlalchemy.', + poolclass=pool.NullPool, + ) + + with connectable.connect() as connection: + context.configure( + connection=connection, + target_metadata=target_metadata, + process_revision_directives=process_revision_directives, + **current_app.extensions['migrate'].configure_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"} diff --git a/migrations/versions/48860be4fad8_.py b/migrations/versions/48860be4fad8_.py new file mode 100644 index 000000000..a74af311f --- /dev/null +++ b/migrations/versions/48860be4fad8_.py @@ -0,0 +1,40 @@ +"""empty message + +Revision ID: 48860be4fad8 +Revises: +Create Date: 2022-11-07 21:22:36.946483 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '48860be4fad8' +down_revision = None +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.create_table('goal', + sa.Column('goal_id', sa.Integer(), autoincrement=True, nullable=False), + sa.Column('title', sa.String(), nullable=True), + sa.PrimaryKeyConstraint('goal_id') + ) + op.create_table('task', + sa.Column('task_id', sa.Integer(), autoincrement=True, nullable=False), + sa.Column('title', sa.String(), nullable=True), + sa.Column('description', sa.String(), nullable=True), + sa.Column('completed_at', sa.DateTime(), nullable=True), + sa.PrimaryKeyConstraint('task_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/migrations/versions/f417695ff730_.py b/migrations/versions/f417695ff730_.py new file mode 100644 index 000000000..8625d89fd --- /dev/null +++ b/migrations/versions/f417695ff730_.py @@ -0,0 +1,30 @@ +"""empty message + +Revision ID: f417695ff730 +Revises: 48860be4fad8 +Create Date: 2022-11-07 22:34:01.104315 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'f417695ff730' +down_revision = '48860be4fad8' +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.add_column('task', sa.Column('goal_id', sa.Integer(), nullable=True)) + op.create_foreign_key(None, 'task', 'goal', ['goal_id'], ['goal_id']) + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.drop_constraint(None, 'task', type_='foreignkey') + op.drop_column('task', 'goal_id') + # ### end Alembic commands ### diff --git a/tests/test_wave_01.py b/tests/test_wave_01.py index dca626d78..43141093b 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") @@ -60,13 +60,9 @@ 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": "Item #1 cannot be 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={ @@ -93,7 +89,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 +115,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={ @@ -131,13 +127,9 @@ 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": "Item #1 cannot be 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") @@ -152,7 +144,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") @@ -161,15 +153,11 @@ 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": "Item #1 cannot be found"} 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 +174,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={ diff --git a/tests/test_wave_02.py b/tests/test_wave_02.py index a087e0909..c9a76e6b1 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") diff --git a/tests/test_wave_03.py b/tests/test_wave_03.py index 32d379822..17320dddf 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") @@ -128,13 +128,9 @@ 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": "Item #1 cannot be 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") @@ -143,7 +139,4 @@ def test_mark_incomplete_missing_task(client): # Assert assert response.status_code == 404 - raise Exception("Complete test with assertion about response body") - # ***************************************************************** - # **Complete test with assertion about response body*************** - # ***************************************************************** + assert response_body == {"error": "Item #1 cannot be found"} \ No newline at end of file diff --git a/tests/test_wave_05.py b/tests/test_wave_05.py index aee7c52a1..d767dfdb9 100644 --- a/tests/test_wave_05.py +++ b/tests/test_wave_05.py @@ -1,7 +1,8 @@ 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 +13,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 +30,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 +47,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 + assert response.status_code == 404 # assertion 2 goes here + assert response_body == {"error": "Item #1 cannot be 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 +83,53 @@ 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": "Updating my goals" + }) + + response_body = response.get_json() # Assert # ---- Complete Assertions Here ---- # assertion 1 goes here + assert response.status_code == 200 # assertion 2 goes here + assert "goal" in response_body # assertion 3 goes here + assert response_body == { + "goal": { + "id": 1, + "title": "Updating my goals", + } + } # ---- Complete Assertions Here ---- + goal = Goal.query.get(1) + assert goal.title == "Updating my goals" -@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": "Updating my goals" + }) + response_body = response.get_json() # Assert # ---- Complete Assertions Here ---- # assertion 1 goes here + assert response.status_code == 404 # assertion 2 goes here + assert response_body == {"error": "Item #1 cannot be 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,29 +144,28 @@ 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 - - raise Exception("Complete test with assertion about response body") - # ***************************************************************** - # **Complete test with assertion about response body*************** - # ***************************************************************** + assert response_body == {"error": "Item #1 cannot be found"} + assert Goal.query.all() == [] -@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 + assert response.status_code == 404 # assertion 2 goes here + assert response_body == {"error": "Item #1 cannot be 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={}) diff --git a/tests/test_wave_06.py b/tests/test_wave_06.py index 8afa4325e..af07e9566 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,10 @@ def test_get_tasks_for_specific_goal_no_goal(client): # Assert assert response.status_code == 404 + assert response_body == {"error": "Item #1 cannot be 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 +70,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 +95,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 cc8740148e6be9a78a01701b1b6317efdde99571 Mon Sep 17 00:00:00 2001 From: Paje Date: Thu, 10 Nov 2022 11:31:17 -0600 Subject: [PATCH 2/4] deploying --- Procfile | 1 + app/models/task.py | 19 ++++++- app/routes.py | 124 ++++++++++++++++++--------------------------- 3 files changed, 68 insertions(+), 76 deletions(-) create mode 100644 Procfile diff --git a/Procfile b/Procfile new file mode 100644 index 000000000..62e430aca --- /dev/null +++ b/Procfile @@ -0,0 +1 @@ +web: gunicorn 'app:create_app()' \ No newline at end of file diff --git a/app/models/task.py b/app/models/task.py index e41fd759d..26e16e309 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -7,4 +7,21 @@ class Task(db.Model): description = db.Column(db.String) completed_at = db.Column(db.DateTime, nullable=True) goal_id = db.Column(db.Integer, db.ForeignKey("goal.goal_id")) - goal = db.relationship("Goal", back_populates="tasks") \ No newline at end of file + goal = db.relationship("Goal", back_populates="tasks") + + def format_task(self): + return { + "id": self.task_id, + "title": self.title, + "description": self.description, + "is_complete": (self.completed_at == True), + } + + def format_task_goal(self): + return { + "id": self.task_id, + "goal_id": self.goal_id, + "title": self.title, + "description": self.description, + "is_complete": bool(self.completed_at), + } diff --git a/app/routes.py b/app/routes.py index 523f48209..361e49cad 100644 --- a/app/routes.py +++ b/app/routes.py @@ -6,39 +6,39 @@ import os from app import db + def slackbot_call(message): PATH = "https://slack.com/api/chat.postMessage" - parameters = { - "channel": "task-notifications", - "text": message - } + parameters = {"channel": "task-notifications", "text": message} requests.post( - PATH, - params=parameters, - headers={"Authorization": os.environ.get("SLACKBOT_API_KEY")} + PATH, + params=parameters, + headers={"Authorization": os.environ.get("SLACKBOT_API_KEY")}, ) + def validate_model_id(cls, model_id): try: model_id = int(model_id) except ValueError: - abort(make_response( - f"{model_id} is an invalid input. Please input an integer.", 400 - ) + abort( + make_response( + f"{model_id} is an invalid input. Please input an integer.", 400 ) - + ) + model = cls.query.get(model_id) if model: return model else: abort(make_response({"error": f"Item #{model_id} cannot be found"}, 404)) - tasks_bp = Blueprint("tasks", __name__, url_prefix="/tasks") -@tasks_bp.route("", methods = ["GET"]) + +@tasks_bp.route("", methods=["GET"]) def retrieve_tasks(): tasks = Task.query.all() tasks_response = [] @@ -50,61 +50,37 @@ def retrieve_tasks(): tasks = Task.query.order_by(desc("title")) for task in tasks: - tasks_response.append({ - "id": task.task_id, - "title": task.title, - "description": task.description, - "is_complete": (task.completed_at == True) - }) - - if sort_query == "asc": - tasks = Task.query.order_by(asc("title")) - elif sort_query == "desc": - tasks = Task.query.order_by(desc("title")) + tasks_response.append(task.format_task()) return jsonify(tasks_response) -@tasks_bp.route("", methods = ["POST"]) + +@tasks_bp.route("", methods=["POST"]) def create_task(): request_body = request.get_json() if not request_body.get("title") or not request_body.get("description"): return {"details": "Invalid data"}, 400 - + new_task = Task( title=request_body["title"], description=request_body["description"], - completed_at=request_body.get("completed_at") - ) + completed_at=request_body.get("completed_at"), + ) db.session.add(new_task) db.session.commit() - return {"task": { - "id": new_task.task_id, - "title": new_task.title, - "description": new_task.description, - "is_complete": (new_task.completed_at == True) - } + return { + "task": new_task.format_task() }, 201 + @tasks_bp.route("/", methods=["GET"]) def handle_task(task_id): task = validate_model_id(Task, task_id) if task.goal_id: - return {"task": { - "id": task.task_id, - "goal_id": task.goal_id, - "title": task.title, - "description": task.description, - "is_complete": (task.completed_at == True) - } - } + return {"task": task.format_task_goal()} else: - return {"task": { - "id": task.task_id, - "title": task.title, - "description": task.description, - "is_complete": (task.completed_at == True) - } - } + return {"task": task.format_task()} + @tasks_bp.route("/", methods=["PUT"]) def update_task(task_id): @@ -118,14 +94,8 @@ def update_task(task_id): db.session.commit() - return make_response({ - "task": { - "id": task.task_id, - "title": task.title, - "description": task.description, - "is_complete": (task.completed_at == True) - } - }) + return {"task": task.format_task()} + @tasks_bp.route("/", methods=["DELETE"]) def delete_task(task_id): @@ -134,9 +104,10 @@ def delete_task(task_id): db.session.delete(task) db.session.commit() - return make_response({ - "details": f"Task {task_id} \"{task.title}\" successfully deleted" - }) + return make_response( + {"details": f'Task {task_id} "{task.title}" successfully deleted'} + ) + @tasks_bp.route("//mark_complete", methods=["PATCH"]) def update_task_as_complete(task_id): @@ -146,15 +117,16 @@ def update_task_as_complete(task_id): slackbot_call(f"Someone just completed the task {task.title}") - return make_response({ - "task": { - "id": task.task_id, - "title": task.title, - "description": task.description, - "is_complete": (bool(task.completed_at)) + return make_response( + { + "task": { + "id": task.task_id, + "title": task.title, + "description": task.description, + "is_complete": (bool(task.completed_at)), } - }) - + } + ) @tasks_bp.route("//mark_incomplete", methods=["PATCH"]) @@ -165,11 +137,13 @@ def update_task_as_incomplete(task_id): db.session.commit() - return make_response({ - "task": { - "id": task.task_id, - "title": task.title, - "description": task.description, - "is_complete": (bool(task.completed_at)) + return make_response( + { + "task": { + "id": task.task_id, + "title": task.title, + "description": task.description, + "is_complete": (bool(task.completed_at)), } - }) + } + ) From 2240393530ded8efaf00196ce28b0f032edeeaec Mon Sep 17 00:00:00 2001 From: Paje Date: Thu, 10 Nov 2022 12:57:19 -0600 Subject: [PATCH 3/4] format task change --- app/models/task.py | 2 +- app/routes.py | 4 +--- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/app/models/task.py b/app/models/task.py index 26e16e309..fffc16eac 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -14,7 +14,7 @@ def format_task(self): "id": self.task_id, "title": self.title, "description": self.description, - "is_complete": (self.completed_at == True), + "is_complete": bool(self.completed_at), } def format_task_goal(self): diff --git a/app/routes.py b/app/routes.py index 361e49cad..cec875681 100644 --- a/app/routes.py +++ b/app/routes.py @@ -68,9 +68,7 @@ def create_task(): ) db.session.add(new_task) db.session.commit() - return { - "task": new_task.format_task() - }, 201 + return {"task": new_task.format_task()}, 201 @tasks_bp.route("/", methods=["GET"]) From 7734813e16f704c3e42d7f49d9e7befc045e13ad Mon Sep 17 00:00:00 2001 From: Paje Date: Sat, 12 Nov 2022 15:52:43 -0600 Subject: [PATCH 4/4] Completed --- app/goal_routes.py | 47 +++++++++++++++++----------------------------- app/models/goal.py | 8 +++++++- 2 files changed, 24 insertions(+), 31 deletions(-) diff --git a/app/goal_routes.py b/app/goal_routes.py index 17d253e22..3d8866154 100644 --- a/app/goal_routes.py +++ b/app/goal_routes.py @@ -10,43 +10,37 @@ goals_bp = Blueprint("goals", __name__, url_prefix="/goals") + @goals_bp.route("", methods=["GET"]) def retrieve_goals(): goals = Goal.query.all() goals_response = [] for goal in goals: - goals_response.append({ - "id": goal.goal_id, - "title": goal.title - }) + goals_response.append(goal.format_goal()) return jsonify(goals_response) + @goals_bp.route("", methods=["POST"]) def create_goal(): request_body = request.get_json() - + if not request_body.get("title"): return {"details": "Invalid data"}, 400 - new_goal = Goal(title = request_body["title"]) + new_goal = Goal(title=request_body["title"]) db.session.add(new_goal) db.session.commit() - return { "goal": { - "id": new_goal.goal_id, - "title": new_goal.title - }}, 201 + return {"goal": {"id": new_goal.goal_id, "title": new_goal.title}}, 201 + @goals_bp.route("/", methods=["GET"]) def handle_goal(goal_id): goal = validate_model_id(Goal, goal_id) - return {"goal": { - "id": goal.goal_id, - "title": goal.title, - } - } + return {"goal": goal.format_goal()} + @goals_bp.route("/", methods=["PUT"]) def update_goal(goal_id): @@ -57,11 +51,8 @@ def update_goal(goal_id): goal.title = request_body["title"] db.session.commit() - return make_response({ - "goal": { - "id": goal.goal_id, - "title": goal.title - }}) + return make_response({"goal": {"id": goal.goal_id, "title": goal.title}}) + @goals_bp.route("/", methods=["DELETE"]) def delete_goal(goal_id): @@ -70,9 +61,10 @@ def delete_goal(goal_id): db.session.delete(goal) db.session.commit() - return make_response({ - "details": f"Goal {goal_id} \"{goal.title}\" successfully deleted" - }) + return make_response( + {"details": f'Goal {goal_id} "{goal.title}" successfully deleted'} + ) + @goals_bp.route("//tasks", methods=["GET"]) def add_task_to_goal(goal_id): @@ -80,16 +72,11 @@ def add_task_to_goal(goal_id): tasks_response = [] for task in Goal.query.get(goal_id).tasks: task.goal_id = goal.goal_id - tasks_response.append({ - "id": task.task_id, - "goal_id": goal.goal_id, - "title": task.title, - "description": task.description, - "is_complete": (task.completed_at == True) - }) + tasks_response.append(task.format_task_goal()) return {"id": goal.goal_id, "title": goal.title, "tasks": tasks_response} + @goals_bp.route("//tasks", methods=["POST"]) def retrieve_tasks_from_goal(goal_id): goal = validate_model_id(Goal, goal_id) diff --git a/app/models/goal.py b/app/models/goal.py index b58ffb803..c444ece40 100644 --- a/app/models/goal.py +++ b/app/models/goal.py @@ -4,4 +4,10 @@ class Goal(db.Model): goal_id = db.Column(db.Integer, primary_key=True, autoincrement=True) title = db.Column(db.String) - tasks = db.relationship("Task", back_populates="goal") \ No newline at end of file + tasks = db.relationship("Task", back_populates="goal") + + def format_goal(self): + return { + "id": self.goal_id, + "title": self.title + } \ No newline at end of file