Sea Turtles - Tiffini H.

Procfile

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

app/__init__.py

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

app/goal_routes.py

@@ -0,0 +1,90 @@
+from flask import Blueprint, request, jsonify, make_response, abort
+from app import db
+from app.models.goal import Goal
+from app.models.task import Task
+from app.route_helpers import error_message, validate_model_instance
+
+goals_bp = Blueprint("goals_bp", __name__, url_prefix="/goals")
+
+# create a new goal
+@goals_bp.route("", methods=["POST"])
+def create_goal():
+    request_body = request.get_json()
+
+    # check for request body
+    try:
+        new_goal = Goal(title=request_body["title"])
+    except:
+        error_message("Invalid data", 400)
+
+    # update database
+    db.session.add(new_goal)
+    db.session.commit()
+
+    response_body = {"goal": new_goal.to_dict()}
+
+    return make_response(jsonify(response_body), 201)
+
+# get all goals
+@goals_bp.route("", methods=["GET"])
+def get_all_goals():
+    goals = Goal.query.all()
+    goals_response = [goal.to_dict() for goal in goals]
+
+    return make_response(jsonify(goals_response))
+
+# get goal by id
+@goals_bp.route("/<goal_id>", methods=["GET"])
+def get_goal_by_id(goal_id):
+    goal = validate_model_instance(Goal, goal_id)
+    return {"goal": goal.to_dict()}
+
+# update goal by id
+@goals_bp.route("/<goal_id>", methods=["PUT"])
+def update_goal(goal_id):
+    goal = validate_model_instance(Goal, goal_id)
+
+    request_body = request.get_json()
+    goal.title = request_body["title"]
+
+    db.session.commit()
+    return {"goal": goal.to_dict()}
+
+# delete goal by id
+@goals_bp.route("/<goal_id>", methods=["DELETE"])
+def delete_goal(goal_id):
+    goal = validate_model_instance(Goal, goal_id)
+
+    db.session.delete(goal)
+    db.session.commit()
+
+    return make_response({"details": f'Goal {goal_id} \"{goal.title}\" successfully deleted'})
+
+# get tasks by goal id
+@goals_bp.route("/<goal_id>/tasks", methods=["GET"])
+def get_tasks_for_goal(goal_id):
+    goal = validate_model_instance(Goal, goal_id)
+    task_list = [task.to_dict() for task in goal.tasks]
+
+    goal_dict = goal.to_dict()
+    goal_dict["tasks"] = task_list
+
+    return jsonify(goal_dict)
+
+# post tasks to goal by goal id
+@goals_bp.route("/<goal_id>/tasks", methods=["POST"])
+def post_tasks_to_goal(goal_id):
+    goal = validate_model_instance(Goal, goal_id)
+    request_body = request.get_json()
+
+    for task_id in request_body["task_ids"]:
+        task = Task.query.get(task_id)
+        task.goal_id = goal_id
+        task.goal = goal
+
+    db.session.commit()
+
+    return make_response({
+        "id": goal.goal_id,
+        "task_ids": request_body["task_ids"]
+    })

app/models/goal.py

@@ -3,3 +3,17 @@
 
 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="goal")
+
+    def to_dict(self):
+        goal_dict = {
+            "id": self.goal_id,
+            "title": self.title
+        }
+
+        if self.tasks:
+            goal_dict["tasks"] = [task.task_id for task in self.tasks]
+            # goal_dict["tasks"] = []
+
+        return goal_dict

app/models/task.py

@@ -3,3 +3,25 @@
 
 class Task(db.Model):
     task_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, default=None)
+    goal_id = db.Column(db.Integer, db.ForeignKey("goal.goal_id"))
+    goal = db.relationship("Goal", back_populates="tasks")
+
+    def to_dict(self):
+        task_dict = {
+            "id": self.task_id,
+            "title": self.title,
+            "description": self.description,
+        }
+
+        if not self.completed_at:
+            task_dict["is_complete"] = False
+        else:
+            task_dict["is_complete"] = True
+
+        if self.goal_id:
+            task_dict["goal_id"] = self.goal_id
+
+        return task_dict

app/route_helpers.py

