MouseTools 4.3.0__tar.gz → 4.3.1__tar.gz

{mousetools-4.3.0 → mousetools-4.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mousetools
-Version: 4.3.0
+Version: 4.3.1
 Summary: An unofficial Python wrapper for Disney's API
 Author: Scott Caratozzolo
 License-Expression: MIT

{mousetools-4.3.0 → mousetools-4.3.1}/mousetools/api/menu.py

@@ -1,3 +1,4 @@
+import logging
 import typing
 from datetime import datetime, timedelta
 from zoneinfo import ZoneInfo
@@ -8,7 +9,7 @@ from mousetools.auth import auth_obj
 from mousetools.decorators import disney_property, json_property
 from mousetools.mixins.disney import DisneyAPIMixin
 
-# menus -> menu -> menugroups -> menuitems
+logger = logging.getLogger(__name__)
 
 
 class MenuItem:
@@ -351,7 +352,17 @@ class Menus(DisneyAPIMixin):
 
     def refresh(self) -> None:
         """Pulls initial data if none exists or if it is older than the refresh interval"""
-        if self._disney_data is None or datetime.now(tz=self._tz) - self.last_refresh > self._refresh_interval:
+        no_data_check = self._disney_data is None
+        time_since_pull = datetime.now(tz=self._tz) - self._disney_data_pull_time
+        old_data_check = time_since_pull > self._refresh_interval
+        logger.debug(
+            "No data check: %s, Time since last update: %s, Old data check: %s",
+            no_data_check,
+            time_since_pull,
+            old_data_check,
+        )
+        if no_data_check or old_data_check:
+            logger.info("Refreshing menu data %s", self.entity_id)
             self._disney_data = self.get_disney_data(self._menu_service_url)
             self._disney_data_pull_time = datetime.now(tz=self._tz)
 
@@ -396,19 +407,14 @@ class Menus(DisneyAPIMixin):
         """
         return self._disney_data["ancestorLocationLandArea"]
 
-    @property
-    def last_refresh(self) -> datetime:
+    @disney_property()
+    def last_refresh(self) -> typing.Optional[datetime]:
         """
         The last time the menus were refreshed.
 
         Returns:
-            (datetime): The last time the menus were refreshed.
+            (typing.Optional[datetime]): The last time the menus were refreshed.
         """
-        if self._disney_data is None:
-            self._disney_data = self.get_disney_data(self.entity_id)
-        try:
-            refresh_time = isoparse(self._disney_data["lastRefresh"])
-            refresh_time = refresh_time.replace(tzinfo=self._tz)
-            return refresh_time
-        except (KeyError, TypeError, ValueError):
-            return self._disney_data_pull_time
+        refresh_time = isoparse(self._disney_data["lastRefresh"])
+        refresh_time = refresh_time.replace(tzinfo=self._tz)
+        return refresh_time

{mousetools-4.3.0 → mousetools-4.3.1}/mousetools/auth.py

@@ -1,5 +1,6 @@
 import base64
 import json
+import logging
 import typing
 from datetime import datetime, timedelta
 from importlib.resources import as_file, files
@@ -7,6 +8,8 @@ from importlib.resources import as_file, files
 import httpx
 from Crypto.Cipher import AES
 
+logger = logging.getLogger(__name__)
+
 
 class Authentication:
     def __init__(self):
@@ -38,6 +41,7 @@ class Authentication:
             "client_id": self._environments["authzClientId"],
         }
 
+        logger.debug("Sending request for authentication token")
         response = httpx.post(
             f"{self._environments['authzServiceUrl']}/token",
             headers=headers,
@@ -57,6 +61,7 @@ class Authentication:
         """
 
         if self.time_of_expire is None or (datetime.now() > self.time_of_expire):
+            logger.info("Requesting new authentication token")
             access_token, expires_in = self.authenticate()
             self.time_of_expire = datetime.now() + timedelta(seconds=(expires_in - 10))
             self.access_token = access_token

{mousetools-4.3.0 → mousetools-4.3.1}/mousetools/channels/__init__.py

@@ -6,6 +6,7 @@ from enum import Enum
 from dateutil.parser import isoparse
 
 from mousetools.channels.enums import DestinationTimezones, DLRCouchbaseChannels, WDWCouchbaseChannels
+from mousetools.decorators import disney_property
 from mousetools.enums import DestinationShort, EntityType
 from mousetools.mixins.couchbase import CouchbaseMixin
 
@@ -26,7 +27,7 @@ class CouchbaseChildChannel(CouchbaseMixin):
             if self._destination_short == DestinationShort.WALT_DISNEY_WORLD
             else DestinationTimezones.DISNEYLAND_RESORT
         )
