MouseTools 4.4.2__tar.gz → 4.5.1__tar.gz

{mousetools-4.4.2 → mousetools-4.5.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mousetools
-Version: 4.4.2
+Version: 4.5.1
 Summary: An unofficial Python wrapper for Disney's API
 Author: Scott Caratozzolo
 License-Expression: MIT
@@ -17,6 +17,7 @@ Classifier: Operating System :: OS Independent
 Requires-Python: <4.0,>=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: more-itertools>=10.7.0
 Requires-Dist: pycryptodome>=3.22.0
 Requires-Dist: python-dateutil>=2.9.0.post0
 Requires-Dist: requests>=2.32.3

{mousetools-4.4.2 → mousetools-4.5.1}/mousetools/channels/__init__.py

@@ -47,6 +47,11 @@ class CouchbaseChildChannel(CouchbaseMixin):
             self._cb_data = self.get_channel_data(self.channel_id)
             self._cb_data_pull_time = datetime.now(tz=self._tz.value)
 
+    def _refresh_from_manager(self, cb_data: dict) -> None:
+        logger.info("Refreshing new data from manager for %s", self.channel_id)
+        self._cb_data = cb_data
+        self._cb_data_pull_time = datetime.now(tz=self._tz.value)
+
     @disney_property()
     def last_update(self) -> Optional[datetime]:
         """
@@ -101,6 +106,11 @@ class CouchbaseChannel(CouchbaseMixin):
             self._cb_data = self.get_channel_changes(self.channel_id)
             self._cb_data_pull_time = datetime.now(tz=self._tz.value)
 
+    def _refresh_from_manager(self, cb_data: dict) -> None:
+        logger.info("Refreshing new data from manager for %s", self.channel_id)
+        self._cb_data = cb_data
+        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."""
         self.refresh()

mousetools-4.5.1/mousetools/channels/manager.py

@@ -0,0 +1,113 @@
+import logging
+from typing import Optional, Union
+
+from more_itertools import batched
+
+from mousetools.channels import CouchbaseChannel, CouchbaseChildChannel
+from mousetools.mixins.couchbase import CouchbaseMixin
+
+logger = logging.getLogger(__name__)
+
+
+class ChannelManager(CouchbaseMixin):
+    def __init__(self, channels: list[Union[CouchbaseChannel, CouchbaseChildChannel]]) -> None:
+        self._channel_store = {}
+        for channel in channels:
+            self._channel_store[channel.channel_id] = channel
+
+    def add_channel(self, channel: Union[CouchbaseChannel, CouchbaseChildChannel]) -> None:
+        """Adds a channel to the manager
+
+        Args:
+            channel (Union[CouchbaseChannel, CouchbaseChildChannel]): Channel to add
+        """
+        self._channel_store[channel.channel_id] = channel
+
+    def get_channel(self, channel_id: str) -> Union[CouchbaseChannel, CouchbaseChildChannel]:
+        """Returns a channel from the manager
+
+        Args:
+            channel_id (str): Channel ID
+
+        Returns:
+            Union[CouchbaseChannel, CouchbaseChildChannel]: The channel
+        """
+        return self._channel_store[channel_id]
+
+    def get_all_channels(self) -> list[Union[CouchbaseChannel, CouchbaseChildChannel]]:
+        """Returns a list of all channels in the manager
+
+        Returns:
+            list[Union[CouchbaseChannel, CouchbaseChildChannel]]: List of channels
+        """
+        return list(self._channel_store.values())
+
+    def get_channel_ids(self) -> list[str]:
+        """Returns a list of all channel ids in the manager
+
+        Returns:
+            list[str]: List of channel ids
+        """
+        return list(self._channel_store.keys())
+
+    def remove_channel(
+        self, channel_id: str, return_channel: bool = False
+    ) -> Optional[Union[CouchbaseChannel, CouchbaseChildChannel]]:
+        """Removes a channel from the manager
+
+        Args:
+            channel_id (str): Channel ID
+            return_channel (bool, optional): If True, will return the channel. Defaults to False.
+
+        Returns:
+            Optional[Union[CouchbaseChannel, CouchbaseChildChannel]]: The channel
+        """
+        channel = self._channel_store.pop(channel_id)
+        if return_channel:
+            return channel
+
+    def refresh(self) -> None:
+        """Refreshes all channels in the manager
+
+        Raises:
+            ValueError: If the channel is not a child or parent channel
+        """
+        children_channels: dict[str, CouchbaseChildChannel] = {}
+        parent_channels: dict[str, CouchbaseChannel] = {}
+
+        for channel_id, channel in self._channel_store.items():
+            if isinstance(channel, CouchbaseChildChannel):
+                children_channels[channel_id] = channel
+            elif isinstance(channel, CouchbaseChannel):
+                parent_channels[channel_id] = channel
+            else:
+                raise ValueError(f"Channel {channel} is not a child or parent channel")
+        logger.info(
+            "Refreshing %d children channels and %d parent channels", len(children_channels), len(parent_channels)
+        )
+
+        self._refresh_children(children_channels)
+
+        self._refresh_parents(parent_channels)
+
+    def _refresh_children(self, children_channels: dict[str, CouchbaseChildChannel]) -> None:
+        if children_channels:
+            logger.debug("Refreshing children channels")
+            for _channels in batched(children_channels, 100):
+                children_results = self.get_channel_data(_channels)
+                for channel_id, result in zip(_channels, children_results):
+                    children_channels[channel_id]._refresh_from_manager(result)
+
+    def _refresh_parents(self, parent_channels: dict[str, CouchbaseChannel]) -> None:
+        if parent_channels:
+            logger.debug("Refreshing parent channels")
+            for _channels in batched(parent_channels, 100):
+                parent_results = self.get_channel_changes(_channels)
+                for channel_id in _channels:
+                    copy_results = parent_results.copy()
+                    new_results = []
+                    for result in copy_results["results"]:
+                        if channel_id in result["id"]:
+                            new_results.append(result)
+                    copy_results["results"] = new_results
+                    parent_channels[channel_id]._refresh_from_manager(copy_results)

{mousetools-4.4.2 → mousetools-4.5.1}/mousetools/mixins/couchbase.py

@@ -14,28 +14,39 @@ class CouchbaseMixin:
     _couchbase_url = "https://" + auth_obj._environments["syncGatewayUrl"].split("//")[1].rstrip("/")
     _headers: dict = auth_obj.get_couchbase_headers()
 
-    def get_channel_data(self, channel_name: str) -> Union[dict, None]:
+    def get_channel_data(self, channel_name: Union[str, list[str]]) -> Union[list[dict], dict, None]:
         """
         Sends a request to the Disney Couchbase API with the given channel ID and returns the data.
 
         Args:
-            channel_name (str): Couchbase channel to request data from.
+            channel_name (Union[str, list[str]]): Couchbase channel(s) to request data from.
 
         Returns:
-            (dict): The disney data.
+            (Union[list[dict], dict, None]): The disney data.
         """
 
+        if isinstance(channel_name, str):
+            _channel_names = [channel_name]
+            return_list = False
+        else:
+            _channel_names = channel_name
+            return_list = True
+
         payload = {
-            "docs": [
-                {"id": channel_name},
-            ],
+            "docs": [{"id": name} for name in _channel_names],
             "json": True,
         }
 
-        logger.info("Sending request for channel data: %s", channel_name)
+        logger.info(
+            "Sending request for channel data: %s", f"{len(channel_name)} channels" if return_list else _channel_names
+        )
         response = requests.post(self._couchbase_url + "/_bulk_get", json=payload, headers=self._headers, timeout=10)
-        logger.debug("Response status for %s: %s", channel_name, response.status_code)
-        data = None
+        logger.debug(
+            "Response status for %s: %s",
+            f"{len(channel_name)} channels" if return_list else _channel_names,
+            response.status_code,
+        )
+        results = []
         try:
             response.raise_for_status()
             raw_data = response.text
@@ -48,6 +59,7 @@ class CouchbaseMixin:
                 if line != "" and line[0] != "-":
                     try:
                         data = json.loads(line)
+                        results.append(data)
                     except Exception:
                         logger.debug("Failed to parse line: %s", line)
                         continue
@@ -55,21 +67,30 @@ class CouchbaseMixin:
             logger.error("Request failed: %s", err)
             return None
 
-        return data
+        if return_list:
+            return results
+        else:
+            return results[0]
 
-    def get_channel_changes(self, channel_name: str, since: Union[int, None] = None) -> Union[dict, None]:
+    def get_channel_changes(
+        self, channel_name: Union[str, list[str]], since: Union[int, None] = None
+    ) -> Union[dict, None]:
         """Sends a request to the Disney Couchbase API with the given channel ID and returns the data.
 
         Args:
-            channel_name (str): Couchbase channel to request data from.
+            channel_name (Union[str, list[str]]): Couchbase channel to request data from.
             since (Union[int, None], optional): Since when to get changes. Defaults to None.
 
         Returns:
             Union[dict, None]: The disney data.
         """
+
+        if isinstance(channel_name, str):
+            channel_name = [channel_name]
+
         try:
             payload = {
-                "channels": channel_name,
+                "channels": ",".join(channel_name),
                 "style": "all_docs",
                 "filter": "sync_gateway/bychannel",
                 "feed": "normal",
@@ -78,9 +99,16 @@ class CouchbaseMixin:
             if since:
                 payload["since"] = since
 
-            logger.info("Sending request for channel changes: %s", channel_name)
+            logger.info(
+                "Sending request for channel changes: %s",
+                f"{len(channel_name)} channels" if len(channel_name) > 1 else channel_name[0],
+            )
             response = requests.post(self._couchbase_url + "/_changes", json=payload, headers=self._headers, timeout=10)
-            logger.debug("Response status for %s: %s", channel_name, response.status_code)
+            logger.debug(
+                "Response status for %s: %s",
+                f"{len(channel_name)} channels" if len(channel_name) > 1 else channel_name[0],
+                response.status_code,
+            )
             response.raise_for_status()
             data = response.json()
         except requests.HTTPError as err:

{mousetools-4.4.2 → mousetools-4.5.1}/mousetools.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mousetools
-Version: 4.4.2
+Version: 4.5.1
 Summary: An unofficial Python wrapper for Disney's API
 Author: Scott Caratozzolo
 License-Expression: MIT
@@ -17,6 +17,7 @@ Classifier: Operating System :: OS Independent
 Requires-Python: <4.0,>=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: more-itertools>=10.7.0
 Requires-Dist: pycryptodome>=3.22.0
 Requires-Dist: python-dateutil>=2.9.0.post0
 Requires-Dist: requests>=2.32.3

{mousetools-4.4.2 → mousetools-4.5.1}/mousetools.egg-info/SOURCES.txt

@@ -15,6 +15,7 @@ mousetools/api/menu.py
 mousetools/api/search.py
 mousetools/channels/__init__.py
 mousetools/channels/enums.py
+mousetools/channels/manager.py
 mousetools/channels/calendar/__init__.py
 mousetools/channels/characters/__init__.py
 mousetools/channels/facilities/__init__.py
@@ -26,4 +27,5 @@ mousetools/mixins/__init__.py
 mousetools/mixins/couchbase.py
 mousetools/mixins/disney.py
 mousetools/resources/environments.bin
+tests/test_manager.py
 tests/test_mixins.py

{mousetools-4.4.2 → mousetools-4.5.1}/mousetools.egg-info/requires.txt

@@ -1,3 +1,4 @@
+more-itertools>=10.7.0
 pycryptodome>=3.22.0
 python-dateutil>=2.9.0.post0
 requests>=2.32.3

{mousetools-4.4.2 → mousetools-4.5.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mousetools"
-version = "4.4.2"
+version = "4.5.1"
 authors = [{name = "Scott Caratozzolo"}]
 description = "An unofficial Python wrapper for Disney's API"
 readme = "README.md"
@@ -8,6 +8,7 @@ license = "MIT"
 license-files = ["LICENSE"]
 requires-python = ">=3.9, <4.0"
 dependencies = [
+    "more-itertools>=10.7.0",
     "pycryptodome>=3.22.0",
     "python-dateutil>=2.9.0.post0",
     "requests>=2.32.3",

mousetools-4.5.1/tests/test_manager.py

@@ -0,0 +1,28 @@
+from mousetools.channels.facilities import FacilityChannel, FacilityChildChannel
+from mousetools.channels.facilities.enums import DLRCouchbaseChannels, WDWCouchbaseChannels
+from mousetools.channels.manager import ChannelManager
+
+
+def test_manager():
+    channel_manager = ChannelManager([])
+    assert channel_manager.get_channel_ids() == []
+
+    wdw = FacilityChannel(WDWCouchbaseChannels.FACILITIES)
+    dlr = FacilityChannel(DLRCouchbaseChannels.FACILITIES)
+    channel_manager.add_channel(wdw)
+    channel_manager.add_channel(dlr)
+    assert channel_manager.get_all_channels() == [wdw, dlr]
+
+    channel = channel_manager.remove_channel(WDWCouchbaseChannels.FACILITIES.value, return_channel=True)
+    assert channel.channel_id == WDWCouchbaseChannels.FACILITIES.value
+    assert len(channel_manager.get_all_channels()) == 1
+
+    channel_manager.add_channel(
+        FacilityChildChannel("wdw.facilities.1_0.en_us.attraction.80010177;entityType=Attraction")
+    )
+    assert dlr._cb_data is None
+    channel_manager.refresh()
+    assert dlr._cb_data is not None
+
+    channel = channel_manager.get_channel("wdw.facilities.1_0.en_us.attraction.80010177;entityType=Attraction")
+    assert channel.channel_id == "wdw.facilities.1_0.en_us.attraction.80010177;entityType=Attraction"