diff --git a/app/__init__.py b/app/__init__.py index 2764c4cc8..2a22025c8 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -30,5 +30,9 @@ def create_app(test_config=None): migrate.init_app(app, db) # Register Blueprints here + from app.routes.task_routes import tasks_bp + app.register_blueprint(tasks_bp) + from app.routes.goal_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..d05bee925 100644 --- a/app/models/goal.py +++ b/app/models/goal.py @@ -3,4 +3,28 @@ 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, nullable=False) + # relationship + tasks = db.relationship("Task", backref="goal", lazy=True) + + def to_dict(self): + return { + "id": self.goal_id, + "title": self.title + } + + def add_tasks_to_goal_dict(self): + tasks_list = [task.task_id for task in self.tasks] + return { + "id": self.goal_id, + "task_ids": tasks_list + } + + def get_tasks_from_goal_dict(self): + tasks = [task.to_dict_for_goal() for task in self.tasks] + return { + "id": self.goal_id, + "title": self.title, + "tasks": tasks + } \ No newline at end of file diff --git a/app/models/task.py b/app/models/task.py index 39c89cd16..fa04af198 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -1,6 +1,38 @@ from flask import current_app from app import db +import datetime 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, nullable=False) + description = db.Column(db.String, nullable=False) + # is_complete = db.Column(db.Boolean) + completed_at = db.Column(db.DateTime(timezone=True), nullable=True) + # relationship + goal_id = db.Column(db.Integer, db.ForeignKey('goal.goal_id'), nullable=True) + + def to_dict(self): + return { + "id": self.task_id, + "title": self.title, + "description": self.description, + # "is_complete": True if self.completed_at == True else False + "is_complete": bool(self.completed_at) + } + + def to_dict_for_goal(self): + return { + "id": self.task_id, + "goal_id": self.goal_id, + "title": self.title, + "description": self.description, + "is_complete": bool(self.completed_at) + } + + def is_related_to_goal(self): + if self.goal_id: + related_to_goal = True + else: + related_to_goal = False + return related_to_goal 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/goal_routes.py b/app/routes/goal_routes.py new file mode 100644 index 000000000..e0d507fb5 --- /dev/null +++ b/app/routes/goal_routes.py @@ -0,0 +1,105 @@ +from flask import Blueprint, request, make_response, jsonify, abort +from flask.wrappers import Response +from app.models.goal import Goal +from app.models.task import Task +from app import db +from datetime import date, datetime + +goals_bp = Blueprint('goals', __name__, url_prefix='/goals') + +# # Helper functions +def valid_int(id): + try: + number = int(id) + return number + except: + response_body = 'Invalid Data' + abort(make_response(response_body,400)) + +def get_goal_from_id(goal_id): + id = valid_int(goal_id) + selected_goal = Goal.query.filter_by(goal_id=goal_id).one_or_none() + # Goal not found + if selected_goal is None: + abort(make_response("Not Found", 404)) + return selected_goal + +def valid_goal(request_body): + if "title" not in request_body: + abort(make_response({"details": "Invalid data"}, 400)) +# # + +# Create a goal +@goals_bp.route("", methods=["POST"], strict_slashes=False) +def create_goal(): + request_body = request.get_json() + valid_goal(request_body) + new_goal = Goal(title=request_body["title"]) + db.session.add(new_goal) + db.session.commit() + response = {"goal": new_goal.to_dict()} + return make_response(response, 201) + +# Get all goals +@goals_bp.route("", methods=["GET"], strict_slashes=False) +def get_all_goals(): + response_list = [] + goal_objects = Goal.query.all() + for goal in goal_objects: + response_list.append(goal.to_dict()) + return make_response(jsonify(response_list), 200) + +# Get one goal +@goals_bp.route("/", methods=["GET"], strict_slashes=False) +def get_goal(goal_id): + selected_goal = get_goal_from_id(goal_id) + response_body = {"goal": selected_goal.to_dict()} + return make_response(response_body, 200) + +# Update goal +@goals_bp.route("/", methods=["PUT"], strict_slashes=False) +def update_goal(goal_id): + selected_goal = get_goal_from_id(goal_id) + request_body = request.get_json() + if "title" in request_body: + selected_goal.title = request_body["title"] + db.session.commit() + response_body = {"goal": selected_goal.to_dict()} + return make_response(response_body, 200) + +# Delete goal +@goals_bp.route("/", methods=["DELETE"], strict_slashes=False) +def delete_goal(goal_id): + selected_goal = get_goal_from_id(goal_id) + db.session.delete(selected_goal) + db.session.commit() + response_body = {'details': f'Goal {goal_id} "{selected_goal.title}" successfully deleted'} + return make_response(response_body, 200) + +# Post list of task_ids to a goal +@goals_bp.route("//tasks", methods=["POST"], strict_slashes=False) +def post_tasks_to_goal(goal_id): + selected_goal = get_goal_from_id(goal_id) + selected_goal = Goal.query.get(goal_id) + request_body = request.get_json() + task_ids_list = request_body["task_ids"] + + for task_id in task_ids_list: + task = Task.query.get(task_id) + selected_goal.tasks.append(task) + + db.session.commit() + response_body = selected_goal.add_tasks_to_goal_dict() + return make_response(response_body, 200) + +# Get tasks from goal +@goals_bp.route("//tasks", methods=["GET"], strict_slashes=False) +def get_tasks_from_goal(goal_id): + selected_goal = get_goal_from_id(goal_id) + selected_goal = Goal.query.get(goal_id) + + + + response_body = selected_goal.get_tasks_from_goal_dict() + + return make_response(response_body, 200) diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py new file mode 100644 index 000000000..e041c9727 --- /dev/null +++ b/app/routes/task_routes.py @@ -0,0 +1,111 @@ +from flask import Blueprint, request, make_response, jsonify, abort +from app.models.task import Task +from app import db +from datetime import date, datetime + +tasks_bp = Blueprint('tasks', __name__, url_prefix='/tasks') + +# # Helper functions +def valid_int(id): + try: + number = int(id) + return number + except: + response_body = 'Invalid Data' + abort(make_response(response_body,400)) + +def get_task_from_id(task_id): + id = valid_int(task_id) + selected_task = Task.query.filter_by(task_id=task_id).one_or_none() + # Task not found + if selected_task is None: + abort(make_response("Not Found", 404)) + return selected_task + +def valid_task(request_body): + if "title" not in request_body or "description" not in request_body or "completed_at" not in request_body: + abort(make_response({"details": "Invalid data"}, 400)) +# # + +# Create one task with error handlers +@tasks_bp.route("", methods=["POST"], strict_slashes=False) +def create_task(): + request_body = request.get_json() + valid_task(request_body) + 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() + response = {"task": new_task.to_dict()} + return make_response(response, 201) + +# Get all tasks +@tasks_bp.route("", methods=["GET"], strict_slashes=False) +def get_all_tasks(): + sort_tasks = request.args.get("sort") + response_list = [] + # Sort task: by title, ascending + if sort_tasks == "asc": + task_objects = Task.query.order_by(Task.title.asc()) + # Sort task: by title descending + elif sort_tasks == "desc": + task_objects = Task.query.order_by(Task.title.desc()) + else: + task_objects = Task.query.all() + for task in task_objects: + response_list.append(task.to_dict()) + return make_response(jsonify(response_list), 200) + +# Get one task +@tasks_bp.route("/", methods=["GET"], strict_slashes=False) +def get_task(task_id): + selected_task = get_task_from_id(task_id) + if selected_task.is_related_to_goal(): + response_body = {"task": selected_task.to_dict_for_goal()} + else: + response_body = {"task": selected_task.to_dict()} + return make_response(response_body, 200) + +# Update task +@tasks_bp.route("/", methods=["PUT"], strict_slashes=False) +def update_task(task_id): + selected_task = get_task_from_id(task_id) + request_body = request.get_json() + if "title" in request_body: + selected_task.title = request_body["title"] + if "description" in request_body: + selected_task.description = request_body["description"] + db.session.commit() + response_body = {"task": selected_task.to_dict()} + return make_response(response_body, 200) + +# Mark task complete +@tasks_bp.route("//mark_complete", methods=["PATCH"], strict_slashes=False) +def mark_task_complete(task_id): + selected_task = get_task_from_id(task_id) + # selected_task.is_complete = True + selected_task.completed_at = datetime.now() + db.session.commit() + response_body = {"task": selected_task.to_dict()} + return make_response(response_body, 200) + +# Mark task incomplete +@tasks_bp.route("//mark_incomplete", methods=["PATCH"], strict_slashes=False) +def mark_task_incomplete(task_id): + selected_task = get_task_from_id(task_id) + selected_task.completed_at = None + db.session.commit() + response_body = {"task": selected_task.to_dict()} + return make_response(response_body, 200) + +# Delete task +@tasks_bp.route("/", methods=["DELETE"], strict_slashes=False) +def delete_task(task_id): + selected_task = get_task_from_id(task_id) + db.session.delete(selected_task) + db.session.commit() + response_body = {'details': f'Task {task_id} "{selected_task.title}" successfully deleted'} + return make_response(response_body, 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/31b40e359500_.py b/migrations/versions/31b40e359500_.py new file mode 100644 index 000000000..9e04ca09c --- /dev/null +++ b/migrations/versions/31b40e359500_.py @@ -0,0 +1,30 @@ +"""empty message + +Revision ID: 31b40e359500 +Revises: d053da55b088 +Create Date: 2021-11-23 03:37:40.347127 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '31b40e359500' +down_revision = 'd053da55b088' +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/419a494764d6_.py b/migrations/versions/419a494764d6_.py new file mode 100644 index 000000000..4169cf720 --- /dev/null +++ b/migrations/versions/419a494764d6_.py @@ -0,0 +1,40 @@ +"""empty message + +Revision ID: 419a494764d6 +Revises: +Create Date: 2021-11-21 16:31:47.819552 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '419a494764d6' +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=False), + sa.Column('description', sa.String(), nullable=False), + sa.Column('is_complete', sa.Boolean(), nullable=True), + sa.Column('completed_at', sa.DateTime(timezone=True), 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/d053da55b088_.py b/migrations/versions/d053da55b088_.py new file mode 100644 index 000000000..c709ae111 --- /dev/null +++ b/migrations/versions/d053da55b088_.py @@ -0,0 +1,30 @@ +"""empty message + +Revision ID: d053da55b088 +Revises: 419a494764d6 +Create Date: 2021-11-23 01:12:43.749494 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'd053da55b088' +down_revision = '419a494764d6' +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=False)) + op.drop_column('task', 'is_complete') + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.add_column('task', sa.Column('is_complete', sa.BOOLEAN(), autoincrement=False, nullable=True)) + op.drop_column('goal', 'title') + # ### end Alembic commands ### diff --git a/tests/test_wave_05.py b/tests/test_wave_05.py index 6ba60c6fa..014f4693b 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") + 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") + 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") 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):