From 8b982d561f2ba2419a22ed318749d2d183d0feb0 Mon Sep 17 00:00:00 2001 From: Courtney Date: Wed, 5 May 2021 15:31:38 -0700 Subject: [PATCH 01/11] passing Wave01 --- app/__init__.py | 2 + app/models/task.py | 14 ++++ app/routes.py | 50 ++++++++++++++- migrations/README | 1 + migrations/alembic.ini | 45 +++++++++++++ migrations/env.py | 96 ++++++++++++++++++++++++++++ migrations/script.py.mako | 24 +++++++ migrations/versions/8869fd0c845c_.py | 39 +++++++++++ 8 files changed, 270 insertions(+), 1 deletion(-) 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/8869fd0c845c_.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 39c89cd16..45d33e944 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -4,3 +4,17 @@ 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) + + + # helper method to return dictionary and report if task has been completed or not + def to_dict(self): + return { + "id": self.task_id, + "title": self.title, + "description": self.description, + "is_complete": self.completed_at != None + } + diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..346606f0c 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,50 @@ -from flask import Blueprint +from app import db +from flask import Blueprint, request, make_response, jsonify +from app.models.task import Task +tasks_bp = Blueprint("tasks", __name__, url_prefix="/tasks") + +@tasks_bp.route("", methods=["GET", "POST"]) +def handle_tasks(): + + if request.method == "GET": + tasks = Task.query.all() + tasks_response = [] + for task in tasks: + tasks_response.append(task.to_dict()) + return make_response(jsonify(tasks_response), 200) + + else: + request_body = request.get_json() + if "title" in request_body and "description" in request_body and "completed_at" in request_body: + 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({"task": new_task.to_dict()}, 201) + else: + return make_response({"details": "Invalid data"}, 400) + + +@tasks_bp.route("/", methods=["GET", "PUT", "DELETE"]) +def handle_task(task_id): + task = Task.query.get(task_id) + if task: + if request.method == "GET": + return {"task": task.to_dict()}, 200 + + elif request.method == "PUT": + form_data = request.get_json() + task.title = form_data["title"] + task.description = form_data["description"] + task.completed_at = form_data["completed_at"] + db.session.commit() + return make_response({"task": task.to_dict()}, 200) + + elif request.method == "DELETE": + db.session.delete(task) + db.session.commit() + return make_response({"details": f"Task {task.task_id} \"{task.title}\" successfully deleted"}, 200) + else: + return make_response("", 404) \ No newline at end of file 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/8869fd0c845c_.py b/migrations/versions/8869fd0c845c_.py new file mode 100644 index 000000000..ebf3c1581 --- /dev/null +++ b/migrations/versions/8869fd0c845c_.py @@ -0,0 +1,39 @@ +"""empty message + +Revision ID: 8869fd0c845c +Revises: +Create Date: 2021-05-05 10:43:35.052226 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '8869fd0c845c' +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(), 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 5e82f57343ba4c46ba8a9a0167994e113b26deed Mon Sep 17 00:00:00 2001 From: Courtney Date: Thu, 6 May 2021 10:34:03 -0700 Subject: [PATCH 02/11] passing Wave02 --- app/models/task.py | 3 ++- app/routes.py | 13 +++++++++++-- 2 files changed, 13 insertions(+), 3 deletions(-) diff --git a/app/models/task.py b/app/models/task.py index 45d33e944..975cb5380 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -9,7 +9,8 @@ class Task(db.Model): completed_at = db.Column(db.DateTime, nullable=True) - # helper method to return dictionary and report if task has been completed or not + # helper method to return dictionary and simultaneously + # report if task has been completed or not def to_dict(self): return { "id": self.task_id, diff --git a/app/routes.py b/app/routes.py index 346606f0c..a2823c146 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,6 +1,7 @@ from app import db from flask import Blueprint, request, make_response, jsonify from app.models.task import Task +from sqlalchemy import desc, asc tasks_bp = Blueprint("tasks", __name__, url_prefix="/tasks") @@ -8,7 +9,13 @@ def handle_tasks(): if request.method == "GET": - tasks = Task.query.all() + order_query = request.args.get("sort") + if order_query == "asc": + tasks = Task.query.order_by(asc(Task.title)) + elif order_query == "desc": + tasks = Task.query.order_by(desc(Task.title)) + else: + tasks = Task.query.all() tasks_response = [] for task in tasks: tasks_response.append(task.to_dict()) @@ -47,4 +54,6 @@ def handle_task(task_id): db.session.commit() return make_response({"details": f"Task {task.task_id} \"{task.title}\" successfully deleted"}, 200) else: - return make_response("", 404) \ No newline at end of file + return make_response("", 404) + + From fb66f6594559c979db8b3daf9179d9377ed0d381 Mon Sep 17 00:00:00 2001 From: Courtney Date: Thu, 6 May 2021 11:38:59 -0700 Subject: [PATCH 03/11] passing Wave03 --- app/routes.py | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/app/routes.py b/app/routes.py index a2823c146..2a4fb7f68 100644 --- a/app/routes.py +++ b/app/routes.py @@ -2,6 +2,7 @@ from flask import Blueprint, request, make_response, jsonify from app.models.task import Task from sqlalchemy import desc, asc +from datetime import datetime tasks_bp = Blueprint("tasks", __name__, url_prefix="/tasks") @@ -56,4 +57,19 @@ def handle_task(task_id): else: return make_response("", 404) +@tasks_bp.route("//", methods=["PATCH"]) +def handle_task_completion(task_id, mark_info): + task = Task.query.get(task_id) + if task: + if mark_info == "mark_incomplete": + task.completed_at = None + db.session.commit() + return make_response({"task": task.to_dict()}, 200) + elif mark_info == "mark_complete": + task.completed_at = datetime.utcnow() + db.session.commit() + return make_response({"task": task.to_dict()}, 200) + else: + return make_response("", 404) + From 1be57febe333543d20fbbeb8cf4a0e6d6a92d80a Mon Sep 17 00:00:00 2001 From: Courtney Date: Thu, 6 May 2021 15:55:11 -0700 Subject: [PATCH 04/11] passing Wave04 --- app/routes.py | 29 +++++++++++++++++++++++++---- 1 file changed, 25 insertions(+), 4 deletions(-) diff --git a/app/routes.py b/app/routes.py index 2a4fb7f68..5158a3832 100644 --- a/app/routes.py +++ b/app/routes.py @@ -4,6 +4,10 @@ from sqlalchemy import desc, asc from datetime import datetime +#why don't I need to say from ... import ... here??? +import requests +import os + tasks_bp = Blueprint("tasks", __name__, url_prefix="/tasks") @tasks_bp.route("", methods=["GET", "POST"]) @@ -57,19 +61,36 @@ def handle_task(task_id): else: return make_response("", 404) -@tasks_bp.route("//", methods=["PATCH"]) -def handle_task_completion(task_id, mark_info): +@tasks_bp.route("//", methods=["PATCH"]) +def handle_task_completion(task_id, mark_status): task = Task.query.get(task_id) if task: - if mark_info == "mark_incomplete": + if mark_status == "mark_incomplete": task.completed_at = None db.session.commit() return make_response({"task": task.to_dict()}, 200) - elif mark_info == "mark_complete": + elif mark_status == "mark_complete": task.completed_at = datetime.utcnow() db.session.commit() + #call to function that sends slack message + send_slack_message(task.title) return make_response({"task": task.to_dict()}, 200) else: return make_response("", 404) +#WAVE 4 -- for organization sake should this go somewhere else? +PATH = "https://slack.com/api/chat.postMessage" + +#define a function that sends a slack message +def send_slack_message(task_title): + query_params = { + "channel": "task-notifications", + "text": f"Someone just completed the task {task_title}" + } + slackbot_token = os.environ.get('SLACK_API_KEY') + header = { + "Authorization": f"Bearer {slackbot_token}" + } + # why use .POST and not .PATCH + requests.post(PATH, params=query_params, headers=header) From 1bf6f3fbccf0c1f9c6770b94b4ce0e21c1279512 Mon Sep 17 00:00:00 2001 From: Courtney Date: Fri, 7 May 2021 11:56:43 -0700 Subject: [PATCH 05/11] Passing Wave05 --- app/__init__.py | 3 +- app/models/goal.py | 8 ++++++ app/models/task.py | 1 + app/routes.py | 41 ++++++++++++++++++++++++++++ migrations/versions/a0ae4ea944b6_.py | 28 +++++++++++++++++++ 5 files changed, 80 insertions(+), 1 deletion(-) create mode 100644 migrations/versions/a0ae4ea944b6_.py diff --git a/app/__init__.py b/app/__init__.py index 30052751d..8605c7e60 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -30,7 +30,8 @@ def create_app(test_config=None): migrate.init_app(app, db) # Register Blueprints here - from .routes import tasks_bp + from .routes import tasks_bp, goals_bp app.register_blueprint(tasks_bp) + app. register_blueprint(goals_bp) return app diff --git a/app/models/goal.py b/app/models/goal.py index 8cad278f8..cff87cd4b 100644 --- a/app/models/goal.py +++ b/app/models/goal.py @@ -4,3 +4,11 @@ class Goal(db.Model): goal_id = db.Column(db.Integer, primary_key=True) + title = db.Column(db.String) + + # should this have a different name than the similar function in the Task class? + def to_dict(self): + return { + "id": self.goal_id, + "title": self.title, + } \ No newline at end of file diff --git a/app/models/task.py b/app/models/task.py index 975cb5380..25161dd57 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -8,6 +8,7 @@ class Task(db.Model): description = db.Column(db.String) completed_at = db.Column(db.DateTime, nullable=True) + # consider making separate function to determine if complete or not** # helper method to return dictionary and simultaneously # report if task has been completed or not diff --git a/app/routes.py b/app/routes.py index 5158a3832..8afec22d2 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,6 +1,7 @@ from app import db from flask import Blueprint, request, make_response, jsonify from app.models.task import Task +from app.models.goal import Goal from sqlalchemy import desc, asc from datetime import datetime @@ -9,6 +10,7 @@ import os tasks_bp = Blueprint("tasks", __name__, url_prefix="/tasks") +goals_bp = Blueprint("goals", __name__, url_prefix="/goals") @tasks_bp.route("", methods=["GET", "POST"]) def handle_tasks(): @@ -94,3 +96,42 @@ def send_slack_message(task_title): } # why use .POST and not .PATCH requests.post(PATH, params=query_params, headers=header) + + +#WAVE 5 +@goals_bp.route("", methods=["GET", "POST"]) +def handle_goals(): + if request.method == "GET": + goals = Goal.query.all() + goals_response = [] + for goal in goals: + goals_response.append(goal.to_dict()) + return make_response(jsonify(goals_response), 200) + + else: + request_body = request.get_json() + if "title" in request_body: + new_goal = Goal(title = request_body["title"]) + db.session.add(new_goal) + db.session.commit() + return make_response({"goal": new_goal.to_dict()}, 201) + else: + return make_response({"details": "Invalid data"}, 400) + +@goals_bp.route("/", methods=["GET", "PUT", "DELETE"]) +def handle_goal(goal_id): + goal = Goal.query.get(goal_id) + if goal: + if request.method == "GET": + return {"goal": goal.to_dict()}, 200 + elif request.method == "PUT": + form_data = request.get_json() + goal.title = form_data["title"] + db.session.commit() + return make_response({"goal": goal.to_dict()}, 200) + elif request.method == "DELETE": + db.session.delete(goal) + db.session.commit() + return make_response({"details": f"Goal {goal.goal_id} \"{goal.title}\" successfully deleted"}, 200) + else: + return make_response("", 404) \ No newline at end of file diff --git a/migrations/versions/a0ae4ea944b6_.py b/migrations/versions/a0ae4ea944b6_.py new file mode 100644 index 000000000..cd00c7594 --- /dev/null +++ b/migrations/versions/a0ae4ea944b6_.py @@ -0,0 +1,28 @@ +"""empty message + +Revision ID: a0ae4ea944b6 +Revises: 8869fd0c845c +Create Date: 2021-05-07 11:20:06.284531 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'a0ae4ea944b6' +down_revision = '8869fd0c845c' +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 99911a053aa119cdbd108ceebc838e5f8527626f Mon Sep 17 00:00:00 2001 From: Courtney Date: Wed, 12 May 2021 21:47:05 -0700 Subject: [PATCH 06/11] passing Wave06 --- app/models/goal.py | 1 + app/models/task.py | 9 +++++++ app/routes.py | 36 +++++++++++++++++++++++++--- migrations/versions/9656fd5ab4a5_.py | 30 +++++++++++++++++++++++ 4 files changed, 73 insertions(+), 3 deletions(-) create mode 100644 migrations/versions/9656fd5ab4a5_.py diff --git a/app/models/goal.py b/app/models/goal.py index cff87cd4b..131190793 100644 --- a/app/models/goal.py +++ b/app/models/goal.py @@ -5,6 +5,7 @@ class Goal(db.Model): goal_id = db.Column(db.Integer, primary_key=True) title = db.Column(db.String) + tasks = db.relationship('Task', backref='goal', lazy=True) # should this have a different name than the similar function in the Task class? def to_dict(self): diff --git a/app/models/task.py b/app/models/task.py index 25161dd57..3c3124559 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -7,12 +7,21 @@ class Task(db.Model): title = db.Column(db.String) description = db.Column(db.String) completed_at = db.Column(db.DateTime, nullable=True) + goal_id = db.Column(db.Integer, db.ForeignKey('goal.goal_id')) # consider making separate function to determine if complete or not** # helper method to return dictionary and simultaneously # report if task has been completed or not def to_dict(self): + if self.goal_id: + return { + "id": self.task_id, + "goal_id": self.goal_id, + "title": self.title, + "description": self.description, + "is_complete": self.completed_at != None + } return { "id": self.task_id, "title": self.title, diff --git a/app/routes.py b/app/routes.py index 8afec22d2..54d40320a 100644 --- a/app/routes.py +++ b/app/routes.py @@ -82,6 +82,7 @@ def handle_task_completion(task_id, mark_status): #WAVE 4 -- for organization sake should this go somewhere else? +# consider moving to a "utilities" folder PATH = "https://slack.com/api/chat.postMessage" #define a function that sends a slack message @@ -94,10 +95,8 @@ def send_slack_message(task_title): header = { "Authorization": f"Bearer {slackbot_token}" } - # why use .POST and not .PATCH requests.post(PATH, params=query_params, headers=header) - #WAVE 5 @goals_bp.route("", methods=["GET", "POST"]) def handle_goals(): @@ -134,4 +133,35 @@ def handle_goal(goal_id): db.session.commit() return make_response({"details": f"Goal {goal.goal_id} \"{goal.title}\" successfully deleted"}, 200) else: - return make_response("", 404) \ No newline at end of file + return make_response("", 404) + + +# WAVE 06 +@goals_bp.route("//tasks", methods=["POST"]) +def assign_tasks_to_goal(goal_id): + request_body = request.get_json() + tasks_for_goal = request_body["task_ids"] + for task_id in tasks_for_goal: + task = Task.query.get(task_id) + task.goal_id = int(goal_id) + return make_response({ + "id": int(goal_id), + "task_ids": tasks_for_goal + }, 200) + +@goals_bp.route("//tasks", methods=["GET"]) +def get_tasks_of_one_goal(goal_id): + goal = Goal.query.get(goal_id) + if not Goal.query.get(goal_id): + return make_response("404"), 404 + else: + tasks_response = [] + tasks_of_goal = Task.query.filter_by(goal_id=goal_id) + if tasks_of_goal: + for task in tasks_of_goal: + tasks_response.append(task.to_dict()) + return make_response({ + "id": int(goal_id), + "title": goal.title, + "tasks": tasks_response + }, 200) \ No newline at end of file diff --git a/migrations/versions/9656fd5ab4a5_.py b/migrations/versions/9656fd5ab4a5_.py new file mode 100644 index 000000000..ecf55753b --- /dev/null +++ b/migrations/versions/9656fd5ab4a5_.py @@ -0,0 +1,30 @@ +"""empty message + +Revision ID: 9656fd5ab4a5 +Revises: a0ae4ea944b6 +Create Date: 2021-05-11 10:27:22.517844 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '9656fd5ab4a5' +down_revision = 'a0ae4ea944b6' +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.add_column('task', sa.Column('goal_id', sa.Integer(), nullable=True)) + op.create_foreign_key(None, 'task', 'goal', ['goal_id'], ['goal_id']) + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.drop_constraint(None, 'task', type_='foreignkey') + op.drop_column('task', 'goal_id') + # ### end Alembic commands ### From 5994bd82653e10ffe4984cdd88c5cc670de16d90 Mon Sep 17 00:00:00 2001 From: Courtney Date: Wed, 12 May 2021 21:58:17 -0700 Subject: [PATCH 07/11] refactored to include helper function for determining if a task is complete --- app/models/task.py | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/app/models/task.py b/app/models/task.py index 3c3124559..2df4b45a4 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -9,10 +9,11 @@ class Task(db.Model): completed_at = db.Column(db.DateTime, nullable=True) goal_id = db.Column(db.Integer, db.ForeignKey('goal.goal_id')) - # consider making separate function to determine if complete or not** + def is_complete(self): + if self.completed_at: + return True + return False - # helper method to return dictionary and simultaneously - # report if task has been completed or not def to_dict(self): if self.goal_id: return { @@ -20,12 +21,12 @@ def to_dict(self): "goal_id": self.goal_id, "title": self.title, "description": self.description, - "is_complete": self.completed_at != None + "is_complete": self.is_complete() } return { "id": self.task_id, "title": self.title, "description": self.description, - "is_complete": self.completed_at != None + "is_complete": self.is_complete() } From e6f16858d4d823ff6f092fd979c245b8c7b091e2 Mon Sep 17 00:00:00 2001 From: Courtney Date: Wed, 12 May 2021 22:07:09 -0700 Subject: [PATCH 08/11] updated to remove comments and clean up spacing --- app/models/goal.py | 1 - app/routes.py | 15 +++------------ 2 files changed, 3 insertions(+), 13 deletions(-) diff --git a/app/models/goal.py b/app/models/goal.py index 131190793..21b5c2c97 100644 --- a/app/models/goal.py +++ b/app/models/goal.py @@ -7,7 +7,6 @@ class Goal(db.Model): title = db.Column(db.String) tasks = db.relationship('Task', backref='goal', lazy=True) - # should this have a different name than the similar function in the Task class? def to_dict(self): return { "id": self.goal_id, diff --git a/app/routes.py b/app/routes.py index 54d40320a..e4c6dd274 100644 --- a/app/routes.py +++ b/app/routes.py @@ -4,8 +4,6 @@ from app.models.goal import Goal from sqlalchemy import desc, asc from datetime import datetime - -#why don't I need to say from ... import ... here??? import requests import os @@ -14,7 +12,6 @@ @tasks_bp.route("", methods=["GET", "POST"]) def handle_tasks(): - if request.method == "GET": order_query = request.args.get("sort") if order_query == "asc": @@ -27,7 +24,6 @@ def handle_tasks(): for task in tasks: tasks_response.append(task.to_dict()) return make_response(jsonify(tasks_response), 200) - else: request_body = request.get_json() if "title" in request_body and "description" in request_body and "completed_at" in request_body: @@ -40,14 +36,12 @@ def handle_tasks(): else: return make_response({"details": "Invalid data"}, 400) - @tasks_bp.route("/", methods=["GET", "PUT", "DELETE"]) def handle_task(task_id): task = Task.query.get(task_id) if task: if request.method == "GET": return {"task": task.to_dict()}, 200 - elif request.method == "PUT": form_data = request.get_json() task.title = form_data["title"] @@ -55,7 +49,6 @@ def handle_task(task_id): task.completed_at = form_data["completed_at"] db.session.commit() return make_response({"task": task.to_dict()}, 200) - elif request.method == "DELETE": db.session.delete(task) db.session.commit() @@ -74,18 +67,16 @@ def handle_task_completion(task_id, mark_status): elif mark_status == "mark_complete": task.completed_at = datetime.utcnow() db.session.commit() - #call to function that sends slack message send_slack_message(task.title) return make_response({"task": task.to_dict()}, 200) else: return make_response("", 404) -#WAVE 4 -- for organization sake should this go somewhere else? -# consider moving to a "utilities" folder +#WAVE 4 +# consider moving to a "utilities" folder in refactoring PATH = "https://slack.com/api/chat.postMessage" -#define a function that sends a slack message def send_slack_message(task_title): query_params = { "channel": "task-notifications", @@ -97,6 +88,7 @@ def send_slack_message(task_title): } requests.post(PATH, params=query_params, headers=header) + #WAVE 5 @goals_bp.route("", methods=["GET", "POST"]) def handle_goals(): @@ -106,7 +98,6 @@ def handle_goals(): for goal in goals: goals_response.append(goal.to_dict()) return make_response(jsonify(goals_response), 200) - else: request_body = request.get_json() if "title" in request_body: From e7ae186350d510673e59ede6277458763d796cf6 Mon Sep 17 00:00:00 2001 From: Courtney Date: Wed, 12 May 2021 22:24:10 -0700 Subject: [PATCH 09/11] refactored so each route handles one method --- app/routes.py | 163 ++++++++++++++++++++++++++++---------------------- 1 file changed, 93 insertions(+), 70 deletions(-) diff --git a/app/routes.py b/app/routes.py index e4c6dd274..98a9c232d 100644 --- a/app/routes.py +++ b/app/routes.py @@ -10,49 +10,61 @@ tasks_bp = Blueprint("tasks", __name__, url_prefix="/tasks") goals_bp = Blueprint("goals", __name__, url_prefix="/goals") -@tasks_bp.route("", methods=["GET", "POST"]) -def handle_tasks(): - if request.method == "GET": - order_query = request.args.get("sort") - if order_query == "asc": - tasks = Task.query.order_by(asc(Task.title)) - elif order_query == "desc": - tasks = Task.query.order_by(desc(Task.title)) - else: - tasks = Task.query.all() - tasks_response = [] - for task in tasks: - tasks_response.append(task.to_dict()) - return make_response(jsonify(tasks_response), 200) - else: - request_body = request.get_json() - if "title" in request_body and "description" in request_body and "completed_at" in request_body: - 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({"task": new_task.to_dict()}, 201) - else: - return make_response({"details": "Invalid data"}, 400) +@tasks_bp.route("", methods=["GET"]) +def get_tasks(): + order_query = request.args.get("sort") + if order_query == "asc": + tasks = Task.query.order_by(asc(Task.title)) + elif order_query == "desc": + tasks = Task.query.order_by(desc(Task.title)) + else: + tasks = Task.query.all() + tasks_response = [] + for task in tasks: + tasks_response.append(task.to_dict()) + return make_response(jsonify(tasks_response), 200) -@tasks_bp.route("/", methods=["GET", "PUT", "DELETE"]) -def handle_task(task_id): +@tasks_bp.route("", methods=["POST"]) +def create_task(): + request_body = request.get_json() + if "title" in request_body and "description" in request_body and "completed_at" in request_body: + 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({"task": new_task.to_dict()}, 201) + else: + return make_response({"details": "Invalid data"}, 400) + +@tasks_bp.route("/", methods=["GET"]) +def get_one_task(task_id): task = Task.query.get(task_id) if task: - if request.method == "GET": - return {"task": task.to_dict()}, 200 - elif request.method == "PUT": - form_data = request.get_json() - task.title = form_data["title"] - task.description = form_data["description"] - task.completed_at = form_data["completed_at"] - db.session.commit() - return make_response({"task": task.to_dict()}, 200) - elif request.method == "DELETE": - db.session.delete(task) - db.session.commit() - return make_response({"details": f"Task {task.task_id} \"{task.title}\" successfully deleted"}, 200) + return {"task": task.to_dict()}, 200 + else: + return make_response("", 404) + +@tasks_bp.route("/", methods=["PUT"]) +def update_task(task_id): + task = Task.query.get(task_id) + if task: + form_data = request.get_json() + task.title = form_data["title"] + task.description = form_data["description"] + task.completed_at = form_data["completed_at"] + db.session.commit() + return make_response({"task": task.to_dict()}, 200) + else: + return make_response("", 404) + +@tasks_bp.route("/", methods=["DELETE"]) +def delete_task(task_id): + task = Task.query.get(task_id) + if task: + db.session.delete(task) + db.session.commit() + return make_response({"details": f"Task {task.task_id} \"{task.title}\" successfully deleted"}, 200) else: return make_response("", 404) @@ -90,42 +102,53 @@ def send_slack_message(task_title): #WAVE 5 -@goals_bp.route("", methods=["GET", "POST"]) -def handle_goals(): - if request.method == "GET": - goals = Goal.query.all() - goals_response = [] - for goal in goals: - goals_response.append(goal.to_dict()) - return make_response(jsonify(goals_response), 200) - else: - request_body = request.get_json() - if "title" in request_body: - new_goal = Goal(title = request_body["title"]) - db.session.add(new_goal) - db.session.commit() - return make_response({"goal": new_goal.to_dict()}, 201) - else: - return make_response({"details": "Invalid data"}, 400) +@goals_bp.route("", methods=["GET"]) +def get_goals(): + goals = Goal.query.all() + goals_response = [] + for goal in goals: + goals_response.append(goal.to_dict()) + return make_response(jsonify(goals_response), 200) -@goals_bp.route("/", methods=["GET", "PUT", "DELETE"]) -def handle_goal(goal_id): +@goals_bp.route("", methods=["POST"]) +def create_goal(): + request_body = request.get_json() + if "title" in request_body: + new_goal = Goal(title = request_body["title"]) + db.session.add(new_goal) + db.session.commit() + return make_response({"goal": new_goal.to_dict()}, 201) + else: + return make_response({"details": "Invalid data"}, 400) + +@goals_bp.route("/", methods=["GET"]) +def get_one_goal(goal_id): goal = Goal.query.get(goal_id) if goal: - if request.method == "GET": - return {"goal": goal.to_dict()}, 200 - elif request.method == "PUT": - form_data = request.get_json() - goal.title = form_data["title"] - db.session.commit() - return make_response({"goal": goal.to_dict()}, 200) - elif request.method == "DELETE": - db.session.delete(goal) - db.session.commit() - return make_response({"details": f"Goal {goal.goal_id} \"{goal.title}\" successfully deleted"}, 200) + return {"goal": goal.to_dict()}, 200 else: return make_response("", 404) +@goals_bp.route("/", methods=["PUT"]) +def update_goal(goal_id): + goal = Goal.query.get(goal_id) + if goal: + form_data = request.get_json() + goal.title = form_data["title"] + db.session.commit() + return make_response({"goal": goal.to_dict()}, 200) + else: + return make_response("", 404) + +@goals_bp.route("/", methods=["DELETE"]) +def delete_goal(goal_id): + goal = Goal.query.get(goal_id) + if goal: + db.session.delete(goal) + db.session.commit() + return make_response({"details": f"Goal {goal.goal_id} \"{goal.title}\" successfully deleted"}, 200) + else: + return make_response("", 404) # WAVE 06 @goals_bp.route("//tasks", methods=["POST"]) From adeda2ea6175b1c8a451e73c8299dfa9d4f236a9 Mon Sep 17 00:00:00 2001 From: Courtney Date: Thu, 13 May 2021 09:22:55 -0700 Subject: [PATCH 10/11] refactored so each endpoint method has its own route --- app/routes.py | 34 ++++++++++++---------------------- 1 file changed, 12 insertions(+), 22 deletions(-) diff --git a/app/routes.py b/app/routes.py index 98a9c232d..36a1f6470 100644 --- a/app/routes.py +++ b/app/routes.py @@ -34,16 +34,14 @@ def create_task(): db.session.add(new_task) db.session.commit() return make_response({"task": new_task.to_dict()}, 201) - else: - return make_response({"details": "Invalid data"}, 400) + return make_response({"details": "Invalid data"}, 400) @tasks_bp.route("/", methods=["GET"]) def get_one_task(task_id): task = Task.query.get(task_id) if task: return {"task": task.to_dict()}, 200 - else: - return make_response("", 404) + return make_response("", 404) @tasks_bp.route("/", methods=["PUT"]) def update_task(task_id): @@ -55,8 +53,7 @@ def update_task(task_id): task.completed_at = form_data["completed_at"] db.session.commit() return make_response({"task": task.to_dict()}, 200) - else: - return make_response("", 404) + return make_response("", 404) @tasks_bp.route("/", methods=["DELETE"]) def delete_task(task_id): @@ -65,8 +62,7 @@ def delete_task(task_id): db.session.delete(task) db.session.commit() return make_response({"details": f"Task {task.task_id} \"{task.title}\" successfully deleted"}, 200) - else: - return make_response("", 404) + return make_response("", 404) @tasks_bp.route("//", methods=["PATCH"]) def handle_task_completion(task_id, mark_status): @@ -81,8 +77,7 @@ def handle_task_completion(task_id, mark_status): db.session.commit() send_slack_message(task.title) return make_response({"task": task.to_dict()}, 200) - else: - return make_response("", 404) + return make_response("", 404) #WAVE 4 @@ -118,16 +113,14 @@ def create_goal(): db.session.add(new_goal) db.session.commit() return make_response({"goal": new_goal.to_dict()}, 201) - else: - return make_response({"details": "Invalid data"}, 400) + return make_response({"details": "Invalid data"}, 400) @goals_bp.route("/", methods=["GET"]) def get_one_goal(goal_id): goal = Goal.query.get(goal_id) if goal: return {"goal": goal.to_dict()}, 200 - else: - return make_response("", 404) + return make_response("", 404) @goals_bp.route("/", methods=["PUT"]) def update_goal(goal_id): @@ -137,8 +130,7 @@ def update_goal(goal_id): goal.title = form_data["title"] db.session.commit() return make_response({"goal": goal.to_dict()}, 200) - else: - return make_response("", 404) + return make_response("", 404) @goals_bp.route("/", methods=["DELETE"]) def delete_goal(goal_id): @@ -147,8 +139,7 @@ def delete_goal(goal_id): db.session.delete(goal) db.session.commit() return make_response({"details": f"Goal {goal.goal_id} \"{goal.title}\" successfully deleted"}, 200) - else: - return make_response("", 404) + return make_response("", 404) # WAVE 06 @goals_bp.route("//tasks", methods=["POST"]) @@ -166,9 +157,7 @@ def assign_tasks_to_goal(goal_id): @goals_bp.route("//tasks", methods=["GET"]) def get_tasks_of_one_goal(goal_id): goal = Goal.query.get(goal_id) - if not Goal.query.get(goal_id): - return make_response("404"), 404 - else: + if goal: tasks_response = [] tasks_of_goal = Task.query.filter_by(goal_id=goal_id) if tasks_of_goal: @@ -178,4 +167,5 @@ def get_tasks_of_one_goal(goal_id): "id": int(goal_id), "title": goal.title, "tasks": tasks_response - }, 200) \ No newline at end of file + }, 200) + return make_response("", 404) \ No newline at end of file From cf33852d574e9ea84c3cb0794eecf391ae230703 Mon Sep 17 00:00:00 2001 From: Courtney Date: Thu, 13 May 2021 09:45:03 -0700 Subject: [PATCH 11/11] refactored routes to include list comprehensions --- app/routes.py | 12 +++--------- 1 file changed, 3 insertions(+), 9 deletions(-) diff --git a/app/routes.py b/app/routes.py index 36a1f6470..2b0cccf57 100644 --- a/app/routes.py +++ b/app/routes.py @@ -19,9 +19,7 @@ def get_tasks(): tasks = Task.query.order_by(desc(Task.title)) 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] return make_response(jsonify(tasks_response), 200) @tasks_bp.route("", methods=["POST"]) @@ -100,9 +98,7 @@ def send_slack_message(task_title): @goals_bp.route("", methods=["GET"]) def get_goals(): goals = Goal.query.all() - goals_response = [] - for goal in goals: - goals_response.append(goal.to_dict()) + goals_response = [goal.to_dict() for goal in goals] return make_response(jsonify(goals_response), 200) @goals_bp.route("", methods=["POST"]) @@ -158,11 +154,9 @@ def assign_tasks_to_goal(goal_id): def get_tasks_of_one_goal(goal_id): goal = Goal.query.get(goal_id) if goal: - tasks_response = [] tasks_of_goal = Task.query.filter_by(goal_id=goal_id) if tasks_of_goal: - for task in tasks_of_goal: - tasks_response.append(task.to_dict()) + tasks_response = [task.to_dict() for task in tasks_of_goal] return make_response({ "id": int(goal_id), "title": goal.title,