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..d337fde0d 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -4,12 +4,10 @@ import os from dotenv import load_dotenv - db = SQLAlchemy() migrate = Migrate() load_dotenv() - def create_app(test_config=None): app = Flask(__name__) app.config["SQLALCHEMY_TRACK_MODIFICATIONS"] = False @@ -28,7 +26,13 @@ def create_app(test_config=None): db.init_app(app) 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..e9c02bdf7 100644 --- a/app/models/goal.py +++ b/app/models/goal.py @@ -2,5 +2,33 @@ 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, autoincrement=True) + title = db.Column(db.String) + tasks = db.relationship("Task",backref="goal", lazy=True) + + + def list_of_task_id(self): + task_ids =[task.id for task in self.tasks] + return task_ids + + def to_dict(self): + if self.list_of_task_id(): + + return {"id":self.id, + "title":self.title, + "task_ids":self.list_of_task_id() + } + else: + return {"id":self.id, + "title":self.title, + } + def task_lists(self): + list=[] + for task in self.tasks: + list.append(task.to_dict()) + return list + + + \ No newline at end of file diff --git a/app/models/task.py b/app/models/task.py index 39c89cd16..1ce5192ac 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -1,6 +1,31 @@ from flask import current_app from app import db - 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')) + + def check_for_completed_task(self): + if self.completed_at: + return True + return False + + 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_completed_task() + } + else: + return {"id":self.id, + "title":self.title, + "description":self.description, + "is_complete":self.check_for_completed_task(), + "goal_id": self.goal_id + } + diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..7dd510c4c 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,157 @@ -from flask import Blueprint +from app import db +from app.models.task import Task +from flask import Blueprint, jsonify,request, make_response, abort +from datetime import date +from app.models.goal import Goal +import os +import requests +from dotenv import load_dotenv +from slack_sdk import WebClient +from slack_sdk.errors import SlackApiError + +def valid_int(number,parameter_type): + try: + int(number) + except: + abort(make_response({"error":f"{parameter_type} must be an int"},400)) + +def slack_notification(): + load_dotenv() + slack_token = os.environ["SLACK_TOKENS"] + client = WebClient(token=slack_token) + try: + response = client.chat_postMessage( + channel ="CNEEJDLAW", + text = "Task completed" + ) + except SlackApiError as e: + return jsonify({"Error": "chanel not found"}) + +tasks_bp = Blueprint("tasks",__name__,url_prefix="/tasks") +goals_bp = Blueprint("goals", __name__,url_prefix="/goals") + +@tasks_bp.route("",methods=["GET"]) +def handle_tasks(): + sort_query = request.args.get("sort") + if sort_query == "asc": + tasks = Task.query.order_by(Task.title.asc()) + elif sort_query == "desc": + tasks = Task.query.order_by(Task.title.desc()) + else: + tasks = Task.query.all() + tasks_response =[] + for task in tasks: + tasks_response.append(task.to_dict()) + return jsonify(tasks_response),200 + +@tasks_bp.route("/",methods=["GET","put","DELETE"]) +def get_task(task_id): + valid_int(task_id, "task_id") + task = Task.query.get_or_404(task_id) + if request.method == "GET": + return jsonify({"task":task.to_dict()}),200 + elif request.method == "PUT": + request_body = request.get_json() + if "title" in request_body: + task.title = request_body["title"] + if "description" in request_body: + task.description = request_body["description"] + if "completed_at" in request_body: + task.completed_at = request_body["completed_at"] + db.session.commit() + return jsonify({"task":task.to_dict()}),200 + elif request.method == "DELETE": + db.session.delete(task) + db.session.commit() + return jsonify({"details":f'Task {task_id} "{task.title}" successfully deleted'}),200 + +@tasks_bp.route("",methods=["POST"]) +def create_task(): + 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 jsonify({'details': "Invalid data"}),400 + + new_task = Task( + title=request_body["title"], + description = request_body["description"], + completed_at = request_body["completed_at"] + ) + db.session.add(new_task) + db.session.commit() + return jsonify({"task":new_task.to_dict()}),201 + +@tasks_bp.route("//mark_complete",methods=["PATCH"]) +def mark_complete_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_notification() + return jsonify({"task":task.to_dict()}),200 + +@tasks_bp.route("//mark_incomplete",methods=["PATCH"]) +def mark_incomplete_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 + +@goals_bp.route("", methods=["POST"]) +def create_goal(): + 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 + +@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 + +@goals_bp.route("/", methods=["GET", "PUT","DELETE"]) +def get_goal(goal_id): + valid_int(goal_id,"goal_id") + goal = Goal.query.get_or_404(goal_id) + if request.method == "GET": + return jsonify({"goal":goal.to_dict()}),200 + elif request.method == "DELETE": + db.session.delete(goal) + db.session.commit() + return jsonify({"details":f"Goal {goal_id} \"{goal.title}\" successfully deleted"}) + elif request.method == "PUT": + request_body = request.get_json() + goal.title = request_body["title"] + db.session.commit() + return jsonify({"goal":goal.to_dict()}),200 + +@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(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) + response_body = {"id":goal.id, + "title":goal.title, + "tasks":goal.task_lists() + } + print(response_body) + return jsonify(response_body),200 \ No newline at end of file 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/8424eb27fd71_.py b/migrations/versions/8424eb27fd71_.py new file mode 100644 index 000000000..fa609a5bb --- /dev/null +++ b/migrations/versions/8424eb27fd71_.py @@ -0,0 +1,30 @@ +"""empty message + +Revision ID: 8424eb27fd71 +Revises: ab57bec98a23 +Create Date: 2021-11-02 15:27:37.873070 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '8424eb27fd71' +down_revision = 'ab57bec98a23' +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'], ['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/ab57bec98a23_.py b/migrations/versions/ab57bec98a23_.py new file mode 100644 index 000000000..1b557bbfb --- /dev/null +++ b/migrations/versions/ab57bec98a23_.py @@ -0,0 +1,40 @@ +"""empty message + +Revision ID: ab57bec98a23 +Revises: +Create Date: 2021-11-02 09:42:14.769017 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'ab57bec98a23' +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(), autoincrement=True, 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.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/requirements.txt b/requirements.txt index cfdf74050..e849bfb4b 100644 --- a/requirements.txt +++ b/requirements.txt @@ -26,6 +26,7 @@ python-dotenv==0.15.0 python-editor==1.0.4 requests==2.25.1 six==1.15.0 +slack-sdk==3.11.2 SQLAlchemy==1.3.23 toml==0.10.2 urllib3==1.26.4 diff --git a/tests/test_wave_05.py b/tests/test_wave_05.py index 6ba60c6fa..4b3dffd00 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,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 - # ---- Complete Test ---- + assert response.status_code ==404 + assert response_body == None + def test_create_goal(client): # Act @@ -71,30 +71,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": "complete my project successfully" + }) + response_body = response.get_json() # Assert - # ---- Complete Assertions Here ---- - # assertion 1 goes here - # assertion 2 goes here - # assertion 3 goes here - # ---- Complete Assertions Here ---- - -@pytest.mark.skip(reason="test to be completed by student") + assert response.status_code == 200 + assert "goal" in response_body + assert response_body =={ + "goal":{"id": 1, + "title": "complete my project successfully"} + } + goal = Goal.query.get(1) + assert goal.title == "complete my project successfully" + def test_update_goal_not_found(client): - pass + # Act - # ---- Complete Act Here ---- + response = client.put("/goals/1", json={ + "title": "complete my project successfully" + }) + 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 +120,20 @@ 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 + # 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 == None + def test_create_goal_missing_title(client):