move more code from core

Author: JarbasAl

ovos_bus_client/__init__.py

@@ -11,10 +11,11 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-from .client.client import MessageBusClient
-from .message import Message
-from .send_func import send
-from .conf import client_from_config
+from ovos_bus_client.client.client import MessageBusClient
+from ovos_bus_client.message import Message
+from ovos_bus_client.send_func import send
+from ovos_bus_client.session import Session, SessionManager, UtteranceState
+from ovos_bus_client.conf import client_from_config
 
 """
 Mycroft Messagebus Client.

ovos_bus_client/client/client.py

@@ -2,7 +2,7 @@
 from ovos_bus_client.util import create_echo_function
 from ovos_bus_client.client.collector import MessageCollector
 from ovos_bus_client.client.waiter import MessageWaiter
-
+from ovos_bus_client.conf import load_message_bus_config
 from mycroft_bus_client.client.client import MessageBusClient as _MycroftBusClient, MessageBusClientConf
 from ovos_bus_client.session import Session, SessionManager
 

ovos_bus_client/conf.py

@@ -1 +1,71 @@
-from mycroft_bus_client.conf import *
+"""Message bus configuration loader.
+
+The message bus event handler and client use basically the same configuration.
+This code is re-used in both to load config values.
+"""
+import json
+
+from mycroft.util.log import LOG
+from ovos_config.config import Configuration
+from mycroft_bus_client.client.client import MessageBusClientConf
+
+# mycroft-core had this duplicated with both names...
+MessageBusConfig = MessageBusClientConf
+
+
+def load_message_bus_config(**overrides):
+    """Load the bits of device configuration needed to run the message bus."""
+    LOG.info('Loading message bus configs')
+    config = Configuration()
+
+    try:
+        websocket_configs = config['websocket']
+    except KeyError as ke:
+        LOG.error('No websocket configs found ({})'.format(repr(ke)))
+        raise
+    else:
+        mb_config = MessageBusConfig(
+            host=overrides.get('host') or websocket_configs.get('host'),
+            port=overrides.get('port') or websocket_configs.get('port'),
+            route=overrides.get('route') or websocket_configs.get('route'),
+            ssl=overrides.get('ssl') or config.get('ssl')
+        )
+        if not all([mb_config.host, mb_config.port, mb_config.route]):
+            error_msg = 'Missing one or more websocket configs'
+            LOG.error(error_msg)
+            raise ValueError(error_msg)
+
+    return mb_config
+
+
+def client_from_config(subconf='core', file_path='/etc/mycroft/bus.conf'):
+    """Load messagebus configuration from file.
+
+    The config is a basic json file with a number of "sub configurations"
+
+    Ex:
+    {
+      "core": {
+        "route": "/core",
+        "port": "8181"
+      }
+      "gui": {
+        "route": "/gui",
+        "port": "8811"
+      }
+    }
+
+    Arguments:
+        subconf:    configuration to choose from the file, defaults to "core"
+                    if omitted.
+        file_path:  path to the config file, defaults to /etc/mycroft/bus.conf
+                    if omitted.
+    Returns:
+        MessageBusClient instance based on the selected config.
+    """
+    from ovos_bus_client.client import MessageBusClient
+
+    with open(file_path) as f:
+        conf = json.load(f)
+
+    return MessageBusClient(**conf[subconf])

ovos_bus_client/message.py

@@ -1 +1,35 @@
-from mycroft_bus_client.message import *
+import re
+from mycroft_bus_client.message import Message as _MycroftMessage,  dig_for_message, CollectionMessage
+from ovos_utils.log import LOG
+
+try:
+    from lingua_franca.parse import normalize
+except ImportError:
+    # optional LF import
+    def normalize(text, *args, **kwargs):
+        return text
+
+
+class Message(_MycroftMessage):
+    """Mycroft specific Message class."""
+
+    def utterance_remainder(self):
+        """
+        DEPRECATED - mycroft-core hack, used by some skills in the wild
+
+        For intents get the portion not consumed by Adapt.
+
+        For example: if they say 'Turn on the family room light' and there are
+        entity matches for "turn on" and "light", then it will leave behind
+        " the family room " which is then normalized to "family room".
+
+        Returns:
+            str: Leftover words or None if not an utterance.
+        """
+        LOG.warning("Message.utterance_remainder has been deprecated!")
+        utt = normalize(self.data.get("utterance", ""))
+        if utt and "__tags__" in self.data:
+            for token in self.data["__tags__"]:
+                # Substitute only whole words matching the token
+                utt = re.sub(r'\b' + token.get("key", "") + r"\b", "", utt)
+        return normalize(utt)

ovos_bus_client/send_func.py

@@ -1 +1,32 @@
-from mycroft_bus_client.send_func import *
+from websocket import create_connection
+
+from ovos_config.config import Configuration
+from ovos_bus_client.client import MessageBusClient
+from ovos_bus_client.message import Message
+
+
+def send(message_to_send, data_to_send=None):
+    """Send a single message over the websocket.
+
+    Args:
+        message_to_send (str): Message to send
+        data_to_send (dict): data structure to go along with the
+            message, defaults to empty dict.
+    """
+    data_to_send = data_to_send or {}
+
+    # Calculate the standard Mycroft messagebus websocket address
+    config = Configuration()
+    config = config.get("websocket")
+    url = MessageBusClient.build_url(
+        config.get("host"),
+        config.get("port"),
+        config.get("route"),
+        config.get("ssl")
+    )
+
+    # Send the provided message/data
+    ws = create_connection(url)
+    packet = Message(message_to_send, data_to_send).serialize()
+    ws.send(packet)
+    ws.close()

requirements.txt

@@ -1 +1,3 @@
-mycroft-messagebus-client
+mycroft-messagebus-client
+ovos-config
+ovos-utils

setup.py

@@ -16,7 +16,7 @@ def required(requirements_file):
 
 setup(
     name='ovos-bus-client',
-    version='0.0.1',
+    version='0.0.2',
     packages=['ovos_bus_client',
               'ovos_bus_client.client',
               'ovos_bus_client.util'],