Sphinx - Salma Anany

.gitignore

@@ -138,4 +138,6 @@ dmypy.json
 .pytype/
 
 # Cython debug symbols
-cython_debug/
+cython_debug/
+
+.idea

app/__init__.py

@@ -1,7 +1,15 @@
+import os
+
+from dotenv import load_dotenv
 from flask import Flask
+
 from .db import db, migrate
 from .models import task, goal
-import os
+from .routes.goal_routes import goal_bp
+from .routes.task_routes import tasks_bp
+
+load_dotenv()
+
 
 def create_app(config=None):
     app = Flask(__name__)
@@ -16,6 +24,8 @@ def create_app(config=None):
 
     db.init_app(app)
     migrate.init_app(app, db)
+    app.register_blueprint(tasks_bp)
+    app.register_blueprint(goal_bp)
 
     # Register Blueprints here
 

app/db.py

@@ -1,6 +1,7 @@
-from flask_sqlalchemy import SQLAlchemy
 from flask_migrate import Migrate
+from flask_sqlalchemy import SQLAlchemy
+
 from .models.base import Base
 
 db = SQLAlchemy(model_class=Base)
-migrate = Migrate()
+migrate = Migrate()

app/models/base.py

@@ -1,4 +1,5 @@
 from sqlalchemy.orm import DeclarativeBase
 
+
 class Base(DeclarativeBase):
-    pass
+    pass

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
 
+
 class Goal(db.Model):
     id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True)
+    title: Mapped[str] = mapped_column(nullable=False)
+    tasks = relationship('Task', back_populates='goal', cascade='all, delete-orphan')
+
+    def to_dict(self, no_tasks=True):
+        result = {"id": self.id, "title": self.title, }
+        if not no_tasks:
+            tasks = []
+            for task in self.tasks:
+                tasks.append(task.to_dict())
+            result["tasks"] = tasks
+        return result
+
+    def from_dict(self, data:dict[str, any]):
+        if id in data:
+            self.id = data.get("id")
+        if "title" in data:
+            self.title = data["title"]
+        return self

app/models/task.py

@@ -1,5 +1,33 @@
-from sqlalchemy.orm import Mapped, mapped_column
+from datetime import datetime
+
+from sqlalchemy import Integer, ForeignKey
+from sqlalchemy.orm import Mapped, mapped_column, relationship
+
 from ..db import db
 
+
 class Task(db.Model):
     id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True)
+    title: Mapped[str] = mapped_column(nullable=False)
+    description: Mapped[str]
+    completed_at: Mapped[datetime] = mapped_column(nullable=True)
+
+    goal_id = db.Column(Integer, ForeignKey('goal.id'), nullable=True)
+    goal = relationship('Goal', back_populates='tasks')
+
+    def to_dict(self):
+        result = dict(
+            id=self.id,
+            title=self.title,
+            description=self.description,
+            is_complete=self.completed_at is not None)
+        if self.goal is not None:
+            result["goal_id"] = self.goal.id
+        return result
+    def from_dict(self, data):
+        self.id = data["id"]
+        self.title = data["title"]
+        self.description = data["description"]
+        self.goal_id = data["goal_id"]
+        self.completed_at = None if data["is_complete"] == False else datetime.now()
+        return self

app/routes/goal_routes.py

