From 55ba89388a85d394c2d38abf57308be8c1995c4a Mon Sep 17 00:00:00 2001 From: takhat Date: Fri, 4 Nov 2022 16:40:59 -0700 Subject: [PATCH 01/19] wave1: added create-task method and passed test_create_task --- app/__init__.py | 2 + app/models/task.py | 42 +++++++++++- app/routes.py | 14 +++- migrations/README | 1 + migrations/alembic.ini | 45 +++++++++++++ migrations/env.py | 96 ++++++++++++++++++++++++++++ migrations/script.py.mako | 24 +++++++ migrations/versions/af5b9f6159e5_.py | 39 +++++++++++ tests/test_wave_01.py | 2 +- 9 files changed, 262 insertions(+), 3 deletions(-) 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/af5b9f6159e5_.py diff --git a/app/__init__.py b/app/__init__.py index 2764c4cc8..30052751d 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -30,5 +30,7 @@ def create_app(test_config=None): migrate.init_app(app, db) # Register Blueprints here + from .routes import tasks_bp + app.register_blueprint(tasks_bp) return app diff --git a/app/models/task.py b/app/models/task.py index c91ab281f..2d7408c54 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -1,5 +1,45 @@ from app import db +#Wave 1: CRUD for One Model class Task(db.Model): - task_id = db.Column(db.Integer, primary_key=True) + + 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, + default = None) + + def to_dict(self): + return { + "id": self.id, + "title": self.title, + "description": self.description, + "is_complete": False if self.completed_at is None else True + } + # Source: + # https://stackoverflow.com/questions/52325025/use-of-if-else-inside-a-dict-to-set-a-value-to-key-using-python + + @classmethod + def from_dict(cls, dict): + return cls ( + title = dict["title"], + description = dict["description"] + ) if len(dict) == 2 else cls ( + title = dict["title"], + description = dict["description"], + completed_at = dict["completed_at"] + ) + + + + + + + + + + diff --git a/app/routes.py b/app/routes.py index 3aae38d49..4b038eca6 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1 +1,13 @@ -from flask import Blueprint \ No newline at end of file +from flask import Blueprint, jsonify, make_response, request, abort +from app import db +from app.models.task import Task + +tasks_bp = Blueprint("tasks", __name__, url_prefix="/tasks") + +@tasks_bp.route("", methods=["POST"]) +def create_task(): + request_body = request.get_json() + new_task = Task.from_dict(request_body) + db.session.add(new_task) + db.session.commit() + return jsonify({"task": new_task.to_dict()}), 201 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/af5b9f6159e5_.py b/migrations/versions/af5b9f6159e5_.py new file mode 100644 index 000000000..7d36afa16 --- /dev/null +++ b/migrations/versions/af5b9f6159e5_.py @@ -0,0 +1,39 @@ +"""empty message + +Revision ID: af5b9f6159e5 +Revises: +Create Date: 2022-11-04 15:39:06.854791 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'af5b9f6159e5' +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(), nullable=False), + sa.PrimaryKeyConstraint('goal_id') + ) + op.create_table('task', + sa.Column('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('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_01.py b/tests/test_wave_01.py index dca626d78..e055d3713 100644 --- a/tests/test_wave_01.py +++ b/tests/test_wave_01.py @@ -66,7 +66,7 @@ def test_get_task_not_found(client): # ***************************************************************** -@pytest.mark.skip(reason="No way to test this feature yet") +#@pytest.mark.skip(reason="No way to test this feature yet") def test_create_task(client): # Act response = client.post("/tasks", json={ From 3a99621e6cce8bc233deb71b31b59bbd587ce848 Mon Sep 17 00:00:00 2001 From: takhat Date: Fri, 4 Nov 2022 17:53:31 -0700 Subject: [PATCH 02/19] Wave 1: added READ routes and passed READ tests --- app/routes.py | 42 +++++++++++++++++++++++++++++++++++++++++- tests/test_wave_01.py | 16 ++++++++-------- 2 files changed, 49 insertions(+), 9 deletions(-) diff --git a/app/routes.py b/app/routes.py index 4b038eca6..7b7fe3d25 100644 --- a/app/routes.py +++ b/app/routes.py @@ -4,10 +4,50 @@ tasks_bp = Blueprint("tasks", __name__, url_prefix="/tasks") +#CREATE Routes @tasks_bp.route("", methods=["POST"]) def create_task(): request_body = request.get_json() - new_task = Task.from_dict(request_body) + try: + new_task = Task.from_dict(request_body) + except KeyError: + return jsonify ({"details": "Invalid data"}), 400 db.session.add(new_task) db.session.commit() return jsonify({"task": new_task.to_dict()}), 201 + +#READ Routes +@tasks_bp.route("", methods=["GET"]) +def read_all_tasks(): + title_query_val = request.args.get("title") + date_query_val = request.args.get("completed_at") + if title_query_val is not None: + tasks = Task.query.filter_by(title=title_query_val) + elif date_query_val is not None: + tasks = Task.query.filter_by(completed_at=date_query_val) + else: + tasks = Task.query.all() + tasks_response = [] + for task in tasks: + tasks_response.append(task.to_dict()) + return jsonify(tasks_response), 200 + +@tasks_bp.route("", methods=["GET"]) +def read_task_by_id(task_id): + task = validate_task(task_id) + return jsonify({"task":task.to_dict()}), 200 + +#Helper function for use in READ route: read_task_by_id +def validate_task(id): + try: + task_id = int(id) + except: + abort(make_response(jsonify({"msg":f"invalid id: {id}"}), 400)) + + task = Task.query.get(task_id) + + if not task: + abort(make_response(jsonify({"msg": f"No task found with given id: {id}"}), 404)) + + return task + diff --git a/tests/test_wave_01.py b/tests/test_wave_01.py index e055d3713..d0ea2a7ed 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,11 +60,11 @@ def test_get_task_not_found(client): # Assert assert response.status_code == 404 - 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*************** # ***************************************************************** - + assert response_body == {"msg": "No task found with given id: 1"} #@pytest.mark.skip(reason="No way to test this feature yet") def test_create_task(client): @@ -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 a9852956b2435fca6cb89fd3ae7583eeeb63961a Mon Sep 17 00:00:00 2001 From: takhat Date: Fri, 4 Nov 2022 18:34:35 -0700 Subject: [PATCH 03/19] Wave 1: added UPDATE route: update_task and passed UPDATE tests --- app/routes.py | 20 ++++++++++++++++++++ tests/test_wave_01.py | 7 ++++--- 2 files changed, 24 insertions(+), 3 deletions(-) diff --git a/app/routes.py b/app/routes.py index 7b7fe3d25..e6c6ab95b 100644 --- a/app/routes.py +++ b/app/routes.py @@ -51,3 +51,23 @@ def validate_task(id): return task + +@tasks_bp.route("/", methods=["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"] + if len(request_body) > 2 and request_body["completed_at"]: + task.completed_at = request_body["completed_at"] + db.session.commit() + + return jsonify({"task": { + "id": task.id, + "title": task.title, + "description": task.description, + "is_complete": False if task.completed_at is None else True + }}), 200 + diff --git a/tests/test_wave_01.py b/tests/test_wave_01.py index d0ea2a7ed..5dced0505 100644 --- a/tests/test_wave_01.py +++ b/tests/test_wave_01.py @@ -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={ @@ -131,10 +131,11 @@ def test_update_task_not_found(client): # Assert assert response.status_code == 404 - 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*************** # ***************************************************************** + assert response_body == {"msg": "No task found with given id: 1"} @pytest.mark.skip(reason="No way to test this feature yet") From c6cdcd5d48066031d95491111b6063fd9baa4af3 Mon Sep 17 00:00:00 2001 From: takhat Date: Fri, 4 Nov 2022 18:45:46 -0700 Subject: [PATCH 04/19] Wave 1 done: added DELETE routes and passed DELETE route tests --- app/routes.py | 12 ++++++++++-- tests/test_wave_01.py | 8 ++++---- 2 files changed, 14 insertions(+), 6 deletions(-) diff --git a/app/routes.py b/app/routes.py index e6c6ab95b..c1cf88572 100644 --- a/app/routes.py +++ b/app/routes.py @@ -37,7 +37,7 @@ def read_task_by_id(task_id): task = validate_task(task_id) return jsonify({"task":task.to_dict()}), 200 -#Helper function for use in READ route: read_task_by_id +#Helper function for use in READ route: read_task_by_id and UPDATE route: update_task def validate_task(id): try: task_id = int(id) @@ -51,7 +51,7 @@ def validate_task(id): return task - +#UPDATE Routes @tasks_bp.route("/", methods=["PUT"]) def update_task(task_id): @@ -71,3 +71,11 @@ def update_task(task_id): "is_complete": False if task.completed_at is None else True }}), 200 +# DELETE Routes +@tasks_bp.route("/", methods=["DELETE"]) +def delete_route(task_id): + task = validate_task(task_id) + db.session.delete(task) + db.session.commit() + return jsonify({"details": f'Task {task_id} "{task.title}" successfully deleted'}), 200 + diff --git a/tests/test_wave_01.py b/tests/test_wave_01.py index 5dced0505..d9b42489b 100644 --- a/tests/test_wave_01.py +++ b/tests/test_wave_01.py @@ -138,7 +138,7 @@ def test_update_task_not_found(client): assert response_body == {"msg": "No task found with given id: 1"} -@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") @@ -153,7 +153,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") @@ -162,11 +162,11 @@ def test_delete_task_not_found(client): # Assert assert response.status_code == 404 - 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*************** # ***************************************************************** - + assert response_body == {"msg": "No task found with given id: 1"} assert Task.query.all() == [] From fb8fbb155b19bb172ba12ac343350251e205d27c Mon Sep 17 00:00:00 2001 From: takhat Date: Sat, 5 Nov 2022 20:31:34 -0700 Subject: [PATCH 05/19] Wave 2 complete: added query param: sort, added addl. tests to ignore case, passed all tests. --- app/routes.py | 28 +++++--- tests/test_wave_02.py | 159 +++++++++++++++++++++++++++++++++++++++++- 2 files changed, 174 insertions(+), 13 deletions(-) diff --git a/app/routes.py b/app/routes.py index c1cf88572..aaec29a47 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,10 +1,11 @@ from flask import Blueprint, jsonify, make_response, request, abort from app import db from app.models.task import Task +from sqlalchemy import desc #(used in read_all_tasks for sorting) tasks_bp = Blueprint("tasks", __name__, url_prefix="/tasks") -#CREATE Routes +#CREATE Routes (Wave 1: CRUD Routes) @tasks_bp.route("", methods=["POST"]) def create_task(): request_body = request.get_json() @@ -16,15 +17,20 @@ def create_task(): db.session.commit() return jsonify({"task": new_task.to_dict()}), 201 -#READ Routes +#READ Routes (Wave 1: CRUD routes) @tasks_bp.route("", methods=["GET"]) def read_all_tasks(): - title_query_val = request.args.get("title") - date_query_val = request.args.get("completed_at") - if title_query_val is not None: - tasks = Task.query.filter_by(title=title_query_val) - elif date_query_val is not None: - tasks = Task.query.filter_by(completed_at=date_query_val) + #(Wave 2: Query param: sort) + if "sort"in request.args or "SORT" in request.args: + sort_query_val = request.args.get("sort") if "sort"in request.args else \ + request.args.get("SORT") + if sort_query_val.lower() == "asc": + tasks = Task.query.order_by(Task.title).all() + elif sort_query_val.lower() == "desc": + tasks = Task.query.order_by(Task.title.desc()).all() + # Source: https://stackoverflow.com/questions/4186062/sqlalchemy-order-by-descending + else: + return jsonify({"msg": f"Invalid query value: {sort_query_val}"}), 400 else: tasks = Task.query.all() tasks_response = [] @@ -33,7 +39,7 @@ def read_all_tasks(): return jsonify(tasks_response), 200 @tasks_bp.route("", methods=["GET"]) -def read_task_by_id(task_id): +def read_task_by_id(task_id): task = validate_task(task_id) return jsonify({"task":task.to_dict()}), 200 @@ -51,7 +57,7 @@ def validate_task(id): return task -#UPDATE Routes +#UPDATE Routes (Wave 1: CRUD Routes) @tasks_bp.route("/", methods=["PUT"]) def update_task(task_id): @@ -71,7 +77,7 @@ def update_task(task_id): "is_complete": False if task.completed_at is None else True }}), 200 -# DELETE Routes +# DELETE Routes (Wave 1: CRUD Routes) @tasks_bp.route("/", methods=["DELETE"]) def delete_route(task_id): task = validate_task(task_id) diff --git a/tests/test_wave_02.py b/tests/test_wave_02.py index a087e0909..0159faf3f 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") @@ -27,9 +27,85 @@ def test_get_tasks_sorted_asc(client, three_tasks): "description": "", "is_complete": False} ] +#@pytest.mark.skip(reason="No way to test this feature yet") +def test_get_tasks_sorted_asc_ignore_case_SORT(client, three_tasks): + # Act + response = client.get("/tasks?SORT=asc") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert len(response_body) == 3 + assert response_body == [ + { + "id": 2, + "title": "Answer forgotten email 📧", + "description": "", + "is_complete": False}, + { + "id": 3, + "title": "Pay my outstanding tickets 😭", + "description": "", + "is_complete": False}, + { + "id": 1, + "title": "Water the garden 🌷", + "description": "", + "is_complete": False} + ] +#@pytest.mark.skip(reason="No way to test this feature yet") +def test_get_tasks_sorted_asc_ignore_case_ASC(client, three_tasks): + # Act + response = client.get("/tasks?sort=ASC") + response_body = response.get_json() + # Assert + assert response.status_code == 200 + assert len(response_body) == 3 + assert response_body == [ + { + "id": 2, + "title": "Answer forgotten email 📧", + "description": "", + "is_complete": False}, + { + "id": 3, + "title": "Pay my outstanding tickets 😭", + "description": "", + "is_complete": False}, + { + "id": 1, + "title": "Water the garden 🌷", + "description": "", + "is_complete": False} + ] +#@pytest.mark.skip(reason="No way to test this feature yet") +def test_get_tasks_sorted_asc_ignore_case_SORT_ASC(client, three_tasks): + # Act + response = client.get("/tasks?SORT=ASC") + response_body = response.get_json() -@pytest.mark.skip(reason="No way to test this feature yet") + # Assert + assert response.status_code == 200 + assert len(response_body) == 3 + assert response_body == [ + { + "id": 2, + "title": "Answer forgotten email 📧", + "description": "", + "is_complete": False}, + { + "id": 3, + "title": "Pay my outstanding tickets 😭", + "description": "", + "is_complete": False}, + { + "id": 1, + "title": "Water the garden 🌷", + "description": "", + "is_complete": False} + ] +#@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") @@ -55,3 +131,82 @@ def test_get_tasks_sorted_desc(client, three_tasks): "is_complete": False, "title": "Answer forgotten email 📧"}, ] + +#@pytest.mark.skip(reason="No way to test this feature yet") +def test_get_tasks_sorted_desc_ignore_case_SORT(client, three_tasks): + # Act + response = client.get("/tasks?SORT=desc") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert len(response_body) == 3 + assert response_body == [ + { + "description": "", + "id": 1, + "is_complete": False, + "title": "Water the garden 🌷"}, + { + "description": "", + "id": 3, + "is_complete": False, + "title": "Pay my outstanding tickets 😭"}, + { + "description": "", + "id": 2, + "is_complete": False, + "title": "Answer forgotten email 📧"}, + ] +#@pytest.mark.skip(reason="No way to test this feature yet") +def test_get_tasks_sorted_desc_ignore_case_DESC(client, three_tasks): + # Act + response = client.get("/tasks?sort=DESC") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert len(response_body) == 3 + assert response_body == [ + { + "description": "", + "id": 1, + "is_complete": False, + "title": "Water the garden 🌷"}, + { + "description": "", + "id": 3, + "is_complete": False, + "title": "Pay my outstanding tickets 😭"}, + { + "description": "", + "id": 2, + "is_complete": False, + "title": "Answer forgotten email 📧"}, + ] +#@pytest.mark.skip(reason="No way to test this feature yet") +def test_get_tasks_sorted_desc_ignore_case_SORT_DESC(client, three_tasks): + # Act + response = client.get("/tasks?SORT=DESC") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert len(response_body) == 3 + assert response_body == [ + { + "description": "", + "id": 1, + "is_complete": False, + "title": "Water the garden 🌷"}, + { + "description": "", + "id": 3, + "is_complete": False, + "title": "Pay my outstanding tickets 😭"}, + { + "description": "", + "id": 2, + "is_complete": False, + "title": "Answer forgotten email 📧"}, + ] \ No newline at end of file From a1a869c93ba795f708ddb6881aa0783ea5877268 Mon Sep 17 00:00:00 2001 From: takhat Date: Sat, 5 Nov 2022 21:12:36 -0700 Subject: [PATCH 06/19] Wave 3 complete: added PATCH(update) route, passed related tests --- app/routes.py | 13 +++++++++++++ tests/test_wave_03.py | 19 ++++++++++--------- 2 files changed, 23 insertions(+), 9 deletions(-) diff --git a/app/routes.py b/app/routes.py index aaec29a47..40eb17d04 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,3 +1,4 @@ +from datetime import datetime from flask import Blueprint, jsonify, make_response, request, abort from app import db from app.models.task import Task @@ -76,6 +77,18 @@ def update_task(task_id): "description": task.description, "is_complete": False if task.completed_at is None else True }}), 200 + +#UPDATE Routes (Wave 3: PATCH Routes) +@tasks_bp.route("//", methods=["PATCH"]) +def update_task_mark_complete_or_incomplete(task_id, mark): + task = validate_task(task_id) + if mark == "mark_complete": + task.completed_at = datetime.utcnow().date() + #Source: https://stackoverflow.com/questions/27587127/how-to-convert-datetime-date-today-to-utc-time + elif mark == "mark_incomplete": + task.completed_at = None + db.session.commit() + return jsonify({"task":task.to_dict()}), 200 # DELETE Routes (Wave 1: CRUD Routes) @tasks_bp.route("/", methods=["DELETE"]) diff --git a/tests/test_wave_03.py b/tests/test_wave_03.py index 32d379822..a595f8837 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,13 @@ def test_mark_complete_missing_task(client): # Assert assert response.status_code == 404 - 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*************** # ***************************************************************** + assert response_body == {"msg": "No task found with given id: 1"} - -@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 +143,8 @@ def test_mark_incomplete_missing_task(client): # Assert assert response.status_code == 404 - 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*************** # ***************************************************************** + assert response_body == {"msg": "No task found with given id: 1"} \ No newline at end of file From 5231e73e56fdc690755fdf55c7ff80b2c4cffa93 Mon Sep 17 00:00:00 2001 From: takhat Date: Tue, 8 Nov 2022 16:12:00 -0800 Subject: [PATCH 07/19] wave 4 complete: using an external web api (slack api) --- app/routes.py | 48 +++++++++++++++++++++++++++++++++++++++---- tests/test_wave_03.py | 8 ++++---- 2 files changed, 48 insertions(+), 8 deletions(-) diff --git a/app/routes.py b/app/routes.py index 40eb17d04..ebf815043 100644 --- a/app/routes.py +++ b/app/routes.py @@ -3,6 +3,13 @@ from app import db from app.models.task import Task from sqlalchemy import desc #(used in read_all_tasks for sorting) +import os +from slackclient import SlackClient + + +SLACK_TOKEN = os.environ.get('SLACK_TOKEN', None) +slack_client = SlackClient(SLACK_TOKEN) + tasks_bp = Blueprint("tasks", __name__, url_prefix="/tasks") @@ -10,12 +17,15 @@ @tasks_bp.route("", methods=["POST"]) def create_task(): request_body = request.get_json() + try: new_task = Task.from_dict(request_body) except KeyError: return jsonify ({"details": "Invalid data"}), 400 + db.session.add(new_task) db.session.commit() + return jsonify({"task": new_task.to_dict()}), 201 #READ Routes (Wave 1: CRUD routes) @@ -25,23 +35,31 @@ def read_all_tasks(): if "sort"in request.args or "SORT" in request.args: sort_query_val = request.args.get("sort") if "sort"in request.args else \ request.args.get("SORT") + if sort_query_val.lower() == "asc": tasks = Task.query.order_by(Task.title).all() + elif sort_query_val.lower() == "desc": tasks = Task.query.order_by(Task.title.desc()).all() # Source: https://stackoverflow.com/questions/4186062/sqlalchemy-order-by-descending + else: return jsonify({"msg": f"Invalid query value: {sort_query_val}"}), 400 + else: tasks = Task.query.all() - tasks_response = [] - for task in tasks: - tasks_response.append(task.to_dict()) + + tasks_response = [task.to_dict() for task in tasks] + + # for task in tasks: + # tasks_response.append(task.to_dict()) + return jsonify(tasks_response), 200 @tasks_bp.route("", methods=["GET"]) def read_task_by_id(task_id): task = validate_task(task_id) + return jsonify({"task":task.to_dict()}), 200 #Helper function for use in READ route: read_task_by_id and UPDATE route: update_task @@ -67,8 +85,10 @@ def update_task(task_id): task.title = request_body["title"] task.description = request_body["description"] + if len(request_body) > 2 and request_body["completed_at"]: task.completed_at = request_body["completed_at"] + db.session.commit() return jsonify({"task": { @@ -82,19 +102,39 @@ def update_task(task_id): @tasks_bp.route("//", methods=["PATCH"]) def update_task_mark_complete_or_incomplete(task_id, mark): task = validate_task(task_id) + if mark == "mark_complete": task.completed_at = datetime.utcnow().date() - #Source: https://stackoverflow.com/questions/27587127/how-to-convert-datetime-date-today-to-utc-time + #Source: https://stackoverflow.com/questions/27587127/how-to-convert-datetime-date-today-to-utc-time + + channel_id = "C04A2GQ53NF" + message = f"Someone just completed the task {task.title}" + + send_message(channel_id=channel_id, message=message) + #Source: https://realpython.com/getting-started-with-the-slack-api-using-python-and-flask/ + elif mark == "mark_incomplete": task.completed_at = None + db.session.commit() + return jsonify({"task":task.to_dict()}), 200 # DELETE Routes (Wave 1: CRUD Routes) @tasks_bp.route("/", methods=["DELETE"]) def delete_route(task_id): task = validate_task(task_id) + db.session.delete(task) db.session.commit() + return jsonify({"details": f'Task {task_id} "{task.title}" successfully deleted'}), 200 +#Helper Function to call slack api +def send_message(channel_id, message): + slack_client.api_call( + "chat.postMessage", + channel=channel_id, + text=message, + ) +#Source: https://api.slack.com/methods/chat.postMessage/code diff --git a/tests/test_wave_03.py b/tests/test_wave_03.py index a595f8837..50be0acc6 100644 --- a/tests/test_wave_03.py +++ b/tests/test_wave_03.py @@ -23,8 +23,8 @@ def test_mark_complete_on_incomplete_task(client, one_task): with patch("requests.post") as mock_get: mock_get.return_value.status_code = 200 - # Act - response = client.patch("/tasks/1/mark_complete") + # Act + response = client.patch("/tasks/1/mark_complete") response_body = response.get_json() # Assert @@ -80,8 +80,8 @@ def test_mark_complete_on_completed_task(client, completed_task): with patch("requests.post") as mock_get: mock_get.return_value.status_code = 200 - # Act - response = client.patch("/tasks/1/mark_complete") + # Act + response = client.patch("/tasks/1/mark_complete") response_body = response.get_json() # Assert From df459dd9e3fec99420b1c631f518d8504f64e604 Mon Sep 17 00:00:00 2001 From: takhat Date: Tue, 8 Nov 2022 17:00:56 -0800 Subject: [PATCH 08/19] refactored Wave 4: call external apis using responses library instead of slackclient --- app/routes.py | 40 +++++++++++++++++++++++++++------------- 1 file changed, 27 insertions(+), 13 deletions(-) diff --git a/app/routes.py b/app/routes.py index ebf815043..67731e5b7 100644 --- a/app/routes.py +++ b/app/routes.py @@ -3,12 +3,12 @@ from app import db from app.models.task import Task from sqlalchemy import desc #(used in read_all_tasks for sorting) -import os -from slackclient import SlackClient - +import requests +import os +# from slackclient import SlackClient #Alternate method 3 (below to call external api) SLACK_TOKEN = os.environ.get('SLACK_TOKEN', None) -slack_client = SlackClient(SLACK_TOKEN) +# slack_client = SlackClient(SLACK_TOKEN) #Alternate method 3 tasks_bp = Blueprint("tasks", __name__, url_prefix="/tasks") @@ -107,10 +107,24 @@ def update_task_mark_complete_or_incomplete(task_id, mark): task.completed_at = datetime.utcnow().date() #Source: https://stackoverflow.com/questions/27587127/how-to-convert-datetime-date-today-to-utc-time - channel_id = "C04A2GQ53NF" + + channel = "text-notifications" message = f"Someone just completed the task {task.title}" + access_token = SLACK_TOKEN + my_headers = {'Authorization' : f'Bearer {access_token}'} + + #Method 1: + response = requests.post(f'https://slack.com/api/chat.postMessage', + data={"channel": channel,"text": message}, + headers=my_headers,json=True) + + #Alternate Method 2: + #response = requests.post(f'https://slack.com/api/chat.postMessage?channel={channel}&text={message}&pretty=1', headers=my_headers) + #Source: https://www.nylas.com/blog/use-python-requests-module-rest-apis/ - send_message(channel_id=channel_id, message=message) + #Alternate Method 3: + # channel_id = "C04A2GQ53NF" + # send_message(channel_id=channel_id, message=message) #Source: https://realpython.com/getting-started-with-the-slack-api-using-python-and-flask/ elif mark == "mark_incomplete": @@ -130,11 +144,11 @@ def delete_route(task_id): return jsonify({"details": f'Task {task_id} "{task.title}" successfully deleted'}), 200 -#Helper Function to call slack api -def send_message(channel_id, message): - slack_client.api_call( - "chat.postMessage", - channel=channel_id, - text=message, - ) +#Helper Function to call slack api (Alternate Method 3) +# def send_message(channel_id, message): +# slack_client.api_call( +# "chat.postMessage", +# channel=channel_id, +# text=message, +# ) #Source: https://api.slack.com/methods/chat.postMessage/code From 0ba5e71e5f80afdf45229a601d9e36a2081562d7 Mon Sep 17 00:00:00 2001 From: takhat Date: Tue, 8 Nov 2022 17:16:31 -0800 Subject: [PATCH 09/19] minor refactor --- app/routes.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/routes.py b/app/routes.py index 67731e5b7..39016fab9 100644 --- a/app/routes.py +++ b/app/routes.py @@ -136,7 +136,7 @@ def update_task_mark_complete_or_incomplete(task_id, mark): # DELETE Routes (Wave 1: CRUD Routes) @tasks_bp.route("/", methods=["DELETE"]) -def delete_route(task_id): +def delete_task(task_id): task = validate_task(task_id) db.session.delete(task) From 59508196276cf19de21ed72ad18ea5b947220d4e Mon Sep 17 00:00:00 2001 From: takhat Date: Wed, 9 Nov 2022 15:31:30 -0800 Subject: [PATCH 10/19] Wave 5 complete: added Goal Model to define one-to-many relationship and passed all tests --- app/__init__.py | 4 +- app/goal_routes.py | 64 ++++++++++++++++++++++++++++ app/models/goal.py | 29 ++++++++++++- app/models/task.py | 6 +++ app/{routes.py => task_routes.py} | 24 ++++++----- migrations/versions/af5e2653f654_.py | 32 ++++++++++++++ tests/test_wave_05.py | 63 ++++++++++++++++++--------- 7 files changed, 190 insertions(+), 32 deletions(-) create mode 100644 app/goal_routes.py rename app/{routes.py => task_routes.py} (89%) create mode 100644 migrations/versions/af5e2653f654_.py diff --git a/app/__init__.py b/app/__init__.py index 30052751d..74797ff6d 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -30,7 +30,9 @@ def create_app(test_config=None): migrate.init_app(app, db) # Register Blueprints here - from .routes import tasks_bp + from .task_routes import tasks_bp app.register_blueprint(tasks_bp) + from .goal_routes import goals_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..f5b89ef83 --- /dev/null +++ b/app/goal_routes.py @@ -0,0 +1,64 @@ + +from datetime import datetime +from flask import Blueprint, jsonify, make_response, request, abort +from app import db +from app.models.task import Task +from app.models.goal import Goal +from sqlalchemy import desc #(used in read_all_tasks for sorting) +import os +from .task_routes import validate_model + +goals_bp = Blueprint("goal", __name__, url_prefix="/goals") + +#CREATE Routes (Wave 5: CRUD Routes for goal model) + +@goals_bp.route('', methods=['POST']) +def create_goal(): + request_body = request.get_json() + try: + new_goal = Goal.from_dict(request_body) + except KeyError: + return jsonify ({"details": "Invalid data"}), 400 + + db.session.add(new_goal) + db.session.commit() + + return jsonify({"goal": new_goal.to_dict()}), 201 + + +@goals_bp.route('', methods=["GET"]) +def get_all_goals(): + goals = Goal.query.all() + + result = [item.to_dict() for item in goals] + + return jsonify(result), 200 + +@goals_bp.route("", methods=["GET"]) +def read_goal_by_id(goal_id): + chosen_goal = validate_model(Goal, goal_id) + + return jsonify({"goal": chosen_goal.to_dict()}), 200 + +@goals_bp.route('/', methods=['PUT']) +def update_one_goal(goal_id): + update_goal = validate_model(Goal, goal_id) + + request_body = request.get_json() + + try: + update_goal.title = request_body["title"] + except KeyError: + return jsonify({"msg": "Missing needed data"}), 400 + + db.session.commit() + return jsonify({"msg": f"Successfully updated goal with id {update_goal.goal_id}"}), 200 + +@goals_bp.route('/', methods=['DELETE']) +def delete_one_goal(goal_id): + goal_to_delete = validate_model(Goal, goal_id) + + db.session.delete(goal_to_delete) + db.session.commit() + + return jsonify({"details": f'Goal {goal_to_delete.goal_id} "{goal_to_delete.title}" successfully deleted'}), 200 diff --git a/app/models/goal.py b/app/models/goal.py index b0ed11dd8..df789ec9b 100644 --- a/app/models/goal.py +++ b/app/models/goal.py @@ -2,4 +2,31 @@ class Goal(db.Model): - goal_id = db.Column(db.Integer, primary_key=True) + goal_id = db.Column( + db.Integer, + primary_key=True) + + title = db.Column(db.String) + task_items = db.relationship( + "Task", + back_populates = 'goal') + + def to_dict(self): + return { + "id": self.goal_id, + "title": self.title, + #"task_items": self.task_items + } + + def get_task_items(self): + list_of_tasks = [item.to_dict() for item in self.task_items] + + @classmethod + def from_dict(cls, dict): + return cls ( + title = dict["title"], + ) if len(dict) == 1 else cls ( + title = dict["title"], + description = dict["description"], + task_items = dict["task_items"] + ) diff --git a/app/models/task.py b/app/models/task.py index 2d7408c54..63a4ef2f0 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -12,6 +12,12 @@ class Task(db.Model): completed_at = db.Column(db.DateTime, nullable = True, default = None) + goal_id = db.Column( + db.Integer, + db.ForeignKey("goal.goal_id")) + goal = db.relationship( + "Goal", + back_populates='task_items') def to_dict(self): return { diff --git a/app/routes.py b/app/task_routes.py similarity index 89% rename from app/routes.py rename to app/task_routes.py index 39016fab9..fa189626d 100644 --- a/app/routes.py +++ b/app/task_routes.py @@ -2,6 +2,7 @@ from flask import Blueprint, jsonify, make_response, request, abort from app import db from app.models.task import Task +from app.models.goal import Goal from sqlalchemy import desc #(used in read_all_tasks for sorting) import requests import os @@ -58,29 +59,29 @@ def read_all_tasks(): @tasks_bp.route("", methods=["GET"]) def read_task_by_id(task_id): - task = validate_task(task_id) + task = validate_model(Task, task_id) return jsonify({"task":task.to_dict()}), 200 #Helper function for use in READ route: read_task_by_id and UPDATE route: update_task -def validate_task(id): +def validate_model(cls, id): try: - task_id = int(id) + model_id = int(id) except: - abort(make_response(jsonify({"msg":f"invalid id: {id}"}), 400)) + abort(make_response(jsonify({"msg":f"invalid id: {model_id}"}), 400)) - task = Task.query.get(task_id) + chosen_object = cls.query.get(model_id) - if not task: - abort(make_response(jsonify({"msg": f"No task found with given id: {id}"}), 404)) + if not chosen_object: + abort(make_response(jsonify({"msg": f"No {cls.__name__.lower()} found with given id: {model_id}"}), 404)) - return task + return chosen_object #UPDATE Routes (Wave 1: CRUD Routes) @tasks_bp.route("/", methods=["PUT"]) def update_task(task_id): - task = validate_task(task_id) + task = validate_model(Task, task_id) request_body = request.get_json() task.title = request_body["title"] @@ -101,7 +102,7 @@ def update_task(task_id): #UPDATE Routes (Wave 3: PATCH Routes) @tasks_bp.route("//", methods=["PATCH"]) def update_task_mark_complete_or_incomplete(task_id, mark): - task = validate_task(task_id) + task = validate_model(Task, task_id) if mark == "mark_complete": task.completed_at = datetime.utcnow().date() @@ -137,7 +138,7 @@ def update_task_mark_complete_or_incomplete(task_id, mark): # DELETE Routes (Wave 1: CRUD Routes) @tasks_bp.route("/", methods=["DELETE"]) def delete_task(task_id): - task = validate_task(task_id) + task = validate_model(Task, task_id) db.session.delete(task) db.session.commit() @@ -152,3 +153,4 @@ def delete_task(task_id): # text=message, # ) #Source: https://api.slack.com/methods/chat.postMessage/code + diff --git a/migrations/versions/af5e2653f654_.py b/migrations/versions/af5e2653f654_.py new file mode 100644 index 000000000..c8cdd3e81 --- /dev/null +++ b/migrations/versions/af5e2653f654_.py @@ -0,0 +1,32 @@ +"""empty message + +Revision ID: af5e2653f654 +Revises: af5b9f6159e5 +Create Date: 2022-11-09 13:32:39.893322 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'af5e2653f654' +down_revision = 'af5b9f6159e5' +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.add_column('goal', sa.Column('title', sa.String(), nullable=True)) + 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') + op.drop_column('goal', 'title') + # ### end Alembic commands ### diff --git a/tests/test_wave_05.py b/tests/test_wave_05.py index aee7c52a1..ed50388f5 100644 --- a/tests/test_wave_05.py +++ b/tests/test_wave_05.py @@ -1,7 +1,8 @@ +from app.models.goal import Goal 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 +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") + #raise Exception("Complete test") # Assert # ---- Complete Test ---- # assertion 1 goes here + assert response.status_code == 404 # assertion 2 goes here + assert response_body == {"msg": "No goal found with given id: 1"} # ---- 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,52 @@ 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 # ---- Complete Act Here ---- - + response = client.put("/goals/1", json={ + "title": "Do a random act of kindness." + }) + response_body = response.get_json() + # Assert # ---- Complete Assertions Here ---- # assertion 1 goes here + assert response.status_code == 200 # assertion 2 goes here + assert "msg" in response_body # assertion 3 goes here + assert response_body=={ + "msg": "Successfully updated goal with id 1" + } + goal = Goal.query.get(1) + assert goal.title == "Do a random act of kindness." + assert goal.goal_id == 1 # ---- 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") + #raise Exception("Complete test") # Act # ---- Complete Act Here ---- - + response = client.put("/goals/1", json={ + "title": "Do a random act of kindness." + }) + 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 == {"msg": "No goal found with given id: 1"} # ---- 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") @@ -124,27 +145,31 @@ def test_delete_goal(client, one_goal): response = client.get("/goals/1") assert response.status_code == 404 - 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*************** # ***************************************************************** + assert response.get_json() == {"msg": "No goal found with given id: 1"} - -@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 + assert "msg" in response_body # assertion 2 goes here + assert response_body == {"msg": "No goal found with given id: 1"} # ---- 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 b9a572923c3da4835cb150917292635976d040bf Mon Sep 17 00:00:00 2001 From: takhat Date: Wed, 9 Nov 2022 18:37:07 -0800 Subject: [PATCH 11/19] Wave 6 complete: added one-to-many relationship between goal and tasks and passed tests --- app/goal_routes.py | 38 ++++++++++++++++++++++++++++++++++++-- app/models/goal.py | 25 +++++++++++++++++++------ app/models/task.py | 13 +++++++++++-- app/task_routes.py | 5 +++-- tests/test_wave_06.py | 17 +++++++++-------- 5 files changed, 78 insertions(+), 20 deletions(-) diff --git a/app/goal_routes.py b/app/goal_routes.py index f5b89ef83..3bf1d7aed 100644 --- a/app/goal_routes.py +++ b/app/goal_routes.py @@ -28,9 +28,9 @@ def create_goal(): @goals_bp.route('', methods=["GET"]) def get_all_goals(): - goals = Goal.query.all() + all_goals = Goal.query.all() - result = [item.to_dict() for item in goals] + result = [item.to_dict() for item in all_goals] return jsonify(result), 200 @@ -62,3 +62,37 @@ def delete_one_goal(goal_id): db.session.commit() return jsonify({"details": f'Goal {goal_to_delete.goal_id} "{goal_to_delete.title}" successfully deleted'}), 200 + +#Wave 6: Nested Routes +@goals_bp.route('//tasks', methods=['POST']) +def add_task_ids_to_goal(goal_id): + chosen_goal = validate_model(Goal, goal_id) + + request_body = request.get_json() + task_ids = request_body["task_ids"] + + for id in task_ids: + task = Task.query.get(int(id)) + if task not in chosen_goal.tasks: + chosen_goal.tasks.append(task) + #db.session.add(task) + db.session.commit() + + return jsonify({ + "id" : int(goal_id), + "task_ids": task_ids + }), 200 + +@goals_bp.route('//tasks', methods=['GET']) +def get_tasks_by_goal_id(goal_id): + chosen_goal = validate_model(Goal, goal_id) + + return jsonify(chosen_goal.to_dict_incl_tasks()), 200 + + + + + + + + diff --git a/app/models/goal.py b/app/models/goal.py index df789ec9b..f41ffd269 100644 --- a/app/models/goal.py +++ b/app/models/goal.py @@ -7,20 +7,33 @@ class Goal(db.Model): primary_key=True) title = db.Column(db.String) - task_items = db.relationship( + tasks = db.relationship( "Task", - back_populates = 'goal') + back_populates = 'goal', lazy = True) def to_dict(self): return { "id": self.goal_id, "title": self.title, - #"task_items": self.task_items + #"tasks": self.tasks } + + def to_dict_incl_tasks(self): + tasks = self.get_task_items() + return { + "id": self.goal_id, + "title": self.title, + "tasks": tasks + } + + #Helper method to use in to_dict_incl_tasks() def get_task_items(self): - list_of_tasks = [item.to_dict() for item in self.task_items] - + if self.tasks is None: + return None + list_of_tasks = [item.to_dict_incl_goal_id() for item in self.tasks] + return list_of_tasks + @classmethod def from_dict(cls, dict): return cls ( @@ -28,5 +41,5 @@ def from_dict(cls, dict): ) if len(dict) == 1 else cls ( title = dict["title"], description = dict["description"], - task_items = dict["task_items"] + tasks = dict["tasks"] ) diff --git a/app/models/task.py b/app/models/task.py index 63a4ef2f0..5f6ce9726 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -14,10 +14,11 @@ class Task(db.Model): default = None) goal_id = db.Column( db.Integer, - db.ForeignKey("goal.goal_id")) + db.ForeignKey("goal.goal_id"), + nullable = True) goal = db.relationship( "Goal", - back_populates='task_items') + back_populates='tasks') def to_dict(self): return { @@ -29,6 +30,14 @@ def to_dict(self): # Source: # https://stackoverflow.com/questions/52325025/use-of-if-else-inside-a-dict-to-set-a-value-to-key-using-python + def to_dict_incl_goal_id(self): + return{ + "id": self.id, + "goal_id": self.goal_id, + "title": self.title, + "description": self.description, + "is_complete": False if self.completed_at is None else True + } @classmethod def from_dict(cls, dict): return cls ( diff --git a/app/task_routes.py b/app/task_routes.py index fa189626d..a953ad738 100644 --- a/app/task_routes.py +++ b/app/task_routes.py @@ -60,8 +60,9 @@ def read_all_tasks(): @tasks_bp.route("", methods=["GET"]) def read_task_by_id(task_id): task = validate_model(Task, task_id) - - return jsonify({"task":task.to_dict()}), 200 + if task.goal_id is None: + return jsonify({"task":task.to_dict()}), 200 + return jsonify({"task":task.to_dict_incl_goal_id()}), 200 #Helper function for use in READ route: read_task_by_id and UPDATE route: update_task def validate_model(cls, id): diff --git a/tests/test_wave_06.py b/tests/test_wave_06.py index 8afa4325e..9fa61d0c1 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") @@ -51,13 +51,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") + #raise Exception("Complete test with assertion about response body") # ***************************************************************** # **Complete test with assertion about response body*************** # ***************************************************************** + assert "msg" in response_body + assert response_body == {"msg": "No goal found with given id: 1"} - -@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 +75,7 @@ def test_get_tasks_for_specific_goal_no_tasks(client, one_goal): } -@pytest.mark.skip(reason="No way to test this feature yet") +#@pytest.mark.skip(reason="No way to test this feature yet") def test_get_tasks_for_specific_goal(client, one_task_belongs_to_one_goal): # Act response = client.get("/goals/1/tasks") @@ -99,7 +100,7 @@ def test_get_tasks_for_specific_goal(client, one_task_belongs_to_one_goal): } -@pytest.mark.skip(reason="No way to test this feature yet") +#@pytest.mark.skip(reason="No way to test this feature yet") def test_get_task_includes_goal_id(client, one_task_belongs_to_one_goal): response = client.get("/tasks/1") response_body = response.get_json() From 58bacf6489f50dc4218b03833b79aa5f27642ef0 Mon Sep 17 00:00:00 2001 From: takhat Date: Wed, 9 Nov 2022 21:58:04 -0800 Subject: [PATCH 12/19] adding Procfile --- Procfile | 1 + 1 file changed, 1 insertion(+) 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 From 531def4f4fad8b6fc916372613dd3ed8f3dd1516 Mon Sep 17 00:00:00 2001 From: takhat Date: Wed, 9 Nov 2022 22:38:55 -0800 Subject: [PATCH 13/19] refactored from_dict method to allow creating task with goal_id added too --- app/models/task.py | 27 ++++++++++++++++++--------- 1 file changed, 18 insertions(+), 9 deletions(-) diff --git a/app/models/task.py b/app/models/task.py index 5f6ce9726..7c4d1fc69 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -40,15 +40,24 @@ def to_dict_incl_goal_id(self): } @classmethod def from_dict(cls, dict): - return cls ( - title = dict["title"], - description = dict["description"] - ) if len(dict) == 2 else cls ( - title = dict["title"], - description = dict["description"], - completed_at = dict["completed_at"] - ) - + if "completed_at" in dict.keys() and "goal_id" in dict.keys(): + return cls ( + goal_id = dict["goal_id"], + title = dict["title"], + description = dict["description"], + completed_at = dict["completed_at"] + ) + elif "completed_at" in dict.keys(): + return cls ( + title = dict["title"], + description = dict["description"], + completed_at = dict["completed_at"] + ) + else: + return cls ( + title = dict["title"], + description = dict["description"], + ) From bfb2f85ecdc663aca1960589361a0cebddc4a91e Mon Sep 17 00:00:00 2001 From: takhat Date: Wed, 9 Nov 2022 22:49:01 -0800 Subject: [PATCH 14/19] refactored create_task() to return new_task dict with goal_id attribute if its not None. --- app/task_routes.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/app/task_routes.py b/app/task_routes.py index a953ad738..bf59965f8 100644 --- a/app/task_routes.py +++ b/app/task_routes.py @@ -26,7 +26,8 @@ def create_task(): db.session.add(new_task) db.session.commit() - + if new_task.goal_id: + return jsonify({"task": new_task.to_dict_incl_goal_id()}), 201 return jsonify({"task": new_task.to_dict()}), 201 #READ Routes (Wave 1: CRUD routes) From 6f1bbc190666c7b96f7823cd88a8b9f451fa4ecb Mon Sep 17 00:00:00 2001 From: takhat Date: Wed, 9 Nov 2022 22:55:44 -0800 Subject: [PATCH 15/19] refactored create_task() to return new_task dict with goal_id attribute if its not None. --- app/task_routes.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/app/task_routes.py b/app/task_routes.py index bf59965f8..e388e5926 100644 --- a/app/task_routes.py +++ b/app/task_routes.py @@ -26,8 +26,10 @@ def create_task(): db.session.add(new_task) db.session.commit() - if new_task.goal_id: + + if new_task.goal_id is not None: return jsonify({"task": new_task.to_dict_incl_goal_id()}), 201 + return jsonify({"task": new_task.to_dict()}), 201 #READ Routes (Wave 1: CRUD routes) From a65afe6b15140c656a55e42ea3ee098c131c7679 Mon Sep 17 00:00:00 2001 From: takhat Date: Wed, 9 Nov 2022 23:34:13 -0800 Subject: [PATCH 16/19] undo last 3 commits(refactor) --- app/models/goal.py | 3 +-- app/models/task.py | 27 +++++++++------------------ app/task_routes.py | 3 --- 3 files changed, 10 insertions(+), 23 deletions(-) diff --git a/app/models/goal.py b/app/models/goal.py index f41ffd269..83a00b9fa 100644 --- a/app/models/goal.py +++ b/app/models/goal.py @@ -14,8 +14,7 @@ class Goal(db.Model): def to_dict(self): return { "id": self.goal_id, - "title": self.title, - #"tasks": self.tasks + "title": self.title } def to_dict_incl_tasks(self): diff --git a/app/models/task.py b/app/models/task.py index 7c4d1fc69..5f6ce9726 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -40,24 +40,15 @@ def to_dict_incl_goal_id(self): } @classmethod def from_dict(cls, dict): - if "completed_at" in dict.keys() and "goal_id" in dict.keys(): - return cls ( - goal_id = dict["goal_id"], - title = dict["title"], - description = dict["description"], - completed_at = dict["completed_at"] - ) - elif "completed_at" in dict.keys(): - return cls ( - title = dict["title"], - description = dict["description"], - completed_at = dict["completed_at"] - ) - else: - return cls ( - title = dict["title"], - description = dict["description"], - ) + return cls ( + title = dict["title"], + description = dict["description"] + ) if len(dict) == 2 else cls ( + title = dict["title"], + description = dict["description"], + completed_at = dict["completed_at"] + ) + diff --git a/app/task_routes.py b/app/task_routes.py index e388e5926..a953ad738 100644 --- a/app/task_routes.py +++ b/app/task_routes.py @@ -27,9 +27,6 @@ def create_task(): db.session.add(new_task) db.session.commit() - if new_task.goal_id is not None: - return jsonify({"task": new_task.to_dict_incl_goal_id()}), 201 - return jsonify({"task": new_task.to_dict()}), 201 #READ Routes (Wave 1: CRUD routes) From f62b53f1a4e55581fcdc5731a34abf0ff83014b3 Mon Sep 17 00:00:00 2001 From: takhat Date: Wed, 9 Nov 2022 23:59:04 -0800 Subject: [PATCH 17/19] add slack_sdk in req --- requirements.txt | 1 + tests/test_wave_06.py | 3 +-- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/requirements.txt b/requirements.txt index cacdbc36e..ad6b2cbf2 100644 --- a/requirements.txt +++ b/requirements.txt @@ -28,6 +28,7 @@ python-dotenv==0.15.0 python-editor==1.0.4 requests==2.25.1 six==1.15.0 +slack_sdk==3.19.3 SQLAlchemy==1.3.23 toml==0.10.2 urllib3==1.26.5 diff --git a/tests/test_wave_06.py b/tests/test_wave_06.py index 9fa61d0c1..5957a4a6f 100644 --- a/tests/test_wave_06.py +++ b/tests/test_wave_06.py @@ -16,8 +16,7 @@ def test_post_task_ids_to_goal(client, one_goal, three_tasks): assert "task_ids" in response_body assert response_body == { "id": 1, - "task_ids": [1, 2, 3] - } + "task_ids": [1, 2, 3] } # Check that Goal was updated in the db assert len(Goal.query.get(1).tasks) == 3 From d172a6094a2b7a16d2dd498a1fff60e681cb9c22 Mon Sep 17 00:00:00 2001 From: takhat Date: Thu, 10 Nov 2022 11:03:14 -0800 Subject: [PATCH 18/19] refactored add_task_ids_to_goal --- app/goal_routes.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/app/goal_routes.py b/app/goal_routes.py index 3bf1d7aed..ae8b98054 100644 --- a/app/goal_routes.py +++ b/app/goal_routes.py @@ -72,7 +72,8 @@ def add_task_ids_to_goal(goal_id): task_ids = request_body["task_ids"] for id in task_ids: - task = Task.query.get(int(id)) + #task = Task.query.get(int(id)) + task = validate_model(Task, int(id)) if task not in chosen_goal.tasks: chosen_goal.tasks.append(task) #db.session.add(task) From f1434ac946227bc77d2a910b74357aa89f211d0a Mon Sep 17 00:00:00 2001 From: takhat Date: Thu, 10 Nov 2022 11:04:45 -0800 Subject: [PATCH 19/19] refactored add_task_ids_to_goal --- app/goal_routes.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/goal_routes.py b/app/goal_routes.py index ae8b98054..1f40f9c16 100644 --- a/app/goal_routes.py +++ b/app/goal_routes.py @@ -73,7 +73,7 @@ def add_task_ids_to_goal(goal_id): for id in task_ids: #task = Task.query.get(int(id)) - task = validate_model(Task, int(id)) + task = validate_model(Task, id) if task not in chosen_goal.tasks: chosen_goal.tasks.append(task) #db.session.add(task)