splits toggle_complete into two endpoints, beefs up tests

Author: tildeee

ada-project-docs/wave_03.md

@@ -22,14 +22,14 @@ The following route is required for wave 3.
 - JSON's value of `true` is similar to Python's value of `True`, and `false` is similar to Python's `False`.
 - JSON's value of `null` is similar to Python's value of `None`.
 
-### Toggle Complete: Mark Complete on an Incomplete Task
+### Mark Complete on an Incompleted Task
 
 Given a task that has:
 
 - An id `1`
 - A `completed_at` attribute with a `null` value
 
-when I send a `PATCH` request to `/tasks/1/complete`,
+when I send a `PATCH` request to `/tasks/1/mark_complete`,
 
 then the task is updated, so that its `completed_at` value is the current date, and I get this response:
 
@@ -46,14 +46,14 @@ then the task is updated, so that its `completed_at` value is the current date,
 }
 ```
 
-### Toggle Complete: Mark Complete on an Incomplete Task
+### Mark Incomplete on a Completed Task
 
 Given a task that has:
 
 - An id `1`
 - A `completed_at` attribute with a datetime value
 
-when I send a `PATCH` request to `/tasks/1/complete`,
+when I send a `PATCH` request to `/tasks/1/mark_incomplete`,
 
 then the task is updated, so that its `completed_at` value is `null`/`None`, and I get this response:
 
@@ -69,3 +69,59 @@ then the task is updated, so that its `completed_at` value is `null`/`None`, and
   }
 }
 ```
+
+### Mark Complete on a Completed Task
+
+Given a task that has:
+
+- An id `1`
+- A `completed_at` attribute with a datetime value
+
+when I send a `PATCH` request to `/tasks/1/mark_complete`,
+
+then I want this to behave exactly like `/tasks/1/mark_complete` for an incomplete task. The task is updated, so that its `completed_at` value is the current date, and I get this response:
+
+`200 OK`
+
+```json
+{
+  "task": {
+    "id": 1,
+    "title": "Go on my daily walk 🏞",
+    "description": "Notice something new every day",
+    "is_complete": true
+  }
+}
+```
+
+### Mark Incomplete on an Incompleted Task
+
+Given a task that has:
+
+- An id `1`
+- A `completed_at` attribute with a `null` value
+
+when I send a `PATCH` request to `/tasks/1/mark_incomplete`,
+
+then I want this to behave exactly like `/tasks/1/mark_complete` for an incomplete task. Its `completed_at` value remains as `null`/`None`, and I get this response:
+
+`200 OK`
+
+```json
+{
+  "task": {
+    "id": 1,
+    "title": "Go on my daily walk 🏞",
+    "description": "Notice something new every day",
+    "is_complete": false
+  }
+}
+```
+
+## Mark Complete and Mark Incomplete for Missing Tasks
+
+Given that there are no tasks with the ID `1`,
+
+When I send a `PATCH` request to `/tasks/1/mark_complete` or a `PATCH` request `/tasks/1/mark_incomplete`,
+
+Then I get a `404 Not Found`, with no response body.

ada-project-docs/wave_04.md

@@ -15,7 +15,7 @@ To complete this wave, follow these steps:
 1. Setup a Slack workspace and create a Slackbot with the right permissions, and get a Slackbot API key
 1. Verify that your Slackbot works using the Slack Tester
 1. Verify that your Slackbot works using Postman
-1. Modify the `/tasks/<task_id>/complete` route to make a call to the Slack API
+1. Modify the `/tasks/<task_id>/mark_complete` route to make a call to the Slack API
 1. Use Postman to verify your work
 
 ### Setup a Slack Workspace
@@ -95,15 +95,15 @@ Let's verify that this API call works even in Postman!
 
 - We could put in the token as a query param. However, the Slack API documentation states that it prefers API keys to be sent in the "Authorization" request header.
 
