✨ RecDotGov Tours + Tickets + Timed Entry (#189)

* ✨ RecDotGov Tours + Timed Entry (#151)

* Add support for tours (ticket and timed-entry) as new providers

A tour facility is currently modeled as a campground and each individual
tour is a campsite. User interface was not updated yet but the logic
does the work as expected.

* Add RecreationDotGovDailyTicket and RecreationDotGovDailyTimedEntry

With this endpoint, available time slots can be extracted. They're
attached as equipments on each tour (as campsite).

* RecreationDotGov Tours (#1)

Flake8 + ABC

* Fix Flake8 lint errors

Co-authored-by: Justin Flannery <juftin@juftin.com>

* ✨ RecDotGov Tours + Timed Entry

* 📝 New Provider Docs (#190)

* 📝 New Provider Docs

* 📝 Provider Docs

Co-authored-by: jingyuanliang <jingyuanliang@google.com>

Author: juftin

.github/workflows/lint.yaml

@@ -40,5 +40,5 @@ jobs:
             run: |
                 echo "Flake8: ${{ steps.flake8.outcome }}"
                 echo "MyPy: ${{ steps.mypy.outcome }}"
-                echo "I Should Really Be Enforcing MyPy Errors
+                echo "I Should Really Be Enforcing MyPy Errors"
                 exit 1

.pre-commit-config.yaml

@@ -34,6 +34,12 @@ repos:
     -   id: pretty-format-toml
         args: [--autofix]
 
+-   repo: https://github.com/PyCQA/autoflake
+    rev: v2.0.0
+    hooks:
+    -   id: autoflake
+        args: [--in-place, --expand-star-imports, --remove-all-unused-imports, --remove-duplicate-keys, --remove-unused-variables, --ignore-pass-after-docstring]
+
 # sets up .pre-commit-ci.yaml to ensure pre-commit dependencies stay up to date
 ci:
     autoupdate_schedule: weekly

README.md

@@ -83,6 +83,7 @@ Camply doesn't support your favorite campsite booking provider yet? Consider
     * [RecreationDotGov](docs/providers.md#recreationgov)
     * [Yellowstone](docs/providers.md#yellowstone)
     * [GoingToCamp](docs/providers.md#goingtocamp)
+    * [RecDotGov Tours + Tickets + Timed Entry](docs/providers.md#recreationgov-tickets-tours--timed-entry)
 - [Command Line Usage](docs/command_line_usage.md)
     * [campsites](docs/command_line_usage.md#campsites)
     * [recreation-areas](docs/command_line_usage.md#recreation-areas)
@@ -109,6 +110,10 @@ Camply doesn't support your favorite campsite booking provider yet? Consider
         + [Search for Recreation Areas by Query String](docs/command_line_usage.md#search-for-recreation-areas-by-query-string)
         + [Look for Specific Campgrounds Within a Recreation Area](docs/command_line_usage.md#look-for-specific-campgrounds-within-a-recreation-area)
         + [Look for Specific Campgrounds by Query String](docs/command_line_usage.md#look-for-specific-campgrounds-by-query-string)
+        + [Searching for Tickets and Timed Entries](docs/ccommand_line_usage.md#searching-for-tickets-and-timed-entries)
+            - [Tickets + Tours](docs/ccommand_line_usage.md#tickets-tours)
+            - [Timed Entry](docs/ccommand_line_usage.md#timed-entry)
+            - [Using the Daily Providers](command_line_usage.md#using-the-daily-providers)
 - [Finding Recreation Areas IDs and Campground IDs To Search Without Using the Command Line](docs/command_line_usage.md#finding-recreation-areas-ids-and-campground-ids-to-search-without-using-the-command-line)
 - [Object-Oriented Usage (Python)](docs/python.md)
     * [Search for a Recreation.gov Campsite](docs/python.md#search-for-a-recreationgov-campsite)

camply/cli.py

@@ -46,9 +46,8 @@ class CamplyContext:
     "--provider",
     show_default=False,
     default=None,
-    help="Camping Search Provider. Options available are 'Yellowstone', "
-    "'RecreationDotGov', and 'GoingToCamp'. Defaults to 'RecreationDotGov'"
-    ", not case-sensitive.",
+    type=click.Choice(CAMPSITE_SEARCH_PROVIDER.keys(), case_sensitive=False),
+    help="Camping Search Provider. Defaults to 'RecreationDotGov', not case-sensitive.",
 )
 debug_option = click.option(
     "--debug/--no-debug", default=None, help="Enable extra debugging output"
@@ -85,11 +84,11 @@ def _preferred_provider(context: CamplyContext, command_provider: Optional[str])
     The preferred provider is returned
     """
     if command_provider:
-        return command_provider.lower()
+        return command_provider
     elif command_provider is None and context.provider:
-        return context.provider.lower()
+        return context.provider
     else:
-        return DEFAULT_CAMPLY_PROVIDER.lower()
+        return DEFAULT_CAMPLY_PROVIDER
 
 
 @click.group()
@@ -213,38 +212,24 @@ def recreation_areas(
     if context.debug is None:
         context.debug = debug
         _set_up_debug(debug=context.debug)
-
-    # Recreation dot gov and yellowstone require --state or --search, but going to
-    # camp does not, since all of its "rec areas" are a very few.
-    if all([search is None, state is None, provider != GOING_TO_CAMP]):
-        logger.error(
-            "You must add a --search, --state, or --provider parameter "
-            "to search for Recreation Areas."
-        )
-        exit(1)
-    if all([search is None, state is not None, provider == GOING_TO_CAMP]):
+    if all(
+        [search is None, state is not None, provider in [YELLOWSTONE, GOING_TO_CAMP]]
+    ):
+        # State Filtering Not Supported
         logger.error(
-            "GoingToCamp does not support filtering recreation areas by state. Leave --state blank."
+            f"{provider} does not support filtering recreation areas by state. Leave --state blank."
         )
         exit(1)
-
-    camp_provider = None
-    if provider == RECREATION_DOT_GOV:
-        camp_provider = RecreationDotGov()
-    elif provider == GOING_TO_CAMP:
-        camp_provider = GoingToCampProvider()
+    if provider == GOING_TO_CAMP:
+        rec_area_finder = GoingToCampProvider()
+    elif provider.startswith(RECREATION_DOT_GOV):
+        rec_area_finder = RecreationDotGov()
     else:
-        logger.error(
-            "The provider you specified does not exist or does notsupport"
-            "listing recreation areas. See --help for available providers"
-        )
-        exit(1)
-
+        rec_area_finder = CAMPSITE_SEARCH_PROVIDER[provider]
     params = dict()
     if state is not None:
         params.update(dict(state=state))
-
-    camp_provider.find_recreation_areas(search_string=search, **params)
+    rec_area_finder.find_recreation_areas(search_string=search, **params)
 
 
 @camply_command_line.command()
@@ -264,7 +249,7 @@ def campgrounds(
     rec_area: Optional[int] = None,
     campground: Optional[int] = None,
     campsite: Optional[int] = None,
-    provider: str = DEFAULT_CAMPLY_PROVIDER,
+    provider: Optional[str] = DEFAULT_CAMPLY_PROVIDER,
 ) -> None:
     """
     Search for Campgrounds (inside of Recreation Areas) and list them
@@ -278,7 +263,6 @@ def campgrounds(
     if context.debug is None:
         context.debug = debug
         _set_up_debug(debug=context.debug)
-
     if provider == YELLOWSTONE:
         SearchYellowstone.print_campgrounds()
         exit(0)
@@ -296,11 +280,10 @@ def campgrounds(
             "or --rec-area parameter to search for Campgrounds."
         )
         exit(1)
-
     if provider == YELLOWSTONE:
         SearchYellowstone.print_campgrounds()
         exit(0)
-    if provider == GOING_TO_CAMP:
+    elif provider == GOING_TO_CAMP:
         if len(rec_area) == 0:
             logger.error("You must specify at least one --rec-area")
             exit(1)
@@ -309,8 +292,8 @@ def campgrounds(
             rec_area_id=rec_area_id, campground_id=campground, search_string=search
         )
         exit(0)
-
-    camp_finder = RecreationDotGov()
+    search_provider_class = CAMPSITE_SEARCH_PROVIDER[provider]
+    camp_finder = search_provider_class.provider_class()
     params = dict()
     if state is not None:
         params.update(dict(state=state))
@@ -471,7 +454,7 @@ def _validate_campsites(
     """
     Validate the campsites portion of the CLI
     """
-    if provider == RECREATION_DOT_GOV and all(
+    if provider.startswith(RECREATION_DOT_GOV) and all(
         [
             len(rec_area) == 0,
             len(campground) == 0,
@@ -561,7 +544,6 @@ def campsites(
     if context.debug is None:
         context.debug = debug
         _set_up_debug(debug=context.debug)
-
     notifications = make_list(notifications)
     _validate_campsites(
         rec_area=rec_area,
@@ -583,7 +565,9 @@ def campsites(
         provider, provider_kwargs, search_kwargs = yaml_utils.yaml_file_to_arguments(
             file_path=yaml_config
         )
-        provider = provider.lower()
+        for provider_str in CAMPSITE_SEARCH_PROVIDER.keys():
+            if provider.lower() == provider_str.lower():
+                provider = provider_str
     else:
         search_window = SearchWindow(
             start_date=datetime.strptime(start_date, "%Y-%m-%d"),
@@ -610,9 +594,7 @@ def campsites(
             notification_provider=notifications,
             search_forever=search_forever,
         )
-    provider_class = {
-        key.lower(): value for key, value in CAMPSITE_SEARCH_PROVIDER.items()
-    }[provider]
+    provider_class = CAMPSITE_SEARCH_PROVIDER[provider]
     camping_finder = provider_class(**provider_kwargs)
     camping_finder.get_matching_campsites(**search_kwargs)
 

camply/config/api_config.py

@@ -199,10 +199,14 @@ class RIDBConfig:
     # FACILITIES_API_PATH FIELDS
     FACILITIES_API_PATH: str = "facilities"
     CAMPGROUND_FACILITY_FIELD_QUALIFIER: str = "Campground"
+    TICKET_FACILITY_FIELD_QUALIFIER: str = "Ticket Facility"
+    TIMED_ENTRY_FACILITY_FIELD_QUALIFIER: str = "Timed Entry"
     # RECREATION AREA FIELDS
     REC_AREA_API_PATH: str = "recareas"
     # CAMPSITE DETAILS
     CAMPSITE_API_PATH: str = "campsites"
+    # TOUR DETAILS
+    TOUR_API_PATH: str = "tours"
 
 
 class RecreationBookingConfig:

camply/config/search_config.py

@@ -65,3 +65,10 @@ class EquipmentConfig:
     for key, list_of_values in EQUIPMENT_MAPPING.items():
         for value in list_of_values:
             EQUIPMENT_REVERSE_MAPPING[value] = key
+
+    TIMESTAMP_EQUIPMENT = []
+    for hour in range(0, 24):
+        hour_str = str(hour).zfill(2)
+        for minute in range(0, 60):
+            minute_str = str(minute).zfill(2)
+            TIMESTAMP_EQUIPMENT.append(hour_str + minute_str)

camply/config/yellowstone_config.py

@@ -69,6 +69,7 @@ class YellowstoneConfig(DataColumns):
 
     YELLOWSTONE_RECREATION_AREA_ID: int = 1
     YELLOWSTONE_RECREATION_AREA_NAME: str = "Yellowstone"
+    YELLOWSTONE_RECREATION_AREA_FULL_NAME: str = "Yellowstone National Park"
     YELLOWSTONE_RECREATION_AREA_FORMAL_NAME: str = "Yellowstone National Park, USA"
     YELLOWSTONE_LOOP_NAME: str = "N/A"
     CAMPSITE_AVAILABILITY_STATUS: str = "Available"