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..1af6d1edd 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -9,6 +9,8 @@ migrate = Migrate() load_dotenv() +SLACK_TOKEN = os.environ.get("SLACK_TOKEN") + def create_app(test_config=None): app = Flask(__name__) @@ -28,7 +30,15 @@ def create_app(test_config=None): db.init_app(app) migrate.init_app(app, db) + + from .routes.goal_routes import goal_bp + app.register_blueprint(goal_bp) - # Register Blueprints here + # Register Blueprints here + from .routes.task_routes import task_bp + app.register_blueprint(task_bp) + return app + + \ No newline at end of file diff --git a/app/models/goal.py b/app/models/goal.py index 8cad278f8..b4e8d7dfa 100644 --- a/app/models/goal.py +++ b/app/models/goal.py @@ -4,3 +4,12 @@ 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) + + def to_dict(self): + return { + "id": self.goal_id, + "title": self.title, + + } diff --git a/app/models/task.py b/app/models/task.py index 39c89cd16..759c46e4a 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -3,4 +3,26 @@ 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) + is_complete = db.Column(db.Boolean) + # completed_at can be empty/null which means that a task is not completed + goal_id = db.Column(db.Integer, db.ForeignKey('goal.goal_id'), nullable = True) + + def to_dict(self): + if not self.completed_at: + self.is_complete = False + else: + self.is_complete = True + dictionary = { + "id": self.task_id, + "title": self.title, + "description": self.description, + "is_complete": self.is_complete + } + if self.goal_id: + dictionary["goal_id"] = self.goal_id + + return dictionary \ 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..2bab19a8c --- /dev/null +++ b/app/routes/goal_routes.py @@ -0,0 +1,95 @@ +from app.models.goal import Goal +from flask import jsonify +from flask import Blueprint, make_response, request, jsonify, abort +from app import db +from app.models.task import Task + + +#helper functions +goal_bp = Blueprint("goal", __name__,url_prefix="/goals") +def valid_int(number, parameter_type): + try: + int(number) + except: + abort(make_response({"error": f"{parameter_type} must be an int"})), 400 + +def get_goal_from_id(goal_id): + valid_int(goal_id, "goal_id") + return Goal.query.get_or_404(goal_id, description="{goal not found}") +# get all goal + +@goal_bp.route("", methods=["GET", "POST"]) +def handle_goals(): + if request.method == "GET": + goals = Goal.query.all() + goals_response = [] + for goal in goals: + goal = goal.to_dict() + goals_response.append(goal) + return jsonify(goals_response), 200 + + #write query to fetch all goals + + + elif request.method == "POST": + request_body = request.get_json() + if not "title" 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.to_dict()}), 201 + + + +@goal_bp.route("/", methods=["GET", "PUT", "DELETE"]) +def handle_goal(goal_id): + goal_id = int(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": + request_body = request.get_json() + + goal.title = request_body["title"] + + db.session.commit() + return jsonify({"goal": goal.to_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'}), 200 + +###WAVE 6 routes### +@goal_bp.route("//tasks", methods=["POST"]) +def create_one_to_many(goal_id): + request_body = request.get_json() + goal = Goal.query.get(goal_id) + task_ids = request_body["task_ids"] + for task_id in task_ids: + task=Task.query.get(task_id) + goal.tasks.append(task) #list of task objects + + db.session.commit() + return jsonify({"id": goal.goal_id, + "task_ids":[task.task_id for task in goal.tasks]}), 200 + +@goal_bp.route("//tasks", methods=["GET"]) +def get_task_for_goal(goal_id): + # request_body = request.get_json() + goal = Goal.query.get(goal_id) + if goal is None: + return make_response("", 404) + + db.session.commit() + return jsonify({ + "id": goal.goal_id, + "title": goal.title, + "tasks": [task.to_dict() for task in goal.tasks] + }), 200 \ 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..e2b45ed44 --- /dev/null +++ b/app/routes/task_routes.py @@ -0,0 +1,121 @@ +from app.models.task import Task +from flask import jsonify +from flask import Blueprint, make_response, request, jsonify, abort +from app import db, SLACK_TOKEN +from datetime import datetime +import requests + + +#helper functions +task_bp = Blueprint("task", __name__,url_prefix="/tasks") +def valid_int(number, parameter_type): + try: + int(number) + except: + abort(make_response({"error": f"{parameter_type} must be an int"})), 400 + +def get_task_from_id(task_id): + valid_int(task_id, "task_id") + return Task.query.get_or_404(task_id, description="{task not found}") +# get all tasks + +@task_bp.route("", methods=["GET", "POST"]) +def handle_tasks(): + if request.method == "GET": + + #write query to fetch all tasks + sort_query = request.args.get("sort") ###WAVE 2### + + if sort_query == "asc": + tasks = Task.query.order_by(Task.title.asc()) + elif sort_query == "desc": + tasks = Task.query.order_by(Task.title.desc()) + else: + tasks = Task.query.all() + tasks_response = [task.to_dict() for task in tasks] + return jsonify(tasks_response), 200 + + elif request.method == "POST": + request_body = request.get_json() + if not "title" in request_body or not "description" in request_body or not "completed_at" 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.to_dict()}), 201 + + + +@task_bp.route("/", methods=["GET", "PUT", "DELETE"]) +def handle_task(task_id): + task_id = int(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": + request_body = request.get_json() + + task.title = request_body["title"] + task.description = request_body["description"] + + db.session.commit() + return jsonify({"task": task.to_dict()}), 200 + + elif request.method == "DELETE": + db.session.delete(task) + db.session.commit() + return jsonify({"details":f'Task {task.task_id} "{task.title}" successfully deleted'}), 200 + +##WAVE 4 Slack Helper Function### +def post_complete_task_to_slack(task): + url = "https://slack.com/api/chat.postMessage" + message = f"Someone just completed the task {task.title}" + query_params = { + "token": SLACK_TOKEN, + "channel": 'task-list-api', + "text" : message + } + return requests.post(url, data=query_params).json() + +##wave 3 complete/incomplete## +@task_bp.route("//mark_complete", methods=["PATCH"]) +def update_task_completion(task_id): + task= get_task_from_id(task_id) + task.is_complete=True + task.completed_at = datetime.now() + db.session.commit() + post_complete_task_to_slack(task) + return jsonify({"task": task.to_dict()}), 200 + + +@task_bp.route("//mark_incomplete", methods=["PATCH"]) +def update_task_incomplete(task_id): + task= get_task_from_id(task_id) + task.is_complete=False + task.completed_at = None + db.session.commit() + return jsonify({"task": task.to_dict()}), 200 + +# @task_bp.route("/", methods=["GET"]) +# def handle_task(task_id): +# task_id = int(task_id) +# task = Task.query.get(task_id) +# if not task: +# return make_response(f"Task {task_id} Bad data", 400) + + # if request.method == GET + + # for task in tasks: + # if task.id == task_id: + # return vars(task) + + # return "Not found", 404 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/13358a7981b5_.py b/migrations/versions/13358a7981b5_.py new file mode 100644 index 000000000..402f4ac7e --- /dev/null +++ b/migrations/versions/13358a7981b5_.py @@ -0,0 +1,39 @@ +"""empty message + +Revision ID: 13358a7981b5 +Revises: +Create Date: 2021-10-29 11:14:18.703049 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '13358a7981b5' +down_revision = None +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.create_table('goal', + sa.Column('goal_id', sa.Integer(), nullable=False), + sa.PrimaryKeyConstraint('goal_id') + ) + op.create_table('task', + sa.Column('task_id', sa.Integer(), nullable=False), + sa.Column('title', sa.String(), nullable=True), + sa.Column('description', sa.String(), nullable=True), + sa.Column('completed_at', sa.DateTime(), nullable=True), + sa.PrimaryKeyConstraint('task_id') + ) + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.drop_table('task') + op.drop_table('goal') + # ### end Alembic commands ### diff --git a/migrations/versions/390c60aee6a1_.py b/migrations/versions/390c60aee6a1_.py new file mode 100644 index 000000000..26d463204 --- /dev/null +++ b/migrations/versions/390c60aee6a1_.py @@ -0,0 +1,34 @@ +"""empty message + +Revision ID: 390c60aee6a1 +Revises: 5ec289939f0b +Create Date: 2021-11-04 10:41:41.983889 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '390c60aee6a1' +down_revision = '5ec289939f0b' +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.drop_constraint('task_one_goal_fkey', 'task', type_='foreignkey') + op.create_foreign_key(None, 'task', 'goal', ['goal_id'], ['goal_id']) + op.drop_column('task', 'one_goal') + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.add_column('task', sa.Column('one_goal', sa.INTEGER(), autoincrement=False, nullable=True)) + op.drop_constraint(None, 'task', type_='foreignkey') + op.create_foreign_key('task_one_goal_fkey', 'task', 'goal', ['one_goal'], ['goal_id']) + op.drop_column('task', 'goal_id') + # ### end Alembic commands ### diff --git a/migrations/versions/5ec289939f0b_.py b/migrations/versions/5ec289939f0b_.py new file mode 100644 index 000000000..cadc920a2 --- /dev/null +++ b/migrations/versions/5ec289939f0b_.py @@ -0,0 +1,30 @@ +"""empty message + +Revision ID: 5ec289939f0b +Revises: e50e5030ef79 +Create Date: 2021-11-04 10:15:34.180205 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '5ec289939f0b' +down_revision = 'e50e5030ef79' +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.add_column('task', sa.Column('one_goal', sa.Integer(), nullable=True)) + op.create_foreign_key(None, 'task', 'goal', ['one_goal'], ['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', 'one_goal') + # ### end Alembic commands ### diff --git a/migrations/versions/74c32d62b7c9_.py b/migrations/versions/74c32d62b7c9_.py new file mode 100644 index 000000000..b2189d14b --- /dev/null +++ b/migrations/versions/74c32d62b7c9_.py @@ -0,0 +1,28 @@ +"""empty message + +Revision ID: 74c32d62b7c9 +Revises: 13358a7981b5 +Create Date: 2021-11-03 15:01:52.276092 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '74c32d62b7c9' +down_revision = '13358a7981b5' +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.add_column('task', sa.Column('is_complete', sa.Boolean(), nullable=True)) + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.drop_column('task', 'is_complete') + # ### end Alembic commands ### diff --git a/migrations/versions/e50e5030ef79_.py b/migrations/versions/e50e5030ef79_.py new file mode 100644 index 000000000..607162a15 --- /dev/null +++ b/migrations/versions/e50e5030ef79_.py @@ -0,0 +1,28 @@ +"""empty message + +Revision ID: e50e5030ef79 +Revises: 74c32d62b7c9 +Create Date: 2021-11-03 17:35:48.062207 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'e50e5030ef79' +down_revision = '74c32d62b7c9' +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/tests/test_wave_05.py b/tests/test_wave_05.py index 6ba60c6fa..57b367e8b 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,18 +42,16 @@ 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 response = client.get("/goals/1") 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 +70,37 @@ 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": "Updated Goal Title"}) + 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": "Updated Goal Title" + } + } + goal = Goal.query.get(1) + assert goal.title == "Updated Goal Title" -@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("/goal/1", json={ + "title": "Updated Goal Title"}) + 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 + def test_delete_goal(client, one_goal): @@ -113,18 +119,16 @@ 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):