Possum - Makiko

app/__init__.py

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

app/models/goal.py

@@ -1,5 +1,34 @@
-from sqlalchemy.orm import Mapped, mapped_column
+from sqlalchemy.orm import Mapped, mapped_column, relationship
+from sqlalchemy import String
+from typing import TYPE_CHECKING
 from ..db import db
 
+if TYPE_CHECKING:
+    from .task import Task
+
 class Goal(db.Model):
     id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True)
+    title: Mapped[str] = mapped_column(String(255))
+    tasks: Mapped[list["Task"]] = relationship(back_populates="goal")
+
+    def to_dict(self, include_tasks=False, ids_only=False):
+        if ids_only:
+            return {
+                    "id": self.id,
+                    "task_ids": [task.id for task in self.tasks]
+            }
+
+        goal_as_dict = {
+            "id": self.id,
+            "title": self.title,
+        }
+
+        if include_tasks:
+            goal_as_dict["tasks"] = [task.to_dict() for task in self.tasks]
+
+        return goal_as_dict
+
+    @classmethod
+    def from_dict(cls, goal_dict):
+        new_goal = cls(title=goal_dict["title"])
+        return new_goal

app/models/task.py

@@ -1,5 +1,35 @@
-from sqlalchemy.orm import Mapped, mapped_column
+from sqlalchemy.orm import Mapped, mapped_column, relationship
+from sqlalchemy import String, ForeignKey
+from datetime import datetime
+from typing import Optional, TYPE_CHECKING
 from ..db import db
 
+if TYPE_CHECKING:
+    from .goal import Goal
 class Task(db.Model):
     id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True)
+    title: Mapped[str]= mapped_column(String(255))
+    description: Mapped[str] 
+    completed_at: Mapped[Optional[datetime]] 
+    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": self.id,
+            "title": self.title,
+            "description": self.description,
+            "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
+
+    @classmethod
+    def from_dict(cls,task_dict):
+        return cls(   
+            title=task_dict["title"],
+            description=task_dict["description"],
+            )

app/routes/goal_routes.py

@@ -1 +1,60 @@
-from flask import Blueprint
+from flask import Blueprint, request, abort, make_response, Response
+from .route_utilities import validate_model, create_model, update_model, get_models_with_filters
+from ..models.goal import Goal
+from ..models.task import Task
+from app.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.post("/<goal_id>/tasks")
+def create_task_with_goal(goal_id):
+    goal = validate_model(Goal, goal_id)
+    request_body = request.get_json()
+
+    try:
+        task_ids = request_body["task_ids"]
+    except KeyError:
+        invalid_msg = {"details": "Invalid data"}
+        abort(make_response(invalid_msg, 400))
+
+    tasks = [validate_model(Task, task_id) for task_id in task_ids]
+
+    goal.tasks = tasks
+    db.session.commit()
+
+    return goal.to_dict(ids_only=True)
+
+@bp.get("")
+def get_all_goals():
+    return get_models_with_filters(Goal, filters=request.args)
+
+@bp.get("/<goal_id>")
+def get_one_goal(goal_id):
+    goal = validate_model(Goal, goal_id)
+
+    return goal.to_dict()
+
+@bp.get("/<goal_id>/tasks")
+def get_tasks_by_goal(goal_id):
+    goal = validate_model(Goal, goal_id)
+
+    return goal.to_dict(include_tasks=True)
+
+@bp.put("/<goal_id>")
+def update_goal(goal_id):
+    required_keys = ["title"]
+    return update_model(Goal, goal_id, required_keys)
+
+@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")

app/routes/home_routes.py

@@ -0,0 +1,8 @@
+from flask import Blueprint
+
+bp = Blueprint("home_bp", __name__)
+
+
+@bp.get("/")
+def home_page():
+    return "<h1>✨Welcome to Makiko’s Task List API✨</h1>"

app/routes/route_utilities.py

