HiveMind-HackChatBridge 0.1.0a2__tar.gz

hivemind_hackchatbridge-0.1.0a2/HiveMind_HackChatBridge.egg-info/PKG-INFO

@@ -0,0 +1,114 @@
+Metadata-Version: 2.4
+Name: HiveMind-HackChatBridge
+Version: 0.1.0a2
+Summary: Relay a hack.chat channel to a HiveMind hub — a HiveMind satellite whose input and output are a hack.chat channel
+Author-email: jarbasAI <jarbasai@mailfence.com>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/JarbasHiveMind/HiveMind-HackChatBridge
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: hivemind-bus-client<1.0.0,>=0.9.0
+Requires-Dist: ovos-utils
+Requires-Dist: ovos-bus-client
+Requires-Dist: websocket-client
+Requires-Dist: click
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Provides-Extra: e2e
+Requires-Dist: pytest; extra == "e2e"
+Requires-Dist: pytest-timeout; extra == "e2e"
+Requires-Dist: hivescope>=0.5.0a2; extra == "e2e"
+Requires-Dist: websockets>=11; extra == "e2e"
+Dynamic: license-file
+
+# HiveMind HackChat Bridge
+
+Relay a [hack.chat](https://hack.chat) channel to a [HiveMind](https://github.com/JarbasHiveMind/HiveMind-core) hub.
+
+[hack.chat](https://hack.chat) is a minimal, anonymous, channel-based websocket chat. This bridge is a HiveMind **satellite** whose input and output are a hack.chat channel instead of a microphone. Channel messages become utterances sent to the hub; the hub's spoken reply is posted back into the channel, addressed to the user. Any HiveMind hub (and the OVOS skills behind it) becomes a hack.chat bot.
+
+```
+hack.chat channel  ⇄  HiveMind-HackChatBridge  ⇄  HiveMind hub  ⇄  OVOS skills
+```
+
+![](./hackchat.png)
+![](./hackchat_bridge.png)
+
+## Prerequisites
+
+- A running **HiveMind hub** ([hivemind-core](https://github.com/JarbasHiveMind/HiveMind-core)) reachable over the network, and a **HiveMind access key** for this bridge (`hivemind-core add-client`).
+- A **hack.chat channel name** to join, and a **nickname** for the bot. hack.chat is anonymous — no account or token is required.
+
+## Install
+
+```bash
+pip install HiveMind-HackChatBridge
+```
+
+Or from a checkout:
+
+```bash
+git clone https://github.com/JarbasHiveMind/HiveMind-HackChatBridge
+cd HiveMind-HackChatBridge
+pip install .
+```
+
+Declared dependencies: `hivemind-bus-client`, `ovos-bus-client`, `ovos-utils`, `websocket-client`, `click`.
+
+## Quickstart
+
+**1. Register the bridge on the hub** (where `hivemind-core` is installed):
+
+```bash
+hivemind-core add-client --name hackchat-bridge \
+  --access-key "your-access-key" --password "your-password"
+```
+
+**2. Run the bridge.** Configuration is passed on the command line via the `hivemind-hackchat-bridge` console script (or `python -m hackchat_bridge`):
+
+```bash
+hivemind-hackchat-bridge \
+  --channel your_channel \
+  --username Jarbas_BOT \
+  --access-key "your-access-key" \
+  --password "your-password" \
+  --host ws://127.0.0.1 \
+  --port 5678
+```
+
+**4. Send a message.** Open the same channel at `https://hack.chat/?your_channel` and type:
+
+```
+what time is it?
+```
+
+The bridge forwards the message to the hub and posts the reply back as `@user , <answer>`.
+
+## Configuration
+
+`hivemind-hackchat-bridge` options:
+
+| Option | Description | Default |
+| --- | --- | --- |
+| `--channel` | hack.chat channel name to join | — (required) |
+| `--username` | Bot nickname shown in the channel | `Jarbas_BOT` |
+| `--host` | HiveMind hub host (`wss://` / `ws://`) | `ws://127.0.0.1` |
+| `--port` | HiveMind hub port | `5678` |
+| `--access-key` | HiveMind access key | `None` |
+| `--password` | HiveMind password | `None` |
+| `--self-signed` | Accept self-signed SSL certificates | off |
+| `--lang` | Language code for utterances | `en-us` |
+
+The bridge forwards every channel message except its own, stripping a leading `@username` mention of the bot before sending.
+
+## Troubleshooting
+
+- **Bot joins but never answers** — confirm the hub is reachable and the access key/password are registered (`hivemind-core list-clients`), and that the hub produces a `speak` for the answer.
+- **Wrong channel** — the bot and the user must be on the same hack.chat channel name; open `https://hack.chat/?<channel>`.
+
+## Documentation
+
+- **[Operator setup](docs/operator-setup.md)** — hack.chat is anonymous (no account/token); registering the bridge on a HiveMind hub, the run command, and the network-only live e2e.
+
+See also [`docs/`](docs/) for a full setup walkthrough, a configuration reference, and worked examples.

hivemind_hackchatbridge-0.1.0a2/HiveMind_HackChatBridge.egg-info/SOURCES.txt

@@ -0,0 +1,15 @@
+LICENSE
+pyproject.toml
+readme.md
+requirements.txt
+HiveMind_HackChatBridge.egg-info/PKG-INFO
+HiveMind_HackChatBridge.egg-info/SOURCES.txt
+HiveMind_HackChatBridge.egg-info/dependency_links.txt
+HiveMind_HackChatBridge.egg-info/entry_points.txt
+HiveMind_HackChatBridge.egg-info/requires.txt
+HiveMind_HackChatBridge.egg-info/top_level.txt
+hackchat_bridge/__init__.py
+hackchat_bridge/__main__.py
+hackchat_bridge/hackchat.py
+hackchat_bridge/version.py
+tests/test_smoke.py

hivemind_hackchatbridge-0.1.0a2/HiveMind_HackChatBridge.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

hivemind_hackchatbridge-0.1.0a2/HiveMind_HackChatBridge.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+hivemind-hackchat-bridge = hackchat_bridge.__main__:main

hivemind_hackchatbridge-0.1.0a2/HiveMind_HackChatBridge.egg-info/requires.txt

@@ -0,0 +1,14 @@
+hivemind-bus-client<1.0.0,>=0.9.0
+ovos-utils
+ovos-bus-client
+websocket-client
+click
+
+[e2e]
+pytest
+pytest-timeout
+hivescope>=0.5.0a2
+websockets>=11
+
+[test]
+pytest

hivemind_hackchatbridge-0.1.0a2/HiveMind_HackChatBridge.egg-info/top_level.txt

@@ -0,0 +1 @@
+hackchat_bridge

hivemind_hackchatbridge-0.1.0a2/LICENSE

@@ -0,0 +1,203 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   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.
+

hivemind_hackchatbridge-0.1.0a2/PKG-INFO

@@ -0,0 +1,114 @@
+Metadata-Version: 2.4
+Name: HiveMind-HackChatBridge
+Version: 0.1.0a2
+Summary: Relay a hack.chat channel to a HiveMind hub — a HiveMind satellite whose input and output are a hack.chat channel
+Author-email: jarbasAI <jarbasai@mailfence.com>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/JarbasHiveMind/HiveMind-HackChatBridge
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: hivemind-bus-client<1.0.0,>=0.9.0
+Requires-Dist: ovos-utils
+Requires-Dist: ovos-bus-client
+Requires-Dist: websocket-client
+Requires-Dist: click
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Provides-Extra: e2e
+Requires-Dist: pytest; extra == "e2e"
+Requires-Dist: pytest-timeout; extra == "e2e"
+Requires-Dist: hivescope>=0.5.0a2; extra == "e2e"
+Requires-Dist: websockets>=11; extra == "e2e"
+Dynamic: license-file
+
+# HiveMind HackChat Bridge
+
+Relay a [hack.chat](https://hack.chat) channel to a [HiveMind](https://github.com/JarbasHiveMind/HiveMind-core) hub.
+
+[hack.chat](https://hack.chat) is a minimal, anonymous, channel-based websocket chat. This bridge is a HiveMind **satellite** whose input and output are a hack.chat channel instead of a microphone. Channel messages become utterances sent to the hub; the hub's spoken reply is posted back into the channel, addressed to the user. Any HiveMind hub (and the OVOS skills behind it) becomes a hack.chat bot.
+
+```
+hack.chat channel  ⇄  HiveMind-HackChatBridge  ⇄  HiveMind hub  ⇄  OVOS skills
+```
+
+![](./hackchat.png)
+![](./hackchat_bridge.png)
+
+## Prerequisites
+
+- A running **HiveMind hub** ([hivemind-core](https://github.com/JarbasHiveMind/HiveMind-core)) reachable over the network, and a **HiveMind access key** for this bridge (`hivemind-core add-client`).
+- A **hack.chat channel name** to join, and a **nickname** for the bot. hack.chat is anonymous — no account or token is required.
+
+## Install
+
+```bash
+pip install HiveMind-HackChatBridge
+```
+
+Or from a checkout:
+
+```bash
+git clone https://github.com/JarbasHiveMind/HiveMind-HackChatBridge
+cd HiveMind-HackChatBridge
+pip install .
+```
+
+Declared dependencies: `hivemind-bus-client`, `ovos-bus-client`, `ovos-utils`, `websocket-client`, `click`.
+
+## Quickstart
+
+**1. Register the bridge on the hub** (where `hivemind-core` is installed):
+
+```bash
+hivemind-core add-client --name hackchat-bridge \
+  --access-key "your-access-key" --password "your-password"
+```
+
+**2. Run the bridge.** Configuration is passed on the command line via the `hivemind-hackchat-bridge` console script (or `python -m hackchat_bridge`):
+
+```bash
+hivemind-hackchat-bridge \
+  --channel your_channel \
+  --username Jarbas_BOT \
+  --access-key "your-access-key" \
+  --password "your-password" \
+  --host ws://127.0.0.1 \
+  --port 5678
+```
+
+**4. Send a message.** Open the same channel at `https://hack.chat/?your_channel` and type:
+
+```
+what time is it?
+```
+
+The bridge forwards the message to the hub and posts the reply back as `@user , <answer>`.
+
+## Configuration
+
+`hivemind-hackchat-bridge` options:
+
+| Option | Description | Default |
+| --- | --- | --- |
+| `--channel` | hack.chat channel name to join | — (required) |
+| `--username` | Bot nickname shown in the channel | `Jarbas_BOT` |
+| `--host` | HiveMind hub host (`wss://` / `ws://`) | `ws://127.0.0.1` |
+| `--port` | HiveMind hub port | `5678` |
+| `--access-key` | HiveMind access key | `None` |
+| `--password` | HiveMind password | `None` |
+| `--self-signed` | Accept self-signed SSL certificates | off |
+| `--lang` | Language code for utterances | `en-us` |
+
+The bridge forwards every channel message except its own, stripping a leading `@username` mention of the bot before sending.
+
+## Troubleshooting
+
+- **Bot joins but never answers** — confirm the hub is reachable and the access key/password are registered (`hivemind-core list-clients`), and that the hub produces a `speak` for the answer.
+- **Wrong channel** — the bot and the user must be on the same hack.chat channel name; open `https://hack.chat/?<channel>`.
+
+## Documentation
+
+- **[Operator setup](docs/operator-setup.md)** — hack.chat is anonymous (no account/token); registering the bridge on a HiveMind hub, the run command, and the network-only live e2e.
+
+See also [`docs/`](docs/) for a full setup walkthrough, a configuration reference, and worked examples.

hivemind_hackchatbridge-0.1.0a2/hackchat_bridge/__init__.py

@@ -0,0 +1,123 @@
+from ovos_utils import create_daemon
+from ovos_utils.log import LOG
+
+from hivemind_bus_client import HiveMessageBusClient
+from ovos_bus_client import Message
+
+from hackchat_bridge.hackchat import HackChat
+from hackchat_bridge.version import __version__
+
+platform = f"JarbasHackChatBridgeV{__version__}"
+
+
+class JarbasHackChatBridge:
+    """Relay a hack.chat channel to a HiveMind hub.
+
+    Channel messages become ``recognizer_loop:utterance`` messages on the
+    HiveMind bus; the hub's ``speak`` reply is posted back into the channel,
+    addressed to the originating user.
+    """
+
+    def __init__(self, username, channel,
+                 access_key=None,
+                 host="ws://127.0.0.1",
+                 port=5678,
+                 password=None,
+                 self_signed=False,
+                 lang="en-us",
+                 bus=None):
+        self.status = "disconnected"
+        self.username = username
+        self.channel = channel
+        self.lang = lang
+        self.hackchat = None
+
+        if bus:
+            # got a connection already
+            self.bus = bus
+        else:
+            # connect to hivemind
+            self.bus = HiveMessageBusClient(access_key,
+                                            host=host,
+                                            port=port,
+                                            password=password,
+                                            self_signed=self_signed)
+            self.bus.connect()
+
+        self.bus.on_mycroft("speak", self.handle_speak)
+        self.bus.on_mycroft("hive.complete_intent_failure",
+                            self.handle_intent_failure)
+
+    def connect_hackchat(self):
+        """Join the hack.chat channel and start relaying messages."""
+        self.hackchat = HackChat(self.username, self.channel)
+        self.hackchat.on_message += [self.on_hack_message]
+        self.hackchat.on_join += [self.on_hack_join]
+        self.hackchat.on_open += [self.on_hack_open]
+        self.hackchat.on_leave += [self.on_hack_leave]
+        self.status = "connected"
+        LOG.info("Channel: {0}".format(self.channel))
+        LOG.info("Username: {0}".format(self.username))
+        create_daemon(self.hackchat.run)
+
+    @property
+    def online_users(self):
+        if self.hackchat is None:
+            return []
+        return self.hackchat.online_users
+
+    # hack.chat callbacks
+    def on_hack_open(self, connector, users):
+        if len(users) == 1:
+            self.hackchat.send_message("This channel belongs to me")
+        else:
+            self.hackchat.send_message("I see {} online users"
+                                       .format(len(users) - 1))
+
+    def on_hack_join(self, connector, user):
+        self.hackchat.send_message("Hello @{}".format(user))
+
+    def on_hack_leave(self, connector, user):
+        self.hackchat.send_message("@{} vanished from cyberspace".format(user))
+
+    def on_hack_message(self, connector, message, user):
+        utterance = message.lower().strip()
+        if user != self.username:
+            utterance = utterance.replace("@" + self.username.lower(), "").strip()
+            self.send_to_hivemind(utterance, user)
+
+    # hivemind side
+    def send_to_hivemind(self, utterance, user):
+        """Forward a channel utterance to the HiveMind hub."""
+        msg = Message("recognizer_loop:utterance",
+                      {"utterances": [utterance], "lang": self.lang},
+                      {"destination": "hive_mind",
+                       "platform": platform,
+                       "user": {"hackchat_username": user}})
+        self.bus.emit(msg)
+
+    def speak(self, utterance, user_data):
+        user = user_data["hackchat_username"]
+        utterance = "@{} , ".format(user) + utterance
+        LOG.debug("Message: " + utterance)
+        if self.hackchat is not None:
+            self.hackchat.send_message(utterance)
+
+    def handle_speak(self, message):
+        assert isinstance(message, Message)
+        user_data = message.context.get("user")
+        if user_data:
+            utterance = message.data["utterance"]
+            self.speak(utterance, user_data)
+
+    def handle_intent_failure(self, message):
+        assert isinstance(message, Message)
+        user_data = message.context.get("user")
+        if user_data:
+            LOG.error("complete intent failure")
+            self.speak("I don't know how to answer that", user_data)
+
+    def run(self):
+        """Connect to hack.chat and block forever."""
+        self.connect_hackchat()
+        self.bus.run_forever()

hivemind_hackchatbridge-0.1.0a2/hackchat_bridge/__main__.py

@@ -0,0 +1,48 @@
+import click
+
+from hackchat_bridge import JarbasHackChatBridge
+
+
+def connect_hackchat_to_hivemind(channel,
+                                 username="Jarbas_BOT",
+                                 access_key=None,
+                                 host="ws://127.0.0.1",
+                                 port=5678,
+                                 password=None,
+                                 self_signed=False,
+                                 lang="en-us"):
+    """Connect a hack.chat channel to a HiveMind hub and block forever."""
+    bridge = JarbasHackChatBridge(username=username,
+                                  channel=channel,
+                                  access_key=access_key,
+                                  host=host,
+                                  port=port,
+                                  password=password,
+                                  self_signed=self_signed,
+                                  lang=lang)
+    bridge.run()
+
+
+@click.command()
+@click.option("--channel", required=True, help="hack.chat channel name to join")
+@click.option("--username", default="Jarbas_BOT", help="bot nickname shown in the channel")
+@click.option("--access-key", default=None, help="HiveMind access key")
+@click.option("--password", default=None, help="HiveMind password")
+@click.option("--host", default="ws://127.0.0.1", help="HiveMind hub host (ws:// or wss://)")
+@click.option("--port", default=5678, type=int, help="HiveMind hub port (default 5678)")
+@click.option("--self-signed", is_flag=True, help="accept self signed ssl certificates")
+@click.option("--lang", default="en-us", help="language code for utterances")
+def main(channel, username, access_key, password, host, port, self_signed, lang):
+    """Relay a hack.chat channel to a HiveMind hub."""
+    connect_hackchat_to_hivemind(channel=channel,
+                                 username=username,
+                                 access_key=access_key,
+                                 host=host,
+                                 port=port,
+                                 password=password,
+                                 self_signed=self_signed,
+                                 lang=lang)
+
+
+if __name__ == '__main__':
+    main()

hivemind_hackchatbridge-0.1.0a2/hackchat_bridge/hackchat.py

@@ -0,0 +1,75 @@
+from threading import Thread
+import json
+import websocket
+from time import sleep
+from ovos_utils.log import LOG
+
+
+class HackChat:
+    """A library to connect to https://hack.chat.
+    <on_message> is <list> of callback functions to receive data from
+    https://hack.chat. Add your callback functions to this attribute.
+    e.g., on_message += [my_callback]
+    The callback function should have 3 parameters, the first for the
+    <HackChat> object, the second for the message someone sent and the
+    third for the nickname of the sender of the message.
+
+    https://github.com/gkbrk/hackchat
+    """
+
+    def __init__(self, nick, channel="programming", debug=True):
+        """Connects to a channel on https://hack.chat.
+        Keyword arguments:
+        nick -- <str>; the nickname to use upon joining the channel
+        channel -- <str>; the channel to connect to on https://hack.chat
+        """
+        self.debug = debug
+        self.nick = nick
+        self.channel = channel
+        self.online_users = []
+        self.on_message = []
+        self.on_join = []
+        self.on_open = []
+        self.on_leave = []
+        self.ws = websocket.create_connection("wss://hack.chat/chat-ws")
+        self._send_packet({"cmd": "join", "channel": channel, "nick": nick})
+        Thread(target=self._ping_thread).start()
+
+    def send_message(self, msg):
+        """Sends a message on the channel."""
+        self._send_packet({"cmd": "chat", "text": msg})
+
+    def _send_packet(self, packet):
+        """Sends <packet> (<dict>) to https://hack.chat."""
+        encoded = json.dumps(packet)
+        self.ws.send(encoded)
+
+    def run(self):
+        """Sends data to the callback functions."""
+        while True:
+            result = json.loads(self.ws.recv())
+            if self.debug:
+                LOG.debug("[Raw Hackchat] " + str(result))
+
+            if result["cmd"] == "chat" and not result["nick"] == self.nick:
+                for handler in list(self.on_message):
+                    handler(self, result["text"], result["nick"])
+            elif result["cmd"] == "onlineAdd":
+                self.online_users.append(result["nick"])
+                for handler in list(self.on_join):
+                    handler(self, result["nick"])
+            elif result["cmd"] == "onlineRemove":
+                self.online_users.remove(result["nick"])
+                for handler in list(self.on_leave):
+                    handler(self, result["nick"])
+            elif result["cmd"] == "onlineSet":
+                for nick in result["nicks"]:
+                    self.online_users.append(nick)
+                for handler in list(self.on_open):
+                    handler(self, result["nicks"])
+
+    def _ping_thread(self):
+        """Retains the websocket connection."""
+        while self.ws.connected:
+            self._send_packet({"cmd": "ping"})
+            sleep(60)

hivemind_hackchatbridge-0.1.0a2/hackchat_bridge/version.py

@@ -0,0 +1,13 @@
+# The following lines are replaced during the release process.
+# START_VERSION_BLOCK
+VERSION_MAJOR = 0
+VERSION_MINOR = 1
+VERSION_BUILD = 0
+VERSION_ALPHA = 2
+# END_VERSION_BLOCK
+
+
+__version__ = (
+    f"{VERSION_MAJOR}.{VERSION_MINOR}.{VERSION_BUILD}"
+    + (f"a{VERSION_ALPHA}" if VERSION_ALPHA else "")
+)

hivemind_hackchatbridge-0.1.0a2/pyproject.toml

@@ -0,0 +1,41 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "HiveMind-HackChatBridge"
+description = "Relay a hack.chat channel to a HiveMind hub — a HiveMind satellite whose input and output are a hack.chat channel"
+readme = "readme.md"
+authors = [{ name = "jarbasAI", email = "jarbasai@mailfence.com" }]
+license = { text = "Apache-2.0" }
+requires-python = ">=3.10"
+dynamic = ["version", "dependencies"]
+
+[project.optional-dependencies]
+test = ["pytest"]
+# Real end-to-end suite (tests/e2e/). Boots a hivemind-core hub via hivescope
+# and drives the bridge's production HiveMessageBusClient path over a real
+# loopback WebSocket. hivescope must currently come from the
+# fix/loopback-whitelist-only-connection branch (the published build lacks the
+# loopback whitelist-only + get_client_by_id fixes); CI injects that via
+# pre_install_pip, so the constraint here is only a lower bound for local runs.
+e2e = [
+    "pytest",
+    "pytest-timeout",
+    "hivescope>=0.5.0a2",
+    "websockets>=11",
+]
+
+[project.urls]
+Homepage = "https://github.com/JarbasHiveMind/HiveMind-HackChatBridge"
+
+[project.scripts]
+hivemind-hackchat-bridge = "hackchat_bridge.__main__:main"
+
+[tool.setuptools]
+packages = ["hackchat_bridge"]
+include-package-data = true
+
+[tool.setuptools.dynamic]
+version = { attr = "hackchat_bridge.version.__version__" }
+dependencies = { file = ["requirements.txt"] }

hivemind_hackchatbridge-0.1.0a2/readme.md

@@ -0,0 +1,90 @@
+# HiveMind HackChat Bridge
+
+Relay a [hack.chat](https://hack.chat) channel to a [HiveMind](https://github.com/JarbasHiveMind/HiveMind-core) hub.
+
+[hack.chat](https://hack.chat) is a minimal, anonymous, channel-based websocket chat. This bridge is a HiveMind **satellite** whose input and output are a hack.chat channel instead of a microphone. Channel messages become utterances sent to the hub; the hub's spoken reply is posted back into the channel, addressed to the user. Any HiveMind hub (and the OVOS skills behind it) becomes a hack.chat bot.
+
+```
+hack.chat channel  ⇄  HiveMind-HackChatBridge  ⇄  HiveMind hub  ⇄  OVOS skills
+```
+
+![](./hackchat.png)
+![](./hackchat_bridge.png)
+
+## Prerequisites
+
+- A running **HiveMind hub** ([hivemind-core](https://github.com/JarbasHiveMind/HiveMind-core)) reachable over the network, and a **HiveMind access key** for this bridge (`hivemind-core add-client`).
+- A **hack.chat channel name** to join, and a **nickname** for the bot. hack.chat is anonymous — no account or token is required.
+
+## Install
+
+```bash
+pip install HiveMind-HackChatBridge
+```
+
+Or from a checkout:
+
+```bash
+git clone https://github.com/JarbasHiveMind/HiveMind-HackChatBridge
+cd HiveMind-HackChatBridge
+pip install .
+```
+
+Declared dependencies: `hivemind-bus-client`, `ovos-bus-client`, `ovos-utils`, `websocket-client`, `click`.
+
+## Quickstart
+
+**1. Register the bridge on the hub** (where `hivemind-core` is installed):
+
+```bash
+hivemind-core add-client --name hackchat-bridge \
+  --access-key "your-access-key" --password "your-password"
+```
+
+**2. Run the bridge.** Configuration is passed on the command line via the `hivemind-hackchat-bridge` console script (or `python -m hackchat_bridge`):
+
+```bash
+hivemind-hackchat-bridge \
+  --channel your_channel \
+  --username Jarbas_BOT \
+  --access-key "your-access-key" \
+  --password "your-password" \
+  --host ws://127.0.0.1 \
+  --port 5678
+```
+
+**4. Send a message.** Open the same channel at `https://hack.chat/?your_channel` and type:
+
+```
+what time is it?
+```
+
+The bridge forwards the message to the hub and posts the reply back as `@user , <answer>`.
+
+## Configuration
+
+`hivemind-hackchat-bridge` options:
+
+| Option | Description | Default |
+| --- | --- | --- |
+| `--channel` | hack.chat channel name to join | — (required) |
+| `--username` | Bot nickname shown in the channel | `Jarbas_BOT` |
+| `--host` | HiveMind hub host (`wss://` / `ws://`) | `ws://127.0.0.1` |
+| `--port` | HiveMind hub port | `5678` |
+| `--access-key` | HiveMind access key | `None` |
+| `--password` | HiveMind password | `None` |
+| `--self-signed` | Accept self-signed SSL certificates | off |
+| `--lang` | Language code for utterances | `en-us` |
+
+The bridge forwards every channel message except its own, stripping a leading `@username` mention of the bot before sending.
+
+## Troubleshooting
+
+- **Bot joins but never answers** — confirm the hub is reachable and the access key/password are registered (`hivemind-core list-clients`), and that the hub produces a `speak` for the answer.
+- **Wrong channel** — the bot and the user must be on the same hack.chat channel name; open `https://hack.chat/?<channel>`.
+
+## Documentation
+
+- **[Operator setup](docs/operator-setup.md)** — hack.chat is anonymous (no account/token); registering the bridge on a HiveMind hub, the run command, and the network-only live e2e.
+
+See also [`docs/`](docs/) for a full setup walkthrough, a configuration reference, and worked examples.

hivemind_hackchatbridge-0.1.0a2/requirements.txt

@@ -0,0 +1,5 @@
+hivemind-bus-client>=0.9.0,<1.0.0
+ovos-utils
+ovos-bus-client
+websocket-client
+click

hivemind_hackchatbridge-0.1.0a2/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

hivemind_hackchatbridge-0.1.0a2/tests/test_smoke.py

@@ -0,0 +1,88 @@
+"""Smoke tests: import the package and construct the bridge without networking.
+
+These tests must not touch the live hack.chat service or a HiveMind hub. The
+HiveMessageBusClient is replaced by a fake bus, and ``HackChat`` (which opens a
+websocket in its constructor) is only exercised lazily via ``connect_hackchat``,
+which we do not call here.
+"""
+import hackchat_bridge
+from hackchat_bridge import JarbasHackChatBridge, platform
+from hackchat_bridge.version import __version__
+
+
+class FakeBus:
+    """Minimal stand-in for HiveMessageBusClient — records emits/handlers."""
+
+    def __init__(self):
+        self.emitted = []
+        self.mycroft_handlers = {}
+
+    def on_mycroft(self, msg_type, func):
+        self.mycroft_handlers[msg_type] = func
+
+    def emit(self, message):
+        self.emitted.append(message)
+
+    def run_forever(self):  # pragma: no cover - never called in tests
+        pass
+
+
+def test_version():
+    assert isinstance(__version__, str)
+    assert __version__
+    assert platform.startswith("JarbasHackChatBridge")
+    assert __version__ in platform
+
+
+def test_package_exports():
+    assert hasattr(hackchat_bridge, "JarbasHackChatBridge")
+    assert hasattr(hackchat_bridge, "HackChat")
+
+
+def test_bridge_constructs_with_injected_bus():
+    bus = FakeBus()
+    bridge = JarbasHackChatBridge(username="Jarbas_BOT",
+                                  channel="test_channel",
+                                  bus=bus)
+    assert bridge.status == "disconnected"
+    assert bridge.hackchat is None
+    assert bridge.online_users == []
+    # speak/intent-failure handlers were registered on the bus
+    assert "speak" in bus.mycroft_handlers
+    assert "hive.complete_intent_failure" in bus.mycroft_handlers
+
+
+def test_send_to_hivemind_emits_utterance():
+    from ovos_bus_client import Message
+
+    bus = FakeBus()
+    bridge = JarbasHackChatBridge(username="Jarbas_BOT",
+                                  channel="test_channel",
+                                  bus=bus)
+    bridge.send_to_hivemind("what time is it", "alice")
+    assert len(bus.emitted) == 1
+    msg = bus.emitted[0]
+    assert isinstance(msg, Message)
+    assert msg.msg_type == "recognizer_loop:utterance"
+    assert msg.data["utterances"] == ["what time is it"]
+    assert msg.context["user"]["hackchat_username"] == "alice"
+
+
+def test_handle_speak_routes_back_to_user(monkeypatch):
+    from ovos_bus_client import Message
+
+    bus = FakeBus()
+    bridge = JarbasHackChatBridge(username="Jarbas_BOT",
+                                  channel="test_channel",
+                                  bus=bus)
+    sent = []
+
+    class FakeHackChat:
+        def send_message(self, msg):
+            sent.append(msg)
+
+    bridge.hackchat = FakeHackChat()
+    msg = Message("speak", {"utterance": "it is noon"},
+                  {"user": {"hackchat_username": "alice"}})
+    bus.mycroft_handlers["speak"](msg)
+    assert sent == ["@alice , it is noon"]