now a test module per method

Author: jpstroop

.gitignore

@@ -54,5 +54,6 @@ _data
 _logs
 _sample_responses
 _scripts
+_cov_html
 secrets.json
 tokens.json

TODO.md

@@ -2,22 +2,26 @@
 
 ## TODO
 
-- [ ] break bigger test files down into files by method: activity and nutrition,
-  at least!
-
-- [ ] confirm that validation of methods where before_date or after_date is
-  handled consistently across classes
+\_ [ ] Complete coverage
 
 - [ ] need constants for sort "desc"/"asc"
 
-- [ ] break tests into separate files for each method? It's a lot, but the test
-  files are huge
+- [ ] Confront MyPy. See https://stackoverflow.com/a/51294709 for json help
+
+- [ ] add a note about typing, method naming semantics, aliases, and interns.
+
+- [ ] When typing resource, wrap the actual response type around the JSONType,,
+  e.g. List[JSONType], Dict[str, JSONType], so that the user can actually know
+  what to expect (or None, of course)
+
+- [ ] Test that all methods have an alias in `Client` and that the signatures
+  match
 
 - [ ] validate:
   `fitbit_client.exceptions.ValidationException: Calories From Fat must be a valid non-negative number. Currently it is "146.79".`
   It needs to be a positive int!
 
-- [ ] Make sure that mocks have type annotations
+- [ ] Should mocks have type annotations?
 
 - [ ] consolidate fixures where possible
 
@@ -66,17 +70,9 @@
 - [ ] Form to chang scopes are part of OAuth flow? Maybe get rid of the cut and
   paste method altogether? It's less to test...
 
-- [ ] Validation to NutritionResource - Calories must be ints, not floats like
-  everything else
-
 - [ ] Response validation? Accidentally doing a GET instead of a POST on, e.g.
   `food.json` will yield a response, but not the one you want!
 
-- [ ] Confront MyPy. See https://stackoverflow.com/a/51294709 for json help
-
-- [ ] Test that all methods have an alias in `Client` and that the signatures
-  match
-
 - [ ] Make the food download_food_logs (rename to `get_food_logs`) and food log
   to CSV part of one helper package. It should expand the foods to have their
   complete nutrition (a separate call for each unique food)

fitbit_client/client.py

@@ -12,7 +12,7 @@
 from fitbit_client.resources.activity_timeseries import ActivityTimeSeriesResource
 from fitbit_client.resources.body import BodyResource
 from fitbit_client.resources.body_timeseries import BodyTimeSeriesResource
-from fitbit_client.resources.breathingrate import BreathingRateResource
+from fitbit_client.resources.breathing_rate import BreathingRateResource
 from fitbit_client.resources.cardio_fitness_score import CardioFitnessScoreResource
 from fitbit_client.resources.device import DeviceResource
 from fitbit_client.resources.electrocardiogram import ElectrocardiogramResource