@@ -1 +1,103 @@
-from flask import Blueprint
+from flask import Blueprint, make_response, abort, request
+
+from app import db
+from app.models.goal import Goal
+from app.models.task import Task
+
+goal_bp = Blueprint("goal_bp", __name__, url_prefix="/goals")
+
+def validate_key_in_request(request_body, key, datatype):
+    if key not in request_body or not isinstance(request_body[key], datatype):
+        abort(make_response({"details": "Invalid data"}, 400))
+    return request_body
+
+
+def validate_goal_id(id):
+    if not id.isnumeric():
+        abort(make_response({"details": f" {id} Invalid data"}, 400))
+
+
+@goal_bp.post("")
+def create_goal():
+    request_body = validate_key_in_request(request.get_json(), "title", str)
+    new_goal = Goal().from_dict(request_body)
+    db.session.add(new_goal)
+    db.session.commit()
+    response = {
+        "goal": new_goal.to_dict()
+    }
+    return response, 201
+
+
+@goal_bp.get("")
+def get_all_tasks():
+    title_param = request.args.get("title")
+
+    query = db.select(Goal)
+    if title_param:
+        query = query.where(Goal.title.like(f"%{title_param}"))
+
+    goals = db.session.scalars(query).all()
+    return [goal.to_dict() for goal in goals]
+
+
+
+
+@goal_bp.get("/<goal_id>")
+def get_one_goal(goal_id):
+    goal = get_goal_by_id(goal_id)
+    return {"goal": goal.to_dict()}
+
+
+@goal_bp.post("/<goal_id>/tasks")
+def set_one_goal_tasks(goal_id):
+    request_body = validate_key_in_request(request.get_json(), "task_ids", list)
+    goal = get_goal_by_id(goal_id)
+    task_ids = request_body.get("task_ids", [])
+
+    tasks = db.session.query(Task).filter(Task.id.in_(task_ids)).all()
+    if len(tasks) != len(task_ids):
+        abort(make_response({"message": "One or more tasks not found"}, 404))
+
+    for task in tasks:
+        task.goal = goal
+
+    db.session.commit()
+
+    return {"id": goal.id, "task_ids": [task.id for task in tasks]}, 200
+
+
+@goal_bp.put("/<goal_id>")
+def update_goal(goal_id):
+    goal = get_goal_by_id(goal_id)
+    request_body = request.get_json()
+    goal.title = request_body["title"]
+    db.session.commit()
+    result = {"goal": goal.to_dict()}
+    return make_response(result, 200)
+
+
+@goal_bp.delete("/<goal_id>")
+def delete_goal(goal_id):
+    goal = get_goal_by_id(goal_id)
+    db.session.delete(goal)
+    db.session.commit()
+    response = {"details": f'Goal {goal_id} "{goal.title}" successfully deleted'}
+    return make_response(response, 200)
+
+
+def get_goal_by_id(goal_id):
+    validate_goal_id(goal_id)
+    query = db.select(Goal).where(Goal.id == goal_id)
+    goal = db.session.scalar(query)
+
+    if not goal:
+        response = {"message": f"Goal {goal_id} not found"}
+        abort(make_response(response, 404))
+    return goal
+
+
+@goal_bp.get("/<goal_id>/tasks")
+def get_one_goal_tasks(goal_id):
+    return get_goal_by_id(goal_id).to_dict(False)
+

app/routes/task_routes.py

