Merge pull request #57 from matburt/module_interface

Receptor Module Interface

Author: matburt

Pipfile

@@ -9,6 +9,8 @@ ipython = "*"
 pytest = "*"
 pytest-asyncio = "*"
 flake8 = "*"
+pyyaml = "*"
+wait-for = "*"
 
 [packages]
 python-dateutil = "*"

Pipfile.lock

@@ -0,0 +1,2 @@
+from .controller import Controller  # noqa
+from .config import ReceptorConfig  # noqa

receptor/__init__.py

@@ -8,7 +8,7 @@
 
 
 def main(args=None):
-    
+
     try:
         config = ReceptorConfig(args)
     except Exception as e:

receptor/__main__.py

@@ -4,8 +4,9 @@
 import logging
 import os
 import ssl
+import urllib.parse
 
-from .entrypoints import run_as_node, run_as_controller, run_as_ping, run_as_send
+from .entrypoints import run_as_node, run_as_ping, run_as_send, run_as_controller
 from .exceptions import ReceptorRuntimeError, ReceptorConfigError
 
 logger = logging.getLogger(__name__)
@@ -18,7 +19,7 @@
     },
     'controller': {
         'hint': 'Run a Receptor controller',
-        'entrypoint': run_as_controller,
+        'entrypoint': run_as_controller, # TODO: New entrypoint
     },
     'ping': {
         'hint': 'Tell the local controller to ping a node',
@@ -108,17 +109,18 @@ def __init__(self, args=None):
         # Receptor node options
         self.add_config_option(
             section='node',
-            key='listen_address',
-            default_value='0.0.0.0',
+            key='listen',
+            default_value='receptor://0.0.0.0:8888',
             value_type='str',
-            hint='Set/override IP address to listen on. If not set here or in a config file, the default is 0.0.0.0/0.',
+            hint='Set/override IP address and port to listen on. If not set here or in a config file, the default is receptor://0.0.0.0:8888.',
         )
         self.add_config_option(
             section='node',
-            key='listen_port',
-            default_value=8888,
-            value_type='int',
-            hint='Set/override TCP port to listen on. If not set here or in a config file, the default is 8888.',
+            key='websocket_listen',
+            default_value='',
+            value_type='str',
+            hint='Set IP address and port to listen on for websocket clients in the form ws[s]://addr:port. '
+                 'If not set here or in a config file then it is disabled',
         )
         self.add_config_option(
             section='node',
@@ -154,7 +156,7 @@ def __init__(self, args=None):
         )
         self.add_config_option(
             section='node',
-            key='ping_interval',
+            key='keepalive_interval',
             default_value=-1,
             value_type='int',
             hint='If specified, the node will ping all other known nodes in the mesh every N seconds. The default is -1, meaning no pings are sent.',
@@ -179,17 +181,18 @@ def __init__(self, args=None):
         )
         self.add_config_option(
             section='controller',
-            key='listen_address',
-            default_value='0.0.0.0',
+            key='listen',
+            default_value='receptor://0.0.0.0:8888',
             value_type='str',
-            hint='Set/override IP address to listen on. If not set here or in a config file, the default is 0.0.0.0/0.',
+            hint='Set IP address and port to listen on. If not set here or in a config file, the default is receptor://0.0.0.0/0:8888.',
         )
         self.add_config_option(
             section='controller',
-            key='listen_port',
-            default_value=8888,
-            value_type='int',
-            hint='Set/override TCP port to listen on. If not set here or in a config file, the default is 8888.',
+            key='websocket_listen',
+            default_value='',
+            value_type='str',
+            hint='Set IP address and port to listen on for websocket clients in the form ws://addr:port. '
+                 'If not set here or in a config file then it is disabled',
         )
         self.add_config_option(
             section='controller',
@@ -199,13 +202,12 @@ def __init__(self, args=None):
             value_type='str',
             hint='Set/override controller node identifier. If unspecified here or in a config file, one will be automatically generated.',
         )
-        # Ping options
         self.add_config_option(
             section='ping',
-            key='socket_path',
-            default_value='/var/run/receptor_controller.sock',
-            value_type='path',
-            hint='Path to control socket for controller commands.',
+            key='peer',
+            default_value='',
+            value_type='str',
+            hint='The peer to relay the ping directive through'
         )
         self.add_config_option(
             section='controller',
@@ -455,7 +457,6 @@ def go(self):
             raise ReceptorRuntimeError("you must specify a subcommand (%s)." % (", ".join(SUBCOMMAND_EXTRAS.keys()),))
         self._parsed_args.func(self)
 
-
     def get_client_ssl_context(self):
         if self.auth_ssl_cert:
             logger.debug("Loading SSL Client Context")