@@ -83,7 +83,7 @@ def __init__(
         self.activity: ActivityResource = ActivityResource(self.auth.session, language=language, locale=locale)
         self.body_timeseries: BodyTimeSeriesResource = BodyTimeSeriesResource(self.auth.session, language=language, locale=locale)
         self.body: BodyResource = BodyResource(self.auth.session, language=language, locale=locale)
-        self.breathingrate: BreathingRateResource = BreathingRateResource(self.auth.session, language=language, locale=locale)
+        self.breathing_rate: BreathingRateResource = BreathingRateResource(self.auth.session, language=language, locale=locale)
         self.cardio_fitness_score: CardioFitnessScoreResource = CardioFitnessScoreResource(self.auth.session, language=language, locale=locale)
         self.device: DeviceResource = DeviceResource(self.auth.session, language=language, locale=locale)
         self.electrocardiogram: ElectrocardiogramResource = ElectrocardiogramResource(self.auth.session, language=language, locale=locale)

fitbit_client/resources/breathingrate.py fitbit_client/resources/breathing_rate.pyfitbit_client/resources/breathingrate.py renamed to fitbit_client/resources/breathing_rate.py

@@ -1,4 +1,4 @@
-# fitbit_client/resources/breathingrate.py
+# fitbit_client/resources/breathing_rate.py
 
 # Standard library imports
 from typing import Any

pyproject.toml

@@ -75,7 +75,7 @@ extensions = [
 testpaths = ["tests"]
 minversion = 6.0
 python_files = "test_*.py"
-addopts = "-ra -q --cov=fitbit_client --cache-clear --cov-report=term-missing -v --tb=native"
+addopts = "-ra -q --cov=fitbit_client --cache-clear --cov-report=term-missing --cov-report=html:cov_html -v --tb=native"
 pythonpath = ["."]
 
 # https://pytest-cov.readthedocs.io/en/latest/config.html

tests/resources/active_zone_minutes/__init__.py

@@ -0,0 +1 @@
+# tests/resources/active_zone_minutes/__init__.py

tests/resources/active_zone_minutes/conftest.py

@@ -0,0 +1,23 @@
+# tests/resources/active_zone_minutes/conftest.py
+
+"""Fixtures for active_zone_minutes tests."""
+
+# Standard library imports
+
+# Standard library imports
+from unittest.mock import patch
+
+# Third party imports
+from pytest import fixture
+
+# Local imports
+from fitbit_client.resources.active_zone_minutes import ActiveZoneMinutesResource
+
+
+@fixture
+def azm_resource(mock_oauth_session, mock_logger):
+    """Fixture to provide an ActiveZoneMinutesResource instance"""
+    with patch("fitbit_client.resources.base.getLogger", return_value=mock_logger):
+        return ActiveZoneMinutesResource(
+            oauth_session=mock_oauth_session, locale="en_US", language="en_US"
+        )

tests/resources/active_zone_minutes/test_get_azm_timeseries.py

@@ -0,0 +1,19 @@
+# tests/resources/active_zone_minutes/test_get_azm_timeseries.py
+
+"""Tests for the get_azm_timeseries endpoint."""
+
+
+def test_get_azm_timeseries_with_today_date(azm_resource, mock_response):
+    """Test using 'today' as the date parameter"""
+    mock_response.json.return_value = {"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
+    azm_resource.oauth.request.assert_called_once_with(
+        "GET",
+        "https://api.fitbit.com/1/user/-/activities/active-zone-minutes/date/today/1d.json",
+        data=None,
+        json=None,
+        params=None,
+        headers={"Accept-Locale": "en_US", "Accept-Language": "en_US"},
+    )

tests/resources/active_zone_minutes/test_get_azm_timeseries_by_date.py

@@ -0,0 +1,98 @@
+# tests/resources/active_zone_minutes/test_get_azm_timeseries_by_date.py
+
+"""Tests for the get_azm_timeseries_by_date endpoint."""
+
+# Third party imports
+
+# Third party imports
+from pytest import raises
+
+# Local imports
+from fitbit_client.exceptions import InvalidDateException
+from fitbit_client.resources.constants import Period
+
+
+def test_get_azm_timeseries_by_date_success(azm_resource, mock_response):
+    """Test successful retrieval of AZM time series by date with default period"""
+    mock_response.json.return_value = {
+        "activities-active-zone-minutes": [
+            {
+                "dateTime": "2025-02-01",
+                "value": {
+                    "activeZoneMinutes": 102,
+                    "fatBurnActiveZoneMinutes": 90,
+                    "cardioActiveZoneMinutes": 8,
+                    "peakActiveZoneMinutes": 4,
+                },
+            }
+        ]
+    }
+    azm_resource.oauth.request.return_value = mock_response
+    result = azm_resource.get_azm_timeseries_by_date(date="2025-02-01")
+    assert result == mock_response.json.return_value
+    azm_resource.oauth.request.assert_called_once_with(
+        "GET",
+        "https://api.fitbit.com/1/user/-/activities/active-zone-minutes/date/2025-02-01/1d.json",
+        data=None,
+        json=None,
+        params=None,
+        headers={"Accept-Locale": "en_US", "Accept-Language": "en_US"},
+    )
+
+
+def test_get_azm_timeseries_by_date_explicit_period(azm_resource, mock_response):
+    """Test successful retrieval of AZM time series by date with explicit ONE_DAY period"""
+    mock_response.json.return_value = {"activities-active-zone-minutes": []}
+    azm_resource.oauth.request.return_value = mock_response
+    result = azm_resource.get_azm_timeseries_by_date(date="2025-02-01", period=Period.ONE_DAY)
+    assert result == mock_response.json.return_value
+    azm_resource.oauth.request.assert_called_once_with(
+        "GET",
+        "https://api.fitbit.com/1/user/-/activities/active-zone-minutes/date/2025-02-01/1d.json",
+        data=None,
+        json=None,
+        params=None,
+        headers={"Accept-Locale": "en_US", "Accept-Language": "en_US"},
+    )
+
+
+def test_get_azm_timeseries_by_date_with_user_id(azm_resource, mock_response):
+    """Test getting AZM time series for a specific user"""
+    mock_response.json.return_value = {"activities-active-zone-minutes": []}
+    azm_resource.oauth.request.return_value = mock_response
+    result = azm_resource.get_azm_timeseries_by_date(date="2025-02-01", user_id="123ABC")
+    assert result == mock_response.json.return_value
+    azm_resource.oauth.request.assert_called_once_with(
+        "GET",
+        "https://api.fitbit.com/1/user/123ABC/activities/active-zone-minutes/date/2025-02-01/1d.json",
+        data=None,
+        json=None,
+        params=None,
+        headers={"Accept-Locale": "en_US", "Accept-Language": "en_US"},
+    )
+
+
+def test_get_azm_timeseries_by_date_invalid_period(azm_resource):
+    """Test that using any period other than ONE_DAY raises ValueError"""
+    invalid_periods = [
+        Period.SEVEN_DAYS,
+        Period.THIRTY_DAYS,
+        Period.ONE_WEEK,
+        Period.ONE_MONTH,
+        Period.THREE_MONTHS,
+        Period.SIX_MONTHS,
+        Period.ONE_YEAR,
+        Period.MAX,
+    ]
+    for period in invalid_periods:
+        with raises(ValueError) as exc_info:
+            azm_resource.get_azm_timeseries_by_date(date="2025-02-01", period=period)
+        assert "Only 1d period is supported for AZM time series" in str(exc_info.value)
+
+
+def test_get_azm_timeseries_by_date_invalid_date(azm_resource):
+    """Test that invalid date format raises InvalidDateException"""
+    with raises(InvalidDateException) as exc_info:
+        azm_resource.get_azm_timeseries_by_date(date="invalid-date")
+    assert "invalid-date" in str(exc_info.value)
+    assert exc_info.value.field_name == "date"

tests/resources/active_zone_minutes/test_get_azm_timeseries_by_interval.py

@@ -0,0 +1,101 @@
+# tests/resources/active_zone_minutes/test_get_azm_timeseries_by_interval.py
+
+"""Tests for the get_azm_timeseries_by_interval endpoint."""
+
+# Third party imports
+
+# Standard library imports
+from datetime import datetime
+from datetime import timedelta
+
+# Third party imports
+from pytest import raises
+
+# Local imports
+from fitbit_client.exceptions import InvalidDateException
+from fitbit_client.exceptions import InvalidDateRangeException
+
+
+def test_get_azm_timeseries_by_interval_success(azm_resource, mock_response):
+    """Test successful retrieval of AZM time series by date range"""
+    mock_response.json.return_value = {
+        "activities-active-zone-minutes": [
+            {
+                "dateTime": "2025-02-01",
+                "value": {
+                    "activeZoneMinutes": 102,
+                    "fatBurnActiveZoneMinutes": 90,
+                    "cardioActiveZoneMinutes": 8,
+                    "peakActiveZoneMinutes": 4,
+                },
+            },
+            {
+                "dateTime": "2025-02-02",
+                "value": {
+                    "activeZoneMinutes": 47,
+                    "fatBurnActiveZoneMinutes": 43,
+                    "cardioActiveZoneMinutes": 4,
+                },
+            },
+        ]
+    }
+    azm_resource.oauth.request.return_value = mock_response
+    result = azm_resource.get_azm_timeseries_by_interval(
+        start_date="2025-02-01", end_date="2025-02-02"
+    )
+    assert result == mock_response.json.return_value
+    azm_resource.oauth.request.assert_called_once_with(
+        "GET",
+        "https://api.fitbit.com/1/user/-/activities/active-zone-minutes/date/2025-02-01/2025-02-02.json",
+        data=None,
+        json=None,
+        params=None,
+        headers={"Accept-Locale": "en_US", "Accept-Language": "en_US"},
+    )
+
+
+def test_get_azm_timeseries_by_interval_with_user_id(azm_resource, mock_response):
+    """Test getting AZM time series by date range for a specific user"""
+    mock_response.json.return_value = {"activities-active-zone-minutes": []}
+    azm_resource.oauth.request.return_value = mock_response
+    result = azm_resource.get_azm_timeseries_by_interval(
+        start_date="2025-02-01", end_date="2025-02-02", user_id="123ABC"
+    )
+    assert result == mock_response.json.return_value
+    azm_resource.oauth.request.assert_called_once_with(
+        "GET",
+        "https://api.fitbit.com/1/user/123ABC/activities/active-zone-minutes/date/2025-02-01/2025-02-02.json",
+        data=None,
+        json=None,
+        params=None,
+        headers={"Accept-Locale": "en_US", "Accept-Language": "en_US"},
+    )
+
+
+def test_get_azm_timeseries_by_interval_invalid_dates(azm_resource):
+    """Test that invalid date formats raise InvalidDateException"""
+    with raises(InvalidDateException) as exc_info:
+        azm_resource.get_azm_timeseries_by_interval(start_date="invalid", end_date="2024-02-01")
+    assert "invalid" in str(exc_info.value)
+    assert exc_info.value.field_name == "start_date"
+    with raises(InvalidDateException) as exc_info:
+        azm_resource.get_azm_timeseries_by_interval(start_date="2024-02-01", end_date="invalid")
+    assert "invalid" in str(exc_info.value)
+    assert exc_info.value.field_name == "end_date"
+
+
+def test_get_azm_timeseries_by_interval_invalid_date_order(azm_resource):
+    """Test that start_date after end_date raises InvalidDateRangeException"""
+    with raises(InvalidDateRangeException) as exc_info:
+        azm_resource.get_azm_timeseries_by_interval(start_date="2025-02-02", end_date="2025-02-01")
+    assert "Start date 2025-02-02 is after end date 2025-02-01" in str(exc_info.value)
+
+
+def test_get_azm_timeseries_by_interval_exceeds_max_range(azm_resource):
+    """Test that exceeding the 1095 day range limit raises InvalidDateRangeException"""
+    start_date = (datetime.now() - timedelta(days=1096)).strftime("%Y-%m-%d")
+    end_date = datetime.now().strftime("%Y-%m-%d")
+    with raises(InvalidDateRangeException) as exc_info:
+        azm_resource.get_azm_timeseries_by_interval(start_date=start_date, end_date=end_date)
+    assert "1095 days" in str(exc_info.value)
+    assert "AZM time series" in str(exc_info.value)