Lia Gaetano task-list

Procfile

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

app/__init__.py

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

app/models/goal.py

@@ -3,4 +3,27 @@
 
 
 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", back_populates="goal", lazy=True)
+
+    def to_dict(self):
+        return {
+            "id": self.id,
+            "title": self.title
+        }
+
+    def tasks_to_dict(self):
+        tasks = [task.goals_to_dict() for task in self.tasks]
+        return {
+            "id": self.id,
+            "title": self.title,
+            "tasks": tasks
+        }
+
+    def update_from_dict(self, data):
+        # Loops through attributes provided by users
+        for key, value in data.items():
+            # Restricts to attributes that are columns
+            if key in Goal.__table__.columns.keys():
+                setattr(self, key, value)

app/models/task.py

@@ -3,4 +3,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, nullable=False)
+    description = db.Column(db.String)
+    completed_at = db.Column(db.DateTime)
+    goal_id = db.Column(db.Integer, db.ForeignKey('goal.id'), nullable=True)
+    goal = db.relationship("Goal", back_populates="tasks")
+
+    def check_if_completed(self):
+        if self.completed_at:
+            return True
+        return False
+
+    def to_dict(self):
+        return {
+            "id": self.id,
+            "title": self.title,
+            "description": self.description,
+            "is_complete": self.check_if_completed()
+        }
+
+    def goals_to_dict(self):
+        return {
+            "id": self.id,
+            "goal_id": self.goal_id,
+            "title": self.title,
+            "description": self.description,
+            "is_complete": self.check_if_completed()
+        }
+
+    def update_from_dict(self, data):
+        # Loops through attributes provided by user
+        for key, value in data.items():
+            # Restricts to attributes that are table columns
+            if key in Task.__table__.columns.keys():
+                setattr(self, key, value)

app/routes.py

@@ -1,2 +1,193 @@
-from flask import Blueprint
+from app import db
+from flask import Blueprint, request, abort, jsonify, make_response
+from datetime import datetime
+from dotenv import load_dotenv
+import os
+import requests
+from app.models.task import Task
+from app.models.goal import Goal
+from app.utils.route_wrappers import require_instance_or_404
 
