refactor: rename display and simplify config

config.yml

@@ -1,12 +1,9 @@
-api:
+transilien:
   url: https://api.transilien.com/gare/00000000/depart/00000000
-  user: user
+  username: username
   password: password
 
-refresh_time:
-  default: 10
-  step: 10
-  max: 30
+refresh_time: 10
 
-device:
+display:
   type: console

rerwatcher/app.py

@@ -5,7 +5,7 @@
 
 from rerwatcher.transilien import Transilien
 from rerwatcher.daemon import Daemon
-from rerwatcher.display import DisplayDeviceFactory
+from rerwatcher.display import DisplayBuilder
 from rerwatcher.utils import overwrite_config_with_env
 
 
@@ -15,12 +15,12 @@ def __init__(self, *args, **kwargs):
         super().__init__(app_name=app_name, *args, **kwargs)
 
         config = RerWatcher.load_config()
-        matrix_display = DisplayDeviceFactory.build(config['device'])
-        transilien = Transilien(config['api'])
+        display = DisplayBuilder.build(config['display'])
+        transilien = Transilien(config['transilien'])
 
         self._app = _App(
             config=config,
-            display=matrix_display,
+            display=display,
             transilien=transilien,
         )
 
@@ -41,7 +41,7 @@ def __init__(self, config, display, transilien):
         self.is_running = False
         self.transilien = transilien
         self.display = display
-        self._refresh_time = config['refresh_time']['default']
+        self._refresh_time = config['refresh_time']
 
     def start(self):
         self.is_running = True

rerwatcher/display.py

@@ -3,23 +3,23 @@
 from RPLCD import CharLCD
 
 
-class DisplayTypeNotSupportedError(NotImplementedError):
+class UnknownDisplayTypeError(NotImplementedError):
     pass
 
 
-class DisplayDevice(ABC):
+class Display(ABC):
     @abstractmethod
     def print(self, messages):
         raise NotImplementedError
 
 
-class Console(DisplayDevice):
+class Console(Display):
     def print(self, messages):
         for message in messages:
             print(message)
 
 
-class LCD(DisplayDevice):
+class LCD(Display):
     def __init__(self):
         self._device = CharLCD('PCF8574', 0x27)
 
@@ -29,7 +29,7 @@ def print(self, messages):
             self._device.write_string(message)
 
 
-class DisplayDeviceFactory(ABC):
+class DisplayBuilder(ABC):
     @staticmethod
     def build(config: dict):
         display = {
@@ -38,6 +38,6 @@ def build(config: dict):
         }.get(config['type'])
 
         if not display:
-            raise DisplayTypeNotSupportedError
+            raise UnknownDisplayTypeError
 
         return display()

rerwatcher/transilien.py

@@ -10,11 +10,11 @@
 
 
 class Requester:
-    def __init__(self, config: dict):
-        self._url = config['url']
+    def __init__(self, url: str, username: str, password: str):
+        self._url = url
         self._auth = HTTPBasicAuth(
-            username=config['user'],
-            password=config['password']
+            username=username,
+            password=password
         )
 
     @request_error_handler
@@ -67,8 +67,8 @@ def _format_timedelta(time_delta: timedelta):
 
 
 class Transilien:
-    def __init__(self, config):
-        self.requester = Requester(config)
+    def __init__(self, config: dict):
+        self.requester = Requester(**config)
         self.formatter = Formatter()
 
     @fetch_data_error_handler

tests/conftest.py

