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..7879a7f47 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -28,7 +28,8 @@ def create_app(test_config=None): db.init_app(app) migrate.init_app(app, db) - + from .routes import tasks_bp, goals_bp # Register Blueprints here - + app.register_blueprint(tasks_bp) + app.register_blueprint(goals_bp) return app diff --git a/app/models/goal.py b/app/models/goal.py index 8cad278f8..d8249d126 100644 --- a/app/models/goal.py +++ b/app/models/goal.py @@ -1,6 +1,9 @@ from flask import current_app +from sqlalchemy.orm import backref 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", backref = "goal") \ No newline at end of file diff --git a/app/models/task.py b/app/models/task.py index 39c89cd16..5fcea086a 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -3,4 +3,9 @@ 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 ="task") diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..b2779a08b 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,270 @@ -from flask import Blueprint +from flask import Blueprint, jsonify, request, make_response, abort +from app.models.task import Task +from app.models.goal import Goal +from app import db +from sqlalchemy import desc +from datetime import date, time, datetime +import requests +import os + +# assign tasks_bp to the new Blueprint instance +tasks_bp = Blueprint("tasks", __name__, url_prefix="/tasks") +# assign goals_bp to the new Blueprint instance +goals_bp = Blueprint("goals", __name__, url_prefix="/goals") +# assign slack path for slack integration +slack_path = "https://slack.com/api/chat.postMessage" + + + +@tasks_bp.route("", methods=["POST"]) +def post_one_task(): +# request_body will be the user's input, converted to json. it will be a new record +# for the db, with all fields (a dict) + 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 make_response({"details": "Invalid data"}, 400) + else: +# taking infor fr request_body and converting it to new Task object + new_task = Task(title=request_body["title"], + description=request_body["description"], + completed_at=request_body["completed_at"]) +# committing changes to db + db.session.add(new_task) + db.session.commit() + # using is_completed to hold Boolean value of datetime which is the data type + # for new_task.completed_at, essentially converting from Null to False + is_complete = new_task.completed_at is not None + return make_response({"task": {"id": new_task.task_id, + "title": new_task.title, + "description": new_task.description, + "is_complete": is_complete}}, 201) + +@tasks_bp.route("", methods=["GET"]) +def working_with_all_tasks(): + title_query = request.args.get('title') #query params for wave2 + order_by_query = request.args.get('sort') + if title_query: + # filter_by returns a list of objects/ records that match the query params + + tasks = Task.query.filter_by(title = title_query) + # what part of the Task.query is actually accessing the DB? + elif order_by_query == 'asc': + # getting all tasks fr the db + tasks = Task.query.order_by(Task.title).all() + # query_all return list of objects. loop through objects and add to empt list, task_response + # as requested formatted JSON objects + elif order_by_query == 'desc': + tasks = Task.query.order_by(desc(Task.title)).all() + # this else covers any search for all tasks, without any query params + else: + tasks = Task.query.order_by(Task.title).all() + + task_response = [] + # looping through each task, converting to requested format (dict) and adding to + # task_response which will be list of dicts + for task in tasks: + is_complete = task.completed_at is not None + task_response.append({ + 'id': task.task_id, + 'title': task.title, + 'description': task.description, + 'is_complete': is_complete}) + + return jsonify(task_response), 200 + +@tasks_bp.route("/", methods=["GET", "PUT", "DELETE", "PATCH"]) +def CRUD_one_task(task_id): + task = Task.query.get(task_id) #either get Task back or None + if task is None: +# couldn't figure out another way to return no response body, researched abort + abort(404) +# returning the object's info in the desired data structure format + is_complete = task.completed_at is not None + if request.method == "GET": + if task.goal_id: + return make_response({"task": {"id": task.task_id, + "title": task.title, + "description": task.description, + "goal_id": task.goal_id, + "is_complete": is_complete}}, 200) + else: + return make_response({"task": {"id": task.task_id, + "title": task.title, + "description": task.description, + "is_complete": is_complete}}, 200) + elif request.method == "PUT": + # form data is a local variable to hold the body of the HTTP request + form_data = request.get_json() + # reassigning attributes of the task object using the dict values that came over + # in the request body + task.title = form_data["title"] + task.description = form_data["description"] + task.completed_at = task.completed_at + + db.session.commit() + + return make_response({"task": {"id": task.task_id, + "title": task.title, + "description": task.description, + "is_complete": is_complete}}, 200) + # patch will change just one part of the record, not the whole record + elif request.method == "PATCH": + form_data = request.get_json() + if "title" in form_data: + task.title = form_data["title"] + if "description" in form_data: + task.description = form_data["description"] + + db.session.commit() + return make_response({"task": {"id": task.task_id, + "title": task.title, + "description": task.description, + "is_complete": is_complete}}, 200) + elif request.method == "DELETE": + db.session.delete(task) + db.session.commit() + return make_response({'details': + f'Task {task.task_id} "{task.title}" successfully deleted'}, 200) + +@tasks_bp.route("//mark_complete", methods=["PATCH"]) +def mark_task_complete(task_id): +# setting current datetime to time_stamp to use to mark task.completed_at + time_stamp = datetime.now() + task = Task.query.get(task_id) #either get Task back or None + if task is None: + abort(404) + else: + task.completed_at = time_stamp +# now db record shows timestamp for completed_at + db.session.commit() + is_complete = task.completed_at is not None + + try: + query_params = {"channel": "slack-api-test-channel", + "text": f"Someone just completed the task {task.title}"} + header_param = {"Authorization": "Bearer "+ os.environ.get("slack_oauth_token")} + slack_post_body = requests.post(slack_path, params=query_params, headers= header_param) + except TypeError: + pass +# response body doesn't want to show timestamp, just True, so changing is_complete to True + return make_response({"task": {"id": task.task_id, + "title": task.title, + "description": task.description, + "is_complete": is_complete}}, 200) + +@tasks_bp.route("//mark_incomplete", methods=["PATCH"]) +def mark_task_incomplete(task_id): + task = Task.query.get(task_id) #either get Task back or None + if task is None: + abort(404) + else: + task.completed_at = None + db.session.commit() + is_complete = task.completed_at is not None + return make_response({"task": {"id": task.task_id, + "title": task.title, + "description": task.description, + "is_complete": is_complete}}, 200) +# Here we are beginning the code for the Goal Model/ Table +@goals_bp.route("", methods=["POST"]) +def post_one_goal(): + request_body = request.get_json() + if 'title' not in request_body : + return make_response({"details": "Invalid data"}, 400) + else: + new_goal = Goal(title=request_body["title"]) + + db.session.add(new_goal) + db.session.commit() + return make_response({"goal": {"id": new_goal.goal_id, + "title": new_goal.title}}, 201) + +@goals_bp.route("", methods=["GET"]) +def working_with_all_goals(): + title_query = request.args.get('title') #query params + order_by_query = request.args.get('sort') + if title_query: + # filter_by returns a list of objects/ records that match the query params + + goals = Goal.query.filter_by(title = title_query) + # what part of the Goal.query is actually accessing the DB? + elif order_by_query == 'asc': + goals = Goal.query.order_by(Goal.title).all() + # query_all return list of objects. loop through objects and add to empt list, task_response + # as requested formatted JSON objects + elif order_by_query == 'desc': + # chaining methods of Goal together + goals = Goal.query.order_by(desc(Goal.title)).all() + # this else covers any search for all goals, without any query params + else: + goals = Goal.query.order_by(Goal.title).all() + + goal_response = [] + for goal in goals: + goal_response.append({ + 'id': goal.goal_id, + 'title': goal.title}) + return jsonify(goal_response), 200 + +@goals_bp.route("/", methods=["GET", "PUT", "DELETE"]) +def CRUD_one_goal(goal_id): + goal = Goal.query.get(goal_id) #either get Goal back or None +# this guard clause checks if the goal_id exists, if not, it will give 404 + if goal is None: +# couldn't figure out another way to return no response body, researched abort + abort(404) +# returning the object's info in the desired data structure format + if request.method == "GET": + return make_response({"goal": {"id": goal.goal_id, + "title": goal.title}}, 200) + elif request.method == "PUT": + # form data is a local variable to hold the body of the HTTP request + form_data = request.get_json() + # reassigning attributes of the goal object using the dict values that came over + # in the request body + goal.title = form_data["title"] + db.session.commit() + + return make_response({"goal": {"id": goal.goal_id, + "title": goal.title}}, 200) + elif request.method == "DELETE": + db.session.delete(goal) + db.session.commit() + return make_response({'details': + f'Goal {goal.goal_id} "{goal.title}" successfully deleted'}, 200) +# given one goal id, find 3 task ids and associate them with the goal by changing +# their goal_id column(Foreign Key) from nullable to the goal_id of the goal to be associated +@goals_bp.route("//tasks", methods=["POST", "GET"]) +def associate_tasks_with_goal(goal_id): + request_body = request.get_json() + tasks = Task.query.all() + goal = Goal.query.get(goal_id) #either get Goal back or None +# this guard clause checks if the goal_id exists, if not, it will give 404 + if goal is None: + abort(404) + if request.method == "POST": +# checking all tasks, if that task_id is in the list which came from Request_body, reassign value +# of task.goal_id (need to convert to int bc goal_id is user input and is a string) + for task in tasks: + if task.task_id in request_body["task_ids"]: + task.goal_id = int(goal_id) + db.session.commit() + return make_response({"id": int(goal_id), "task_ids": request_body["task_ids"]}, 200) + elif request.method == "GET": + # getting all tasks (attribute of Goal object) associated with given goal_id + goals_tasks = Goal.query.get(goal_id).tasks + + task_response = [] + for task in goals_tasks: + is_complete = task.completed_at is not None + task_response.append({ + 'id': task.task_id, + 'goal_id': task.goal_id, + 'title': task.title, + 'description': task.description, + 'is_complete': is_complete}) + + return make_response({"id": goal.goal_id, "title": goal.title, "tasks": task_response}, 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/161ad4e57543_.py b/migrations/versions/161ad4e57543_.py new file mode 100644 index 000000000..3deb7d876 --- /dev/null +++ b/migrations/versions/161ad4e57543_.py @@ -0,0 +1,28 @@ +"""empty message + +Revision ID: 161ad4e57543 +Revises: 81574f664e68 +Create Date: 2021-11-01 14:23:41.998654 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '161ad4e57543' +down_revision = '81574f664e68' +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/81574f664e68_.py b/migrations/versions/81574f664e68_.py new file mode 100644 index 000000000..7eea6097a --- /dev/null +++ b/migrations/versions/81574f664e68_.py @@ -0,0 +1,39 @@ +"""empty message + +Revision ID: 81574f664e68 +Revises: +Create Date: 2021-10-27 18:32:46.030621 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '81574f664e68' +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/9b0fe8c7cadc_.py b/migrations/versions/9b0fe8c7cadc_.py new file mode 100644 index 000000000..a50976621 --- /dev/null +++ b/migrations/versions/9b0fe8c7cadc_.py @@ -0,0 +1,30 @@ +"""empty message + +Revision ID: 9b0fe8c7cadc +Revises: 161ad4e57543 +Create Date: 2021-11-03 15:49:13.820131 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '9b0fe8c7cadc' +down_revision = '161ad4e57543' +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/tests/test_wave_05.py b/tests/test_wave_05.py index 6ba60c6fa..46d5917c4 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,19 +42,16 @@ def test_get_goal(client, one_goal): } } -@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 response = client.post("/goals", json={ @@ -71,30 +69,38 @@ def test_create_goal(client): } } -@pytest.mark.skip(reason="test to be completed by student") -def test_update_goal(client, one_goal): - pass - # Act - # ---- Complete Act Here ---- - # Assert - # ---- Complete Assertions Here ---- - # assertion 1 goes here - # assertion 2 goes here - # assertion 3 goes here - # ---- Complete Assertions Here ---- +def test_update_goal(client, one_goal): + + response = client.put("/goals/1", json={ + "title": "Updated Goal Title", + + }) + response_body = response.get_json() + +# Assert + 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") def test_update_goal_not_found(client): - 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 - # ---- 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") -def test_delete_goal_not_found(client): - pass +def test_delete_goal_not_found(client): # 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):