-### Modify `/tasks/<task_id>/complete` to Call the Slack API: Toggle Complete
+### Modify `/tasks/<task_id>/mark_complete` to Call the Slack API
 
 Given a task that has:
 
 - An id `1`
 - A `title` attribute with the value `"My Beautiful Task"`
 - A `completed_at` attribute with a `null` value
 
-when I send a `PATCH` request to `/tasks/1/complete`,
+when I send a `PATCH` request to `/tasks/1/mark_complete`,
 
 then a Slack message is immediately sent to the channel `task-notifications` in the configured Slack workspace, with the text `"Someone just completed the task My Beautiful Task"`. "My Beautiful Task" should be the title of the task.
 

tests/test_wave_03.py

@@ -4,7 +4,7 @@
 from app.models.task import Task
 
 
-def test_toggle_complete_on_incomplete_task(client, one_task):
+def test_mark_complete_on_incomplete_task(client, one_task):
     # Arrange
     """
     The future Wave 4 adds special functionality to this route,
@@ -22,7 +22,7 @@ def test_toggle_complete_on_incomplete_task(client, one_task):
         mock_get.return_value.status_code = 200
 
         # Act
-        response = client.patch("/tasks/1/complete")
+        response = client.patch("/tasks/1/mark_complete")
     response_body = response.get_json()
 
     # Assert
@@ -40,9 +40,9 @@ def test_toggle_complete_on_incomplete_task(client, one_task):
     assert Task.query.get(1).completed_at
 
 
-def test_toggle_complete_on_complete_task(client, completed_task):
+def test_mark_incomplete_on_complete_task(client, completed_task):
     # Act
-    response = client.patch("/tasks/1/complete")
+    response = client.patch("/tasks/1/mark_incomplete")
     response_body = response.get_json()
 
     # Assert
@@ -59,6 +59,81 @@ def test_toggle_complete_on_complete_task(client, completed_task):
     assert Task.query.get(1).completed_at == None
 
 
+def test_mark_complete_on_completed_task(client, completed_task):
+    # Arrange
+    """
+    The future Wave 4 adds special functionality to this route,
+    so for this test, we need to set-up "mocking."
+
+    Mocking will help our tests work in isolation, which is a
+    good thing!
+
+    We need to mock any POST requests that may occur during this
+    test (due to Wave 4).
+
+    There is no action needed here, the tests should work as-is.
+    """
+    with patch("app.routes.requests.post") as mock_get:
+        mock_get.return_value.status_code = 200
+
+        # Act
+        response = client.patch("/tasks/1/mark_complete")
+    response_body = response.get_json()
+
+    # Assert
+    assert response.status_code == 200
+    assert "task" in response_body
+    assert response_body["task"]["is_complete"] == True
+    assert response_body == {
+        "task": {
+            "id": 1,
+            "title": "Go on my daily walk 🏞",
+            "description": "Notice something new every day",
+            "is_complete": True
+        }
+    }
+    assert Task.query.get(1).completed_at
+
+
+def test_mark_incomplete_on_incomplete_task(client, one_task):
+    # Act
+    response = client.patch("/tasks/1/mark_incomplete")
+    response_body = response.get_json()
+
+    # Assert
+    assert response.status_code == 200
+    assert response_body["task"]["is_complete"] == False
+    assert response_body == {
+        "task": {
+            "id": 1,
+            "title": "Go on my daily walk 🏞",
+            "description": "Notice something new every day",
+            "is_complete": False
+        }
+    }
+    assert Task.query.get(1).completed_at == None
+
+
+def test_mark_complete_missing_task(client):
+    # Act
+    response = client.patch("/tasks/1/mark_complete")
+    response_body = response.get_json()
+
+    # Assert
+    assert response.status_code == 404
+    assert response_body == None
+
+
+def test_mark_incomplete_missing_task(client):
+    # Act
+    response = client.patch("/tasks/1/mark_incomplete")
+    response_body = response.get_json()
+
+    # Assert
+    assert response.status_code == 404
+    assert response_body == None
+
+
 # Let's add this test for creating tasks, now that
 # the completion functionality has been implemented
 def test_create_task_with_valid_completed_at(client):