Alice(TrangLe) Finish Task list API

app/__init__.py

@@ -1,22 +1,33 @@
 from flask import Flask
+from .routes.task_routes import bp as task_bp
+from .routes.goal_routes import bp as goal_bp
 from .db import db, migrate
 from .models import task, goal
 import os
 
+DB_URI = os.environ.get('SQLALCHEMY_DATABASE_URI')
+if (DB_URI is None):
+    print('DB_URI not found')
+
 def create_app(config=None):
     app = Flask(__name__)
 
+    # Register Blueprints here
+    app.register_blueprint(task_bp)
+    app.register_blueprint(goal_bp)
+
     app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False
     app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get('SQLALCHEMY_DATABASE_URI')
-
     if config:
         # Merge `config` into the app's configuration
         # to override the app's default settings for testing
         app.config.update(config)
 
+    print("Migrating db...")
     db.init_app(app)
     migrate.init_app(app, db)
 
     # Register Blueprints here
 
     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
 
 class Goal(db.Model):
     id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True)
+    title: Mapped[str]
+    description: Mapped[str | None]
+    tasks: Mapped[list["Task"]] = relationship(back_populates="goal")
+
+    def to_dict(self):
+        return {
+            'id': self.id,
+            'title': self.title,
+            'description': self.description,
+            'task_ids': [task.id for task in self.tasks],
+            'tasks': [ task.to_dict() for task in self.tasks]
+        }
+
+    @classmethod
+    def from_dict(cls, dict_data: dict):
+        goal = Goal(
+            id=dict_data.get("id"),
+            title=dict_data["title"],
+            description=dict_data.get("description"),
+        )
+        return goal
+

app/models/task.py

@@ -1,5 +1,32 @@
-from sqlalchemy.orm import Mapped, mapped_column
+from sqlalchemy.orm import Mapped, mapped_column, relationship
+from sqlalchemy import ForeignKey
 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[str | None]
+    goal_id: Mapped[int | None] = mapped_column(ForeignKey("goal.id"))
+    goal: Mapped["Goal"] = relationship(back_populates="tasks")
+
+    def to_dict(self):
+        return {
+            'id': self.id,
+            'title': self.title,
+            'description': self.description,
+            'is_complete': self.completed_at is not None,
+            "goal_id": self.goal_id
+        }
+
+    @classmethod
+    def from_dict(cls, dict_data: dict):
+        task = Task(
+            id=dict_data.get("id"),
+            title=dict_data["title"],
+            description=dict_data["description"],
+            completed_at=dict_data.get("completed_at")
+        )
+        return task
+
+

app/routes/goal_routes.py

