MouseTools 3.0.0.dev2__py3-none-any.whl → 3.1.0.dev2__py3-none-any.whl

{MouseTools-3.0.0.dev2.dist-info → MouseTools-3.1.0.dev2.dist-info}/METADATA

@@ -1,9 +1,10 @@
 Metadata-Version: 2.1
 Name: MouseTools
-Version: 3.0.0.dev2
+Version: 3.1.0.dev2
 Summary: An unofficial Python wrapper for Disney's API
 Author: Scott Caratozzolo
 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

{MouseTools-3.0.0.dev2.dist-info → MouseTools-3.1.0.dev2.dist-info}/RECORD

@@ -1,11 +1,11 @@
-mousetools/__init__.py,sha256=QDVy9HOqGcQaEeRFhBKiKEx_BdM0er3pydqlvoSMztw,199
+mousetools/__init__.py,sha256=8TH8dO7pAgFB4pSi1mfpEtIEAtOoLj0thRwkh-BWc7U,199
 mousetools/auth.py,sha256=ogbssFgG4Fmjuce2ppH96nlh3BJNXjOTWuSVbVM4XGQ,2372
 mousetools/exceptions.py,sha256=0omdWcFu99r1XgVWQpn2jemgR34-lkfOeXvWFyCFILM,536
 mousetools/ids.py,sha256=Gsnb9tkQ7uyDacbGJHGdYVv-4-FyfEI3BplMrYW67PY,4248
 mousetools/urls.py,sha256=2WQMnUo080QxwFXOs5t9X5893QofQ5z3by_vkQsCDpo,233
-mousetools/entities/__init__.py,sha256=6UCrjuEJ_DboUhQHYrn16GL2VdCPw13or4fuU85Q4hM,1437
+mousetools/entities/__init__.py,sha256=HuNje5r9AuMPbP1h3S06XBPzoanhub8tWcApNyE4mIc,1493
 mousetools/entities/attraction.py,sha256=ACKNG_5xMM2kXws_76SmcfqaqErxRRzEER2XGsMtUpA,366
-mousetools/entities/base.py,sha256=G7i8WQhRoWAp7eDx3_c9I_A9rejnC9TwKchRAtL00_c,16570
+mousetools/entities/base.py,sha256=Eeye28DhNk1_YXf-VPtwI2U0uum-wPfVW1Q57CRofg0,16579
 mousetools/entities/character.py,sha256=ifdzEZC9r3W_ZBoYzjgsKMWbT3TmmDo98wg7letqaoU,363
 mousetools/entities/destination.py,sha256=MsQ713DRoWlBoEHSKqtt4qctArHXUqk1ukYU_tnNh5o,520
 mousetools/entities/dining_event.py,sha256=9aa7MF5FPQdLcwHDgm77KT6kmba3IVBx_KyhEPXu9XU,370
@@ -15,18 +15,18 @@ mousetools/entities/entertainment_venue.py,sha256=53WzFLnjoKZYaz3GV-B9km2UNiMYKX
 mousetools/entities/event.py,sha256=_u_IYJM55FwPpf_RVlqYK2ryaWq-5gznhBqRlSwnepg,351
 mousetools/entities/guest_services.py,sha256=p1NP1vnkEXOv1OMKRiWPhQ77Cikok3jXAOu3PJQXV_o,376
 mousetools/entities/land.py,sha256=oT8wSBuLyBe34kRhl2O-DJyA1np1O-X-YsJoRnqVhFI,348
-mousetools/entities/menu.py,sha256=sZPanyB7zuznRC-B4wIJbKWRyM_gwVAAVnLKsBjG5-A,353
+mousetools/entities/menu.py,sha256=ymXEBbxIlbThII_oxvgk9cXWt2_JSARWrk0uR4-xaw0,6167
 mousetools/entities/merchandise_facility.py,sha256=xtU_yuhGi4seS7e2ClMtsaqmw-SBIs5N_7gFz1FxgcA,395
 mousetools/entities/park.py,sha256=ZtXo4hyyJFIRQ7l-GMmBj9rMH14KUQ84f5RVZ0VLBcI,1221
 mousetools/entities/point_of_interest.py,sha256=h-CroI3QwuLGvGmGHRS3yQO8OQB-5lplLmQHlvLHDNo,385
 mousetools/entities/resort.py,sha256=aKNrLVa_KRTHPLbY2IHMp7sgSesBT2gR0u6XJBaEt14,354
 mousetools/entities/resort_area.py,sha256=COiwcB8aXOFWmjw_RYOYgJ35SHb8z_QaBKyTHA2OGZQ,368