@@ -0,0 +1,74 @@
+from flask import abort, make_response, Response, request
+from ..db import db
+
+def validate_model(cls,model_id):
+    try:
+        model_id = int(model_id)
+    except ValueError:
+        invalid = {"message": f"{cls.__name__} ({model_id}) is invalid."}
+        abort(make_response(invalid, 400))
+
+    query = db.select(cls).where(cls.id == model_id)
+    model = db.session.scalar(query)
+
+    if not model:
+        not_found = {"message" : f"{cls.__name__} ({model_id}) is not found."}  
+        abort(make_response(not_found, 404))
+
+    return model
+
+def create_model(cls, model_data):
+    try:
+        new_model =cls.from_dict(model_data)
+    except KeyError as error:
+        invalid_msg = {"details": "Invalid data"}
+        abort(make_response(invalid_msg, 400))
+
+    db.session.add(new_model)
+    db.session.commit()
+
+    return new_model.to_dict(), 201
+
+def update_model(cls, model_id, required_keys): 
+    model = validate_model(cls, model_id)
+    request_body = request.get_json()
+
+    for key in required_keys:
+        if key not in request_body:
+            invalid_msg = {"details": "Invalid data"}
+            abort(make_response(invalid_msg, 400))
+
+    for key in required_keys:
+        setattr(model,key,request_body[key])
+
+    db.session.commit()
+
+    return Response(status=204, mimetype="application/json")
+
+def get_models_with_filters(cls, filters=None):
+    query = db.select(cls)
+
+    if filters:
+        for attribute, value in filters.items():
+            if attribute == "sort":
+                query = apply_sort_to_query(cls, query, value)
+            elif hasattr(cls, attribute):
+                query = query.where(getattr(cls, attribute).ilike(f"%{value}%"))
+
+    models = db.session.scalars(query.order_by(cls.id))
+    models_response = [model.to_dict() for model in models]
+    return models_response
+
+def apply_sort_to_query(cls, query, sort_type):
+    valid_sort = {
+        "asc": cls.title,
+        "desc": cls.title.desc()
+    }
+    sort_type = sort_type.casefold().strip()
+
+    if sort_type not in valid_sort:
+        invalid_msg = {"message": "Invalid sort value. Valid options: asc, desc."}
+        abort(make_response(invalid_msg, 400))
+
+    return query.order_by(valid_sort[sort_type])
+

app/routes/task_routes.py

@@ -1 +1,57 @@
-from flask import Blueprint
+from flask import Blueprint, request, Response
+from .route_utilities import validate_model, create_model, get_models_with_filters, update_model
+from datetime import datetime
+from app.models.task import Task
+from app.services.slack_service import send_msg_slack
+from app.db import db
+
+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, filters=request.args)
+
+@bp.get("/<task_id>")
+def get_one_task(task_id):
+    task = validate_model(Task,task_id)
+
+    return task.to_dict()
+
+@bp.put("/<task_id>")
+def update_task(task_id):
+    required_keys = ["title", "description"]
+    return update_model(Task, task_id, required_keys)
+
+@bp.patch("/<task_id>/mark_complete")
+def mark_complete_task(task_id):
+    task = validate_model(Task, task_id)
+    task.completed_at = datetime.now()
+
+    db.session.commit()
+
+    send_msg_slack(task)
+
+    return Response(status=204, mimetype="application/json")
+
+@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()
+
+    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")

app/services/slack_service.py

@@ -0,0 +1,19 @@
+import os
+import requests
+
+
+SLACK_URL = "https://slack.com/api/chat.postMessage"
+SLACK_API_KEY = os.environ.get('SLACK_API_KEY')
+
+def send_msg_slack(task):
+    json_body = {
+        "channel": "C09N95RPR34",
+        "text": f"Someone just completed the task {task.title}"
+    }
+
+    headers = {
+        "Authorization": f"Bearer {SLACK_API_KEY}",
+        "Content-Type": "application/json"
+    }
+
+    requests.post(SLACK_URL, json=json_body, headers=headers)

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