C22 Sphinx - Christelle Nkera

app/__init__.py

@@ -1,22 +1,28 @@
 from flask import Flask
+from .routes.task_routes import tasks_bp
+from .routes.goal_routes import goals_bp
 from .db import db, migrate
-from .models import task, goal
+from .models import task
+from .models import goal
 import os
 
 def create_app(config=None):
+    # __name__ stores the name of the module we're in
     app = Flask(__name__)
 
     app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False
     app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get('SQLALCHEMY_DATABASE_URI')
 
+    # app.config['SQLALCHEMY_DATABASE_URI'] = 'postgresql+psycopg2://postgres:postgres@localhost:5432/task_list_api_development'
+
     if config:
-        # Merge `config` into the app's configuration
-        # to override the app's default settings for testing
         app.config.update(config)
 
     db.init_app(app)
     migrate.init_app(app, db)
 
     # Register Blueprints here
+    app.register_blueprint(tasks_bp)
+    app.register_blueprint(goals_bp)
 
-    return app
+    return app

app/models/goal.py

@@ -1,5 +1,21 @@
-from sqlalchemy.orm import Mapped, mapped_column
+from sqlalchemy.orm import Mapped, mapped_column, relationship
 from ..db import db
+from typing import List
 
 class Goal(db.Model):
     id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True)
+    title: Mapped[str]
+    tasks: Mapped[List["Task"]] = relationship(back_populates="goal")
+
+    def to_dict(self):
+        return dict(
+            id=self.id,
+            title=self.title,
+        )
+
+    @classmethod
+    def from_dict(cls, task_data):
+        return cls(
+            title=task_data["title"]
+        )
+

app/models/task.py

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

app/routes/goal_routes.py

