Crow - Kathryn Bello

app/__init__.py

@@ -2,12 +2,18 @@
 from .db import db, migrate
 from .models import task, goal
 import os
+from .routes.task_routes import tasks_bp
+from .routes.goal_routes import goals_bp
+from dotenv import load_dotenv
 
 def create_app(config=None):
     app = Flask(__name__)
 
+    load_dotenv()
+
     app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False
     app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get('SQLALCHEMY_DATABASE_URI')
+    app.config['SLACK_API_TOKEN'] = os.environ.get('SLACK_API_TOKEN')
 
     if config:
         # Merge `config` into the app's configuration
@@ -16,7 +22,7 @@ def create_app(config=None):
 
     db.init_app(app)
     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,22 @@
-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")
+
+    @classmethod
+    def from_dict(cls, goal_data):
+        new_goal = Goal(title=goal_data["title"])
+
+        return new_goal
+
+    def to_dict(self):
+        goal_as_dict = {}
+        goal_as_dict["id"] = self.id
+        goal_as_dict["title"] = self.title
+
+        return goal_as_dict

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 typing import Optional
+from typing import TYPE_CHECKING 
+if TYPE_CHECKING: from .goal import Goal
 from ..db import db
+from datetime import datetime
 
 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] = None
+    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):
+        is_complete = task_data.get("is_complete")
+
+        if is_complete is True:
+            completed_at = datetime
+        else:
+            completed_at = None
+
+        new_task = Task(title=task_data["title"],
+                        description=task_data["description"],
+                        completed_at=completed_at)
+
+        return new_task
+
+    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
+        task_as_dict["is_complete"] = True if self.completed_at else False
+        if self.goal_id is not None:
+            task_as_dict["goal_id"] = self.goal_id
+        return task_as_dict

app/routes/goal_routes.py

@@ -1 +1,88 @@
-from flask import Blueprint
+from flask import Blueprint, request, make_response, Response, abort
+from app.models.goal import Goal
+from app.models.task import Task
+from app.routes.route_utilities import validate_model, create_model
+from app.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)
+
+@goals_bp.post("/<id>/tasks")
+def assign_tasks_to_goal(id):
+    resp_dict = {}
+    goal = validate_model(Goal, id)
+    request_body = request.get_json()
+
+    if "task_ids" not in request_body:
+        return {"details": "task_ids is required"}, 400
+
+    task_ids = request_body["task_ids"]
+    tasks = []
+    for task_id in task_ids:
+        task = validate_model(Task, task_id)
+        tasks.append(task)
+
+    goal.tasks = tasks
+    db.session.commit()
+
+    resp_dict["id"] = goal.id
+    resp_dict["task_ids"] = [task.id for task in goal.tasks]
+
+    return resp_dict, 200
+
+
+@goals_bp.get("")
+def get_all_goals():
+    query = db.select(Goal).order_by(Goal.id)
+    goals = db.session.scalars(query)
+
+    goal_response = [goal.to_dict() for goal in goals]
+    return goal_response, 200
+
+
+@goals_bp.get("/<id>")
+def get_goal_by_id(id):
+    goal = validate_model(Goal, id)
+
+    return goal.to_dict(), 200
+
+@goals_bp.get("/<id>/tasks")
+def get_goal_tasks(id):
+    goal = validate_model(Goal, id)
+
+    tasks = [task.to_dict() for task in goal.tasks] if goal.tasks else []
+
+    resp = {
+        "id": goal.id,
+        "title": goal.title,
+        "tasks": tasks
+    }
+
+    return resp, 200
+
+
+@goals_bp.put("/<id>")
+def update_goal(id):
+    goal = validate_model(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("/<id>")
+def delete_goal_by_id(id):
+    goal = validate_model(Goal, id)
+
+    db.session.delete(goal)
+    db.session.commit()
+
+    return Response(status=204, mimetype="application/json")

app/routes/route_utilities.py

@@ -0,0 +1,52 @@
+from flask import make_response, Response, abort
+from app.db import db
+import requests
+import os
+
+def validate_model(cls, model_id):
+    try:
+        model_id = int(model_id)
+    except Exception:
+        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 Exception as e:
+        response = {"details": f"Invalid request: missing {e.args[0]}"}
+        abort(make_response(response, 400))
+
+    db.session.add(new_model)
+    db.session.commit()
+
+    return new_model.to_dict(), 201
+
+def send_slack_notification(task_title):
+    url = "https://slack.com/api/chat.postMessage"
+    token = os.environ.get("SLACK_API_TOKEN")
+
+    payload = {
+        "channel": "C09QW7ZQ8CX", 
+        "text": f"Someone just completed the task {task_title}"
+    }
+
+    headers = {
+        'Authorization': f'Bearer {token}',
+        'Content-Type': 'application/json'
+    }
+    try:
+        response = requests.post(url, headers=headers, json=payload)
+        print(response.json())
+        return response.json()
+    except Exception as e:
+        return {"details": f"Failed to send slack message {e}"}

app/routes/task_routes.py

@@ -1 +1,88 @@
-from flask import Blueprint
+from flask import Blueprint, request, make_response, Response, abort
+from app.models.task import Task
+from app.db import db
+from sqlalchemy import desc, asc
+from datetime import datetime
+from app.routes.route_utilities import validate_model, create_model, send_slack_notification
+
+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)
+
+
+@tasks_bp.get("")
+def get_all_tasks():
+    sort_param = request.args.get("sort")
+    query = db.select(Task)
+    if sort_param:
+        if sort_param == "asc":
+            query = query.order_by(asc(Task.title))
+        elif sort_param == "desc":
+            query = query.order_by(desc(Task.title))
+        elif sort_param != "asc" and sort_param != "desc":
+            response = {"details": "Invalid request: sort only accepts asc or desc."}
+            abort(make_response(response, 400))
+    else:
+        query = query.order_by(Task.id)
+
+    tasks = db.session.scalars(query)
+    task_response = [task.to_dict() for task in tasks]
+
+    return task_response, 200
+
+
+@tasks_bp.get("/<id>")
+def get_task_by_id(id):
+    task = validate_model(Task, id)
+
+    return task.to_dict(), 200
+
+
+@tasks_bp.put("/<id>")
+def update_task(id):
+    task = validate_model(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.patch("/<id>/mark_complete")
+def mark_task_complete(id):
+    task = validate_model(Task, id)
+
+    now = datetime.now()
+    task.completed_at = now
+    db.session.commit()
+
+    send_slack_notification(task.title)
+
+    return Response(status=204, mimetype="application/json")
+
+
+@tasks_bp.patch("/<id>/mark_incomplete")
+def mark_task_incomplete(id):
+    task = validate_model(Task, id)
+
+    task.completed_at = None
+    db.session.commit()
+
+    return Response(status=204, mimetype="application/json")
+
+
+@tasks_bp.delete("/<id>")
+def delete_task_by_id(id):
+    task = validate_model(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