task_list_api -Sunitha -Sphinx

ada-project-docs/optional-enhancements.md

@@ -1,4 +1,4 @@
-# Optional Enhancements
+dour# Optional Enhancements
 
 ## Goal
 
@@ -42,7 +42,7 @@ Here are some ideas to start:
 - Create a class method in `Task` named `from_json()`
     - Converts JSON into a new instance of `Task`
     - Takes in a dictionary in the shape of the JSON our API receives in the create and update routes
-    - Returns an instance of `Task` 
+    - Returns an instance of `Task`
 
 ### Use List Comprehensions
 

ada-project-docs/wave_01.md

@@ -27,7 +27,7 @@ Tasks should contain these attributes. **The tests require the following columns
 
 ### Tips
 
-- To work with date information, we can import the `datetime` data type with the import line `from datetime import datetime`. 
+- To work with date information, we can import the `datetime` data type with the import line `from datetime import datetime`.
 - SQLAlchemy supports optional, or _nullable_, columns with specific syntax.
 - Don't forget to run:
   - `flask db init` once during setup
@@ -50,7 +50,7 @@ Tasks should contain these attributes. **The tests require the following columns
 
 ### CLI
 
-In addition to testing your code with pytest and postman, you can play test your code with the CLI (Command Line Interface) by running `python3 cli/main.py`. 
+In addition to testing your code with pytest and postman, you can play test your code with the CLI (Command Line Interface) by running `python3 cli/main.py`.
 
 The flask server needs to be running first before running the CLI.
 
@@ -122,8 +122,7 @@ As a client, I want to be able to make a `GET` request to `/tasks` when there ar
 
 #### Get One Task: One Saved Task
 
