Madeline - Pheonix class #35

anselrognlie · 2024-12-01T16:53:23Z

Once we have other import paths to our models (here, through the blueprints, which import the models), we technically don't need the imports here any more. It's fine to leave them for clarity (and a reminder that any other models we add would need to be included until other routes are setup), but if the VS Code warning is bothersome, feel free to remove these.

anselrognlie · 2025-02-20T01:25:01Z

If check_for_completion is an instance method, call it as

"is_complete": self.check_for_completion()

Python will shuffle things around internally.

anselrognlie · 2024-11-29T17:15:20Z

Nice detection of goal membership to detemine whether to include the goal information.

anselrognlie · 2024-11-29T17:16:25Z

Nice way to optionally allow a taks to be created as already belonging to a goal.

anselrognlie · 2025-02-20T01:24:26Z

If we're passing self, prefer this to be an actual instnce method (indent it into the class).

Nit: no space between else and :

def check_for_completion(self): if self.completed_at is not None: return True else: return False

anselrognlie · 2024-12-02T15:19:26Z

Remember to always create a __init__.py in any new folders you create. It may appear that the imports are working correctly, but there are corner cases where this can become a problem. So the recommendation is to always make the __init__.py.

anselrognlie · 2025-02-20T01:26:29Z

Prefer to explicitly list the symbols being imported rather than using import *

anselrognlie · 2025-02-20T01:29:50Z

With the create_model refactor, create_model is already creating an appropriate response, so we can return it as

return create_model(Goal, request_body)

anselrognlie · 2025-02-20T01:31:47Z

This check is redundant. goals will alreayd be an empty list is nothing was found, so the return on line 58 willwork identically.

anselrognlie · 2025-02-20T01:32:51Z

The try/except his unnecessary. validate_model will already take care of generating the 404 response and halting further processing of the request.

anselrognlie · 2024-12-08T22:20:39Z

Nit: there should be a space after the colon

anselrognlie · 2024-12-08T22:03:42Z

Nice extension to handle the sort keyword along with attribute filtering.

-Original file line number
+Diff line change
@@ -1,6 +1,8 @@
-    from flask import Flask
+    from flask import Flask, request, jsonify
     from .db import db, migrate
     from .models import task, goal
+    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,9 @@ 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

-Original file line number
+Diff line change
@@ -1,5 +1,29 @@
-    from sqlalchemy.orm import Mapped, mapped_column
+    from sqlalchemy.orm import Mapped, mapped_column, relationship
+    from datetime import datetime
+    from app.routes.utilities_routes import create_model, validate_model
+    from typing import Optional
+    from sqlalchemy import ForeignKey
+    # from app.models.task import Task
     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):
+            goal_as_dict = {}
+            goal_as_dict["id"] = self.id
+            goal_as_dict["title"] = self.title
+            return goal_as_dict
+        @classmethod
+        def from_dict(cls, goal_data):
+            new_goal = cls(
+                title=goal_data["title"]
+            )
+            return new_goal

-Original file line number
+Diff line change
@@ -1,5 +1,45 @@
-    from sqlalchemy.orm import Mapped, mapped_column
+    from sqlalchemy.orm import Mapped, mapped_column, relationship
     from ..db import db
+    from datetime import datetime
+    from typing import Optional
+    from sqlalchemy import ForeignKey
     class Task(db.Model):
         id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True)
+        title: Mapped[str]
+        description: Mapped[str]
+        completed_at: Mapped[Optional[datetime]]
+        goal_id: Mapped[Optional[int]] = mapped_column(ForeignKey("goal.id"))
+        goal: Mapped["Goal"] = relationship("Goal", back_populates="tasks")
+        def to_dict(self):
+            task_as_dict = {
+                "id": self.id,
+                "title": self.title,
+                "description": self.description,
+                "is_complete": check_for_completion(self)
+            }
+            if self.goal_id:
+                task_as_dict["goal_id"] = self.goal_id
+            return task_as_dict
+        @classmethod
+        def from_dict(cls, task_data):
+            goal_id = task_data.get("goal_id")
+            new_task = cls(
+                title=task_data["title"],
+                description=task_data["description"],
+                goal_id = goal_id
+            )
+            return new_task
+    def check_for_completion(self):
+        if self.completed_at is not None:
+            return True
+        else :
+            return False