-        self._refresh_interval: timedelta = timedelta(minutes=30)
+        self._refresh_interval: timedelta = timedelta(hours=12)
         self._cb_data: typing.Optional[dict] = None
         self._cb_data_pull_time: datetime = datetime.now(tz=self._tz.value)
         if not lazy_load:
@@ -34,28 +35,29 @@ class CouchbaseChildChannel(CouchbaseMixin):
 
     def refresh(self) -> None:
         """Pulls initial data if none exists or if it is older than the refresh interval"""
-        if self._cb_data is None or datetime.now(tz=self._tz.value) - self.last_update > self._refresh_interval:
+
+        no_data_check = self._cb_data is None
+        time_since_pull = datetime.now(tz=self._tz.value) - self._cb_data_pull_time
+        old_data_check = time_since_pull > self._refresh_interval
+        logger.debug(
+            "No data check: %s, Time since pull: %s, Old data check: %s", no_data_check, time_since_pull, old_data_check
+        )
+        if no_data_check or old_data_check:
+            logger.info("Refreshing %s", self.channel_id)
             self._cb_data = self.get_channel_data(self.channel_id)
             self._cb_data_pull_time = datetime.now(tz=self._tz.value)
 
-    @property
-    def last_update(self) -> datetime:
+    @disney_property()
+    def last_update(self) -> typing.Optional[datetime]:
         """
-        The last time the data was updated.
+        The last time disney updated the data.
 
         Returns:
-            (datetime): The last time the entity's data was updated, or None if no such data exists.
+            (typing.Optional[datetime]): The last time the entity's data was updated, or None if no such data exists.
         """
-        if self._cb_data is None:
-            self._cb_data = self.get_channel_data(self.channel_id)
-
-        try:
-            dt = isoparse(self._cb_data["lastUpdate"])
-            dt = dt.replace(tzinfo=self._tz.value)
-            return dt
-        except (KeyError, TypeError, ValueError):
-            logger.debug("No last updated found for %s", self.channel_id)
-            return self._cb_data_pull_time
+        dt = isoparse(self._cb_data["lastUpdate"])
+        dt = dt.replace(tzinfo=self._tz.value)
+        return dt
 
 
 class CouchbaseChannel(CouchbaseMixin):
@@ -78,16 +80,26 @@ class CouchbaseChannel(CouchbaseMixin):
 
         self._cb_data = None
         self._refresh_interval = timedelta(minutes=10)
-        self.last_update = datetime.now(tz=self._tz.value)
+        self._cb_data_pull_time = datetime.now(tz=self._tz.value)
 
         if not lazy_load:
             self.refresh()
 
     def refresh(self) -> None:
         """Pulls initial data if none exists or if it is older than the refresh interval"""
-        if self._cb_data is None or datetime.now(tz=self._tz.value) - self.last_update > self._refresh_interval:
+        no_data_check = self._cb_data is None
+        time_since_pull = datetime.now(tz=self._tz.value) - self._cb_data_pull_time
+        old_data_check = time_since_pull > self._refresh_interval
+        logger.debug(
+            "No data check: %s, Time since last update: %s, Old data check: %s",
+            no_data_check,
+            time_since_pull,
+            old_data_check,
+        )
+        if no_data_check or old_data_check:
+            logger.info("Refreshing %s", self.channel_id)
             self._cb_data = self.get_channel_changes(self.channel_id)
-            self.last_update = datetime.now(tz=self._tz.value)
+            self._cb_data_pull_time = datetime.now(tz=self._tz.value)
 
     def get_children_channel_ids(self) -> list[str]:
         """Returns a list of child channel ids for the channel."""

{mousetools-4.3.0 → mousetools-4.3.1}/mousetools/channels/facilities/__init__.py