-mousetools/entities/restaurant.py,sha256=QTWPhmQb0kqRUNdLwqCpc3LGpQ35DvXdWFXQXgtgCBo,366
+mousetools/entities/restaurant.py,sha256=9Ci3N2QohPeuPUwBS19rsFsXMjFC89IgSU8pYjJTKlo,1655
 mousetools/mixins/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-mousetools/mixins/disney.py,sha256=9EW_TPl3LQy9EHyivxVSOKJ1TWjfPHHdwnDQJK4c-b0,1854
+mousetools/mixins/disney.py,sha256=1l2ck-1cIZph_fnIApqGRqLGKgVpTn91wnZ5abmxmfs,1862
 mousetools/mixins/themeparksapi.py,sha256=gxep2vBXMSSVh1c3Yjt7oaIyCjhQfGtbSHXysbhazbs,4321
-MouseTools-3.0.0.dev2.dist-info/LICENSE,sha256=xX4HoDU-zdafl3yEfIaspkvqHPaaXhuDwkJ6qhDMUIo,1074
-MouseTools-3.0.0.dev2.dist-info/METADATA,sha256=RyuiZTeMGFhu4LPRIpTDIhoah-Ax90JBjQK7JhA1cgI,2496
-MouseTools-3.0.0.dev2.dist-info/WHEEL,sha256=UvcQYKBHoFqaQd6LKyqHw9fxEolWLQnlzP0h_LgJAfI,91
-MouseTools-3.0.0.dev2.dist-info/top_level.txt,sha256=7nanLN103J_xJn6HK6yuyqqlDgltCsQY2-ArRXx1Ukk,11
-MouseTools-3.0.0.dev2.dist-info/RECORD,,
+MouseTools-3.1.0.dev2.dist-info/LICENSE,sha256=xX4HoDU-zdafl3yEfIaspkvqHPaaXhuDwkJ6qhDMUIo,1074
+MouseTools-3.1.0.dev2.dist-info/METADATA,sha256=JHql1m7EDD0kAOK5-mZ2b3Tr4q49dlYrHV1a-CIFJt4,2576
+MouseTools-3.1.0.dev2.dist-info/WHEEL,sha256=uCRv0ZEik_232NlR4YDw4Pv3Ajt5bKvMH13NUU7hFuI,91
+MouseTools-3.1.0.dev2.dist-info/top_level.txt,sha256=7nanLN103J_xJn6HK6yuyqqlDgltCsQY2-ArRXx1Ukk,11
+MouseTools-3.1.0.dev2.dist-info/RECORD,,

