QT_task-list-api

app/__init__.py

@@ -1,7 +1,12 @@
 from flask import Flask
 from .db import db, migrate
 from .models import task, goal
+from .routes.task_routes import tasks_bp
+from .routes.goal_routes import goals_bp
 import os
+from dotenv import load_dotenv
+load_dotenv()
+
 
 def create_app(config=None):
     app = Flask(__name__)
@@ -18,5 +23,7 @@ def create_app(config=None):
     migrate.init_app(app, db)
 
     # Register Blueprints here
+    app.register_blueprint(tasks_bp)
+    app.register_blueprint(goals_bp)
 
     return app

app/models/goal.py

@@ -1,5 +1,21 @@
-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(back_populates="goal")
+
+    @classmethod
+    def from_dict(cls, goal_data):
+        new_goal = cls(title=goal_data["title"])
+        return new_goal
+
+    def to_dict(self):
+        goal_as_dict = {
+            "id": self.id,
+            "title": self.title
+            }
+
+        return goal_as_dict

app/models/task.py

@@ -1,5 +1,46 @@
-from sqlalchemy.orm import Mapped, mapped_column
+from sqlalchemy.orm import Mapped, mapped_column, relationship
+from sqlalchemy import ForeignKey
+from datetime import datetime, UTC
+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[Optional[datetime]] = mapped_column(nullable=True)
+    goal_id: Mapped[Optional[int]] = mapped_column(ForeignKey("goal.id"))
+    goal: Mapped[Optional["Goal"]] = relationship(back_populates="tasks")
+
+    @classmethod
+    def from_dict(cls, task_data):
+        goal_id = task_data.get("goal_id")
+        new_task = cls(
+            title=task_data["title"],
+            description=task_data["description"],
+            completed_at=datetime.utcnow() if task_data.get("is_complete") else None,
+            goal_id = goal_id
+            )
+
+        return new_task
+
+    def to_dict(self):
+        task_as_dict = {
+            "id": self.id,
+            "title": self.title,
+            "description": self.description,
+            "is_complete": bool(self.completed_at),
+        }
+
+        if self.goal_id:
+            task_as_dict["goal_id"] = self.goal_id
+
+        return task_as_dict
+
+
+    def mark_complete(self):
+        self.completed_at = datetime.now(UTC)
+
+    def mark_incomplete(self):
+        self.completed_at = None

app/routes/goal_routes.py

@@ -1 +1,85 @@
-from flask import Blueprint
+from flask import Blueprint, abort, make_response, request, Response
+from app.models.goal import Goal
+from app.models.task import Task
+from .route_utilities import validate_model, create_model
+from ..db import db
+
+goals_bp = Blueprint("goals_bp", __name__, url_prefix="/goals")
+
+@goals_bp.post("")
+def create_goal():
+    request_body = request.get_json()
+    return create_model(Goal, request_body, "goal")
+
+@goals_bp.get("")
+def get_all_goals():
+    query = db.select(Goal)
+
+    title_param = request.args.get("title")
+    if title_param:
+        query = query.where(Goal.name.ilike(f"%{title_param}%"))
+
+    goals = db.session.scalars(query)
+    goals_response = []
+    for goal in goals:
+        goals_response.append(goal.to_dict())
+
+    return goals_response
+
+
+@goals_bp.get("/<goal_id>")
+def get_one_goal(goal_id):
+    goal = validate_model(Goal, goal_id)
+
+    return {"goal": goal.to_dict()}
+
+
+@goals_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")
+
+
+@goals_bp.delete("/<goal_id>")
+def delete_goal(goal_id):
+    goal = validate_model(Goal, goal_id)
+    db.session.delete(goal)
+    db.session.commit()
+
+    return Response(status=204, mimetype="application/json")
+
+
+@goals_bp.post("/<goal_id>/tasks")
+def post_task_ids_to_goal(goal_id):
+    goal = validate_model(Goal, goal_id)
+
+    request_body = request.get_json()
+    task_ids = request_body.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
+
+
+@goals_bp.get("/<goal_id>/tasks")
+def get_tasks_for_one_goal(goal_id):
+    goal = validate_model(Goal, goal_id)
+
+    task_list = [task.to_dict() for task in goal.tasks]
+
+    response = {
+        "id": goal.id,
+        "title": goal.title,
+        "tasks": task_list
+    }
+    return response, 200

