Add endpoint & logic for getting stop photo (StreetView)

Author: David-Lor

sample.env

@@ -49,5 +49,9 @@ google_maps_stop_map_default_size_y=720
 google_maps_stop_map_default_zoom=17
 google_maps_stop_map_default_type=roadmap
 
+# Default values for GET Photo/Streetview
+stop_photo_default_size_x=2000
+stop_photo_default_size_y=2000
+
 # Language in which print texts in static Maps pictures (2 characters country code)
 google_maps_language=es

vigobusapi/app.py

@@ -16,7 +16,7 @@
 from vigobusapi.request_handler import request_handler
 from vigobusapi.settings import settings, google_maps_settings
 from vigobusapi.vigobus_getters import get_stop, get_stops, get_buses, search_stops
-from vigobusapi.services.google_maps import GoogleMapRequest, get_map
+from vigobusapi.services.google_maps import GoogleMapRequest, GoogleStreetviewRequest, get_map, get_photo
 from vigobusapi.services import MongoDB
 from vigobusapi.logger import logger
 
@@ -96,22 +96,41 @@ async def endpoint_get_stop_map(
         map_type: GoogleMapRequest.MapTypes = google_maps_settings.stop_map_default_type
 ):
     """Get a picture of a map with the stop location marked on it."""
-    with logger.contextualize(**locals()):
-        stop = await get_stop(stop_id)
-        if (stop.lat, stop.lon) == (None, None):
-            raise HTTPException(status_code=409, detail="The stop does not have information about the location")
-
-        map_request = GoogleMapRequest(
-            location_x=stop.lat,
-            location_y=stop.lon,
-            size_x=size_x,
-            size_y=size_y,
-            zoom=zoom,
-            map_type=map_type,
-            tags=[GoogleMapRequest.Tag(location_x=stop.lat, location_y=stop.lon)]
-        )
-        map_data = await get_map(map_request)
-        return StreamingResponse(io.BytesIO(map_data), media_type="image/png")
+    stop = await get_stop(stop_id)
+    if (stop.lat, stop.lon) == (None, None):
+        raise HTTPException(status_code=409, detail="The stop does not have information about the location")
+
+    map_request = GoogleMapRequest(
+        location_x=stop.lat,
+        location_y=stop.lon,
+        size_x=size_x,
+        size_y=size_y,
+        zoom=zoom,
+        map_type=map_type,
+        tags=[GoogleMapRequest.Tag(location_x=stop.lat, location_y=stop.lon)]
+    )
+    map_data = await get_map(map_request)
+    return StreamingResponse(io.BytesIO(map_data), media_type="image/png")
+
+
+@app.get("/stop/{stop_id}/photo")
+async def endpoint_get_stop_photo(
+        stop_id: int,
+        size_x: int = google_maps_settings.stop_photo_default_size_x,
+        size_y: int = google_maps_settings.stop_photo_default_size_y,
+):
+    stop = await get_stop(stop_id)
+    if (stop.lat, stop.lon) == (None, None):
+        raise HTTPException(status_code=409, detail="The stop does not have information about the location")
+
+    photo_request = GoogleStreetviewRequest(
+        location_x=stop.lat,
+        location_y=stop.lon,
+        size_x=size_x,
+        size_y=size_y
+    )
+    photo_data = await get_photo(photo_request)
+    return StreamingResponse(io.BytesIO(photo_data), media_type="image/png")
 
 
 def run():

vigobusapi/services/google_maps.py

@@ -15,11 +15,12 @@
 from vigobusapi.logger import logger
 from .http_requester import http_request, ListOfTuples
 
-__all__ = ("GoogleMapRequest", "get_map")
+__all__ = ("GoogleMapRequest", "GoogleStreetviewRequest", "get_map", "get_photo")
 
 # TODO May refactor in package with different modules (at least split classes and logic)
 
 GOOGLE_MAPS_STATIC_API_URL = "https://maps.googleapis.com/maps/api/staticmap"
+GOOGLE_STREETVIEW_STATIC_API_URL = "https://maps.googleapis.com/maps/api/streetview"
 
 
 class _GoogleMapsBaseRequest(BaseModel, ChecksumableClass):
@@ -112,12 +113,17 @@ def checksum_hash(self):
     map_type: MapTypes
 
 
-async def _request(url: str, params: Union[dict, ListOfTuples]):
+class GoogleStreetviewRequest(_GoogleMapsBaseRequest):
+    pass
+
+
+async def _request(url: str, params: Union[dict, ListOfTuples], expect_http_error: bool = False):
     """HTTP requester for Google Maps API calls, automatically including the configured API key.
     Raises exception if the API Key is not configured.
 
     :param url: URL for the Google API, WITHOUT query parameters
     :param params: query parameters
+    :param expect_http_error: if True, raise_for_status=False and not_retry_400_errors=True
     """
     if not settings.enabled:
         raise Exception("Google Maps API Key not set in settings")
@@ -131,7 +137,9 @@ async def _request(url: str, params: Union[dict, ListOfTuples]):
         url=url,
         method="GET",
         params=params,
-        retries=1
+        retries=1,
+        raise_for_status=not expect_http_error,
+        not_retry_400_errors=expect_http_error
     )
 
 
@@ -164,3 +172,29 @@ async def get_map(request: GoogleMapRequest) -> bytes:
             params.append(("markers", tag_param))
 
     return (await _request(url=GOOGLE_MAPS_STATIC_API_URL, params=params)).content
+
+
+async def get_photo(request: GoogleStreetviewRequest) -> Optional[bytes]:
+    """Get a static StreetView picture from the Google StreetView Static API. Return the acquired PNG picture as bytes.
+    If the requested location does not have an available picture, returns None.
+
+    References:
+        https://developers.google.com/maps/documentation/streetview/overview
+    """
+    logger.bind(streetview_request=request.dict()).debug("Requesting Google Static StreetView picture...")
+    # TODO cache loaded pictures
+    # TODO Support specific parameters for tuning camera, if required
+    params = [
+        ("location", request.location_str),
+        ("size", request.size_str),
+        ("return_error_code", "true"),
+        ("source", "outdoor")
+    ]
+
+    response = await _request(GOOGLE_STREETVIEW_STATIC_API_URL, params=params, expect_http_error=True)
+    if response.status_code == 404:
+        logger.debug("No StreetView picture available for the request")
+        return None
+
+    response.raise_for_status()
+    return response.content

vigobusapi/settings.py

@@ -47,6 +47,8 @@ class GoogleMapsSettings(_BaseSettings):
     stop_map_default_size_y: int = 720
     stop_map_default_zoom: int = 17
     stop_map_default_type: str = "roadmap"  # TODO use enum (after refactoring to avoid circular dependency issue)
+    stop_photo_default_size_x: int = 2000
+    stop_photo_default_size_y: int = 2000
     language: str = "es"
 
     @property