Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion app/__init__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
from flask import Flask
from .db import db, migrate
from .models import task, goal
from .models import task
from .routes.task_routes import bp as tasks_bp
from .routes.goal_routes import bp as goals_bp
import os

def create_app(config=None):
Expand All @@ -18,5 +20,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
24 changes: 23 additions & 1 deletion app/models/goal.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,27 @@
from sqlalchemy.orm import Mapped, mapped_column
from sqlalchemy.orm import Mapped, mapped_column, relationship
from sqlalchemy import String
from ..db import db

from typing import TYPE_CHECKING
if TYPE_CHECKING:
from .task import Task

class Goal(db.Model):
id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True)
title: Mapped[str | None] = mapped_column(String(200), nullable=True)
tasks: Mapped[list["Task"]] = relationship(back_populates="goal")

def to_dict(self) -> dict:
return {
"id": self.id,
"title": self.title,
}


@classmethod
def from_dict(cls, data: dict):
if "title" not in data:
raise KeyError("title")
return cls(
title=data["title"]
)
42 changes: 41 additions & 1 deletion app/models/task.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,45 @@
from sqlalchemy.orm import Mapped, mapped_column
from datetime import datetime
from sqlalchemy import String, Text, DateTime
from sqlalchemy.orm import Mapped, mapped_column, relationship
from sqlalchemy import ForeignKey
from typing import Optional
from ..db import db

from typing import TYPE_CHECKING
if TYPE_CHECKING:
from .goal import Goal
class Task(db.Model):
id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True)
title: Mapped[str | None] = mapped_column(String(200), nullable=True)
description: Mapped[str | None] = mapped_column(Text, nullable=True)
completed_at: Mapped[datetime | None] = mapped_column(DateTime(), nullable=True, default=None)
goal_id: Mapped[Optional[int]] = mapped_column(ForeignKey("goal.id"))
goal: Mapped[Optional["Goal"]] = relationship(back_populates="tasks")


def to_dict(self) -> dict:
task_as_dict = {
"id": self.id,
"title": self.title,
"description": self.description,
"is_complete": self.completed_at is not None
}
if self.goal_id:
task_as_dict["goal_id"] = self.goal_id
return task_as_dict


@classmethod
def from_dict(cls, data: dict):
if "title" not in data:
raise KeyError("title")
if "description" not in data:
raise KeyError("description")
task = cls(
title=data["title"],
description=data["description"],
completed_at=None,
)
if "goal_id" in data:
task.goal_id = data["goal_id"]
return task
75 changes: 74 additions & 1 deletion app/routes/goal_routes.py
Original file line number Diff line number Diff line change
@@ -1 +1,74 @@
from flask import Blueprint
from flask import Blueprint, Response, request, abort, make_response
from app.models.goal import Goal
from app.models.task import Task
from ..db import db
from .route_utilities import validate_model, create_model, get_models_with_filters

