otf-api 0.11.0rc1__tar.gz → 0.12.0__tar.gz

{otf_api-0.11.0rc1/src/otf_api.egg-info → otf_api-0.12.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: otf-api
-Version: 0.11.0rc1
+Version: 0.12.0
 Summary: Python OrangeTheory Fitness API Client
 Author-email: Jessica Smith <j.smith.git1@gmail.com>
 License-Expression: MIT

{otf_api-0.11.0rc1 → otf_api-0.12.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "otf-api"
-version = "0.11.0-rc1"
+version = "0.12.0"
 description = "Python OrangeTheory Fitness API Client"
 authors = [{ name = "Jessica Smith", email = "j.smith.git1@gmail.com" }]
 requires-python = ">=3.11"

{otf_api-0.11.0rc1 → otf_api-0.12.0}/src/otf_api/__init__.py

@@ -4,7 +4,7 @@ from otf_api.api import Otf
 from otf_api import models
 from otf_api.auth import OtfUser
 
-__version__ = "0.11.0-rc1"
+__version__ = "0.12.0"
 
 
 __all__ = ["Otf", "OtfUser", "models"]

{otf_api-0.11.0rc1 → otf_api-0.12.0}/src/otf_api/api.py

@@ -1,7 +1,7 @@
 import atexit
 import contextlib
 from concurrent.futures import ThreadPoolExecutor
-from datetime import date, datetime, timedelta
+from datetime import date, datetime, time, timedelta
 from functools import partial
 from json import JSONDecodeError
 from logging import getLogger
@@ -18,7 +18,7 @@ from otf_api import exceptions as exc
 from otf_api import filters, models
 from otf_api.auth import OtfUser
 from otf_api.models.enums import HISTORICAL_BOOKING_STATUSES
-from otf_api.utils import ensure_date, ensure_datetime, ensure_list, get_booking_uuid, get_class_uuid  # get_booking_id
+from otf_api.utils import ensure_date, ensure_datetime, ensure_list, get_booking_id, get_booking_uuid, get_class_uuid
 
 API_BASE_URL = "api.orangetheory.co"
 API_IO_BASE_URL = "api.orangetheory.io"
@@ -69,7 +69,7 @@ class Otf:
         return hash(self.member_uuid)
 
     @retry(
-        retry=retry_if_exception_type(exc.OtfRequestError),
+        retry=retry_if_exception_type((exc.OtfRequestError, httpx.HTTPStatusError)),
         stop=stop_after_attempt(3),
         wait=wait_exponential(multiplier=1, min=4, max=10),
         reraise=True,
@@ -123,8 +123,11 @@ class Otf:
             raise
 
         if not response.text:
-            # insanely enough, at least one endpoint (get perf summary) returns None without error instead of 404
-            raise exc.OtfRequestError("Empty response", None, response=response, request=request)
+            if method == "GET":
+                raise exc.OtfRequestError("Empty response", None, response=response, request=request)
+
+            LOGGER.debug(f"Request {method!r} to {full_url!r} returned no content")
+            return None
 
         try:
             resp = response.json()
@@ -144,10 +147,15 @@ class Otf:
         return resp
 
     def _classes_request(
-        self, method: str, url: str, params: dict[str, Any] | None = None, headers: dict[str, Any] | None = None
+        self,
+        method: str,
+        url: str,
+        params: dict[str, Any] | None = None,
+        headers: dict[str, Any] | None = None,
+        **kwargs: Any,
     ) -> Any:
         """Perform an API request to the classes API."""
-        return self._do(method, API_IO_BASE_URL, url, params, headers=headers)
+        return self._do(method, API_IO_BASE_URL, url, params, headers=headers, **kwargs)
 
     def _default_request(
         self,
@@ -175,7 +183,7 @@ class Otf:
 
         return self._do(method, API_IO_BASE_URL, url, params, headers=headers)
 
-    def _get_classes_raw(self, studio_uuids: list[str] | None) -> dict:
+    def _get_classes_raw(self, studio_uuids: list[str]) -> dict:
         """Retrieve raw class data."""
         return self._classes_request("GET", "/v1/classes", params={"studio_ids": studio_uuids})
 
@@ -203,6 +211,11 @@ class Otf:
             raise exc.OtfException(f"Error booking class {class_uuid}: {e}")
         return resp
 
+    def _book_class_new_raw(self, body: dict[str, str | bool]) -> dict:
+        """Book a class by class_id."""
+
+        return self._classes_request("POST", "/v1/bookings/me", json=body)
+
     def _get_booking_raw(self, booking_uuid: str) -> dict:
         """Retrieve raw booking data."""
         return self._default_request("GET", f"/member/members/{self.member_uuid}/bookings/{booking_uuid}")
@@ -240,15 +253,7 @@ class Otf:
 
     def _cancel_booking_new_raw(self, booking_id: str) -> dict:
         """Cancel a booking by booking_id."""
-        return self._classes_request("DELETE", f"/v1/bookings/me/{booking_id}", headers={"SIGV4AUTH_REQUIRED": "true"})
-
-    def _get_booking_new_raw(self, booking_id: str) -> dict:
-        """Retrieve raw booking data."""
-        return self._classes_request("GET", f"/v1/bookings/me/{booking_id}", headers={"SIGV4AUTH_REQUIRED": "true"})
-
-    def _book_class_new_raw(self, class_id: str) -> dict:
-        """Book a class by class_id."""
-        return self._classes_request("POST", f"/v1/bookings/me/{class_id}", headers={"SIGV4AUTH_REQUIRED": "true"})
+        return self._classes_request("DELETE", f"/v1/bookings/me/{booking_id}")
 
     def _get_member_detail_raw(self) -> dict:
         """Retrieve raw member details."""
@@ -432,13 +437,16 @@ class Otf:
         """Get bookings from the new endpoint with no date filters."""
         start_date = pendulum.datetime(1970, 1, 1)
         end_date = pendulum.today().start_of("day").add(days=45)
-        return self.get_bookings_new(start_date, end_date, exclude_canceled=False)
+        return self.get_bookings_new(start_date, end_date, exclude_cancelled=False)
+
+    def _get_app_config_raw(self) -> dict[str, Any]:
+        return self._default_request("GET", "/member/app-configurations", headers={"SIGV4AUTH_REQUIRED": "true"})
 
     def get_bookings_new(
         self,
-        start_dtme: datetime | str | None = None,
-        end_dtme: datetime | str | None = None,
-        exclude_canceled: bool = True,
+        start_date: datetime | str | None = None,
+        end_date: datetime | str | None = None,
+        exclude_cancelled: bool = True,
     ) -> list[models.BookingV2]:
         """Get the bookings for the user. If no dates are provided, it will return all bookings
         between today and 45 days from now.
@@ -450,9 +458,9 @@ class Otf:
         new class, which is normally transparent to the user.
 
         Args:
-            start_dtme (datetime | str | None): The start date for the bookings. Default is None.
-            end_dtme (datetime | str | None): The end date for the bookings. Default is None.
-            exclude_canceled (bool): Whether to exclude canceled bookings. Default is True.
+            start_dtme (datetime | date | str | None): The start date for the bookings. Default is None.
+            end_dtme (datetime | date | str | None): The end date for the bookings. Default is None.
+            exclude_cancelled (bool): Whether to exclude canceled bookings. Default is True.
         Returns:
             list[BookingV2]: The bookings for the user.
         """
@@ -460,24 +468,27 @@ class Otf:
         expand = True  # this doesn't seem to have an effect? so leaving it out of the argument list
 
         # leaving the parameter as `exclude_canceled` for backwards compatibility
-        include_canceled = not exclude_canceled
+        include_canceled = not exclude_cancelled
 
-        end_dtme = ensure_datetime(end_dtme)
-        start_dtme = ensure_datetime(start_dtme)
+        end_date = ensure_datetime(end_date, time(23, 59, 59))
+        start_date = ensure_datetime(start_date)
 
-        end_dtme = end_dtme or pendulum.today().start_of("day").add(days=45)
-        start_dtme = start_dtme or pendulum.datetime(1970, 1, 1).start_of("day")
+        end_date = end_date or pendulum.today().start_of("day").add(days=45)
+        start_date = start_date or pendulum.datetime(1970, 1, 1).start_of("day")
 
         bookings_resp = self._get_bookings_new_raw(
-            ends_before=end_dtme, starts_after=start_dtme, include_canceled=include_canceled, expand=expand
+            ends_before=end_date, starts_after=start_date, include_canceled=include_canceled, expand=expand
         )
 
         return [models.BookingV2(**b) for b in bookings_resp["items"]]
 
-    # def get_booking_new(self, booking_id: str) -> models.BookingV2:
-    #     """Get a booking by ID."""
-    #     booking_resp = self._get_booking_new_raw(booking_id)
-    #     return models.BookingV2(**booking_resp)
+    def get_booking_new(self, booking_id: str) -> models.BookingV2:
+        """Get a booking by ID."""
+        all_bookings = self._get_all_bookings_new()
+        booking = next((b for b in all_bookings if b.booking_id == booking_id), None)
+        if not booking:
+            raise exc.ResourceNotFoundError(f"Booking with ID {booking_id} not found")
+        return booking
 
     def get_classes(
         self,
@@ -493,11 +504,11 @@ class Otf:
         UUIDs are provided, it will default to the user's home studio.
 
         Args:
-            start_date (date | None): The start date for the classes. Default is None.
-            end_date (date | None): The end date for the classes. Default is None.
+            start_date (date | str | None): The start date for the classes. Default is None.
+            end_date (date | str | None): The end date for the classes. Default is None.
             studio_uuids (list[str] | None): The studio UUIDs to get the classes for. Default is None, which will\
             default to the user's home studio only.
-            include_home_studio (bool): Whether to include the home studio in the classes. Default is True.
+            include_home_studio (bool | None): Whether to include the home studio in the classes. Default is True.
             filters (list[ClassFilter] | ClassFilter | None): A list of filters to apply to the classes, or a single\
             filter. Filters are applied as an OR operation. Default is None.
 
@@ -726,6 +737,26 @@ class Otf:
 
         return booking
 
+    def book_class_new(self, class_id: str) -> models.BookingV2:
+        """Book a class by providing the class_id.
+
+        Args:
+            class_id (str): The class ID to book.
+
+        Returns:
+            BookingV2: The booking.
+        """
+        if not class_id:
+            raise ValueError("class_id is required")
+
+        body = {"class_id": class_id, "confirmed": False, "waitlist": False}
+
+        resp = self._book_class_new_raw(body)
+
+        new_booking = models.BookingV2(**resp)
+
+        return new_booking
+
     def _check_class_already_booked(self, class_uuid: str) -> None:
         """Check if the class is already booked.
 
@@ -779,17 +810,14 @@ class Otf:
             ValueError: If booking_uuid is None or empty string
             BookingNotFoundError: If the booking does not exist.
         """
-        # if isinstance(booking, models.BookingV2):
-        #     LOGGER.warning("BookingV2 object provided, using the new cancel booking endpoint (`cancel_booking_new`)")
-        #     self.cancel_booking_new(booking)
+        if isinstance(booking, models.BookingV2):
+            LOGGER.warning("BookingV2 object provided, using the new cancel booking endpoint (`cancel_booking_new`)")
+            self.cancel_booking_new(booking)
 
         booking_uuid = get_booking_uuid(booking)
 
         if booking == booking_uuid:  # ensure this booking exists by calling the booking endpoint
-            try:
-                self.get_booking(booking_uuid)
-            except Exception:
-                raise exc.BookingNotFoundError(f"Booking {booking_uuid} does not exist.")
+            _ = self.get_booking(booking_uuid)  # allow the exception to be raised if it doesn't exist
 
         resp = self._cancel_booking_raw(booking_uuid)
         if resp["code"] == "NOT_AUTHORIZED" and resp["message"].startswith("This class booking has"):
@@ -797,25 +825,27 @@ class Otf:
                 f"Booking {booking_uuid} is already cancelled.", booking_uuid=booking_uuid
             )
 
-    # def cancel_booking_new(self, booking: str | models.BookingV2) -> None:
-    #     """Cancel a booking by providing either the booking_id or the BookingV2 object.
-    #     Args:
-    #         booking (str | BookingV2): The booking ID or the BookingV2 object to cancel.
-    #     Raises:
-    #         ValueError: If booking_id is None or empty string
-    #         BookingNotFoundError: If the booking does not exist.
-    #     """
+    def cancel_booking_new(self, booking: str | models.BookingV2) -> None:
+        """Cancel a booking by providing either the booking_id or the BookingV2 object.
+
+        Args:
+            booking (str | BookingV2): The booking ID or the BookingV2 object to cancel.
 
-    #     if isinstance(booking, models.Booking):
-    #         LOGGER.warning("Booking object provided, using the old cancel booking endpoint (`cancel_booking`)")
-    #         self.cancel_booking(booking)
+        Raises:
+            ValueError: If booking_id is None or empty string
+            BookingNotFoundError: If the booking does not exist.
+        """
 
-    #     booking_id = get_booking_id(booking)
+        if isinstance(booking, models.Booking):
+            LOGGER.warning("Booking object provided, using the old cancel booking endpoint (`cancel_booking`)")
+            self.cancel_booking(booking)
 
-    #     if booking == booking_id:  # ensure this booking exists by calling the booking endpoint
-    #         self.get_booking_new(booking_id)
+        booking_id = get_booking_id(booking)
 
-    #     self._cancel_booking_new_raw(booking_id)
+        if booking == booking_id:
+            _ = self.get_booking_new(booking_id)  # allow the exception to be raised if it doesn't exist
+
+        self._cancel_booking_new_raw(booking_id)
 
     def get_bookings(
         self,
@@ -1483,32 +1513,31 @@ class Otf:
                 raise exc.AlreadyRatedError(f"Workout {performance_summary_id} is already rated.") from None
             raise
 
-    # def get_workout_from_booking(self, booking: str | models.BookingV2) -> models.Workout:
-    #     """Get a workout for a specific booking.
+    def get_workout_from_booking(self, booking: str | models.BookingV2) -> models.Workout:
+        """Get a workout for a specific booking.
+
+        Args:
+            booking (str | Booking): The booking ID or BookingV2 object to get the workout for.
 
-    #     Args:
-    #         booking_id (str | Booking): The booking ID or Booking object to get the workout for.
+        Returns:
+            Workout: The member's workout.
 
-    #     Returns:
-    #         Workout: The member's workout.
+        Raises:
+            BookingNotFoundError: If the booking does not exist.
+            ResourceNotFoundError: If the workout does not exist.
+        """
+        booking_id = get_booking_id(booking)
 
-    #     Raises:
-    #         BookingNotFoundError: If the booking does not exist.
-    #         ResourceNotFoundError: If the workout does not exist.
-    #     """
-    #     booking_id = booking if isinstance(booking, str) else booking.booking_id
+        booking = self.get_booking_new(booking_id)
 
-    #     booking = self.get_booking_new(booking_id)
-    #     if not booking:
-    #         raise exc.BookingNotFoundError(f"Booking {booking_id} not found.")
+        if not booking.workout or not booking.workout.performance_summary_id:
+            raise exc.ResourceNotFoundError(f"Workout for booking {booking_id} not found.")
 
-    #     if not booking.workout or not booking.workout.performance_summary_id:
-    #         raise exc.ResourceNotFoundError(f"Workout for booking {booking_id} not found.")
+        perf_summary = self._get_performance_summary_raw(booking.workout.performance_summary_id)
+        telemetry = self.get_telemetry(booking.workout.performance_summary_id)
+        workout = models.Workout(**perf_summary, v2_booking=booking, telemetry=telemetry)
 
-    #     perf_summary = self._get_performance_summary_raw(booking.workout.performance_summary_id)
-    #     telemetry = self.get_telemetry(booking.workout.performance_summary_id)
-    #     workout = models.Workout(**perf_summary, v2_booking=booking, telemetry=telemetry)
-    #     return workout
+        return workout
 
     def get_workouts(
         self, start_date: date | str | None = None, end_date: date | str | None = None
@@ -1516,8 +1545,8 @@ class Otf:
         """Get the member's workouts, using the new bookings endpoint and the performance summary endpoint.
 
         Args:
-            start_date (date | None): The start date for the workouts. If None, defaults to 30 days ago.
-            end_date (date | None): The end date for the workouts. If None, defaults to today.
+            start_date (date | str | None): The start date for the workouts. If None, defaults to 30 days ago.
+            end_date (date | str | None): The end date for the workouts. If None, defaults to today.
 
         Returns:
             list[Workout]: The member's workouts.
@@ -1528,7 +1557,7 @@ class Otf:
         start_dtme = pendulum.datetime(start_date.year, start_date.month, start_date.day, 0, 0, 0)
         end_dtme = pendulum.datetime(end_date.year, end_date.month, end_date.day, 23, 59, 59)
 
-        bookings = self.get_bookings_new(start_dtme, end_dtme, exclude_canceled=False)
+        bookings = self.get_bookings_new(start_dtme, end_dtme, exclude_cancelled=False)
         bookings_dict = {b.workout.id: b for b in bookings if b.workout}
 
         perf_summaries_dict = self._get_perf_summaries_threaded(list(bookings_dict.keys()))
@@ -1621,19 +1650,7 @@ class Otf:
 
         self.rate_class(workout.class_uuid, workout.performance_summary_id, class_rating, coach_rating)
 
-        # TODO: use this once we get it working, getting workout list is substitute for now
-        # return self.get_workout_from_booking(workout.booking_id)
-
-        workout_date = pendulum.instance(workout.otf_class.starts_at).start_of("day")
-        workouts = self.get_workouts(workout_date.subtract(days=1), workout_date.add(days=1))
-
-        selected_workout = next(
-            (w for w in workouts if w.performance_summary_id == workout.performance_summary_id), None
-        )
-
-        assert selected_workout is not None, "Workout not found in the list of workouts"
-
-        return selected_workout
+        return self.get_workout_from_booking(workout.booking_id)
 
     # the below do not return any data for me, so I can't test them
 

{otf_api-0.11.0rc1 → otf_api-0.12.0}/src/otf_api/auth/auth.py

@@ -29,7 +29,6 @@ LOGGER = getLogger(__name__)
 CLIENT_ID = "1457d19r0pcjgmp5agooi0rb1b"  # from android app
 USER_POOL_ID = "us-east-1_dYDxUeyL1"
 REGION = "us-east-1"
-COGNITO_IDP_URL = f"https://cognito-idp.{REGION}.amazonaws.com/"
 
 ID_POOL_ID = "us-east-1:4943c880-fb02-4fd7-bc37-2f4c32ecb2a3"
 PROVIDER_KEY = f"cognito-idp.{REGION}.amazonaws.com/{USER_POOL_ID}"
@@ -296,6 +295,8 @@ class HttpxCognitoAuth(httpx.Auth):
 
         request.headers[self.http_header] = self.http_header_prefix + token
 
+        # If the request has the SIGV4AUTH_REQUIRED header, sign the request
+        # used by very few endpoints, but I expect that may change in the future
         if request.headers.get("SIGV4AUTH_REQUIRED"):
             del request.headers["SIGV4AUTH_REQUIRED"]
             yield from self.sign_httpx_request(request)

{otf_api-0.11.0rc1 → otf_api-0.12.0}/src/otf_api/models/bookings.py

@@ -36,6 +36,11 @@ class OtfClass(OtfItemBase):
     program_name: str | None = Field(None, alias="programName", exclude=True, repr=False)
     virtual_class: bool | None = Field(None, alias="virtualClass", exclude=True, repr=False)
 
+    @property
+    def coach_name(self) -> str:
+        """Shortcut to get the coach's name, to be compatible with new BookingV2Class"""
+        return self.coach.first_name or ""
+
     def __str__(self) -> str:
         starts_at_str = self.starts_at.strftime("%a %b %d, %I:%M %p")
         return f"Class: {starts_at_str} {self.name} - {self.coach.first_name}"
@@ -90,6 +95,11 @@ class Booking(OtfItemBase):
         """Shortcut to get the class end time"""
         return self.otf_class.ends_at
 
+    @property
+    def id_value(self) -> str:
+        """Returns the booking_uuid, to be compatible with new BookingV2 model"""
+        return self.booking_uuid
+
     def __str__(self) -> str:
         starts_at_str = self.otf_class.starts_at.strftime("%a %b %d, %I:%M %p")
         class_name = self.otf_class.name

{otf_api-0.11.0rc1 → otf_api-0.12.0}/src/otf_api/models/bookings_v2.py

@@ -72,6 +72,16 @@ class BookingV2Class(OtfItemBase):
     )
     starts_at_utc: datetime | None = Field(None, alias="starts_at", exclude=True, repr=False)
 
+    @property
+    def coach_name(self) -> str:
+        """Shortcut to get the coach's name, to be compatible with old Booking OtfClass model"""
+        return self.coach or ""
+
+    @property
+    def ends_at(self) -> datetime:
+        """Emulates the end time of the class, to be compatible with old Booking OtfClass model"""
+        return get_end_time(self.starts_at, self.class_type)
+
     def __str__(self) -> str:
         starts_at_str = self.starts_at.strftime("%a %b %d, %I:%M %p")
         return f"Class: {starts_at_str} {self.name} - {self.coach}"
@@ -160,7 +170,17 @@ class BookingV2(OtfItemBase):
     @property
     def ends_at(self) -> datetime:
         """Shortcut to get the class end time"""
-        return get_end_time(self.otf_class.starts_at, self.otf_class.class_type)
+        return self.otf_class.ends_at
+
+    @property
+    def cancelled_date(self) -> datetime | None:
+        """Returns the canceled_at value in a backward-compatible way"""
+        return self.canceled_at
+
+    @property
+    def id_value(self) -> str:
+        """Returns the booking_id, to be compatible with old Booking model"""
+        return self.booking_id
 
     def __str__(self) -> str:
         starts_at_str = self.otf_class.starts_at.strftime("%a %b %d, %I:%M %p")

{otf_api-0.11.0rc1 → otf_api-0.12.0}/src/otf_api/utils.py

@@ -1,6 +1,6 @@
 import json
 import typing
-from datetime import date, datetime
+from datetime import date, datetime, time
 from logging import getLogger
 from pathlib import Path
 from typing import Any
@@ -12,6 +12,8 @@ if typing.TYPE_CHECKING:
 
 LOGGER = getLogger(__name__)
 
+MIN_TIME = datetime.min.time()
+
 
 def get_booking_uuid(booking_or_uuid: "str | models.Booking") -> str:
     from otf_api.models.bookings import Booking
@@ -58,7 +60,7 @@ def ensure_list(obj: list | Any | None) -> list:
     return obj
 
 
-def ensure_datetime(date_str: str | datetime | None) -> datetime | None:
+def ensure_datetime(date_str: str | datetime | None, combine_with: time = MIN_TIME) -> datetime | None:
     if not date_str:
         return None
 
@@ -69,7 +71,7 @@ def ensure_datetime(date_str: str | datetime | None) -> datetime | None:
         return date_str
 
     if isinstance(date_str, date):
-        return datetime.combine(date_str, datetime.min.time())
+        return datetime.combine(date_str, combine_with)
 
     raise ValueError(f"Expected str or datetime, got {type(date_str)}")
 

{otf_api-0.11.0rc1 → otf_api-0.12.0/src/otf_api.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: otf-api
-Version: 0.11.0rc1
+Version: 0.12.0
 Summary: Python OrangeTheory Fitness API Client
 Author-email: Jessica Smith <j.smith.git1@gmail.com>
 License-Expression: MIT