Marie Keefer Task List API

Procfile

@@ -0,0 +1 @@
+web: gunicorn 'app:create_app()'

app/__init__.py

@@ -1,10 +1,8 @@
-from flask import Flask
-from flask_sqlalchemy import SQLAlchemy
-from flask_migrate import Migrate
 import os
 from dotenv import load_dotenv
-
-
+from flask import Flask
+from flask_migrate import Migrate
+from flask_sqlalchemy import SQLAlchemy
 db = SQLAlchemy()
 migrate = Migrate()
 load_dotenv()
@@ -21,14 +19,18 @@ def create_app(test_config=None):
         app.config["TESTING"] = True
         app.config["SQLALCHEMY_DATABASE_URI"] = os.environ.get(
             "SQLALCHEMY_TEST_DATABASE_URI")
-
+    
     # Import models here for Alembic setup
-    from app.models.task import Task
     from app.models.goal import Goal
+    from app.models.task import Task
 
     db.init_app(app)
     migrate.init_app(app, db)
 
     # Register Blueprints here
+    from app.task_routes import tasks_bp
+    app.register_blueprint(tasks_bp)
+    from app.goal_routes import goals_bp
+    app.register_blueprint(goals_bp)
 
     return app

app/goal_routes.py

@@ -0,0 +1,89 @@
+from app import db
+from app.models.goal import Goal
+from app.models.task import Task
+from flask import Blueprint,jsonify, make_response, request
+from app.helper_functions import validate_model
+from sqlalchemy import asc, desc
+
+
+goals_bp = Blueprint("goals_bp", __name__, url_prefix="/goals")
+
+@goals_bp.route("", methods=["POST"])
+def create_goal():
+    request_body = request.get_json()
+    if not "title" in request_body:
+        return make_response({"details": "Invalid data"}, 400)
+
+    new_goal = Goal.from_dict(request_body)
+
+    db.session.add(new_goal)
+    db.session.commit()
+
+    return make_response({"goal": new_goal.to_dict()}, 201)
+
+@goals_bp.route("/<goal_id>/tasks", methods=["POST"])
+def create_goal_tasks(goal_id):
+    request_body = request.get_json()
+    goal = validate_model(Goal, goal_id)
+
+    task_list = []
+    for task_id in request_body["task_ids"]:
+        task = validate_model(Task, task_id)
+        task.goal = goal
+        task_list.append(task_id)
+
+    db.session.commit()
+
+    return make_response({"id": goal.goal_id, "task_ids": task_list}, 200)
+
+@goals_bp.route("", methods=["GET"])
+def read_all_goals():
+    sort_query = request.args.get("sort")
+    if sort_query:
+        if sort_query == "asc":
+            goals = Goal.query.order_by(Goal.title.asc()).all()
+        elif sort_query == "desc":
+            goals = Goal.query.order_by(Goal.title.desc()).all()
+    else:
+        goals = Goal.query.all()
+
+    goal_response = []
+    for goal in goals:
+        goal_response.append(goal.to_dict())
+    return make_response(jsonify(goal_response), 200)
+
+@goals_bp.route("/<goal_id>", methods=["GET"])
+def read_one_goal(goal_id):
+    goal = validate_model(Goal, goal_id)
+
+    return make_response({"goal": goal.to_dict()}, 200)
+
+@goals_bp.route("/<goal_id>/tasks", methods=["GET"])
+def read_tasks_of_one_goal(goal_id):
+    goal = validate_model(Goal, goal_id)
+
+    task_list = []
+    for task in goal.tasks:
+        task_list.append(task.to_dict())
+
+    return make_response({"id": goal.goal_id, "title": goal.title, "tasks": task_list})
+
+@goals_bp.route("/<goal_id>", methods=["PUT"])
+def update_goal(goal_id):
+    goal = validate_model(Goal, goal_id)
+    request_body = request.get_json()
+
+    goal.title = request_body["title"]
+
+    db.session.commit()
+
+    return make_response({"goal": goal.to_dict()}, 200)
+
+@goals_bp.route("/<goal_id>", methods=["DELETE"])
+def delete_goal(goal_id):
+    goal = validate_model(Goal, goal_id)
+
+    db.session.delete(goal)
+    db.session.commit()
+
+    return make_response({"details":f"Goal {goal.goal_id} \"{goal.title}\" successfully deleted"}), 200

app/helper_functions.py

@@ -0,0 +1,29 @@
+from app import db
+from flask import abort, make_response
+import os, requests
+
+def validate_model(cls, model_id):
+    try:
+        model_id = int(model_id)
+    except:
+        abort(make_response({"message": f"{cls.__name__} {model_id} invalid"}, 400))
+
+    model = cls.query.get(model_id)
+
+    if not model:
+        abort(make_response({"message": f"{cls.__name__} {model_id} not found"}, 404))
+
+    return model
+
+
+def slack_bot_message(message):
+    slack_api_key = os.environ.get("SLACK_BOT_TOKEN")
+    slack_url = "https://slack.com/api/chat.postMessage"
+    header = {"Authorization": slack_api_key}
+
+    query_params = {
+        "channel": "task-notifications",
+        "text": message
+    }
+    print(slack_api_key)
+    requests.post(url=slack_url, data=query_params, headers=header)

