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..f818895f8 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -14,6 +14,11 @@ def create_app(test_config=None): app = Flask(__name__) app.config["SQLALCHEMY_TRACK_MODIFICATIONS"] = False + # import models here + + + + if test_config is None: app.config["SQLALCHEMY_DATABASE_URI"] = os.environ.get( "SQLALCHEMY_DATABASE_URI") @@ -30,5 +35,11 @@ def create_app(test_config=None): migrate.init_app(app, db) # Register Blueprints here + + from .routes import tasks_bp + app.register_blueprint(tasks_bp) + + from .routes import goals_bp + app.register_blueprint(goals_bp) return app diff --git a/app/models/goal.py b/app/models/goal.py index 8cad278f8..a873fcf5d 100644 --- a/app/models/goal.py +++ b/app/models/goal.py @@ -1,6 +1,38 @@ 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) + id = db.Column(db.Integer, primary_key=True) + title = db.Column(db.String) + # genres = db.relationship("Genre", secondary="books_genres", backref="books") + tasks = db.relationship("Task", backref="goal", lazy=True) + + def to_dict(self): + if self.list_of_task_ids(): + + return{ + + "id": self.id, + "title": self.title, + "tasks_ids": self.list_of_task_ids() + } + else: + return{ + "id": self.id, + "title": self.title + } + + def list_of_task_ids(self): + task_ids = [task.id for task in self.tasks] + return task_ids + + def task_list(self): + list = [] + for task in self.tasks: + list.append(task.to_dict) + + return list + + diff --git a/app/models/task.py b/app/models/task.py index 39c89cd16..1e2a869bc 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -1,6 +1,40 @@ from flask import current_app from app import db +# task_id: a primary key for each task +# title: text to name the task +# description: text to describe the task +# completed_at: a datetime that has the date that a task is completed on. Can be nullable, and contain a null value. A task with a null value for completed_at has not been completed. class Task(db.Model): - task_id = db.Column(db.Integer, primary_key=True) + id = db.Column(db.Integer, primary_key=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.id'), nullable=True) + + def to_dict(self): + if self.goal_id is None: + return { + "id": self.id, + "title": self.title, + "description": self.description, + "is_complete": self.check_for_complete_task(), + } + else: + + return{ + + "id": self.id, + "title": self.title, + "description": self.description, + "is_complete": self.check_for_complete_task(), + "goal_id": self.goal_id + + } + + def check_for_complete_task(self): + if self.completed_at: + return True + return False + diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..a0ca6904c 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,272 @@ -from flask import Blueprint +from flask.wrappers import Response +from app.models.task import Task +from app import db +from flask import Blueprint, jsonify, make_response, request, abort +from datetime import date +import os +import requests +from dotenv import load_dotenv +from app.models.goal import Goal + +# handle_tasks handles GET and POST requests for the /tasks endpoint + + +tasks_bp = Blueprint("tasks_bp", __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)) + +@tasks_bp.route("", methods=["GET", "POST"]) +def handle_tasks(): +# Wave 1: Get Tasks: Getting Saved Tasks + if request.method == "GET": + sort = request.args.get("sort") + if sort == "asc": + tasks = Task.query.order_by(Task.title) + elif sort == "desc": + tasks = Task.query.order_by(Task.title.desc()) + else: + tasks = Task.query.all() +#Wave 1: Get Tasks: No Saved Tasks + tasks_response = [] + for task in tasks: + has_complete = task.completed_at + tasks_response.append( + { + "description": task.description, + "id": task.id, + "is_complete": False if has_complete == None else has_complete, + "title": task.title, + } + ) + return jsonify(tasks_response) +# Wave 1: Create a Task: Valid Task With null completed_at + elif request.method == "POST": + request_body = request.get_json() +#Wave 1: Create A Task: Missing Title + if "title" not in request_body or "description" not in request_body or "completed_at" not in request_body: + return jsonify ({ + "details": "Invalid data" + }), 400 + + + new_task = Task( + title=request_body["title"], + description=request_body["description"], + completed_at=request_body["completed_at"] + ) + db.session.add(new_task) + db.session.commit() + +#Wave 1: Create A Task: Valid Task with null completed_at 201 CREATED + + + return jsonify({"task":new_task.to_dict()}),201 +# handle_one_task handles GET,PUT and DELETE requests for the tasks/task_id endpoint +@tasks_bp.route("/", methods=["GET", "PUT", "DELETE"]) +def handle_one_task(task_id): + valid_int(task_id,"task_id") + task = Task.query.get_or_404(task_id) +# Wave 1: Get One Task: One Saved Task + if request.method == "GET": + has_complete = task.completed_at + if task.goal_id: + task_response={ + "task": { + "id": task.id, + "goal_id": task.goal_id, + "title": task.title, + "description": task.description, + "is_complete": False if has_complete == None else has_complete, + + } + } + else: + task_response={ + "task": { + "id": task.id, + "title": task.title, + "description": task.description, + "is_complete": False if has_complete == None else has_complete, + + } + } + + return jsonify(task_response) +#Wave 1: Update Task, #Wave 1 Update Task: No Matching Task, Update Task 200 OK + elif request.method == "PUT": + form_data = request.get_json() + + task.title = form_data["title"] + task.description = form_data["description"] + + + db.session.commit() + return jsonify({"task":task.to_dict()}),200 + +#Wave 1 Delete Task: Deleting A Task, #Wave 1: Delete Task: No Matching Task + elif request.method == "DELETE": + db.session.delete(task) + db.session.commit() + response = { + "details": f'Task {task.id} "{task.title}" successfully deleted' + } + json_response = jsonify(response) + return make_response(json_response, 200) + +def slack_bot(title): + query_path = { + "channel": "melinda-bot", + "text": f"Someone completed the task {title}" + } + header = { + "Authorization": f"Bearer {os.environ.get('BOT')}" + } + response = requests.post("https://slack.com/api/chat.postMessage",params = query_path, headers = header) + return response.json() + + +#Wave 3 +@tasks_bp.route("//mark_complete", methods=["PATCH"]) +def handle_completed_task(task_id): + valid_int(task_id,"task_id") + task = Task.query.get_or_404(task_id) + task.completed_at = date.today() + db.session.commit() + slack_bot(task.title) + return jsonify ({"task":task.to_dict()}),200 + + +@tasks_bp.route("//mark_incomplete", methods=["PATCH"]) +def handle_incompleted_task(task_id): + valid_int(task_id,"task_id") + task = Task.query.get_or_404(task_id) + task.completed_at = None + db.session.commit() + return jsonify ({"task":task.to_dict()}),200 + + +# Wave 5 Creating a Goal Model Blueprint +goals_bp = Blueprint("goals_bp", __name__, url_prefix="/goals") + +# Wave 5 Create A Goal: Valid Goal +@goals_bp.route("", methods=["POST"]) +def handle_post_goals(): + + request_body = request.get_json() + + if "title" not in request_body: + return jsonify ( { + "details": "Invalid data" + }), 400 + + new_goal = Goal( + title = request_body["title"] + ) + db.session.add(new_goal) + db.session.commit() + + + return jsonify({"goal":new_goal.to_dict()}), 201 + +# Wave 5 Get Goals: Getting Saved Goals +@goals_bp.route("", methods=["GET"]) +def handle_goals(): + goals = Goal.query.all() + goals_response = [] + for goal in goals: + goals_response.append(goal.to_dict()) + return jsonify(goals_response), 200 + + +# Wave 5 Update Goal: Update Goal/No Matching Goal +@goals_bp.route("/", methods=["PUT", "GET"]) +def handle_update_one_goal(goal_id): + goal = Goal.query.get_or_404(goal_id) + if request.method == "GET": + return jsonify({"goal":goal.to_dict()}),200 + elif request.method == "PUT": + form_data = request.get_json() + if "title" not in form_data: + return jsonify( { + "details": "title required" + }), 400 + + goal.title = form_data["title"] + + db.session.commit() + return jsonify({"goal":{"goal_id":goal.id, "title":goal.title}}),200 + +# Wave 5 Deleting A Goal: Deleting A Goal/No Matching Goal +@goals_bp.route("/", methods=["DELETE"]) +def handle_delete_one_goal(goal_id): + goal = Goal.query.get_or_404(goal_id) + db.session.delete(goal) + db.session.commit() + return jsonify( { + "details": f"Goal {goal_id} \"{goal.title}\" successfully deleted" + }),200 + # json_response = jsonify(response) + # return make_response(json_response), 200 + +#Wave # 6 +@goals_bp.route("//tasks", methods=["POST"]) +def post_task_ids_to_goal(goal_id): + valid_int(goal_id,"goal_id") + request_body = request.get_json() + goal = Goal.query.get_or_404(goal_id) + task_ids = request_body["task_ids"] + for task_id in task_ids: + task = Task.query.get(task_id) + goal.tasks.append(task) + db.session.commit() + return jsonify({"id":goal.id, "task_ids": [task.id for task in goal.tasks]}),200 + +@goals_bp.route("//tasks", methods=["GET"]) +def get_tasks_for_goal(goal_id): + valid_int(goal_id,"goal_id") + goal = Goal.query.get_or_404(goal_id) + + tasks = goal.tasks + tasks_list = [] + for task in tasks: + tasks_list.append(task.to_dict()) + response_body = {"id":goal.id, + "title":goal.title, + "tasks": tasks_list + } + + + return jsonify(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/a86f4efc50c0_.py b/migrations/versions/a86f4efc50c0_.py new file mode 100644 index 000000000..3a5c55fae --- /dev/null +++ b/migrations/versions/a86f4efc50c0_.py @@ -0,0 +1,42 @@ +"""empty message + +Revision ID: a86f4efc50c0 +Revises: +Create Date: 2021-11-14 17:05:52.542184 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'a86f4efc50c0' +down_revision = None +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.create_table('goal', + sa.Column('id', sa.Integer(), nullable=False), + sa.Column('title', sa.String(), nullable=True), + sa.PrimaryKeyConstraint('id') + ) + op.create_table('task', + sa.Column('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.Column('goal_id', sa.Integer(), nullable=True), + sa.ForeignKeyConstraint(['goal_id'], ['goal.id'], ), + sa.PrimaryKeyConstraint('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/tests/test_wave_05.py b/tests/test_wave_05.py index 6ba60c6fa..6838ee096 100644 --- a/tests/test_wave_05.py +++ b/tests/test_wave_05.py @@ -41,17 +41,17 @@ 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 + assert response.status_code == 404 + assert response_body == None # ---- Complete Test ---- def test_create_goal(client): @@ -71,29 +71,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 + response = client.put("goals/1", json={"title": "Updated Goal"}) + response_body = response.get_json() # ---- Complete Act Here ---- # Assert # ---- Complete Assertions Here ---- - # assertion 1 goes here - # assertion 2 goes here - # assertion 3 goes here + assert response.status_code == 200 + assert "goal" in response_body + assert response_body == { + "goal": { + "goal_id": 1, + "title": "Updated Goal" + } + } # ---- Complete Assertions Here ---- -@pytest.mark.skip(reason="test to be completed by student") +#@pytest.mark.skip(reason="test to be completed by student") def test_update_goal_not_found(client): pass # Act # ---- Complete Act Here ---- + response = client.put("goals/1", json={"title": "Updated Goal"}) + response_body = response.get_json() # Assert # ---- Complete Assertions Here ---- - # assertion 1 goes here - # assertion 2 goes here + assert response.status_code == 404 + assert response_body is None # ---- Complete Assertions Here ---- @@ -113,17 +121,19 @@ 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 + assert response.status_code == 404 + assert response_body is None # ---- Complete Assertions Here ----