Standardize on mock_response_factory in tests

- Update test files to use mock_response_factory consistently
- Replace direct manipulations of mock_response with factory usage
- Keep documentation in DEVELOPMENT.md about the standardized approach

Author: jpstroop

docs/DEVELOPMENT.md

@@ -195,15 +195,28 @@ All resource mocks are in the root [conftest.py](tests/conftest.py).
 
 ### Response Mocking
 
-The test suite uses consistent patterns for mocking API responses:
+The test suite uses the `mock_response_factory` fixture to create consistent,
+configurable mock responses:
 
 ```python
-mock_response = Mock()
-mock_response.json.return_value = {"data": "test"}
-mock_response.headers = {"content-type": "application/json"}
-mock_response.status_code = 200
+# Creating a mock response with status code and data
+mock_response = mock_response_factory(200, {"data": "test"})
+
+# Creating a mock response with additional headers
+mock_response = mock_response_factory(
+    status_code=200,
+    json_data={"data": "test"},
+    headers={"custom-header": "value"}
+)
+
+# Creating a delete response with no content (204)
+mock_response = mock_response_factory(204)
 ```
 
+This approach provides a clean, standardized way to create mock responses with
+the desired status code, data, and headers. All test files should use this
+factory method rather than manually configuring mock responses.
+
 ## OAuth Callback Implementation
 
 The OAuth callback mechanism is implemented using two main classes:

tests/fitbit_client/resources/active_zone_minutes/test_get_azm_timeseries.py

@@ -3,9 +3,9 @@
 """Tests for the get_azm_timeseries endpoint."""
 
 
-def test_get_azm_timeseries_with_today_date(azm_resource, mock_response):
+def test_get_azm_timeseries_with_today_date(azm_resource, mock_response_factory):
     """Test using 'today' as the date parameter"""
-    mock_response.json.return_value = {"activities-active-zone-minutes": []}
+    mock_response = mock_response_factory(200, {"activities-active-zone-minutes": []})
     azm_resource.oauth.request.return_value = mock_response
     result = azm_resource.get_azm_timeseries_by_date(date="today")
     assert result == mock_response.json.return_value

tests/fitbit_client/resources/body_timeseries/test_get_body_timeseries_by_date.py

@@ -54,11 +54,11 @@ def test_get_body_timeseries_by_date_period_validation(body_timeseries):
             )
 
 
-def test_get_body_timeseries_by_date_successful_flow(body_timeseries, mock_response):
+def test_get_body_timeseries_by_date_successful_flow(body_timeseries, mock_response_factory):
     """Test the successful flow through validation and request for get_body_timeseries_by_date."""
     # Set up the mock response
+    mock_response = mock_response_factory(200, {"expected": "response"})
     body_timeseries.oauth.request.return_value = mock_response
