Merge pull request #70 from BottlecapDave/develop

New release

Author: BottlecapDave

custom_components/first_bus/api_client.py

@@ -13,7 +13,7 @@ async def async_get_bus_times(self, stop):
         # Disable content type check as sometimes it can report text/html
         data = await response.json(content_type=None)
 
-        if ("times" in data):
+        if ("times" in data and "atcocode" in data):
           return list(map(lambda time: {
             "due": time["Due"],
             "service_ref": time["ServiceRef"],
@@ -22,4 +22,4 @@ async def async_get_bus_times(self, stop):
             "is_live": True if time["IsLive"] == 'Y' or time["IsLive"] == 'y' else False
           }, data["times"]))
 
-        return []
+        return None

custom_components/first_bus/config/__init__.py

@@ -1,6 +1,8 @@
 import logging
 import re
-from ..const import CONFIG_BUSES, REGEX_BUSES
+
+from ..api_client import FirstBusApiClient
+from ..const import CONFIG_BUSES, CONFIG_STOP, REGEX_BUSES
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -19,9 +21,16 @@ def merge_config(data: dict, options: dict, updated_config: dict = None):
 
   return config
 
-def validate_config(config: dict):
+async def async_validate_main_config(config: dict):
   new_config = dict(config)
   errors = {}
+  client = FirstBusApiClient()
+
+  if CONFIG_STOP in new_config:
+    buses = await client.async_get_bus_times(new_config[CONFIG_STOP])
+    if buses is None:
+      errors[CONFIG_STOP] = "invalid_stop"
+
   if CONFIG_BUSES in new_config and new_config[CONFIG_BUSES] is not None and len(new_config[CONFIG_BUSES]) > 0:
     matches = re.search(REGEX_BUSES, new_config[CONFIG_BUSES])
     if (matches is None):

custom_components/first_bus/config_flow.py

@@ -13,7 +13,7 @@
   DATA_SCHEMA_STOP,
 )
 
-from .config import merge_config, validate_config
+from .config import merge_config, async_validate_main_config
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -27,7 +27,7 @@ async def async_step_user(self, user_input):
 
     errors = {}
     if user_input is not None:
-      (errors, config) = validate_config(user_input)
+      (errors, config) = await async_validate_main_config(user_input)
 
       # Setup our basic sensors
       if len(errors) < 1:
@@ -77,7 +77,7 @@ async def async_step_user(self, user_input):
 
     _LOGGER.debug(f"Update config {config}")
 
-    (errors, config) = validate_config(config)
+    (errors, config) = await async_validate_main_config(config)
 
     if len(errors) < 1:
       return self.async_create_entry(title="", data=config)

custom_components/first_bus/translations/en.json

@@ -17,7 +17,8 @@
       }
     },
     "error": {
-      "invalid_buses": "Buses must be alphanumeric and spaces separated by commas"
+      "invalid_buses": "Buses must be alphanumeric and spaces separated by commas",
+      "invalid_stop": "Bus stop is not recognised by First Bus. Please check and try again."
     },
     "abort": {
     }
@@ -36,7 +37,8 @@
       }
     },
     "error": {
-      "invalid_buses": "Buses must be alphanumeric and spaces separated by commas"
+      "invalid_buses": "Buses must be alphanumeric and spaces separated by commas",
+      "invalid_stop": "Bus stop is not recognised by First Bus. Please check and try again."
     },
     "abort": {
     }

package-lock.json

@@ -39,4 +39,13 @@ async def test_when_get_buses_is_called_then_next_bus_is_returned():
             # Ignore any thrown exceptions
             pass
 
-    assert passes > 0
+    assert passes > 0
+
+@pytest.mark.asyncio
+async def test_when_get_buses_is_called_with_invalid_stop_then_none_is_returned():
+    # Arrange
+    client = FirstBusApiClient()
+
+    # Act
+    buses = await client.async_get_bus_times("123")
+    assert buses is None

tests/integration/api_client/test_get_bus_times.py

