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 diff --git a/app/__init__.py b/app/__init__.py index 2764c4cc8..d6964182d 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,4 +1,4 @@ -from flask import Flask +from flask import Flask, render_template from flask_sqlalchemy import SQLAlchemy from flask_migrate import Migrate import os @@ -12,6 +12,7 @@ def create_app(test_config=None): app = Flask(__name__) + app.url_map.strict_slashes = False app.config["SQLALCHEMY_TRACK_MODIFICATIONS"] = False if test_config is None: @@ -30,5 +31,12 @@ def create_app(test_config=None): migrate.init_app(app, db) # Register Blueprints here + from .routes import tasks_bp, goals_bp + app.register_blueprint(tasks_bp) + app.register_blueprint(goals_bp) + + @app.route("/") + def index(): + return render_template("index.html") return app diff --git a/app/models/goal.py b/app/models/goal.py index 8cad278f8..6abe60396 100644 --- a/app/models/goal.py +++ b/app/models/goal.py @@ -4,3 +4,5 @@ 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) diff --git a/app/models/task.py b/app/models/task.py index 39c89cd16..265b0b45f 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -4,3 +4,8 @@ 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) + goal_id = db.Column(db.Integer, db.ForeignKey( + 'goal.goal_id'), nullable=True) diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..9ed3f3168 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,274 @@ -from flask import Blueprint +import requests +from dotenv import load_dotenv +import os +import datetime +from sqlalchemy import desc +from app import db +from app.models.task import Task +from app.models.goal import Goal +from flask import request, Blueprint, make_response, jsonify +tasks_bp = Blueprint("tasks", __name__, url_prefix="/tasks") +goals_bp = Blueprint("goals", __name__, url_prefix="/goals") +load_dotenv() + + +@tasks_bp.route("/", methods=["GET", "POST"]) +def handle_tasks(): + if request.method == "GET": + sort_query = request.args.get("sort") + if sort_query == "asc": + tasks = Task.query.order_by(Task.title) + elif sort_query == "desc": + tasks = Task.query.order_by(desc(Task.title)) + else: + tasks = Task.query.all() + + tasks_response = [] + for task in tasks: + if not task.completed_at: + is_complete = False + else: + is_complete = True + tasks_response.append({ + "id": task.task_id, + "title": task.title, + "description": task.description, + "is_complete": is_complete + }) + return make_response(jsonify(tasks_response), 200) + + elif request.method == "POST": + request_body = request.get_json() + keys = ['title', 'description', 'completed_at'] + for key in keys: + if key not in request_body: + task_response = {"details": "Invalid data"} + return make_response(task_response, 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() + if not request_body["completed_at"]: + is_complete = False + else: + is_complete = True + task_response = {"task": + {"id": new_task.task_id, + "title": new_task.title, + "description": new_task.description, + "is_complete": is_complete} + } + return make_response(task_response, 201) + + +@tasks_bp.route("/", methods=["GET", "PUT", "DELETE"]) +def handle_task(task_id): + task = Task.query.get(task_id) + if not task: + return make_response(f"Task #{task_id} Not Found", 404) + + if request.method == "GET": + if not task.completed_at: + is_complete = False + else: + is_complete = True + task_response = {"task": { + "id": task.task_id, + "title": task.title, + "description": task.description, + "is_complete": is_complete, + }} + if task.goal_id: + task_response["task"]["goal_id"] = task.goal_id + return make_response(task_response, 200) + elif request.method == "PUT": + form_data = request.get_json() + if ("completed_at" not in form_data or + form_data["completed_at"] == None): + is_complete = False + else: + is_complete = True + task.title = form_data["title"] + task.description = form_data["description"] + task.completed_at = form_data["completed_at"] + db.session.commit() + task_response = {"task": { + "id": task.task_id, + "title": task.title, + "description": task.description, + "is_complete": is_complete + }} + return make_response(task_response, 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) + + +@tasks_bp.route("//mark_complete", methods=["PATCH"]) +def handle_task_complete(task_id): + task = Task.query.get(task_id) + if not task: + return make_response(f"Task #{task_id} Not Found", 404) + + task.completed_at = datetime.datetime.utcnow() + db.session.commit() + channel = "channel=task-notifications" + text = f"text=Someone just completed the task {task.title}" + + path = f"https://slack.com/api/chat.postMessage?{channel}&{text}" + + SLACKBOT_AUTH = os.environ.get( + "SLACKBOT_AUTH") + + requests.post(path, headers={'Authorization': f'Bearer {SLACKBOT_AUTH}'}) + + task_response = {"task": { + "id": task.task_id, + "title": task.title, + "description": task.description, + "is_complete": True + }} + return make_response(task_response, 200) + + +@tasks_bp.route("//mark_incomplete", methods=["PATCH"]) +def handle_task_incomplete(task_id): + # get current data, set the thing + task = Task.query.get(task_id) + if not task: + return make_response(f"Task #{task_id} Not Found", 404) + + task.completed_at = None + db.session.commit() + + task_response = {"task": { + "id": task.task_id, + "title": task.title, + "description": task.description, + "is_complete": False + }} + return make_response(task_response, 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 make_response(jsonify(goals_response), 200) + + elif request.method == "POST": + request_body = request.get_json() + if 'title' not in request_body: + goal_response = {"details": "Invalid data"} + return make_response(goal_response, 400) + + new_goal = Goal(title=request_body["title"]) + + db.session.add(new_goal) + db.session.commit() + + goal_response = {"goal": + {"id": new_goal.goal_id, + "title": new_goal.title, + }} + return make_response(goal_response, 201) + + +@goals_bp.route("/", methods=["GET", "PUT", "DELETE"]) +def handle_goal(goal_id): + goal = Goal.query.get(goal_id) + if not goal: + return make_response(f"Goal #{goal_id} Not Found", 404) + + if request.method == "GET": + goal_response = {"goal": { + "id": goal.goal_id, + "title": goal.title + }} + return make_response(goal_response, 200) + + elif request.method == "PUT": + form_data = request.get_json() + if not 'title' in form_data: + goal_response = {"details": "Invalid data"} + return make_response(goal_response, 400) + + goal.title = form_data["title"] + db.session.commit() + + goal_response = {"goal": { + "id": goal.goal_id, + "title": goal.title + }} + return make_response(goal_response, 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) + + +@goals_bp.route("//tasks", methods=["POST", "GET"]) +def handle_goal_tasks(goal_id): + goal = Goal.query.get(goal_id) + if not goal: + return make_response(f"Goal #{goal_id} Not Found", 404) + + if request.method == "POST": + request_body = request.get_json() + task_ids = request_body["task_ids"] + for task_id in task_ids: + task = Task.query.get(task_id) + # if not task: + # return make_response(f"Task #{task_id} Not Found", 404) + task.goal_id = goal_id + + db.session.commit() + goal_response = { + "id": goal.goal_id, + "task_ids": task_ids + } + return make_response(jsonify(goal_response), 200) + + if request.method == "GET": + tasks = Task.query.filter_by(goal_id=goal.goal_id) + tasks_response = [] + + for task in tasks: + if not task.completed_at: + is_complete = False + else: + is_complete = True + tasks_response.append({ + "id": task.task_id, + "title": task.title, + "description": task.description, + "is_complete": is_complete, + "goal_id": task.goal_id, + }) + goal_response = { + "id": goal.goal_id, + "title": goal.title, + "tasks": tasks_response + } + return make_response(jsonify(goal_response), 200) diff --git a/app/templates/__init__.py b/app/templates/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/app/templates/index.html b/app/templates/index.html new file mode 100644 index 000000000..a36f085ea --- /dev/null +++ b/app/templates/index.html @@ -0,0 +1,148 @@ + + + + + + + + Another Task List API + + + +
+

