From 59ba3dcd6ff56fb3dd00873a0baae1a3394ed9c6 Mon Sep 17 00:00:00 2001 From: Lin Zhang Date: Wed, 5 May 2021 12:42:34 -0400 Subject: [PATCH 01/18] completes setup --- migrations/README | 1 + migrations/alembic.ini | 45 ++++++++++++++++++ migrations/env.py | 96 +++++++++++++++++++++++++++++++++++++++ migrations/script.py.mako | 24 ++++++++++ 4 files changed, 166 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 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"} From 434d4502f8e42badacaaa32d599b34bd71622d9c Mon Sep 17 00:00:00 2001 From: Lin Zhang Date: Sun, 9 May 2021 19:56:51 -0400 Subject: [PATCH 02/18] passes wave 1 tests that took way too long --- app/__init__.py | 5 +++ app/models/task.py | 20 ++++++++- app/routes.py | 61 +++++++++++++++++++++++++++- migrations/versions/1bb62149cec1_.py | 39 ++++++++++++++++++ migrations/versions/5b323b3e516c_.py | 38 +++++++++++++++++ 5 files changed, 161 insertions(+), 2 deletions(-) create mode 100644 migrations/versions/1bb62149cec1_.py create mode 100644 migrations/versions/5b323b3e516c_.py diff --git a/app/__init__.py b/app/__init__.py index 2764c4cc8..f23daff80 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -30,5 +30,10 @@ def create_app(test_config=None): migrate.init_app(app, db) # Register Blueprints here + from .routes import tasks_bp + app.register_blueprint(tasks_bp) + + # from .routes import goals_bp + # app.register_blueprint(goals_bp) return app diff --git a/app/models/task.py b/app/models/task.py index 39c89cd16..01b5e69ce 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -1,6 +1,24 @@ from flask import current_app from app import db +from sqlalchemy import DateTime class Task(db.Model): - task_id = db.Column(db.Integer, primary_key=True) + task_id = db.Column(db.Integer, primary_key=True, autoincrement=True) + title = db.Column(db.String) + description = db.Column(db.String) + completed_at = db.Column(db.DateTime, nullable=True) + + def is_complete(self): + if self.completed_at: + return True + else: + return False + + def to_dict(self): + return { + "id": self.task_id, + "title": self.title, + "description": self.description, + "is_complete": self.is_complete() + } diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..c24cdfa07 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,61 @@ -from flask import Blueprint +from app import db +from app.models.task import Task +# from app.models.goal import Goal +from flask import request, Blueprint, make_response, jsonify +from datetime import datetime +tasks_bp = Blueprint( + "tasks", __name__, url_prefix="/tasks") + + +@tasks_bp.route("", methods=["POST"], strict_slashes=False) +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 jsonify({"task": new_task.to_dict()}), 201 + + else: + return make_response({"details": "Invalid data"}, 400) + + +@tasks_bp.route("", methods=["GET"], strict_slashes=False) +def task_index(): + 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"], strict_slashes=False) +def handle_task(task_id): + task = Task.query.get(task_id) + if task is None: + return make_response("", 404) + + if request.method == "GET": + return jsonify({"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 jsonify({"task": task.to_dict()}), 200 + + elif request.method == "DELETE": + db.session.delete(task) + db.session.commit() + task_response = { + "details": f'Task {task.task_id} "{task.title}" successfully deleted'} + return make_response(task_response), 200 diff --git a/migrations/versions/1bb62149cec1_.py b/migrations/versions/1bb62149cec1_.py new file mode 100644 index 000000000..521baf4e9 --- /dev/null +++ b/migrations/versions/1bb62149cec1_.py @@ -0,0 +1,39 @@ +"""empty message + +Revision ID: 1bb62149cec1 +Revises: +Create Date: 2021-05-07 14:05:50.281429 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '1bb62149cec1' +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('task_title', sa.String(), nullable=True), + sa.Column('task_description', sa.String(), nullable=True), + sa.Column('task_completed_at', sa.DateTime(), nullable=True), + sa.PrimaryKeyConstraint('task_id') + ) + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.drop_table('task') + op.drop_table('goal') + # ### end Alembic commands ### diff --git a/migrations/versions/5b323b3e516c_.py b/migrations/versions/5b323b3e516c_.py new file mode 100644 index 000000000..69749c475 --- /dev/null +++ b/migrations/versions/5b323b3e516c_.py @@ -0,0 +1,38 @@ +"""empty message + +Revision ID: 5b323b3e516c +Revises: 1bb62149cec1 +Create Date: 2021-05-09 00:29:50.225257 + +""" +from alembic import op +import sqlalchemy as sa +from sqlalchemy.dialects import postgresql + +# revision identifiers, used by Alembic. +revision = '5b323b3e516c' +down_revision = '1bb62149cec1' +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.add_column('task', sa.Column('completed_at', sa.DateTime(), nullable=True)) + op.add_column('task', sa.Column('description', sa.String(), nullable=True)) + op.add_column('task', sa.Column('title', sa.String(), nullable=True)) + op.drop_column('task', 'task_completed_at') + op.drop_column('task', 'task_description') + op.drop_column('task', 'task_title') + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.add_column('task', sa.Column('task_title', sa.VARCHAR(), autoincrement=False, nullable=True)) + op.add_column('task', sa.Column('task_description', sa.VARCHAR(), autoincrement=False, nullable=True)) + op.add_column('task', sa.Column('task_completed_at', postgresql.TIMESTAMP(), autoincrement=False, nullable=True)) + op.drop_column('task', 'title') + op.drop_column('task', 'description') + op.drop_column('task', 'completed_at') + # ### end Alembic commands ### From a642146582319145d84e2ac9457f71d8492aabcc Mon Sep 17 00:00:00 2001 From: Lin Zhang Date: Sun, 9 May 2021 22:16:57 -0400 Subject: [PATCH 03/18] adds wave 2 --- app/routes.py | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/app/routes.py b/app/routes.py index c24cdfa07..7136c978c 100644 --- a/app/routes.py +++ b/app/routes.py @@ -28,7 +28,14 @@ def create_task(): @tasks_bp.route("", methods=["GET"], strict_slashes=False) def task_index(): - tasks = Task.query.all() + sort_query = request.args.get("sort") + if sort_query == "asc": + tasks = Task.query.order_by(Task.title) + elif sort_query == "desc": + tasks = Task.query.order_by(Task.title.desc()) + else: + tasks = Task.query.all() + tasks_response = [] for task in tasks: tasks_response.append(task.to_dict()) From 21049ca843a01bec7272e275340360ab7e21e431 Mon Sep 17 00:00:00 2001 From: Lin Zhang Date: Sun, 9 May 2021 23:36:00 -0400 Subject: [PATCH 04/18] adds part of wave 3 --- app/routes.py | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/app/routes.py b/app/routes.py index 7136c978c..af74dd283 100644 --- a/app/routes.py +++ b/app/routes.py @@ -66,3 +66,27 @@ def handle_task(task_id): task_response = { "details": f'Task {task.task_id} "{task.title}" successfully deleted'} return make_response(task_response), 200 + + +@tasks_bp.route("//mark_complete", methods=["PATCH"], strict_slashes=False) +def handle_complete(task_id): + task = Task.query.get(task_id) + if task is None: + return make_response("", 404) + else: + form_data = request.get_json() + task.completed_at = form_data["completed_at"] + db.session.commit() + return jsonify({"task": task.to_dict()}), 200 + + +@tasks_bp.route("//mark_incomplete", methods=["PATCH"], strict_slashes=False) +def handle_incomplete(task_id): + task = Task.query.get(task_id) + if task is None: + return make_response("", 404) + else: + form_data = request.get_json() + task.completed_at = form_data["completed_at"] + db.session.commit() + return jsonify({"task": task.to_dict()}), 200 From eddd26575fc62d012f5d06a380be4c2a5acf08b7 Mon Sep 17 00:00:00 2001 From: Lin Zhang Date: Sun, 9 May 2021 23:54:56 -0400 Subject: [PATCH 05/18] passes wave 3 tests yay --- app/routes.py | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/app/routes.py b/app/routes.py index af74dd283..b75e3d2f5 100644 --- a/app/routes.py +++ b/app/routes.py @@ -74,8 +74,7 @@ def handle_complete(task_id): if task is None: return make_response("", 404) else: - form_data = request.get_json() - task.completed_at = form_data["completed_at"] + task.completed_at = datetime.now() db.session.commit() return jsonify({"task": task.to_dict()}), 200 @@ -86,7 +85,6 @@ def handle_incomplete(task_id): if task is None: return make_response("", 404) else: - form_data = request.get_json() - task.completed_at = form_data["completed_at"] + task.completed_at = None db.session.commit() return jsonify({"task": task.to_dict()}), 200 From a5c93feae1eda3944d838c7dfb2473f8555f7ada Mon Sep 17 00:00:00 2001 From: Lin Zhang Date: Tue, 11 May 2021 20:35:01 -0400 Subject: [PATCH 06/18] passes all wave 4 and adds external API: Slackbot --- app/__init__.py | 4 ++-- app/models/task.py | 2 +- app/routes.py | 38 +++++++++++++++++++++++++++++--------- 3 files changed, 32 insertions(+), 12 deletions(-) diff --git a/app/__init__.py b/app/__init__.py index f23daff80..9a7870547 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,8 +1,8 @@ from flask import Flask -from flask_sqlalchemy import SQLAlchemy from flask_migrate import Migrate -import os +from flask_sqlalchemy import SQLAlchemy from dotenv import load_dotenv +import os db = SQLAlchemy() diff --git a/app/models/task.py b/app/models/task.py index 01b5e69ce..c3373be7f 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -1,5 +1,5 @@ -from flask import current_app from app import db +from flask import current_app from sqlalchemy import DateTime diff --git a/app/routes.py b/app/routes.py index b75e3d2f5..cf3bc78b3 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,13 +1,16 @@ from app import db from app.models.task import Task # from app.models.goal import Goal -from flask import request, Blueprint, make_response, jsonify from datetime import datetime +from flask import request, Blueprint, make_response, jsonify +import requests +import os tasks_bp = Blueprint( "tasks", __name__, url_prefix="/tasks") +# WAVE 1 @tasks_bp.route("", methods=["POST"], strict_slashes=False) def create_task(): request_body = request.get_json() @@ -26,6 +29,7 @@ def create_task(): return make_response({"details": "Invalid data"}, 400) +# WAVE 2 @tasks_bp.route("", methods=["GET"], strict_slashes=False) def task_index(): sort_query = request.args.get("sort") @@ -42,6 +46,7 @@ def task_index(): return make_response(jsonify(tasks_response), 200) +# WAVE 1 @tasks_bp.route("/", methods=["GET", "PUT", "DELETE"], strict_slashes=False) def handle_task(task_id): task = Task.query.get(task_id) @@ -68,23 +73,38 @@ def handle_task(task_id): return make_response(task_response), 200 -@tasks_bp.route("//mark_complete", methods=["PATCH"], strict_slashes=False) -def handle_complete(task_id): +# WAVE 3 +@tasks_bp.route("//mark_incomplete", methods=["PATCH"], strict_slashes=False) +def handle_incomplete(task_id): task = Task.query.get(task_id) if task is None: return make_response("", 404) else: - task.completed_at = datetime.now() + task.completed_at = None db.session.commit() - return jsonify({"task": task.to_dict()}), 200 + return jsonify({"task": task.to_dict()}), 200 -@tasks_bp.route("//mark_incomplete", methods=["PATCH"], strict_slashes=False) -def handle_incomplete(task_id): +@tasks_bp.route("//mark_complete", methods=["PATCH"], strict_slashes=False) +def handle_complete(task_id): task = Task.query.get(task_id) if task is None: return make_response("", 404) else: - task.completed_at = None + task.completed_at = datetime.now() db.session.commit() - return jsonify({"task": task.to_dict()}), 200 + call_slack_api(task) + return jsonify({"task": task.to_dict()}), 200 + + +# WAVE 4 +def call_slack_api(task): + SLACK_TOKEN = os.environ.get("SLACK_BOT_TOKEN") + url = "https://slack.com/api/chat.postMessage" + payload = { + "channel": "task-notifications", + "text": f"Someone just completed the task {task.title}"} + headers = { + "Authorization": f"Bearer {SLACK_TOKEN}", + } + return requests.request("POST", url, headers=headers, data=payload) From c5c5ea47faca69b3250b8ba98181b26593492108 Mon Sep 17 00:00:00 2001 From: Lin Zhang Date: Tue, 11 May 2021 20:41:17 -0400 Subject: [PATCH 07/18] getting ready to copy everything from wave 1 to wave 5 and hope it passes --- app/routes.py | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/app/routes.py b/app/routes.py index cf3bc78b3..407b8c3fc 100644 --- a/app/routes.py +++ b/app/routes.py @@ -10,7 +10,9 @@ "tasks", __name__, url_prefix="/tasks") -# WAVE 1 +# ------------------------- +# WAVE 1 - TASK ENDPOINTS +# ------------------------- @tasks_bp.route("", methods=["POST"], strict_slashes=False) def create_task(): request_body = request.get_json() @@ -98,7 +100,7 @@ def handle_complete(task_id): # WAVE 4 -def call_slack_api(task): +def call_slack_api(task_name): SLACK_TOKEN = os.environ.get("SLACK_BOT_TOKEN") url = "https://slack.com/api/chat.postMessage" payload = { @@ -108,3 +110,8 @@ def call_slack_api(task): "Authorization": f"Bearer {SLACK_TOKEN}", } return requests.request("POST", url, headers=headers, data=payload) + + +# ------------------------- +# WAVE 5 - GOAL ENDPOINTS +# ------------------------- From 5d10d1f815b036a3762908b31138de7bda5657cc Mon Sep 17 00:00:00 2001 From: Lin Zhang Date: Tue, 11 May 2021 21:28:04 -0400 Subject: [PATCH 08/18] adds extra wave 4 function using Bolt framework/Python SDK instead of requests --- app/__init__.py | 4 +--- app/routes.py | 22 +++++++++++++++++++--- requirements.txt | 1 + 3 files changed, 21 insertions(+), 6 deletions(-) diff --git a/app/__init__.py b/app/__init__.py index 9a7870547..3f9674a9e 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -30,10 +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) - - # from .routes import goals_bp # app.register_blueprint(goals_bp) return app diff --git a/app/routes.py b/app/routes.py index 407b8c3fc..d1ce46d89 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,10 +1,13 @@ from app import db from app.models.task import Task -# from app.models.goal import Goal from datetime import datetime from flask import request, Blueprint, make_response, jsonify import requests import os +# from app.models.goal import Goal +from slack_sdk import WebClient +from slack_sdk.errors import SlackApiError + tasks_bp = Blueprint( "tasks", __name__, url_prefix="/tasks") @@ -26,7 +29,6 @@ def create_task(): db.session.add(new_task) db.session.commit() return jsonify({"task": new_task.to_dict()}), 201 - else: return make_response({"details": "Invalid data"}, 400) @@ -100,7 +102,7 @@ def handle_complete(task_id): # WAVE 4 -def call_slack_api(task_name): +def call_slack_api(task): SLACK_TOKEN = os.environ.get("SLACK_BOT_TOKEN") url = "https://slack.com/api/chat.postMessage" payload = { @@ -112,6 +114,20 @@ def call_slack_api(task_name): return requests.request("POST", url, headers=headers, data=payload) +# def call_slack_api(task): +# client = WebClient(token=os.environ.get("SLACK_BOT_TOKEN")) +# channel_id = "T0226NANZ9N" +# try: +# result = client.chat_postMessage( +# channel=channel_id, +# text=f"Someone just completed the task {task.title}" +# ) +# logger.info(result) + +# except SlackApiError as e: +# logger.error(f"Error posting message: {e}") + + # ------------------------- # WAVE 5 - GOAL ENDPOINTS # ------------------------- diff --git a/requirements.txt b/requirements.txt index cfdf74050..6a684c4be 100644 --- a/requirements.txt +++ b/requirements.txt @@ -26,6 +26,7 @@ python-dotenv==0.15.0 python-editor==1.0.4 requests==2.25.1 six==1.15.0 +slack-sdk==3.5.1 SQLAlchemy==1.3.23 toml==0.10.2 urllib3==1.26.4 From 353a7d808ac1f6b247bd54dd6849a1d0bda5e3e4 Mon Sep 17 00:00:00 2001 From: Lin Zhang Date: Tue, 11 May 2021 23:33:01 -0400 Subject: [PATCH 09/18] passes wave 5 tests --- app/__init__.py | 5 +-- app/models/goal.py | 9 ++++- app/routes.py | 49 ++++++++++++++++++++++++++-- migrations/versions/9bb4509ff1ea_.py | 28 ++++++++++++++++ 4 files changed, 86 insertions(+), 5 deletions(-) create mode 100644 migrations/versions/9bb4509ff1ea_.py diff --git a/app/__init__.py b/app/__init__.py index 3f9674a9e..c99bc64f1 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -30,8 +30,9 @@ def create_app(test_config=None): migrate.init_app(app, db) # Register Blueprints here - from .routes import tasks_bp # , goals_bp + from .routes import tasks_bp app.register_blueprint(tasks_bp) - # app.register_blueprint(goals_bp) + from .routes import goals_bp + app.register_blueprint(goals_bp) return app diff --git a/app/models/goal.py b/app/models/goal.py index 8cad278f8..dbfc3a2d0 100644 --- a/app/models/goal.py +++ b/app/models/goal.py @@ -3,4 +3,11 @@ class Goal(db.Model): - goal_id = db.Column(db.Integer, primary_key=True) + goal_id = db.Column(db.Integer, primary_key=True, autoincrement=True) + title = db.Column(db.String) + + def to_dict(self): + return { + "id": self.goal_id, + "title": self.title, + } diff --git a/app/routes.py b/app/routes.py index d1ce46d89..1355fbd6b 100644 --- a/app/routes.py +++ b/app/routes.py @@ -4,10 +4,12 @@ from flask import request, Blueprint, make_response, jsonify import requests import os -# from app.models.goal import Goal from slack_sdk import WebClient from slack_sdk.errors import SlackApiError +from app.models.goal import Goal +goals_bp = Blueprint( + "goals", __name__, url_prefix="/goals") tasks_bp = Blueprint( "tasks", __name__, url_prefix="/tasks") @@ -86,7 +88,7 @@ def handle_incomplete(task_id): else: task.completed_at = None db.session.commit() - return jsonify({"task": task.to_dict()}), 200 + return jsonify({"task": task.to_dict()}), 200 @tasks_bp.route("//mark_complete", methods=["PATCH"], strict_slashes=False) @@ -131,3 +133,46 @@ def call_slack_api(task): # ------------------------- # WAVE 5 - GOAL ENDPOINTS # ------------------------- + +@goals_bp.route("", methods=["POST"], strict_slashes=False) +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 jsonify({"goal": new_goal.to_dict()}), 201 + return make_response({"details": "Invalid data"}, 400) + + +@goals_bp.route("", methods=["GET"], strict_slashes=False) +def goal_index(): + 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"], strict_slashes=False) +def handle_goal(goal_id): + goal = Goal.query.get(goal_id) + if goal is None: + return make_response("", 404) + + if request.method == "GET": + return jsonify({"goal": goal.to_dict()}), 200 + + elif request.method == "PUT": + form_data = request.get_json() + goal.title = form_data["title"] + db.session.commit() + return jsonify({"goal": goal.to_dict()}), 200 + + elif request.method == "DELETE": + db.session.delete(goal) + db.session.commit() + goal_response = { + "details": f'Goal {goal.goal_id} "{goal.title}" successfully deleted'} + return make_response(goal_response), 200 diff --git a/migrations/versions/9bb4509ff1ea_.py b/migrations/versions/9bb4509ff1ea_.py new file mode 100644 index 000000000..2b9ab7999 --- /dev/null +++ b/migrations/versions/9bb4509ff1ea_.py @@ -0,0 +1,28 @@ +"""empty message + +Revision ID: 9bb4509ff1ea +Revises: 5b323b3e516c +Create Date: 2021-05-11 22:36:48.384281 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '9bb4509ff1ea' +down_revision = '5b323b3e516c' +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 7b6b8c8e9345d5a1eab6c9b1bf51eeec5e5d5db4 Mon Sep 17 00:00:00 2001 From: Lin Zhang Date: Wed, 12 May 2021 01:01:09 -0400 Subject: [PATCH 10/18] fixes wave 4 bolt code --- app/__init__.py | 1 - app/routes.py | 25 ++++++++++--------------- 2 files changed, 10 insertions(+), 16 deletions(-) diff --git a/app/__init__.py b/app/__init__.py index c99bc64f1..1d599fe7f 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -4,7 +4,6 @@ from dotenv import load_dotenv import os - db = SQLAlchemy() migrate = Migrate() load_dotenv() diff --git a/app/routes.py b/app/routes.py index 1355fbd6b..b884c4879 100644 --- a/app/routes.py +++ b/app/routes.py @@ -6,8 +6,9 @@ import os from slack_sdk import WebClient from slack_sdk.errors import SlackApiError - from app.models.goal import Goal + + goals_bp = Blueprint( "goals", __name__, url_prefix="/goals") @@ -45,7 +46,6 @@ def task_index(): tasks = Task.query.order_by(Task.title.desc()) else: tasks = Task.query.all() - tasks_response = [] for task in tasks: tasks_response.append(task.to_dict()) @@ -68,7 +68,6 @@ def handle_task(task_id): task.description = form_data['description'] task.completed_at = form_data["completed_at"] db.session.commit() - return jsonify({"task": task.to_dict()}), 200 elif request.method == "DELETE": @@ -115,25 +114,21 @@ def call_slack_api(task): } return requests.request("POST", url, headers=headers, data=payload) - +# IGNORE - WORKS BUT USES SLACK BOLT/PYTHON SDK (from slack API documentation) instead of requests.package # def call_slack_api(task): # client = WebClient(token=os.environ.get("SLACK_BOT_TOKEN")) -# channel_id = "T0226NANZ9N" -# try: -# result = client.chat_postMessage( -# channel=channel_id, -# text=f"Someone just completed the task {task.title}" -# ) -# logger.info(result) - -# except SlackApiError as e: -# logger.error(f"Error posting message: {e}") +# channel_id = "task-notifications" +# # try: +# result = client.chat_postMessage( +# channel=channel_id, +# text=f"Someone just completed the task {task.title}" +# ) +# return result # ------------------------- # WAVE 5 - GOAL ENDPOINTS # ------------------------- - @goals_bp.route("", methods=["POST"], strict_slashes=False) def create_goal(): request_body = request.get_json() From 4f7f4acc110ee9e6e57db311e93402a0db70e2d3 Mon Sep 17 00:00:00 2001 From: Lin Zhang Date: Wed, 12 May 2021 23:26:38 -0400 Subject: [PATCH 11/18] passes all tests --- app/models/goal.py | 9 +++++++ app/models/task.py | 13 +++++++++ app/routes.py | 40 +++++++++++++++++++++++++++- migrations/versions/214d1c57aeb2_.py | 30 +++++++++++++++++++++ 4 files changed, 91 insertions(+), 1 deletion(-) create mode 100644 migrations/versions/214d1c57aeb2_.py diff --git a/app/models/goal.py b/app/models/goal.py index dbfc3a2d0..7b7eadbf4 100644 --- a/app/models/goal.py +++ b/app/models/goal.py @@ -5,9 +5,18 @@ class Goal(db.Model): goal_id = db.Column(db.Integer, primary_key=True, autoincrement=True) title = db.Column(db.String) + # 'Task' looks at class in python and loads multiple of those (this is like a pseudo column) + tasks = db.relationship('Task', backref='goal', lazy=True) def to_dict(self): return { "id": self.goal_id, "title": self.title, } + + # def with_tasks(self): + # return { + # "id": self.goal_id, + # "title": self.title, + # "tasks": self.with_goal() + # } diff --git a/app/models/task.py b/app/models/task.py index c3373be7f..04c2e7c2d 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -9,6 +9,10 @@ class Task(db.Model): description = db.Column(db.String) completed_at = db.Column(db.DateTime, nullable=True) + # lowercase 'goal.id' looks at a table in your db + goal_id = db.Column(db.Integer, db.ForeignKey( + 'goal.goal_id'), nullable=True) + def is_complete(self): if self.completed_at: return True @@ -22,3 +26,12 @@ def to_dict(self): "description": self.description, "is_complete": self.is_complete() } + + def with_goal(self): + return { + "id": self.task_id, + "title": self.title, + "description": self.description, + "is_complete": self.is_complete(), + "goal_id": self.goal_id + } diff --git a/app/routes.py b/app/routes.py index b884c4879..747ac5447 100644 --- a/app/routes.py +++ b/app/routes.py @@ -60,7 +60,10 @@ def handle_task(task_id): return make_response("", 404) if request.method == "GET": - return jsonify({"task": task.to_dict()}), 200 + if task.goal_id is None: + return jsonify({"task": task.to_dict()}), 200 + else: + return jsonify({"task": task.with_goal()}), 200 elif request.method == "PUT": form_data = request.get_json() @@ -171,3 +174,38 @@ def handle_goal(goal_id): goal_response = { "details": f'Goal {goal.goal_id} "{goal.title}" successfully deleted'} return make_response(goal_response), 200 + + +# WAVE 6 +@goals_bp.route("//tasks", methods=["POST"], strict_slashes=False) +def sending_list_tasks_to_goal(goal_id): + # from request + request_body = request.get_json() + # task ids from the request body + # for each task id, attach it to the same goal id (in url) + # + # query based on task id + tasks = request_body["task_ids"] + # database + goal = Goal.query.get(goal_id) + for task_id in tasks: + task_db_object = Task.query.get(task_id) + goal.tasks.append(task_db_object) + # task_db_object.goal_id = int(goal_id) + db.session.commit() + return {"id": goal.goal_id, + "task_ids": tasks}, 200 + + +@goals_bp.route("//tasks", methods=["GET"], strict_slashes=False) +def getting_tasks_of_one_goal(goal_id): + goal = Goal.query.get(goal_id) + if goal is None: + return make_response("", 404) + tasks = Task.query.join(Goal).filter(Task.goal_id == goal_id).all() + + tasks_response = [] + for task in tasks: + tasks_response.append(task.with_goal()) + + return{"id": goal.goal_id, "title": goal.title, "tasks": tasks_response}, 200 diff --git a/migrations/versions/214d1c57aeb2_.py b/migrations/versions/214d1c57aeb2_.py new file mode 100644 index 000000000..385332b5c --- /dev/null +++ b/migrations/versions/214d1c57aeb2_.py @@ -0,0 +1,30 @@ +"""empty message + +Revision ID: 214d1c57aeb2 +Revises: 9bb4509ff1ea +Create Date: 2021-05-12 18:31:31.628572 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '214d1c57aeb2' +down_revision = '9bb4509ff1ea' +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 f091fba6476015dfedb93b6dd55d2f26b84dc1a3 Mon Sep 17 00:00:00 2001 From: Lin Zhang Date: Thu, 13 May 2021 10:42:33 -0400 Subject: [PATCH 12/18] refactors and removes comments --- app/models/goal.py | 7 ------- app/routes.py | 16 ++++------------ 2 files changed, 4 insertions(+), 19 deletions(-) diff --git a/app/models/goal.py b/app/models/goal.py index 7b7eadbf4..4da39ab54 100644 --- a/app/models/goal.py +++ b/app/models/goal.py @@ -13,10 +13,3 @@ def to_dict(self): "id": self.goal_id, "title": self.title, } - - # def with_tasks(self): - # return { - # "id": self.goal_id, - # "title": self.title, - # "tasks": self.with_goal() - # } diff --git a/app/routes.py b/app/routes.py index 747ac5447..40089e6b3 100644 --- a/app/routes.py +++ b/app/routes.py @@ -11,7 +11,6 @@ goals_bp = Blueprint( "goals", __name__, url_prefix="/goals") - tasks_bp = Blueprint( "tasks", __name__, url_prefix="/tasks") @@ -22,7 +21,6 @@ @tasks_bp.route("", methods=["POST"], strict_slashes=False) 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"], @@ -58,7 +56,7 @@ def handle_task(task_id): task = Task.query.get(task_id) if task is None: return make_response("", 404) - +# thank you audrey! if request.method == "GET": if task.goal_id is None: return jsonify({"task": task.to_dict()}), 200 @@ -117,15 +115,14 @@ def call_slack_api(task): } return requests.request("POST", url, headers=headers, data=payload) -# IGNORE - WORKS BUT USES SLACK BOLT/PYTHON SDK (from slack API documentation) instead of requests.package +# IGNORE - WORKS BUT USES SLACK BOLT/PYTHON SDK (from slack API docs) instead of requests.package # def call_slack_api(task): # client = WebClient(token=os.environ.get("SLACK_BOT_TOKEN")) # channel_id = "task-notifications" # # try: # result = client.chat_postMessage( # channel=channel_id, -# text=f"Someone just completed the task {task.title}" -# ) +# text=f"Someone just completed the task {task.title}") # return result @@ -179,14 +176,9 @@ def handle_goal(goal_id): # WAVE 6 @goals_bp.route("//tasks", methods=["POST"], strict_slashes=False) def sending_list_tasks_to_goal(goal_id): - # from request request_body = request.get_json() - # task ids from the request body - # for each task id, attach it to the same goal id (in url) - # - # query based on task id tasks = request_body["task_ids"] - # database + # (db) goal = Goal.query.get(goal_id) for task_id in tasks: task_db_object = Task.query.get(task_id) From afdc0be0197ffce1196c04f87aa2ff747bc33a2f Mon Sep 17 00:00:00 2001 From: Lin Zhang Date: Thu, 13 May 2021 10:55:29 -0400 Subject: [PATCH 13/18] optional enhancement 1: reorganize routes --- app/routes.py | 59 ++++++++++++++++++++++++++++++++++----------------- 1 file changed, 40 insertions(+), 19 deletions(-) diff --git a/app/routes.py b/app/routes.py index 40089e6b3..8ae5ffefc 100644 --- a/app/routes.py +++ b/app/routes.py @@ -51,32 +51,43 @@ def task_index(): # WAVE 1 -@tasks_bp.route("/", methods=["GET", "PUT", "DELETE"], strict_slashes=False) -def handle_task(task_id): +@tasks_bp.route("/", methods=["GET"], strict_slashes=False) +def get_one_task(task_id): task = Task.query.get(task_id) if task is None: return make_response("", 404) # thank you audrey! - if request.method == "GET": - if task.goal_id is None: - return jsonify({"task": task.to_dict()}), 200 - else: - return jsonify({"task": task.with_goal()}), 200 + elif task.goal_id is None: + return jsonify({"task": task.to_dict()}), 200 + else: + return jsonify({"task": task.with_goal()}), 200 + - elif request.method == "PUT": +@tasks_bp.route("/", methods=["PUT"], strict_slashes=False) +def update_task(task_id): + task = Task.query.get(task_id) + if task is None: + return make_response("", 404) + else: 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 jsonify({"task": task.to_dict()}), 200 + return jsonify({"task": task.to_dict()}), 200 - elif request.method == "DELETE": + +@tasks_bp.route("/", methods=["DELETE"], strict_slashes=False) +def delete_task(task_id): + task = Task.query.get(task_id) + if task is None: + return make_response("", 404) + else: db.session.delete(task) db.session.commit() task_response = { "details": f'Task {task.task_id} "{task.title}" successfully deleted'} - return make_response(task_response), 200 + return make_response(task_response), 200 # WAVE 3 @@ -150,27 +161,37 @@ def goal_index(): return make_response(jsonify(goals_response), 200) -@goals_bp.route("/", methods=["GET", "PUT", "DELETE"], strict_slashes=False) -def handle_goal(goal_id): +@goals_bp.route("/", methods=["GET"], strict_slashes=False) +def get_one_goal(goal_id): goal = Goal.query.get(goal_id) if goal is None: return make_response("", 404) + return jsonify({"goal": goal.to_dict()}), 200 - if request.method == "GET": - return jsonify({"goal": goal.to_dict()}), 200 - elif request.method == "PUT": +@goals_bp.route("/", methods=["PUT"], strict_slashes=False) +def update_goal(goal_id): + goal = Goal.query.get(goal_id) + if goal is None: + return make_response("", 404) + else: form_data = request.get_json() goal.title = form_data["title"] db.session.commit() - return jsonify({"goal": goal.to_dict()}), 200 + return jsonify({"goal": goal.to_dict()}), 200 - elif request.method == "DELETE": + +@goals_bp.route("/", methods=["DELETE"], strict_slashes=False) +def delete_goal(goal_id): + goal = Goal.query.get(goal_id) + if goal is None: + return make_response("", 404) + else: db.session.delete(goal) db.session.commit() goal_response = { "details": f'Goal {goal.goal_id} "{goal.title}" successfully deleted'} - return make_response(goal_response), 200 + return make_response(goal_response), 200 # WAVE 6 From b353a903d7f15e2e5f8b0a6bd2b48d75ce3c59c2 Mon Sep 17 00:00:00 2001 From: Lin Zhang Date: Thu, 13 May 2021 11:13:12 -0400 Subject: [PATCH 14/18] optional 2: list comprehension --- app/routes.py | 15 ++++----------- 1 file changed, 4 insertions(+), 11 deletions(-) diff --git a/app/routes.py b/app/routes.py index 8ae5ffefc..36dc5d326 100644 --- a/app/routes.py +++ b/app/routes.py @@ -44,9 +44,7 @@ def task_index(): tasks = Task.query.order_by(Task.title.desc()) 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) @@ -155,9 +153,7 @@ def create_goal(): @goals_bp.route("", methods=["GET"], strict_slashes=False) def goal_index(): 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) @@ -216,9 +212,6 @@ def getting_tasks_of_one_goal(goal_id): if goal is None: return make_response("", 404) tasks = Task.query.join(Goal).filter(Task.goal_id == goal_id).all() - - tasks_response = [] - for task in tasks: - tasks_response.append(task.with_goal()) - + # tasks_response = [] + tasks_response = [(task.with_goal()) for task in tasks] return{"id": goal.goal_id, "title": goal.title, "tasks": tasks_response}, 200 From b2cf8e11396628214afe2f184ccd61a93313112d Mon Sep 17 00:00:00 2001 From: Lin Zhang Date: Thu, 13 May 2021 11:32:06 -0400 Subject: [PATCH 15/18] optional 3/4: a few router helper and model instance methods --- app/models/task.py | 2 +- app/routes.py | 12 ++++++------ 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/app/models/task.py b/app/models/task.py index 04c2e7c2d..b928b7b15 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -19,7 +19,7 @@ def is_complete(self): else: return False - def to_dict(self): + def to_json(self): return { "id": self.task_id, "title": self.title, diff --git a/app/routes.py b/app/routes.py index 36dc5d326..f0e4f292f 100644 --- a/app/routes.py +++ b/app/routes.py @@ -29,7 +29,7 @@ def create_task(): ) db.session.add(new_task) db.session.commit() - return jsonify({"task": new_task.to_dict()}), 201 + return jsonify({"task": new_task.to_json()}), 201 else: return make_response({"details": "Invalid data"}, 400) @@ -44,7 +44,7 @@ def task_index(): tasks = Task.query.order_by(Task.title.desc()) else: tasks = Task.query.all() - tasks_response = [(task.to_dict()) for task in tasks] + tasks_response = [(task.to_json()) for task in tasks] return make_response(jsonify(tasks_response), 200) @@ -56,7 +56,7 @@ def get_one_task(task_id): return make_response("", 404) # thank you audrey! elif task.goal_id is None: - return jsonify({"task": task.to_dict()}), 200 + return jsonify({"task": task.to_json()}), 200 else: return jsonify({"task": task.with_goal()}), 200 @@ -72,7 +72,7 @@ def update_task(task_id): task.description = form_data['description'] task.completed_at = form_data["completed_at"] db.session.commit() - return jsonify({"task": task.to_dict()}), 200 + return jsonify({"task": task.to_json()}), 200 @tasks_bp.route("/", methods=["DELETE"], strict_slashes=False) @@ -97,7 +97,7 @@ def handle_incomplete(task_id): else: task.completed_at = None db.session.commit() - return jsonify({"task": task.to_dict()}), 200 + return jsonify({"task": task.to_json()}), 200 @tasks_bp.route("//mark_complete", methods=["PATCH"], strict_slashes=False) @@ -109,7 +109,7 @@ def handle_complete(task_id): task.completed_at = datetime.now() db.session.commit() call_slack_api(task) - return jsonify({"task": task.to_dict()}), 200 + return jsonify({"task": task.to_json()}), 200 # WAVE 4 From 5e119137091d6616b6867a964a48c554b7611c77 Mon Sep 17 00:00:00 2001 From: Lin Zhang Date: Thu, 13 May 2021 11:37:34 -0400 Subject: [PATCH 16/18] lol removes import slack_sdk in order to pass tests on Learn --- app/routes.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/app/routes.py b/app/routes.py index f0e4f292f..0956d8b97 100644 --- a/app/routes.py +++ b/app/routes.py @@ -4,8 +4,8 @@ from flask import request, Blueprint, make_response, jsonify import requests import os -from slack_sdk import WebClient -from slack_sdk.errors import SlackApiError +# from slack_sdk import WebClient +# from slack_sdk.errors import SlackApiError from app.models.goal import Goal From 23788eae3b5530beeedef1b65d847ce0d9a07672 Mon Sep 17 00:00:00 2001 From: Lin Zhang Date: Thu, 13 May 2021 11:46:29 -0400 Subject: [PATCH 17/18] adds heroku Procfile --- Procfile | 1 + 1 file changed, 1 insertion(+) create mode 100644 Procfile diff --git a/Procfile b/Procfile new file mode 100644 index 000000000..62e430aca --- /dev/null +++ b/Procfile @@ -0,0 +1 @@ +web: gunicorn 'app:create_app()' \ No newline at end of file From 78c483711d153ef6d1e65703e7328cdda8930b4a Mon Sep 17 00:00:00 2001 From: Lin Zhang Date: Thu, 13 May 2021 12:26:08 -0400 Subject: [PATCH 18/18] final changes after successful deployment --- app/routes.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/routes.py b/app/routes.py index 0956d8b97..7e0ee3604 100644 --- a/app/routes.py +++ b/app/routes.py @@ -69,7 +69,7 @@ def update_task(task_id): else: form_data = request.get_json() task.title = form_data["title"] - task.description = form_data['description'] + task.description = form_data["description"] task.completed_at = form_data["completed_at"] db.session.commit() return jsonify({"task": task.to_json()}), 200