C24 Crow Iris Cheung task_list_api

app/__init__.py

@@ -1,5 +1,7 @@
 from flask import Flask
 from .db import db, migrate
+from .routes.task_routes import bp as tasks_bp
+from .routes.goal_routes import bp as goals_bp
 from .models import task, goal
 import os
 
@@ -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(goals_bp)
 
     return app

app/models/goal.py

@@ -1,5 +1,24 @@
-from sqlalchemy.orm import Mapped, mapped_column
+from sqlalchemy.orm import Mapped, mapped_column, relationship
 from ..db import db
+from typing import TYPE_CHECKING
+if TYPE_CHECKING:
+    from .task import Task
 
 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")
+
+    def to_dict(self):
+        goal_as_dict={}
+        goal_as_dict["id"] = self.id
+        goal_as_dict["title"] = self.title
+        # goal_as_dict["task_ids"] = [task.id for task in self.tasks]
+        # goal_as_dict["tasks"] = self.tasks
+        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,40 @@
-from sqlalchemy.orm import Mapped, mapped_column
+from sqlalchemy.orm import Mapped, mapped_column, relationship
+from sqlalchemy import ForeignKey
 from ..db import db
+from datetime import datetime
+from typing import Optional, TYPE_CHECKING
+if TYPE_CHECKING:
+    from .goal import Goal
+
 
 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, default=None)
+    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={}
+        task_as_dict["id"] = self.id
+        task_as_dict["title"] = self.title
+        task_as_dict["description"] = self.description
+        if self.completed_at:
+            task_as_dict["is_complete"] = True
+        elif not self.completed_at or self.completed_at == None:
+            task_as_dict["is_complete"] = False
+        if self.goal_id is not None:
+            task_as_dict["goal_id"] = self.goal_id
+
+        return task_as_dict
+
+    @classmethod
+    def from_dict(cls, task_data):
+        new_task = cls(title=task_data["title"],
+                    description=task_data["description"],
+                    completed_at=None,
+                    goal_id=task_data.get("goal_id")
+                    )
+        return new_task

app/routes/goal_routes.py

@@ -1 +1,95 @@
-from flask import Blueprint
+from flask import Blueprint, Response, request
+from app.models.goal import Goal
+from app.models.task import Task
+from ..routes.route_utilities import validate_model, create_model
+from ..db import db
+
+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_goal():
+
+    query = db.select(Goal)
+
+    title_param = request.args.get("title")
+    if title_param:
+        query = query.where(Goal.title.ilike(f"%{title_param}%"))
+
+    goals = db.session.scalars(query.order_by(Goal.id))
+
+    goals_response = []
+    for goal in goals:
+        goals_response.append(goal.to_dict())
+    return goals_response
+
+@bp.get("/<goal_id>")
+def get_one_goal(goal_id):
+    goal = validate_model(Goal, goal_id)
+    return goal.to_dict()
+
+@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)
+    db.session.delete(goal)
+    db.session.commit()
+
+    return Response(status=204, mimetype="application/json")
+
+@bp.post("/<goal_id>/tasks")
+def create_task_by_goal(goal_id):
+    goal = validate_model(Goal, goal_id)
+    if goal.tasks:
+        for task in goal.tasks:
+            task.goal_id = None
+            db.session.commit()
+
+    request_body = request.get_json()
+    for id in request_body["task_ids"]:
+        query = db.select(Task).where(Task.id == id)
+        task = db.session.scalar(query)
+        task.goal_id = goal_id
+
+    db.session.commit()
+
+    response = goal.to_dict()
+    result = {
+        "id": response.get("id"),
+        "task_ids": [task.id for task in goal.tasks]
+    }
+    return result, 200
+
+
+@bp.get("/<goal_id>/tasks")
+def get_task_by_goal(goal_id):
+    goal = validate_model(Goal, goal_id)
+    response = goal.to_dict()
+
+    result = {
+        "id":response.get("id"),
+        "title":response.get("title"),
+        "tasks":[task.to_dict() for task in goal.tasks]
+    }
+
+    return result, 200
+
+
+
+
+
+

app/routes/route_utilities.py

@@ -0,0 +1,33 @@
+from flask import abort, make_response
+
+from ..db import db
+
+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
+
+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
+

app/routes/task_routes.py

@@ -1 +1,98 @@
-from flask import Blueprint
+from flask import Blueprint, Response, request
+import requests
+from app.models.task import Task
+from datetime import datetime
+from ..routes.route_utilities import validate_model, create_model
+from ..db import db
+import os
+
+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_task():
+
+    query = db.select(Task)
+
+    title_param = request.args.get("title")
+    if title_param:
+        query = query.where(Task.title.ilike(f"%{title_param}%"))
+
+    description_param = request.args.get("description")
+    if description_param:
+        query = query.where(Task.description.ilike(f"%{description_param}%"))
+
+    complete_param = request.args.get("is_completed")
+    if complete_param:
+        query = query.where(Task.completed_at == None)
+
+    sort_order = request.args.get("sort")
+    if sort_order == "asc":
+        tasks = db.session.scalars(query.order_by(Task.title.asc()))
+    elif sort_order == "desc":
+        tasks = db.session.scalars(query.order_by(Task.title.desc()))
+    else:
+        tasks = db.session.scalars(query.order_by(Task.id))
+
+    tasks_response = []
+    for task in tasks:
+        tasks_response.append(task.to_dict())
+    return tasks_response
+
+
+@bp.get("/<task_id>")
+def get_one_task(task_id):
+    task = validate_model(Task, task_id)
+    return task.to_dict()
+
+@bp.patch("/<task_id>/mark_complete")
+def update_completed_at_complete(task_id):
+    task = validate_model(Task, task_id)
+    task.completed_at = datetime.utcnow()
+
+    headers={"Authorization": os.environ.get('SLACKAUTHORIZATION')}
+    data = {"channel": "slack-api-testing",
+            "text": f"Someone just completed {task.title}"}
+
+    response=requests.post("https://slack.com/api/chat.postMessage",
+                        headers=headers,
+                        json=data)
+
+    db.session.commit()
+    return Response(status=204, mimetype="application/json")
+
+
+@bp.patch("/<task_id>/mark_incomplete")
+def update_completed_at_incomplete(task_id):
+    task = validate_model(Task, task_id)
+    task.completed_at = None
+
+    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"]
+    task.compelted_at = None
+
+    db.session.commit()
+
+    return Response(status=204, mimetype="application/json")
+
+@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")
+

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