-Original file line number
+Diff line change
@@ -1 +1,107 @@
-    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
+    from app.routes.utilities_routes import *
+    bp = Blueprint("goal_bp",__name__, url_prefix= "/goals")
+    ####################################################################
+    ######################### Create FUNCTIONS #########################
+    ####################################################################
+    @bp.post("")
+    def create_goal():
+        request_body = request.get_json()
+        if not request_body or not request_body.get("title"):
+            return make_response({"details": "Invalid data: missing title"}, 400)
+        goal = create_model(Goal, request_body)
+        return make_response(goal, 201)
+    @bp.post("/<goal_id>/tasks")
+    def post_task_ids_to_goal(goal_id):
+        request_body = request.get_json()
+        goal = validate_model(Goal, goal_id)
+        task_ids = request_body.get("task_ids", [])
+        for task_id in task_ids:
+            task = validate_model(Task, task_id)
+            goal.tasks.append(task)
+        db.session.commit()
+        response_body = {
+            "id": goal.id,
+            "task_ids": [task.id for task in goal.tasks]
+        }
+        return response_body, 200
+    ####################################################################
+    ######################### READ FUNCTIONS #########################
+    ####################################################################
+    @bp.get("")
+    def get_goals():
+        request_arguements = request.args
+        goals = get_models_with_filters(Goal, request_arguements)
+        if not goals:
+            return make_response([], 200)
+        return make_response(goals, 200)
+    @bp.get("/<goal_id>")
+    def get_one_goal(goal_id):
+        try:
+            goal = validate_model(Goal, goal_id)
+            return make_response({"goal": goal.to_dict()}, 200)
+        except:
+            return make_response({"details": f"Goal {goal_id} not found"}, 404)
+    @bp.get("/<goal_id>/tasks")
+    def get_tasks_for_specific_goal(goal_id):
+        goal = validate_model(Goal, goal_id)
+        response_body = goal.to_dict()
+        response_body["tasks"] = [task.to_dict() for task in goal.tasks]
+        return response_body, 200
+    ####################################################################
+    ######################### UPDATE FUNCTIONS #########################
+    ####################################################################
+    @bp.put("/<goal_id>")
+    def update_goal(goal_id):
+        goal = validate_model(Goal, goal_id)
+        request_body = request.get_json()
+        goal_title = request_body.get("title")
+        if not goal_title:
+            return make_response({"details": "Invalid request: missing title"}, 400)
+        goal.title = goal_title
+        db.session.commit()
+        return make_response({"goal": goal.to_dict()}, 200)
+    ####################################################################
+    ######################### DELETE FUNCTIONS #########################
+    ####################################################################
+    @bp.delete("/<goal_id>")
+    def delete_goal(goal_id):
+        goal = validate_model(Goal, goal_id)
+        goal_id = goal.id
+        goal_title = goal.title
+        db.session.delete(goal)
+        db.session.commit()
+        response_body = {
+            "details": f'Goal {goal_id} "{goal_title}" successfully deleted'
+        }
+        return make_response(response_body, 200)

-Original file line number
+Diff line change
@@ -0,0 +1,27 @@
+    from flask import request, jsonify, abort, make_response
+    import requests
+    import os
+    def send_message(message, slack_channel, slack_url, slack_api_token):
+        headers = {
+             'Authorization': f'Bearer {slack_api_token}',
+             'Content-Type': 'application/json'
+        }
+        payload = {
+            "channel": slack_channel,
+            "text": message
+            }
+        response = requests.post(slack_url, json=payload, headers= headers)
+        if response.status_code != 200 or response.json().get("ok") is not True:
+            print("Failed to send Slack message: error unknown")
+    def send_message_with_config(message):
+            slack_channel = os.environ.get("SLACK_CHANNEL")
+            slack_url = os.environ.get("SLACK_URL")
+            slack_api_token = os.getenv("SLACK_BOT_TOKEN")
+            return send_message(message, slack_channel, slack_url, slack_api_token)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Madeline - Pheonix class #35

Uh oh!

Diff view

Diff view

There are no files selected for viewing

anselrognlie Dec 1, 2024

Uh oh!

anselrognlie Feb 20, 2025

Uh oh!

anselrognlie Nov 29, 2024

Uh oh!

anselrognlie Nov 29, 2024

Uh oh!

anselrognlie Feb 20, 2025

Uh oh!

anselrognlie Dec 2, 2024

Uh oh!

anselrognlie Feb 20, 2025

Uh oh!

anselrognlie Feb 20, 2025

Uh oh!

anselrognlie Feb 20, 2025

Uh oh!

anselrognlie Feb 20, 2025

Uh oh!

anselrognlie Dec 8, 2024

Uh oh!