app/routes/route_utilities.py

@@ -0,0 +1,69 @@
+from flask import abort, make_response
+from ..db import db
+import logging
+import requests
+import os
+from dotenv import load_dotenv
+
+load_dotenv()
+
+
+def validate_model(cls, model_id):
+    try:
+        model_id = int(model_id)
+    except:
+        response = {"message": 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 = {"message": f"{cls.__name__} {model_id} not found"}
+        abort(make_response(response, 404))
+
+    return model
+
+
+logger = logging.getLogger(__name__)
+
+
+def chat_post_message(task):
+    token = os.environ.get('SLACK_BOT_TOKEN')
+    channel = os.environ.get('SLACK_CHANNEL_ID')
+
+    try:
+        response = requests.post(
+            "https://slack.com/api/chat.postMessage",
+            headers={
+                "Authorization": f"Bearer {token}",
+                "Content-Type": "application/json"
+            },
+
+            json={
+                "channel": channel,
+                "text": f"Someone just completed the task {task.title}"
+            }
+        )
+        if response.status_code == 200 and response.json().get("ok"):
+            logger.info("Slack message sent successfully.")
+        else:
+            logger.error(f"Slack API error: {response.json()}")
+    except Exception as e:
+        logger.error(f"Failed to send Slack message: {e}")
+
+
+def create_model(cls, model_data, response_key):
+    try:
+        new_model = cls.from_dict(model_data)
+
+    except KeyError:
+        response = {"details": "Invalid data"}
+        abort(make_response(response, 400))
+
+    db.session.add(new_model)
+    db.session.commit()
+
+    return {response_key: new_model.to_dict()}, 201
+
+

app/routes/task_routes.py

@@ -1 +1,85 @@
-from flask import Blueprint
+from flask import Blueprint, abort, make_response, request, Response
+from app.models.task import Task
+from .route_utilities import validate_model, chat_post_message, create_model
+from sqlalchemy import asc, desc
+from ..db import db
+
+tasks_bp = Blueprint("tasks_bp", __name__, url_prefix="/tasks")
+
+@tasks_bp.post("")
+def create_task():
+    request_body = request.get_json()
+    return create_model(Task, request_body, "task")
+
+
+@tasks_bp.get("")
+def get_all_tasks():
+    query = db.select(Task)
+
+    title_param = request.args.get("title")
+    if title_param:
+        query = query.where(Task.title.ilike(f"%{title_param}%"))
+
+    sort_param = request.args.get("sort")
+    if sort_param:
+        if sort_param.lower() == "asc":
+            query = query.order_by(asc(Task.title))
+        elif sort_param.lower() == "desc":
+            query = query.order_by(desc(Task.title))
+
+    query = query.order_by(Task.id)
+
+    tasks = db.session.scalars(query)
+
+    tasks_response = []
+    for task in tasks:
+        tasks_response.append(task.to_dict())
+    return tasks_response
+
+
+@tasks_bp.get("/<task_id>")
+def get_one_task(task_id):
+    task = validate_model(Task, task_id)
+
+    return {"task": task.to_dict()}
+
+
+@tasks_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")
+
+
+@tasks_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")
+
+
+@tasks_bp.patch("/<task_id>/mark_complete")
+def mark_task_complete(task_id):
+    task = validate_model(Task, task_id)
+    task.mark_complete()
+    db.session.commit()
+
+    chat_post_message(task)
+
+    return Response(status=204, mimetype="application/json")
+
+@tasks_bp.patch("/<task_id>/mark_incomplete")
+def mark_task_incomplete(task_id):
+    task = validate_model(Task, task_id)
+
+    task.mark_incomplete()
+    db.session.commit()
+
+    return Response(status=204, mimetype="application/json")

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