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..6e54a8581 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -9,9 +9,9 @@ migrate = Migrate() load_dotenv() - 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 +30,9 @@ def create_app(test_config=None): migrate.init_app(app, db) # Register Blueprints here - + import app.routes.task_routes as task_routes + import app.routes.goal_routes as goal_routes + app.register_blueprint(task_routes.bp) + app.register_blueprint(goal_routes.bp) + return app diff --git a/app/models/goal.py b/app/models/goal.py index 8cad278f8..24c9562f3 100644 --- a/app/models/goal.py +++ b/app/models/goal.py @@ -3,4 +3,12 @@ class Goal(db.Model): - goal_id = db.Column(db.Integer, primary_key=True) + id = db.Column(db.Integer, primary_key=True) + title = db.Column(db.String) + tasks = db.relationship('Task', backref='goal', lazy=True) + + def to_json(self): + return { + "id": self.id, + "title": self.title + } diff --git a/app/models/task.py b/app/models/task.py index 39c89cd16..46ed613a1 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -3,4 +3,22 @@ class Task(db.Model): - task_id = db.Column(db.Integer, primary_key=True) + id = db.Column(db.Integer, primary_key=True) + title = db.Column(db.String) + description = db.Column(db.String) + completed_at = db.Column(db.DateTime, nullable=True) + goal_id = db.Column(db.Integer, db.ForeignKey('goal.id'), nullable=True) + + def is_complete(self): + return True if self.completed_at else False + + def to_json(self): + response = { + "id": self.id, + "title": self.title, + "description": self.description, + "is_complete": self.is_complete() + } + if self.goal_id: + response["goal_id"] = self.goal_id + return response \ No newline at end of file diff --git a/app/routes.py b/app/routes.py deleted file mode 100644 index 8e9dfe684..000000000 --- a/app/routes.py +++ /dev/null @@ -1,2 +0,0 @@ -from flask import Blueprint - diff --git a/app/routes/__init__.py b/app/routes/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/app/routes/goal_routes.py b/app/routes/goal_routes.py new file mode 100644 index 000000000..ad3da3072 --- /dev/null +++ b/app/routes/goal_routes.py @@ -0,0 +1,91 @@ +from app import db +from app.models.goal import Goal +from app.models.task import Task +from .route_helpers import validate_item +from flask import Blueprint, request, make_response, jsonify + +bp = Blueprint("goals", __name__, url_prefix="/goals") + +@bp.route("", methods=["GET"]) +def get_goals(): + goals = Goal.query.all() + return jsonify([goal.to_json() for goal in goals]) + +@bp.route("", methods=["POST"]) +def create_goal(): + request_body = request.get_json() + if "title" not in request_body: + return make_response({"details": "Invalid data"}, 400) + new_goal = Goal(title=request_body["title"]) + + db.session.add(new_goal) + db.session.commit() + + return make_response({"goal": new_goal.to_json()}, 201) + +@bp.route("/", methods=["GET"]) +def get_goal(goal_id): + goal_response = validate_item("goal", goal_id) + if type(goal_response) != Goal: + return goal_response + return {"goal": goal_response.to_json()} + +@bp.route("/", methods=["PUT"]) +def update_goal(goal_id): + goal_response = validate_item("goal", goal_id) + if type(goal_response) != Goal: + return goal_response + + form_data = request.get_json() + goal_response.title = form_data["title"], + db.session.commit() + return {"goal": goal_response.to_json()} + + +@bp.route("/", methods=["DELETE"]) +def delete_goal(goal_id): + goal_response = validate_item("goal", goal_id) + if type(goal_response) != Goal: + return goal_response + + db.session.delete(goal_response) + db.session.commit() + return make_response( + {"details": + f"Goal {goal_response.id} \"{goal_response.title}\" successfully deleted" + } + ) + +@bp.route("//tasks", methods=["GET"]) +def get_goal_tasks(goal_id): + goal_response = validate_item("goal", goal_id) + if type(goal_response) != Goal: + return goal_response + + tasks = goal_response.tasks + tasks_details = [task.to_json() for task in tasks] + return make_response( + { + "id": goal_response.id, + "title": goal_response.title, + "tasks": tasks_details + }) + +@bp.route("//tasks", methods=["POST"]) +def add_goal_tasks(goal_id): + goal_response = validate_item("goal", goal_id) + if type(goal_response) != Goal: + return goal_response + + request_body = request.get_json() + for id in request_body["task_ids"]: + task = Task.query.get(id) + goal_response.tasks.append(task) + + db.session.add(goal_response) + db.session.commit() + + return make_response( + {"id": goal_response.id, + "task_ids": request_body["task_ids"] + }) diff --git a/app/routes/route_helpers.py b/app/routes/route_helpers.py new file mode 100644 index 000000000..0bd47bf8a --- /dev/null +++ b/app/routes/route_helpers.py @@ -0,0 +1,36 @@ +from app.models.task import Task +from app.models.goal import Goal +from flask import make_response +from dateutil.parser import parse, ParserError +import os +import requests + +def validate_item(type, id): + if not id.isdigit(): + return make_response(f"{id} is not a valid {type}_id. {type.title()} ID must be an integer.", 400) + + if type == "task": + # item = Task.query.get_or_404(id) # This will give the standard 404 page instead of custom message + item = Task.query.get(id) + elif type == "goal": + item = Goal.query.get(id) + + if not item: + return make_response(f"{type.title()} {id} not found", 404) + return item + +def validate_datetime(date_text): + try: + return parse(date_text) + except ParserError: + return make_response(f"Invalid date format in \"completed_at\". Please resubmit with a valid date_time.", 400) + +def post_to_slack(text): + slack_token = os.environ.get("SLACK_POST_MESSAGE_API_TOKEN") + slack_path = "https://slack.com/api/chat.postMessage" + query_params ={ + "channel": "task-notifications", + "text": text, + } + headers = {"Authorization": f"Bearer {slack_token}"} + requests.post(slack_path, params = query_params, headers = headers) \ No newline at end of file diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py new file mode 100644 index 000000000..034dfaf16 --- /dev/null +++ b/app/routes/task_routes.py @@ -0,0 +1,116 @@ +from app import db +from app.models.task import Task +from .route_helpers import * +from flask import Blueprint, request, make_response, jsonify +import datetime + +bp = Blueprint("tasks", __name__, url_prefix="/tasks") + +@bp.route("", methods=["GET"]) +def get_tasks(): + sort_query = request.args.get("sort") + search_title_query = request.args.get("search_title") + if sort_query: + if sort_query == "asc": + tasks = Task.query.order_by(Task.title).all() + elif sort_query == "desc": + tasks = Task.query.order_by(Task.title.desc()).all() + else: + return make_response(f"{sort_query} is not a valid sort parameter. Please use sort=asc or sort=desc.", 400) + elif search_title_query: + tasks = Task.query.filter_by(title=search_title_query).all() + else: + tasks = Task.query.all() + + return jsonify([task.to_json() for task in tasks]) + +@bp.route("", methods=["POST"]) +def create_task(): + request_body = request.get_json() + for attribute in {"title", "description", "completed_at"}: + if attribute not in request_body: + return make_response({"details": "Invalid data"}, 400) + + if request_body["completed_at"]: + date_time_response = validate_datetime(request_body["completed_at"]) + if type(date_time_response) != datetime.datetime: + return date_time_response + + new_task = Task(title=request_body["title"], + description=request_body["description"]) + + new_task.completed_at = date_time_response.strftime("%m/%d/%Y, %H:%M:%S") if request_body["completed_at"] else None + + db.session.add(new_task) + db.session.commit() + + return make_response({"task": new_task.to_json()}, 201) + +@bp.route("/", methods=["GET"]) +def get_task(task_id): + task_response = validate_item("task", task_id) + if type(task_response) != Task: + return task_response + + return {"task": task_response.to_json()} + +@bp.route("/", methods=["PUT"]) +def update_task(task_id): + task_response = validate_item("task", task_id) + if type(task_response) != Task: + return task_response + + form_data = request.get_json() + for attribute in {"title", "description"}: + if attribute not in form_data: + return make_response({"details": "Invalid data"}, 400) + + if form_data["completed_at"]: + date_time_response = validate_datetime(form_data["completed_at"]) + if type(date_time_response) != datetime.datetime: + return date_time_response + + task_response.title = form_data["title"], + task_response.description = form_data["description"] + task_response.completed_at = date_time_response.strftime("%m/%d/%Y, %H:%M:%S") if form_data["completed_at"] else None + + db.session.commit() + + return {"task": task_response.to_json()} + +@bp.route("/", methods=["DELETE"]) +def delete_task(task_id): + task_response = validate_item("task", task_id) + if type(task_response) != Task: + return task_response + + db.session.delete(task_response) + db.session.commit() + return make_response( + {"details": + f"Task {task_response.id} \"{task_response.title}\" successfully deleted" + } + ) + +@bp.route("//mark_complete", methods=["PATCH"]) +def mark_complete(task_id): + task_response = validate_item("task", task_id) + if type(task_response) != Task: + return task_response + + task_response.completed_at = datetime.datetime.utcnow() + db.session.commit() + + slack_text = f"Someone just completed the task {task_response.title}" + post_to_slack(slack_text) + return {"task": task_response.to_json()} + +@bp.route("//mark_incomplete", methods=["PATCH"]) +def mark_incomplete(task_id): + task_response = validate_item("task", task_id) + if type(task_response) != Task: + return task_response + + task_response.completed_at = None + db.session.commit() + return {"task": task_response.to_json()} \ 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/62528327195e_.py b/migrations/versions/62528327195e_.py new file mode 100644 index 000000000..50fda0140 --- /dev/null +++ b/migrations/versions/62528327195e_.py @@ -0,0 +1,42 @@ +"""empty message + +Revision ID: 62528327195e +Revises: +Create Date: 2021-06-11 18:26:14.195756 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '62528327195e' +down_revision = None +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.create_table('goal', + sa.Column('id', sa.Integer(), nullable=False), + sa.Column('title', sa.String(), nullable=True), + sa.PrimaryKeyConstraint('id') + ) + op.create_table('task', + sa.Column('id', sa.Integer(), nullable=False), + sa.Column('title', sa.String(), nullable=True), + sa.Column('description', sa.String(), nullable=True), + sa.Column('completed_at', sa.DateTime(), nullable=True), + sa.Column('goal_id', sa.Integer(), nullable=True), + sa.ForeignKeyConstraint(['goal_id'], ['goal.id'], ), + sa.PrimaryKeyConstraint('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/tests/conftest.py b/tests/conftest.py index d11083bf3..197c47255 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -86,3 +86,17 @@ def one_task_belongs_to_one_goal(app, one_goal, one_task): goal = Goal.query.first() goal.tasks.append(task) db.session.commit() + +# This fixture gets called in every test that +# references "duplicate_title_tasks" +# This fixture creates 2 tasks with +# the same title +@pytest.fixture +def duplicate_title_tasks(app): + new_task1 = Task( + title="Super Fun Title", description="Do something fun every day", completed_at=None) + new_task2 = Task( + title="Super Fun Title", description="Do something else fun every day", completed_at=None) + db.session.add(new_task1) + db.session.add(new_task2) + db.session.commit() diff --git a/tests/test_optional_enhancements.py b/tests/test_optional_enhancements.py new file mode 100644 index 000000000..b09231a5a --- /dev/null +++ b/tests/test_optional_enhancements.py @@ -0,0 +1,167 @@ +from app.models.task import Task +import datetime + +def test_create_task_with_valid_datetime_string(client): + # Act + response = client.post("/tasks", json={ + "title": "A Brand New Task", + "description": "Test Description", + "completed_at": "June 24, 2021 11:00:00" + }) + response_body = response.get_json() + + # Assert + assert response.status_code == 201 + assert response_body == { + "task": { + "description": "Test Description", + "id": 1, + "is_complete": True, + "title": "A Brand New Task" + } + } + task = Task.query.get(1) + assert task.title == "A Brand New Task" + assert task.description == "Test Description" + assert task.completed_at == datetime.datetime(2021, 6, 24, 11, 0) + + +def test_create_task_with_invalid_datetime_string(client): + # Act + response = client.post("/tasks", json={ + "title": "A Brand New Task", + "description": "Test Description", + "completed_at": "Just finished" + }) + response_text = response.get_data(as_text=True) + + # Assert + assert response.status_code == 400 + assert response_text == f"Invalid date format in \"completed_at\". Please resubmit with a valid date_time." + assert Task.query.all() == [] + +def test_update_task_with_valid_datetime_string(client, one_task): + # Act + response = client.put("/tasks/1", json={ + "title": "Updated Task Title", + "description": "Updated Test Description", + "completed_at": "June 28, 2020" + }) + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert "task" in response_body + assert response_body == { + "task": { + "id": 1, + "title": "Updated Task Title", + "description": "Updated Test Description", + "is_complete": True + } + } + task = Task.query.get(1) + assert task.title == "Updated Task Title" + assert task.description == "Updated Test Description" + assert task.completed_at == datetime.datetime(2020, 6, 28, 0, 0) + + +def test_update_task_with_invalid_datetime_string(client, one_task): + # Act + response = client.put("/tasks/1", json={ + "title": "A Brand New Task", + "description": "Test Description", + "completed_at": "Just finished" + }) + response_text = response.get_data(as_text=True) + + # Assert + assert response.status_code == 400 + assert response_text == f"Invalid date format in \"completed_at\". Please resubmit with a valid date_time." + assert Task.query.first().title == "Go on my daily walk 🏞" + assert Task.query.first().description == "Notice something new every day" + assert Task.query.first().completed_at == None + +def test_get_tasks_invalid_sort_param(client, three_tasks): + # Act + response = client.get("/tasks?sort=ASC") + response_text = response.get_data(as_text=True) + + # Assert + assert response.status_code == 400 + assert response_text == "ASC is not a valid sort parameter. Please use sort=asc or sort=desc." + +def test_task_to_json_no_goal(one_task): + # Arrange + task = Task.query.first() + + # Act + task_json = task.to_json() + + # Assert + assert task_json["id"] == task.id + assert task_json["title"] == task.title + assert task_json["description"] == task.description + assert task_json["is_complete"] == task.is_complete() + assert task_json.get("goal_id") == None + +def test_task_to_json_with_goal(one_task_belongs_to_one_goal): + # Arrange + task = Task.query.first() + + # Act + task_json = task.to_json() + + # Assert + assert task_json["id"] == task.id + assert task_json["title"] == task.title + assert task_json["description"] == task.description + assert task_json["is_complete"] == task.is_complete() + assert task_json.get("goal_id") == task.goal_id + +def test_get_tasks_search_by_title_that_exists(client, three_tasks): + # Act + response = client.get("/tasks?search_title=Answer forgotten email 📧") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert len(response_body) == 1 + assert response_body == [ + { + "id": 2, + "title": "Answer forgotten email 📧", + "description": "", + "is_complete": False} + ] + +def test_get_tasks_search_by_title_that_does_not_exists(client): + # Act + response = client.get("/tasks?search_title=non-existent title") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert len(response_body) == 0 + assert response_body == [] + +def test_get_tasks_search_by_title_that_has_multiple(client, duplicate_title_tasks): + # Act + response = client.get("/tasks?search_title=Super Fun Title") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert len(response_body) == 2 + assert response_body == [ + { + "id": 1, + "title": "Super Fun Title", + "description": "Do something fun every day", + "is_complete": False}, + { + "id": 2, + "title": "Super Fun Title", + "description": "Do something else fun every day", + "is_complete": False} + ] \ No newline at end of file