+tasks_bp = Blueprint("tasks", __name__, url_prefix="/tasks")
+goals_bp = Blueprint("goals", __name__, url_prefix="/goals")
+
+@tasks_bp.route("", methods=["GET"])
+def get_tasks():
+    """
+    Retrieve all tasks. Allows for use of query parameters.
+    Returns JSON list of task dictionaries. """
+    query = Task.query # Base query
+
+    # Query params, adding to query where indicated
+    sort = request.args.get("sort")
+    if sort == "asc":
+        query = query.order_by(Task.title)
+    elif sort == "desc":
+        query = query.order_by(Task.title.desc())
+
+    query = query.all() # Final query
+
+    # Returns jsonified list of task dicionaries
+    return jsonify([task.to_dict() for task in query]), 200
+
+@tasks_bp.route("/<task_id>", methods=["GET"])
+@require_instance_or_404
+def get_task(task):
+    """Retrieve one stored task by id."""
+    if task.goal_id:
+        return jsonify({"task": task.goals_to_dict()}), 200
+    else:
+        return jsonify({"task": task.to_dict()}), 200
+
+@tasks_bp.route("", methods=["POST"])
+def post_task():
+    """Create a new task from JSON data."""
+    form_data = request.get_json()
+
+    # All fields must be provided
+    mandatory_fields = ["title", "description", "completed_at"]
+    for field in mandatory_fields:
+        if field not in form_data:
+            return jsonify({"details": "Invalid data"}), 400 
+
+    new_task = Task(
+        title=form_data["title"],
+        description=form_data["description"],
+        completed_at=form_data["completed_at"]
+    )
+
+    db.session.add(new_task)
+    db.session.commit()
+    return {"task": new_task.to_dict()}, 201
+
+@tasks_bp.route("/<task_id>", methods=["PUT"])
+@require_instance_or_404
+def put_task(task):
+    """Updates task by id."""
+    form_data = request.get_json()
+
+    # Updates object from form data
+    task.update_from_dict(form_data)
+    db.session.commit()
+
+    return {"task": task.to_dict()}, 200
+
+@tasks_bp.route("/<task_id>/mark_complete", methods=["PATCH"])
+@require_instance_or_404
+def update_task_to_complete(task):
+    """Updates task at particular id to completed using PATCH."""
+    # Make call to Slack API if task newly completed
+    if not task.check_if_completed():
+        slack_api_url = "https://slack.com/api/chat.postMessage"
+        headers = {"Authorization": "Bearer " + os.environ.get("SLACK_API_KEY")}
+        param_payload = {
+            "channel": "task-notifications", 
+            "text": f"Someone has just completed the task {task.title}"
+            }
+
+        try:
+            requests.post(slack_api_url, headers=headers, params=param_payload)
+
+        except Exception as e:
+            return f"Error posting message to Slack: {e}"
+
+    # Change task to completed in db
+    task.completed_at = datetime.now()
+    db.session.commit()
+
+    return {"task": task.to_dict()}, 200
+
+@tasks_bp.route("<task_id>/mark_incomplete", methods=["PATCH"])
+@require_instance_or_404
+def update_task_to_incomplete(task):
+    """Updates task at particular id to incomplete using PATCH."""
+    task.completed_at = None
+    db.session.commit()
+    return {"task": task.to_dict()}, 200
+
+@tasks_bp.route("/<task_id>", methods=["DELETE"])
+@require_instance_or_404
+def delete_task(task):
+    """Deletes task by id."""
+    db.session.delete(task)
+    db.session.commit()
+
+    return {
+        "details": f"Task {task.id} \"{task.title}\" successfully deleted"
+    }, 200
+
+@goals_bp.route("", methods=["GET"])
+def get_goals():
+    """Retrieve all stored goals."""
+    goals = Goal.query.all()
+
+    return jsonify([goal.to_dict() for goal in goals]), 200
+
+@goals_bp.route("/<goal_id>", methods=["GET"])
+@require_instance_or_404
+def get_goal(goal):
+    """Retrieve one stored goal by id."""
+    return jsonify({"goal": goal.to_dict()}), 200
+
+@goals_bp.route("", methods=["POST"])
+def create_goal():
+    """Create a new goal from JSON data."""
+    form_data = request.get_json()
+
+    if "title" not in form_data:
+        return jsonify({"details": "Invalid data"}), 400
+
+    new_goal = Goal(
+        title=form_data["title"]
+    )
+    db.session.add(new_goal)
+    db.session.commit()
+
+    return jsonify({"goal": new_goal.to_dict()}), 201
+
+@goals_bp.route("/<goal_id>", methods=["PUT"])
+@require_instance_or_404
+def update_goal(goal):
+    """Updates goal by id."""
+    form_data = request.get_json()
+
+    goal.update_from_dict(form_data)
+    db.session.commit()
+
+    return jsonify({"goal": goal.to_dict()}), 200
+
+@goals_bp.route("/<goal_id>", methods=["DELETE"])
+@require_instance_or_404
+def delete_goal(goal):
+    """Deletes goal by id."""
+    db.session.delete(goal)
+    db.session.commit()
+
+    return {
+        "details": f"Goal {goal.id} \"{goal.title}\" successfully deleted"
+    }, 200
+
+@goals_bp.route("/<goal_id>/tasks", methods=["POST"])
+@require_instance_or_404
+def post_tasks_related_to_goal(goal):
+    """Adds tasks to goal wiht id."""
+    form_data = request.get_json()
+
+    for task_id in form_data["task_ids"]:
+        query = Task.query.get(task_id)
+        if not query:
+            continue
+        goal.tasks.append(query)
+
+    db.session.commit()
+
+    return jsonify({
+        "id": goal.id,
+        "task_ids": [task.id for task in goal.tasks]
+    }), 200
+
+@goals_bp.route("/<goal_id>/tasks", methods=["GET"])
+@require_instance_or_404
+def get_tasks_related_to_goal(goal):
+    """Retrieves all tasks associated with goal id."""
+    return jsonify(goal.tasks_to_dict()), 200

app/utils/route_wrappers.py

@@ -0,0 +1,32 @@
+from functools import wraps
+from flask import jsonify
+from app.models.task import Task
+from app.models.goal import Goal
+
+def require_instance_or_404(endpoint):
+    """
+    Decorator to validate that a requested id of input data exists.
+    Returns JSON and 404 if not found."""
+    @wraps(endpoint) # Makes fn look like func to return
+    def fn(*args, **kwargs):
+        if "task_id" in kwargs:
+            task_id = kwargs.get("task_id", None)
+            task = Task.query.get(task_id)
+
+            if not task:
+                return jsonify(None), 404 # null
+
+            kwargs.pop("task_id")
+            return endpoint(*args, task=task, **kwargs)
+
+        elif "goal_id" in kwargs:
+            goal_id = kwargs.get("goal_id", None)
+            goal = Goal.query.get(goal_id)
+
+            if not goal:
+                return jsonify(None), 404
+
+            kwargs.pop("goal_id")
+            return endpoint(*args, goal=goal, **kwargs)
+
+    return fn

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