MouseTools 2.1.2.dev2__py3-none-any.whl → 3.0.0.dev1__py3-none-any.whl

mousetools/entities/event.py

@@ -0,0 +1,8 @@
+from mousetools.entities.base import Entity
+
+
+class Event(Entity):
+    """Class for Event Entities."""
+
+    def __repr__(self) -> str:
+        return f"Event(id='{self.id}')"

mousetools/entities/merchandise_facility.py

@@ -0,0 +1,8 @@
+from mousetools.entities.base import Entity
+
+
+class MerchandiseFacility(Entity):
+    """Class for MerchandiseFacility Entities."""
+
+    def __repr__(self) -> str:
+        return f"MerchandiseFacility(id='{self.id}')"

mousetools/entities/park.py

@@ -0,0 +1,8 @@
+from mousetools.entities.base import Entity
+
+
+class Park(Entity):
+    """Class for Park Entities."""
+
+    def __repr__(self) -> str:
+        return f"Park(id='{self.id}')"

mousetools/entities/resort.py

@@ -0,0 +1,8 @@
+from mousetools.entities.base import Entity
+
+
+class Resort(Entity):
+    """Class for Resort Entities."""
+
+    def __repr__(self) -> str:
+        return f"Resort(id='{self.id}')"

mousetools/entities/restaurant.py

@@ -0,0 +1,8 @@
+from mousetools.entities.base import Entity
+
+
+class Restaurant(Entity):
+    """Class for Restaurant Entities."""
+
+    def __repr__(self) -> str:
+        return f"Restaurant(id='{self.id}')"

mousetools/exceptions.py

@@ -0,0 +1,17 @@
+class MouseToolsException(Exception):
+    """Base class for all MouseTools exceptions."""
+
+
+class EntityIDNotFound(MouseToolsException):
+    """Raised when an enity id could not be found."""
+
+    # TODO add id to message
+    def __init__(self, message="Entity ID not found."):
+        super().__init__(message)
+
+
+class AncestorDestinationMissing(MouseToolsException):
+    """Raised for entities missing ancestor destination."""
+
+    def __init__(self, message="Entity missing ancestor destination id."):
+        super().__init__(message)

mousetools/ids.py