bp = Blueprint("goals", __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("/<goal_id>")
def get_one_goal(goal_id):
goal = validate_model(Goal, goal_id)
return goal.to_dict(), 200


@bp.put("/<goal_id>")
def update_goal(goal_id):
goal = validate_model(Goal, goal_id)
request_body = request.get_json()
try:
goal.title = request_body["title"]
except KeyError:
return abort(make_response({"details": "Invalid data"}, 400))
db.session.commit()
return Response(status=204, mimetype="application/json")


@bp.delete("/<goal_id>")
def delete_goal(goal_id):
goal = validate_model(Goal, goal_id)
db.session.delete(goal)
db.session.commit()
return Response(status=204, mimetype="application/json")


@bp.post("/<goal_id>/tasks")
def create_task_with_goal(goal_id):
goal = validate_model(Goal, goal_id)
request_body = request.get_json()
if not isinstance(request_body, dict) or "task_ids" not in request_body or not isinstance(request_body["task_ids"], list):
return abort(make_response({"details": "Invalid data"}, 400))

task_ids = request_body["task_ids"]

tasks = []
for tid in task_ids:
task = validate_model(Task, tid)
tasks.append(task)
goal.tasks = tasks
db.session.commit()

return {"id": goal.id, "task_ids": task_ids}, 200


@bp.get("/<goal_id>/tasks")
def get_tasks_by_goal(goal_id):
goal = validate_model(Goal, goal_id)
response = {
"id": goal.id,
"title": goal.title,
"tasks": [task.to_dict() for task in goal.tasks],
}
return response
36 changes: 36 additions & 0 deletions app/routes/route_utilities.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
from flask import abort, make_response
from ..db import db

def validate_model(cls, model_id):
try:
model_id = int(model_id)
except (TypeError, ValueError):
return abort(make_response({"message": f"{cls.__name__} id {model_id} invalid"}, 400))
query = db.select(cls).where(cls.id == model_id)
model = db.session.scalar(query)
if not model:
return abort(make_response({"message": f"{cls.__name__} id {model_id} not found"}, 404))

return model


def create_model(cls, model_data):
try:
new_model = cls.from_dict(model_data)
except (KeyError, ValueError):
return 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
110 changes: 109 additions & 1 deletion app/routes/task_routes.py
Original file line number Diff line number Diff line change
@@ -1 +1,109 @@
from flask import Blueprint
from flask import Blueprint, Response, abort, make_response, request
from datetime import datetime
from app.models.task import Task
from .route_utilities import validate_model, create_model
from ..db import db
from sqlalchemy import asc, desc
import os, requests

SLACK_BOT_TOKEN = os.getenv("SLACK_BOT_TOKEN")
SLACK_CHANNEL_ID = os.getenv("SLACK_CHANNEL_ID")

bp = Blueprint("tasks", __name__, url_prefix="/tasks")


def send_slack_message(text: str):
if not SLACK_BOT_TOKEN or not SLACK_CHANNEL_ID:
return
try:
resp = requests.post(
"https://slack.com/api/chat.postMessage",
headers={
"Authorization": f"Bearer {SLACK_BOT_TOKEN}",
"Content-Type": "application/json; charset=utf-8",
},
json={"channel": SLACK_CHANNEL_ID, "text": text},
timeout=5,
)

if resp.status_code != 200 or not resp.json().get("ok", False):
pass
except Exception:
pass


@bp.post("")
def create_task():
request_body = request.get_json()
return create_model(Task, request_body)


@bp.get("")
def get_all_tasks():
sort = request.args.get("sort")
if sort == "asc":
query = db.select(Task).order_by(Task.title.asc())
elif sort == "desc":
query = db.select(Task).order_by(Task.title.desc())
else:
query = db.select(Task).order_by(Task.id)
tasks = db.session.scalars(query).all()
return [t.to_dict() for t in tasks], 200


@bp.get("/<task_id>")
def get_one_task(task_id):
task = validate_model(Task, task_id)
return task.to_dict(), 200


@bp.put("/<task_id>")
def update_task(task_id):
task = validate_model(Task, task_id)
request_body = request.get_json()
try:
task.title = request_body["title"]
task.description = request_body["description"]
except KeyError:
return abort(make_response({"details": "Invalid data"}, 400))
db.session.commit()
return Response(status=204, mimetype="application/json")


@bp.delete("/<task_id>")
def delete_task(task_id):
task = validate_model(Task, task_id)
db.session.delete(task)
db.session.commit()
return Response(status=204, mimetype="application/json")


@bp.patch("/<task_id>/mark_complete")
def mark_complete(task_id):
task = validate_model(Task, task_id)
if task.completed_at:
return Response(status=204, mimetype="application/json")
try:
task.completed_at = datetime.now()

db.session.commit()

except Exception as e:
db.session.rollback()
print(f"Database error on committing task {task_id}: {e}")
return Response(
'{"error": "Internal server error"}',
status=500,
mimetype="application/json"
)

send_slack_message(f"Someone just completed the task {task.title}")
return Response(status=204, mimetype="application/json")


@bp.patch("/<task_id>/mark_incomplete")
def mark_incomplete(task_id):
task = validate_model(Task, task_id)
task.completed_at = None
db.session.commit()
return Response(status=204, mimetype="application/json")
1 change: 1 addition & 0 deletions migrations/README
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Single-database configuration for Flask.
50 changes: 50 additions & 0 deletions migrations/alembic.ini
Original file line number Diff line number Diff line change
@@ -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
Loading