C24 - Possum - Ekaterina Belova - Task list API

app/__init__.py

@@ -1,6 +1,8 @@
 from flask import Flask
 from .db import db, migrate
 from .models import task, goal
+from .routes.task_routes import bp as tasks_bp
+from .routes.goal_routes import bp as goal_bp
 import os
 
 def create_app(config=None):
@@ -18,5 +20,7 @@ def create_app(config=None):
     migrate.init_app(app, db)
 
     # Register Blueprints here
+    app.register_blueprint(tasks_bp)
+    app.register_blueprint(goal_bp)
 
     return app

app/models/goal.py

@@ -1,5 +1,20 @@
-from sqlalchemy.orm import Mapped, mapped_column
+from sqlalchemy.orm import Mapped, mapped_column, relationship
 from ..db import db
 
 class Goal(db.Model):
     id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True)
+    title: Mapped[str]
+    tasks: Mapped[list["Task"]] = relationship("Task", back_populates="goal")
+
+    def to_dict(self):
+        goal_as_dict = {
+            "id": self.id,
+            "title": self.title
+        }
+
+        return goal_as_dict
+
+    @classmethod
+    def from_dict(cls, goal_data):
+        new_goal = cls(title=goal_data["title"])
+        return new_goal

app/models/task.py

@@ -1,5 +1,32 @@
-from sqlalchemy.orm import Mapped, mapped_column
+from datetime import datetime
+from sqlalchemy.orm import Mapped, mapped_column, relationship
+from sqlalchemy import ForeignKey
+from typing import Optional 
 from ..db import db
 
 class Task(db.Model):
     id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True)
+    title: Mapped[str]
+    description: Mapped[str]
+    completed_at: Mapped[datetime | None] = mapped_column(nullable=True)
+    goal_id: Mapped[Optional[int]] = mapped_column(ForeignKey("goal.id"))
+    goal: Mapped[Optional["Goal"]] = relationship(back_populates="tasks")
+
+    def to_dict(self):
+        task_as_dict = {
+            "id": getattr(self, "id", None),
+            "title": getattr(self, "title", None),
+            "description": getattr(self, "description", None),
+            "is_complete": (self.completed_at is not None)
+        }
+        if self.goal:
+            task_as_dict["goal_id"] = self.goal_id
+        return task_as_dict
+
+    @classmethod
+    def from_dict(cls, dict):
+        return cls(
+            title=dict["title"],
+            description=dict["description"],
+            goal_id=dict.get("goal_id")
+        )

app/routes/goal_routes.py

@@ -1 +1,66 @@
-from flask import Blueprint
+from flask import Blueprint, Response, request
+from app import db
+from app.models.goal import Goal
+from app.models.task import Task
+from .route_utilities import create_model, get_models_with_filters, validate_model
+
+bp = Blueprint("goals_bp", __name__, url_prefix="/goals")
+
+@bp.post("")
+def create_goal():
+    request_body = request.get_json()
+    return create_model(Goal, request_body)
+
+@bp.get("")
+def get_all_goals():
+    return get_models_with_filters(Goal, request.args)
+
+@bp.get("/<goal_id>")
+def get_one_goal(goal_id):
+    goal = validate_model(Goal, goal_id)
+    return goal.to_dict(), 200
+
+@bp.put("/<goal_id>")
+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 Response(status=204, mimetype="application/json")
+
+@bp.delete("/<goal_id>")
+def delete_goal(goal_id):
+    goal = validate_model(Goal, goal_id)
+
+    for task in goal.tasks:
+        task.goal_id = None
+
+    db.session.delete(goal)
+    db.session.commit()
+    return Response(status=204, mimetype="application/json")
+
+@bp.post("/<goal_id>/tasks")
+def create_task_with_goal(goal_id):
+    goal = validate_model(Goal, goal_id)
+
+    data = request.get_json()
+    task_ids = data.get("task_ids")
+
+    goal.tasks = []
+
+    for task_id in task_ids:
+        task = validate_model(Task, task_id)
+        goal.tasks.append(task)
+
+    db.session.commit()
+
+    return {"id": goal.id, "task_ids": task_ids}, 200
+
+@bp.get("/<goal_id>/tasks")
+def get_tasks_by_goal(goal_id):
+    goal = validate_model(Goal, goal_id)
+    task_list = [task.to_dict() for task in goal.tasks]
+    return {"id": goal.id, "title": goal.title, "tasks": task_list}, 200

