Olive - Task List - Sea Turtles

Procfile

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

app/__init__.py

@@ -30,5 +30,9 @@ def create_app(test_config=None):
     migrate.init_app(app, db)
 
     # Register Blueprints here
+    from .routes.task_routes import tasks_bp 
+    app.register_blueprint(tasks_bp)
+    from .routes.goal_routes import goals_bp 
+    app.register_blueprint(goals_bp)
 
     return app

app/models/goal.py

@@ -2,4 +2,31 @@
 
 
 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)
+    tasks = db.relationship("Task", backref="goal", lazy=True)
+
+
+    def to_dict(self):
+        return dict(
+            id = self.id,
+            title = self.title
+            )
+
+    def to_dict_with_tasks(self):
+        tasks_info = [task.to_dict() for task in self.tasks]
+        return dict(
+            id = self.id,
+            title = self.title,
+            tasks = tasks_info
+        )
+
+    @classmethod
+    def from_dict(cls, data_dict):
+        return cls(
+                title = data_dict["title"],
+            )
+
+    def replace_details(self, data_dict):
+        self.title = data_dict["title"]
+

app/models/task.py

@@ -2,4 +2,38 @@
 
 
 class Task(db.Model):
-    task_id = db.Column(db.Integer, primary_key=True)
+    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)
+    goal_id = db.Column(db.Integer, db.ForeignKey("goal.id"))
+
+
+    def to_dict(self):
+        if self.goal_id:
+            return dict(
+            id = self.id,
+            goal_id = self.goal_id,
+            title = self.title,
+            description = self.description,
+            is_complete = bool(self.completed_at)
+        )
+        else:
+            return dict(
+            id = self.id,
+            title = self.title,
+            description = self.description,
+            is_complete = bool(self.completed_at)
+        )
+    @classmethod
+    def from_dict(cls, data_dict):
+        completed_time = data_dict["completed_at"] if "completed_at" in data_dict else None
+        return cls(
+                title = data_dict["title"],
+                description = data_dict["description"],
+                completed_at = completed_time
+            )
+
+    def replace_details(self, data_dict):
+        self.title = data_dict["title"]
+        self.description = data_dict["description"]

app/routes/goal_routes.py

@@ -0,0 +1,83 @@
+from app.models.goal import Goal
+from app.models.task import Task
+from flask import Blueprint, jsonify, request
+from app import db
+from .routes_helper import get_record_by_id, make_goal_safely, replace_goal_safely
+
+goals_bp = Blueprint("goals_bp", __name__, url_prefix="/goals")
+
+# POST /goals
+@goals_bp.route("", methods = ["POST"])
+def create_goal():
+    request_body = request.get_json()
+    new_goal = make_goal_safely(request_body)
+
+    db.session.add(new_goal)
+    db.session.commit()
+
+    return jsonify({"goal": new_goal.to_dict()}), 201
+
+# GET /goals
+@goals_bp.route("", methods=["GET"])
+def read_all_goals():
+    goals = Goal.query.all()
+
+    result_list = [goal.to_dict() for goal in goals]
+
+    return jsonify(result_list)
+
+# GET /goals/<id>
+@goals_bp.route("/<id>", methods=["Get"])
+def read_goal_by_id(id):
+    goal = get_record_by_id(Goal, id)
+    return jsonify({"goal":goal.to_dict()})
+
+# PUT /goals/<id>
+@goals_bp.route("/<id>", methods=["PUT"])
+def replace_goal_by_id(id):
+    request_body = request.get_json()
+    goal = get_record_by_id(Goal, id)
+
+    replace_goal_safely(goal, request_body)
+
+    db.session.add(goal)
+    db.session.commit()
+
+    return jsonify({"goal":goal.to_dict()})
+
+# DELETE /goals/<id>
+@goals_bp.route("/<id>", methods=["DELETE"])
+def delete_goal_by_id(id):
+    goal = get_record_by_id(Goal, id)
+
+    db.session.delete(goal)
+    db.session.commit()
+
+    return jsonify({"details": f'Goal {goal.id} "{goal.title}" successfully deleted'})
+
+# POST /goals/<id>/tasks
+@goals_bp.route("/<id>/tasks", methods=["POST"])
+def post_tasks_to_goal(id):
+    request_body = request.get_json()
+    goal = get_record_by_id(Goal, id)
+
+    task_ids = request_body["task_ids"]
+
+    for id in task_ids:
+        task = get_record_by_id(Task, id)
+        task.goal = goal
+
+    db.session.commit()
+
+    task_list = [task.id for task in goal.tasks ]
+
+    return(jsonify({"id":goal.id, "task_ids": task_list}))
+
+# GET /goals/<id>/tasks
+@goals_bp.route("/<id>/tasks", methods=["GET"])
+def read_tasks_from_goal(id):
+    goal = get_record_by_id(Goal, id)
+
+    return jsonify(goal.to_dict_with_tasks())
+
+