@@ -1 +1,145 @@
-from flask import Blueprint
+from datetime import datetime
+
+from flask import request, Blueprint, make_response, abort
+from sqlalchemy import asc, desc
+
+from app import db
+from app.models.task import Task
+from app.slack.slack_client import SlackClient
+from app.slack.slackmessage import SlackMessage
+
+tasks_bp = Blueprint("tasks_bp", __name__, url_prefix="/tasks")
+slack_client = SlackClient()
+
+
+@tasks_bp.post("")
+def create_task():
+    request_body = request.get_json()
+    if "title" not in request_body.keys():
+        abort(make_response({"details": "Invalid data"}, 400))
+    title = request_body["title"]
+    if "description" not in request_body.keys():
+        abort(make_response({"details": "Invalid data"}, 400))
+    description = request_body["description"]
+    new_task = Task(title=title, description=description, completed_at=None)
+    db.session.add(new_task)
+    db.session.commit()
+    response = {
+        "task": new_task.to_dict()
+    }
+    return response, 201
+
+
+@tasks_bp.get("")
+def get_all_tasks():
+    description_param = request.args.get("description")
+    title_param = request.args.get("title")
+    sort_param = request.args.get("sort")
+
+    query = db.select(Task)
+    if description_param:
+        query = query.where(Task.description.like(f"%{description_param}%"))
+
+    if title_param:
+        query = query.where(Task.title.like(f"%{title_param}"))
+    if sort_param == "asc":
+        query = query.order_by(asc(Task.title))
+    elif sort_param == "desc":
+        query = query.order_by(desc(Task.title))
+
+    tasks = db.session.scalars(query).all()
+    tasks_response = [task.to_dict() for task in tasks]
+    return tasks_response
+
+
+def validate_id(id):
+    if not id.isnumeric():
+        abort(make_response({"message": f"Tasks id {id} invalid"}, 400))
+
+
+@tasks_bp.get("/<task_id>")
+def get_one_task(task_id):
+    validate_id(task_id)
+    query = db.select(Task).where(Task.id == task_id)
+    task = db.session.scalar(query)
+
+    if not task:
+        response = {"message": f"{task_id} not found"}
+        abort(make_response(response, 404))
+
+    return {"task": task.to_dict()}
+
+
+@tasks_bp.put("/<task_id>")
+def update_task(task_id):
+    validate_id(task_id)
+    query = db.select(Task).where(Task.id == task_id)
+    task = db.session.scalar(query)
+
+    if task is None:
+        abort(make_response({"message": f"Task {task_id} not found"}, 404))
+
+    request_body = request.get_json()
+    task.title = request_body["title"]
+    task.description = request_body["description"]
+    if "is_complete" in request_body.keys() and request_body["is_complete"]:
+        task.completed_at = datetime.now()
+    else:
+        task.completed_at = None
+    db.session.commit()
+    return {
+        "task": task.to_dict()
+    }
+
+
+@tasks_bp.delete("/<task_id>")
+def delete_task(task_id):
+    validate_id(task_id)
+    query = db.select(Task).where(Task.id == task_id)
+    task = db.session.scalar(query)
+    if not task:
+        response = {"message": f"{task_id} not found"}
+        abort(make_response(response, 404))
+
+    db.session.delete(task)
+    db.session.commit()
+
+    return {
+        "details": f'Task {task_id} "{task.title}" successfully deleted'
+    }
+
+
+def change_task_status(task_id, is_completed):
+    task = Task.query.get(task_id)
+    if task is None:
+        response = {"message": f"Task {task_id} not found"}
+        abort(make_response(response, 404))
+
+    if is_completed:
+        completed_date = datetime.now()
+        task_text = f"Someone just completed the task '{task.title}'"
+    else:
+        completed_date = None
+        task_text = f"Someone just marked the task '{task.title}' incomplete"
+
+    CHANNEL_NAME = "task-notifications"
+    notification_messages = SlackMessage(CHANNEL_NAME, task_text)
+    notification_was_sent = slack_client.post_message(notification_messages)
+    if notification_was_sent:
+        Task.query.filter_by(id=task_id).update({Task.completed_at: completed_date})
+        db.session.commit()
+    return task
+
+
+@tasks_bp.patch("/<task_id>/mark_complete")
+def mark_completed_task(task_id):
+    validate_id(task_id)
+    task = change_task_status(task_id, True)
+    return make_response({"task": task.to_dict()}, 200)
+
+
+@tasks_bp.patch("/<task_id>/mark_incomplete")
+def mark_in_complete_task(task_id):
+    validate_id(task_id)
+    task = change_task_status(task_id, False)
+    return make_response({"task": task.to_dict()}, 200)

app/slack/slack_client.py

@@ -0,0 +1,19 @@
+import os
+
+import requests
+
+from app.slack.slackmessage import SlackMessage
+
+
+class SlackClient:
+    def __init__(self):
+        self.token = os.environ.get('SLACK_TOKEN')
+        self.url = "https://slack.com/api"
+        self.headers = {
+            "Authorization": f"Bearer {self.token}",
+            "Content-Type": "application/json"
+        }
+
+    def post_message(self, slack_message: SlackMessage):
+        response = requests.post(f"{self.url}/chat.postMessage", headers=self.headers, json=slack_message.__dict__)
+        return response.status_code == 200

app/slack/slackmessage.py

@@ -0,0 +1,4 @@
+class SlackMessage:
+    def __init__(self, channel, text):
+        self.channel = channel
+        self.text = text

migrations/README

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