From 4ec20600c50ecba4383c3dee0ae03a13c816c560 Mon Sep 17 00:00:00 2001 From: Celina Date: Thu, 9 Jun 2022 03:43:16 -0700 Subject: [PATCH 1/6] wave 1 complete, all tests pass --- ada-project-docs/setup.md | 2 +- app/__init__.py | 2 + app/models/task.py | 17 ++++ app/routes.py | 97 ++++++++++++++++++- migrations/README | 1 + migrations/alembic.ini | 45 +++++++++ migrations/env.py | 96 ++++++++++++++++++ migrations/script.py.mako | 24 +++++ .../0d6a77b4a375_innitial_model_creation.py | 39 ++++++++ requirements.txt | 2 +- tests/test_wave_01.py | 43 +++----- 11 files changed, 338 insertions(+), 30 deletions(-) create mode 100644 migrations/README create mode 100644 migrations/alembic.ini create mode 100644 migrations/env.py create mode 100644 migrations/script.py.mako create mode 100644 migrations/versions/0d6a77b4a375_innitial_model_creation.py diff --git a/ada-project-docs/setup.md b/ada-project-docs/setup.md index 125900ca9..82e5a8f41 100644 --- a/ada-project-docs/setup.md +++ b/ada-project-docs/setup.md @@ -61,7 +61,7 @@ SQLALCHEMY_TEST_DATABASE_URI=postgresql+psycopg2://postgres:postgres@localhost:5 Run `$ flask db init`. -**_After you make your first model in Wave 1_**, run the other commands `migrate` and `upgrade`. +**_After you make your first model in Wave 1_**, run the other commands `migrate` with -m to add message so we know what were talking about and `upgrade`. ## Run `$ flask run` or `$ FLASK_ENV=development flask run` diff --git a/app/__init__.py b/app/__init__.py index 2764c4cc8..91934ab41 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -31,4 +31,6 @@ def create_app(test_config=None): # Register Blueprints here + from .routes import tasks_bp + app.register_blueprint(tasks_bp) return app diff --git a/app/models/task.py b/app/models/task.py index c91ab281f..b0f246323 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -3,3 +3,20 @@ class Task(db.Model): task_id = db.Column(db.Integer, primary_key=True) + title = db.Column(db.String, nullable=False) + description = db.Column(db.String, nullable=False) + completed_at = db.Column(db.DateTime, nullable=True) + + def to_dictionary(self): + return dict( + id=self.task_id, + title=self.title, + description=self.description, + is_complete=self.is_complete() + ) + + def is_complete(self): + if not self.completed_at: + return False + else: + return True diff --git a/app/routes.py b/app/routes.py index 3aae38d49..216a68fe8 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1 +1,96 @@ -from flask import Blueprint \ No newline at end of file +from flask import Blueprint, jsonify, request, make_response, abort +from app import db +from app.models.task import Task + +# Create a Task: +tasks_bp = Blueprint("tasks_bp", __name__, url_prefix="/tasks") + +@tasks_bp.route("", methods = ["POST"]) +def handle_tasks(): + request_body = request.get_json() + if "title" in request_body and "description" in request_body: + new_task = Task( + title = request_body["title"], + description = request_body["description"] + ) + else: + return jsonify({"details":"Invalid data"}), 400 + + db.session.add(new_task) + db.session.commit() + task_response = {"task": new_task.to_dictionary()} + return (jsonify(task_response), 201) + +# Get Tasks: Getting Saved Tasks (RESTful Endpoint: Read) +@tasks_bp.route("", methods = ["GET"]) +def task_data(): + tasks = Task.query.all() + tasks_response = [] + + for task in tasks: + tasks_response.append(task.to_dictionary()) + # If No Saved Tasks wil stil return 200 + return (jsonify(tasks_response), 200) + + +# Get One Task: One Saved Task +@tasks_bp.route("/", methods=["GET"]) +def handle_task(task_id): + task = validate_task(task_id) + task_response = {"task": task.to_dictionary()} + return (jsonify(task_response), 200) + +# Update Task +@tasks_bp.route("/", methods=["PUT"]) +def update_task(task_id): + task = validate_task(task_id) + + request_body = request.get_json() + + task.title = request_body["title"] + task.description = request_body["description"] + + db.session.commit() + + task_response = {"task": task.to_dictionary()} + return (jsonify(task_response), 200) + +# Delete Task: Deleting a Task +@tasks_bp.route("/", methods=["DELETE"]) +def delete_task(task_id): + task = validate_task(task_id) + + db.session.delete(task) + db.session.commit() + + response = {"details": f"Task {task.task_id} \"{task.title}\" successfully deleted"} + return (jsonify(response), 200) + + +# Validate there are no matching Task: Get, Update, and Delete + +def validate_task(task_id): + try: + task_id = int(task_id) + except: + abort(make_response({"message": f"Task {task_id} is invalid"}, 400)) + + + task = Task.query.get(task_id) + + if not task: + abort(make_response({"message": f"Task {task_id} not found"}, 404)) + return task + + + + + + + + + + + + + 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/0d6a77b4a375_innitial_model_creation.py b/migrations/versions/0d6a77b4a375_innitial_model_creation.py new file mode 100644 index 000000000..bbce97235 --- /dev/null +++ b/migrations/versions/0d6a77b4a375_innitial_model_creation.py @@ -0,0 +1,39 @@ +"""innitial model creation + +Revision ID: 0d6a77b4a375 +Revises: +Create Date: 2022-06-08 16:26:53.125238 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '0d6a77b4a375' +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=False), + sa.Column('description', sa.String(), nullable=False), + sa.Column('completed_at', sa.Integer(), 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/requirements.txt b/requirements.txt index 30ff414fe..68a2f250f 100644 --- a/requirements.txt +++ b/requirements.txt @@ -21,7 +21,7 @@ psycopg2-binary==2.8.6 py==1.10.0 pycodestyle==2.6.0 pyparsing==2.4.7 -pytest==6.2.3 +pytest==7.1.2 pytest-cov==2.12.1 python-dateutil==2.8.1 python-dotenv==0.15.0 diff --git a/tests/test_wave_01.py b/tests/test_wave_01.py index dca626d78..2c4909463 100644 --- a/tests/test_wave_01.py +++ b/tests/test_wave_01.py @@ -2,7 +2,7 @@ import pytest -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_get_tasks_no_saved_tasks(client): # Act response = client.get("/tasks") @@ -13,7 +13,7 @@ def test_get_tasks_no_saved_tasks(client): assert response_body == [] -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_get_tasks_one_saved_tasks(client, one_task): # Act response = client.get("/tasks") @@ -32,7 +32,7 @@ def test_get_tasks_one_saved_tasks(client, one_task): ] -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_get_task(client, one_task): # Act response = client.get("/tasks/1") @@ -51,7 +51,7 @@ def test_get_task(client, one_task): } -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_get_task_not_found(client): # Act response = client.get("/tasks/1") @@ -59,14 +59,11 @@ def test_get_task_not_found(client): # Assert assert response.status_code == 404 + assert response_body == {"message": "Task 1 not found"} + + - raise Exception("Complete test with assertion about response body") - # ***************************************************************** - # **Complete test with assertion about response body*************** - # ***************************************************************** - - -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_create_task(client): # Act response = client.post("/tasks", json={ @@ -93,7 +90,7 @@ def test_create_task(client): assert new_task.completed_at == None -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_update_task(client, one_task): # Act response = client.put("/tasks/1", json={ @@ -119,7 +116,7 @@ def test_update_task(client, one_task): assert task.completed_at == None -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_update_task_not_found(client): # Act response = client.put("/tasks/1", json={ @@ -130,14 +127,11 @@ def test_update_task_not_found(client): # Assert assert response.status_code == 404 + assert response_body == {"message": "Task 1 not found"} - raise Exception("Complete test with assertion about response body") - # ***************************************************************** - # **Complete test with assertion about response body*************** - # ***************************************************************** -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_delete_task(client, one_task): # Act response = client.delete("/tasks/1") @@ -152,7 +146,7 @@ def test_delete_task(client, one_task): assert Task.query.get(1) == None -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_delete_task_not_found(client): # Act response = client.delete("/tasks/1") @@ -160,16 +154,11 @@ def test_delete_task_not_found(client): # Assert assert response.status_code == 404 - - raise Exception("Complete test with assertion about response body") - # ***************************************************************** - # **Complete test with assertion about response body*************** - # ***************************************************************** - assert Task.query.all() == [] + assert response_body == {"message": "Task 1 not found"} -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_create_task_must_contain_title(client): # Act response = client.post("/tasks", json={ @@ -186,7 +175,7 @@ def test_create_task_must_contain_title(client): assert Task.query.all() == [] -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_create_task_must_contain_description(client): # Act response = client.post("/tasks", json={ From 5560461bd64ed7ac79cad0dda5ea4eda16fc3a37 Mon Sep 17 00:00:00 2001 From: Celina Date: Thu, 9 Jun 2022 05:13:14 -0700 Subject: [PATCH 2/6] wave 2 complete, all tests pass --- app/routes.py | 17 ++++++++++++++--- tests/test_wave_02.py | 4 ++-- 2 files changed, 16 insertions(+), 5 deletions(-) diff --git a/app/routes.py b/app/routes.py index 216a68fe8..d6bc6d08f 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,3 +1,5 @@ +from typing import OrderedDict +from urllib.request import OpenerDirector from flask import Blueprint, jsonify, request, make_response, abort from app import db from app.models.task import Task @@ -23,10 +25,19 @@ def handle_tasks(): # Get Tasks: Getting Saved Tasks (RESTful Endpoint: Read) @tasks_bp.route("", methods = ["GET"]) -def task_data(): - tasks = Task.query.all() +def get_tasks(): + sort = request.args.get("sort") + #Sort by assending (is default?) + if sort == "asc": + tasks =Task.query.order_by(Task.title) + #Sort by decending + elif sort == "desc": + tasks =Task.query.order_by(Task.title.desc()) + #No Sort + else: + tasks = Task.query.all() + tasks_response = [] - for task in tasks: tasks_response.append(task.to_dictionary()) # If No Saved Tasks wil stil return 200 diff --git a/tests/test_wave_02.py b/tests/test_wave_02.py index a087e0909..c9a76e6b1 100644 --- a/tests/test_wave_02.py +++ b/tests/test_wave_02.py @@ -1,7 +1,7 @@ import pytest -@pytest.mark.skip(reason="No way to test this feature yet") +#@pytest.mark.skip(reason="No way to test this feature yet") def test_get_tasks_sorted_asc(client, three_tasks): # Act response = client.get("/tasks?sort=asc") @@ -29,7 +29,7 @@ def test_get_tasks_sorted_asc(client, three_tasks): ] -@pytest.mark.skip(reason="No way to test this feature yet") +#@pytest.mark.skip(reason="No way to test this feature yet") def test_get_tasks_sorted_desc(client, three_tasks): # Act response = client.get("/tasks?sort=desc") From bd8418fa7b2ea1ddedd41c3e77a2deb57d873959 Mon Sep 17 00:00:00 2001 From: Celina Date: Thu, 9 Jun 2022 09:03:49 -0700 Subject: [PATCH 3/6] wave 3 complete, all tests pass --- app/routes.py | 29 +++++++++++++++++++++++++++-- tests/test_wave_03.py | 32 ++++++++++++-------------------- 2 files changed, 39 insertions(+), 22 deletions(-) diff --git a/app/routes.py b/app/routes.py index d6bc6d08f..e0a48caee 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,3 +1,4 @@ +from datetime import datetime from typing import OrderedDict from urllib.request import OpenerDirector from flask import Blueprint, jsonify, request, make_response, abort @@ -8,12 +9,13 @@ tasks_bp = Blueprint("tasks_bp", __name__, url_prefix="/tasks") @tasks_bp.route("", methods = ["POST"]) -def handle_tasks(): +def create_tasks(): request_body = request.get_json() if "title" in request_body and "description" in request_body: new_task = Task( title = request_body["title"], - description = request_body["description"] + description = request_body["description"], + completed_at = datetime.utcnow() ) else: return jsonify({"details":"Invalid data"}), 400 @@ -66,6 +68,29 @@ def update_task(task_id): task_response = {"task": task.to_dictionary()} return (jsonify(task_response), 200) +# Task Complete +@tasks_bp.route("//mark_complete", methods=["PATCH"]) +def task_complete(task_id): + task = validate_task(task_id) + task.completed_at = datetime.utcnow() + + db.session.commit() + task_response = {"task": task.to_dictionary()} + return (jsonify(task_response), 200) + +# Task Incomplete +@tasks_bp.route("//mark_incomplete", methods=["PATCH"]) +def task_incomplete(task_id): + task = validate_task(task_id) + task.completed_at = None + db.session.commit() + task_response = {"task": task.to_dictionary()} + return (jsonify(task_response), 200) + + + + + # Delete Task: Deleting a Task @tasks_bp.route("/", methods=["DELETE"]) def delete_task(task_id): diff --git a/tests/test_wave_03.py b/tests/test_wave_03.py index 959176ceb..d2733ec25 100644 --- a/tests/test_wave_03.py +++ b/tests/test_wave_03.py @@ -5,7 +5,7 @@ import pytest -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_mark_complete_on_incomplete_task(client, one_task): # Arrange """ @@ -42,7 +42,7 @@ def test_mark_complete_on_incomplete_task(client, one_task): assert Task.query.get(1).completed_at -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_mark_incomplete_on_complete_task(client, completed_task): # Act response = client.patch("/tasks/1/mark_incomplete") @@ -62,7 +62,7 @@ def test_mark_incomplete_on_complete_task(client, completed_task): assert Task.query.get(1).completed_at == None -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_mark_complete_on_completed_task(client, completed_task): # Arrange """ @@ -99,7 +99,7 @@ def test_mark_complete_on_completed_task(client, completed_task): assert Task.query.get(1).completed_at -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_mark_incomplete_on_incomplete_task(client, one_task): # Act response = client.patch("/tasks/1/mark_incomplete") @@ -119,7 +119,7 @@ def test_mark_incomplete_on_incomplete_task(client, one_task): assert Task.query.get(1).completed_at == None -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_mark_complete_missing_task(client): # Act response = client.patch("/tasks/1/mark_complete") @@ -127,14 +127,9 @@ def test_mark_complete_missing_task(client): # Assert assert response.status_code == 404 + assert response_body == {"message": "Task 1 not found"} - raise Exception("Complete test with assertion about response body") - # ***************************************************************** - # **Complete test with assertion about response body*************** - # ***************************************************************** - - -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_mark_incomplete_missing_task(client): # Act response = client.patch("/tasks/1/mark_incomplete") @@ -142,16 +137,13 @@ def test_mark_incomplete_missing_task(client): # Assert assert response.status_code == 404 - - raise Exception("Complete test with assertion about response body") - # ***************************************************************** - # **Complete test with assertion about response body*************** - # ***************************************************************** - + assert response_body == {"message": "Task 1 not found"} # Let's add this test for creating tasks, now that # the completion functionality has been implemented -@pytest.mark.skip(reason="No way to test this feature yet") + + +# @pytest.mark.skip(reason="No way to test this feature yet") def test_create_task_with_valid_completed_at(client): # Act response = client.post("/tasks", json={ @@ -181,7 +173,7 @@ def test_create_task_with_valid_completed_at(client): # Let's add this test for updating tasks, now that # the completion functionality has been implemented -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_update_task_with_completed_at_date(client, completed_task): # Act response = client.put("/tasks/1", json={ From 690e8841e7253b797efce6d17599b596ec87bcd3 Mon Sep 17 00:00:00 2001 From: Celina Date: Fri, 10 Jun 2022 07:23:49 -0700 Subject: [PATCH 4/6] wave 5 complete, all tests pass --- app/__init__.py | 7 +- app/goal_routes.py | 117 ++++++++++++++++++ app/models/goal.py | 7 ++ app/{routes.py => task_routes.py} | 15 ++- ...=> 0d6a77b4a375_initial_model_creation.py} | 0 .../versions/dd8b8f33192b_starting_wave_5.py | 28 +++++ tests/test_wave_05.py | 81 ++++++------ 7 files changed, 205 insertions(+), 50 deletions(-) create mode 100644 app/goal_routes.py rename app/{routes.py => task_routes.py} (95%) rename migrations/versions/{0d6a77b4a375_innitial_model_creation.py => 0d6a77b4a375_initial_model_creation.py} (100%) create mode 100644 migrations/versions/dd8b8f33192b_starting_wave_5.py diff --git a/app/__init__.py b/app/__init__.py index 91934ab41..f01d15cd4 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -31,6 +31,11 @@ def create_app(test_config=None): # Register Blueprints here - from .routes import tasks_bp + from .task_routes import tasks_bp app.register_blueprint(tasks_bp) + + from .goal_routes import goal_bp + app.register_blueprint(goal_bp) + return app + diff --git a/app/goal_routes.py b/app/goal_routes.py new file mode 100644 index 000000000..9f82c1c9b --- /dev/null +++ b/app/goal_routes.py @@ -0,0 +1,117 @@ +from datetime import datetime +from typing import OrderedDict +from urllib.request import OpenerDirector +from flask import Blueprint, jsonify, request, make_response, abort +from app import db +from app.models.goal import Goal + +### Create a Goal: +goal_bp = Blueprint("goal_bp", __name__, url_prefix="/goals") + +@goal_bp.route("", methods = ["POST"]) +def create_goals(): + request_body = request.get_json() + if "title" in request_body: + new_goal = Goal( + title = request_body["title"] + ) + else: + return jsonify({"details":"Invalid data"}), 400 + + + db.session.add(new_goal) + db.session.commit() + goal_response = {"goal": new_goal.to_dictionary()} + return (jsonify(goal_response), 201) + + +### Get Goals +@goal_bp.route("", methods = ["GET"]) +def get_goals(): + sort = request.args.get("sort") + #Sort by assending (is default?) + if sort == "asc": + goals =Goal.query.order_by(Goal.title) + #Sort by decending + elif sort == "desc": + goals =Goal.query.order_by(Goal.title.desc()) + #No Sort + else: + goals = Goal.query.all() + + goals_response = [] + for goal in goals: + goals_response.append(goal.to_dictionary()) + # If No Saved Goals wil stil return 200 + return (jsonify(goals_response), 200) + + +### Get One Goal: One Saved Goal +@goal_bp.route("/", methods=["GET"]) +def get_one_goal(goal_id): + goal = validate_goal(goal_id) + goal_response = {"goal": goal.to_dictionary()} + return (jsonify(goal_response), 200) + +### Update Goal +@goal_bp.route("/", methods=["PUT"]) +def update_goal(goal_id): + goal = validate_goal(goal_id) + + request_body = request.get_json() + + goal.title = request_body["title"] + + db.session.commit() + + goal_response = {"goal": goal.to_dictionary()} + return (jsonify(goal_response), 200) + +# Goal Complete +@goal_bp.route("//mark_complete", methods=["PATCH"]) +def goal_complete(goal_id): + goal = validate_goal(goal_id) + goal.completed_at = datetime.utcnow() + + db.session.commit() + goal_response = {"goal": goal.to_dictionary()} + return (jsonify(goal_response), 200) + +# Goal Incomplete +@goal_bp.route("//mark_incomplete", methods=["PATCH"]) +def goal_incomplete(goal_id): + goal = validate_goal(goal_id) + goal.completed_at = None + db.session.commit() + goal_response = {"goal": goal.to_dictionary()} + return (jsonify(goal_response), 200) + + +# Delete Goal: Deleting a Goal +@goal_bp.route("/", methods=["DELETE"]) +def delete_goal(goal_id): + goal = validate_goal(goal_id) + + db.session.delete(goal) + db.session.commit() + + response = {"details": f"Goal {goal.goal_id} \"{goal.title}\" successfully deleted"} + return (jsonify(response), 200) + + +# Validate there are no matching Goal: Get, Update, and Delete + +def validate_goal(goal_id): + try: + goal_id = int(goal_id) + except: + abort(make_response({"message": f"Goal {goal_id} is invalid"}, 400)) + + + goal = Goal.query.get(goal_id) + + if not goal: + abort(make_response({"message": f"Goal {goal_id} not found"}, 404)) + return goal + + diff --git a/app/models/goal.py b/app/models/goal.py index b0ed11dd8..8f88735b1 100644 --- a/app/models/goal.py +++ b/app/models/goal.py @@ -3,3 +3,10 @@ class Goal(db.Model): goal_id = db.Column(db.Integer, primary_key=True) + title = db.Column(db.String, nullable=False) + + def to_dictionary(self): + return dict( + id=self.goal_id, + title=self.title + ) \ No newline at end of file diff --git a/app/routes.py b/app/task_routes.py similarity index 95% rename from app/routes.py rename to app/task_routes.py index e0a48caee..7cb56b4ec 100644 --- a/app/routes.py +++ b/app/task_routes.py @@ -5,7 +5,7 @@ from app import db from app.models.task import Task -# Create a Task: +### Create a Task: tasks_bp = Blueprint("tasks_bp", __name__, url_prefix="/tasks") @tasks_bp.route("", methods = ["POST"]) @@ -25,7 +25,8 @@ def create_tasks(): task_response = {"task": new_task.to_dictionary()} return (jsonify(task_response), 201) -# Get Tasks: Getting Saved Tasks (RESTful Endpoint: Read) + +### Get Tasks @tasks_bp.route("", methods = ["GET"]) def get_tasks(): sort = request.args.get("sort") @@ -46,14 +47,15 @@ def get_tasks(): return (jsonify(tasks_response), 200) -# Get One Task: One Saved Task +### Get One Task: One Saved Task @tasks_bp.route("/", methods=["GET"]) -def handle_task(task_id): +def get_one_task(task_id): task = validate_task(task_id) task_response = {"task": task.to_dictionary()} return (jsonify(task_response), 200) -# Update Task + +### Update Task @tasks_bp.route("/", methods=["PUT"]) def update_task(task_id): task = validate_task(task_id) @@ -88,9 +90,6 @@ def task_incomplete(task_id): return (jsonify(task_response), 200) - - - # Delete Task: Deleting a Task @tasks_bp.route("/", methods=["DELETE"]) def delete_task(task_id): diff --git a/migrations/versions/0d6a77b4a375_innitial_model_creation.py b/migrations/versions/0d6a77b4a375_initial_model_creation.py similarity index 100% rename from migrations/versions/0d6a77b4a375_innitial_model_creation.py rename to migrations/versions/0d6a77b4a375_initial_model_creation.py diff --git a/migrations/versions/dd8b8f33192b_starting_wave_5.py b/migrations/versions/dd8b8f33192b_starting_wave_5.py new file mode 100644 index 000000000..d9065c474 --- /dev/null +++ b/migrations/versions/dd8b8f33192b_starting_wave_5.py @@ -0,0 +1,28 @@ +"""empty message + +Revision ID: dd8b8f33192b +Revises: 0d6a77b4a375 +Create Date: 2022-06-09 09:20:50.855204 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'dd8b8f33192b' +down_revision = '0d6a77b4a375' +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)) + # ### 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 aee7c52a1..8e788e7e3 100644 --- a/tests/test_wave_05.py +++ b/tests/test_wave_05.py @@ -1,7 +1,8 @@ +from app.models.goal import Goal import pytest -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_get_goals_no_saved_goals(client): # Act response = client.get("/goals") @@ -12,7 +13,7 @@ def test_get_goals_no_saved_goals(client): assert response_body == [] -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_get_goals_one_saved_goal(client, one_goal): # Act response = client.get("/goals") @@ -29,7 +30,7 @@ def test_get_goals_one_saved_goal(client, one_goal): ] -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_get_goal(client, one_goal): # Act response = client.get("/goals/1") @@ -46,22 +47,19 @@ 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() - raise Exception("Complete test") # Assert - # ---- Complete Test ---- - # assertion 1 goes here - # assertion 2 goes here - # ---- Complete Test ---- + assert response.status_code == 404 + assert response_body == {"message": "Goal 1 not found"} -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_create_goal(client): # Act response = client.post("/goals", json={ @@ -80,34 +78,42 @@ 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): - raise Exception("Complete test") # 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): - raise Exception("Complete test") # Act - # ---- Complete Act Here ---- + response = client.put("/goals/1", json={ + "title": "Updated Goal Title", + "description": "Updated Test Description", + }) + 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 == {"message": "Goal 1 not found"} -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_delete_goal(client, one_goal): # Act response = client.delete("/goals/1") @@ -119,32 +125,25 @@ def test_delete_goal(client, one_goal): assert response_body == { "details": 'Goal 1 "Build a habit of going outside daily" successfully deleted' } - # Check that the goal was deleted + assert Goal.query.get(1) == None response = client.get("/goals/1") assert response.status_code == 404 - raise Exception("Complete test with assertion about response body") - # ***************************************************************** - # **Complete test with assertion about response body*************** - # ***************************************************************** - -@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): - raise Exception("Complete test") - # 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 Goal.query.all() == [] + assert response_body == {"message": "Goal 1 not found"} -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_create_goal_missing_title(client): # Act response = client.post("/goals", json={}) From bd12474af0b05a93e2a20f288f4c15ba4ce1a3d3 Mon Sep 17 00:00:00 2001 From: Celina Date: Fri, 10 Jun 2022 21:24:15 -0700 Subject: [PATCH 5/6] refactored for wave 1 and 3 compatabliity. all tests pass in waves 1, 2, 3, 4, 5 & the first two tests of wave 6 --- app/goal_routes.py | 17 +++++++++++ app/models/goal.py | 1 + app/models/task.py | 5 +++- app/task_routes.py | 10 +++++-- .../versions/4a2042fd99e4_starting_wave_6.py | 30 +++++++++++++++++++ tests/test_wave_06.py | 20 +++++-------- 6 files changed, 68 insertions(+), 15 deletions(-) create mode 100644 migrations/versions/4a2042fd99e4_starting_wave_6.py diff --git a/app/goal_routes.py b/app/goal_routes.py index 9f82c1c9b..91a2517c0 100644 --- a/app/goal_routes.py +++ b/app/goal_routes.py @@ -4,6 +4,7 @@ from flask import Blueprint, jsonify, request, make_response, abort from app import db from app.models.goal import Goal +from app.task_routes import validate_task ### Create a Goal: goal_bp = Blueprint("goal_bp", __name__, url_prefix="/goals") @@ -115,3 +116,19 @@ def validate_goal(goal_id): return goal +@goal_bp.route("//tasks", methods=["POST"]) +def post_task_ids_to_goal(goal_id): + goal = validate_goal(goal_id) + + request_body = request.get_json() + + for task_id in request_body["task_ids"]: + task = validate_task(task_id) + task.goal_id = goal.goal_id + + db.session.commit() + + return jsonify({"id":goal.goal_id, "task_ids": request_body["task_ids"]}), 200 + + + diff --git a/app/models/goal.py b/app/models/goal.py index 8f88735b1..a68384aab 100644 --- a/app/models/goal.py +++ b/app/models/goal.py @@ -4,6 +4,7 @@ class Goal(db.Model): goal_id = db.Column(db.Integer, primary_key=True) title = db.Column(db.String, nullable=False) + tasks = db.relationship("Task", back_populates="goals", lazy = True) def to_dictionary(self): return dict( diff --git a/app/models/task.py b/app/models/task.py index b0f246323..ba04b8f9a 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -1,3 +1,4 @@ +from email.policy import default from app import db @@ -5,7 +6,9 @@ class Task(db.Model): task_id = db.Column(db.Integer, primary_key=True) title = db.Column(db.String, nullable=False) description = db.Column(db.String, nullable=False) - completed_at = db.Column(db.DateTime, nullable=True) + completed_at = db.Column(db.DateTime, nullable=True, default=None) + goal_id = db.Column(db.Integer, db.ForeignKey('goal.goal_id'), nullable = True) + goals = db.relationship("Goal", back_populates="tasks") def to_dictionary(self): return dict( diff --git a/app/task_routes.py b/app/task_routes.py index 7cb56b4ec..a464285dd 100644 --- a/app/task_routes.py +++ b/app/task_routes.py @@ -11,11 +11,17 @@ @tasks_bp.route("", methods = ["POST"]) def create_tasks(): request_body = request.get_json() - if "title" in request_body and "description" in request_body: + if "title" in request_body and "description" in request_body and "completed_at" in request_body: new_task = Task( title = request_body["title"], description = request_body["description"], - completed_at = datetime.utcnow() + completed_at = request_body["completed_at"] + ) + elif "title" in request_body and "description" in request_body: + new_task = Task( + title = request_body["title"], + description = request_body["description"], + # completed_at = request_body["completed_at"] ) else: return jsonify({"details":"Invalid data"}), 400 diff --git a/migrations/versions/4a2042fd99e4_starting_wave_6.py b/migrations/versions/4a2042fd99e4_starting_wave_6.py new file mode 100644 index 000000000..a9b571948 --- /dev/null +++ b/migrations/versions/4a2042fd99e4_starting_wave_6.py @@ -0,0 +1,30 @@ +"""starting wave 6 + +Revision ID: 4a2042fd99e4 +Revises: dd8b8f33192b +Create Date: 2022-06-10 10:22:28.037650 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '4a2042fd99e4' +down_revision = 'dd8b8f33192b' +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_06.py b/tests/test_wave_06.py index 8afa4325e..a0bb30fb1 100644 --- a/tests/test_wave_06.py +++ b/tests/test_wave_06.py @@ -1,8 +1,9 @@ +from app.models.task import Task from app.models.goal import Goal import pytest -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_post_task_ids_to_goal(client, one_goal, three_tasks): # Act response = client.post("/goals/1/tasks", json={ @@ -23,7 +24,7 @@ def test_post_task_ids_to_goal(client, one_goal, three_tasks): assert len(Goal.query.get(1).tasks) == 3 -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_post_task_ids_to_goal_already_with_goals(client, one_task_belongs_to_one_goal, three_tasks): # Act response = client.post("/goals/1/tasks", json={ @@ -42,7 +43,7 @@ def test_post_task_ids_to_goal_already_with_goals(client, one_task_belongs_to_on assert len(Goal.query.get(1).tasks) == 2 -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_get_tasks_for_specific_goal_no_goal(client): # Act response = client.get("/goals/1/tasks") @@ -50,14 +51,9 @@ def test_get_tasks_for_specific_goal_no_goal(client): # Assert assert response.status_code == 404 + assert response_body == {"message": "Goal 1 not found"} - raise Exception("Complete test with assertion about response body") - # ***************************************************************** - # **Complete test with assertion about response body*************** - # ***************************************************************** - - -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_get_tasks_for_specific_goal_no_tasks(client, one_goal): # Act response = client.get("/goals/1/tasks") @@ -74,7 +70,7 @@ def test_get_tasks_for_specific_goal_no_tasks(client, one_goal): } -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_get_tasks_for_specific_goal(client, one_task_belongs_to_one_goal): # Act response = client.get("/goals/1/tasks") @@ -99,7 +95,7 @@ def test_get_tasks_for_specific_goal(client, one_task_belongs_to_one_goal): } -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_get_task_includes_goal_id(client, one_task_belongs_to_one_goal): response = client.get("/tasks/1") response_body = response.get_json() From 554b149cfb8bc8a5c8491818309f3cfac2c98f10 Mon Sep 17 00:00:00 2001 From: Celina Date: Sun, 12 Jun 2022 06:10:26 -0700 Subject: [PATCH 6/6] refactored for wave 1 and 3 compatabliity. all tests pass in waves 1, 2, 3, 4, 5 & the first four tests of wave 6 --- app/goal_routes.py | 18 +++++++++++++++--- app/models/goal.py | 13 +++++++++---- tests/test_wave_06.py | 5 +++-- 3 files changed, 27 insertions(+), 9 deletions(-) diff --git a/app/goal_routes.py b/app/goal_routes.py index 91a2517c0..3ed96adc2 100644 --- a/app/goal_routes.py +++ b/app/goal_routes.py @@ -1,9 +1,11 @@ +from urllib import response from datetime import datetime from typing import OrderedDict from urllib.request import OpenerDirector from flask import Blueprint, jsonify, request, make_response, abort from app import db from app.models.goal import Goal +from app.models.task import Task from app.task_routes import validate_task ### Create a Goal: @@ -123,12 +125,22 @@ def post_task_ids_to_goal(goal_id): request_body = request.get_json() for task_id in request_body["task_ids"]: - task = validate_task(task_id) - task.goal_id = goal.goal_id - + task = Task.query.get(task_id) + task.goal_id = goal_id + task.goal = goal + db.session.commit() return jsonify({"id":goal.goal_id, "task_ids": request_body["task_ids"]}), 200 +@goal_bp.route("//tasks", methods=["GET"]) +def get_tasks_for_goal(goal_id): + goal = validate_goal(goal_id) + task_list = [task.to_dictionary() for task in goal.tasks] + + goal_dict = goal.to_dictionary() + goal_dict["tasks"] = task_list + + return jsonify(goal_dict) diff --git a/app/models/goal.py b/app/models/goal.py index a68384aab..84f82a3dd 100644 --- a/app/models/goal.py +++ b/app/models/goal.py @@ -7,7 +7,12 @@ class Goal(db.Model): tasks = db.relationship("Task", back_populates="goals", lazy = True) def to_dictionary(self): - return dict( - id=self.goal_id, - title=self.title - ) \ No newline at end of file + goal_dict = { + "id": self.goal_id, + "title": self.title + } + + if self.tasks: + goal_dict["tasks"] = [task.task_id for task in self.tasks] + + return goal_dict \ No newline at end of file diff --git a/tests/test_wave_06.py b/tests/test_wave_06.py index a0bb30fb1..f678bd1f8 100644 --- a/tests/test_wave_06.py +++ b/tests/test_wave_06.py @@ -67,14 +67,15 @@ def test_get_tasks_for_specific_goal_no_tasks(client, one_goal): "id": 1, "title": "Build a habit of going outside daily", "tasks": [] - } + } + response_body = response.get_json() + # @pytest.mark.skip(reason="No way to test this feature yet") def test_get_tasks_for_specific_goal(client, one_task_belongs_to_one_goal): # Act response = client.get("/goals/1/tasks") - response_body = response.get_json() # Assert assert response.status_code == 200