Available Routes

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PATHMETHODREQUEST BODYDESCRIPTION
/tasksGETN/A + Get all tasks. Optional parameter 'sort=<asc or desc>' to sort + by task title. +
/tasksPOST'title', 'description', 'completed_at'Create a task. 'completed_at' can be null.
/tasks/<task_id>GETN/AGet details for a single task.
/tasks/<task_id>PUT'title', 'description', 'completed_at'Update details for a single task.
/tasks/<task_id>DELETEN/ADelete a single task.
/tasks/<task_id>/mark_completePATCHN/ASet 'completed_at' for the given task to the current time.
/tasks/<task_id>/mark_incompletePATCHN/ASet 'completed_at' for the given task to null.
/goalsGETN/AGet a list of all goals.
/goalsPOST"title"Create a goal.
/goals/<goal_id>GETN/AGet deails for a single goal.
/goals/<goal_id>PUT'title'Update details for a single goal.
/goals/<goal_id>DELETEN/ADelete a single goal.
/goals/<goal_id>/tasksGETN/AGet all the tasks for a single goal.
/goals/<goal_id>/tasksPOST'task_ids':['task_id']Set the goal_id to for each task in the request body.
+
+ + + 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/5555974d9b14_.py b/migrations/versions/5555974d9b14_.py new file mode 100644 index 000000000..838107ad1 --- /dev/null +++ b/migrations/versions/5555974d9b14_.py @@ -0,0 +1,30 @@ +"""empty message + +Revision ID: 5555974d9b14 +Revises: 81fdda2f4dfb +Create Date: 2021-06-09 21:59:10.210377 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '5555974d9b14' +down_revision = '81fdda2f4dfb' +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 ### diff --git a/migrations/versions/73665149d320_.py b/migrations/versions/73665149d320_.py new file mode 100644 index 000000000..183647d6e --- /dev/null +++ b/migrations/versions/73665149d320_.py @@ -0,0 +1,39 @@ +"""empty message + +Revision ID: 73665149d320 +Revises: +Create Date: 2021-06-07 13:36:25.519765 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '73665149d320' +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_on', 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/81fdda2f4dfb_.py b/migrations/versions/81fdda2f4dfb_.py new file mode 100644 index 000000000..ebed46383 --- /dev/null +++ b/migrations/versions/81fdda2f4dfb_.py @@ -0,0 +1,28 @@ +"""empty message + +Revision ID: 81fdda2f4dfb +Revises: c054d0ab4343 +Create Date: 2021-06-09 13:18:56.291164 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '81fdda2f4dfb' +down_revision = 'c054d0ab4343' +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 ### diff --git a/migrations/versions/c054d0ab4343_.py b/migrations/versions/c054d0ab4343_.py new file mode 100644 index 000000000..521eb820b --- /dev/null +++ b/migrations/versions/c054d0ab4343_.py @@ -0,0 +1,30 @@ +"""empty message + +Revision ID: c054d0ab4343 +Revises: 73665149d320 +Create Date: 2021-06-07 14:20:14.461794 + +""" +from alembic import op +import sqlalchemy as sa +from sqlalchemy.dialects import postgresql + +# revision identifiers, used by Alembic. +revision = 'c054d0ab4343' +down_revision = '73665149d320' +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.drop_column('task', 'completed_on') + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.add_column('task', sa.Column('completed_on', postgresql.TIMESTAMP(), autoincrement=False, nullable=True)) + op.drop_column('task', 'completed_at') + # ### end Alembic commands ###