MouseTools 3.1.0.dev2__tar.gz → 4.0.0b0__tar.gz

{mousetools-3.1.0.dev2 → mousetools-4.0.0b0}/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Scott Caratozzolo
+Copyright (c) 2025 Scott Caratozzolo
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

{mousetools-3.1.0.dev2 → mousetools-4.0.0b0/MouseTools.egg-info}/PKG-INFO

@@ -1,18 +1,20 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: MouseTools
-Version: 3.1.0.dev2
+Version: 4.0.0b0
 Summary: An unofficial Python wrapper for Disney's API
 Author: Scott Caratozzolo
+License-Expression: MIT
 Project-URL: repository, https://gitlab.com/caratozzoloxyz/public/MouseTools
 Project-URL: documentation, https://caratozzoloxyz.gitlab.io/public/MouseTools/
 Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: httpx>=0.27.2
+Requires-Dist: pycryptodome>=3.22.0
 Requires-Dist: tzdata>=2024.1
+Dynamic: license-file
 
 # MouseTools
 [![PyPI version](https://badge.fury.io/py/MouseTools.svg)](https://badge.fury.io/py/MouseTools) [![Downloads](https://pepy.tech/badge/mousetools)](https://pepy.tech/project/mousetools)

mousetools-4.0.0b0/MouseTools.egg-info/SOURCES.txt

@@ -0,0 +1,22 @@
+LICENSE
+README.md
+pyproject.toml
+MouseTools.egg-info/PKG-INFO
+MouseTools.egg-info/SOURCES.txt
+MouseTools.egg-info/dependency_links.txt
+MouseTools.egg-info/requires.txt
+MouseTools.egg-info/top_level.txt
+mousetools/__init__.py
+mousetools/auth.py
+mousetools/api/__init__.py
+mousetools/api/menu.py
+mousetools/channels/__init__.py
+mousetools/channels/enums.py
+mousetools/channels/facilities/__init__.py
+mousetools/channels/facilities/enums.py
+mousetools/channels/facilitystatus/__init__.py
+mousetools/mixins/__init__.py
+mousetools/mixins/couchbase.py
+mousetools/mixins/disney.py
+mousetools/resources/environments.bin
+tests/test_mixins.py

{mousetools-3.1.0.dev2 → mousetools-4.0.0b0}/MouseTools.egg-info/requires.txt

@@ -1,2 +1,3 @@
 httpx>=0.27.2
+pycryptodome>=3.22.0
 tzdata>=2024.1

{mousetools-3.1.0.dev2/MouseTools.egg-info → mousetools-4.0.0b0}/PKG-INFO

@@ -1,18 +1,20 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: MouseTools
-Version: 3.1.0.dev2
+Version: 4.0.0b0
 Summary: An unofficial Python wrapper for Disney's API
 Author: Scott Caratozzolo
+License-Expression: MIT
 Project-URL: repository, https://gitlab.com/caratozzoloxyz/public/MouseTools
 Project-URL: documentation, https://caratozzoloxyz.gitlab.io/public/MouseTools/
 Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: httpx>=0.27.2
+Requires-Dist: pycryptodome>=3.22.0
 Requires-Dist: tzdata>=2024.1
+Dynamic: license-file
 
 # MouseTools
 [![PyPI version](https://badge.fury.io/py/MouseTools.svg)](https://badge.fury.io/py/MouseTools) [![Downloads](https://pepy.tech/badge/mousetools)](https://pepy.tech/project/mousetools)

{mousetools-3.1.0.dev2 → mousetools-4.0.0b0}/mousetools/__init__.py

@@ -3,5 +3,5 @@ import logging
 logger = logging.getLogger(__name__)
 logger.addHandler(logging.NullHandler())
 
-__version__ = "3.1.0-dev.2"  # will be set at runtime
+__version__ = "0.0.0"  # will be set at runtime
 logger.info(f"MouseTools version: {__version__}")

mousetools-4.0.0b0/mousetools/api/menu.py

@@ -0,0 +1,433 @@
+import typing
+
+from mousetools.auth import auth_obj
+from mousetools.mixins.disney import DisneyAPIMixin
+
+# menus -> menu -> menugroups -> menuitems
+
+
+class MenuItem:
+    def __init__(self, raw_item_data: dict, parent_resturant_id: typing.Optional[str] = None):
+        self._raw_item_data = raw_item_data
+        self._parent_restaurant_id = parent_resturant_id
+
+    def __repr__(self) -> str:
+        return f"MenuItem(entity_id={self.entity_id}, parent_resturant_id={self._parent_restaurant_id})"
+
+    @property
+    def entity_id(self) -> typing.Optional[str]:
+        """
+        The entity id of the menu item.
+
+        Returns:
+            (typing.Optional[str]): The entity id of the menu item.
+        """
+        try:
+            return self._raw_item_data["id"]
+        except KeyError:
+            return None
+
+    @property
+    def pc_short_name(self) -> typing.Optional[str]:
+        """
+        The short name of the menu item.
+
+        Returns:
+            (typing.Optional[str]): The short name of the menu item.
+        """
+        try:
+            return self._raw_item_data["names"]["PCShort"]
+        except KeyError:
+            return None
+
+    @property
+    def pc_long_name(self) -> typing.Optional[str]:
+        """
+        The long name of the menu item.
+
+        Returns:
+            (typing.Optional[str]): The long name of the menu item.
+        """
+        try:
+            return self._raw_item_data["names"]["PCLong"]
+        except KeyError:
+            return None
+
+    @property
+    def mobile_short_name(self) -> typing.Optional[str]:
+        """
+        The short name of the menu item.
+
+        Returns:
+            (typing.Optional[str]): The short name of the menu item.
+        """
+        try:
+            return self._raw_item_data["names"]["MobileShort"]
+        except KeyError:
+            return None
+
+    @property
+    def mobile_long_name(self) -> typing.Optional[str]:
+        """
+        The long name of the menu item.
+
+        Returns:
+            (typing.Optional[str]): The long name of the menu item.
+        """
+        try:
+            return self._raw_item_data["names"]["MobileLong"]
+        except KeyError:
+            return None
+
+    @property
+    def mickey_check(self) -> typing.Optional[bool]:
+        """
+        Whether the menu item is mickey check.
+
+        Returns:
+            (typing.Optional[bool]): Whether the menu item is mickey check.
+        """
+        try:
+            return self._raw_item_data["mickeyCheck"]
+        except KeyError:
+            return None
+
+    @property
+    def pc_long_description(self) -> typing.Optional[str]:
+        """
+        The long description of the menu item.
+
+        Returns:
+            (typing.Optional[str]): The long description of the menu item.
+        """
+        try:
+            return self._raw_item_data["descriptions"]["PCLong"]["text"]
+        except KeyError:
+            return None
+
+    @property
+    def mobile_short_description(self) -> typing.Optional[str]:
+        """
+        The short description of the menu item.
+
+        Returns:
+            (typing.Optional[str]): The short description of the menu item.
+        """
+        try:
+            return self._raw_item_data["descriptions"]["MobileShort"]["text"]
+        except KeyError:
+            return None
+
+    @property
+    def default_selection(self) -> typing.Optional[bool]:
+        """
+        Whether the menu item is the default selection.
+
+        Returns:
+            (typing.Optional[bool]): Whether the menu item is the default selection.
+        """
+        try:
+            return self._raw_item_data["defaultSelection"]
+        except KeyError:
+            return None
+
+    @property
+    def prices(self) -> typing.Optional[dict]:
+        """
+        The prices of the menu item.
+
+        Returns:
+            (typing.Optional[dict]): The prices of the menu item.
+        """
+        try:
+            return self._raw_item_data["prices"]
+        except KeyError:
+            return None
+
+    @property
+    def per_serving_without_tax(self) -> typing.Optional[float]:
+        """
+        The per serving without tax of the menu item.
+
+        Returns:
+            (typing.Optional[float]): The per serving without tax of the menu item.
+        """
+        try:
+            return self._raw_item_data["prices"]["PerServing"]["withoutTax"]
+        except KeyError:
+            return None
+
+
+class MenuGroup:
+    def __init__(self, raw_menu_group_data: dict, parent_restaurant_id: typing.Optional[str] = None):
+        self._raw_menu_group_data = raw_menu_group_data
+        self._parent_restaurant_id = parent_restaurant_id
+
+    def __str__(self) -> str:
+        return f"MenuGroup(menu_group_type={self.menu_group_type}, parent_restaurant_id={self._parent_restaurant_id})"
+
+    @property
+    def menu_group_type(self) -> typing.Optional[str]:
+        """
+        The type of the menu group.
+
+        Returns:
+            (typing.Optional[str]): The type of the menu group.
+        """
+        try:
+            return self._raw_menu_group_data["menuGroupType"]
+        except KeyError:
+            return None
+
+    @property
+    def multiple_price_types(self) -> typing.Optional[bool]:
+        """
+        Whether the menu group has multiple price types.
+
+        Returns:
+            (typing.Optional[bool]): Whether the menu group has multiple price types.
+        """
+        try:
+            return self._raw_menu_group_data["multiplePriceTypes"]
+        except KeyError:
+            return None
+
+    @property
+    def mickey_check_items(self) -> typing.Optional[bool]:
+        """
+        Whether the menu group has mickey check items.
+
+        Returns:
+            (typing.Optional[bool]): Whether the menu group has mickey check items.
+        """
+        try:
+            return self._raw_menu_group_data["mickeyCheckItems"]
+        except KeyError:
+            return None
+
+    @property
+    def names(self) -> typing.Optional[dict]:
+        """
+        The names of the menu group.
+
+        Returns:
+            (typing.Optional[dict]): The names of the menu group.
+        """
+        try:
+            return self._raw_menu_group_data["names"]
+        except KeyError:
+            return None
+
+    @property
+    def pc_short_name(self) -> typing.Optional[str]:
+        """
+        The short name of the menu group.
+
+        Returns:
+            (typing.Optional[str]): The short name of the menu group.
+        """
+        try:
+            return self._raw_menu_group_data["names"]["PCShort"]
+        except KeyError:
+            return None
+
+    @property
+    def pc_long_name(self) -> typing.Optional[str]:
+        """
+        The long name of the menu group.
+
+        Returns:
+            (typing.Optional[str]): The long name of the menu group.
+        """
+        try:
+            return self._raw_menu_group_data["names"]["PCLong"]
+        except KeyError:
+            return None
+
+    @property
+    def mobile_short_name(self) -> typing.Optional[str]:
+        """
+        The short name of the menu group.
+
+        Returns:
+            (typing.Optional[str]): The short name of the menu group.
+        """
+        try:
+            return self._raw_menu_group_data["names"]["MobileShort"]
+        except KeyError:
+            return None
+
+    @property
+    def mobile_long_name(self) -> typing.Optional[str]:
+        """
+        The long name of the menu group.
+
+        Returns:
+            (typing.Optional[str]): The long name of the menu group.
+        """
+        try:
+            return self._raw_menu_group_data["names"]["MobileLong"]
+        except KeyError:
+            return None
+
+    @property
+    def menu_items(self) -> typing.Optional[list[MenuItem]]:
+        """
+        The menu items of the menu group.
+
+        Returns:
+            (typing.Optional[list[MenuItem]]): The menu items of the menu group.
+        """
+        try:
+            return [MenuItem(i, self._parent_restaurant_id) for i in self._raw_menu_group_data["menuItems"]]
+        except KeyError:
+            return None
+
+
+class Menu:
+    def __init__(self, raw_menu_data: dict, parent_restaurant_id: typing.Optional[str] = None):
+        self._raw_menu_data = raw_menu_data
+        self._parent_restaurant_id = parent_restaurant_id
+
+    def __str__(self):
+        return f"Menu(entity_id={self.entity_id}, menu_type={self.menu_type}, parent_restaurant_id={self._parent_restaurant_id})"
+
+    @property
+    def entity_id(self) -> typing.Optional[str]:
+        """
+        The entity id of the menu.
+
+        Returns:
+            (typing.Optional[str]): The entity id of the menu.
+        """
+        try:
+            return self._raw_menu_data["id"]
+        except KeyError:
+            return None
+
+    @property
+    def menu_type(self) -> typing.Optional[str]:
+        """
+        The type of the menu.
+
+        Returns:
+            (typing.Optional[str]): The type of the menu.
+        """
+        try:
+            return self._raw_menu_data["menuType"]
+        except KeyError:
+            return None
+
+    @property
+    def localized_menu_type(self) -> typing.Optional[str]:
+        """
+        The localized type of the menu.
+
+        Returns:
+            (typing.Optional[str]): The localized type of the menu.
+        """
+        try:
+            return self._raw_menu_data["localizedMenuType"]
+        except KeyError:
+            return None
+
+    @property
+    def experience_type(self) -> typing.Optional[str]:
+        """
+        The experience type of the menu.
+
+        Returns:
+            (typing.Optional[str]): The experience type of the menu.
+        """
+        try:
+            return self._raw_menu_data["experienceType"]
+        except KeyError:
+            return None
+
+    @property
+    def service_style(self) -> typing.Optional[str]:
+        """
+        The service style of the menu.
+
+        Returns:
+            (typing.Optional[str]): The service style of the menu.
+        """
+        try:
+            return self._raw_menu_data["serviceStyle"]
+        except KeyError:
+            return None
+
+    @property
+    def primary_cuisine_type(self) -> typing.Optional[str]:
+        """
+        The primary cuisine type of the menu.
+
+        Returns:
+            (typing.Optional[str]): The primary cuisine type of the menu.
+        """
+        try:
+            return self._raw_menu_data["primaryCuisineType"]
+        except KeyError:
+            return None
+
+    @property
+    def secondary_cuisine_type(self) -> typing.Optional[str]:
+        """
+        The secondary cuisine type of the menu.
+
+        Returns:
+            (typing.Optional[str]): The secondary cuisine type of the menu.
+        """
+        try:
+            return self._raw_menu_data["secondaryCuisineType"]
+        except KeyError:
+            return None
+
+    @property
+    def menu_groups(self) -> list[MenuGroup]:
+        """
+        The menu groups of the menu.
+
+        Returns:
+            (list[MenuGroup]): The menu items of the menu.
+        """
+        try:
+            return [MenuGroup(i, self._parent_restaurant_id) for i in self._raw_menu_data["menuGroups"]]
+        except KeyError:
+            return []
+
+
+class Menus(DisneyAPIMixin):
+    """Class for Menu Entities."""
+
+    _menu_service_base = f"{auth_obj._environments['serviceMenuUrl']}/diningMenuSvc/orchestration/menus"
+
+    def __init__(self, restaurant_channel_id: str, lazy_load: bool = True):
+        self.entity_id = restaurant_channel_id.rsplit(".", 1)[-1]
+        self._menu_service_url = f"{self._menu_service_base}/{self.entity_id}"
+
+        if lazy_load:
+            self.disney_data: typing.Optional[dict] = None
+        else:
+            self.disney_data = self.get_disney_data(self.entity_id)
+
+    def __str__(self):
+        return f"Menus(entity_id={self.entity_id})"
+
+    def __repr__(self):
+        return f"Menus(restaurant_channel_id={self.entity_id})"
+
+    @property
+    def menus(self) -> list[Menu]:
+        """
+        Returns a list of all the menus associated with this entity.
+
+        Returns:
+            (list[Menu]): List of Menu objects that are associated with this entity.
+        """
+        if self.disney_data is None:
+            self.disney_data = self.get_disney_data(self._menu_service_url)
+        try:
+            return [Menu(i, self.entity_id) for i in self.disney_data["menus"]]
+        except KeyError:
+            return []

mousetools-4.0.0b0/mousetools/auth.py

@@ -0,0 +1,112 @@
+import base64
+import json
+import typing
+from datetime import datetime, timedelta
+from importlib.resources import as_file, files
+
+import httpx
+from Crypto.Cipher import AES
+
+
+class Authentication:
+    def __init__(self):
+        self.time_of_expire: typing.Optional[datetime] = None
+        self.access_token: typing.Optional[str] = None
+        self._environments = self._decrypt_file("resources/environments.bin").get("production", {})
+
+    def authenticate(self) -> tuple[str, int]:
+        """Gets an access token from Disney and the token's expiration time
+
+        Returns:
+            (tuple[str, int]): Access token to the api and how long until it expires
+        """
+
+        headers = {
+            "User-Agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36",
+            "Accept-Language": "en-US,en;q=0.9",
+            "Cache-Control": "max-age=0",
+            "Accept": "application/json",
+            "Content-Type": "application/x-www-form-urlencoded",
+            "Connection": "keep-alive",
+            "Proxy-Connection": "keep-alive",
+            "Accept-Encoding": "gzip, deflate",
+        }
+
+        body = {
+            "grant_type": "assertion",
+            "assertion_type": "public",
+            "client_id": self._environments["authzClientId"],
+        }
+
+        response = httpx.post(
+            f"{self._environments['authzServiceUrl']}/token",
+            headers=headers,
+            params=body,
+            timeout=10,
+        )
+        response.raise_for_status()
+        auth = response.json()
+
+        return auth["access_token"], int(auth["expires_in"])
+
+    def get_headers(self) -> dict[str, str]:
+        """Creates the headers to send during the request
+
+        Returns:
+            (dict[str, str]): Headers for the request
+        """
+
+        if self.time_of_expire is None or (datetime.now() > self.time_of_expire):
+            access_token, expires_in = self.authenticate()
+            self.time_of_expire = datetime.now() + timedelta(seconds=(expires_in - 10))
+            self.access_token = access_token
+
+        headers = {
+            "Authorization": f"BEARER {self.access_token}",
+            "User-Agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36",
+            "Content-Type": "application/json",
+            "Accept": "*/*",
+        }
+
+        return headers
+
+    def get_couchbase_headers(self) -> dict[str, str]:
+        """Creates the headers to send during the couchbase request
+
+        Returns:
+            (dict[str, str]): Headers for the couchbase request
+        """
+        username = self._environments["syncGatewayUser"]
+        password = self._environments["syncGatewayPass"]
+        token = base64.b64encode(f"{username}:{password}".encode()).decode()
+
+        header = {
+            "Authorization": f"Basic {token}",
+            "User-Agent": "CouchbaseLite/3.2.1-9 (Java; Android 16; sdk_gphone64_x86_64) EE/release, Commit/2109502be2@02fbcb1b8b44 Core/3.2.1 (19)",
+            "Content-Type": "application/json",
+            "Accept": "multipart/related",
+        }
+
+        return header
+
+    def _decrypt_file(self, filename: str) -> dict:
+        cipher = AES.new(self._e(), AES.MODE_GCM, nonce=self._b())
+        with as_file(files("mousetools") / filename) as f, open(f, "rb") as file:
+            decrypted = cipher.decrypt(file.read())
+            return json.loads(decrypted.decode("Windows-1252")[:-16])
+
+    def _e(self):
+        s = ""
+        for i in range(1, 17):
+            if i % 2 != 0 or i >= 16:
+                s += chr(i + 65)
+            else:
+                s += str(3.141592653589793)[i]
+        bytes_ = s.encode("utf-8")
+        return bytes_
+
+    def _b(self):
+        return bytes(reversed(self._e()))
+
+
+auth_obj = Authentication()

mousetools-4.0.0b0/mousetools/channels/__init__.py

@@ -0,0 +1,46 @@
+import typing
+from datetime import datetime, timedelta
+from enum import Enum
+
+from mousetools.channels.enums import DestinationShort, DestinationTimezones, DLRCouchbaseChannels, WDWCouchbaseChannels
+from mousetools.mixins.couchbase import CouchbaseMixin
+
+
+class CouchbaseChannel(CouchbaseMixin):
+    def __init__(self, channel_id: typing.Union[WDWCouchbaseChannels, DLRCouchbaseChannels], lazy_load: bool = True):
+        """
+        Args:
+            channel_id (typing.Union[WDWCouchbaseChannels, DLRCouchbaseChannels]): Channel ID from the enum
+            lazy_load (bool, optional): If True, will not pull data until a method or property is called. Defaults to True.
+        """
+        if isinstance(channel_id, Enum):
+            channel_id = channel_id.value
+        self.channel_id = channel_id
+
+        self._destination_short: DestinationShort = channel_id.split(".")[0]
+        self._tz: DestinationTimezones = (
+            DestinationTimezones.WALT_DISNEY_WORLD
+            if self._destination_short == DestinationShort.WALT_DISNEY_WORLD
+            else DestinationTimezones.DISNEYLAND_RESORT
+        )
+
+        self._cb_data = None
+        self._refresh_interval = timedelta(minutes=10)
+        self.last_update = 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:
+            self._cb_data = self.get_channel_changes(self.channel_id)
+
+    def get_children_channel_ids(self) -> list[str]:
+        """Returns a list of child channel ids for the channel."""
+        self.refresh()
+
+        return [i["id"] for i in self._cb_data["results"]]
+
+    def __repr__(self):
+        return f"{self.__class__.__name__}({self.channel_id})"