Sea Turtles - Esther Annorzie

Procfile

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

ada-project-docs/wave_01.md

@@ -136,7 +136,7 @@ As a client, I want to be able to make a `GET` request to `/tasks/1` when there
 
 As a client, I want to be able to make a `PUT` request to `/tasks/1` when there is at least one saved task with this request body:
 
-```json
+```jso
 {
   "title": "Updated Task Title",
   "description": "Updated Test Description",

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 bp
+    app.register_blueprint(bp)
 
+    from .goal_routes import bp
+    app.register_blueprint(bp)
+
     return app

app/goal_routes.py

@@ -0,0 +1,84 @@
+from flask import Blueprint, jsonify, make_response, request
+from app.models.task import Task
+from app.models.goal import Goal
+from .routes_helper import get_record_by_id, abort_message
+from app import db
+
+
+bp = Blueprint("goals", __name__, url_prefix="/goals")
+
+
+@bp.route("", methods=("POST",))
+def create_goal():
+    request_body = request.get_json()
+    if "title" not in request_body:
+        abort_message("Missing title", 400)
+
+    goal = Goal.from_dict(request_body)
+    db.session.add(goal)
+    db.session.commit()
+
+    return make_response(jsonify({"goal": goal.to_dict()}), 201)
+
+
+@bp.route("/<goal_id>/tasks", methods=("POST",))
+def add_tasks_to_goal(goal_id):
+    goal = get_record_by_id(goal_id)
+    request_body = request.get_json()
+
+    tasks_list = []
+    for task_id in request_body["task_ids"]:
+        task = get_record_by_id(task_id)
+        task.goal = goal
+        tasks_list.append(task.task_id)
+
+    db.session.commit()
+    return make_response(jsonify({"id": goal.goal_id, 
+    "task_ids": tasks_list}))
+
+
+@bp.route("/<goal_id>", methods=("GET",))
+def read_goal(goal_id):
+    goal = get_record_by_id(goal_id)
+    return make_response(jsonify({"goal": goal.to_dict()}))
+
+
+@bp.route("", methods=("GET",))
+def read_all_goals():
+    goals = Goal.query.all()
+    goals_response = [goal.to_dict() for goal in goals]
+    return make_response(jsonify(goals_response))
+
+
+@bp.route("/<goal_id>/tasks", methods=("GET",))
+def read_specific_goal_tasks(goal_id):
+    goal = get_record_by_id(goal_id)
+
+    goal_tasks = [Task.to_dict(task) for task in goal.tasks]
+
+    return make_response(jsonify({
+        "id": goal.goal_id, 
+        "title": goal.title, 
+        "tasks": goal_tasks})
+    )
+
+
+@bp.route("/<goal_id>", methods=("PUT",))
+def replace_goal(goal_id):
+    goal = get_record_by_id(Goal, goal_id)
+    request_body = request.get_json()
+    if "title" not in request_body:
+        abort_message("Title not found", 404)
+    goal.override_goal(request_body)
+    db.session.commit()
+
+    return jsonify({"goal": goal.to_dict()})
+
+
+@bp.route("/<goal_id>", methods=("DELETE",))
+def delete_goal(goal_id):
+    goal = get_record_by_id(goal_id)
+    db.session.delete(goal)
+    db.session.commit()
+
+    abort_message(f'Goal {goal_id} "{goal.title}" successfully deleted')

app/models/goal.py

@@ -3,3 +3,23 @@
 
 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")
+
+
+    @classmethod
+    def from_dict(cls, data_dict):
+        return cls(
+            title=data_dict["title"]
+        )
+
+
+    def to_dict(self):
+        return dict(
+            id=self.goal_id,
+            title=self.title
+        )
+
+
+    def override_goal(self, data_dict):
+        self.title = data_dict["title"]

app/models/task.py

@@ -3,3 +3,35 @@
 
 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):
