From adad46df02c3bfd10ac79fcf011d2f4ebf8d3dcc Mon Sep 17 00:00:00 2001 From: Regina Date: Thu, 10 Jun 2021 21:17:01 -0700 Subject: [PATCH 1/5] adds wave 1 CRUD for tasks --- app/__init__.py | 5 +- app/models/task.py | 4 ++ app/routes.py | 69 +++++++++++++++++++- migrations/README | 1 + migrations/alembic.ini | 45 +++++++++++++ migrations/env.py | 96 ++++++++++++++++++++++++++++ migrations/script.py.mako | 24 +++++++ migrations/versions/34571d40858b_.py | 39 +++++++++++ 8 files changed, 281 insertions(+), 2 deletions(-) create mode 100644 migrations/README create mode 100644 migrations/alembic.ini create mode 100644 migrations/env.py create mode 100644 migrations/script.py.mako create mode 100644 migrations/versions/34571d40858b_.py diff --git a/app/__init__.py b/app/__init__.py index 2764c4cc8..40f132f14 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -28,7 +28,10 @@ def create_app(test_config=None): db.init_app(app) migrate.init_app(app, db) - + from app.models.task import Task + from .routes import tasks_bp + # Register Blueprints here + app.register_blueprint(tasks_bp) return app diff --git a/app/models/task.py b/app/models/task.py index 39c89cd16..9e658241e 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -4,3 +4,7 @@ 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, default=None) + diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..d3307284c 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,69 @@ -from flask import Blueprint +from app import db +from app.models.task import Task +from flask import request, Blueprint, make_response, jsonify, json +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({ + "id": task.task_id, + "title": task.title, + "description": task.description, + "is_complete": bool(task.completed_at) + }) + return jsonify(tasks_response) + elif request.method == "POST": + request_body = request.get_json() + if "title" not in request_body or "description" not in request_body or "completed_at" not in request_body: + return {"details": f"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"Task {new_task.title} successfully created", 201) + +@tasks_bp.route("/", methods=["GET", "PUT", "DELETE"]) +def handle_task(task_id): + task = Task.query.get(task_id) + + if task is None: + return make_response("Not Found", 404) + elif request.method == "GET": + return { "task":{ + "id": task.task_id, + "title": task.title, + "description": task.description, + "is_complete": bool(task.completed_at) + }} + 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 { + "task":{ + "id": task.task_id, + "title": task.title, + "description": task.description, + "is_complete": bool(task.completed_at) + }} + 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 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/34571d40858b_.py b/migrations/versions/34571d40858b_.py new file mode 100644 index 000000000..8ece015b1 --- /dev/null +++ b/migrations/versions/34571d40858b_.py @@ -0,0 +1,39 @@ +"""empty message + +Revision ID: 34571d40858b +Revises: +Create Date: 2021-06-10 10:03:22.578847 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '34571d40858b' +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 bea4d867b562a3ed58c52d910ad67c912dc959a0 Mon Sep 17 00:00:00 2001 From: Regina Date: Mon, 14 Jun 2021 12:43:57 -0700 Subject: [PATCH 2/5] wave 1 and wave 2 tests all passing --- app/routes.py | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/app/routes.py b/app/routes.py index d3307284c..0544f09e9 100644 --- a/app/routes.py +++ b/app/routes.py @@ -8,7 +8,13 @@ @tasks_bp.route("", methods=["GET","POST"]) def handle_tasks(): if request.method == "GET": - tasks = Task.query.all() + task_query = request.args.get("sort") + if task_query == "asc": + tasks = Task.query.order_by(Task.title) + elif task_query == "desc": + tasks = Task.query.order_by(Task.title.desc()).all() + else: + tasks = Task.query.all() tasks_response = [] for task in tasks: tasks_response.append({ @@ -22,15 +28,22 @@ def handle_tasks(): request_body = request.get_json() if "title" not in request_body or "description" not in request_body or "completed_at" not in request_body: return {"details": f"Invalid data"}, 400 + # if request_body["completed_at"] is None: + # request_body["completed_at"] = false 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"Task {new_task.title} successfully created", 201) + return make_response( + {"task": { + "id": new_task.task_id, + "title": new_task.title, + "description": new_task.description, + "is_complete": bool(new_task.completed_at) + }}, 201) @tasks_bp.route("/", methods=["GET", "PUT", "DELETE"]) def handle_task(task_id): From eb8c32b242e8e523ea159468062b34f83950b51a Mon Sep 17 00:00:00 2001 From: Regina Date: Mon, 14 Jun 2021 19:25:08 -0700 Subject: [PATCH 3/5] adds wave 3 tests passing --- app/routes.py | 33 ++++++++++++++++++++++++++++++++- 1 file changed, 32 insertions(+), 1 deletion(-) diff --git a/app/routes.py b/app/routes.py index 0544f09e9..c767ebfbd 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 request, Blueprint, make_response, jsonify, json +import datetime tasks_bp = Blueprint("tasks", __name__, url_prefix="/tasks") @@ -79,4 +80,34 @@ def handle_task(task_id): db.session.commit() return make_response({ "details":f"Task {task.task_id} \"{task.title}\" successfully deleted" - }) \ No newline at end of file + }) + +@tasks_bp.route("//mark_complete", methods=["PATCH"]) +def handle_task_completion(task_id): + task = Task.query.get(task_id) + if task is None: + return make_response("Not Found", 404) + elif request.method == "PATCH": + if bool(task.completed_at) == False: + task.completed_at = datetime.datetime.now() + return ({ "task":{ + "id": task.task_id, + "title": task.title, + "description": task.description, + "is_complete": bool(task.completed_at) + }}, 200) + +@tasks_bp.route("//mark_incomplete", methods=["PATCH"]) +def handle_task_not_completion(task_id): + task = Task.query.get(task_id) + if task is None: + return make_response("Not Found", 404) + elif request.method == "PATCH": + task.completed_at = None + return ({ "task":{ + "id": task.task_id, + "title": task.title, + "description": task.description, + "is_complete": False + }}, 200) + From 44b066e4ee4aa54d6f5f6bef3a24410d09e4a2b3 Mon Sep 17 00:00:00 2001 From: Regina Date: Mon, 14 Jun 2021 20:41:20 -0700 Subject: [PATCH 4/5] adds slack api and passes wave 4 --- app/routes.py | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/app/routes.py b/app/routes.py index c767ebfbd..058d36d4b 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,7 +1,7 @@ from app import db from app.models.task import Task from flask import request, Blueprint, make_response, jsonify, json -import datetime +import datetime, requests, os tasks_bp = Blueprint("tasks", __name__, url_prefix="/tasks") @@ -81,6 +81,15 @@ def handle_task(task_id): return make_response({ "details":f"Task {task.task_id} \"{task.title}\" successfully deleted" }) +def post_to_slack(slack_message): + SLACK_TOKEN = os.environ.get('SLACK_ACCESS_TOKEN') + slack_path = "https://slack.com/api/chat.postMessage" + query_params ={ + 'channel': 'task-notifications', + 'text': slack_message + } + headers = {'Authorization': f"Bearer {SLACK_TOKEN}"} + requests.post(slack_path, params=query_params, headers=headers) @tasks_bp.route("//mark_complete", methods=["PATCH"]) def handle_task_completion(task_id): @@ -90,12 +99,16 @@ def handle_task_completion(task_id): elif request.method == "PATCH": if bool(task.completed_at) == False: task.completed_at = datetime.datetime.now() - return ({ "task":{ + slack_message = f"Someone just completed the task {task.title}" + post_to_slack(slack_message) + return ( + { "task":{ "id": task.task_id, "title": task.title, "description": task.description, "is_complete": bool(task.completed_at) - }}, 200) + }}, 200 + ) @tasks_bp.route("//mark_incomplete", methods=["PATCH"]) def handle_task_not_completion(task_id): From 9256405fe9ed42f463733a8e948b22a3a2ff588c Mon Sep 17 00:00:00 2001 From: Regina Date: Tue, 15 Jun 2021 01:32:43 -0700 Subject: [PATCH 5/5] adds wave 5 tests passing --- app/__init__.py | 3 ++ app/models/goal.py | 1 + app/routes.py | 60 ++++++++++++++++++++++++++++ migrations/versions/54247471ede8_.py | 28 +++++++++++++ 4 files changed, 92 insertions(+) create mode 100644 migrations/versions/54247471ede8_.py diff --git a/app/__init__.py b/app/__init__.py index 40f132f14..fbeb88cbe 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -30,8 +30,11 @@ def create_app(test_config=None): migrate.init_app(app, db) from app.models.task import Task from .routes import tasks_bp + from app.models.goal import Goal + from .routes import goals_bp # Register Blueprints here app.register_blueprint(tasks_bp) + app.register_blueprint(goals_bp) return app diff --git a/app/models/goal.py b/app/models/goal.py index 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.py b/app/routes.py index 058d36d4b..a6ecc8565 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,9 +1,11 @@ from app import db from app.models.task import Task +from app.models.goal import Goal from flask import request, Blueprint, make_response, jsonify, json import datetime, requests, os tasks_bp = Blueprint("tasks", __name__, url_prefix="/tasks") +goals_bp = Blueprint("goals", __name__, url_prefix="/goals") @tasks_bp.route("", methods=["GET","POST"]) @@ -81,6 +83,7 @@ def handle_task(task_id): return make_response({ "details":f"Task {task.task_id} \"{task.title}\" successfully deleted" }) + def post_to_slack(slack_message): SLACK_TOKEN = os.environ.get('SLACK_ACCESS_TOKEN') slack_path = "https://slack.com/api/chat.postMessage" @@ -124,3 +127,60 @@ def handle_task_not_completion(task_id): "is_complete": False }}, 200) +@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({ + "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 {"details": f"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 + ) + +@goals_bp.route("/", methods=["GET", "PUT", "DELETE"]) +def handle_goal(goal_id): + goal = Goal.query.get(goal_id) + + if goal is None: + return make_response("Not Found", 404) + elif 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 { + "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/migrations/versions/54247471ede8_.py b/migrations/versions/54247471ede8_.py new file mode 100644 index 000000000..d658f1c64 --- /dev/null +++ b/migrations/versions/54247471ede8_.py @@ -0,0 +1,28 @@ +"""empty message + +Revision ID: 54247471ede8 +Revises: 34571d40858b +Create Date: 2021-06-14 22:02:53.429433 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '54247471ede8' +down_revision = '34571d40858b' +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 ###