@@ -0,0 +1,41 @@
+from flask import jsonify, make_response, abort
+from app.models.goal import Goal
+from app.models.task import Task
+import requests, os
+
+# helper function to generate error message
+def error_message(message, status_code):
+    abort(make_response(jsonify(dict(details=message)), status_code))
+
+# class/model-agnostic helper function to validate model instances
+def validate_model_instance(model, id):
+    if model == Task:
+        model_name = "Task"
+    elif model == Goal:
+        model_name = "Goal"
+
+    try:
+        id = int(id)
+    except:
+        error_message(f"{model_name} #{id} invalid", 400)
+
+    model_instance = model.query.get(id)
+
+    if not model_instance:
+        error_message(f"{model_name} #{id} not found", 404)
+
+    return model_instance
+
+# helper function to post completion message to slack
+def post_slack_completion_message(task_id):
+    task = validate_model_instance(Task, task_id)
+    path = "https://slack.com/api/chat.postMessage"
+    SLACK_API_KEY = os.environ.get("SLACK_BOT_TOKEN")
+
+    request_headers = {"Authorization": f"Bearer {SLACK_API_KEY}"}
+    request_body = {
+        "channel": "C03EP2Q0WK1",
+        "text": f"Someone just completed the task {task.title}"
+    }
+
+    requests.post(path, headers=request_headers, json=request_body)

app/task_routes.py

@@ -0,0 +1,101 @@
+from flask import Blueprint, request, jsonify, make_response, abort
+from sqlalchemy import desc
+from app import db
+from app.models.task import Task
+from datetime import date
+from app.route_helpers import error_message, validate_model_instance, post_slack_completion_message
+
+tasks_bp = Blueprint("tasks_bp", __name__, url_prefix="/tasks")
+
+# create a new task
+@tasks_bp.route("", methods=["POST"])
+def create_task():
+    request_body = request.get_json()
+
+    try:
+        new_task = Task(
+            title=request_body["title"],
+            description=request_body["description"]
+        )
+    except:
+        error_message("Invalid data", 400)
+
+    if request_body.get("completed_at"):
+        new_task.completed_at = request_body.get("completed_at")
+
+    db.session.add(new_task)
+    db.session.commit()
+
+    response_body = {"task": new_task.to_dict()}
+
+    return make_response(jsonify(response_body), 201)
+
+# retrieve all tasks
+@tasks_bp.route("", methods=["GET"])
+def get_all_tasks():
+    sort_param = request.args.get("sort")
+
+    if sort_param == "asc":
+        tasks = Task.query.order_by(Task.title).all()
+    elif sort_param == "desc":
+        tasks = Task.query.order_by(desc(Task.title)).all()
+    else:
+        tasks = Task.query.all()
+
+    tasks_response = [task.to_dict() for task in tasks]
+
+    return jsonify(tasks_response)
+
+# retrieve one task by id
+@tasks_bp.route("/<task_id>", methods=["GET"])
+def get_one_task_by_id(task_id):
+    task = validate_model_instance(Task, task_id)
+
+    return {"task": task.to_dict()}
+
+# update one task by id
+@tasks_bp.route("/<task_id>", methods=["PUT"])
+def update_one_task_by_id(task_id):
+    task = validate_model_instance(Task, task_id)
+    request_body = request.get_json()
+
+    task.title = request_body["title"]
+    task.description = request_body["description"]
+
+    db.session.commit()
+
+    return {"task": task.to_dict()}
+
+# delete one task by id
+@tasks_bp.route("/<task_id>", methods=["DELETE"])
+def delete_task_by_id(task_id):
+    task = validate_model_instance(Task, task_id)
+
+    db.session.delete(task)
+    db.session.commit()
+
+    return make_response({"details": f'Task {task_id} "{task.title}" successfully deleted'})
+
+# mark one task complete by id
+@tasks_bp.route("/<task_id>/mark_complete", methods=["PATCH"])
+def mark_task_complete(task_id):
+    task = validate_model_instance(Task, task_id)
+
+    task.completed_at = date.today()
+    response_body = {"task": task.to_dict()}
+
+    db.session.commit()
+    post_slack_completion_message(task_id)
+
+    return make_response(jsonify(response_body), 200)
+
+# mark one task incomplete by id
+@tasks_bp.route("/<task_id>/mark_incomplete", methods=["PATCH"])
+def mark_task_incomplete(task_id):
+    task = validate_model_instance(Task, task_id)
+
+    task.completed_at = None
+    response_body = {"task": task.to_dict()}
+
+    db.session.commit()
+    return make_response(jsonify(response_body), 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