@@ -1,44 +1,90 @@
-from .auth import get_headers
-import requests
-import json
-
-WDW_ID = '80007798'
-DLR_ID = '80008297'
-DESTINATION_IDS = [WDW_ID, DLR_ID]
-
-MK_ID = "80007944"
-EPCOT_ID = "80007838"
-HS_ID = "80007998"
-AK_ID = "80007823"
-DLP_ID = "330339"
-CA_ID = "336894"
-TL_ID = "80007981"
-BB_ID = "80007834"
-WDW_PARK_IDS = [MK_ID, EPCOT_ID, HS_ID, AK_ID, TL_ID, BB_ID]
-DLR_PARK_IDS = [DLP_ID, CA_ID]
-
-themeparkapi_ids = {MK_ID: "WaltDisneyWorldMagicKingdom", EPCOT_ID: "WaltDisneyWorldEpcot", HS_ID: "WaltDisneyWorldHollywoodStudios",
-                    AK_ID: "WaltDisneyWorldAnimalKingdom", DLP_ID: "DisneylandResortMagicKingdom", CA_ID: "DisneylandResortCaliforniaAdventure"}
-
-
-def ids(dest, type):
-    dest_data = requests.get("https://api.wdpro.disney.go.com/facility-service/destinations/{}".format(dest), headers=get_headers()).json()
-    ids = []
-
-    data = requests.get(dest_data['links'][type]['href'], headers=get_headers()).json()
-
-    for enter in data['entries']:
-        try:
-            ids.append(enter['links']['self']['href'].split('/')[-1].split('?')[0])
-        except:
-            pass
-    return ids
-
-WDW_EV_IDS = ids(WDW_ID, "entertainmentVenues")
-DLR_EV_IDS = ids(DLR_ID, "entertainmentVenues")
-
-WDW_ATTRACTION_IDS = ids(WDW_ID, "attractions")
-DLR_ATTRACTION_IDS = ids(DLR_ID, "attractions")
-
-WDW_ENTERTAINMENT_IDS = ids(WDW_ID, "entertainments")
-DLR_ENTERTAINMENT_IDS = ids(DLR_ID, "entertainments")
+from datetime import datetime
+from dataclasses import dataclass
+from concurrent.futures import ThreadPoolExecutor, as_completed
+from mousetools.auth import auth_obj
+from mousetools.urls import ANCESTOR_ENTITIES_BASE_URL
+import requests
+import logging
+
+logger = logging.getLogger(__name__)
+
+
+@dataclass(frozen=True)
+class DestinationIds:
+    WALT_DISNEY_WORLD: str = "80007798;entityType=destination"
+    """The destination id for Walt Disney World."""
+    DISNEYLAND_RESORT: str = "80008297;entityType=destination"
+    """The destination id for Disneyland Resort."""
+
+
+@dataclass(frozen=True)
+class WaltDisneyWorldParkIds:
+    MAGIC_KINGDOM: str = "80007944;entityType=theme-park"
+    """The Park id for Magic Kingdom."""
+    EPCOT: str = "80007838;entityType=theme-park"
+    """The Park id for Epcot."""
+    HOLLYWOOD_STUDIOS: str = "80007998;entityType=theme-park"
+    """The Park id for Hollywood Studios."""
+    ANIMAL_KINGDOM: str = "80007823;entityType=theme-park"
+    """The Park id for Animal Kingdom."""
+    TYPHOON_LAGOON: str = "80007981;entityType=water-park"
+    """The Park id for Typhoon Lagoon."""
+    BLIZZARD_BEACH: str = "80007834;entityType=water-park"
+    """The Park id for Blizzard Beach."""
+
+
+@dataclass(frozen=True)
+class DisneylandResortParkIds:
+    DISNEYLAND: str = "330339;entityType=theme-park"
+    """The Park id for Disneyland."""
+    CALIFORNIA_ADVENTURE: str = "336894;entityType=theme-park"
+    """The Park id for California Adventure."""
+
+
+@dataclass(frozen=True)
+class ThemeParkAPIIds:
+    WALT_DISNEY_WORLD: str = "e957da41-3552-4cf6-b636-5babc5cbc4e5"
+    """The ThemeParks.Wiki id for Walt Disney World."""
+    MAGIC_KINGDOM: str = "75ea578a-adc8-4116-a54d-dccb60765ef9"
+    """The ThemeParks.Wiki id for Magic Kingdom."""
+    EPCOT: str = "47f90d2c-e191-4239-a466-5892ef59a88b"
+    """The ThemeParks.Wiki id for Epcot."""
+    HOLLYWOOD_STUDIOS: str = "288747d1-8b4f-4a64-867e-ea7c9b27bad8"
+    """The ThemeParks.Wiki id for Hollywood Studios."""
+    ANIMAL_KINGDOM: str = "1c84a229-8862-4648-9c71-378ddd2c7693"
+    """The ThemeParks.Wiki id for Animal Kingdom."""
+    TYPHOON_LAGOON: str = "b070cbc5-feaa-4b87-a8c1-f94cca037a18"
+    """The ThemeParks.Wiki id for Typhoon Lagoon."""
+    BLIZZARD_BEACH: str = "ead53ea5-22e5-4095-9a83-8c29300d7c63"
+    """The ThemeParks.Wiki id for Blizzard Beach."""
+
+    DISNEYLAND_RESORT: str = "bfc89fd6-314d-44b4-b89e-df1a89cf991e"
+    """The ThemeParks.Wiki id for Disneyland Resort."""
+    DISNEYLAND: str = "7340550b-c14d-4def-80bb-acdb51d49a6"
+    """The ThemeParks.Wiki id for Disneyland."""
+    CALIFORNIA_ADVENTURE: str = "832fcd51-ea19-4e77-85c7-75d5843b127c"
+    """The ThemeParks.Wiki id for California Adventure."""
+
+
+def ancestor_entities(dest_id: str):
+    if dest_id == DestinationIds.WALT_DISNEY_WORLD:
+        destination = "wdw"
+    elif dest_id == DestinationIds.DISNEYLAND_RESORT:
+        destination = "dlr"
+
+    results = []
+
+    today_str = datetime.now().strftime("%Y-%m-%d")
+    base_url = f"{ANCESTOR_ENTITIES_BASE_URL}/{destination}/{dest_id}/{today_str}"
+    entity_names = ["/entertainment", "/dining", "/shops", "/resorts"]
+    with ThreadPoolExecutor(max_workers=5) as executor:
+        futures = [executor.submit(requests.get, f"{base_url}{i}", headers=auth_obj.get_headers(), timeout=300) for i in entity_names]
+        for future in as_completed(futures):
+            try:
+                response = future.result()
+                response.raise_for_status()
+                results += response.json()["results"]
+            except Exception as e:
+                logger.warning("Error getting ancestor entities: %s", e)
+
+    return results