-As a client, I want to be able to make a `GET` request to `/tasks/1` when there is at least one saved task and get this response:
-
+As a client, I want to be able to make a `GET` request to `/tasks/1` when there is at least one saved task and get this respons
 `200 OK`
 
 ```json
@@ -192,7 +191,7 @@ The response code should be `404`.
 You may choose the response body.
 
 Make sure to complete the tests for non-existing tasks to check that the correct response body is returned.
- 
+
 
 #### Create a Task: Invalid Task With Missing Data
 

app/__init__.py

@@ -1,13 +1,16 @@
 from flask import Flask
 from .db import db, migrate
 from .models import task, goal
+from .routes.task_routes import tasks_bp
+from .routes.goal_routes import goals_bp
 import os
 
+
 def create_app(config=None):
     app = Flask(__name__)
 
-    app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False
-    app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get('SQLALCHEMY_DATABASE_URI')
+    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
@@ -18,5 +21,7 @@ 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,15 @@
-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]
+    tasks: Mapped[list["Task"]] = relationship("Task", back_populates="goal")
+
+    def to_dict(self):
+        return dict(id=self.id, title=self.title)
+
+    @classmethod
+    def from_dict(cls, goal_data):
+        return cls(title=goal_data["title"])

app/models/task.py

@@ -1,5 +1,34 @@
-from sqlalchemy.orm import Mapped, mapped_column
+from sqlalchemy.orm import Mapped, mapped_column, relationship
+from sqlalchemy import ForeignKey
 from ..db import db
+from datetime import datetime
+from typing import Optional
+
 
 class Task(db.Model):
     id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True)
+    title: Mapped[str] = mapped_column(String, nullable=False)
+    description: Mapped[str]
+    completed_at: Mapped[Optional[datetime]]
+    goal_id: Mapped[Optional[int]] = mapped_column(ForeignKey("goal.id"))
+    goal: Mapped[Optional["Goal"]] = relationship("Goal", back_populates="tasks")
+
+    def to_dict(self):
+        task_dict = {
+            "id": self.id,
+            "title": self.title,
+            "description": self.description,
+            "is_complete": task.is_complete()})
+        }
+        if self.goal_id is not None:
+            task_dict["goal_id"] = self.goal_id
+        return task_dict
+
+    @classmethod
+    def from_dict(cls, task_data):
+        return cls(
+            goal_id=task_data.get("goal_id"),
+            title=task_data["title"],
+            description=task_data["description"],
+            completed_at=task_data.get("completed_at", None),
+        )

app/routes/goal_routes.py

@@ -1 +1,142 @@
-from flask import Blueprint
+from flask import Blueprint, abort, make_response, request, Response
+from app.models.goal import Goal
+from app.models.task import Task
+from ..db import db
+from datetime import datetime
+
+goals_bp = Blueprint("goals_bp", __name__, url_prefix="/goals")
+
+
+@goals_bp.post("")
+def create_goal():
+    request_body = request.get_json()
+
+    try:
+        new_goal = Goal.from_dict(request_body)
+
+    except KeyError as error:
+        response = {"details": f"Invalid data - missing {error.args[0]}"}
+        abort(make_response(response, 400))
+
+    db.session.add(new_goal)
+    db.session.commit()
+
+    response = {"goal": new_goal.to_dict()}
+    return response, 201
+
+
+@goals_bp.get("")
+def get_all_goals():
+    query = db.select(Goal)
+
+    title_param = request.args.get("title")
+    sort = request.args.get("sort", "asc")  # Default to ascending order
+
+    query = db.select(Goal)
+
+    if title_param:
+        query = query.where(Goal.title.ilike(f"%{title_param}%"))
+
+    if sort == "desc":
+        query = query.order_by(Goal.title.asc())
+
+    goals = db.session.scalars(query)
+    goals_response = [goal.to_dict() for goal in goals]
+
+    return goals_response, 200
+
+
+@goals_bp.get("/<goal_id>")
+def get_single_goal(goal_id):
+    goal = validate_goal(goal_id)
+
+    return {"goal": goal.to_dict()}
+
+
+@goals_bp.put("/<goal_id>")
+def update_goal(goal_id):
+    goal = validate_goal(goal_id)
+    request_body = request.get_json()
+
+    goal.title = request_body["title"]
+
+    db.session.commit()
+    response = {"goal": goal.to_dict()}
+    return response, 200
+
+
+@goals_bp.patch("/<goal_id>/mark_complete")
+def mark_goal_complete(goal_id):
+    goal = validate_goal(goal_id)
+    goal.completed_at = datetime.now()
+    db.session.commit()
+
+    return {"goal": goal.to_dict()}, 200
+
+
+@goals_bp.patch("/<goal_id>/mark_incomplete")
+def mark_goal_incomplete(goal_id):
+    goal = validate_goal(goal_id)
+    goal.completed_at = None
+
+    db.session.commit()
+
+    return {"goal": goal.to_dict()}, 200
+
+
+@goals_bp.delete("/<goal_id>")
+def delete_goal(goal_id):
+    goal = validate_goal(goal_id)
+
+    db.session.delete(goal)
+    db.session.commit()
+    response = {"details": f'Goal {goal_id} "{goal.title}" successfully deleted'}
+    return response, 200
+
+
+@goals_bp.post("/<goal_id>/tasks")
+def assign_tasks_to_goal(goal_id):
+    goal = validate_goal(goal_id)
+    request_body = request.get_json()
+    task_ids = request_body.get("task_ids", [])
+
+    tasks = [validate_model(Task, task_id) for task_id in task_ids]
+
+    goal.tasks.extend(tasks)
+    db.session.commit()
+
+    return {"id": goal.id, "task_ids": task_ids}, 200
+
+
+@goals_bp.get("/<goal_id>/tasks")
+def get_tasks_by_goal(goal_id):
+    goal = validate_goal(goal_id)
+    goal_dict = goal.to_dict()
+    goal_dict["tasks"] = [task.to_dict() for task in goal.tasks]
+    return goal_dict
+
+
+@goals_bp.get("<goal_id>/tasks/<task_id>")
+def get_one_task_by_goal(goal_id, task_id):
+
+    goal = validate_goal(Goal, goal_id)
+    task = validate_goal(Task, task_id)
+
+    if task in goal.tasks:
+        goal_dict = goal.to_dict()
+        goal_dict["task"] = task.to_dict()
+        return goal_dict
+    return {"details": f"Task {task.id} not found for Goal {goal.id}"}, 404
+
+
+def validate_goal(goal_id):
+    try:
+        goal_id = int(goal_id)
+    except ValueError:
+        abort(400, description="Invalid goal_id")
+
+    goal = Goal.query.get(goal_id)
+    if goal is None:
+        abort(make_response({"message": f"goal {goal_id} not found"}, 404))
+
+    return goal

app/routes/task_routes.py

@@ -1 +1,119 @@
-from flask import Blueprint
+from flask import Blueprint, abort, make_response, request, Response
+from app.models.task import Task
+from ..db import db
+from datetime import datetime
+from app.models.task import Task
+
+tasks_bp = Blueprint("tasks_bp", __name__, url_prefix="/tasks")
+
+
+
+@tasks_bp.post("")
+def create_task():
+  request_body = request.get_json()
+
+  try:
+     new_task = Task.from_dict(request_body)
+
+  except KeyError:
+     response = {"details": "Invalid data"}
+     abort(make_response(response, 400))
+
+
+  db.session.add(new_task)
+  db.session.commit()
+
+  response = {"task": new_task.to_dict()}
+  return response, 201
+
+
+@tasks_bp.get("")
+def get_all_tasks():
+  query = db.select(Task)
+  description_param = request.args.get("description")
+  if description_param:
+    query = query.where(Task.description.ilike(f"%{description_param}%")).order_by(Task.id)
+
+  title_param = request.args.get("title")
+  sort = request.args.get("sort", "asc")  # Default to ascending order
+
+  query = db.select(Task)
+
+  if title_param:
+      query = query.where(Task.title.ilike(f"%{title_param}%"))
+
+  if sort == "desc":
+      query = query.order_by(Task.title.desc())
+  else:
+      query = query.order_by(Task.title.asc())
+
+  tasks = db.session.scalars(query)
+  tasks_response = [task.to_dict() for task in tasks]
+
+  return tasks_response, 200
+
+
+@tasks_bp.get("/<task_id>")
+def get_single_task(task_id):
+  task = validate_task(task_id)
+
+
+  return {"task": task.to_dict()}
+
+
+@tasks_bp.put("/<task_id>")
+def update_task(task_id):
+  task = validate_task(task_id)
+  request_body = request.get_json()
+
+  task.title = request_body["title"]
+  task.description = request_body.get("description")
+  task.completed_at = request_body.get("completed_at")
+
+  db.session.commit()
+  response = {"task": task.to_dict()}
+  return response, 200
+
+@tasks_bp.patch("/<task_id>/mark_complete")
+def mark_task_complete(task_id):
+    task = validate_task(task_id)
+    task.completed_at = datetime.now()
+    db.session.commit()
+
+    return {"task": task.to_dict()}, 200
+
+@tasks_bp.patch("/<task_id>/mark_incomplete")
+def mark_task_incomplete(task_id):
+    task = validate_task(task_id)
+    task.completed_at = None
+
+    db.session.commit()
+
+    return {"task": task.to_dict()}, 200
+
+
+@tasks_bp.delete("/<task_id>")
+def delete_task(task_id):
+  task = validate_task(task_id)
+
+  db.session.delete(task)
+  db.session.commit()
+  response = {
+    "details": f'Task {task_id} "{task.title}" successfully deleted'
+    }
+  return response, 200
+
+def validate_task(task_id):
+  try:
+      task_id = int(task_id)
+  except ValueError:
+        response = {"details": f"Task {task_id} invalid"}
+        abort(make_response(response, 404))
+
+  task = db.session.get(Task,task_id)
+
+  if not task:
+        response = {"message": f"task {task_id} not found"}
+        abort(make_response(response, 404))
+
+  return task