@@ -0,0 +1,178 @@
+from unittest import mock
+import pytest
+from custom_components.first_bus.config import async_validate_main_config
+from custom_components.first_bus.const import CONFIG_NAME, CONFIG_STOP, CONFIG_BUSES
+from custom_components.first_bus.api_client import FirstBusApiClient
+
+@pytest.mark.asyncio
+async def test_when_data_valid_then_no_errors_returned():
+  # Arrange
+  original_config = {
+    CONFIG_NAME: "test",
+    CONFIG_STOP: "123",
+    CONFIG_BUSES: "12 A,12B,12"
+  }
+
+  async def async_mocked_get_bus_times(*args, **kwargs):
+    return []
+
+  # Act
+  with mock.patch.multiple(FirstBusApiClient, async_get_bus_times=async_mocked_get_bus_times):
+    (errors, config) = await async_validate_main_config(original_config)
+
+    # Assert
+    assert CONFIG_NAME not in errors
+    assert CONFIG_STOP not in errors
+    assert CONFIG_BUSES not in errors
+
+    assert CONFIG_NAME in config
+    assert config[CONFIG_NAME] == original_config[CONFIG_NAME]
+    assert CONFIG_STOP in config
+    assert config[CONFIG_STOP] == original_config[CONFIG_STOP]
+    assert CONFIG_BUSES in config
+    assert config[CONFIG_BUSES] == ["12 A", "12B", "12"]
+
+@pytest.mark.asyncio
+async def test_when_buses_not_present_then_buses_empty_array():
+  # Arrange
+  original_config = {
+    CONFIG_NAME: "test",
+    CONFIG_STOP: "123"
+  }
+
+  async def async_mocked_get_bus_times(*args, **kwargs):
+    return []
+
+  # Act
+  with mock.patch.multiple(FirstBusApiClient, async_get_bus_times=async_mocked_get_bus_times):
+    (errors, config) = await async_validate_main_config(original_config)
+
+    # Assert
+    assert CONFIG_NAME not in errors
+    assert CONFIG_STOP not in errors
+    assert CONFIG_BUSES not in errors
+
+    assert CONFIG_NAME in config
+    assert config[CONFIG_NAME] == original_config[CONFIG_NAME]
+    assert CONFIG_STOP in config
+    assert config[CONFIG_STOP] == original_config[CONFIG_STOP]
+    assert CONFIG_BUSES in config
+    assert config[CONFIG_BUSES] == []
+
+@pytest.mark.asyncio
+async def test_when_buses_none_then_buses_empty_array():
+  # Arrange
+  original_config = {
+    CONFIG_NAME: "test",
+    CONFIG_STOP: "123",
+    CONFIG_BUSES: None
+  }
+
+  async def async_mocked_get_bus_times(*args, **kwargs):
+    return []
+
+  # Act
+  with mock.patch.multiple(FirstBusApiClient, async_get_bus_times=async_mocked_get_bus_times):
+    (errors, config) = await async_validate_main_config(original_config)
+
+    # Assert
+    assert CONFIG_NAME not in errors
+    assert CONFIG_STOP not in errors
+    assert CONFIG_BUSES not in errors
+
+    assert CONFIG_NAME in config
+    assert config[CONFIG_NAME] == original_config[CONFIG_NAME]
+    assert CONFIG_STOP in config
+    assert config[CONFIG_STOP] == original_config[CONFIG_STOP]
+    assert CONFIG_BUSES in config
+    assert config[CONFIG_BUSES] == []
+
+@pytest.mark.asyncio
+async def test_when_buses_empty_then_buses_empty_array():
+  # Arrange
+  original_config = {
+    CONFIG_NAME: "test",
+    CONFIG_STOP: "123",
+    CONFIG_BUSES: ""
+  }
+
+  async def async_mocked_get_bus_times(*args, **kwargs):
+    return []
+
+  # Act
+  with mock.patch.multiple(FirstBusApiClient, async_get_bus_times=async_mocked_get_bus_times):
+    (errors, config) = await async_validate_main_config(original_config)
+
+    # Assert
+    assert CONFIG_NAME not in errors
+    assert CONFIG_STOP not in errors
+    assert CONFIG_BUSES not in errors
+
+    assert CONFIG_NAME in config
+    assert config[CONFIG_NAME] == original_config[CONFIG_NAME]
+    assert CONFIG_STOP in config
+    assert config[CONFIG_STOP] == original_config[CONFIG_STOP]
+    assert CONFIG_BUSES in config
+    assert config[CONFIG_BUSES] == []
+
+@pytest.mark.asyncio
+@pytest.mark.parametrize("bus_value",[
+  ("A-B"),
+  ("12,12B,"),
+])
+async def test_when_buses_not_valid_then_buses_empty_array(bus_value: str):
+  # Arrange
+  original_config = {
+    CONFIG_NAME: "test",
+    CONFIG_STOP: "123",
+    CONFIG_BUSES: bus_value
+  }
+
+  async def async_mocked_get_bus_times(*args, **kwargs):
+    return []
+
+  # Act
+  with mock.patch.multiple(FirstBusApiClient, async_get_bus_times=async_mocked_get_bus_times):
+    (errors, config) = await async_validate_main_config(original_config)
+
+    # Assert
+    assert CONFIG_NAME not in errors
+    assert CONFIG_STOP not in errors
+    assert CONFIG_BUSES in errors
+    assert errors[CONFIG_BUSES] == "invalid_buses"
+
+    assert CONFIG_NAME in config
+    assert config[CONFIG_NAME] == original_config[CONFIG_NAME]
+    assert CONFIG_STOP in config
+    assert config[CONFIG_STOP] == original_config[CONFIG_STOP]
+    assert CONFIG_BUSES in config
+    assert config[CONFIG_BUSES] == original_config[CONFIG_BUSES]
+
+@pytest.mark.asyncio
+async def test_when_bus_stop_is_invalid_then_no_errors_returned():
+  # Arrange
+  original_config = {
+    CONFIG_NAME: "test",
+    CONFIG_STOP: "123",
+    CONFIG_BUSES: ""
+  }
+
+  async def async_mocked_get_bus_times(*args, **kwargs):
+    return None
+
+  # Act
+  with mock.patch.multiple(FirstBusApiClient, async_get_bus_times=async_mocked_get_bus_times):
+    (errors, config) = await async_validate_main_config(original_config)
+
+    # Assert
+    assert CONFIG_NAME not in errors
+    assert CONFIG_BUSES not in errors
+    assert CONFIG_STOP in errors
+    assert errors[CONFIG_STOP] == "invalid_stop"
+
+    assert CONFIG_NAME in config
+    assert config[CONFIG_NAME] == original_config[CONFIG_NAME]
+    assert CONFIG_STOP in config
+    assert config[CONFIG_STOP] == original_config[CONFIG_STOP]
+    assert CONFIG_BUSES in config
+    assert config[CONFIG_BUSES] == []