mousetools/mixins/disney.py

@@ -0,0 +1,64 @@
+import logging
+import requests
+from mousetools.auth import auth_obj
+from mousetools import WALT_DISNEY_WORLD_ENTITIES, DISNEYLAND_RESORT_ENTITIES
+from mousetools.ids import DestinationIds
+from mousetools.exceptions import EntityIDNotFound
+
+logger = logging.getLogger(__name__)
+
+
+class DisneyAPIMixin:
+    _ancestor_destination_id = None
+    # should be set in subclass
+    id = ""
+
+    def get_disney_data(self):
+        """
+        Finds the entity in the Disney data and stores it in the
+        disney_data attribute. Also stores the ancestor destination id in
+        the _ancenstor_destination_id attribute.
+
+        Returns:
+            (dict): The disney data.
+
+        Raises:
+            (EntityIDNotFound): If the entity is not found in the Disney data.
+        """
+        for i in WALT_DISNEY_WORLD_ENTITIES:
+            if self.id == i["id"]:
+                self._ancestor_destination_id = DestinationIds.WALT_DISNEY_WORLD
+                logger.info("Entity %s found in Walt Disney World", self.id)
+                return i
+
+        for i in DISNEYLAND_RESORT_ENTITIES:
+            if self.id == i["id"]:
+                self._ancestor_destination_id = DestinationIds.DISNEYLAND_RESORT
+                logger.info("Entity %s found in Disneyland Resort", self.id)
+                return i
+
+        raise EntityIDNotFound
+
+    def get_extended_disney_data(self):
+        """
+        Gets the extended disney data for this entity from the Disney API.
+
+        The extended data is the data returned by the simple details API endpoint.
+
+        Returns:
+            (dict): The extended disney data.
+
+        Raises:
+            (requests.exceptions.RequestException): If there is an error getting the data.
+        """
+
+        headers = auth_obj.get_headers()
+
+        try:
+            response = requests.get(self.details_simple_url(), headers=headers)
+
+            response.raise_for_status()
+            return response.json()
+
+        except Exception as e:
+            logger.debug("Error getting extended disney data: %s", e)

mousetools/mixins/themeparksapi.py

