Adding support for the 2024 model year (#10)

* Adding support for 2024 model year

* Adding httpstat.us helper

Author: Ben-Chapman

src/libs/common_query_params.py

@@ -35,7 +35,7 @@ def __init__(
         self,
         # https://facts.usps.com/42000-zip-codes/. Starting zip code is 00501
         zip: int = Query(ge=501, le=99950),
-        year: int = Query(ge=2022, le=2023),
+        year: int = Query(ge=2022, le=2024),
         radius: int = Query(gt=0, lt=1000),
         model: str = Query(regex="|".join(valid_models)),
     ):

src/routers/bmw.py

@@ -18,6 +18,7 @@ async def get_bmw_inventory(
     max_page_size = 2000
 
     zip_code = str(common_params.zip)
+    year = str(common_params.year)
     model = common_params.model
     radius = str(common_params.radius)
 
@@ -33,6 +34,8 @@ async def get_bmw_inventory(
         + radius
         + " excludeStopSale: false series: "
         + f'"{model}"'
+        + f" minModelYear: {year}"
+        + f" maxModelYear: {year}"
         # Order statuses 0 and 1: Vehicle is at the dealership
         # 2, 3, 4, and 5: Vehicle is in transit or in production"
         + ', statuses:["0","1","2","3","4","5"] }, sorting: [{order: ASC, criteria: DISTANCE_TO_LOCATOR_ZIP},{order:ASC,criteria:PRICE}] pagination: {pageIndex: 1, '  # noqa: B950

src/routers/ford.py

@@ -93,7 +93,6 @@ async def main(
         }
     # Retrieve the initial batch of 12 vehicles
     inv = await http.get(uri=inventory_uri, headers=headers, params=inventory_params)
-    print(f"\n\n\n{type(inv)}\n\n\n")
     try:
         inv = inv.json()
     except AttributeError:

src/routers/genesis.py

@@ -1,8 +1,24 @@
-from fastapi import APIRouter, Depends, Request
+# Copyright 2023 Ben Chapman
+#
+# This file is part of The EV Finder.
+#
+# The EV Finder is free software: you can redistribute it and/or modify it under the
+# terms of the GNU General Public License as published by the Free Software Foundation,
+# either version 3 of the License, or (at your option) any later version.
+#
+# The EV Finder is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
+# without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+# See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along with The EV Finder.
+# If not, see <https://www.gnu.org/licenses/>.
+
+import datetime
 
+from fastapi import APIRouter, Depends, Request
 from src.libs.common_query_params import CommonInventoryQueryParams
-from src.libs.responses import error_response, send_response
 from src.libs.http import AsyncHTTPClient
+from src.libs.responses import error_response, send_response
 
 router = APIRouter(prefix="/api")
 verify_ssl = True
@@ -15,15 +31,26 @@ async def get_genesis_inventory(
     common_params: CommonInventoryQueryParams = Depends(),
 ) -> dict:
     """Makes a request to the Genesis Inventory API and returns a JSON object containing
-    the inventory results for a given vehicle model, zip code and search radius.
+    the inventory results for a given vehicle model and zip code.
+
+    The Genesis API does not accept a search radius nor a model year, rather a maxdealers
+    URI path segment. The EV Finder frontend deals with filtering the results to display
+    the relevant information for the search performed.
+
+    Args:
+        req (Request): The HTTP request from the EV Finder application.
+        common_params (CommonInventoryQueryParams, optional): The EV Finder query params.
+        Typically zip, year, model and radius. Defaults to Depends().
+
+    Returns:
+        dict: A JSON object containing the inventory results for the given search.
     """
-    params = {
-        "zip": common_params.zip,
-        "year": common_params.year,
-        "modelname": common_params.model,
-        "radius": common_params.radius,
-        "maxdealers": 25,
-    }
+
+    zipcode = common_params.zip
+    modelname = common_params.model
+    maxdealers = 50
+    todays_date = datetime.datetime.now().strftime("%Y-%m-%d")
+
     headers = {
         "User-Agent": req.headers.get("User-Agent"),
         "Referer": f"{genesis_base_url}/us/en/new/inventory.html",
@@ -33,9 +60,10 @@ async def get_genesis_inventory(
         base_url=genesis_base_url, timeout_value=30.0, verify=verify_ssl
     ) as http:
         inv = await http.get(
-            uri=("/bin/api/v1/inventory"),
+            uri=(
+                f"/bin/api/v1/inventory.json/{modelname}/{zipcode}/{maxdealers}/{todays_date}"
+            ),
             headers=headers,
-            params=params,
         )
 
         inventory_data = inv.json()
@@ -45,7 +73,9 @@ async def get_genesis_inventory(
                 response_data=inventory_data,
             )
         else:
-            error_message = "An error occurred with the Genesis API"
+            error_message = (
+                "An error occurred obtaining vehicle inventory for this search."
+            )
             return error_response(
                 error_message=error_message, error_data=inventory_data
             )
@@ -79,5 +109,7 @@ async def get_genesis_vin_detail(req: Request) -> dict:
                 response_data=vin_data,
             )
         else:
-            error_message = "An error occurred with the Genesis API"
+            error_message = (
+                "An error occurred obtaining VIN information for this vehicle."
+            )
             return error_response(error_message=error_message, error_data=vin_data)

src/routers/helpers.py

@@ -3,6 +3,7 @@
 from fastapi import APIRouter, Path
 
 from src.libs.responses import error_response, send_response
+from src.libs.http import AsyncHTTPClient
 
 router = APIRouter(prefix="/api")
 verify_ssl = True
@@ -29,3 +30,31 @@ def send_error_response(
     return error_response(
         error_message=f"This is a {status_code} error", status_code=status_code
     )
+
+
+@router.get("/test/status/{status_code}")
+async def send_httpstatus_error_response(
+    status_code: int = Path(
+        title="A HTTP status code in the 400 or 500 class", ge=400, le=599
+    ),
+):
+    async with AsyncHTTPClient(
+        base_url="https://httpstat.us", timeout_value=1.0, verify=True
+    ) as http:
+        params = {"sleep": 2000}
+        headers = {"User-Agent": "Test"}
+        h = await http.get(uri=f"/{status_code}", params=params, headers=headers)
+
+    try:
+        h.json()
+        return error_response(
+            error_message=f"This is a error: {h}", status_code=status_code
+        )
+    except AttributeError:
+        return error_response(
+            error_message=f"This is a error: {h}", status_code=status_code
+        )
+
+    # return "foo"
+    # return h.text if h.text else "foo"
+    #

src/routers/kia.py

@@ -52,12 +52,10 @@ async def get_kia_inventory(
                 error_data=inv.text,
             )
 
+    # When this key is not present, no vehicles were found for the given search so return
+    # an empty dict instead of the Kia response (which is filled with nulls)
     try:
         data["inventoryVehicles"]
         return send_response(response_data=data)
     except KeyError:
-        return error_response(
-            error_message="Invalid data received from the Kia inventory system.",
-            error_data=data,
-            status_code=500,
-        )
+        return send_response(response_data={})

src/tests/conftest.py

@@ -0,0 +1,43 @@
+import os
+import time
+
+import vcr
+
+cassette_dir = "tests/cassettes"
+
+
+def program_vcr():
+    for cassette in os.listdir(cassette_dir):
+        if "yaml" in cassette:  # Only delete the casette files
+            delete_stale_cassette(cassette_name=cassette)
+
+    _vcr = vcr.VCR(
+        cassette_library_dir=cassette_dir,
+        record_mode="new_episodes",
+    )
+
+    return _vcr
+
+
+def delete_stale_cassette(
+    cassette_name: str, delete_if_older_than_days: int = 30
+) -> None:
+    """We're using VCR.py to record the request / responses to the various manufacturer
+    APIs, in order to facilitate offline testing, less-flakey and deterministic tests.
+    As the manufacturer APIs are not under our control, I want to occasionally refresh
+    the API responses to ensure our tests pass against the most recent version of a
+    manufacturer API. If a VCR.py cassette is > delete_if_older_than_days days old,
+    remove it before starting a test.
+
+    Args:
+        cassette_name (str): Name of the cassette file to delete.
+        delete_if_older_than_days (int, optional): Delete a cassette file if older than
+         this value. Defaults to 30.
+    """
+
+    cassette_file = f"{cassette_dir}/{cassette_name}"
+    file_age_in_sec = time.time() - os.path.getmtime(cassette_file)
+
+    if file_age_in_sec > (delete_if_older_than_days * 60 * 60):
+        print(f"Deleting {cassette_file}")
+        os.remove(cassette_file)