Add message queueing capabilities to MessageSender

Fix a Sphinx warning message

README.md

@@ -80,6 +80,6 @@ The TFW message format:
 
 Most of the components you need have docstrings included (hang on tight, this is work in progress) – refer to them for usage info.
 
-In the `docs` folder you can find our Sphinx-based API documentation, which you can build using the included `Makefile` (you need to have Sphinx installed, please reach out to us if you have trouble building the docs).
+In the `docs` folder you can find our Sphinx-based API documentation, which you can build using the `hack/tfw.sh` script in the [test-tutorial-framework](https://github.com/avatao-content/test-tutorial-framework) repository.
 
-To get started you should take a look at the [test-tutorial-framework](https://github.com/avatao-content/test-tutorial-framework) repository, which serves as an example project as well.
+To get started you should take a look at [test-tutorial-framework](https://github.com/avatao-content/test-tutorial-framework), which serves as an example project as well.

lib/tfw/components/directory_monitor.py

@@ -15,8 +15,8 @@ LOG = logging.getLogger(__name__)
 
 
 class DirectoryMonitor(ObserverMixin):
-    def __init__(self, directories):
+    def __init__(self, ide_key, directories):
-        self.eventhandler = IdeReloadWatchdogEventHandler()
+        self.eventhandler = IdeReloadWatchdogEventHandler(ide_key)
         for directory in directories:
             self.observer.schedule(self.eventhandler, directory, recursive=True)
 
@@ -44,8 +44,9 @@ class DirectoryMonitor(ObserverMixin):
 
 
 class IdeReloadWatchdogEventHandler(FileSystemWatchdogEventHandler):
-    def __init__(self):
+    def __init__(self, ide_key):
         super().__init__()
+        self.ide_key = ide_key
         self.uplink = ServerUplinkConnector()
         self._paused = False
         self.ignore = 0
@@ -65,7 +66,7 @@ class IdeReloadWatchdogEventHandler(FileSystemWatchdogEventHandler):
             return
         LOG.debug(event)
         self.uplink.send({
-            'key': 'ide',
+            'key': self.ide_key,
             'data': {'command': 'reload'}
         })
 

lib/tfw/components/directory_monitoring_event_handler.py

@@ -15,7 +15,12 @@ class DirectoryMonitoringEventHandler(EventHandlerBase, MonitorManagerMixin):
     def __init__(self, key, directory):
         super().__init__(key)
         self._directory = directory
-        MonitorManagerMixin.__init__(self, DirectoryMonitor, self._directory)
+        MonitorManagerMixin.__init__(
+            self,
+            DirectoryMonitor,
+            key,
+            self._directory
+        )
 
         self.commands = {
             'pause':     self.pause,

lib/tfw/components/ide_event_handler.py

@@ -141,6 +141,7 @@ class IdeEventHandler(EventHandlerBase, MonitorManagerMixin):
         MonitorManagerMixin.__init__(
             self,
             DirectoryMonitor,
+            self.key,
             self.filemanager.allowed_directories
         )
 

lib/tfw/decorators/lazy_property.py

@@ -1,6 +1,8 @@
 # Copyright (C) 2018 Avatao.com Innovative Learning Kft.
 # All Rights Reserved. See LICENSE file for details.
 
+from functools import update_wrapper
+
 
 class lazy_property:
     """
@@ -9,7 +11,7 @@ class lazy_property:
     """
     def __init__(self, func):
         self.func = func
-        self.__doc__ = func.__doc__
+        update_wrapper(self, func)
 
     def __get__(self, instance, owner):
         if instance is None:

lib/tfw/networking/message_sender.py

@@ -1,32 +1,46 @@
 # Copyright (C) 2018 Avatao.com Innovative Learning Kft.
 # All Rights Reserved. See LICENSE file for details.
 
-from datetime import datetime
-
 from tfw.networking.event_handlers import ServerUplinkConnector
 
 
 class MessageSender:
     """
-    Provides a mechanism to send messages to our frontend messaging component which
+    Provides mechanisms to send messages to our frontend messaging component.
-    displays messages with the key "message".
     """
-    def __init__(self, custom_key: str = None):
+    def __init__(self):
         self.server_connector = ServerUplinkConnector()
-        self.key = custom_key or 'message'
+        self.key = 'message'
+        self.queue_key = 'queueMessages'
 
     def send(self, originator, message):
         """
-        Sends a message to the key specified in __init__.
+        Sends a message.
         :param originator: name of sender to be displayed on the frontend
         :param message: message to send
         """
         data = {
             'originator': originator,
-            'timestamp': datetime.now().isoformat(),
             'message': message
         }
         self.server_connector.send({
             'key': self.key,
             'data': data
         })
+
+    def queue_messages(self, originator, messages):
+        """
+        Queues a list of messages to be displayed in a chatbot-like manner.
+        :param originator: name of sender to be displayed on the frontend
+        :param messages: list of messages to queue
+        """
+        data = {
+            'messages': [
+                {'message': message, 'originator': originator}
+                for message in messages
+            ]
+        }
+        self.server_connector.send({
+            'key': self.queue_key,
+            'data': data
+        })

setup.py

@@ -2,7 +2,6 @@ from os.path import dirname, realpath, join
 
 from setuptools import setup, find_packages
 
-
 here = dirname(realpath(__file__))
 
 with open(join(here, 'VERSION'), 'r') as ifile:
@@ -10,7 +9,8 @@ with open(join(here, 'VERSION'), 'r') as ifile:
 with open(join(here, 'requirements.txt'), 'r') as ifile:
     requirements = ifile.read().splitlines()
 
-setup(name='tfw',
+setup(
+    name = 'tfw',
     version = version,
     description = 'Avatao tutorial-framework',
     url = 'https://github.com/avatao-content/baseimage-tutorial-framework',
@@ -20,4 +20,10 @@ setup(name='tfw',
     packages = find_packages('lib'),
     package_dir = {'': 'lib'},
     install_requires = requirements,
-      zip_safe=False)
+    extras_require = {
+        'docs': [
+            'sphinx >= 1.7.0',
+        ],
+    },
+    zip_safe = False,
+)

supervisor/supervisord.conf

@@ -4,6 +4,7 @@ logfile=/dev/null
 logfile_maxbytes=0
 loglevel = debug
 pidfile = /tmp/supervisord.pid
+strip_ansi=true
 
 [inet_http_server]
 port = 127.0.0.1:%(ENV_TFW_SUPERVISOR_HTTP_PORT)s