otf-api 0.4.0__tar.gz → 0.5.0__tar.gz

{otf_api-0.4.0 → otf_api-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: otf-api
-Version: 0.4.0
+Version: 0.5.0
 Summary: Python OrangeTheory Fitness API Client
 License: MIT
 Author: Jessica Smith

{otf_api-0.4.0 → otf_api-0.5.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "otf-api"
-version = "0.4.0"
+version = "0.5.0"
 description = "Python OrangeTheory Fitness API Client"
 authors = ["Jessica Smith <j.smith.git1@gmail.com>"]
 license = "MIT"

{otf_api-0.4.0 → otf_api-0.5.0}/src/otf_api/__init__.py

@@ -6,7 +6,7 @@ from loguru import logger
 from .api import Otf
 from .auth import OtfUser
 
-__version__ = "0.4.0"
+__version__ = "0.5.0"
 
 
 __all__ = ["Otf", "OtfUser"]

{otf_api-0.4.0 → otf_api-0.5.0}/src/otf_api/api.py

@@ -3,7 +3,6 @@ import contextlib
 import json
 import typing
 from datetime import date, datetime
-from math import ceil
 from typing import Any
 
 import aiohttp
@@ -43,7 +42,6 @@ from otf_api.models import (
     TelemetryHrHistory,
     TelemetryMaxHr,
     TotalClasses,
-    WorkoutList,
 )
 
 
@@ -226,32 +224,15 @@ class Otf:
         """Perform an API request to the performance summary API."""
         return await self._do(method, API_IO_BASE_URL, url, params, headers)
 
-    async def get_workouts(self) -> WorkoutList:
-        """Get the list of workouts from OT Live.
+    async def get_body_composition_list(self) -> BodyCompositionList:
+        """Get the member's body composition list.
 
         Returns:
-            WorkoutList: The list of workouts.
-
-        Info:
-            ---
-            This returns data from the same api the [OT Live website](https://otlive.orangetheory.com/) uses.
-            It is quite a bit of data, and all workouts going back to ~2019. The data includes the class history
-            UUID, which can be used to get telemetry data for a specific workout.
+            Any: The member's body composition list.
         """
+        data = await self._default_request("GET", f"/member/members/{self._member_uuid}/body-composition")
 
-        res = await self._default_request("GET", "/virtual-class/in-studio-workouts")
-
-        return WorkoutList(workouts=res["data"])
-
-    async def get_total_classes(self) -> TotalClasses:
-        """Get the member's total classes. This is a simple object reflecting the total number of classes attended,
-        both in-studio and OT Live.
-
-        Returns:
-            TotalClasses: The member's total classes.
-        """
-        data = await self._default_request("GET", "/mobile/v1/members/classes/summary")
-        return TotalClasses(**data["data"])
+        return BodyCompositionList(data=data["data"])
 
     async def get_classes(
         self,
@@ -346,6 +327,16 @@ class Otf:
 
         return classes_list
 
+    async def get_total_classes(self) -> TotalClasses:
+        """Get the member's total classes. This is a simple object reflecting the total number of classes attended,
+        both in-studio and OT Live.
+
+        Returns:
+            TotalClasses: The member's total classes.
+        """
+        data = await self._default_request("GET", "/mobile/v1/members/classes/summary")
+        return TotalClasses(**data["data"])
+
     async def book_class(self, class_uuid: str) -> BookClass | typing.Any:
         """Book a class by class_uuid.
 
@@ -860,16 +851,15 @@ class Otf:
         res = await self._telemetry_request("GET", path, params=params)
         return TelemetryMaxHr(**res)
 
-    async def get_telemetry(self, class_history_uuid: str, max_data_points: int = 0) -> Telemetry:
-        """Get the telemetry for a class history.
+    async def get_telemetry(self, performance_summary_id: str, max_data_points: int = 120) -> Telemetry:
+        """Get the telemetry for a performance summary.
 
         This returns an object that contains the max heartrate, start/end bpm for each zone,
         and a list of telemetry items that contain the heartrate, splat points, calories, and timestamp.
 
         Args:
-            class_history_uuid (str): The class history UUID.
-            max_data_points (int): The max data points to use for the telemetry. Default is 0, which will attempt to\
-            get the max data points from the workout. If the workout is not found, it will default to 120 data points.
+            performance_summary_id (str): The performance summary id.
+            max_data_points (int): The max data points to use for the telemetry. Default is 120.
 
         Returns:
             TelemetryItem: The telemetry for the class history.
@@ -877,30 +867,10 @@ class Otf:
         """
         path = "/v1/performance/summary"
 
-        max_data_points = max_data_points or await self._get_max_data_points(class_history_uuid)
-
-        params = {"classHistoryUuid": class_history_uuid, "maxDataPoints": max_data_points}
+        params = {"classHistoryUuid": performance_summary_id, "maxDataPoints": max_data_points}
         res = await self._telemetry_request("GET", path, params=params)
         return Telemetry(**res)
 
-    async def _get_max_data_points(self, class_history_uuid: str) -> int:
-        """Get the max data points to use for the telemetry.
-
-        Attempts to get the amount of active time for the workout from the OT Live API. If the workout is not found,
-        it will default to 120 data points. If it is found, it will calculate the amount of data points needed based on
-        the active time. This should amount to a data point per 30 seconds, roughly.
-
-        Args:
-            class_history_uuid (str): The class history UUID.
-
-        Returns:
-            int: The max data points to use.
-        """
-        workouts = await self.get_workouts()
-        workout = workouts.by_class_history_uuid.get(class_history_uuid)
-        max_data_points = 120 if workout is None else ceil(active_time_to_data_points(workout.active_time))
-        return max_data_points
-
     # the below do not return any data for me, so I can't test them
 
     async def _get_member_services(self, active_only: bool = True) -> typing.Any:
@@ -934,17 +904,3 @@ class Otf:
 
         data = self._default_request("GET", f"/member/wearables/{self._member_id}/wearable-daily", params=params)
         return data
-
-    async def get_body_composition_list(self) -> BodyCompositionList:
-        """Get the member's body composition list.
-
-        Returns:
-            Any: The member's body composition list.
-        """
-        data = await self._default_request("GET", f"/member/members/{self._member_uuid}/body-composition")
-
-        return BodyCompositionList(data=data["data"])
-
-
-def active_time_to_data_points(active_time: int) -> float:
-    return active_time / 60 * 2

{otf_api-0.4.0 → otf_api-0.5.0}/src/otf_api/auth.py

@@ -63,7 +63,8 @@ class OtfCognito(Cognito):
     @device_key.setter
     def device_key(self, value: str | None):
         if not value:
-            logger.info("Clearing device key")
+            if self._device_key:
+                logger.info("Clearing device key")
             self._device_key = value
             return
 

{otf_api-0.4.0 → otf_api-0.5.0}/src/otf_api/models/__init__.py

@@ -30,7 +30,6 @@ from .responses import (
     TelemetryHrHistory,
     TelemetryMaxHr,
     TotalClasses,
-    WorkoutList,
 )
 
 __all__ = [
@@ -66,5 +65,4 @@ __all__ = [
     "TelemetryHrHistory",
     "TelemetryMaxHr",
     "TotalClasses",
-    "WorkoutList",
 ]

{otf_api-0.4.0 → otf_api-0.5.0}/src/otf_api/models/responses/__init__.py

@@ -21,7 +21,6 @@ from .telemetry import Telemetry
 from .telemetry_hr_history import TelemetryHrHistory
 from .telemetry_max_hr import TelemetryMaxHr
 from .total_classes import TotalClasses
-from .workouts import WorkoutList
 
 __all__ = [
     "BodyCompositionList",
@@ -56,5 +55,4 @@ __all__ = [
     "TelemetryHrHistory",
     "TelemetryMaxHr",
     "TotalClasses",
-    "WorkoutList",
 ]

{otf_api-0.4.0 → otf_api-0.5.0}/src/otf_api/models/responses/performance_summary_list.py

@@ -33,7 +33,7 @@ class Studio(OtfItemBase):
 class Class(OtfItemBase):
     ot_base_class_uuid: str | None = None
     starts_at_local: str
-    name: str
+    name: str | None = None
     coach: Coach
     studio: Studio
 
@@ -56,7 +56,7 @@ class Ratings(OtfItemBase):
 
 
 class PerformanceSummaryEntry(OtfItemBase):
-    performance_summary_id: str = Field(..., alias="id")
+    id: str = Field(..., alias="id")
     details: Details
     ratable: bool
     otf_class: Class = Field(..., alias="class")

otf_api-0.4.0/src/otf_api/models/responses/workouts.py

@@ -1,78 +0,0 @@
-from ast import literal_eval
-from datetime import datetime
-from typing import Any
-
-from pydantic import Field, PrivateAttr
-
-from otf_api.models.base import OtfItemBase
-
-
-class WorkoutType(OtfItemBase):
-    id: int
-    display_name: str = Field(..., alias="displayName")
-    icon: str
-
-
-class Workout(OtfItemBase):
-    studio_number: str = Field(..., alias="studioNumber")
-    studio_name: str = Field(..., alias="studioName")
-    class_type: str = Field(..., alias="classType")
-    active_time: int = Field(..., alias="activeTime")
-    coach: str
-    member_uuid: str = Field(..., alias="memberUuId")
-    class_date: datetime = Field(..., alias="classDate")
-    total_calories: int = Field(..., alias="totalCalories")
-    avg_hr: int = Field(..., alias="avgHr")
-    max_hr: int = Field(..., alias="maxHr")
-    avg_percent_hr: int = Field(..., alias="avgPercentHr")
-    max_percent_hr: int = Field(..., alias="maxPercentHr")
-    total_splat_points: int = Field(..., alias="totalSplatPoints")
-    red_zone_time_second: int = Field(..., alias="redZoneTimeSecond")
-    orange_zone_time_second: int = Field(..., alias="orangeZoneTimeSecond")
-    green_zone_time_second: int = Field(..., alias="greenZoneTimeSecond")
-    blue_zone_time_second: int = Field(..., alias="blueZoneTimeSecond")
-    black_zone_time_second: int = Field(..., alias="blackZoneTimeSecond")
-    step_count: int = Field(..., alias="stepCount")
-    class_history_uuid: str = Field(..., alias="classHistoryUuId")
-    class_id: str = Field(..., alias="classId")
-    date_created: datetime = Field(..., alias="dateCreated")
-    date_updated: datetime = Field(..., alias="dateUpdated")
-    is_intro: bool = Field(..., alias="isIntro")
-    is_leader: bool = Field(..., alias="isLeader")
-    member_email: None = Field(..., alias="memberEmail")
-    member_name: str = Field(..., alias="memberName")
-    member_performance_id: str = Field(..., alias="memberPerformanceId")
-    minute_by_minute_hr: list[int] = Field(
-        ...,
-        alias="minuteByMinuteHr",
-        description="HR data for each minute of the workout. It is returned as a string literal, so it needs to be "
-        "evaluated to a list. If can't be parsed, it will return an empty list.",
-    )
-    source: str
-    studio_account_uuid: str = Field(..., alias="studioAccountUuId")
-    version: str
-    workout_type: WorkoutType = Field(..., alias="workoutType")
-    _minute_by_minute_raw: str | None = PrivateAttr(None)
-
-    @property
-    def active_time_minutes(self) -> int:
-        """Get the active time in minutes."""
-        return self.active_time // 60
-
-    def __init__(self, **data: Any):
-        if "minuteByMinuteHr" in data:
-            try:
-                data["minuteByMinuteHr"] = literal_eval(data["minuteByMinuteHr"])
-            except (ValueError, SyntaxError):
-                data["minuteByMinuteHr"] = []
-
-        super().__init__(**data)
-        self._minute_by_minute_raw = data.get("minuteByMinuteHr")
-
-
-class WorkoutList(OtfItemBase):
-    workouts: list[Workout]
-
-    @property
-    def by_class_history_uuid(self) -> dict[str, Workout]:
-        return {workout.class_history_uuid: workout for workout in self.workouts}