Crow_lexy Le task_list_api

.gitignore

@@ -1,5 +1,6 @@
 .vscode
 .DS_Store
+.env
 
 # Byte-compiled / optimized / DLL files
 __pycache__/

ada-project-docs/wave_04.md

@@ -192,3 +192,11 @@ Send `PATCH` requests to `localhost:5000/tasks/<task_id>/mark_complete` (use the
 ![](assets/postman_patch.png)
 
 ![](assets/slack_notification_feature.png)
+
+
+
+The result show as below
+![](assets/lexy-slackbot.png)
+
+
+

app/__init__.py

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

app/models/goal.py

@@ -1,5 +1,25 @@
-from sqlalchemy.orm import Mapped, mapped_column
+from sqlalchemy.orm import Mapped, mapped_column, relationship
 from ..db import db
+from sqlalchemy import String
+
+
 
 class Goal(db.Model):
+
     id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True)
+    title: Mapped[str] = mapped_column(String(100), nullable=False)
+    tasks: Mapped[list["Task"]] = relationship(
+        back_populates="goal")
+
+
+    def to_dict(self):
+        return {
+            "id": self.id,
+            "title": self.title
+        }
+
+    @classmethod
+    def from_dict(cls, data_dict):
+        if "title" not in data_dict:
+            raise KeyError("title")
+        return cls(title=data_dict["title"])

app/models/task.py

@@ -1,5 +1,49 @@
-from sqlalchemy.orm import Mapped, mapped_column
+from flask_sqlalchemy import SQLAlchemy
+from sqlalchemy.orm import Mapped, mapped_column,relationship
+from sqlalchemy import ForeignKey
 from ..db import db
+from sqlalchemy import String, Date
+from datetime import datetime
+from flask import Blueprint, abort, make_response, request, Response
+from typing import Optional
+from datetime import date
 
 class Task(db.Model):
     id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True)
+    title: Mapped[str] = mapped_column(String(100), nullable=False)
+    description: Mapped[str] = mapped_column(String(255))
+    completed_at:Mapped[date] = mapped_column(Date, nullable=True)
+
+    goal_id: Mapped[Optional[int]] = mapped_column(ForeignKey("goal.id"))
+    goal: Mapped[Optional["Goal"]] = relationship(back_populates="tasks")
+
+    def to_dict(self): # json
+
+
+        task_dict = {"id": self.id,
+                "title":self.title,
+                "description":self.description,
+                "is_complete": self.completed_at is not None}
+
+        if self.goal_id is not None:
+            task_dict["goal_id"] = self.goal_id
+
+
+        return task_dict
+
+    @classmethod
+    def from_dict(cls, data_dict):
+        if "title" not in data_dict:
+
+            raise KeyError("title")
+        if "description" not in data_dict:
+            raise KeyError("description")
+
+        return cls(
+            title=data_dict["title"],
+            description=data_dict["description"],
+            completed_at=None  # default to None when creating
+        )
+
+
+

app/routes/goal_routes.py

@@ -1 +1,81 @@
-from flask import Blueprint
+from flask import Blueprint, request, abort, make_response,Response
+from ..db import db
+from ..models.goal import Goal
+from ..models.task import Task
+from .route_utilities import validate_model,create_model,get_models_with_filters
+
+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_goals():
+   filters = request.args.to_dict()
+   return get_models_with_filters(Goal,filters)
+
+@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()
+
+    goal.title = request_body["title"]
+
+    db.session.commit()
+    return goal.to_dict()
+
+@bp.delete("/<id>")
+def delete_goal(id):
+    goal = validate_model(Goal, id)
+
+    db.session.delete(goal)
+    db.session.commit()
+
+    return Response(status=204, mimetype="application/json")
+
+#nested
+@bp.post("/<goal_id>/tasks")
+def add_tasks_to_goal(goal_id):
+    goal = validate_model(Goal, goal_id)
+    request_body = request.get_json()
+
+    task_ids = request_body.get("task_ids", [])
+
+    for task in goal.tasks:
+        task.goal_id = None
+
+    for task_id in task_ids:
+        task = validate_model(Task, task_id)
+        task.goal_id = goal.id
+
+    db.session.commit()
+
+    return {
+        "id": goal.id,
+        "task_ids": task_ids
+    }, 200
+
+@bp.get("/<goal_id>/tasks")
+def get_tasks_for_goal(goal_id):
+    goal = validate_model(Goal, goal_id)
+
+    tasks_response = [task.to_dict() for task in goal.tasks]
+
+    response_body = {
+        "id": goal.id,
+        "title": goal.title,
+        "tasks": tasks_response
+    }
+
+    return response_body,200
+
+
+

app/routes/route_utilities.py

@@ -0,0 +1,41 @@
+from flask import abort, make_response
+from ..db import db
+
+def validate_model(cls, id):
+    try:
+        id = int(id)
+    except ValueError:
+        invalid = {"message": f"{cls.__name__} id({id}) is invalid."}
+        abort(make_response(invalid, 400))
+
+    query = db.select(cls).where(cls.id == id)
+    model = db.session.scalar(query)
+
+    if not model:
+        not_found = {"message": f"{cls.__name__} with id({id}) 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 e:
+        abort(make_response({"details": "Invalid data"}, 400))
+
+    db.session.add(new_model)
+    db.session.commit()
+
+    return 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,112 @@
-from flask import Blueprint
+from ..models.task import Task
+from flask import Blueprint, abort, make_response, request, Response,current_app
+from ..db import db
+from .route_utilities import validate_model,create_model,get_models_with_filters
+from datetime import datetime,timezone
+import  requests,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_tasks():
+    query = db.select(Task)
+    id_param = request.args.get("id")
+
+    if id_param:
+        query = query.where(Task.id == int(id_param))
+
+    description_param = request.args.get("description")
+    if description_param:
+        query = query.where(Task.description.ilike(f"%{description_param}%"))
+
+    title_param = request.args.get("title")
+    sort_param = request.args.get("sort")
+    if title_param:
+        query = query.where(Task.title.ilike(f"%{title_param}%"))
+
+    complete_param = request.args.get("is_complete")   
+    if complete_param == "true":
+
+        query = query.where(Task.completed_at.is_not(None))
+
+    elif complete_param == "false":
+
+        query = query.where(Task.completed_at.is_(None))
+
+    if sort_param =="asc":
+            query = 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)
+
+    result_list = []
+    result_list =[task.to_dict() for task in tasks]
+
+    return result_list or []
+
+@bp.get("/<id>")
+def get_one_task(id):
+
+    task =validate_model(Task,id)
+    return task.to_dict()
+
+@bp.put("/<id>")
+def replace_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")
+
+@bp.delete("/<id>")
+def del_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_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.patch("/<id>/mark_complete")
+def mark_task_complete(id):
+    task = validate_model(Task, id)
+    task.completed_at = datetime.now(timezone.utc)
+    db.session.commit()
+
+    slack_token = os.environ.get("SLACK_BOT_TOKEN")
+    slack_channel = os.environ.get("SLACK_CHANNEL", "#test_task_slack_api")
+    message = f"Task *{task.title}* has been completed!"
+
+    if not current_app.config.get("TESTING"):
+        response = requests.post(
+            "https://slack.com/api/chat.postMessage",
+            headers={"Authorization": f"Bearer {slack_token}"},
+
+            json={"channel": slack_channel, "text": message}
+        )
+
+    return Response(status=204, mimetype="application/json")
+

migrations/README

@@ -0,0 +1 @@
+Single-database configuration for Flask.