@@ -0,0 +1,122 @@
+import typing
+import logging
+import requests
+from mousetools.ids import DestinationIds, ThemeParkAPIIds
+from mousetools.urls import THEMEPARK_BASE_URL
+from mousetools.exceptions import AncestorDestinationMissing, EntityIDNotFound
+
+logger = logging.getLogger(__name__)
+
+
+class ThemeParkAPIMixin:
+    _tp_entity_id = None
+    # Should be set in subclass
+    id = ""
+    ancestor_destination_id: typing.Optional[str] = None
+
+    @staticmethod
+    def _send_tp_request(url: str) -> dict:
+        """
+        Send a GET request to ThemeParks.Wiki
+
+        Args:
+            url (str): The url to send the request to
+
+        Returns:
+            (dict): The response, parsed as JSON
+
+        Raises:
+            (requests.exceptions.RequestException): If the request fails
+        """
+        logger.debug("Sending request to %s", url)
+        response = requests.get(url)
+        response.raise_for_status()
+        return response.json()
+
+    @property
+    def tp_entity_id(self) -> str:
+        """
+        The id of this entity on the ThemeParks.Wiki API.
+
+        Returns:
+            (str): The id of this entity on the ThemeParks.Wiki API
+
+        Raises:
+            (AncestorDestinationMissing): If the ancestor destination id is not
+                either Walt Disney World or Disneyland Resort
+            (EntityIDNotFound): If no ThemeParks.Wiki API id is found for this entity
+        """
+
+        if self._tp_entity_id is not None:
+            return self._tp_entity_id
+
+        if self.ancestor_destination_id == DestinationIds.WALT_DISNEY_WORLD:
+            tp_destination_id = ThemeParkAPIIds.WALT_DISNEY_WORLD
+        elif self.ancestor_destination_id == DestinationIds.DISNEYLAND_RESORT:
+            tp_destination_id = ThemeParkAPIIds.DISNEYLAND_RESORT
+        else:
+            raise AncestorDestinationMissing
+
+        request_url = f"{THEMEPARK_BASE_URL}/entity/{tp_destination_id}/children"
+        children = self._send_tp_request(request_url)["children"]
+
+        for i in children:
+            if i["externalId"] == self.id:
+                self._tp_entity_id = i["id"]
+                return i["id"]
+
+        raise EntityIDNotFound
+
+    def get_entity_tp(self) -> dict:
+        """
+        Get an entity details from the ThemeParks.Wiki API.
+
+        Returns:
+            (dict): The response, parsed as JSON
+        """
+        request_url = f"{THEMEPARK_BASE_URL}/entity/{self.tp_entity_id}"
+        return self._send_tp_request(request_url)
+
+    def get_entity_children_tp(self) -> dict:
+        """
+        Get the children entities of an entity from the ThemeParks.Wiki API.
+
+        Returns:
+            (dict): The response, parsed as JSON
+        """
+        request_url = f"{THEMEPARK_BASE_URL}/entity/{self.tp_entity_id}/children"
+        return self._send_tp_request(request_url)
+
+    def get_entity_live_tp(self) -> dict:
+        """
+        Get the live data for an entity from the ThemeParks.Wiki API.
+
+        Returns:
+            (dict): The response, parsed as JSON
+        """
+        request_url = f"{THEMEPARK_BASE_URL}/entity/{self.tp_entity_id}/live"
+        return self._send_tp_request(request_url)
+
+    def get_entity_schedule_tp(
+        self,
+        year: typing.Optional[typing.Union[int, str]] = None,
+        month: typing.Optional[typing.Union[int, str]] = None,
+    ) -> dict:
+        """
+        Get the schedule for an entity from the ThemeParks.Wiki API.
+
+        Args:
+            year (Optional[Union[int, str]], optional): The year for which to get the schedule. Defaults to None.
+            month (Optional[Union[int, str]], optional): The month for which to get the schedule. Defaults to None.
+
+        Returns:
+            (dict): The response, parsed as JSON
+        """
+        request_url = f"{THEMEPARK_BASE_URL}/entity/{self.tp_entity_id}/schedule"
+        if year is not None and month is not None:
+            request_url = f"{request_url}/{year}/{month}"
+        else:
+            raise UserWarning(
+                "Missing year or month. Both must be passed to be used in request."
+            )
+        return self._send_tp_request(request_url)

mousetools/urls.py

@@ -0,0 +1,5 @@
+ANCESTOR_ENTITIES_BASE_URL = "https://disneyworld.disney.go.com/finder/api/v1/explorer-service/list-ancestor-entities"
+
+ENTITY_DETAILS_SIMPLE_BASE_URL = "https://disneyworld.disney.go.com/finder/api/v1/explorer-service/details-entity-simple"
+
+THEMEPARK_BASE_URL: str = "https://api.themeparks.wiki/v1"

MouseTools-2.1.2.dev2.dist-info/METADATA