+        response_dict = dict(
+                id=self.task_id,
+                title=self.title,
+                description=self.description,
+                is_complete=self.completed_at is not None
+            )
+
+        if self.goal_id:
+            response_dict["goal_id"] = self.goal_id
+
+        return response_dict
+
+    # create similar functions for task and goal, class for creation
+    @classmethod
+    def from_dict(cls, data_dict):
+        return cls(
+                title=data_dict["title"],
+                description=data_dict["description"],
+                completed_at = data_dict.get("completed_at", None)
+            )
+
+    def override_task(self, data_dict):
+        self.title = data_dict["title"]
+        self.description = data_dict["description"]

app/routes_helper.py

@@ -0,0 +1,46 @@
+from flask import make_response, abort
+from app.models.task import Task
+from app.models.goal import Goal
+
+
+def get_task_by_id(task_id):
+    try:
+        task_id = int(task_id)
+    except:
+        abort_message("Invalid data", 400)
+
+    task = Task.query.get(task_id)
+
+    if not task:
+        abort_message("Task not found", 404)
+    return task
+
+
+def get_goal_by_id(goal_id):
+    try:
+        goal_id = int(goal_id)
+    except:
+        abort_message("Invalid data", 400)
+
+    goal = Goal.query.get(goal_id)
+
+    if not goal:
+        abort_message("Goal not found", 404)
+    return goal
+
+
+def get_record_by_id(cls, record_id):
+    try:
+        record_id = int(record_id)
+    except:
+        abort_message("Invalid data", 400)
+
+    record = cls.query.get(record_id)
+
+    if not record:
+        abort_message(f"{type(cls).__name__} not found", 404)
+    return record
+
+
+def abort_message(details_info, status_code=200):
+    abort(make_response({"details": details_info}, status_code))

app/task_routes.py

@@ -0,0 +1,93 @@
+from flask import Blueprint, jsonify, make_response, request
+from app.models.task import Task
+from .routes_helper import abort_message, get_record_by_id, create_message
+from app import db
+from datetime import datetime
+import requests, os
+
+
+bp = Blueprint("tasks", __name__, url_prefix="/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:
+        create_message("Title or description missing", 400)
+    task = Task.from_dict(request_body)
+    db.session.add(task)
+    db.session.commit()
+
+    return make_response(jsonify({"task": task.to_dict()}), 201)
+
+
+@bp.route("/<task_id>", methods=("GET",))
+def read_one_task(task_id):
+    task = get_record_by_id(task_id)
+    return make_response(jsonify({"task": task.to_dict()}))
+
+
+@bp.route("", methods=("GET",))
+def read_all_tasks():
+    title_query = request.args.get("sort")
+
+    if title_query == "asc":
+        tasks = Task.query.order_by(Task.title.asc())
+    elif title_query == "desc":
+        tasks = Task.query.order_by(Task.title.desc())
+    else:
+        tasks = Task.query.all()
+
+    tasks_response = [task.to_dict() for task in tasks]
+
+    return make_response(jsonify(tasks_response))
+
+
+@bp.route("/<task_id>", methods=("PUT",))
+def replace_task(task_id):
+    task = get_record_by_id(task_id)
+    request_body = request.get_json()
+    if "title" not in request_body:
+        abort_message("Title missing", 404)
+    if "description" not in request_body:
+        abort_message("Description missing", 404)
+
+    task.override_task(request_body)
+    db.session.commit()
+
+    return jsonify({"task": task.to_dict()})
+
+
+@bp.route("/<task_id>", methods=("DELETE",))
+def delete_task(task_id):
+    task = get_record_by_id(task_id)
+    db.session.delete(task)
+    db.session.commit()
+
+    create_message(f'Task {task_id} "{task.title}" successfully deleted')
+
+
+@bp.route("/<task_id>/mark_complete", methods=("PATCH",))
+def mark_task_complete(task_id):
+    task = get_record_by_id(task_id)
+    task.completed_at = datetime.utcnow()
+    db.session.commit()
+
+    requests.post(
+        url="https://slack.com/api/chat.postMessage", 
+        data={
+            "channel": "task-notifications", 
+            "text": f"Someone just completed the task {task.title}"
+        }, 
+        headers={"Authorization": os.environ.get("token")}, 
+    )
+
+    return jsonify({"task": task.to_dict()})
+
+
+@bp.route("/<task_id>/mark_incomplete", methods=("PATCH",))
+def mark_task_incomplete(task_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