C22 Phoenix - Luqi Xie

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 tasks_bp
+from .routes.goal_routes import goals_bp
 import os
 
 def create_app(config=None):
@@ -18,5 +20,8 @@ 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,27 @@
-from sqlalchemy.orm import Mapped, mapped_column
+from sqlalchemy.orm import Mapped, mapped_column, relationship
 from ..db import db
+from typing import List, 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_to_dict = {
+            "id": self.id,
+            "title": self.title,
+            }
+
+        if self.tasks:
+            goal_to_dict["tasks"] = [task.to_dict() for task in self.tasks]
+
+        return goal_to_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,37 @@
-from sqlalchemy.orm import Mapped, mapped_column
+from sqlalchemy.orm import Mapped, mapped_column, relationship
+from sqlalchemy import DateTime, ForeignKey
+from datetime import datetime
 from ..db import db
+from typing import Optional
+from typing import 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(DateTime, 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_to_dict = {
+            "id": self.id,
+            "title": self.title,
+            "description": self.description,
+            "is_complete": self.completed_at is not None
+            }
+        if self.goal_id:
+            task_to_dict["goal_id"] = self.goal_id
+
+        return task_to_dict
+
+    @classmethod
+    def from_dict(cls, task_data):
+        return cls(
+            title=task_data["title"],
+            description=task_data["description"]
+
+        )

app/routes/goal_routes.py

@@ -1 +1,84 @@
-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 {"goal": create_model(Goal, request_body)}, 201
+
+
+@goals_bp.get("")
+def get_all_tasks():
+    query = db.select(Goal)
+    goals = db.session.scalars(query)
+
+    goals_response = []
+    for goal in goals:
+        goals_response.append(
+            {
+                "id": goal.id,
+                "title": goal.title
+            }
+        )
+    return goals_response
+
+@goals_bp.get("/<goal_id>")
+def get_single_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 {"goal": goal.to_dict()}, 200
+
+@goals_bp.delete("/<goal_id>")
+def delete_goal(goal_id):
+    goal = validate_model(Goal, goal_id)
+
+    db.session.delete(goal)
+    db.session.commit()
+
+    response = {"details": f'Goal {goal.id} "{goal.title}" successfully deleted'}
+    return response, 200
+
+
+@goals_bp.post("/<goal_id>/tasks")
+def create_task_with_goal_id(goal_id):
+    goal = validate_model(Goal, goal_id)
+    request_body = request.get_json()
+
+    task_ids = request_body["task_ids"]
+    for task_id in task_ids:
+        task = validate_model(Task, task_id)
+        goal.tasks.append(task)
+
+    db.session.commit()
+
+    response = {
+        "id": goal.id,
+        "task_ids": task_ids}
+    return response, 200
+
+@goals_bp.get("/<goal_id>/tasks")
+def get_tasks_by_goal(goal_id):
+    goal = validate_model(Goal, goal_id)
+
+    response = {
+        "id": goal.id,
+        "title": goal.title,
+        "tasks": [task.to_dict() for task in goal.tasks]
+    }
+    return response, 200

app/routes/route_utilities.py

@@ -0,0 +1,34 @@
+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()
+
+

app/routes/task_routes.py

@@ -1 +1,107 @@
-from flask import Blueprint
+import os
+from flask import Blueprint, abort, make_response,request, Response
+from app.models.task import Task
+from ..db import db
+from datetime import datetime
+from .route_utilities import validate_model, create_model
+import requests
+
+tasks_bp = Blueprint("tasks_bp", __name__, url_prefix = "/tasks")
+
+@tasks_bp.post("")
+def create_task():
+    request_body = request.get_json()
+    return {"task": create_model(Task, request_body)}, 201
+
+    # try:
+    #     new_task = Task.from_dict(request_body)
+
+    # except KeyError as error:
+    #     response = {"details": "Invalid data"}
+    #     abort(make_response(response, 400))
+
+    # db.session.add(new_task)
+    # db.session.commit()
+
+    # response = new_task.to_dict()
+    # return {"task": response}, 201
+
+@tasks_bp.patch("/<task_id>/mark_incomplete")
+def mark_incomplete_task(task_id):
+    task = validate_model(Task, task_id)
+    task.completed_at = None
+
+    db.session.commit()
+
+    response = task.to_dict()
+
+    return {"task": response}, 200 
+
+@tasks_bp.patch("/<task_id>/mark_complete")
+def mark_task_complete(task_id):
+    task = validate_model(Task, task_id)
+    task.completed_at = datetime.now()
+
+    db.session.commit()
+
+    response = task.to_dict()
+    url = "https://slack.com/api/chat.postMessage"
+    headers = {"Authorization": f"Bearer {os.environ.get('AUTHORIZATION_TOKEN')}"}
+    data = {
+    "channel": "task-notification",
+    "text": f"Someone just completed the task {task.title}"
+}
+
+    slack_response = requests.post(url, json=data, headers=headers)
+    return {"task": response}, 200
+
+
+@tasks_bp.get("")
+def get_all_tasks():
+    sort_title_param = request.args.get("sort", "asc")
+
+    if sort_title_param == "desc":
+        tasks = Task.query.order_by(Task.title.desc())
+    else:
+        tasks = Task.query.order_by(Task.title.asc())
+
+    task_response = [task.to_dict() for task in tasks]
+
+    return task_response, 200
+
+@tasks_bp.get("/<task_id>")
+def get_single_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"]
+
+    if request_body.get("is_complete"):
+        task.completed_at = datetime.now()
+    else:
+        task.completed_at = None
+
+    db.session.commit()
+
+    response = {"task": task.to_dict()}
+    return response, 200
+    # return Response(status=200, 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()
+
+    response = {"details": f'Task {task.id} "{task.title}" successfully deleted'}
+    return response, 200
+

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