bring back resource method aliases

Author: jpstroop

README.md

@@ -48,7 +48,10 @@ try:
     client.authenticate()
 
     # Make a request (e.g., get user profile)
+    # You can access resources directly:
     profile = client.user.get_profile()
+    # Or use method aliases for shorter syntax:
+    profile = client.get_profile()
     print(dumps(profile, indent=2))
 
 except Exception as e:
@@ -59,6 +62,29 @@ The response will always be the body of the API response, and is almost always a
 `Dict`, `List` or `None`. `nutrition.get_activity_tcx` is the exception. It
 returns XML (as a `str`).
 
+## Method Aliases
+
+All resource methods are available directly from the client instance. This means
+you can use:
+
+```python
+# Short form with method aliases
+client.get_profile()
+client.get_daily_activity_summary(date="2025-03-06")
+client.get_sleep_log_by_date(date="2025-03-06")
+```
+
+Instead of the longer form:
+
+```python
+# Standard resource access
+client.user.get_profile()
+client.activity.get_daily_activity_summary(date="2025-03-06")
+client.sleep.get_sleep_log_by_date(date="2025-03-06")
+```
+
+Both approaches are equivalent, but aliases provide a more concise syntax.
+
 ## Authentication Methods
 
 ### 1. Automatic (Recommended)

docs/DEVELOPMENT.md

