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..1cb66cc5f 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -15,12 +15,10 @@ def create_app(test_config=None): app.config["SQLALCHEMY_TRACK_MODIFICATIONS"] = False if test_config is None: - app.config["SQLALCHEMY_DATABASE_URI"] = os.environ.get( - "SQLALCHEMY_DATABASE_URI") + app.config["SQLALCHEMY_DATABASE_URI"] = os.environ.get("SQLALCHEMY_DATABASE_URI") else: app.config["TESTING"] = True - app.config["SQLALCHEMY_DATABASE_URI"] = os.environ.get( - "SQLALCHEMY_TEST_DATABASE_URI") + app.config["SQLALCHEMY_DATABASE_URI"] = os.environ.get("SQLALCHEMY_TEST_DATABASE_URI") # Import models here for Alembic setup from app.models.task import Task @@ -30,5 +28,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/goal.py b/app/models/goal.py index 8cad278f8..8ff2bd3f0 100644 --- a/app/models/goal.py +++ b/app/models/goal.py @@ -1,6 +1,22 @@ from flask import current_app from app import db - 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) + tasks = db.relationship("Task", back_populates="goal", lazy=True) + + + def goal_dict(self): + return { + "id": self.goal_id, + "title": self.title + } + + + def goal_and_task_dict(self): + return{ + "id": self.goal_id, + "title": self.title, + "tasks": [task.task_and_goal_dict() for task in self.tasks] + } diff --git a/app/models/task.py b/app/models/task.py index 39c89cd16..a4e193d75 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -1,6 +1,29 @@ from flask import current_app from app import db - 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) + goal_id = db.Column(db.Integer, db.ForeignKey("goal.goal_id"), nullable=True) + goal = db.relationship("Goal", back_populates="tasks") + + + def task_dict(self): + return { + "id": self.task_id, + "title": self.title, + "description": self.description, + "is_complete": False if self.completed_at is None else True, + } + + + def task_and_goal_dict(self): + return { + "id":self.task_id, + "title": self.title, + "description": self.description, + "is_complete": False if self.completed_at is None else True, + "goal_id": self.goal_id + } diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..abd98b317 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,179 @@ -from flask import Blueprint +from io import DEFAULT_BUFFER_SIZE +from app import db +from flask import Blueprint, json, request, jsonify +from app.models.task import Task +from app.models.goal import Goal +from sqlalchemy import asc, desc +from datetime import datetime +import os, requests +from dotenv import load_dotenv +load_dotenv() + +tasks_bp = Blueprint("tasks_bp", __name__, url_prefix="/tasks") +goals_bp = Blueprint("goals_bp", __name__, url_prefix="/goals") + +@tasks_bp.route("", methods=["POST", "GET"]) +def handle_tasks(): + if 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 jsonify({"details": "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 jsonify({"task": new_task.task_dict()}), 201 + + elif request.method == "GET": + sort_query = request.args.get("sort") + if sort_query == "asc": + tasks = Task.query.order_by(asc("title")) + elif sort_query == "desc": + tasks = Task.query.order_by(desc("title")) + else: + tasks = Task.query.all() + + task_response = [task.task_dict() for task in tasks] + + return jsonify(task_response), 200 + + +@tasks_bp.route("/", methods={"GET", "PUT", "DELETE"}) +def handle_one_task(task_id): + task = Task.query.get(task_id) + if task is None: + return jsonify(task), 404 + + if request.method == "GET": + if task.goal_id: + return jsonify({"task": task.task_and_goal_dict()}) + return ({"task": task.task_dict()}), 200 + + elif request.method == "PUT": + request_body = request.get_json() + task.title=request_body["title"] + task.description=request_body["description"] + + db.session.commit() + return jsonify({"task": task.task_dict()}), 200 + + elif request.method == "DELETE": + db.session.delete(task) + db.session.commit() + response_body = f'Task {task.task_id} "{task.title}" successfully deleted' + return jsonify({"details": response_body}), 200 + + +@tasks_bp.route("/mark_complete", methods=["PATCH"]) +def mark_task_complete(task_id): + task= Task.query.get(task_id) + if task is None: + return jsonify(task), 404 + + current_time = datetime.now() + task.completed_at = current_time + + BOT_TOKEN = os.environ.get('BOT_TOKEN') + requests.post( + url="https://slack.com/api/chat.postMessage", + headers={"Authorization": f"Bearer {BOT_TOKEN}"}, + data={"channel": "task_notifications", "text": f"Someone just completed the task {task.title}"} + ) + + db.session.commit() + + return jsonify({"task": task.task_dict()}), 200 + + +@tasks_bp.route("/mark_incomplete", methods=["PATCH"]) +def mark_task_incomplete(task_id): + task = Task.query.get(task_id) + if task is None: + return jsonify(task), 404 + task.completed_at = None + + db.session.commit() + + return jsonify({"task": task.task_dict()}), 200 + + +@goals_bp.route("", methods=["GET", "POST"]) +def handle_goals(): + if request.method == "POST": + request_body = request.get_json() + if "title" not in request_body: + return jsonify({"details": "Invalid data"}), 400 + + new_goal = Goal(title = request_body["title"]) + + db.session.add(new_goal) + db.session.commit() + + return jsonify({"goal": new_goal.goal_dict()}), 201 + + elif request.method == "GET": + request_body = request.get_json() + goals = Goal.query.all() + goal_response = [goal.goal_dict() for goal in goals] + return jsonify(goal_response), 200 + + +@goals_bp.route("/", methods = ["GET", "PUT", "DELETE"]) +def handle_one_goal(goal_id): + goal = Goal.query.get(goal_id) + if goal is None: + return jsonify(goal), 404 + + request_body = request.get_json() + if request.method == "GET": + return jsonify({"goal": goal.goal_dict()}), 200 + + elif request.method == "PUT": + if "title" not in request_body: + return jsonify({"details": "Invalid data"}), 400 + + goal.title = request_body["title"] + db.session.commit() + return jsonify({"goal": goal.goal_dict()}), 200 + + elif request.method == "DELETE": + db.session.delete(goal) + db.session.commit() + return jsonify({'details': f'Goal {goal.goal_id} "{goal.title}" successfully deleted'}) + + +@goals_bp.route("//tasks", methods=["POST", "GET"]) +def handle_goal_and_task(goal_id): + goal = Goal.query.get(goal_id) + if goal is None: + return jsonify(goal), 404 + + if request.method == "GET": + return jsonify(goal.goal_and_task_dict()), 200 + + elif request.method=="POST": + request_body = request.get_json() + + for task_id in request_body["task_ids"]: + task = Task.query.get(task_id) + if task is None: + return jsonify(None), 404 + goal.tasks.append(task) + db.session.commit() + + task_ids = [] + for task in goal.tasks: + task_ids.append(task.task_id) + + return jsonify({"id": goal.goal_id, "task_ids": task_ids}), 200 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/106deb886b95_.py b/migrations/versions/106deb886b95_.py new file mode 100644 index 000000000..a0d9bca0a --- /dev/null +++ b/migrations/versions/106deb886b95_.py @@ -0,0 +1,39 @@ +"""empty message + +Revision ID: 106deb886b95 +Revises: +Create Date: 2021-11-03 17:48:10.369440 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '106deb886b95' +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('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 ### diff --git a/migrations/versions/93b62a26e1a2_updated_goals_and_tasks_one_to_many_.py b/migrations/versions/93b62a26e1a2_updated_goals_and_tasks_one_to_many_.py new file mode 100644 index 000000000..1c3458ab5 --- /dev/null +++ b/migrations/versions/93b62a26e1a2_updated_goals_and_tasks_one_to_many_.py @@ -0,0 +1,32 @@ +"""Updated Goals and Tasks, one to many relationship + +Revision ID: 93b62a26e1a2 +Revises: 106deb886b95 +Create Date: 2021-11-04 12:15:40.652621 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '93b62a26e1a2' +down_revision = '106deb886b95' +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)) + 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') + op.drop_column('goal', 'title') + # ### end Alembic commands ### diff --git a/tests/test_wave_05.py b/tests/test_wave_05.py index 6ba60c6fa..2af05b41f 100644 --- a/tests/test_wave_05.py +++ b/tests/test_wave_05.py @@ -1,4 +1,5 @@ import pytest +from app.models.goal import Goal def test_get_goals_no_saved_goals(client): # Act @@ -41,7 +42,7 @@ def test_get_goal(client, one_goal): } } -@pytest.mark.skip(reason="test to be completed by student") +# @pytest.mark.skip(reason="test to be completed by student") def test_get_goal_not_found(client): pass # Act @@ -49,10 +50,9 @@ def test_get_goal_not_found(client): response_body = response.get_json() # Assert - # ---- Complete Test ---- - # assertion 1 goes here - # assertion 2 goes here - # ---- Complete Test ---- + assert response.status_code == 404 + assert response_body == None + def test_create_goal(client): # Act @@ -71,30 +71,33 @@ def test_create_goal(client): } } -@pytest.mark.skip(reason="test to be completed by student") +# @pytest.mark.skip(reason="test to be completed by student") def test_update_goal(client, one_goal): - pass # Act - # ---- Complete Act Here ---- + response = client.put("/goals/1", json={ + "title": "Build a habit of going outside daily" + }) + response_body = response.get_json() # Assert - # ---- Complete Assertions Here ---- - # assertion 1 goes here - # assertion 2 goes here - # assertion 3 goes here - # ---- Complete Assertions Here ---- + assert response.status_code == 200 + assert "goal" in response_body + assert response_body == {"goal": { + "id": 1, + "title": "Build a habit of going outside daily" + }} -@pytest.mark.skip(reason="test to be completed by student") + +# @pytest.mark.skip(reason="test to be completed by student") def test_update_goal_not_found(client): - pass # Act - # ---- Complete Act Here ---- + response = client.put("/goals/1") + response_body = response.get_json() # Assert - # ---- Complete Assertions Here ---- - # assertion 1 goes here - # assertion 2 goes here - # ---- Complete Assertions Here ---- + assert response.status_code == 404 + assert response_body is None + def test_delete_goal(client, one_goal): @@ -113,18 +116,17 @@ def test_delete_goal(client, one_goal): response = client.get("/goals/1") assert response.status_code == 404 -@pytest.mark.skip(reason="test to be completed by student") +# @pytest.mark.skip(reason="test to be completed by student") def test_delete_goal_not_found(client): - pass - # Act - # ---- Complete Act Here ---- + response = client.delete("/goals/1") + response_body = response.get_json() # Assert - # ---- Complete Assertions Here ---- - # assertion 1 goes here - # assertion 2 goes here - # ---- Complete Assertions Here ---- + assert response.status_code == 404 + assert response_body == None + assert Goal.query.all() == [] + def test_create_goal_missing_title(client):