app/models/goal.py

@@ -3,3 +3,18 @@
 
 class Goal(db.Model):
     goal_id = db.Column(db.Integer, primary_key=True)
+    title = db.Column(db.String)
+    tasks = db.relationship("Task", back_populates="goal", lazy=True)
+
+    def to_dict(self):
+
+            return {
+                "id": self.goal_id,
+                "title": self.title
+            }
+
+
+    @classmethod
+    def from_dict(cls, goal_data):
+        new_goal = Goal(title=goal_data["title"])
+        return new_goal

app/models/task.py

@@ -2,4 +2,42 @@
 
 
 class Task(db.Model):
-    task_id = db.Column(db.Integer, primary_key=True)
+    task_id = db.Column(db.Integer, primary_key=True, autoincrement=True)
+    title = db.Column(db.String)
+    description = db.Column(db.String)
+    completed_at = db.Column(db.DateTime, default=None)
+    goal_id = db.Column(db.Integer, db.ForeignKey("goal.goal_id"), nullable=True)
+    goal = db.relationship("Goal", back_populates="tasks")
+
+    def to_dict(self):
+        if self.completed_at:
+
+            return {
+                "id": self.task_id,
+                "title": self.title,
+                "description": self.description,
+                "is_complete": True
+            }
+        if self.goal_id and not self.completed_at:
+            return {
+                "id": self.task_id,
+                "goal_id": self.goal_id,
+                "title": self.title,
+                "description": self.description,
+                "is_complete": False
+            }
+
+        else:
+            return {
+                "id": self.task_id,
+                "title": self.title,
+                "description": self.description,
+                "is_complete": False
+            }
+
+
+    @classmethod
+    def from_dict(cls, task_data):
+        new_task = Task(title=task_data["title"],
+                    description=task_data["description"])
+        return new_task

app/task_routes.py

@@ -0,0 +1,94 @@
+from app import db
+from app.helper_functions import validate_model, slack_bot_message
+from app.models.task import Task
+from datetime import datetime
+from flask import Blueprint, abort, jsonify, make_response, request
+from sqlalchemy import asc, desc
+from dotenv import load_dotenv
+load_dotenv()
+
+tasks_bp = Blueprint("tasks_bp", __name__, url_prefix="/tasks")
+
+
+# -------Routes-------
+@tasks_bp.route("", methods=["POST"])
+def create_task():
+    request_body = request.get_json()
+    if not "title" in request_body or not "description" in request_body:
+        return make_response({"details": "Invalid data"}, 400)
+
+    new_task = Task.from_dict(request_body)
+
+    db.session.add(new_task)
+    db.session.commit()
+
+    return make_response({"task": new_task.to_dict()}, 201)
+
+@tasks_bp.route("", methods=["GET"])
+def read_all_tasks():
+    sort_query = request.args.get("sort")
+    if sort_query:
+        if sort_query == "asc":
+            tasks = Task.query.order_by(Task.title.asc()).all()
+        elif sort_query == "desc":
+            tasks = Task.query.order_by(Task.title.desc()).all()
+    else:
+        tasks = Task.query.all()
+
+    task_response = []
+    for task in tasks:
+        task_response.append(task.to_dict())
+    return make_response(jsonify(task_response), 200)
+
+
+@tasks_bp.route("/<task_id>", methods=["GET"])
+def read_one_task(task_id):
+    task = validate_model(Task, task_id)
+
+    return make_response({"task": task.to_dict()}, 200)
+
+@tasks_bp.route("/<task_id>", methods=["PUT"])
+def update_task(task_id):
+    task = validate_model(Task, task_id)
+    request_body = request.get_json()
+
+    task.title = request_body["title"]
+    task.description = request_body["description"]
+
+    db.session.commit()
+
+    return make_response({"task": task.to_dict()}, 200)
+
+@tasks_bp.route("/<task_id>", methods=["DELETE"])
+def delete_task(task_id):
+    task = validate_model(Task, task_id)
+
+    db.session.delete(task)
+    db.session.commit()
+
+    return make_response({"details":f"Task {task.task_id} \"{task.title}\" successfully deleted"}), 200
+
+@tasks_bp.route("/<task_id>/mark_complete", methods=["PATCH"])
+def mark_task_complete(task_id):
+    task = validate_model(Task, task_id)
+
+    task.completed_at = datetime.utcnow()
+
+    db.session.commit()
+
+    slack_bot_message(f"Someone just completed the task {task.title}")
+
+    return make_response({"task": task.to_dict()}, 200)
+
+@tasks_bp.route("/<task_id>/mark_incomplete", methods=["PATCH"])
+def mark_task_incomplete(task_id):
+    task = validate_model(Task, task_id)
+
+    task.completed_at = None
+    db.session.commit()
+
+    return make_response({"task": task.to_dict()}, 200)
+
+
+
+

migrations/README

@@ -0,0 +1 @@
+Generic single-database configuration.

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