@@ -7,17 +7,13 @@
 logger.disable('rerwatcher')
 
 CONFIG = {
-    'api': {
+    'transilien': {
         'url': 'https://test.url/00000000/d/00000000',
-        'user': 'user',
+        'username': 'username',
         'password': 'password',
     },
-    'refresh_time': {
-        'default': 10,
-        'step': 10,
-        'max': 30,
-    },
-    'device': {
+    'refresh_time': 10,
+    'display': {
         'type': 'console',
     },
 }

tests/test_app.py

@@ -9,12 +9,12 @@
 
 
 def test_rerwatcher_load_config(mocker):
-    mocker.patch.dict(os.environ, {'API__URL': 'http://test.url'})
+    mocker.patch.dict(os.environ, {'TRANSILIEN__URL': 'http://test.url'})
 
     config = RerWatcher.load_config()
 
-    assert config['api']['url'] == 'http://test.url'
-    assert config['device']['type'] == 'console'
+    assert config['transilien']['url'] == 'http://test.url'
+    assert config['display']['type'] == 'console'
 
 
 def test_rerwatcher_workflow(mocker, mock_config, capsys):

tests/test_display.py

@@ -1,7 +1,7 @@
 import pytest
 
-from rerwatcher.display import (LCD, Console, DisplayDeviceFactory,
-                                DisplayTypeNotSupportedError)
+from rerwatcher.display import (LCD, Console, DisplayBuilder,
+                                UnknownDisplayTypeError)
 
 
 class TestLCDDisplay:
@@ -27,22 +27,22 @@ def test_print_on_console(self, capsys):
         assert 'TEST: 12min\n' == captured.out
 
 
-class TestDisplayDeviceFactory:
-    def test_device_builder_console_display(self, config):
-        device = DisplayDeviceFactory.build(config['device'])
+class TestDisplayFactory:
+    def test_display_builder_console(self, config):
+        display = DisplayBuilder.build(config['display'])
 
-        assert isinstance(device, Console)
+        assert isinstance(display, Console)
 
-    def test_device_builder_matrix_display(self, mocker, config):
+    def test_display_builder_lcd(self, mocker, config):
         mocker.patch('rerwatcher.display.CharLCD')
-        config['device']['type'] = 'lcd'
+        config['display']['type'] = 'lcd'
 
-        device = DisplayDeviceFactory.build(config['device'])
+        display = DisplayBuilder.build(config['display'])
 
-        assert isinstance(device, LCD)
+        assert isinstance(display, LCD)
 
-    def test_device_builder_fail(self, config):
-        config['device']['type'] = 'foo'
+    def test_display_builder_fail(self, config):
+        config['display']['type'] = 'foo'
 
-        with pytest.raises(DisplayTypeNotSupportedError):
-            DisplayDeviceFactory.build(config['device'])
+        with pytest.raises(UnknownDisplayTypeError):
+            DisplayBuilder.build(config['display'])

tests/test_transilien.py

@@ -11,21 +11,22 @@
 
 class TestRequester:
     def test_request(self, mocker, config):
+        config = config['transilien']
         response = mocker.Mock()
         response.status_code = 200
         response.text = 'foo'
         requests = mocker.patch(
             'rerwatcher.transilien.requests.get',
             return_value=response
         )
-        requester = Requester(config['api'])
+        requester = Requester(**config)
 
         result = requester.request()
 
-        url = config['api']['url']
+        url = config['url']
         auth = HTTPBasicAuth(
-            username=config['api']['user'],
-            password=config['api']['password']
+            username=config['username'],
+            password=config['password']
         )
         requests.assert_called_once_with(url=url, auth=auth)
         assert 'foo' == result
@@ -37,7 +38,7 @@ def test_request_fails_if_response_is_not_200(self, mocker, config):
             'rerwatcher.transilien.requests.get',
             return_value=response
         )
-        requester = Requester(config['api'])
+        requester = Requester(**config['transilien'])
 
         with pytest.raises(RequestError):
             requester.request()
@@ -48,7 +49,7 @@ def test_request_fails(self, mocker, config, exception):
             'rerwatcher.transilien.requests.get',
             side_effect=exception
         )
-        requester = Requester(config['api'])
+        requester = Requester(**config['transilien'])
 
         with pytest.raises(RequestError):
             requester.request()
@@ -92,7 +93,7 @@ def test_fetch_data(self, mocker, config):
             'rerwatcher.transilien.Formatter.format',
             return_value=sentinel.data
         )
-        transilien = Transilien(config['api'])
+        transilien = Transilien(config['transilien'])
 
         result = transilien.fetch_data()
 
@@ -105,7 +106,7 @@ def test_fetch_data_fails_on_request(self, mocker, config):
             side_effect=RequestException
         )
         formatter = mocker.patch('rerwatcher.transilien.Formatter.format')
-        transilien = Transilien(config['api'])
+        transilien = Transilien(config['transilien'])
 
         result = transilien.fetch_data()
 
@@ -121,7 +122,7 @@ def test_fetch_data_fails_on_format(self, mocker, config):
             'rerwatcher.transilien.etree.fromstring',
             side_effect=Exception
         )
-        transilien = Transilien(config['api'])
+        transilien = Transilien(config['transilien'])
 
         result = transilien.fetch_data()
 
@@ -132,7 +133,7 @@ def test_fetch_data_failst(self, mocker, config):
             'rerwatcher.transilien.Requester.request',
             side_effect=Exception
         )
-        transilien = Transilien(config['api'])
+        transilien = Transilien(config['transilien'])
 
         with pytest.raises(Exception):
             transilien.fetch_data()