@@ -49,18 +49,10 @@ class FacilityChildChannel(CouchbaseChildChannel):
         """
         super().__init__(channel_id, lazy_load=lazy_load)
 
-        self._refresh_interval: timedelta = timedelta(
-            hours=12
-        )  # properties are rarely updated, no need to spam the API
+        self._refresh_interval = timedelta(weeks=1)  # properties are rarely updated
 
         self._today_calendar: typing.Optional[CalendarChildChannel] = None
 
-    def refresh(self) -> None:
-        """Pulls initial data if none exists or if it is older than the refresh interval"""
-        if self._cb_data is None or datetime.now(tz=self._tz.value) - self.last_update > self._refresh_interval:
-            self._cb_data = self.get_channel_data(self.channel_id)
-            self._cb_data_pull_time = datetime.now(tz=self._tz.value)
-
     def pull_today_calendar(self) -> None:
         """Pulls today's calendar.
 

{mousetools-4.3.0 → mousetools-4.3.1}/mousetools/channels/facilitystatus/__init__.py

@@ -1,6 +1,6 @@
 import logging
 import typing
-from datetime import datetime
+from datetime import datetime, timedelta
 
 from dateutil.parser import isoparse
 
@@ -21,6 +21,8 @@ class FacilityStatusChildChannel(CouchbaseChildChannel):
         """
         super().__init__(channel_id, lazy_load=lazy_load)
 
+        self._refresh_interval: timedelta = timedelta(minutes=10)
+
     def get_status(self) -> typing.Optional[str]:
         """Get the operating status of the facility
 

{mousetools-4.3.0 → mousetools-4.3.1}/mousetools/decorators.py

@@ -18,6 +18,7 @@ def disney_property(
             try:
                 return func(self)
             except (KeyError, TypeError, ValueError):
+                logger.debug("No data found for disney property %s, returning default value", func.__name__)
                 return default_value
 
         wrapper.__annotations__ = func.__annotations__
@@ -34,6 +35,7 @@ def json_property(func: Callable) -> property:
         try:
             return func(self)
         except (KeyError, TypeError, ValueError):
+            logger.debug("No data found for json property %s", func.__name__)
             return None
 
     return wrapper

{mousetools-4.3.0 → mousetools-4.3.1}/mousetools/mixins/couchbase.py

@@ -35,8 +35,9 @@ class CouchbaseMixin:
             "json": True,
         }
 
+        logger.info("Sending request for channel data: %s", channel_name)
         response = httpx.post(self._couchbase_url + "/_bulk_get", json=payload, headers=self._headers)
-        logger.debug("Response status: %s", response.status_code)
+        logger.debug("Response status for %s: %s", channel_name, response.status_code)
         data = None
         try:
             response.raise_for_status()
@@ -71,7 +72,9 @@ class CouchbaseMixin:
             if since:
                 payload["since"] = since
 
+            logger.info("Sending request for channel changes: %s", channel_name)
             response = httpx.post(self._couchbase_url + "/_changes", json=payload, headers=self._headers)
+            logger.debug("Response status for %s: %s", channel_name, response.status_code)
             data = response.raise_for_status().json()
         except httpx.HTTPError as err:
             logger.error("Request failed: %s", err)

{mousetools-4.3.0 → mousetools-4.3.1}/mousetools/mixins/disney.py

@@ -31,7 +31,7 @@ class DisneyAPIMixin:
             response.raise_for_status()
             data = response.json()
         except (httpx.HTTPError, json.decoder.JSONDecodeError) as err:
-            logger.warning("Request failed. Error: %s", err)
+            logger.error("Request failed. Error: %s", err)
             return None
 
         return data

{mousetools-4.3.0 → mousetools-4.3.1}/mousetools.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mousetools
-Version: 4.3.0
+Version: 4.3.1
 Summary: An unofficial Python wrapper for Disney's API
 Author: Scott Caratozzolo
 License-Expression: MIT

{mousetools-4.3.0 → mousetools-4.3.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mousetools"
-version = "4.3.0"
+version = "4.3.1"
 authors = [{name = "Scott Caratozzolo"}]
 description = "An unofficial Python wrapper for Disney's API"
 readme = "README.md"