@@ -1,101 +0,0 @@
-Metadata-Version: 2.1
-Name: MouseTools
-Version: 2.1.2.dev2
-Summary: A Python wrapper for the Disney API
-Author: Scott Caratozzolo
-Project-URL: repository, https://gitlab.com/caratozzoloxyz/public/MouseTools
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: requests
-Requires-Dist: pytz
-
-# 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)
-
-
-A Python wrapper for the Disney API. Data is pulled directly from Disney. This package supports Walt Disney World and Disneyland.
-
-
-### Installation
-You can install using pip:
-```bash
-pip install MouseTools
-```
-You can also install directly from this repo in case of any changes not uploaded to Pypi.
-```bash
-pip install git+https://github.com/scaratozzolo/MouseTools
-```
-
-
-### Example usage:
-```python
-import mousetools
-
-wdw_dest = mousetools.Destination(80007798)
-print(wdw_dest.get_park_ids())
-
-dlr_dest = mousetools.Destination(80008297)
-print(dlr_dest.get_attraction_ids())
-
-mk = mousetools.Park(80007944)
-print(mk.get_wait_times())
-
-pirates = mousetools.Attraction(80010177)
-print(pirates.get_wait_time())
-
-
-# You don't have to know any ids to get started.
-mousetools.ids.WDW_ID     # Walt Disney World Resort
-mousetools.ids.DLR_ID     # Disneyland Resort
-
-# Single park ids
-mousetools.ids.MK_ID      # Magic Kingdom
-mousetools.ids.EPCOT_ID   # EPCOT
-mousetools.ids.HS_ID      # Hollywood Studios
-mousetools.ids.AK_ID      # Animal Kingdom
-mousetools.ids.TL_ID      # Typhoon Lagoon
-mousetools.ids.BB_ID      # Blizzard Beach
-mousetools.ids.DLP_ID     # Disneyland Park
-mousetools.ids.CA_ID      # California Adventure
-
-# List of ids
-# Parks
-mousetools.ids.WDW_PARK_IDS
-mousetools.ids.DLR_PARK_IDS
-
-# Entertainment Venues
-mousetools.ids.WDW_EV_IDS
-mousetools.ids.DLR_EV_IDS
-
-# Attractions
-mousetools.ids.WDW_ATTRACTION_IDS
-mousetools.ids.DLR_ATTRACTION_IDS
-
-# Entertainments
-mousetools.ids.WDW_ENTERTAINMENT_IDS
-mousetools.ids.DLR_ENTERTAINMENT_IDS
-
-```
-
-For more documentation go to the [wiki](https://github.com/scaratozzolo/MouseTools/wiki) or run the following command from a termainal:
-```Bash
-python -m pydoc mousetools
-```
-
-
-I created this project to help with another project found [here](https://github.com/scaratozzolo/WDWWaits). Some parts of the wrapper were created with that in mind.
-
-If you notice any issues please open a new issue with a "bug" label. Furthermore, if you have any feature requests, open a new issue with a "feature request" label.
-
-This package uses the [ThemeParks.wiki API](https://api.themeparks.wiki/). 
-
-### License
-This project is distributed under the MIT license. For more information see [LICENSE](https://github.com/scaratozzolo/MouseTools/blob/master/LICENSE)
-
-https://github.com/scaratozzolo/MouseTools
-
-### Disclaimer
-This project is in no way affiliated with The Walt Disney Company and all use of Disney Services is subject to the [Disney Terms of Use](https://disneytermsofuse.com/).

MouseTools-2.1.2.dev2.dist-info/RECORD

@@ -1,16 +0,0 @@
-mousetools/__init__.py,sha256=MITXDbBq7NpoeEBC8HrER6RWyvNlAq--662cisomv1k,680
-mousetools/attractions.py,sha256=C4RrRdv_pzSfdVm-qktMGgUk8UiYazjw9RIlygk2vhk,13435
-mousetools/auth.py,sha256=WtdVhAWP-ushDQOjcqxOZWYdufiFwMTH3FMkXxMiJwI,1532
-mousetools/characters.py,sha256=k4JYosNLCzjpF0cCB8akKM8Xl8zHuOCfZSKThKi_lao,8101
-mousetools/destinations.py,sha256=CvEuS0dBiNOcguuv-MAcrE8cuQXM3jEnqnlmLDNdACE,13130
-mousetools/entertainments.py,sha256=R-cV0dcEplbM6cZyPAAI6-tfrJOaX_bS93pJe2DN2BM,16041
-mousetools/entertainmentvenues.py,sha256=EQ-9gtfez1UgdcLcVO524EKimE0O7s9sF7rVD4APh4s,10001
-mousetools/facilities.py,sha256=Tzcv_6xFtGzLKVs9qrnSgH45DoDzg9k6mA-l_MMFAF4,9502
-mousetools/ids.py,sha256=opSGD1Kerdxtn99oDtVXDli6dqptzqKk2Sz9rVU-uu0,1407
-mousetools/parks.py,sha256=wVIlNuI9ehGKSlOKx-ZkMf2egcj3pyfE2Uysrnym_mA,16596
-mousetools/pointsofinterest.py,sha256=t1srDGcG_wduvvf_xhkFw6jbbxWh7hhufV-NKrpMLbc,5934
-MouseTools-2.1.2.dev2.dist-info/LICENSE,sha256=p6UXQpWnm-JPYIXK741EYHHVnLFUpxPJt1zFcZ4XgfM,1074
-MouseTools-2.1.2.dev2.dist-info/METADATA,sha256=Mypc1YdjgsuuqQ435-nZxy0StN8k7Etvu0t4F07Ny8U,3199
-MouseTools-2.1.2.dev2.dist-info/WHEEL,sha256=R0nc6qTxuoLk7ShA2_Y-UWkN8ZdfDBG2B6Eqpz2WXbs,91
-MouseTools-2.1.2.dev2.dist-info/top_level.txt,sha256=7nanLN103J_xJn6HK6yuyqqlDgltCsQY2-ArRXx1Ukk,11
-MouseTools-2.1.2.dev2.dist-info/RECORD,,