From 27f767708bb76179e1e266b158f11e17b51ec5fa Mon Sep 17 00:00:00 2001 From: janicelichtman Date: Tue, 8 Jun 2021 11:44:03 -0700 Subject: [PATCH 01/13] added functionality to get all planets, create a planet, update a planet, get a specific planet --- app/__init__.py | 4 ++- app/models/task.py | 3 +++ app/routes.py | 67 +++++++++++++++++++++++++++++++++++++++++++++- 3 files changed, 72 insertions(+), 2 deletions(-) diff --git a/app/__init__.py b/app/__init__.py index 2764c4cc8..90f13d662 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 39c89cd16..2c4213a7a 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -4,3 +4,6 @@ class Task(db.Model): task_id = db.Column(db.Integer, primary_key=True) + title = db.Column(db.String) + description = db.Column(db.String) + completed_at = db.Column(db.DateTime, nullable=True) \ No newline at end of file diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..3ba6147f2 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,67 @@ -from flask import Blueprint +from app import db +from app.models.task import Task +from flask import Blueprint, request, make_response, jsonify +tasks_bp = Blueprint("tasks", __name__, url_prefix="/tasks") + +@tasks_bp.route("", strict_slashes=False, methods=["GET", "POST"]) +def handle_tasks(): + if request.method == "GET": + tasks = Task.query.order_by(Task.task_id).all() + tasks_response = [] + for task in tasks: + is_complete = True if task.completed_at else False + tasks_response.append({ + "id": task.task_id, + "title": task.title, + "description": task.description, + "is_complete": is_complete + }) + return jsonify(tasks_response) + elif request.method == "POST": + request_body = request.get_json() + new_task = Task(title=request_body["title"], + description=request_body["description"]) + db.session.add(new_task) + db.session.commit() + + is_complete = True if new_task.completed_at else False + return make_response({ + "id": new_task.task_id, + "title": new_task.title, + "description": new_task.description, + "is_complete": is_complete + } + , 201) + +@tasks_bp.route("/", strict_slashes=False, methods=["GET", "PUT", "DELETE"]) +def handle_task(task_id): + task = Task.query.get(task_id) + if not task: + return make_response(f"Task {task_id} not found", 404) + + if request.method == "GET": + is_complete = True if task.completed_at else False + return { + "task": {"id": task.task_id, + "title": task.title, + "description": task.description, + "is_complete": is_complete} + } + elif request.method == "PUT": + form_data = request.get_json() + task.title = form_data["title"], + task.description = form_data["description"] + + db.session.commit() + + is_complete = True if task.completed_at else False + return make_response({ + "task":{ + "id": task.task_id, + "title": task.title, + "description": task.description, + "is_complete": is_complete + } + } + ) \ No newline at end of file From 7dfb30534c46a29845aecdd4fec373f060f5988a Mon Sep 17 00:00:00 2001 From: janicelichtman Date: Tue, 8 Jun 2021 11:44:45 -0700 Subject: [PATCH 02/13] added migrations folder --- migrations/README | 1 + migrations/alembic.ini | 45 +++++++++++++ migrations/env.py | 96 ++++++++++++++++++++++++++++ migrations/script.py.mako | 24 +++++++ migrations/versions/f316224e3645_.py | 39 +++++++++++ 5 files changed, 205 insertions(+) create mode 100644 migrations/README create mode 100644 migrations/alembic.ini create mode 100644 migrations/env.py create mode 100644 migrations/script.py.mako create mode 100644 migrations/versions/f316224e3645_.py 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/f316224e3645_.py b/migrations/versions/f316224e3645_.py new file mode 100644 index 000000000..33ccb547c --- /dev/null +++ b/migrations/versions/f316224e3645_.py @@ -0,0 +1,39 @@ +"""empty message + +Revision ID: f316224e3645 +Revises: +Create Date: 2021-06-08 00:23:37.698984 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'f316224e3645' +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('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 ### From ece374592d582eae4abe8150fb291c84a62f5b95 Mon Sep 17 00:00:00 2001 From: janicelichtman Date: Tue, 8 Jun 2021 14:53:27 -0700 Subject: [PATCH 03/13] wave_01 tests pass --- app/routes.py | 22 ++++++++++++++++++---- 1 file changed, 18 insertions(+), 4 deletions(-) diff --git a/app/routes.py b/app/routes.py index 3ba6147f2..0b4423f82 100644 --- a/app/routes.py +++ b/app/routes.py @@ -20,18 +20,23 @@ def handle_tasks(): return jsonify(tasks_response) elif request.method == "POST": request_body = request.get_json() + for attribute in {"title", "description", "completed_at"}: + if attribute not in request_body: + return make_response({"details": "Invalid data"}, 400) new_task = Task(title=request_body["title"], description=request_body["description"]) db.session.add(new_task) db.session.commit() is_complete = True if new_task.completed_at else False - return make_response({ + return make_response({"task": + { "id": new_task.task_id, "title": new_task.title, "description": new_task.description, - "is_complete": is_complete - } + "is_complete": is_complete + } + } , 201) @tasks_bp.route("/", strict_slashes=False, methods=["GET", "PUT", "DELETE"]) @@ -64,4 +69,13 @@ def handle_task(task_id): "is_complete": is_complete } } - ) \ No newline at end of file + ) + elif request.method == "DELETE": + db.session.delete(task) + db.session.commit() + return make_response( + {"details": + f"Task {task.task_id} \"{task.title}\" successfully deleted" + } + ) + \ No newline at end of file From 42a7933fd6c1a47d1836fd93b0dc1f0476b85167 Mon Sep 17 00:00:00 2001 From: janicelichtman Date: Tue, 8 Jun 2021 16:16:48 -0700 Subject: [PATCH 04/13] wave_02 tests pass --- app/routes.py | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/app/routes.py b/app/routes.py index 0b4423f82..8db6f9f14 100644 --- a/app/routes.py +++ b/app/routes.py @@ -7,7 +7,15 @@ @tasks_bp.route("", strict_slashes=False, methods=["GET", "POST"]) def handle_tasks(): if request.method == "GET": - tasks = Task.query.order_by(Task.task_id).all() + sort_query = request.args.get("sort") + + if sort_query == "asc": + tasks = Task.query.order_by(Task.title).all() + elif sort_query == "desc": + tasks = Task.query.order_by(Task.title.desc()).all() + else: + tasks = Task.query.all() + tasks_response = [] for task in tasks: is_complete = True if task.completed_at else False From 2b9053bbbc75ad06c4578cd1a6ea06c3d343f791 Mon Sep 17 00:00:00 2001 From: janicelichtman Date: Tue, 8 Jun 2021 16:33:36 -0700 Subject: [PATCH 05/13] wave_03 tests pass --- app/routes.py | 40 ++++++++++++++++++++++++++++++++++++++-- 1 file changed, 38 insertions(+), 2 deletions(-) diff --git a/app/routes.py b/app/routes.py index 8db6f9f14..5d8bf9505 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,6 +1,7 @@ from app import db from app.models.task import Task from flask import Blueprint, request, make_response, jsonify +from datetime import datetime tasks_bp = Blueprint("tasks", __name__, url_prefix="/tasks") @@ -32,7 +33,9 @@ def handle_tasks(): if attribute not in request_body: return make_response({"details": "Invalid data"}, 400) new_task = Task(title=request_body["title"], - description=request_body["description"]) + description=request_body["description"], + completed_at=request_body["completed_at"]) + db.session.add(new_task) db.session.commit() @@ -86,4 +89,37 @@ def handle_task(task_id): f"Task {task.task_id} \"{task.title}\" successfully deleted" } ) - \ No newline at end of file + +@tasks_bp.route("//mark_complete", strict_slashes=False, methods=["PATCH"]) +def mark_complete(task_id): + task = Task.query.get(task_id) + if not task: + return make_response(f"Task {task_id} not found", 404) + + task.completed_at = datetime.utcnow() + db.session.commit() + + is_complete = True if task.completed_at else False + return { + "task": {"id": task.task_id, + "title": task.title, + "description": task.description, + "is_complete": is_complete} + } + +@tasks_bp.route("//mark_incomplete", strict_slashes=False, methods=["PATCH"]) +def mark_incomplete(task_id): + task = Task.query.get(task_id) + if not task: + return make_response(f"Task {task_id} not found", 404) + + task.completed_at = None + db.session.commit() + + is_complete = True if task.completed_at else False + return { + "task": {"id": task.task_id, + "title": task.title, + "description": task.description, + "is_complete": is_complete} + } \ No newline at end of file From 4e311f96380ea36563163529d21bb05586535c73 Mon Sep 17 00:00:00 2001 From: janicelichtman Date: Wed, 9 Jun 2021 11:17:53 -0700 Subject: [PATCH 06/13] posts to slack when task is marked complete --- app/routes.py | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/app/routes.py b/app/routes.py index 5d8bf9505..72c2c661d 100644 --- a/app/routes.py +++ b/app/routes.py @@ -2,6 +2,9 @@ from app.models.task import Task from flask import Blueprint, request, make_response, jsonify from datetime import datetime +import os +import requests + tasks_bp = Blueprint("tasks", __name__, url_prefix="/tasks") @@ -90,6 +93,17 @@ def handle_task(task_id): } ) +def post_to_slack(task): + slack_token = os.environ.get("SLACK_POST_MESSAGE_API_TOKEN") + slack_path = "https://slack.com/api/chat.postMessage" + query_params ={ + "channel": "task-notifications", + "text": f"Someone just completed the task {task.title}", + } + headers = {"Authorization": f"Bearer {slack_token}"} + requests.post(slack_path, params = query_params, headers = headers) + + @tasks_bp.route("//mark_complete", strict_slashes=False, methods=["PATCH"]) def mark_complete(task_id): task = Task.query.get(task_id) @@ -99,6 +113,8 @@ def mark_complete(task_id): task.completed_at = datetime.utcnow() db.session.commit() + post_to_slack(task) + is_complete = True if task.completed_at else False return { "task": {"id": task.task_id, @@ -109,6 +125,7 @@ def mark_complete(task_id): @tasks_bp.route("//mark_incomplete", strict_slashes=False, methods=["PATCH"]) def mark_incomplete(task_id): + task = Task.query.get(task_id) if not task: return make_response(f"Task {task_id} not found", 404) From 9676f37c53dd5e78ebccbedf0df0fea447926846 Mon Sep 17 00:00:00 2001 From: janicelichtman Date: Fri, 11 Jun 2021 13:36:06 -0700 Subject: [PATCH 07/13] routes refactored and wave_05 tests pass --- app/__init__.py | 6 +- app/models/goal.py | 1 + app/routes/goal_routes.py | 66 +++++++++++++ app/routes/task_routes.py | 141 +++++++++++++++++++++++++++ migrations/versions/e865491e8337_.py | 28 ++++++ 5 files changed, 240 insertions(+), 2 deletions(-) create mode 100644 app/routes/goal_routes.py create mode 100644 app/routes/task_routes.py create mode 100644 migrations/versions/e865491e8337_.py diff --git a/app/__init__.py b/app/__init__.py index 90f13d662..cd1fa28f0 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 - app.register_blueprint(tasks_bp) + import app.routes.task_routes as task_routes + import app.routes.goal_routes as goal_routes + app.register_blueprint(task_routes.bp) + app.register_blueprint(goal_routes.bp) return app diff --git a/app/models/goal.py b/app/models/goal.py index 8cad278f8..653ac1865 100644 --- a/app/models/goal.py +++ b/app/models/goal.py @@ -4,3 +4,4 @@ class Goal(db.Model): goal_id = db.Column(db.Integer, primary_key=True) + title = db.Column(db.String) \ No newline at end of file diff --git a/app/routes/goal_routes.py b/app/routes/goal_routes.py new file mode 100644 index 000000000..3c1d01df1 --- /dev/null +++ b/app/routes/goal_routes.py @@ -0,0 +1,66 @@ +from app import db +from app.models.goal import Goal +from flask import Blueprint, request, make_response, jsonify + +bp = Blueprint("goals", __name__, url_prefix="/goals") + +@bp.route("", strict_slashes=False, methods=["GET", "POST"]) +def handle_goals(): + if request.method == "GET": + goals = Goal.query.all() + goals_response = [] + for goal in goals: + goals_response.append({ + "id": goal.goal_id, + "title": goal.title + }) + return jsonify(goals_response) + elif request.method == "POST": + request_body = request.get_json() + if "title" not in request_body: + return make_response({"details": "Invalid data"}, 400) + new_goal = Goal(title=request_body["title"]) + + db.session.add(new_goal) + db.session.commit() + + return make_response({"goal": + { + "id": new_goal.goal_id, + "title": new_goal.title + } + } + , 201) + +@bp.route("/", strict_slashes=False, methods=["GET", "PUT", "DELETE"]) +def handle_goal(goal_id): + goal = Goal.query.get(goal_id) + if not goal: + return make_response(f"Goal {goal_id} not found", 404) + + if request.method == "GET": + return { + "goal": {"id": goal.goal_id, + "title": goal.title} + } + elif request.method == "PUT": + form_data = request.get_json() + goal.title = form_data["title"], + + db.session.commit() + + return make_response({ + "goal":{ + "id": goal.goal_id, + "title": goal.title + } + } + ) + elif request.method == "DELETE": + db.session.delete(goal) + db.session.commit() + return make_response( + {"details": + f"Goal {goal.goal_id} \"{goal.title}\" successfully deleted" + } + ) \ No newline at end of file diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py new file mode 100644 index 000000000..38431256f --- /dev/null +++ b/app/routes/task_routes.py @@ -0,0 +1,141 @@ +from app import db +from app.models.task import Task +from flask import Blueprint, request, make_response, jsonify +from datetime import datetime +import os +import requests + +bp = Blueprint("tasks", __name__, url_prefix="/tasks") + +@bp.route("", strict_slashes=False, methods=["GET", "POST"]) +def handle_tasks(): + if request.method == "GET": + sort_query = request.args.get("sort") + + if sort_query == "asc": + tasks = Task.query.order_by(Task.title).all() + elif sort_query == "desc": + tasks = Task.query.order_by(Task.title.desc()).all() + else: + tasks = Task.query.all() + + tasks_response = [] + for task in tasks: + is_complete = True if task.completed_at else False + tasks_response.append({ + "id": task.task_id, + "title": task.title, + "description": task.description, + "is_complete": is_complete + }) + return jsonify(tasks_response) + elif request.method == "POST": + request_body = request.get_json() + for attribute in {"title", "description", "completed_at"}: + if attribute not in request_body: + return make_response({"details": "Invalid data"}, 400) + new_task = Task(title=request_body["title"], + description=request_body["description"], + completed_at=request_body["completed_at"]) + + db.session.add(new_task) + db.session.commit() + + is_complete = True if new_task.completed_at else False + return make_response({"task": + { + "id": new_task.task_id, + "title": new_task.title, + "description": new_task.description, + "is_complete": is_complete + } + } + , 201) + +@bp.route("/", strict_slashes=False, methods=["GET", "PUT", "DELETE"]) +def handle_task(task_id): + task = Task.query.get(task_id) + if not task: + return make_response(f"Task {task_id} not found", 404) + + if request.method == "GET": + is_complete = True if task.completed_at else False + return { + "task": {"id": task.task_id, + "title": task.title, + "description": task.description, + "is_complete": is_complete} + } + elif request.method == "PUT": + form_data = request.get_json() + task.title = form_data["title"], + task.description = form_data["description"] + + db.session.commit() + + is_complete = True if task.completed_at else False + return make_response({ + "task":{ + "id": task.task_id, + "title": task.title, + "description": task.description, + "is_complete": is_complete + } + } + ) + elif request.method == "DELETE": + db.session.delete(task) + db.session.commit() + return make_response( + {"details": + f"Task {task.task_id} \"{task.title}\" successfully deleted" + } + ) + +def post_to_slack(text): + slack_token = os.environ.get("SLACK_POST_MESSAGE_API_TOKEN") + slack_path = "https://slack.com/api/chat.postMessage" + query_params ={ + "channel": "task-notifications", + "text": text, + } + headers = {"Authorization": f"Bearer {slack_token}"} + requests.post(slack_path, params = query_params, headers = headers) + +@bp.route("//mark_complete", strict_slashes=False, methods=["PATCH"]) +def mark_complete(task_id): + task = Task.query.get(task_id) + if not task: + return make_response(f"Task {task_id} not found", 404) + + task.completed_at = datetime.utcnow() + db.session.commit() + + slack_text = f"Someone just completed the task {task.title}" + post_to_slack(slack_text) + + is_complete = True if task.completed_at else False + return { + "task": {"id": task.task_id, + "title": task.title, + "description": task.description, + "is_complete": is_complete} + } + +@bp.route("//mark_incomplete", strict_slashes=False, methods=["PATCH"]) +def mark_incomplete(task_id): + + task = Task.query.get(task_id) + if not task: + return make_response(f"Task {task_id} not found", 404) + + task.completed_at = None + db.session.commit() + + is_complete = True if task.completed_at else False + return { + "task": {"id": task.task_id, + "title": task.title, + "description": task.description, + "is_complete": is_complete} + } diff --git a/migrations/versions/e865491e8337_.py b/migrations/versions/e865491e8337_.py new file mode 100644 index 000000000..b1ac5b2ea --- /dev/null +++ b/migrations/versions/e865491e8337_.py @@ -0,0 +1,28 @@ +"""empty message + +Revision ID: e865491e8337 +Revises: f316224e3645 +Create Date: 2021-06-11 00:00:43.222989 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'e865491e8337' +down_revision = 'f316224e3645' +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)) + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.drop_column('goal', 'title') + # ### end Alembic commands ### From da23d44d2fa0af4b36926afa2147204515589407 Mon Sep 17 00:00:00 2001 From: janicelichtman Date: Sat, 12 Jun 2021 23:01:30 -0700 Subject: [PATCH 08/13] wave_06 tests pass --- app/__init__.py | 1 - app/models/goal.py | 5 +- app/models/task.py | 8 +- app/routes.py | 142 ------------------ app/routes/goal_routes.py | 61 +++++++- app/routes/task_routes.py | 40 +++-- .../{f316224e3645_.py => 62528327195e_.py} | 17 ++- migrations/versions/e865491e8337_.py | 28 ---- 8 files changed, 93 insertions(+), 209 deletions(-) delete mode 100644 app/routes.py rename migrations/versions/{f316224e3645_.py => 62528327195e_.py} (62%) delete mode 100644 migrations/versions/e865491e8337_.py diff --git a/app/__init__.py b/app/__init__.py index cd1fa28f0..c803f70e8 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -9,7 +9,6 @@ migrate = Migrate() load_dotenv() - def create_app(test_config=None): app = Flask(__name__) app.config["SQLALCHEMY_TRACK_MODIFICATIONS"] = False diff --git a/app/models/goal.py b/app/models/goal.py index 653ac1865..cc0b6fe6e 100644 --- a/app/models/goal.py +++ b/app/models/goal.py @@ -3,5 +3,6 @@ class Goal(db.Model): - goal_id = db.Column(db.Integer, primary_key=True) - title = db.Column(db.String) \ No newline at end of file + id = db.Column(db.Integer, primary_key=True) + title = db.Column(db.String) + tasks = db.relationship('Task', backref='goal', lazy=True) \ No newline at end of file diff --git a/app/models/task.py b/app/models/task.py index 2c4213a7a..207152a9b 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -3,7 +3,11 @@ class Task(db.Model): - task_id = db.Column(db.Integer, primary_key=True) + id = db.Column(db.Integer, primary_key=True) title = db.Column(db.String) description = db.Column(db.String) - completed_at = db.Column(db.DateTime, nullable=True) \ No newline at end of file + completed_at = db.Column(db.DateTime, nullable=True) + goal_id = db.Column(db.Integer, db.ForeignKey('goal.id'), nullable=True) + + def is_complete(self): + return True if self.completed_at else False \ No newline at end of file diff --git a/app/routes.py b/app/routes.py deleted file mode 100644 index 72c2c661d..000000000 --- a/app/routes.py +++ /dev/null @@ -1,142 +0,0 @@ -from app import db -from app.models.task import Task -from flask import Blueprint, request, make_response, jsonify -from datetime import datetime -import os -import requests - - -tasks_bp = Blueprint("tasks", __name__, url_prefix="/tasks") - -@tasks_bp.route("", strict_slashes=False, methods=["GET", "POST"]) -def handle_tasks(): - if request.method == "GET": - sort_query = request.args.get("sort") - - if sort_query == "asc": - tasks = Task.query.order_by(Task.title).all() - elif sort_query == "desc": - tasks = Task.query.order_by(Task.title.desc()).all() - else: - tasks = Task.query.all() - - tasks_response = [] - for task in tasks: - is_complete = True if task.completed_at else False - tasks_response.append({ - "id": task.task_id, - "title": task.title, - "description": task.description, - "is_complete": is_complete - }) - return jsonify(tasks_response) - elif request.method == "POST": - request_body = request.get_json() - for attribute in {"title", "description", "completed_at"}: - if attribute not in request_body: - return make_response({"details": "Invalid data"}, 400) - new_task = Task(title=request_body["title"], - description=request_body["description"], - completed_at=request_body["completed_at"]) - - db.session.add(new_task) - db.session.commit() - - is_complete = True if new_task.completed_at else False - return make_response({"task": - { - "id": new_task.task_id, - "title": new_task.title, - "description": new_task.description, - "is_complete": is_complete - } - } - , 201) - -@tasks_bp.route("/", strict_slashes=False, methods=["GET", "PUT", "DELETE"]) -def handle_task(task_id): - task = Task.query.get(task_id) - if not task: - return make_response(f"Task {task_id} not found", 404) - - if request.method == "GET": - is_complete = True if task.completed_at else False - return { - "task": {"id": task.task_id, - "title": task.title, - "description": task.description, - "is_complete": is_complete} - } - elif request.method == "PUT": - form_data = request.get_json() - task.title = form_data["title"], - task.description = form_data["description"] - - db.session.commit() - - is_complete = True if task.completed_at else False - return make_response({ - "task":{ - "id": task.task_id, - "title": task.title, - "description": task.description, - "is_complete": is_complete - } - } - ) - elif request.method == "DELETE": - db.session.delete(task) - db.session.commit() - return make_response( - {"details": - f"Task {task.task_id} \"{task.title}\" successfully deleted" - } - ) - -def post_to_slack(task): - slack_token = os.environ.get("SLACK_POST_MESSAGE_API_TOKEN") - slack_path = "https://slack.com/api/chat.postMessage" - query_params ={ - "channel": "task-notifications", - "text": f"Someone just completed the task {task.title}", - } - headers = {"Authorization": f"Bearer {slack_token}"} - requests.post(slack_path, params = query_params, headers = headers) - - -@tasks_bp.route("//mark_complete", strict_slashes=False, methods=["PATCH"]) -def mark_complete(task_id): - task = Task.query.get(task_id) - if not task: - return make_response(f"Task {task_id} not found", 404) - - task.completed_at = datetime.utcnow() - db.session.commit() - - post_to_slack(task) - - is_complete = True if task.completed_at else False - return { - "task": {"id": task.task_id, - "title": task.title, - "description": task.description, - "is_complete": is_complete} - } - -@tasks_bp.route("//mark_incomplete", strict_slashes=False, methods=["PATCH"]) -def mark_incomplete(task_id): - - task = Task.query.get(task_id) - if not task: - return make_response(f"Task {task_id} not found", 404) - - task.completed_at = None - db.session.commit() - - is_complete = True if task.completed_at else False - return { - "task": {"id": task.task_id, - "title": task.title, - "description": task.description, - "is_complete": is_complete} - } \ No newline at end of file diff --git a/app/routes/goal_routes.py b/app/routes/goal_routes.py index 3c1d01df1..1d457db28 100644 --- a/app/routes/goal_routes.py +++ b/app/routes/goal_routes.py @@ -1,5 +1,6 @@ from app import db from app.models.goal import Goal +from app.models.task import Task from flask import Blueprint, request, make_response, jsonify bp = Blueprint("goals", __name__, url_prefix="/goals") @@ -11,7 +12,7 @@ def handle_goals(): goals_response = [] for goal in goals: goals_response.append({ - "id": goal.goal_id, + "id": goal.id, "title": goal.title }) return jsonify(goals_response) @@ -26,7 +27,7 @@ def handle_goals(): return make_response({"goal": { - "id": new_goal.goal_id, + "id": new_goal.id, "title": new_goal.title } } @@ -40,7 +41,7 @@ def handle_goal(goal_id): if request.method == "GET": return { - "goal": {"id": goal.goal_id, + "goal": {"id": goal.id, "title": goal.title} } elif request.method == "PUT": @@ -51,7 +52,7 @@ def handle_goal(goal_id): return make_response({ "goal":{ - "id": goal.goal_id, + "id": goal.id, "title": goal.title } } @@ -61,6 +62,54 @@ def handle_goal(goal_id): db.session.commit() return make_response( {"details": - f"Goal {goal.goal_id} \"{goal.title}\" successfully deleted" + f"Goal {goal.id} \"{goal.title}\" successfully deleted" } - ) \ No newline at end of file + ) + +@bp.route("//tasks", strict_slashes=False, methods=["GET"]) +def get_goal_tasks(goal_id): + goal = Goal.query.get(goal_id) + if not goal: + return make_response(f"Goal {goal_id} not found", 404) + tasks = goal.tasks + tasks_details = [] + for task in tasks: + task_dict = { + "id": task.id, + "goal_id": goal.id, + "title": task.title, + "description": task.description, + "is_complete": task.is_complete() + } + tasks_details.append(task_dict) + return make_response( + { + "id": goal.id, + "title": goal.title, + "tasks": tasks_details + }) + + + + + + +@bp.route("//tasks", strict_slashes=False, methods=["POST"]) +def add_goal_tasks(goal_id): + goal = Goal.query.get(goal_id) + if not goal: + return make_response(f"Goal {goal_id} not found", 404) + + request_body = request.get_json() + for id in request_body["task_ids"]: + task = Task.query.get(id) + goal.tasks.append(task) + + db.session.add(goal) + db.session.commit() + + return make_response( + { + "id": goal.id, + "task_ids": request_body["task_ids"] + }) diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index 38431256f..b916c18ef 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -21,12 +21,11 @@ def handle_tasks(): tasks_response = [] for task in tasks: - is_complete = True if task.completed_at else False tasks_response.append({ - "id": task.task_id, + "id": task.id, "title": task.title, "description": task.description, - "is_complete": is_complete + "is_complete": task.is_complete() }) return jsonify(tasks_response) elif request.method == "POST": @@ -41,13 +40,12 @@ def handle_tasks(): db.session.add(new_task) db.session.commit() - is_complete = True if new_task.completed_at else False return make_response({"task": { - "id": new_task.task_id, + "id": new_task.id, "title": new_task.title, "description": new_task.description, - "is_complete": is_complete + "is_complete": new_task.is_complete() } } , 201) @@ -59,13 +57,17 @@ def handle_task(task_id): return make_response(f"Task {task_id} not found", 404) if request.method == "GET": - is_complete = True if task.completed_at else False - return { - "task": {"id": task.task_id, + base_response = { + "task": {"id": task.id, "title": task.title, "description": task.description, - "is_complete": is_complete} + "is_complete": task.is_complete()} } + if not task.goal_id: + return base_response + else: + base_response["task"]["goal_id"] = task.goal_id + return base_response elif request.method == "PUT": form_data = request.get_json() task.title = form_data["title"], @@ -73,13 +75,12 @@ def handle_task(task_id): db.session.commit() - is_complete = True if task.completed_at else False return make_response({ "task":{ - "id": task.task_id, + "id": task.id, "title": task.title, "description": task.description, - "is_complete": is_complete + "is_complete": task.is_complete() } } ) @@ -88,7 +89,7 @@ def handle_task(task_id): db.session.commit() return make_response( {"details": - f"Task {task.task_id} \"{task.title}\" successfully deleted" + f"Task {task.id} \"{task.title}\" successfully deleted" } ) @@ -114,12 +115,11 @@ def mark_complete(task_id): slack_text = f"Someone just completed the task {task.title}" post_to_slack(slack_text) - is_complete = True if task.completed_at else False return { - "task": {"id": task.task_id, + "task": {"id": task.id, "title": task.title, "description": task.description, - "is_complete": is_complete} + "is_complete": task.is_complete()} } @bp.route("//mark_incomplete", strict_slashes=False, methods=["PATCH"]) @@ -131,11 +131,9 @@ def mark_incomplete(task_id): task.completed_at = None db.session.commit() - - is_complete = True if task.completed_at else False return { - "task": {"id": task.task_id, + "task": {"id": task.id, "title": task.title, "description": task.description, - "is_complete": is_complete} + "is_complete": task.is_complete()} } diff --git a/migrations/versions/f316224e3645_.py b/migrations/versions/62528327195e_.py similarity index 62% rename from migrations/versions/f316224e3645_.py rename to migrations/versions/62528327195e_.py index 33ccb547c..50fda0140 100644 --- a/migrations/versions/f316224e3645_.py +++ b/migrations/versions/62528327195e_.py @@ -1,8 +1,8 @@ """empty message -Revision ID: f316224e3645 +Revision ID: 62528327195e Revises: -Create Date: 2021-06-08 00:23:37.698984 +Create Date: 2021-06-11 18:26:14.195756 """ from alembic import op @@ -10,7 +10,7 @@ # revision identifiers, used by Alembic. -revision = 'f316224e3645' +revision = '62528327195e' down_revision = None branch_labels = None depends_on = None @@ -19,15 +19,18 @@ 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') + sa.Column('id', sa.Integer(), nullable=False), + sa.Column('title', sa.String(), nullable=True), + sa.PrimaryKeyConstraint('id') ) op.create_table('task', - sa.Column('task_id', sa.Integer(), autoincrement=True, nullable=False), + sa.Column('id', sa.Integer(), 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') + sa.Column('goal_id', sa.Integer(), nullable=True), + sa.ForeignKeyConstraint(['goal_id'], ['goal.id'], ), + sa.PrimaryKeyConstraint('id') ) # ### end Alembic commands ### diff --git a/migrations/versions/e865491e8337_.py b/migrations/versions/e865491e8337_.py deleted file mode 100644 index b1ac5b2ea..000000000 --- a/migrations/versions/e865491e8337_.py +++ /dev/null @@ -1,28 +0,0 @@ -"""empty message - -Revision ID: e865491e8337 -Revises: f316224e3645 -Create Date: 2021-06-11 00:00:43.222989 - -""" -from alembic import op -import sqlalchemy as sa - - -# revision identifiers, used by Alembic. -revision = 'e865491e8337' -down_revision = 'f316224e3645' -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)) - # ### end Alembic commands ### - - -def downgrade(): - # ### commands auto generated by Alembic - please adjust! ### - op.drop_column('goal', 'title') - # ### end Alembic commands ### From e243f32c3e733bc4ed20d1e0da20662f895e54b2 Mon Sep 17 00:00:00 2001 From: janicelichtman Date: Sun, 13 Jun 2021 01:24:10 -0700 Subject: [PATCH 09/13] added Procfile for Heroku --- 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 259b1c8e995dbd89171438f24ede103f41b815e0 Mon Sep 17 00:00:00 2001 From: janicelichtman Date: Mon, 14 Jun 2021 10:42:52 -0700 Subject: [PATCH 10/13] returns goal_id when getting all tasks --- app/routes/task_routes.py | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index b916c18ef..1727e11d5 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -21,12 +21,17 @@ def handle_tasks(): tasks_response = [] for task in tasks: - tasks_response.append({ + base_response = { "id": task.id, "title": task.title, "description": task.description, "is_complete": task.is_complete() - }) + } + if not task.goal_id: + tasks_response.append(base_response) + else: + base_response["goal_id"] = task.goal_id + tasks_response.append(base_response) return jsonify(tasks_response) elif request.method == "POST": request_body = request.get_json() From ca1ec73872a1fe418c95e464968edc7efed0669d Mon Sep 17 00:00:00 2001 From: janicelichtman Date: Mon, 14 Jun 2021 17:18:07 -0700 Subject: [PATCH 11/13] much refactoring and some optional enhancements with tests --- app/__init__.py | 1 + app/models/goal.py | 8 +- app/models/task.py | 13 +- app/routes/__init__.py | 0 app/routes/goal_routes.py | 152 +++++++++------------ app/routes/route_helpers.py | 35 +++++ app/routes/task_routes.py | 203 ++++++++++++---------------- tests/test_optional_enhancements.py | 120 ++++++++++++++++ 8 files changed, 325 insertions(+), 207 deletions(-) create mode 100644 app/routes/__init__.py create mode 100644 app/routes/route_helpers.py create mode 100644 tests/test_optional_enhancements.py diff --git a/app/__init__.py b/app/__init__.py index c803f70e8..6e54a8581 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -11,6 +11,7 @@ def create_app(test_config=None): app = Flask(__name__) + app.url_map.strict_slashes = False app.config["SQLALCHEMY_TRACK_MODIFICATIONS"] = False if test_config is None: diff --git a/app/models/goal.py b/app/models/goal.py index cc0b6fe6e..24c9562f3 100644 --- a/app/models/goal.py +++ b/app/models/goal.py @@ -5,4 +5,10 @@ class Goal(db.Model): id = db.Column(db.Integer, primary_key=True) title = db.Column(db.String) - tasks = db.relationship('Task', backref='goal', lazy=True) \ No newline at end of file + tasks = db.relationship('Task', backref='goal', lazy=True) + + def to_json(self): + return { + "id": self.id, + "title": self.title + } diff --git a/app/models/task.py b/app/models/task.py index 207152a9b..46ed613a1 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -10,4 +10,15 @@ class Task(db.Model): goal_id = db.Column(db.Integer, db.ForeignKey('goal.id'), nullable=True) def is_complete(self): - return True if self.completed_at else False \ No newline at end of file + return True if self.completed_at else False + + def to_json(self): + response = { + "id": self.id, + "title": self.title, + "description": self.description, + "is_complete": self.is_complete() + } + if self.goal_id: + response["goal_id"] = self.goal_id + return response \ No newline at end of file diff --git a/app/routes/__init__.py b/app/routes/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/app/routes/goal_routes.py b/app/routes/goal_routes.py index 1d457db28..1b5daeb9c 100644 --- a/app/routes/goal_routes.py +++ b/app/routes/goal_routes.py @@ -1,115 +1,91 @@ from app import db from app.models.goal import Goal from app.models.task import Task +from .route_helpers import validate_item from flask import Blueprint, request, make_response, jsonify bp = Blueprint("goals", __name__, url_prefix="/goals") -@bp.route("", strict_slashes=False, methods=["GET", "POST"]) -def handle_goals(): - if request.method == "GET": - goals = Goal.query.all() - goals_response = [] - for goal in goals: - goals_response.append({ - "id": goal.id, - "title": goal.title - }) - return jsonify(goals_response) - elif request.method == "POST": - request_body = request.get_json() - if "title" not in request_body: - return make_response({"details": "Invalid data"}, 400) - new_goal = Goal(title=request_body["title"]) - - db.session.add(new_goal) - db.session.commit() +@bp.route("", methods=["GET"]) +def get_goals(): + goals = Goal.query.all() + return jsonify([goal.to_json() for goal in goals]) + +@bp.route("", methods=["POST"]) +def create_goal(): + request_body = request.get_json() + if "title" not in request_body: + return make_response({"details": "Invalid data"}, 400) + new_goal = Goal(title=request_body["title"]) - return make_response({"goal": - { - "id": new_goal.id, - "title": new_goal.title - } - } - , 201) + db.session.add(new_goal) + db.session.commit() + + return make_response({"goal": new_goal.to_json()}, 201) -@bp.route("/", strict_slashes=False, methods=["GET", "PUT", "DELETE"]) -def handle_goal(goal_id): - goal = Goal.query.get(goal_id) - if not goal: - return make_response(f"Goal {goal_id} not found", 404) +@bp.route("/", methods=["GET"]) +def get_goal(goal_id): + goal_response = validate_item("goal", goal_id) + if type(goal_response) != Goal: + return goal_response + return {"goal": goal_response.to_json()} - if request.method == "GET": - return { - "goal": {"id": goal.id, - "title": goal.title} - } - elif request.method == "PUT": - form_data = request.get_json() - goal.title = form_data["title"], +@bp.route("/", methods=["PUT"]) +def update_goal(goal_id): + goal_response = validate_item("goal", goal_id) + if type(goal_response) != Goal: + return goal_response + + form_data = request.get_json() + goal_response.title = form_data["title"], + db.session.commit() + return {"goal": goal_response.to_json()} - db.session.commit() - - return make_response({ - "goal":{ - "id": goal.id, - "title": goal.title - } - } - ) - elif request.method == "DELETE": - db.session.delete(goal) - db.session.commit() - return make_response( - {"details": - f"Goal {goal.id} \"{goal.title}\" successfully deleted" - } - ) + +@bp.route("/", methods=["DELETE"]) +def delete_goal(goal_id): + goal_response = validate_item("goal", goal_id) + if type(goal_response) != Goal: + return goal_response + + db.session.delete(goal_response) + db.session.commit() + return make_response( + {"details": + f"Goal {goal_response.id} \"{goal_response.title}\" successfully deleted" + } + ) -@bp.route("//tasks", strict_slashes=False, methods=["GET"]) +@bp.route("//tasks", methods=["GET"]) def get_goal_tasks(goal_id): - goal = Goal.query.get(goal_id) - if not goal: - return make_response(f"Goal {goal_id} not found", 404) - tasks = goal.tasks - tasks_details = [] - for task in tasks: - task_dict = { - "id": task.id, - "goal_id": goal.id, - "title": task.title, - "description": task.description, - "is_complete": task.is_complete() - } - tasks_details.append(task_dict) + goal_response = validate_item("goal", goal_id) + if type(goal_response) != Goal: + return goal_response + + tasks = goal_response.tasks + tasks_details = [task.to_json() for task in tasks] return make_response( { - "id": goal.id, - "title": goal.title, + "id": goal_response.id, + "title": goal_response.title, "tasks": tasks_details }) - - - - - -@bp.route("//tasks", strict_slashes=False, methods=["POST"]) +@bp.route("//tasks", methods=["POST"]) def add_goal_tasks(goal_id): - goal = Goal.query.get(goal_id) - if not goal: - return make_response(f"Goal {goal_id} not found", 404) + goal_response = validate_item("goal", goal_id) + if type(goal_response) != Goal: + return goal_response request_body = request.get_json() for id in request_body["task_ids"]: task = Task.query.get(id) - goal.tasks.append(task) + goal_response.tasks.append(task) - db.session.add(goal) + db.session.add(goal_response) db.session.commit() return make_response( - { - "id": goal.id, - "task_ids": request_body["task_ids"] - }) + {"id": goal_response.id, + "task_ids": request_body["task_ids"] + }) diff --git a/app/routes/route_helpers.py b/app/routes/route_helpers.py new file mode 100644 index 000000000..feada2583 --- /dev/null +++ b/app/routes/route_helpers.py @@ -0,0 +1,35 @@ +from app.models.task import Task +from app.models.goal import Goal +from flask import make_response +from dateutil.parser import parse, ParserError +import os +import requests + +def validate_item(type, id): + if not id.isdigit(): + return make_response(f"{id} is not a valid {type}_id. {type.title()} ID must be an integer.", 400) + + if type == "task": + item = Task.query.get(id) + elif type == "goal": + item = Goal.query.get(id) + + if not item: + return make_response(f"{type.title()} {id} not found", 404) + return item + +def validate_datetime(date_text): + try: + return parse(date_text) + except ParserError: + return make_response(f"Invalid date format in \"completed_at\". Please resubmit with a valid date_time.", 400) + +def post_to_slack(text): + slack_token = os.environ.get("SLACK_POST_MESSAGE_API_TOKEN") + slack_path = "https://slack.com/api/chat.postMessage" + query_params ={ + "channel": "task-notifications", + "text": text, + } + headers = {"Authorization": f"Bearer {slack_token}"} + requests.post(slack_path, params = query_params, headers = headers) \ No newline at end of file diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index 1727e11d5..5f6f1c506 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -1,144 +1,113 @@ from app import db from app.models.task import Task +from .route_helpers import * from flask import Blueprint, request, make_response, jsonify -from datetime import datetime -import os -import requests +import datetime bp = Blueprint("tasks", __name__, url_prefix="/tasks") -@bp.route("", strict_slashes=False, methods=["GET", "POST"]) -def handle_tasks(): - if request.method == "GET": - sort_query = request.args.get("sort") - +@bp.route("", methods=["GET"]) +def get_tasks(): + sort_query = request.args.get("sort") + if sort_query: if sort_query == "asc": tasks = Task.query.order_by(Task.title).all() elif sort_query == "desc": tasks = Task.query.order_by(Task.title.desc()).all() else: - tasks = Task.query.all() - - tasks_response = [] - for task in tasks: - base_response = { - "id": task.id, - "title": task.title, - "description": task.description, - "is_complete": task.is_complete() - } - if not task.goal_id: - tasks_response.append(base_response) - else: - base_response["goal_id"] = task.goal_id - tasks_response.append(base_response) - return jsonify(tasks_response) - elif request.method == "POST": - request_body = request.get_json() - for attribute in {"title", "description", "completed_at"}: - if attribute not in request_body: - return make_response({"details": "Invalid data"}, 400) - new_task = Task(title=request_body["title"], - description=request_body["description"], - completed_at=request_body["completed_at"]) - - db.session.add(new_task) - db.session.commit() + return make_response(f"{sort_query} is not a valid sort parameter. Please use sort=asc or sort=desc.", 400) + else: + tasks = Task.query.all() - return make_response({"task": - { - "id": new_task.id, - "title": new_task.title, - "description": new_task.description, - "is_complete": new_task.is_complete() - } - } - , 201) + return jsonify([task.to_json() for task in tasks]) -@bp.route("/", strict_slashes=False, methods=["GET", "PUT", "DELETE"]) -def handle_task(task_id): - task = Task.query.get(task_id) - if not task: - return make_response(f"Task {task_id} not found", 404) +@bp.route("", methods=["POST"]) +def create_task(): + request_body = request.get_json() + for attribute in {"title", "description", "completed_at"}: + if attribute not in request_body: + return make_response({"details": "Invalid data"}, 400) - if request.method == "GET": - base_response = { - "task": {"id": task.id, - "title": task.title, - "description": task.description, - "is_complete": task.is_complete()} - } - if not task.goal_id: - return base_response - else: - base_response["task"]["goal_id"] = task.goal_id - return base_response - elif request.method == "PUT": - form_data = request.get_json() - task.title = form_data["title"], - task.description = form_data["description"] + if request_body["completed_at"]: + date_time_response = validate_datetime(request_body["completed_at"]) + if type(date_time_response) != datetime.datetime: + return date_time_response - db.session.commit() + new_task = Task(title=request_body["title"], + description=request_body["description"]) + + new_task.completed_at = date_time_response.strftime("%m/%d/%Y, %H:%M:%S") if request_body["completed_at"] else None - return make_response({ - "task":{ - "id": task.id, - "title": task.title, - "description": task.description, - "is_complete": task.is_complete() - } - } - ) - elif request.method == "DELETE": - db.session.delete(task) - db.session.commit() - return make_response( - {"details": - f"Task {task.id} \"{task.title}\" successfully deleted" - } - ) + db.session.add(new_task) + db.session.commit() + + return make_response({"task": new_task.to_json()}, 201) + +@bp.route("/", methods=["GET"]) +def get_task(task_id): + task_response = validate_item("task", task_id) + if type(task_response) != Task: + return task_response + + return {"task": task_response.to_json()} + +@bp.route("/", methods=["PUT"]) +def update_task(task_id): + task_response = validate_item("task", task_id) + if type(task_response) != Task: + return task_response + + form_data = request.get_json() + for attribute in {"title", "description"}: + if attribute not in form_data: + return make_response({"details": "Invalid data"}, 400) + + if form_data["completed_at"]: + date_time_response = validate_datetime(form_data["completed_at"]) + if type(date_time_response) != datetime.datetime: + return date_time_response -def post_to_slack(text): - slack_token = os.environ.get("SLACK_POST_MESSAGE_API_TOKEN") - slack_path = "https://slack.com/api/chat.postMessage" - query_params ={ - "channel": "task-notifications", - "text": text, - } - headers = {"Authorization": f"Bearer {slack_token}"} - requests.post(slack_path, params = query_params, headers = headers) + task_response.title = form_data["title"], + task_response.description = form_data["description"] + task_response.completed_at = date_time_response.strftime("%m/%d/%Y, %H:%M:%S") if form_data["completed_at"] else None + + db.session.commit() + + return {"task": task_response.to_json()} -@bp.route("//mark_complete", strict_slashes=False, methods=["PATCH"]) +@bp.route("/", methods=["DELETE"]) +def delete_task(task_id): + task_response = validate_item("task", task_id) + if type(task_response) != Task: + return task_response + + db.session.delete(task_response) + db.session.commit() + return make_response( + {"details": + f"Task {task_response.id} \"{task_response.title}\" successfully deleted" + } + ) + +@bp.route("//mark_complete", methods=["PATCH"]) def mark_complete(task_id): - task = Task.query.get(task_id) - if not task: - return make_response(f"Task {task_id} not found", 404) + task_response = validate_item("task", task_id) + if type(task_response) != Task: + return task_response - task.completed_at = datetime.utcnow() + task_response.completed_at = datetime.datetime.utcnow() db.session.commit() - slack_text = f"Someone just completed the task {task.title}" + slack_text = f"Someone just completed the task {task_response.title}" post_to_slack(slack_text) - - return { - "task": {"id": task.id, - "title": task.title, - "description": task.description, - "is_complete": task.is_complete()} - } + return {"task": task_response.to_json()} -@bp.route("//mark_incomplete", strict_slashes=False, methods=["PATCH"]) +@bp.route("//mark_incomplete", methods=["PATCH"]) def mark_incomplete(task_id): + task_response = validate_item("task", task_id) + if type(task_response) != Task: + return task_response - task = Task.query.get(task_id) - if not task: - return make_response(f"Task {task_id} not found", 404) - - task.completed_at = None + task_response.completed_at = None db.session.commit() - return { - "task": {"id": task.id, - "title": task.title, - "description": task.description, - "is_complete": task.is_complete()} - } + return {"task": task_response.to_json()} \ No newline at end of file diff --git a/tests/test_optional_enhancements.py b/tests/test_optional_enhancements.py new file mode 100644 index 000000000..a02346c74 --- /dev/null +++ b/tests/test_optional_enhancements.py @@ -0,0 +1,120 @@ +from app.models.task import Task +import datetime + +def test_create_task_with_valid_datetime_string(client): + # Act + response = client.post("/tasks", json={ + "title": "A Brand New Task", + "description": "Test Description", + "completed_at": "June 24, 2021 11:00:00" + }) + response_body = response.get_json() + + # Assert + assert response.status_code == 201 + assert response_body == { + "task": { + "description": "Test Description", + "id": 1, + "is_complete": True, + "title": "A Brand New Task" + } + } + task = Task.query.get(1) + assert task.title == "A Brand New Task" + assert task.description == "Test Description" + assert task.completed_at == datetime.datetime(2021, 6, 24, 11, 0) + + +def test_create_task_with_invalid_datetime_string(client): + # Act + response = client.post("/tasks", json={ + "title": "A Brand New Task", + "description": "Test Description", + "completed_at": "Just finished" + }) + response_text = response.get_data(as_text=True) + + # Assert + assert response.status_code == 400 + assert response_text == f"Invalid date format in \"completed_at\". Please resubmit with a valid date_time." + assert Task.query.all() == [] + +def test_update_task_with_valid_datetime_string(client, one_task): + # Act + response = client.put("/tasks/1", json={ + "title": "Updated Task Title", + "description": "Updated Test Description", + "completed_at": "June 28, 2020" + }) + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert "task" in response_body + assert response_body == { + "task": { + "id": 1, + "title": "Updated Task Title", + "description": "Updated Test Description", + "is_complete": True + } + } + task = Task.query.get(1) + assert task.title == "Updated Task Title" + assert task.description == "Updated Test Description" + assert task.completed_at == datetime.datetime(2020, 6, 28, 0, 0) + + +def test_update_task_with_invalid_datetime_string(client, one_task): + # Act + response = client.put("/tasks/1", json={ + "title": "A Brand New Task", + "description": "Test Description", + "completed_at": "Just finished" + }) + response_text = response.get_data(as_text=True) + + # Assert + assert response.status_code == 400 + assert response_text == f"Invalid date format in \"completed_at\". Please resubmit with a valid date_time." + assert Task.query.first().title == "Go on my daily walk 🏞" + assert Task.query.first().description == "Notice something new every day" + assert Task.query.first().completed_at == None + +def test_get_tasks_invalid_sort_param(client, three_tasks): + # Act + response = client.get("/tasks?sort=ASC") + response_text = response.get_data(as_text=True) + + # Assert + assert response.status_code == 400 + assert response_text == "ASC is not a valid sort parameter. Please use sort=asc or sort=desc." + +def test_task_to_json_no_goal(one_task): + # Arrange + task = Task.query.first() + + # Act + task_json = task.to_json() + + # Assert + assert task_json["id"] == task.id + assert task_json["title"] == task.title + assert task_json["description"] == task.description + assert task_json["is_complete"] == task.is_complete() + assert task_json.get("goal_id") == None + +def test_task_to_json_with_goal(one_task_belongs_to_one_goal): + # Arrange + task = Task.query.first() + + # Act + task_json = task.to_json() + + # Assert + assert task_json["id"] == task.id + assert task_json["title"] == task.title + assert task_json["description"] == task.description + assert task_json["is_complete"] == task.is_complete() + assert task_json.get("goal_id") == task.goal_id \ No newline at end of file From 344b6453d25c8c03ab12823b247d06d6644e2c13 Mon Sep 17 00:00:00 2001 From: janicelichtman Date: Mon, 14 Jun 2021 17:48:29 -0700 Subject: [PATCH 12/13] more optional enhancements and tests --- app/routes/task_routes.py | 3 ++ tests/conftest.py | 14 +++++++++ tests/test_optional_enhancements.py | 49 ++++++++++++++++++++++++++++- 3 files changed, 65 insertions(+), 1 deletion(-) diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index 5f6f1c506..034dfaf16 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -9,6 +9,7 @@ @bp.route("", methods=["GET"]) def get_tasks(): sort_query = request.args.get("sort") + search_title_query = request.args.get("search_title") if sort_query: if sort_query == "asc": tasks = Task.query.order_by(Task.title).all() @@ -16,6 +17,8 @@ def get_tasks(): tasks = Task.query.order_by(Task.title.desc()).all() else: return make_response(f"{sort_query} is not a valid sort parameter. Please use sort=asc or sort=desc.", 400) + elif search_title_query: + tasks = Task.query.filter_by(title=search_title_query).all() else: tasks = Task.query.all() diff --git a/tests/conftest.py b/tests/conftest.py index d11083bf3..197c47255 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -86,3 +86,17 @@ def one_task_belongs_to_one_goal(app, one_goal, one_task): goal = Goal.query.first() goal.tasks.append(task) db.session.commit() + +# This fixture gets called in every test that +# references "duplicate_title_tasks" +# This fixture creates 2 tasks with +# the same title +@pytest.fixture +def duplicate_title_tasks(app): + new_task1 = Task( + title="Super Fun Title", description="Do something fun every day", completed_at=None) + new_task2 = Task( + title="Super Fun Title", description="Do something else fun every day", completed_at=None) + db.session.add(new_task1) + db.session.add(new_task2) + db.session.commit() diff --git a/tests/test_optional_enhancements.py b/tests/test_optional_enhancements.py index a02346c74..b09231a5a 100644 --- a/tests/test_optional_enhancements.py +++ b/tests/test_optional_enhancements.py @@ -117,4 +117,51 @@ def test_task_to_json_with_goal(one_task_belongs_to_one_goal): assert task_json["title"] == task.title assert task_json["description"] == task.description assert task_json["is_complete"] == task.is_complete() - assert task_json.get("goal_id") == task.goal_id \ No newline at end of file + assert task_json.get("goal_id") == task.goal_id + +def test_get_tasks_search_by_title_that_exists(client, three_tasks): + # Act + response = client.get("/tasks?search_title=Answer forgotten email 📧") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert len(response_body) == 1 + assert response_body == [ + { + "id": 2, + "title": "Answer forgotten email 📧", + "description": "", + "is_complete": False} + ] + +def test_get_tasks_search_by_title_that_does_not_exists(client): + # Act + response = client.get("/tasks?search_title=non-existent title") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert len(response_body) == 0 + assert response_body == [] + +def test_get_tasks_search_by_title_that_has_multiple(client, duplicate_title_tasks): + # Act + response = client.get("/tasks?search_title=Super Fun Title") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert len(response_body) == 2 + assert response_body == [ + { + "id": 1, + "title": "Super Fun Title", + "description": "Do something fun every day", + "is_complete": False}, + { + "id": 2, + "title": "Super Fun Title", + "description": "Do something else fun every day", + "is_complete": False} + ] \ No newline at end of file From f02fb9321545aefa96d2ea7c5a19b7a4a1af87eb Mon Sep 17 00:00:00 2001 From: janicelichtman Date: Tue, 15 Jun 2021 10:41:02 -0700 Subject: [PATCH 13/13] small refactor --- app/routes/goal_routes.py | 2 +- app/routes/route_helpers.py | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/app/routes/goal_routes.py b/app/routes/goal_routes.py index 1b5daeb9c..ad3da3072 100644 --- a/app/routes/goal_routes.py +++ b/app/routes/goal_routes.py @@ -83,7 +83,7 @@ def add_goal_tasks(goal_id): goal_response.tasks.append(task) db.session.add(goal_response) - db.session.commit() + db.session.commit() return make_response( {"id": goal_response.id, diff --git a/app/routes/route_helpers.py b/app/routes/route_helpers.py index feada2583..0bd47bf8a 100644 --- a/app/routes/route_helpers.py +++ b/app/routes/route_helpers.py @@ -10,6 +10,7 @@ def validate_item(type, id): return make_response(f"{id} is not a valid {type}_id. {type.title()} ID must be an integer.", 400) if type == "task": + # item = Task.query.get_or_404(id) # This will give the standard 404 page instead of custom message item = Task.query.get(id) elif type == "goal": item = Goal.query.get(id)