@@ -1 +1,89 @@
-from flask import Blueprint
+from flask import Blueprint, abort, make_response, request, Response
+from ..db import db
+from ..models.goal import Goal
+from ..models.task import Task
+import datetime
+import requests
+import os
+from sqlalchemy import desc, asc
+from .route_utilities import validate_model, create_model
+
+goals_bp = Blueprint("goals_bp", __name__, url_prefix="/goals")
+
+@goals_bp.post("")
+def create_goal():
+    request_body = request.get_json()
+
+    return create_model(Goal, request_body)
+
+@goals_bp.get("")
+def get_all_goals():
+    query = db.select(Goal).order_by(Goal.id)
+    goals = db.session.scalars(query)
+
+    response=[goal.to_dict() for goal in goals]
+
+    return response, 200
+
+@goals_bp.get("/<goal_id>")
+def get_single_goal(goal_id):
+    goal = validate_model(Goal, goal_id)
+    response = {"goal": goal.to_dict()}
+
+    return response, 200
+
+@goals_bp.put("/<goal_id>")
+def update_goal(goal_id):
+    goal = validate_model(Goal, goal_id)
+
+    request_body = request.get_json()
+    goal.title = request_body["title"]
+
+    db.session.commit()
+    response = {"title": goal.title}
+
+    return response, 200
+
+@goals_bp.delete("/<goal_id>")
+def delete_goal(goal_id):
+    goal = validate_model(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 create_task_ids_by_goal(goal_id):
+    request_body = request.get_json()
+
+    goal = validate_model(Goal, goal_id)
+
+    try:
+        task_ids = request_body["task_ids"]
+
+        for task_id in task_ids:
+            task = validate_model(Task, task_id)
+            goal.tasks.append(task)
+
+        db.session.commit()
+
+    except KeyError as error:
+        response = {"details": "Invalid data"}
+        abort(make_response(response, 400))
+
+    return {"id": goal.id, "task_ids": task_ids}
+
+@goals_bp.get("/<goal_id>/tasks")
+def get_tasks_by_goal(goal_id):
+    goal = validate_model(Goal, goal_id)
+
+    goal_dict = goal.to_dict()
+    goal_dict["tasks"] = []
+
+    for task in goal.tasks:
+        goal_dict["tasks"].append(task.to_dict())
+
+    return goal_dict

app/routes/route_utilities.py

@@ -0,0 +1,51 @@
+from flask import abort, make_response
+from ..db import db
+from app.models.task import Task
+from app.models.goal import Goal
+from sqlalchemy import desc, asc
+
+def validate_model(cls, model_id):
+
+    # checks for valid input
+    try: 
+        model_id = int(model_id)
+    except: 
+        abort(make_response({"msg": f"{cls.__name__} id {model_id} is invalid"}, 400))
+
+
+    # returns task with the corresponding task_id
+    query = db.select(cls).where(cls.id == model_id)
+    model = db.session.scalar(query)
+
+    if not model:
+        abort(make_response({"msg": f"{cls.__name__} {model_id} not found."}, 404))
+
+    return model
+
+def create_model(cls, model_data):
+    try:
+        new_model = cls.from_dict(model_data)
+
+    except KeyError as error:
+        response = {"details": "Invalid data"}
+        abort(make_response(response, 400))
+
+    db.session.add(new_model)
+    db.session.commit()
+
+    return {cls.__name__.lower(): new_model.to_dict()}, 201
+
+def get_models_with_filters(cls, filters=None):
+    query = db.select(cls)
+
+    if filters:
+        order_by = getattr(cls, filters.get("order_by", "title"))
+        if filters.get("sort") == "desc":
+            query = query.order_by(db.desc(order_by))
+        else:
+            query = query.order_by(db.asc(order_by))
+
+    models = db.session.scalars(query)
+    models_response = [model.to_dict() for model in models]
+
+    return models_response

app/routes/task_routes.py

@@ -1 +1,88 @@
-from flask import Blueprint
+from flask import Blueprint, abort, make_response, request, Response
+from ..db import db
+from app.models.task import Task
+from .route_utilities import validate_model, create_model, get_models_with_filters
+import datetime
+import requests
+import os
+
+tasks_bp = Blueprint("tasks_bp", __name__, url_prefix="/tasks")
+
+@tasks_bp.post("")
+def create_task():
+    request_body = request.get_json()
+
+    return create_model(Task, request_body)
+
+@tasks_bp.get("")
+def get_all_tasks():
+
+    return get_models_with_filters(Task, request.args)
+
+@tasks_bp.get("/<task_id>")
+def get_single_task(task_id):
+    task = validate_model(Task, task_id)
+
+    return {"task": task.to_dict()}
+
+@tasks_bp.put("/<task_id>")
+def update_task(task_id):
+    task = validate_model(Task, task_id)
+
+    request_body = request.get_json()
+    task.title = request_body["title"]
+    task.description = request_body["description"]
+
+    db.session.commit()
+
+    return {"task": task.to_dict()}
+
+@tasks_bp.delete("/<task_id>")
+def delete_task(task_id):
+    task = validate_model(Task, task_id)
+
+    db.session.delete(task)
+    db.session.commit()
+
+    response = {"details": f"Task {task_id} \"{task.title}\" successfully deleted"}
+
+    return response
+
+@tasks_bp.patch("/<task_id>/mark_complete")
+def mark_task_complete(task_id):
+    task = validate_model(Task, task_id)
+    task.completed_at = datetime.datetime.now()
+
+    db.session.commit()
+
+    # Slack bot API call
+    url = "https://slack.com/api/chat.postMessage"
+    API_KEY = os.environ.get("SLACK_BOT_OAUTH")
+    header = {"Authorization": f"Bearer {API_KEY}"}
+    request_body = {
+        "channel": "task-notifications",
+        "text": f"Someone just completed the task {task.title}!"
+    }
+
+    slack_post = requests.post(url, headers=header, params=request_body)
+
+    if slack_post:
+        return {"task": task.to_dict()}
+
+@tasks_bp.patch("/<task_id>/mark_incomplete")
+def mark_task_incomplete(task_id):
+    task = validate_model(Task, task_id)
+    task.completed_at = None 
+    db.session.commit()
+
+    return {"task": task.to_dict()}
+
+
+def implement_slack_api(task):
+    url = "https://slack.com/api/chat.postMessage"
+    API_KEY = os.environ.get("SLACK_BOT_OAUTH")
+    header = {"Authorization": f"Bearer {API_KEY}"}
+    request_body = {
+        "channel": "task-notifications",
+        "text": f"{task.title} completed!",
+    }

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