@@ -1 +1,69 @@
-from flask import Blueprint
+from flask import Blueprint, abort, make_response, request, Response
+from .route_utilities import create_model, validate_model, get_models_with_filters
+from  app.models.goal import Goal
+from  app.models.task import Task
+from datetime import datetime
+from ..db import db
+from ..slack_api.post_message import post_message_with_slack_bot
+
+bp = Blueprint("goal_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_goals():
+    return get_models_with_filters(Goal, request.args)
+
+@bp.get("/<id>")
+def get_one_goal(id):
+    goal = validate_model(Goal, id)
+    return goal.to_dict()
+
+@bp.put("/<id>")
+def update_goal(id):
+    goal = validate_model(Goal, id)
+    request_body = request.get_json()
+    updated_goal = Goal.from_dict(request_body)
+    updated_goal.id = id
+    db.session.merge(updated_goal)
+    db.session.commit()
+
+    return Response(status=204, mimetype="application/json")
+
+@bp.delete("/<id>")
+def delect_goal(id):
+    goal = validate_model(Goal, id)
+    db.session.delete(goal)
+    db.session.commit()
+
+    return Response(status=204, mimetype="application/json")
+
+@bp.post("/<goal_id>/tasks")
+def add_task_to_goal(goal_id):
+    goal = validate_model(Goal, goal_id)
+    request_body = request.get_json()   
+    tasks = []
+    for task_id in request_body['task_ids']:
+        query = db.select(Task).where(Task.id == task_id)
+        tasks.append(db.session.scalar(query))
+    goal.tasks = tasks
+    db.session.merge(goal)
+    db.session.commit()
+    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()
+
+
+
+
+
+
+
+
+

app/routes/route_utilities.py

@@ -0,0 +1,45 @@
+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 = {"message": f"Invalid request: missing {error.args[0]}"}
+        abort(make_response(response, 400))
+
+    db.session.add(new_model)
+    db.session.commit()
+
+    return make_response(new_model.to_dict(), 201)
+
+
+def get_models_with_filters(cls, filters=None):
+    query = db.select(cls)   
+    if filters:
+        for attribute, value in filters.items():
+            if 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

app/routes/task_routes.py

@@ -1 +1,85 @@
-from flask import Blueprint
+from flask import Blueprint, abort, make_response, request, Response
+from ..slack_api.post_message import post_message_with_slack_bot
+from .route_utilities import create_model, validate_model, get_models_with_filters
+from  app.models.task import Task
+from  app.models.goal import Goal
+from datetime import datetime
+from ..db import db
+bp = Blueprint("task_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():
+    query = db.select(Task)
+    title_param = request.args.get("title")
+    if title_param:
+        query = query.where(Task.title.ilike(f"%{title_param}%"))
+    # Sorting logic
+    sort_param = request.args.get("sort")
+    if sort_param == "asc":
+        query = query.order_by(Task.title.asc())   
+    elif sort_param == "desc":
+        query = query.order_by(Task.title.desc())  
+    else:
+        query = query.order_by(Task.id)  
+
+    tasks = db.session.scalars(query)
+
+    description_param = request.args.get("description")
+    if description_param:
+        # In case there are tasks with similar titles, we can also filter by description
+        query = query.where(Task.description.ilike(f"%{description_param}%"))
+    tasks = db.session.scalars(query.order_by(Task.id))
+    response = []
+
+    for task in tasks:     
+        response.append(task.to_dict())
+
+    return response
+
+@bp.put("/<id>")
+def update_task(id):
+    validate_model(Task, id)
+    request_body = request.get_json()
+    updated_task = Task.from_dict(request_body)
+    updated_task.id = id
+    db.session.merge(updated_task)
+    db.session.commit()
+
+    return Response(status=204, mimetype="application/json")
+
+@bp.delete("/<id>")
+def delect_task(id):
+    task = validate_model(Task,id)
+    db.session.delete(task)
+    db.session.commit()
+    return Response(status=204, mimetype="application/json")
+
+@bp.patch("/<id>/mark_complete")
+def mark_complete(id):
+    task = validate_model(Task,id)
+    task.completed_at = datetime.utcnow()
+    db.session.commit()
+    post_message_with_slack_bot(f"Someone just completed the task {task.title}")
+    return Response(status=204, mimetype="application/json")
+
+@bp.patch("/<id>/mark_incomplete")
+def mark_incomplete(id):
+    task = validate_model(Task,id)
+    task.completed_at = None
+    db.session.commit()
+    return Response(status=204, mimetype="application/json")
+
+@bp.get("/<id>")
+def get_tasks_by_id(id):
+    goal = validate_model(Task,id)
+    return goal.to_dict()
+
+
+
+
+

app/slack_api/post_message.py

@@ -0,0 +1,16 @@
+import os
+import requests
+token = os.environ.get("SLACK_BOT_TOKEN")
+
+url = "https://slack.com/api/chat.postMessage"
+def post_message_with_slack_bot(text: str) -> dict:
+    headers = {
+		"Authorization": f"Bearer {token}",
+		"Content-Type": "application/json",
+	}
+    payload = {"channel": "C09Q6QRAJN6", "text": text}
+
+    resp = requests.post(url, headers=headers, json=payload, timeout=10)
+
+    data = resp.json()
+    return data

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