app/routes/route_utilities.py

@@ -0,0 +1,53 @@
+from flask import abort, make_response
+from ..db import db
+
+def validate_model(cls, model_id):
+    try:
+        model_id = int(model_id)
+    except:
+        response = {"details": f"{cls.__name__} {model_id} invalid"}
+        abort(make_response(response , 400))
+
+    query = db.select(cls).where(cls.id == model_id)
+    model = db.session.scalar(query)
+
+    if not model:
+        response = {"details": f"{cls.__name__} {model_id} not found"}
+        abort(make_response(response, 404))
+
+    return model
+
+def create_model(cls, model_data):
+    try:
+        new_model = cls.from_dict(model_data)
+
+    except KeyError as error:
+        response = {"details": "Invalid data"}
+        abort(make_response(response, 400))
+
+    db.session.add(new_model)
+    db.session.commit()
+
+    return new_model.to_dict(), 201
+
+def get_models_with_filters(cls, filters=None):
+    query = db.select(cls)
+    sort = None
+
+    if filters:
+        for attribute, value in filters.items():
+            if hasattr(cls, attribute):
+                query = query.where(getattr(cls, attribute).ilike(f"%{value}%"))
+        sort = filters.get("sort")
+
+    if sort:
+        if sort.lower() == "asc":
+            query = query.order_by(cls.title.asc())
+        elif sort.lower() == "desc":
+            query = query.order_by(cls.title.desc())
+    else:
+        query = query.order_by(cls.id.asc())
+
+    models = db.session.scalars(query)
+    models_response = [model.to_dict() for model in models]
+    return models_response

app/routes/task_routes.py

@@ -1 +1,96 @@
-from flask import Blueprint
+import os
+import requests
+
+from app import db
+from app.models.task import Task
+from datetime import datetime
+from flask import Blueprint, Response, request
+from app.routes.route_utilities import create_model, get_models_with_filters, validate_model
+
+bp = Blueprint("tasks_bp", __name__, url_prefix="/tasks")
+
+@bp.post("")
+def create_task():
+    request_body = request.get_json()
+    return create_model(Task, request_body)
+
+@bp.get("")
+def get_all_tasks():
+    return get_models_with_filters(Task, request.args)
+
+@bp.delete("/<task_id>")
+def delete_task(task_id):
+    task = validate_model(Task, task_id)
+
+    db.session.delete(task)
+    db.session.commit()
+    return Response(status=204, mimetype="application/json")
+
+@bp.put("/<task_id>")
+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 Response(status=204, mimetype="application/json")
+
+@bp.get("/<task_id>")
+def get_one_task(task_id):
+    task = validate_model(Task, task_id)
+
+    return task.to_dict(), 200
+
+@bp.patch("/<task_id>/mark_complete")
+def patch_task(task_id):
+    task = validate_model(Task, task_id)
+
+    task.completed_at = datetime.now()
+
+    db.session.commit()
+
+    response = send_slack_message(None, f"Someone just completed the task {task.title}")
+
+    if response is not None:
+        # Slack may return 200 but contain { "ok": false } in the JSON body.
+        try:
+            ok = response.json().get("ok", False)
+        except ValueError:
+            ok = False
+
+        if response.status_code != 200 or not ok:
+            return Response(status=500, mimetype="application/json")
+
+    return Response(status=204, mimetype="application/json")
+
+@bp.patch("/<task_id>/mark_incomplete")
+def patch_task_incomplete(task_id):
+    task = validate_model(Task, task_id)
+
+    task.completed_at = None
+
+    db.session.commit()
+
+    return Response(status=204, mimetype="application/json")
+
+def send_slack_message(channel, text):
+
+    token = os.environ.get("SLACKBOT_TOKEN")
+
+    if channel is None:
+        channel = os.environ.get("SLACK_CHANNEL")
+
+    try:
+        return requests.post(
+            "https://slack.com/api/chat.postMessage", 
+            headers={"Authorization": f"Bearer {token}"}, 
+            json={
+                "channel": channel,
+                "text": text
+            }
+        )
+    except requests.RequestException:
+        return None

migrations/README

@@ -0,0 +1 @@
+Single-database configuration for Flask.

migrations/alembic.ini

@@ -0,0 +1,50 @@
+# 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,flask_migrate
+
+[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
+
+[logger_flask_migrate]
+level = INFO
+handlers =
+qualname = flask_migrate
+
+[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