feat: include calculated arrival hour on buses

Author: David-Lor

sample.env

@@ -15,6 +15,7 @@ TYPING_SAFE_LIMIT_TIME=30
 INLINE_CACHE_TIME=300
 STOP_MESSAGES_DEPRECATION_REMINDER_AFTER_SECONDS=300  # 300s = 5 minutes
 STOP_MESSAGES_DEPRECATION_REMINDER_LOOP_DELAY_SECONDS=30
+STOP_MESSAGES_INCLUDE_ARRIVAL_HOUR_AFTER_MINUTES=10
 
 # Bus API
 API_URL=http://localhost:5000

static/messages.yaml

@@ -4,9 +4,11 @@
 # Emojis: https://www.webfx.com/tools/emoji-cheat-sheet/
 start:
   - |-
-    ¡Hola! :wave: Este bot proporciona información sobre los autobuses urbanos de la ciudad de Vigo en tiempo real y por paradas.
+    ¡Hola! :wave: Este bot proporciona información sobre los :bus:autobuses urbanos de la ciudad de Vigo en :stopwatch:tiempo real y por :bus_stop:paradas.
 
     Para empezar, envíame el código de la parada que quieras consultar. Podrás encontrar los números de parada en las marquesinas y paradas de autobús.
+    
+    :megaphone:Te puedes suscribir al canal @vigobus para recibir novedades de este bot y notificaciones de servicio.
 
     :question:¿Dudas? Para más información y ayuda, envía /ayuda
 help:
@@ -67,11 +69,13 @@ stop:
   bus_line: >-
     <pre>  {line} ({route}): {time}</pre>
   bus_time_remaining: >-
-    {minutes}m
+    {minutes}m {arrival_time}
   bus_time_now: >-
     &lt;&lt;&lt;
   time_format: >-  # https://docs.python.org/3/library/datetime.html#strftime-and-strptime-behavior
     %d/%m %H:%M:%S
+  bus_arrival_time_format: >-  # https://docs.python.org/3/library/datetime.html#strftime-and-strptime-behavior
+    (~%H:%M)
   no_buses_found: >-
     <pre> ¡No hay buses!</pre>
   not_exists:

vigobusbot/entities.py

@@ -1,7 +1,7 @@
 """ENTITIES
 Custom and imported entities used all over the project
 """
-
+import datetime
 # # Native # #
 from typing import Optional, List, Dict
 
@@ -21,7 +21,10 @@ class Stop(pydantic.BaseModel):
 class Bus(pydantic.BaseModel):
     line: str
     route: str
-    time: int
+    time: int  # minutes
+
+    def get_calculated_arrival_time(self) -> datetime.datetime:
+        return datetime.datetime.now() + datetime.timedelta(minutes=self.time)
 
 
 class File(pydantic.BaseModel):

vigobusbot/settings_handler/__init__.py

@@ -39,6 +39,9 @@ class TelegramSettings(BaseBotSettings):
     If 0, disable this feature."""
     stop_messages_deprecation_reminder_loop_delay_seconds: int = 60
     """Delay for the loop that checks for deprecated Stop messages."""
+    stop_messages_include_arrival_hour_after_minutes: int = -1
+    """Buses arriving after this amount of minutes will include the calculated hour of arrival.
+    Negative values to disable the feature."""
 
     def __init__(self, **kwargs):
         super().__init__(**kwargs)

vigobusbot/telegram_bot/services/message_generators/stop_message_text.py

@@ -2,14 +2,13 @@
 Helper to generate the Stop Message text body
 """
 
-# # Native # #
 import datetime
-from typing import Optional
+from typing import Optional, List
 
-# # Project # #
 from vigobusbot.persistence_api import saved_stops
 from vigobusbot.static_handler import get_messages
-from vigobusbot.entities import Stop, BusesResponse
+from vigobusbot.entities import Stop, BusesResponse, Bus
+from vigobusbot.settings_handler import telegram_settings
 
 __all__ = ("generate_stop_message_text",)
 
@@ -20,7 +19,6 @@ def generate_stop_message_text(
         user_saved_stop: Optional[saved_stops.SavedStop]
 ) -> str:
     messages = get_messages()
-    buses = buses_response.buses
 
     # Generate Stop Name text
     if user_saved_stop and user_saved_stop.stop_name:
@@ -31,23 +29,7 @@ def generate_stop_message_text(
     else:
         stop_name_text = stop.name
 
-    # Generate Buses text
-    if buses:
-        buses_text_lines = list()
-        for bus in buses:
-            if bus.time == 0:
-                time_text = messages.stop.bus_time_now
-            else:
-                time_text = messages.stop.bus_time_remaining.format(minutes=bus.time)
-            buses_text_lines.append(messages.stop.bus_line.format(
-                line=bus.line,
-                route=bus.route,
-                time=time_text
-            ))
-        buses_text = "\n".join(buses_text_lines)
-    else:
-        buses_text = messages.stop.no_buses_found
-
+    buses_text = "\n".join(_generate_buses_text_lines(buses_response.buses))
     last_update_text = datetime.datetime.now().strftime(messages.stop.time_format)
 
     return messages.stop.message.format(
@@ -56,3 +38,32 @@ def generate_stop_message_text(
         buses=buses_text,
         last_update=last_update_text
     )
+
+
+def _generate_buses_text_lines(buses: List[Bus]) -> List[str]:
+    if not buses:
+        return [get_messages().stop.no_buses_found]
+
+    return [_generate_bus_text_line(bus) for bus in buses]
+
+
+def _generate_bus_text_line(bus: Bus) -> str:
+    messages = get_messages()
+    if bus.time == 0:
+        time_text = messages.stop.bus_time_now
+    else:
+        if bus.time > telegram_settings.stop_messages_include_arrival_hour_after_minutes:
+            arrival_time = bus.get_calculated_arrival_time().strftime(messages.stop.bus_arrival_time_format)
+        else:
+            arrival_time = ""
+
+        time_text = messages.stop.bus_time_remaining.format(
+            minutes=bus.time,
+            arrival_time=arrival_time
+        ).strip()
+
+    return messages.stop.bus_line.format(
+        line=bus.line,
+        route=bus.route,
+        time=time_text
+    )