@@ -16,6 +16,9 @@
 - [Logging System](#logging-system)
   - [Application Logger](#application-logger)
   - [Data Logger](#data-logger)
+- [API Design](#api-design)
+  - [Resource-Based API](#resource-based-api)
+  - [Method Aliases](#method-aliases)
 - [Testing](#testing)
   - [Test Organization](#test-organization)
   - [Standard Test Fixtures](#standard-test-fixtures)
@@ -235,6 +238,63 @@ Data log entries contain:
 This logging system provides both operational visibility through the application
 logger and structured data capture through the data logger.
 
+## API Design
+
+The client implements a dual-level API design pattern that balances both
+organization and ease-of-use.
+
+### Resource-Based API
+
+The primary API structure is resource-based, organizing related endpoints into
+dedicated resource classes:
+
+- `client.user` - User profile and badges endpoints
+- `client.activity` - Activity tracking, goals, and summaries
+- `client.sleep` - Sleep logs and goals
+- etc.
+
+This organization provides a clean separation of concerns and makes the code
+more maintainable by grouping related functionality.
+
+### Method Aliases
+
+To improve developer experience, all resource methods are also available
+directly from the client instance through aliases. This means developers can
+choose between two equivalent approaches:
+
+```python
+# Standard resource-based access
+client.user.get_profile()
+client.activity.get_daily_activity_summary(date="2025-03-06")
+
+# Direct access via method aliases
+client.get_profile()
+client.get_daily_activity_summary(date="2025-03-06")
+```
+
+#### Rationale for Method Aliases
+
+Method aliases were implemented for several important reasons:
+
+1. **Reduced Verbosity**: Typing `client.resource_name.method_name(...)` with
+   many parameters can be tedious, especially when used frequently.
+
+2. **Flatter API Surface**: Many modern APIs prefer a flatter design that avoids
+   deep nesting, making the API more straightforward to use.
+
+3. **Method Name Uniqueness**: All resource methods in the Fitbit API have
+   unique names (e.g., there's only one `get_profile()` method), making it safe
+   to expose these methods directly on the client.
+
+4. **Preserve Both Options**: By maintaining both the resource-based access and
+   direct aliases, developers can choose the approach that best fits their needs
+   \- organization or conciseness.
+
+All method aliases are set up in the `_setup_method_aliases()` method in the
+`FitbitClient` class, which is called during initialization. Each alias is a
+direct reference to the corresponding resource method, ensuring consistent
+behavior regardless of how the method is accessed.
+
 ## Testing
 
 The project uses pytest for testing and follows a consistent testing approach

fitbit_client/client.py

@@ -113,7 +113,8 @@ def __init__(
         # isort: on
         self.logger.debug("Fitbit client initialized successfully")
 
-    # API aliases will be re-implemented after resource methods have been refactored.
+        # Set up method aliases
+        self._setup_method_aliases()
 
     def authenticate(self, force_new: bool = False) -> bool:
         """
@@ -145,3 +146,200 @@ def authenticate(self, force_new: bool = False) -> bool:
         except SystemException as e:
             self.logger.error(f"System error during authentication: {str(e)}")
             raise
+
+    def _setup_method_aliases(self) -> None:
+        """Set up direct access to resource methods as client attributes for convenience."""
+        self.logger.debug("Setting up method aliases")
+
+        # Active Zone Minutes
+        self.get_azm_timeseries_by_date = self.active_zone_minutes.get_azm_timeseries_by_date
+        self.get_azm_timeseries_by_interval = (
+            self.active_zone_minutes.get_azm_timeseries_by_interval
+        )
+
+        # Activity Timeseries
+        self.get_activity_timeseries_by_date = (
+            self.activity_timeseries.get_activity_timeseries_by_date
+        )
+        self.get_activity_timeseries_by_date_range = (
+            self.activity_timeseries.get_activity_timeseries_by_date_range
+        )
+
+        # Activity
+        self.create_activity_goals = self.activity.create_activity_goals
+        self.create_activity_goal = self.activity.create_activity_goal
+        self.create_activity_log = self.activity.create_activity_log
+        self.get_activity_log_list = self.activity.get_activity_log_list
+        self.create_favorite_activity = self.activity.create_favorite_activity
+        self.delete_activity_log = self.activity.delete_activity_log
+        self.delete_favorite_activity = self.activity.delete_favorite_activity
+        self.get_activity_goals = self.activity.get_activity_goals
+        self.get_daily_activity_summary = self.activity.get_daily_activity_summary
+        self.get_activity_type = self.activity.get_activity_type
+        self.get_all_activity_types = self.activity.get_all_activity_types
+        self.get_favorite_activities = self.activity.get_favorite_activities
+        self.get_frequent_activities = self.activity.get_frequent_activities
+        self.get_recent_activity_types = self.activity.get_recent_activity_types
+        self.get_lifetime_stats = self.activity.get_lifetime_stats
+        self.get_activity_tcx = self.activity.get_activity_tcx
+
+        # Body Timeseries
+        self.get_body_timeseries_by_date = self.body_timeseries.get_body_timeseries_by_date
+        self.get_body_timeseries_by_date_range = (
+            self.body_timeseries.get_body_timeseries_by_date_range
+        )
+        self.get_bodyfat_timeseries_by_date = self.body_timeseries.get_bodyfat_timeseries_by_date
+        self.get_bodyfat_timeseries_by_date_range = (
+            self.body_timeseries.get_bodyfat_timeseries_by_date_range
+        )
+        self.get_weight_timeseries_by_date = self.body_timeseries.get_weight_timeseries_by_date
+        self.get_weight_timeseries_by_date_range = (
+            self.body_timeseries.get_weight_timeseries_by_date_range
+        )
+
+        # Body
+        self.create_bodyfat_goal = self.body.create_bodyfat_goal
+        self.create_bodyfat_log = self.body.create_bodyfat_log
+        self.create_weight_goal = self.body.create_weight_goal
+        self.create_weight_log = self.body.create_weight_log
+        self.delete_bodyfat_log = self.body.delete_bodyfat_log
+        self.delete_weight_log = self.body.delete_weight_log
+        self.get_body_goals = self.body.get_body_goals
+        self.get_bodyfat_log = self.body.get_bodyfat_log
+        self.get_weight_logs = self.body.get_weight_logs
+
+        # Breathing Rate
+        self.get_breathing_rate_summary_by_date = (
+            self.breathing_rate.get_breathing_rate_summary_by_date
+        )
+        self.get_breathing_rate_summary_by_interval = (
+            self.breathing_rate.get_breathing_rate_summary_by_interval
+        )
+
+        # Cardio Fitness Score
+        self.get_vo2_max_summary_by_date = self.cardio_fitness_score.get_vo2_max_summary_by_date
+        self.get_vo2_max_summary_by_interval = (
+            self.cardio_fitness_score.get_vo2_max_summary_by_interval
+        )
+
+        # Device
+        self.get_devices = self.device.get_devices
+
+        # Electrocardiogram
+        self.get_ecg_log_list = self.electrocardiogram.get_ecg_log_list
+
+        # Friends
+        self.get_friends = self.friends.get_friends
+        self.get_friends_leaderboard = self.friends.get_friends_leaderboard
+
+        # Heartrate Timeseries
+        self.get_heartrate_timeseries_by_date = (
+            self.heartrate_timeseries.get_heartrate_timeseries_by_date
+        )
+        self.get_heartrate_timeseries_by_date_range = (
+            self.heartrate_timeseries.get_heartrate_timeseries_by_date_range
+        )
+
+        # Heartrate Variability
+        self.get_hrv_summary_by_date = self.heartrate_variability.get_hrv_summary_by_date
+        self.get_hrv_summary_by_interval = self.heartrate_variability.get_hrv_summary_by_interval
+
+        # Intraday
+        self.get_azm_intraday_by_date = self.intraday.get_azm_intraday_by_date
+        self.get_azm_intraday_by_interval = self.intraday.get_azm_intraday_by_interval
+        self.get_activity_intraday_by_date = self.intraday.get_activity_intraday_by_date
+        self.get_activity_intraday_by_interval = self.intraday.get_activity_intraday_by_interval
+        self.get_breathing_rate_intraday_by_date = self.intraday.get_breathing_rate_intraday_by_date
+        self.get_breathing_rate_intraday_by_interval = (
+            self.intraday.get_breathing_rate_intraday_by_interval
+        )
+        self.get_heartrate_intraday_by_date = self.intraday.get_heartrate_intraday_by_date
+        self.get_heartrate_intraday_by_interval = self.intraday.get_heartrate_intraday_by_interval
+        self.get_hrv_intraday_by_date = self.intraday.get_hrv_intraday_by_date
+        self.get_hrv_intraday_by_interval = self.intraday.get_hrv_intraday_by_interval
+        self.get_spo2_intraday_by_date = self.intraday.get_spo2_intraday_by_date
+        self.get_spo2_intraday_by_interval = self.intraday.get_spo2_intraday_by_interval
+
+        # Irregular Rhythm Notifications
+        self.get_irn_alerts_list = self.irregular_rhythm_notifications.get_irn_alerts_list
+        self.get_irn_profile = self.irregular_rhythm_notifications.get_irn_profile
+
+        # Nutrition Timeseries
+        self.get_nutrition_timeseries_by_date = (
+            self.nutrition_timeseries.get_nutrition_timeseries_by_date
+        )
+        self.get_nutrition_timeseries_by_date_range = (
+            self.nutrition_timeseries.get_nutrition_timeseries_by_date_range
+        )
+
+        # Nutrition
+        self.add_favorite_foods = self.nutrition.add_favorite_foods
+        self.add_favorite_food = self.nutrition.add_favorite_food
+        self.create_favorite_food = self.nutrition.create_favorite_food
+        self.create_food = self.nutrition.create_food
+        self.create_food_log = self.nutrition.create_food_log
+        self.create_food_goal = self.nutrition.create_food_goal
+        self.create_meal = self.nutrition.create_meal
+        self.create_water_goal = self.nutrition.create_water_goal
+        self.create_water_log = self.nutrition.create_water_log
+        self.delete_custom_food = self.nutrition.delete_custom_food
+        self.delete_favorite_foods = self.nutrition.delete_favorite_foods
+        self.delete_favorite_food = self.nutrition.delete_favorite_food
+        self.delete_food_log = self.nutrition.delete_food_log
+        self.delete_meal = self.nutrition.delete_meal
+        self.delete_water_log = self.nutrition.delete_water_log
+        self.get_food = self.nutrition.get_food
+        self.get_food_goals = self.nutrition.get_food_goals
+        self.get_food_log = self.nutrition.get_food_log
+        self.get_food_locales = self.nutrition.get_food_locales
+        self.get_food_units = self.nutrition.get_food_units
+        self.get_frequent_foods = self.nutrition.get_frequent_foods
+        self.get_recent_foods = self.nutrition.get_recent_foods
+        self.get_favorite_foods = self.nutrition.get_favorite_foods
+        self.get_meal = self.nutrition.get_meal
+        self.get_meals = self.nutrition.get_meals
+        self.get_water_goal = self.nutrition.get_water_goal
+        self.get_water_log = self.nutrition.get_water_log
+        self.search_foods = self.nutrition.search_foods
+        self.update_food_log = self.nutrition.update_food_log
+        self.update_meal = self.nutrition.update_meal
+        self.update_water_log = self.nutrition.update_water_log
+
+        # Sleep
+        self.create_sleep_goals = self.sleep.create_sleep_goals
+        self.create_sleep_goal = self.sleep.create_sleep_goal
+        self.create_sleep_log = self.sleep.create_sleep_log
+        self.delete_sleep_log = self.sleep.delete_sleep_log
+        self.get_sleep_goals = self.sleep.get_sleep_goals
+        self.get_sleep_goal = self.sleep.get_sleep_goal
+        self.get_sleep_log_by_date = self.sleep.get_sleep_log_by_date
+        self.get_sleep_log_by_date_range = self.sleep.get_sleep_log_by_date_range
+        self.get_sleep_log_list = self.sleep.get_sleep_log_list
+
+        # SpO2
+        self.get_spo2_summary_by_date = self.spo2.get_spo2_summary_by_date
+        self.get_spo2_summary_by_interval = self.spo2.get_spo2_summary_by_interval
+
+        # Subscription
+        self.get_subscription_list = self.subscription.get_subscription_list
+
+        # Temperature
+        self.get_temperature_core_summary_by_date = (
+            self.temperature.get_temperature_core_summary_by_date
+        )
+        self.get_temperature_core_summary_by_interval = (
+            self.temperature.get_temperature_core_summary_by_interval
+        )
+        self.get_temperature_skin_summary_by_date = (
+            self.temperature.get_temperature_skin_summary_by_date
+        )
+        self.get_temperature_skin_summary_by_interval = (
+            self.temperature.get_temperature_skin_summary_by_interval
+        )
+
+        # User
+        self.get_profile = self.user.get_profile
+        self.update_profile = self.user.update_profile
+        self.get_badges = self.user.get_badges
+
+        self.logger.debug("Method aliases set up successfully")

tests/test_method_aliases.py

@@ -0,0 +1,58 @@
+# tests/test_method_aliases.py
+
+# Third party imports
+import pytest
+
+# Local imports
+from fitbit_client.client import FitbitClient
+
+
+class TestMethodAliases:
+    """Test that all resource methods are properly aliased in the client."""
+
+    def test_method_aliases_implementation(self):
+        """Verify that the client has set up method aliases for all resources."""
+        # Check that the client file has the required method and call
+        with open(
+            "/Users/jstroop/workspace/fitbit-client-python/fitbit_client/client.py", "r"
+        ) as f:
+            client_content = f.read()
+
+        # Check that the _setup_method_aliases method exists
+        assert (
+            "def _setup_method_aliases" in client_content
+        ), "The _setup_method_aliases method is missing"
+
+        # Check that it's called in __init__
+        assert (
+            "self._setup_method_aliases()" in client_content
+        ), "_setup_method_aliases() is not called in __init__"
+
+        # Check that there are assignments for all resources
+        resources = [
+            "active_zone_minutes",
+            "activity",
+            "activity_timeseries",
+            "body",
+            "body_timeseries",
+            "breathing_rate",
+            "cardio_fitness_score",
+            "device",
+            "electrocardiogram",
+            "friends",
+            "heartrate_timeseries",
+            "heartrate_variability",
+            "intraday",
+            "irregular_rhythm_notifications",
+            "nutrition",
+            "nutrition_timeseries",
+            "sleep",
+            "spo2",
+            "subscription",
+            "temperature",
+            "user",
+        ]
+
+        for resource in resources:
+            # Check at least one method from each resource is aliased
+            assert f"self.{resource}." in client_content, f"No method aliases found for {resource}"