{MouseTools-3.0.0.dev2.dist-info → MouseTools-3.1.0.dev2.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (74.0.0)
+Generator: setuptools (74.1.1)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

mousetools/__init__.py

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

mousetools/entities/__init__.py

@@ -8,6 +8,7 @@ from mousetools.entities.entertainment_venue import EntertainmentVenue
 from mousetools.entities.event import Event
 from mousetools.entities.guest_services import GuestServices
 from mousetools.entities.land import Land
+from mousetools.entities.menu import Menus
 from mousetools.entities.merchandise_facility import MerchandiseFacility
 from mousetools.entities.park import ThemePark, WaterPark
 from mousetools.entities.point_of_interest import PointOfInterest
@@ -38,4 +39,5 @@ __all__ = [
     "Event",
     "Land",
     "PointOfInterest",
+    "Menus",
 ]

mousetools/entities/base.py

@@ -23,7 +23,7 @@ class EntityBase(DisneyAPIMixin, ThemeParkAPIMixin):
 
         if isinstance(facility_service_entity_type, FacilityServiceEntityTypes):
             facility_service_entity_type = facility_service_entity_type.value
-        self.__facility_service_url = f"{WDPRO_FACILITY_SERVICE_BASE_URL}/{facility_service_entity_type}/{self.entity_id}"
+        self._facility_service_url = f"{WDPRO_FACILITY_SERVICE_BASE_URL}/{facility_service_entity_type}/{self.entity_id}"
 
     @property
     def name(self) -> typing.Optional[str]:
@@ -35,7 +35,7 @@ class EntityBase(DisneyAPIMixin, ThemeParkAPIMixin):
         """
 
         if self.disney_data is None:
-            self.disney_data = self.get_disney_data(self.__facility_service_url)
+            self.disney_data = self.get_disney_data(self._facility_service_url)
         try:
             return self.disney_data["name"]
         except KeyError:
@@ -52,7 +52,7 @@ class EntityBase(DisneyAPIMixin, ThemeParkAPIMixin):
         """
 
         if self.disney_data is None:
-            self.disney_data = self.get_disney_data(self.__facility_service_url)
+            self.disney_data = self.get_disney_data(self._facility_service_url)
         try:
             return self.disney_data["type"]
         except KeyError:
@@ -68,7 +68,7 @@ class EntityBase(DisneyAPIMixin, ThemeParkAPIMixin):
             (typing.Optional[str]): The sub type of entity, or None if it was not found.
         """
         if self.disney_data is None:
-            self.disney_data = self.get_disney_data(self.__facility_service_url)
+            self.disney_data = self.get_disney_data(self._facility_service_url)
         try:
             return self.disney_data["subType"]
         except KeyError:
@@ -84,7 +84,7 @@ class EntityBase(DisneyAPIMixin, ThemeParkAPIMixin):
             (typing.Optional[str]): The url friendly id of the entity, or None if not found.
         """
         if self.disney_data is None:
-            self.disney_data = self.get_disney_data(self.__facility_service_url)
+            self.disney_data = self.get_disney_data(self._facility_service_url)
         try:
             _id = self.disney_data["urlFriendlyId"]
             return _id
@@ -101,21 +101,22 @@ class EntityBase(DisneyAPIMixin, ThemeParkAPIMixin):
             (typing.Optional[dict[str, float]]): A dict with "lat" and "lng" keys containing the coordinates of this entity as floats, or None if no coordinates are found
         """
         if self.disney_data is None:
-            self.disney_data = self.get_disney_data(self.__facility_service_url)
+            self.disney_data = self.get_disney_data(self._facility_service_url)
         try:
             return {
                 "lat": float(
                     self.disney_data["coordinates"]["Guest Entrance"]["gps"][
-                        "lattitude"
+                        "latitude"
                     ]
                 ),
                 "lng": float(
-                    self.disney_data["coordinates"]["Guest entrance"]["gps"][
+                    self.disney_data["coordinates"]["Guest Entrance"]["gps"][
                         "longitude"
                     ]
                 ),
             }
-        except KeyError:
+        except KeyError as e:
+            print(e)
             logger.debug("No coordinates found for %s", self.entity_id)
             return None
 
@@ -129,7 +130,7 @@ class EntityBase(DisneyAPIMixin, ThemeParkAPIMixin):
         """
         # TODO check other ancestors to guess dest if not found
         if self.disney_data is None:
-            self.disney_data = self.get_disney_data(self.__facility_service_url)
+            self.disney_data = self.get_disney_data(self._facility_service_url)
         try:
             return (
                 self.disney_data["links"]["ancestorDestination"]["href"]
@@ -156,7 +157,7 @@ class EntityBase(DisneyAPIMixin, ThemeParkAPIMixin):
             (typing.Optional[str]): Theme park id, or None if no such id is found.
         """
         if self.disney_data is None:
-            self.disney_data = self.get_disney_data(self.__facility_service_url)
+            self.disney_data = self.get_disney_data(self._facility_service_url)
         try:
             return (
                 self.disney_data["links"]["ancestorThemePark"]["href"]
@@ -176,7 +177,7 @@ class EntityBase(DisneyAPIMixin, ThemeParkAPIMixin):
             (typing.Optional[str]): Water park id, or None if no such id is found.
         """
         if self.disney_data is None:
-            self.disney_data = self.get_disney_data(self.__facility_service_url)
+            self.disney_data = self.get_disney_data(self._facility_service_url)
         try:
             return (
                 self.disney_data["links"]["ancestorWaterPark"]["href"]
@@ -197,7 +198,7 @@ class EntityBase(DisneyAPIMixin, ThemeParkAPIMixin):
         """
 
         if self.disney_data is None:
-            self.disney_data = self.get_disney_data(self.__facility_service_url)
+            self.disney_data = self.get_disney_data(self._facility_service_url)
         try:
             return (
                 self.disney_data["links"]["ancestorResort"]["href"]
@@ -217,7 +218,7 @@ class EntityBase(DisneyAPIMixin, ThemeParkAPIMixin):
             (typing.Optional[str]): Land id, or None if no such id is found.
         """
         if self.disney_data is None:
-            self.disney_data = self.get_disney_data(self.__facility_service_url)
+            self.disney_data = self.get_disney_data(self._facility_service_url)
         try:
             return (
                 self.disney_data["links"]["ancestorLand"]["href"]
@@ -237,7 +238,7 @@ class EntityBase(DisneyAPIMixin, ThemeParkAPIMixin):
             (typing.Optional[str]): Resort area id, or None if no such id is found.
         """
         if self.disney_data is None:
-            self.disney_data = self.get_disney_data(self.__facility_service_url)
+            self.disney_data = self.get_disney_data(self._facility_service_url)
         try:
             return (
                 self.disney_data["links"]["ancestorResortArea"]["href"]
@@ -257,7 +258,7 @@ class EntityBase(DisneyAPIMixin, ThemeParkAPIMixin):
             (typing.Optional[str]): Entertainment venue id, or None if no such id is found.
         """
         if self.disney_data is None:
-            self.disney_data = self.get_disney_data(self.__facility_service_url)
+            self.disney_data = self.get_disney_data(self._facility_service_url)
         try:
             return (
                 self.disney_data["links"]["ancestorEntertainmentVenue"]["href"]
@@ -279,7 +280,7 @@ class EntityBase(DisneyAPIMixin, ThemeParkAPIMixin):
             (typing.Optional[str]): Restaurant id, or None if no such id is found.
         """
         if self.disney_data is None:
-            self.disney_data = self.get_disney_data(self.__facility_service_url)
+            self.disney_data = self.get_disney_data(self._facility_service_url)
         try:
             return (
                 self.disney_data["links"]["ancestorRestaurant"]["href"]
@@ -322,7 +323,7 @@ class EntityBase(DisneyAPIMixin, ThemeParkAPIMixin):
     @property
     def duration(self) -> typing.Optional[time]:
         if self.disney_data is None:
-            self.disney_data = self.get_disney_data(self.__facility_service_url)
+            self.disney_data = self.get_disney_data(self._facility_service_url)
         try:
             return time.fromisoformat(
                 ":".join(self.disney_data["duration"].split(":")[:3])
@@ -465,7 +466,7 @@ class EntityBase(DisneyAPIMixin, ThemeParkAPIMixin):
         if isinstance(entity_type, FacilityServiceEntityTypes):
             entity_type = entity_type.value
 
-        children_url = f"{self.__facility_service_url}/{entity_type}"
+        children_url = f"{self._facility_service_url}/{entity_type}"
         data = self.get_disney_data(children_url)
         if data:
             return [

mousetools/entities/menu.py

@@ -1,8 +1,144 @@
+import typing
+
 from mousetools.entities.base import EntityBase
 from mousetools.ids import FacilityServiceEntityTypes
 
 
-class Menu(EntityBase):
+class MenuItem:
+    def __init__(self, raw_item_data: dict):
+        self._raw_item_data = raw_item_data
+
+    def __repr__(self) -> str:
+        return f"MenuItem(entity_id={self.entity_id}, name={self.name})"
+
+    @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 name(self) -> typing.Optional[str]:
+        """
+        The name of the menu item.
+
+        Returns:
+            (typing.Optional[str]): The name of the menu item.
+        """
+        try:
+            return self._raw_item_data["name"]
+        except KeyError:
+            return None
+
+    @property
+    def type_name(self) -> typing.Optional[str]:
+        """
+        The type of the menu item.
+
+        Returns:
+            (typing.Optional[str]): The type of the menu item.
+        """
+        try:
+            return self._raw_item_data["type"]
+        except KeyError:
+            return None
+
+    @property
+    def price(self) -> typing.Optional[dict]:
+        """
+        The price of the menu item.
+
+        Examples:
+            {'price_qualifier': 'Per Serving', 'price_without_tax': 6.29}
+
+        Returns:
+            (typing.Optional[dict]): The price of the menu item.
+        """
+        try:
+            for i in self._raw_item_data["prices"]:
+                if i["type"] == "Retail":
+                    return {
+                        "price_without_tax": float(
+                            i["priceSpecifications"][0]["priceWithoutTax"]
+                        ),
+                        "price_qualifier": i["priceSpecifications"][0][
+                            "priceQualifier"
+                        ],
+                    }
+        except KeyError:
+            return None
+
+        return None
+
+
+class Menu:
+    def __init__(self, raw_menu_data: dict):
+        self._raw_menu_data = raw_menu_data
+
+    def __repr__(self) -> str:
+        return f"Menu(entity_id={self.entity_id}, name={self.name})"
+
+    @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 name(self) -> typing.Optional[str]:
+        """
+        The name of the menu.
+
+        Returns:
+            (typing.Optional[str]): The name of the menu.
+        """
+        try:
+            return self._raw_menu_data["name"]
+        except KeyError:
+            return None
+
+    @property
+    def type_name(self) -> typing.Optional[str]:
+        """
+        The type of the menu.
+
+        Returns:
+            (typing.Optional[str]): The type of the menu.
+        """
+        try:
+            return self._raw_menu_data["type"]
+        except KeyError:
+            return None
+
+    @property
+    def menu_items(self) -> list[MenuItem]:
+        """
+        The menu items of the menu.
+
+        Returns:
+            (list[MenuItem]): The menu items of the menu.
+        """
+        try:
+            return [MenuItem(i) for i in self._raw_menu_data["menuItems"]]
+        except KeyError:
+            return []
+
+
+class Menus(EntityBase):
     """Class for Menu Entities."""
 
     def __init__(self, entity_id: str):
@@ -10,3 +146,81 @@ class Menu(EntityBase):
             entity_id=entity_id,
             facility_service_entity_type=FacilityServiceEntityTypes.MENU_ITEMS,
         )
+
+    @property
+    def price_range(self) -> typing.Optional[str]:
+        """
+        The price range of the menu.
+
+        Examples:
+            "$ ($14.99 and under per adult)"
+
+        Returns:
+            (typing.Optional[str]): Price range of menu desribed in $.
+        """
+        if self.disney_data is None:
+            self.disney_data = self.get_disney_data(self._facility_service_url)
+        try:
+            return self.disney_data["priceRange"]
+        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.
+        """
+        if self.disney_data is None:
+            self.disney_data = self.get_disney_data(self._facility_service_url)
+        try:
+            return self.disney_data["serviceStyle"]
+        except KeyError:
+            return None
+
+    @property
+    def meal_period_type(self) -> typing.Optional[str]:
+        """
+        The meal period type of the menu.
+
+        Returns:
+            (typing.Optional[str]): The meal period type of the menu.
+        """
+        if self.disney_data is None:
+            self.disney_data = self.get_disney_data(self._facility_service_url)
+        try:
+            return self.disney_data["mealPeriodType"]
+        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.
+        """
+        if self.disney_data is None:
+            self.disney_data = self.get_disney_data(self._facility_service_url)
+        try:
+            return self.disney_data["primaryCuisineType"]
+        except KeyError:
+            return None
+
+    @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._facility_service_url)
+        try:
+            return [Menu(i) for i in self.disney_data["menus"]]
+        except KeyError:
+            return []

mousetools/entities/restaurant.py

@@ -1,6 +1,11 @@
+import logging
+import typing
+
 from mousetools.entities.base import EntityBase
 from mousetools.ids import FacilityServiceEntityTypes
 
+logger = logging.getLogger(__name__)
+
 
 class Restaurant(EntityBase):
     """Class for Restaurant Entities."""
@@ -10,3 +15,39 @@ class Restaurant(EntityBase):
             entity_id=entity_id,
             facility_service_entity_type=FacilityServiceEntityTypes.RESTAURANTS,
         )
+
+    @property
+    def service_styles(self) -> typing.Optional[list[str]]:
+        """
+        The service styles offered by the restaurant.
+
+        Returns:
+            (typing.Optional[list[str]]): The service styles offered by the restaurant.
+        """
+        if self.disney_data is None:
+            self.disney_data = self.get_disney_data(self._facility_service_url)
+        try:
+            return self.disney_data["serviceStyles"]
+        except KeyError:
+            logger.debug("No service styles found for %s", self.entity_id)
+            return None
+
+    @property
+    def menu_id(self) -> typing.Optional[str]:
+        """
+        The menu id associated with the restaurant.
+
+        Returns:
+            (typing.Optional[str]): The menu id associated with the restaurant.
+        """
+        if self.disney_data is None:
+            self.disney_data = self.get_disney_data(self._facility_service_url)
+        try:
+            return (
+                self.disney_data["menuItems"][0]["links"]["self"]["href"]
+                .split("?")[0]
+                .split("/")[-1]
+            )
+        except KeyError:
+            logger.debug("No menu id found for %s", self.entity_id)
+            return None

mousetools/mixins/disney.py

@@ -30,8 +30,6 @@ class DisneyAPIMixin:
         logger.info("Sending request to %s", url)
         response = httpx.get(url, headers=auth_obj.get_headers())
         logger.debug("Response status: %s", response.status_code)
-        if response.status_code == httpx._status_codes.codes.NOT_FOUND:
-            raise EntityIDNotFoundError
 
         try:
             response.raise_for_status()
@@ -49,6 +47,8 @@ class DisneyAPIMixin:
             logger.debug("Sending new request to %s", url)
             response = httpx.get(url, headers=auth_obj.get_headers())
             logger.debug("Response status: %s", response.status_code)
+            if response.status_code == httpx._status_codes.codes.NOT_FOUND:
+                raise EntityIDNotFoundError
             response.raise_for_status()
             data = response.json()