Open
Conversation
…or 400 invalid response and 404 not found response.
…tasks, and get one task
… pass test_create_task
mikellewade
reviewed
Dec 1, 2024
mikellewade
left a comment
mikellewade
left a comment
There was a problem hiding this comment.
Nice work overall, Brianna! Though I would like for you to read through the comments to see the ones I left about refactoring. There are a lot of places where you could have DRY'd up your code. Refactoring is a big part of this project because it helps train your eye for seeing similarities in your codebase as well as practicing maintainability and scalability.
Comment on lines
+5
to
+6
| from .routes.task_routes import tasks_bp | ||
| from .routes.goal_routes import goals_bp |
There was a problem hiding this comment.
Don't forget that the convention for naming blueprints is to name them bp. With each blueprint being named the same thing we will need to import them under an alias like so:
from .routes.task_routes import bp as tasks_bp| 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") |
Comment on lines
+12
to
+16
| title: Mapped[str] | ||
| description: Mapped[str] | ||
| completed_at: Mapped[Optional[datetime]] = mapped_column(nullable=True) | ||
| goal_id: Mapped[Optional[int]] = mapped_column(ForeignKey("goal.id")) | ||
| goal: Mapped[Optional["Goal"]] = relationship(back_populates="tasks") |
| "id":self.id, | ||
| "title":self.title, | ||
| "description":self.description, | ||
| "is_complete":self.completed_at is not None, |
|
|
||
| @classmethod | ||
| def from_dict(cls, task_data): | ||
| completed_at = datetime if task_data.get("is_complete", False) else None |
Comment on lines
+19
to
+28
|
|
||
| try: | ||
| new_task = Task.from_dict(request_body) | ||
|
|
||
| except KeyError as e: | ||
| response = {"details": "Invalid data"} | ||
| abort(make_response(response, 400)) | ||
|
|
||
| db.session.add(new_task) | ||
| db.session.commit() |
There was a problem hiding this comment.
Another place that is a sign for us to refactor this logic like in our previous create route.
Comment on lines
+87
to
+94
| task = validate_task(task_id) | ||
|
|
||
| task.mark_complete() | ||
| db.session.commit() | ||
|
|
||
| post_to_slack(task) | ||
|
|
||
| return {"task": task.to_dict()}, 200 |
Comment on lines
+108
to
+142
| def validate_task(task_id): | ||
| try: | ||
| task_id = int(task_id) | ||
| except: | ||
| response = {"message": f"task {task_id} invalid"} | ||
| abort(make_response(response , 400)) | ||
|
|
||
| query = db.select(Task).where(Task.id == task_id) | ||
| task = db.session.scalar(query) | ||
|
|
||
| if not task: | ||
| response = {"message": "task not found"} | ||
| abort(make_response(response, 404)) | ||
| return task | ||
|
|
||
| def post_to_slack(task): | ||
| headers = { | ||
| "Authorization": f"Bearer {SLACK_API_TOKEN}", | ||
| "Content-Type": "application/json", | ||
|
|
||
| } | ||
| if task.completed_at: | ||
| data = { | ||
| "text": f"Task '{task.title}' has been marked complete", | ||
| "channel": "C080MLHBX5W", | ||
| } | ||
| else: | ||
| data = { | ||
| "text": f"Task '{task.title}' has been marked incomplete", | ||
| "channel": "C080MLHBX5W", | ||
| } | ||
|
|
||
| r = requests.post(SLACK_API_URL, headers=headers, json=data) | ||
|
|
||
| return r No newline at end of file |
There was a problem hiding this comment.
Both of these functions could live in our utilities file to better separate the concerns of our files.
Comment on lines
+62
to
+64
| assert response_body == { | ||
| "message": "task not found" | ||
| } |
Comment on lines
+93
to
+106
| response = client.put("/goals/1", json={ | ||
| "title": "Build a habit of going outside daily" | ||
| }) | ||
| # Assert | ||
| response_body = response.get_json() | ||
| # ---- Complete Assertions Here ---- | ||
| # assertion 1 goes here | ||
| # assertion 2 goes here | ||
| # assertion 3 goes here | ||
| assert response.status_code == 200 | ||
| assert "goal" in response_body | ||
| assert response_body == { | ||
| "goal" : { | ||
| "id": 1, | ||
| "title": "Build a habit of going outside daily" | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.