-    mock_response.json.return_value = {"expected": "response"}
 
     # Test with BMI resource type (which allows all periods)
     result = body_timeseries.get_body_timeseries_by_date(
@@ -103,11 +103,11 @@ def test_get_body_timeseries_by_date_successful_flow(body_timeseries, mock_respo
     )
 
 
-def test_get_body_timeseries_by_date_makes_correct_request(body_timeseries, mock_response):
+def test_get_body_timeseries_by_date_makes_correct_request(body_timeseries, mock_response_factory):
     """Test that the correct endpoint is called with proper parameters."""
     # Set up the mock response
+    mock_response = mock_response_factory(200, {"expected": "response"})
     body_timeseries.oauth.request.return_value = mock_response
-    mock_response.json.return_value = {"expected": "response"}
 
     # Call the method
     result = body_timeseries.get_body_timeseries_by_date(

tests/fitbit_client/resources/body_timeseries/test_get_weight_timeseries_by_date.py

@@ -36,11 +36,13 @@ def test_get_weight_timeseries_by_date_period_validation(body_timeseries):
         assert f"Period {period.value} not supported for weight" in str(exc_info.value)
 
 
-def test_get_weight_timeseries_by_date_makes_correct_request(body_timeseries, mock_response):
+def test_get_weight_timeseries_by_date_makes_correct_request(
+    body_timeseries, mock_response_factory
+):
     """Test that the correct endpoint is called with proper parameters."""
     # Set up the mock response
+    mock_response = mock_response_factory(200, {"expected": "response"})
     body_timeseries.oauth.request.return_value = mock_response
-    mock_response.json.return_value = {"expected": "response"}
 
     # Call the method
     result = body_timeseries.get_weight_timeseries_by_date(

tests/fitbit_client/resources/body_timeseries/test_get_weight_timeseries_by_date_range.py

@@ -42,11 +42,13 @@ def test_get_weight_timeseries_by_date_range_max_days(body_timeseries):
     assert "weight" in str(exc_info.value)
 
 
-def test_get_weight_timeseries_by_date_range_makes_correct_request(body_timeseries, mock_response):
+def test_get_weight_timeseries_by_date_range_makes_correct_request(
+    body_timeseries, mock_response_factory
+):
     """Test that the correct endpoint is called with proper parameters."""
     # Set up the mock response
+    mock_response = mock_response_factory(200, {"expected": "response"})
     body_timeseries.oauth.request.return_value = mock_response
-    mock_response.json.return_value = {"expected": "response"}
 
     # Call the method with a valid date range (under 31 days)
     result = body_timeseries.get_weight_timeseries_by_date_range(

tests/fitbit_client/resources/friends/test_get_friends.py

@@ -3,23 +3,25 @@
 """Tests for the get_friends endpoint."""
 
 
-def test_get_friends(friends_resource, mock_oauth_session, mock_response):
+def test_get_friends(friends_resource, mock_oauth_session, mock_response_factory):
     """Test getting friends list"""
-    mock_response.json.return_value = {
-        "data": [
-            {
-                "type": "person",
-                "id": "ABC123",
-                "attributes": {
-                    "avatar": "http://example.com/avatar.jpg",
-                    "child": False,
-                    "friend": True,
-                    "name": "Test User",
-                },
-            }
-        ]
-    }
-    mock_response.headers = {"content-type": "application/json"}
+    mock_response = mock_response_factory(
+        200,
+        {
+            "data": [
+                {
+                    "type": "person",
+                    "id": "ABC123",
+                    "attributes": {
+                        "avatar": "http://example.com/avatar.jpg",
+                        "child": False,
+                        "friend": True,
+                        "name": "Test User",
+                    },
+                }
+            ]
+        },
+    )
     mock_oauth_session.request.return_value = mock_response
     result = friends_resource.get_friends()
     assert len(result) == 1

tests/fitbit_client/resources/heartrate_timeseries/test_get_heartrate_timeseries_by_date.py

@@ -15,7 +15,7 @@
 
 
 def test_get_heartrate_timeseries_by_date_success(
-    heartrate_resource, mock_oauth_session, mock_response
+    heartrate_resource, mock_oauth_session, mock_response_factory
 ):
     """Test successful retrieval of heart rate data by date and period"""
     response_data = {
@@ -38,7 +38,7 @@ def test_get_heartrate_timeseries_by_date_success(
             }
         ]
     }
-    mock_response.json.return_value = response_data
+    mock_response = mock_response_factory(200, response_data)
     mock_oauth_session.request.return_value = mock_response
     result = heartrate_resource.get_heartrate_timeseries_by_date(
         date="2024-02-10", period=Period.ONE_DAY
@@ -54,9 +54,9 @@ def test_get_heartrate_timeseries_by_date_success(
     )
 
 
-def test_get_heartrate_timeseries_by_date_today(heartrate_resource, mock_response):
+def test_get_heartrate_timeseries_by_date_today(heartrate_resource, mock_response_factory):
     """Test that 'today' is accepted as a valid date"""
-    mock_response.json.return_value = {"activities-heart": []}
+    mock_response = mock_response_factory(200, {"activities-heart": []})
     heartrate_resource.oauth.request.return_value = mock_response
     result = heartrate_resource.get_heartrate_timeseries_by_date(
         date="today", period=Period.ONE_DAY

tests/fitbit_client/resources/nutrition/test_create_food.py

@@ -11,9 +11,11 @@
 from fitbit_client.resources._constants import NutritionalValue
 
 
-def test_create_food_success(nutrition_resource, mock_response):
+def test_create_food_success(nutrition_resource, mock_response_factory):
     """Test successful creation of a new food"""
-    mock_response.json.return_value = {"foodId": 12345, "name": "Test Food", "calories": 100}
+    mock_response = mock_response_factory(
+        200, {"foodId": 12345, "name": "Test Food", "calories": 100}
+    )
     nutrition_resource.oauth.request.return_value = mock_response
     result = nutrition_resource.create_food(
         name="Test Food",
@@ -47,9 +49,9 @@ def test_create_food_success(nutrition_resource, mock_response):
     )
 
 
-def test_create_food_with_string_nutritional_values(nutrition_resource, mock_response):
+def test_create_food_with_string_nutritional_values(nutrition_resource, mock_response_factory):
     """Test creating food with string nutritional value keys"""
-    mock_response.json.return_value = {"foodId": 12345, "name": "Test Food"}
+    mock_response = mock_response_factory(200, {"foodId": 12345, "name": "Test Food"})
     nutrition_resource.oauth.request.return_value = mock_response
     result = nutrition_resource.create_food(
         name="Test Food",
@@ -102,9 +104,11 @@ def test_create_food_calories_from_fat_must_be_integer(nutrition_resource):
     assert "Calories from fat must be an integer" in str(exc_info.value)
 
 
-def test_create_food_with_calories_from_fat(nutrition_resource, mock_response):
+def test_create_food_with_calories_from_fat(nutrition_resource, mock_response_factory):
     """Test creating food with calories from fat as an integer"""
-    mock_response.json.return_value = {"foodId": 12345, "name": "Test Food", "calories": 100}
+    mock_response = mock_response_factory(
+        200, {"foodId": 12345, "name": "Test Food", "calories": 100}
+    )
     nutrition_resource.oauth.request.return_value = mock_response
 
     result = nutrition_resource.create_food(

tests/fitbit_client/resources/nutrition/test_create_food_log.py

@@ -14,11 +14,11 @@
 from fitbit_client.resources._constants import NutritionalValue
 
 
-def test_create_food_log_with_food_id_success(nutrition_resource, mock_response):
+def test_create_food_log_with_food_id_success(nutrition_resource, mock_response_factory):
     """Test successful creation of a food log entry using food ID"""
-    mock_response.json.return_value = {
-        "foodLog": {"logId": 12345, "loggedFood": {"foodId": 67890, "amount": 1.0}}
-    }
+    mock_response = mock_response_factory(
+        200, {"foodLog": {"logId": 12345, "loggedFood": {"foodId": 67890, "amount": 1.0}}}
+    )
     nutrition_resource.oauth.request.return_value = mock_response
     result = nutrition_resource.create_food_log(
         date="2025-02-08",
@@ -46,11 +46,11 @@ def test_create_food_log_with_food_id_success(nutrition_resource, mock_response)
     )
 
 
-def test_create_food_log_with_custom_food_success(nutrition_resource, mock_response):
+def test_create_food_log_with_custom_food_success(nutrition_resource, mock_response_factory):
     """Test successful creation of a food log entry using custom food details"""
-    mock_response.json.return_value = {
-        "foodLog": {"logId": 12345, "loggedFood": {"name": "Custom Food", "amount": 1.0}}
-    }
+    mock_response = mock_response_factory(
+        200, {"foodLog": {"logId": 12345, "loggedFood": {"name": "Custom Food", "amount": 1.0}}}
+    )
     nutrition_resource.oauth.request.return_value = mock_response
     result = nutrition_resource.create_food_log(
         date="2025-02-08",
@@ -86,11 +86,11 @@ def test_create_food_log_with_custom_food_success(nutrition_resource, mock_respo
     )
 
 
-def test_create_food_log_with_favorite_flag(nutrition_resource, mock_response):
+def test_create_food_log_with_favorite_flag(nutrition_resource, mock_response_factory):
     """Test that creating a food log with favorite=True sets the flag correctly"""
-    mock_response.json.return_value = {
-        "foodLog": {"logId": 12345, "loggedFood": {"foodId": 67890, "amount": 1.0}}
-    }
+    mock_response = mock_response_factory(
+        200, {"foodLog": {"logId": 12345, "loggedFood": {"foodId": 67890, "amount": 1.0}}}
+    )
     nutrition_resource.oauth.request.return_value = mock_response
     result = nutrition_resource.create_food_log(
         date="2025-02-08",
@@ -142,9 +142,9 @@ def test_create_food_log_with_favorite_flag(nutrition_resource, mock_response):
     )
 
 
-def test_create_food_log_with_brand_name_only(nutrition_resource, mock_response):
+def test_create_food_log_with_brand_name_only(nutrition_resource, mock_response_factory):
     """Test creating food log with only brand name (lines 172-174)"""
-    mock_response.json.return_value = {"foodLog": {"logId": 12345}}
+    mock_response = mock_response_factory(200, {"foodLog": {"logId": 12345}})
     nutrition_resource.oauth.request.return_value = mock_response
     result = nutrition_resource.create_food_log(
         date="2025-02-08",
@@ -174,9 +174,9 @@ def test_create_food_log_with_brand_name_only(nutrition_resource, mock_response)
     )
 
 
-def test_create_food_log_none_handling(nutrition_resource, mock_response):
+def test_create_food_log_none_handling(nutrition_resource, mock_response_factory):
     """Test handling of None values for food_name and calories"""
-    mock_response.json.return_value = {"foodLog": {"logId": 12345}}
+    mock_response = mock_response_factory(200, {"foodLog": {"logId": 12345}})
     nutrition_resource.oauth.request.return_value = mock_response
 
     # Save original method
@@ -202,7 +202,7 @@ def test_method(date, meal_type_id, unit_id, amount, **kwargs):
             if calories is not None:
                 params["calories"] = calories
 
-        return mock_response.json.return_value
+        return mock_response.json()
 
     try:
         # Replace with our test method
@@ -260,10 +260,9 @@ def test_create_food_log_invalid_date(nutrition_resource):
         )
 
 
-def test_create_food_log_allows_today(nutrition_resource, mock_response):
+def test_create_food_log_allows_today(nutrition_resource, mock_response_factory):
     """Test that 'today' is accepted as a valid date"""
-    mock_response.json.return_value = {"foodLog": {"logId": 12345}}
-    mock_response.headers = {"content-type": "application/json"}
+    mock_response = mock_response_factory(200, {"foodLog": {"logId": 12345}})
     nutrition_resource.oauth.request.return_value = mock_response
     nutrition_resource.create_food_log(
         date="today", meal_type_id=MealType.BREAKFAST, unit_id=147, amount=100.0, food_id=67890

tests/fitbit_client/resources/nutrition/test_delete_custom_food.py

@@ -3,9 +3,9 @@
 """Tests for the delete_custom_food endpoint."""
 
 
-def test_delete_custom_food_success(nutrition_resource, mock_response):
+def test_delete_custom_food_success(nutrition_resource, mock_response_factory):
     """Test successful deletion of a custom food"""
-    mock_response.status_code = 204
+    mock_response = mock_response_factory(204)
     nutrition_resource.oauth.request.return_value = mock_response
     result = nutrition_resource.delete_custom_food(food_id=12345)
     assert result is None