anselrognlie Dec 8, 2024

Uh oh!

Uh oh!

-Original file line number
+Diff line change
@@ -1 +1,91 @@
-    from flask import Blueprint
+    from flask import Blueprint, abort, make_response, request, Response
+    from app.models.task import Task
+    from app.routes.utilities_routes import create_model, validate_model, get_models_with_filters, delete_model
+    from app.routes.slack_functions import send_message_with_config
+    from datetime import datetime, timezone
+    from ..db import db
+    import os
+    bp = Blueprint("task_bp", __name__, url_prefix="/tasks")
+    invalid_data_response = ({"details": "Invalid data"}, 400)
+    #create a new task in database
+    @bp.post("")
+    def create_task():
+        request_body = request.get_json()
+        return create_model(Task, request_body)
+    @bp.get("")
+    def get_tasks():
+        request_arguments = request.args
+        return get_models_with_filters(Task, request_arguments), 200
+    #get task by task id:
+    @bp.get("/<task_id>")
+    def get_one_task(task_id):
+        task = validate_model(Task, task_id)
+        task_dict = task.to_dict()
+        response = {"task":task_dict}
+        return response,200
+    #update task
+    @bp.put("/<task_id>")
+    def update_task(task_id):
+        task = validate_model(Task, task_id)
+        request_body = request.get_json()
+        title = request_body.get("title")
+        description = request_body.get("description")
+        if not title or not description:
+            return {"error": "Missing required fields: 'title' or 'description'"}, 400
+        task.title = title
+        task.description = description
+        completed_at = request_body.get("completed_at", task.completed_at)
+        task.completed_at = completed_at
+        db.session.commit()
+        response = {"task":task.to_dict()}
+        return response, 200
+    #Delete task
+    @bp.delete("/<task_id>")
+    def delete_task(task_id):
+        task = validate_model(Task, task_id)
+        return delete_model(Task, task)
+    #route 2
+    @bp.patch("/<task_id>/mark_complete")
+    def mark_complete(task_id):
+        task = validate_model(Task, task_id)
+        utc_now = datetime.now(timezone.utc)
+        task.completed_at = utc_now
+        message = f"Task {task.title} has been marked as complete!"
+        slack_response= send_message_with_config(message)
+        db.session.commit()
+        response = {"task": task.to_dict()}
+        if slack_response == None:
+        # if slack_response.status_code != 200 or not slack_response.json().get("ok"):
+            # error_msg = slack_response.json().get("errror", "Unknown error")
+            print("slack_error : Failed to send slack Notification")
+        return response, 200
+    @bp.patch("/<task_id>/mark_incomplete")
+    def mark_incomplete(task_id):
+        task = validate_model(Task, task_id)
+        task.completed_at = None
+        db.session.commit()
+        response = {"task": task.to_dict()}
+        return make_response(response,200)

-Original file line number
+Diff line change
@@ -0,0 +1,64 @@
+    from flask import abort, make_response
+    from app import db
+    def validate_model(cls, model_id):
+        try:
+            model_id = int(model_id)
+        except:
+            response = {"error": f"{cls.__name__} {model_id} invalid"}
+            abort(make_response(response, 400))
+        query = db.select(cls).where(cls.id == model_id)
+        model = db.session.scalar(query)
+        if not model:
+            response = {"details": f"{cls.__name__} {model_id} not found"}
+            abort(make_response(response, 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()
+        dict=cls.to_dict(new_model)
+        response = {((cls.__name__).lower()):dict}
+        return(make_response(response,201))
+    def get_models_with_filters(cls, filters=None):
+        query = db.select(cls)
+        if filters:
+            for attribute, value in filters.items():
+                if attribute != "sort":
+                    if hasattr(cls,attribute):
+                        query = query.where(getattr(cls, attribute).ilike(f"%{value}%"))
+                else:
+                    if value == "asc":
+                        query = query.order_by(cls.title.asc())
+                    elif value == "desc":
+                        query = query.order_by(cls.title.desc())
+        models = db.session.scalars(query.order_by(cls.id))
+        models_response = [model.to_dict() for model in models]
+        return models_response
+    def delete_model(cls,model):
+        model_id = model.id
+        model_title = model.title
+        db.session.delete(model)
+        db.session.commit()
+        details = f"{cls.__name__} {model_id} \"{model_title}\" successfully deleted"
+        response_body = {"details": details}
+        return response_body

Madeline - Pheonix class #35

Are you sure you want to change the base?

Uh oh!

Madeline - Pheonix class #35

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!