Use custom markers on multi-stop maps

Author: David-Lor

README.md

@@ -95,7 +95,6 @@ _La API puede devolver información de Paradas y listados en tiempo real de los
 - Add Near Stops endpoint
 - Add endpoint for static maps and StreetView acquisition
 - Add endpoints for static buses info
-- On multi-stop map generation, return markers showing stop IDs
 - Add integration tests
 - Add detailed install & configuration instructions
 - Improve endpoint and services/controllers in-code organization
@@ -107,7 +106,6 @@ _La API puede devolver información de Paradas y listados en tiempo real de los
 - _Añadir endpoint para consulta de paradas cercanas a ubicación_
 - _Añadir endpoint para obtención de mapas estáticos y StreetView_
 - _Añadir endpoints para consulta de información estática de buses_
-- _En generación de mapas de varias paradas, devolver marcadores mostrando IDs de parada_
 - _Añadir tests de integración_
 - _Añadir instrucciones detalladas de instalación y configuración_
 - _Mejorar organización en código de endpoints y servicios/controladores_

vigobusapi/app.py

@@ -4,7 +4,6 @@
 
 # # Native # #
 import io
-import json
 from typing import Optional, Set
 
 # # Installed # #
@@ -130,21 +129,11 @@ async def endpoint_get_stops_map(
         stops_ids: Set[int] = Query(None, alias="stop_id", min_items=1, max_items=35),
         map_params: MapQueryParams = Depends(),
 ):
-    """Get a picture of a map with the locations of the given stops marked on it.
-    The marks are labelled in the same order as the given stops ids.
-
-    A header "X-Stops-Tags" is returned, being a JSON associating the Stops IDs with the tag label on the map,
-    with the format: {"<stop id>" : "<tag label>"}
-    """
+    """Get a picture of a map with the locations of the given stops marked on it."""
     stops = await get_stops(stops_ids)
 
-    stops_tags = list()
-    stops_tags_relation = dict()
-    for i, stop in enumerate(stops):
-        tag_label = GoogleMapRequest.Tag.get_allowed_labels()[i]
-        tag = GoogleMapRequest.Tag(label=tag_label, location_x=stop.lat, location_y=stop.lon)
-        stops_tags.append(tag)
-        stops_tags_relation[stop.stop_id] = tag_label
+    # noinspection PyTypeChecker
+    stops_tags = [GoogleMapRequest.Tag(label=stop.stop_id, location_x=stop.lat, location_y=stop.lon) for stop in stops]
 
     map_request = GoogleMapRequest(
         size_x=map_params.size_x,
@@ -157,8 +146,7 @@ async def endpoint_get_stops_map(
 
     return StreamingResponse(
         content=io.BytesIO(map_data),
-        media_type="image/png",
-        headers={"X-Stops-Tags": json.dumps(stops_tags_relation)}
+        media_type="image/png"
     )
 
 

vigobusapi/services/google_maps.py

@@ -8,6 +8,7 @@
 from typing import *
 
 # # Installed # #
+import pydantic
 from pydantic import BaseModel
 
 # # Project # #
@@ -24,6 +25,12 @@
 GOOGLE_STREETVIEW_STATIC_API_URL = "https://maps.googleapis.com/maps/api/streetview"
 
 
+def get_labelled_icon_url(label: str) -> str:
+    """Get an URL pointing to a picture of a map marker, with a custom label on top of it"""
+    # TODO self-hosted generation, and/or cache of generated labels
+    return f"https://cdn.mapmarker.io/api/v1/font-awesome/v5/pin?text={label}&size=40&background=D94B43&color=000000&hoffset=-1"
+
+
 class _GoogleMapsBaseRequest(BaseModel, ChecksumableClass):
     location_x: float
     location_y: float
@@ -60,13 +67,23 @@ class Tag(BaseModel, ChecksumableClass):
         __ALLOWED_LABELS = [*[str(i) for i in range(1, 10)], *[c for c in string.ascii_uppercase]]
 
         label: Optional[str] = None  # TODO constrain values accepted (avoid enum?)
+        icon_url: Optional[str] = None
         location_x: float
         location_y: float
 
         @classmethod
         def get_allowed_labels(cls):
             return cls.__ALLOWED_LABELS
 
+        @pydantic.root_validator(pre=True)
+        def label_to_icon(cls, kwargs: dict):
+            """If label is not an "allowed label", generate an icon for it and set it as "icon_url"."""
+            label = kwargs.get("label")
+            if label not in cls.__ALLOWED_LABELS:
+                kwargs["label"] = None
+                kwargs["icon_url"] = get_labelled_icon_url(label)
+            return kwargs
+
         @property
         def location_str(self):
             return f"{self.location_x},{self.location_y}"
@@ -154,15 +171,23 @@ async def _request(url: str, params: Union[dict, ListOfTuples], expect_http_erro
     )
 
 
-async def get_map(request: GoogleMapRequest) -> bytes:
-    """Get a static Map picture from the Google Maps Static API. Return the acquired PNG picture as bytes.
+def _get_map_tags_params(request_tags: List[GoogleMapRequest.Tag]) -> ListOfTuples:
+    params = list()
+    for tag in request_tags:
+        tag_param_values = [tag.location_str]  # Location always at the end
 
-    References:
-        https://developers.google.com/maps/documentation/maps-static/overview
-        https://developers.google.com/maps/documentation/maps-static/start
-    """
-    logger.bind(map_request=request.dict()).debug("Requesting Google Static Map picture...")
-    # TODO cache loaded pictures
+        if tag.label:
+            tag_param_values.insert(0, "label:" + tag.label)
+        if tag.icon_url:
+            tag_param_values.insert(0, "icon:" + tag.icon_url)
+
+        tag_param = "|".join(tag_param_values)
+        params.append(("markers", tag_param))
+
+    return params
+
+
+def _get_map_params(request: GoogleMapRequest) -> ListOfTuples:
     params = [
         ("size", request.size_str),
         ("maptype", request.map_type.value),
@@ -176,15 +201,22 @@ async def get_map(request: GoogleMapRequest) -> bytes:
         params.append(("zoom", str(request.zoom)))
 
     if request.tags:
-        for tag in request.tags:
-            tag_param_values = [tag.location_str]  # Location always at the end
+        params.extend(_get_map_tags_params(request.tags))
+
+    return params
 
-            if tag.label:
-                tag_param_values.insert(0, "label:" + tag.label)
 
-            tag_param = "|".join(tag_param_values)
-            params.append(("markers", tag_param))
+async def get_map(request: GoogleMapRequest) -> bytes:
+    """Get a static Map picture from the Google Maps Static API. Return the acquired PNG picture as bytes.
+
+    References:
+        https://developers.google.com/maps/documentation/maps-static/overview
+        https://developers.google.com/maps/documentation/maps-static/start
+    """
+    logger.bind(map_request=request.dict()).debug("Requesting Google Static Map picture...")
+    # TODO cache loaded pictures
 
+    params = _get_map_params(request)
     return (await _request(url=GOOGLE_MAPS_STATIC_API_URL, params=params)).content