app/routes/routes_helper.py

@@ -0,0 +1,42 @@
+from flask import jsonify, abort, make_response
+from app.models.goal import Goal
+from app.models.task import Task
+
+def error_message(message, status_code):
+    abort(make_response(jsonify(dict(details=message)), status_code))
+
+def get_record_by_id(cls, id):
+    try:
+        id = int(id)
+    except ValueError:
+        error_message(f"Invalid id {id}", 400)
+
+    model = cls.query.get(id)
+    if model:
+        return model
+
+    error_message(f"No model of type {cls} with id {id} found", 404)
+
+def make_task_safely(data_dict):
+    try:
+        return Task.from_dict(data_dict)
+    except KeyError as err:
+        error_message(f"Missing key: {err}", 400)
+
+def replace_task_safely(task, data_dict):
+    try:
+        task.replace_details(data_dict)
+    except KeyError as err:
+        error_message(f"Missing key: {err}", 400)
+
+def make_goal_safely(data_dict):
+    try:
+        return Goal.from_dict(data_dict)
+    except KeyError as err:
+        error_message(f"Missing key: {err}", 400)
+
+def replace_goal_safely(goal, data_dict):
+    try:
+        goal.replace_details(data_dict)
+    except KeyError as err:
+        error_message(f"Missing key: {err}", 400)

app/routes/task_routes.py

@@ -0,0 +1,101 @@
+from datetime import datetime
+from flask import Blueprint, jsonify, request
+from app.models.task import Task
+from app import db
+from .routes_helper import get_record_by_id, make_task_safely, replace_task_safely
+import os
+import requests
+from dotenv import load_dotenv
+
+load_dotenv()
+
+tasks_bp = Blueprint("tasks_bp", __name__, url_prefix="/tasks")
+
+def post_completed_task_to_slack(task):
+    API_KEY = os.environ.get('SLACKBOT_API_KEY')
+    url = "https://slack.com/api/chat.postMessage"
+    data = {"channel": "task-notifications", "text": f"Someone just completed the task {task.title}"}
+    headers = {'Authorization' : f"Bearer {API_KEY}" }
+
+    requests.post(url, data=data, headers=headers)
+
+# POST /tasks
+@tasks_bp.route("", methods = ["POST"])
+def create_task():
+    request_body = request.get_json()
+    new_task = make_task_safely(request_body)
+
+    db.session.add(new_task)
+    db.session.commit()
+
+    return jsonify({"task": new_task.to_dict()}), 201
+
+# GET /tasks
+@tasks_bp.route("", methods=["GET"])
+def read_all_tasks():
+    sort_param = request.args.get("sort")
+
+    if sort_param == 'asc':
+        tasks = Task.query.order_by(Task.title.asc())
+    elif sort_param == 'desc':
+        tasks = Task.query.order_by(Task.title.desc())
+    else:
+        tasks = Task.query.all()
+
+    result_list = [task.to_dict() for task in tasks]
+
+    return jsonify(result_list)
+
+# GET /tasks/<id>
+@tasks_bp.route("/<id>", methods=["Get"])
+def read_task_by_id(id):
+    task = get_record_by_id(Task, id)
+    return jsonify({"task":task.to_dict()})
+
+# PUT /tasks/<id>
+@tasks_bp.route("/<id>", methods=["PUT"])
+def replace_task_by_id(id):
+    request_body = request.get_json()
+    task = get_record_by_id(Task, id)
+
+    replace_task_safely(task, request_body)
+
+    db.session.add(task)
+    db.session.commit()
+
+    return jsonify({"task":task.to_dict()})
+
+# DELETE /tasks/<id>
+@tasks_bp.route("/<id>", methods=["DELETE"])
+def delete_task_by_id(id):
+    task = get_record_by_id(Task, id)
+
+    db.session.delete(task)
+    db.session.commit()
+
+    return jsonify({"details": f'Task {task.id} "{task.title}" successfully deleted'})
+
+# PATCH /tasks/<id>/mark_complete
+@tasks_bp.route("/<id>/mark_complete", methods=["PATCH"])
+def update_task_to_complete(id):
+    task = get_record_by_id(Task, id)
+
+    task.completed_at = datetime.now()
+
+    db.session.commit()
+
+    post_completed_task_to_slack(task)
+
+    return jsonify({"task":task.to_dict()})
+
+# PATCH /tasks/<id>/mark_incomplete
+@tasks_bp.route("/<id>/mark_incomplete", methods=["PATCH"])
+def update_task_to_incomplete(id):
+    task = get_record_by_id(Task, id)
+    task.completed_at = None
+
+    db.session.commit()
+
+    return jsonify({"task":task.to_dict()})
+
+

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