webex-bot 1.0.8__tar.gz → 1.1.12__tar.gz

{webex_bot-1.0.8 → webex_bot-1.1.12}/CONTRIBUTING.rst

@@ -80,10 +80,12 @@ Ready to contribute? Here's how to set up `webex_bot` for local development.
    tests, including testing other Python versions with tox::
 
     $ flake8 webex_bot tests
-    $ python setup.py test or pytest
+    $ pytest
     $ tox
 
-   To get flake8 and tox, just pip install them into your virtualenv.
+   To get the dev dependencies, install them into your virtualenv::
+
+    $ python -m pip install -r requirements_dev.txt
 
 6. Commit your changes and push your branch to GitHub::
 
@@ -102,9 +104,8 @@ Before you submit a pull request, check that it meets these guidelines:
 2. If the pull request adds functionality, the docs should be updated. Put
    your new functionality into a function with a docstring, and add the
    feature to the list in README.rst.
-3. The pull request should work for Python 3.10, 3.11, 3.12, and 3.13, and for PyPy. Check
-   https://travis-ci.com/fbradyirl/webex_bot/pull_requests
-   and make sure that the tests pass for all supported Python versions.
+3. The pull request should work for Python 3.10, 3.11, and 3.12. Check GitHub
+   Actions and make sure that the tests pass for all supported Python versions.
 
 Tips
 ----
@@ -121,8 +122,8 @@ A reminder for the maintainers on how to deploy.
 Make sure all your changes are committed
 Then run::
 
-$ bump2version patch # possible: major / minor / patch
+$ bump2version patch # possible: major / minor / patch (updates webex_bot/__init__.py)
 $ git push
 $ git push --tags
 
-Travis will then deploy to PyPI if tests pass.
+GitHub Actions will then deploy to PyPI if tests pass.

{webex_bot-1.0.8 → webex_bot-1.1.12}/MANIFEST.in

@@ -1,6 +1,8 @@
 include CONTRIBUTING.rst
 include LICENSE
 include README.md
+include pyproject.toml
+include setup.cfg
 
 recursive-include tests *
 recursive-exclude * __pycache__

{webex_bot-1.0.8/webex_bot.egg-info → webex_bot-1.1.12}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.1
 Name: webex_bot
-Version: 1.0.8
+Version: 1.1.12
 Summary: Python package for a Webex Bot based on websockets.
 Home-page: https://github.com/fbradyirl/webex_bot
 Author: Finbarr Brady
@@ -18,29 +18,16 @@ Classifier: Programming Language :: Python :: 3.13
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: webexpythonsdk==2.0.4
+Requires-Dist: webexpythonsdk==2.0.5
 Requires-Dist: coloredlogs
-Requires-Dist: websockets==11.0.3
+Requires-Dist: websockets==16
 Requires-Dist: backoff
 Provides-Extra: proxy
-Requires-Dist: websockets_proxy>=0.1.1; extra == "proxy"
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: keywords
-Dynamic: license
-Dynamic: license-file
-Dynamic: provides-extra
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
+Requires-Dist: websockets_proxy>=0.1.3; extra == "proxy"
 
 # Introduction
 
-[![Pypi](https://img.shields.io/pypi/v/webex_bot.svg)](https://pypi.python.org/pypi/webex_bot) [![Build Status](https://github.com/fbradyirl/webex_bot/workflows/Python%20package/badge.svg)](https://github.com/fbradyirl/webex_bot/actions)
+[![Pypi](https://img.shields.io/pypi/v/webex_bot.svg)](https://pypi.python.org/pypi/webex_bot) [![Build Status](https://github.com/fbradyirl/webex_bot/workflows/Python%20package/badge.svg)](https://github.com/fbradyirl/webex_bot/actions) [![CodeQL](https://github.com/fbradyirl/webex_bot/actions/workflows/codeql.yml/badge.svg)](https://github.com/fbradyirl/webex_bot/actions/workflows/codeql.yml) [![Coverage](https://codecov.io/gh/fbradyirl/webex_bot/branch/main/graph/badge.svg)](https://codecov.io/gh/fbradyirl/webex_bot) [![Release](https://img.shields.io/github/v/release/fbradyirl/webex_bot?sort=semver)](https://github.com/fbradyirl/webex_bot/releases) [![Downloads](https://img.shields.io/pypi/dm/webex_bot)](https://pypi.python.org/pypi/webex_bot)
 
 > [!IMPORTANT]
 > This repository is only sporadically maintained. Breaking API changes will be maintained on a best efforts basis.
@@ -50,7 +37,7 @@ Dynamic: summary
 > Bug reports unrelated to API changes may not get the attention you want.
 
 
-By using this module, you can create a [Webex Teams][5] messaging bot quickly in just a couple of lines of code.
+By using this module, you can create a [Webex][5] messaging bot quickly in just a couple of lines of code.
 
 This module does not require you to set up an ngrok tunnel to receive incoming messages when behind a firewall or
 inside a LAN. This package instead uses a websocket to receive messages from the Webex cloud.
@@ -75,7 +62,7 @@ You can find a sample project, using OpenAI/ChatGPT with this library here: http
 
 ----
 
-**Only Python 3.13 is tested at this time.**
+**Python 3.10, 3.11, and 3.12 are tested at this time.**
 
 1. Install this module from pypi:
 
@@ -113,7 +100,7 @@ proxies = {
 # Create a Bot Object
 bot = WebexBot(teams_bot_token=os.getenv("WEBEX_ACCESS_TOKEN"),
                approved_rooms=['06586d8d-6aad-4201-9a69-0bf9eeb5766e'],
-               bot_name="My Teams Ops Bot",
+               bot_name="My Webex Ops Bot",
                include_demo_commands=True,
                proxies=proxies)
 
@@ -464,6 +451,14 @@ bot = WebexBot(teams_bot_token=os.getenv("WEBEX_ACCESS_TOKEN")
 
 * Allow flag to disable bot to bot check
 
+### 1.1.6 (2026-Feb-02)
+
+* Update dependancies. 
+* Expand test coverage and add CI matrix for Python 3.10–3.12
+* Add coverage reporting and update contributor docs
+* Refresh websocket status handling to avoid deprecations
+
+
 [1]: https://github.com/aaugustin/websockets
 
 [2]: https://github.com/WebexCommunity/WebexPythonSDK

{webex_bot-1.0.8 → webex_bot-1.1.12}/README.md

@@ -1,6 +1,6 @@
 # Introduction
 
-[![Pypi](https://img.shields.io/pypi/v/webex_bot.svg)](https://pypi.python.org/pypi/webex_bot) [![Build Status](https://github.com/fbradyirl/webex_bot/workflows/Python%20package/badge.svg)](https://github.com/fbradyirl/webex_bot/actions)
+[![Pypi](https://img.shields.io/pypi/v/webex_bot.svg)](https://pypi.python.org/pypi/webex_bot) [![Build Status](https://github.com/fbradyirl/webex_bot/workflows/Python%20package/badge.svg)](https://github.com/fbradyirl/webex_bot/actions) [![CodeQL](https://github.com/fbradyirl/webex_bot/actions/workflows/codeql.yml/badge.svg)](https://github.com/fbradyirl/webex_bot/actions/workflows/codeql.yml) [![Coverage](https://codecov.io/gh/fbradyirl/webex_bot/branch/main/graph/badge.svg)](https://codecov.io/gh/fbradyirl/webex_bot) [![Release](https://img.shields.io/github/v/release/fbradyirl/webex_bot?sort=semver)](https://github.com/fbradyirl/webex_bot/releases) [![Downloads](https://img.shields.io/pypi/dm/webex_bot)](https://pypi.python.org/pypi/webex_bot)
 
 > [!IMPORTANT]
 > This repository is only sporadically maintained. Breaking API changes will be maintained on a best efforts basis.
@@ -10,7 +10,7 @@
 > Bug reports unrelated to API changes may not get the attention you want.
 
 
-By using this module, you can create a [Webex Teams][5] messaging bot quickly in just a couple of lines of code.
+By using this module, you can create a [Webex][5] messaging bot quickly in just a couple of lines of code.
 
 This module does not require you to set up an ngrok tunnel to receive incoming messages when behind a firewall or
 inside a LAN. This package instead uses a websocket to receive messages from the Webex cloud.
@@ -35,7 +35,7 @@ You can find a sample project, using OpenAI/ChatGPT with this library here: http
 
 ----
 
-**Only Python 3.13 is tested at this time.**
+**Python 3.10, 3.11, and 3.12 are tested at this time.**
 
 1. Install this module from pypi:
 
@@ -73,7 +73,7 @@ proxies = {
 # Create a Bot Object
 bot = WebexBot(teams_bot_token=os.getenv("WEBEX_ACCESS_TOKEN"),
                approved_rooms=['06586d8d-6aad-4201-9a69-0bf9eeb5766e'],
-               bot_name="My Teams Ops Bot",
+               bot_name="My Webex Ops Bot",
                include_demo_commands=True,
                proxies=proxies)
 
@@ -424,6 +424,14 @@ bot = WebexBot(teams_bot_token=os.getenv("WEBEX_ACCESS_TOKEN")
 
 * Allow flag to disable bot to bot check
 
+### 1.1.6 (2026-Feb-02)
+
+* Update dependancies. 
+* Expand test coverage and add CI matrix for Python 3.10–3.12
+* Add coverage reporting and update contributor docs
+* Refresh websocket status handling to avoid deprecations
+
+
 [1]: https://github.com/aaugustin/websockets
 
 [2]: https://github.com/WebexCommunity/WebexPythonSDK

{webex_bot-1.0.8 → webex_bot-1.1.12}/setup.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 1.0.8
+current_version = 1.1.12
 commit = True
 tag = True
 
@@ -22,6 +22,7 @@ test = pytest
 
 [tool:pytest]
 collect_ignore = ['setup.py']
+addopts = --cov=webex_bot --cov-report=term-missing --cov-report=xml --cov-report=html --cov-fail-under=80
 
 [egg_info]
 tag_build = 

{webex_bot-1.0.8 → webex_bot-1.1.12}/setup.py

@@ -7,14 +7,14 @@ from setuptools import setup, find_packages
 with open('README.md') as readme_file:
     readme = readme_file.read()
 
-requirements = ['webexpythonsdk==2.0.4', 'coloredlogs', 'websockets==11.0.3', 'backoff']
+requirements = ['webexpythonsdk==2.0.5', 'coloredlogs', 'websockets==16', 'backoff']
 
 setup_requirements = ['pytest-runner', ]
 
 test_requirements = ['pytest>=3', ]
 
 extras_requirements = {
-    "proxy": ["websockets_proxy>=0.1.1"]
+    "proxy": ["websockets_proxy>=0.1.3"]
 }
 
 setup(
@@ -45,6 +45,6 @@ setup(
     test_suite='tests',
     tests_require=test_requirements,
     url='https://github.com/fbradyirl/webex_bot',
-    version='1.0.8',
+    version='1.1.12',
     zip_safe=False,
 )

webex_bot-1.1.12/tests/conftest.py

@@ -0,0 +1,116 @@
+import types
+import warnings
+
+import pytest
+
+warnings.filterwarnings(
+    "ignore",
+    category=PendingDeprecationWarning,
+    module=r"webexpythonsdk\.environment",
+)
+warnings.filterwarnings(
+    "ignore",
+    category=DeprecationWarning,
+    module=r"websockets\..*",
+)
+
+from webex_bot.webex_bot import WebexBot
+from webex_bot.websockets.webex_websocket_client import WebexWebsocketClient
+
+
+class DummyPerson:
+    def __init__(self, display_name="Webex Bot", email="bot@example.com", avatar="https://example.com/avatar.png"):
+        self.displayName = display_name
+        self.emails = [email]
+        self.avatar = avatar
+        self.type = "bot"
+
+
+class DummyPeople:
+    def __init__(self, me_person):
+        self._me_person = me_person
+
+    def me(self):
+        return self._me_person
+
+
+class DummyMessages:
+    def __init__(self):
+        self.created = []
+        self.deleted = []
+
+    def create(self, **kwargs):
+        self.created.append(kwargs)
+        return types.SimpleNamespace(id="message-1")
+
+    def delete(self, message_id):
+        self.deleted.append(message_id)
+
+
+class DummyMemberships:
+    def __init__(self, member_emails=None):
+        self.member_emails = set(member_emails or [])
+
+    def list(self, roomId, personEmail):
+        if personEmail in self.member_emails:
+            return [types.SimpleNamespace(personEmail=personEmail)]
+        return []
+
+
+class DummyTeams:
+    def __init__(self, person_email="bot@example.com", member_emails=None):
+        self.people = DummyPeople(DummyPerson(email=person_email))
+        self.messages = DummyMessages()
+        self.memberships = DummyMemberships(member_emails=member_emails)
+
+
+@pytest.fixture
+def teams_api():
+    return DummyTeams(member_emails={"member@example.com"})
+
+
+@pytest.fixture
+def bot(monkeypatch, teams_api):
+    def fake_init(self, access_token, bot_name, on_message=None, on_card_action=None, proxies=None):
+        self.access_token = access_token
+        self.teams = teams_api
+        self.on_message = on_message
+        self.on_card_action = on_card_action
+        self.proxies = proxies
+        self.websocket = None
+
+    monkeypatch.setattr(WebexWebsocketClient, "__init__", fake_init)
+    return WebexBot(teams_bot_token="test-token", include_demo_commands=False)
+
+
+def make_activity(actor_type="PERSON", actor_email="user@example.com", tags=None, parent=None, activity_id="act-1"):
+    if tags is None:
+        tags = ["ONE_ON_ONE"]
+    activity = {
+        "id": activity_id,
+        "actor": {"type": actor_type, "emailAddress": actor_email},
+        "target": {"tags": tags},
+    }
+    if parent is not None:
+        activity["parent"] = parent
+    return activity
+
+
+@pytest.fixture
+def one_on_one_activity():
+    return make_activity()
+
+
+@pytest.fixture
+def group_activity():
+    return make_activity(tags=["GROUP"])
+
+
+@pytest.fixture
+def teams_message():
+    return types.SimpleNamespace(
+        roomId="room-1",
+        text="help",
+        personEmail="user@example.com",
+        messageId="msg-1",
+    )

webex_bot-1.1.12/tests/test_command_model.py

@@ -0,0 +1,49 @@
+from webex_bot.models.command import Command, CALLBACK_KEYWORD_KEY, COMMAND_KEYWORD_KEY
+
+
+class SimpleCommand(Command):
+    def __init__(self, command_keyword=None, card=None):
+        super().__init__(command_keyword=command_keyword, card=card)
+
+    def execute(self, message, attachment_actions, activity):
+        return "ok"
+
+
+def test_command_uses_callback_keyword_from_card():
+    card = {
+        "actions": [
+            {
+                "type": "Action.Submit",
+                "data": {CALLBACK_KEYWORD_KEY: "cb"},
+            }
+        ]
+    }
+    command = SimpleCommand(command_keyword="ping", card=card)
+    assert command.card_callback_keyword == "cb"
+
+
+def test_command_uses_command_keyword_from_card():
+    card = {
+        "actions": [
+            {
+                "type": "Action.Submit",
+                "data": {COMMAND_KEYWORD_KEY: "cmd"},
+            }
+        ]
+    }
+    command = SimpleCommand(command_keyword=None, card=card)
+    assert command.command_keyword == "cmd"
+
+
+def test_command_sets_default_callback_keyword_when_missing():
+    card = {
+        "actions": [
+            {
+                "type": "Action.Submit",
+                "data": {},
+            }
+        ]
+    }
+    command = SimpleCommand(command_keyword="ping", card=card)
+    assert command.card_callback_keyword == "callback___ping"
+    assert card["actions"][0]["data"][CALLBACK_KEYWORD_KEY] == "callback___ping"

webex_bot-1.1.12/tests/test_commands.py

@@ -0,0 +1,49 @@
+import types
+
+from webex_bot.commands.echo import EchoCommand, EchoCallback
+from webex_bot.commands.help import HelpCommand, HELP_COMMAND_KEYWORD
+from webex_bot.models.command import Command, COMMAND_KEYWORD_KEY
+from webex_bot.models.response import Response
+
+
+class SimpleCommand(Command):
+    def __init__(self, keyword, help_message="Help me"):
+        super().__init__(command_keyword=keyword, help_message=help_message)
+
+    def execute(self, message, attachment_actions, activity):
+        return "ok"
+
+
+def test_echo_command_returns_response():
+    command = EchoCommand()
+    response = command.execute("ignored", None, {})
+    assert isinstance(response, Response)
+    assert response.attachments[0]["contentType"] == "application/vnd.microsoft.card.adaptive"
+
+
+def test_echo_callback_uses_input_text():
+    command = EchoCallback()
+    attachment_actions = types.SimpleNamespace(inputs={"message_typed": "hello"})
+    result = command.execute("", attachment_actions, {})
+    assert "hello" in result
+
+
+def test_echo_command_pre_execute_returns_response():
+    command = EchoCommand()
+    response = command.pre_execute("", types.SimpleNamespace(inputs={}), {})
+    assert isinstance(response, Response)
+
+
+def test_help_command_builds_actions_excluding_help():
+    help_command = HelpCommand(bot_name="Bot", bot_help_subtitle="Help", bot_help_image="https://example.com/image.png")
+    other_command = SimpleCommand(keyword="ping", help_message="Ping")
+    help_command.commands = {help_command, other_command}
+    actions, hints = help_command.build_actions_and_hints(thread_parent_id="thread-1")
+    assert len(actions) == 1
+    assert actions[0].data[COMMAND_KEYWORD_KEY] == "ping"
+    assert actions[0].data["thread_parent_id"] == "thread-1"
+    assert len(hints) == 1
+
+
+def test_help_command_keyword_constant():
+    assert HELP_COMMAND_KEYWORD == "help"

webex_bot-1.1.12/tests/test_exceptions.py

@@ -0,0 +1,8 @@
+from webex_bot.exceptions import BotException
+
+
+def test_bot_exception_attributes():
+    exc = BotException("debug", "reply", reply_one_to_one=True)
+    assert exc.debug_message == "debug"
+    assert exc.reply_message == "reply"
+    assert exc.reply_one_to_one is True

webex_bot-1.1.12/tests/test_formatting.py

@@ -0,0 +1,12 @@
+from webex_bot.formatting import quote_info, quote_warning, quote_danger, code, html_link
+
+
+def test_quote_helpers():
+    assert quote_info("hi") == "<blockquote class=info>hi</blockquote>"
+    assert quote_warning("hi") == "<blockquote class=warning>hi</blockquote>"
+    assert quote_danger("hi") == "<blockquote class=danger>hi</blockquote>"
+
+
+def test_code_and_html_link():
+    assert code("x") == "<code>x</code>"
+    assert html_link("Label", "https://example.com") == "<a href='https://example.com'>Label</a>"

webex_bot-1.1.12/tests/test_response.py

@@ -0,0 +1,32 @@
+from webexpythonsdk.models.cards import AdaptiveCard
+
+from webex_bot.models.response import Response, response_from_adaptive_card
+
+
+def test_response_as_dict_filters_empty():
+    response = Response()
+    response.markdown = "hello"
+    response.files = "file-1"
+    response.attachments = {"contentType": "application/vnd.microsoft.card.adaptive", "content": {}}
+    result = response.as_dict()
+    assert result["markdown"] == "hello"
+    assert result["files"] == ["file-1"]
+    assert result["attachments"] == [
+        {"contentType": "application/vnd.microsoft.card.adaptive", "content": {}}
+    ]
+    assert "roomId" not in result
+
+
+def test_response_from_adaptive_card_populates_attachment():
+    card = AdaptiveCard(body=[], actions=[])
+    response = response_from_adaptive_card(card)
+    assert response.text == "This bot requires a client which can render cards."
+    assert response.markdown == "This bot requires a client which can render cards."
+    assert response.attachments[0]["contentType"] == "application/vnd.microsoft.card.adaptive"
+
+
+def test_response_json_and_html_property():
+    response = Response(attributes={"text": "hello"})
+    response.html = "<b>hi</b>"
+    assert response.html == "<b>hi</b>"
+    assert '"text": "hello"' in response.json()

webex_bot-1.1.12/tests/test_webex_bot.py

@@ -0,0 +1,149 @@
+import types
+
+import pytest
+
+from webex_bot.models.command import Command
+from webex_bot.models.response import Response
+from webex_bot.exceptions import BotException
+from webex_bot.webex_bot import WebexBot
+
+
+class DummyCommand(Command):
+    def __init__(self, command_keyword="ping", exact_match=False, card_callback_keyword=None):
+        super().__init__(
+            command_keyword=command_keyword,
+            exact_command_keyword_match=exact_match,
+            help_message="Ping command",
+            card_callback_keyword=card_callback_keyword,
+        )
+
+    def execute(self, message, attachment_actions, activity):
+        return "pong"
+
+
+class PreExecuteCommand(Command):
+    def __init__(self, command_keyword="work", delete_previous_message=False):
+        super().__init__(
+            command_keyword=command_keyword,
+            help_message="Pre execute",
+            delete_previous_message=delete_previous_message,
+        )
+
+    def pre_execute(self, message, attachment_actions, activity):
+        return "Working"
+
+    def execute(self, message, attachment_actions, activity):
+        return "Done"
+
+
+class ExceptionCommand(Command):
+    def __init__(self, command_keyword="fail"):
+        super().__init__(
+            command_keyword=command_keyword,
+            help_message="Failing command",
+        )
+
+    def pre_execute(self, message, attachment_actions, activity):
+        raise BotException("debug", "pre-reply", reply_one_to_one=True)
+
+    def execute(self, message, attachment_actions, activity):
+        raise BotException("debug", "reply", reply_one_to_one=False)
+
+
+def test_get_message_passed_to_command():
+    assert WebexBot.get_message_passed_to_command("help", "help me") == " me"
+    assert WebexBot.get_message_passed_to_command("help", "hello") == "hello"
+
+
+def test_check_user_approved_unrestricted(bot):
+    assert bot.check_user_approved("user@example.com", approved_rooms=[]) is True
+
+
+def test_check_user_approved_domain(bot):
+    bot.approved_domains = ["example.com"]
+    assert bot.check_user_approved("user@example.com", approved_rooms=[]) is True
+    assert bot.check_user_approved("user@other.com", approved_rooms=[]) is False
+
+
+def test_check_user_approved_room_membership(bot):
+    assert bot.check_user_approved("member@example.com", approved_rooms=["room-1"]) is True
+    assert bot.check_user_approved("outsider@example.com", approved_rooms=["room-1"]) is False
+
+
+def test_add_command_duplicate_callback_keyword_raises(bot):
+    first = DummyCommand(command_keyword="first", card_callback_keyword="dup")
+    second = DummyCommand(command_keyword="second", card_callback_keyword="dup")
+    bot.add_command(first)
+    with pytest.raises(Exception):
+        bot.add_command(second)
+
+
+def test_process_incoming_message_ignores_other_bot(bot, teams_message, one_on_one_activity):
+    bot.allow_bot_to_bot = False
+    teams_message.personEmail = "otherbot@example.com"
+    activity = dict(one_on_one_activity)
+    activity["actor"]["type"] = "BOT"
+    bot.process_incoming_message(teams_message, activity)
+    assert bot.teams.messages.created == []
+
+
+def test_process_incoming_message_runs_help(bot, teams_message, one_on_one_activity):
+    teams_message.text = "unknown"
+    bot.process_incoming_message(teams_message, one_on_one_activity)
+    assert len(bot.teams.messages.created) >= 1
+
+
+def test_do_reply_with_response_sets_room_id(bot):
+    response = Response()
+    response.markdown = "hi"
+    bot.do_reply(response, "room-1", "user@example.com", False, True, "thread-1")
+    assert bot.teams.messages.created[-1]["roomId"] == "room-1"
+
+
+def test_do_reply_with_response_list(bot):
+    response = Response()
+    response.markdown = "hello"
+    bot.do_reply([response], "room-1", "user@example.com", False, True, "thread-1")
+    assert bot.teams.messages.created[-1]["roomId"] == "room-1"
+
+
+def test_process_raw_command_exact_match(bot, teams_message, one_on_one_activity):
+    command = DummyCommand(command_keyword="ping", exact_match=True)
+    bot.add_command(command)
+    bot.process_raw_command("ping", teams_message, "user@example.com", one_on_one_activity)
+    assert bot.teams.messages.created[-1]["markdown"] == "pong"
+
+
+def test_process_raw_command_callback(bot, one_on_one_activity):
+    command = DummyCommand(command_keyword="ping", card_callback_keyword="ping_cb")
+    bot.add_command(command)
+    attachment_actions = types.SimpleNamespace(
+        inputs={"callback_keyword": "ping_cb"},
+        roomId="room-1",
+    )
+    activity = dict(one_on_one_activity)
+    activity["actor"]["emailAddress"] = "user@example.com"
+    bot.process_incoming_card_action(attachment_actions, activity)
+    assert bot.teams.messages.created[-1]["markdown"] == "pong"
+
+
+def test_process_raw_command_delete_previous_message(bot, teams_message, one_on_one_activity):
+    command = PreExecuteCommand(delete_previous_message=True)
+    bot.add_command(command)
+    bot.process_raw_command("work", teams_message, "user@example.com", one_on_one_activity)
+    assert teams_message.messageId in bot.teams.messages.deleted
+    assert "message-1" in bot.teams.messages.deleted
+
+
+def test_run_pre_execute_handles_bot_exception(bot, teams_message, one_on_one_activity):
+    command = ExceptionCommand()
+    reply, one_to_one = bot.run_pre_execute(command, "msg", teams_message, one_on_one_activity)
+    assert reply == "pre-reply"
+    assert one_to_one is True
+
+
+def test_run_command_and_handle_bot_exceptions(bot, teams_message, one_on_one_activity):
+    command = ExceptionCommand()
+    reply, one_to_one = bot.run_command_and_handle_bot_exceptions(command, "msg", teams_message, one_on_one_activity)
+    assert reply == "reply"
+    assert one_to_one is False

webex_bot-1.1.12/tests/test_webex_websocket_client.py

@@ -0,0 +1,37 @@
+from webex_bot.websockets.webex_websocket_client import WebexWebsocketClient
+
+
+def _make_client():
+    client = WebexWebsocketClient.__new__(WebexWebsocketClient)
+    client._get_headers = lambda: {"Authorization": "Bearer test"}
+    return client
+
+
+def test_get_websocket_connect_kwargs_prefers_extra_headers():
+    def connect(*, extra_headers=None):
+        return extra_headers
+
+    client = _make_client()
+    assert client._get_websocket_connect_kwargs(connect) == {
+        "extra_headers": {"Authorization": "Bearer test"}
+    }
+
+
+def test_get_websocket_connect_kwargs_uses_additional_headers():
+    def connect(*, additional_headers=None):
+        return additional_headers
+
+    client = _make_client()
+    assert client._get_websocket_connect_kwargs(connect) == {
+        "additional_headers": {"Authorization": "Bearer test"}
+    }
+
+
+def test_get_websocket_connect_kwargs_fallback_to_extra_headers():
+    def connect(*, headers=None):
+        return headers
+
+    client = _make_client()
+    assert client._get_websocket_connect_kwargs(connect) == {
+        "extra_headers": {"Authorization": "Bearer test"}
+    }

{webex_bot-1.0.8 → webex_bot-1.1.12}/webex_bot/__init__.py

@@ -1,4 +1,4 @@
 """Top-level package for Webex Bot."""
 
 __author__ = """Finbarr Brady"""
-__version__ = '1.0.8'
+__version__ = '1.1.12'

{webex_bot-1.0.8 → webex_bot-1.1.12}/webex_bot/commands/echo.py

@@ -17,6 +17,7 @@ class EchoCommand(Command):
         super().__init__(
             command_keyword="echo",
             help_message="Echo Words Back to You!",
+            delete_previous_message=True,
             chained_commands=[EchoCallback()])
 
     def pre_execute(self, message, attachment_actions, activity):

{webex_bot-1.0.8 → webex_bot-1.1.12}/webex_bot/webex_bot.py

@@ -174,7 +174,7 @@ class WebexBot(WebexWebsocketClient):
                     if member.personEmail == user_email:
                         is_user_member = True
             except webexpythonsdk.exceptions.ApiError as apie:
-                log.warn(f"API error: {apie}")
+                log.warning(f"API error: {apie}")
         return is_user_member
 
     def process_incoming_card_action(self, attachment_actions, activity):
@@ -308,6 +308,8 @@ class WebexBot(WebexWebsocketClient):
             log.info(f"delete_previous_message is True. Deleting message with ID: {previous_message_id}")
             self.teams.messages.delete(previous_message_id)
 
+        pre_reply_message_id = None
+
         if not is_card_callback_command and command.card is not None:
             response = Response()
             response.text = "This bot requires a client which can render cards."
@@ -320,7 +322,7 @@ class WebexBot(WebexWebsocketClient):
                                                                                                message=message_without_command,
                                                                                                teams_message=teams_message,
                                                                                                activity=activity)
-            self.do_reply(pre_card_load_reply, room_id, user_email, pre_card_load_reply_one_to_one, is_one_on_one_space, thread_parent_id)
+            pre_reply_message_id = self.do_reply(pre_card_load_reply, room_id, user_email, pre_card_load_reply_one_to_one, is_one_on_one_space, thread_parent_id)
             reply = response
         else:
             log.debug(f"Going to run command: '{command}' with input: '{message_without_command}'")
@@ -328,25 +330,36 @@ class WebexBot(WebexWebsocketClient):
                                                                                    message=message_without_command,
                                                                                    teams_message=teams_message,
                                                                                    activity=activity)
-            self.do_reply(pre_execute_reply, room_id, user_email, pre_execute_reply_one_to_one, is_one_on_one_space, thread_parent_id)
+            pre_reply_message_id = self.do_reply(pre_execute_reply, room_id, user_email, pre_execute_reply_one_to_one, is_one_on_one_space, thread_parent_id)
             reply, reply_one_to_one = self.run_command_and_handle_bot_exceptions(command=command,
                                                                                  message=message_without_command,
                                                                                  teams_message=teams_message,
                                                                                  activity=activity)
         log.info(f"Using thread id={thread_parent_id}")
-        return self.do_reply(reply, room_id, user_email, reply_one_to_one, is_one_on_one_space, thread_parent_id)
+        final_message_id = self.do_reply(reply, room_id, user_email, reply_one_to_one, is_one_on_one_space, thread_parent_id)
+
+        # If requested, delete the pre-execute (or pre-card-load) message once the final reply has been sent
+        if command.delete_previous_message and pre_reply_message_id:
+            try:
+                log.info(f"Deleting pre-execute message with ID: {pre_reply_message_id}")
+                self.teams.messages.delete(pre_reply_message_id)
+            except Exception as e:
+                log.warning(f"Failed to delete pre-execute message {pre_reply_message_id}: {e}")
+
+        return final_message_id
 
     def do_reply(self, reply, room_id, user_email, reply_one_to_one, is_one_on_one_space, conv_target_id):
         # allow command handlers to craft their own Teams message
+        created_message_id = None
         if reply and isinstance(reply, Response):
             # If the Response lacks a roomId, set it to the incoming room
             if not reply.roomId:
                 reply.roomId = room_id
             if not reply.parentId and conv_target_id and self.threads:
                 reply.parentId = conv_target_id
-            reply = reply.as_dict()
-            self.teams.messages.create(**reply)
-            reply = "ok"
+            reply_dict = reply.as_dict()
+            created = self.teams.messages.create(**reply_dict)
+            created_message_id = getattr(created, 'id', None)
         # Support returning a list of Responses
         elif reply and (isinstance(reply, list) or isinstance(reply, types.GeneratorType)):
             for response in reply:
@@ -356,24 +369,24 @@ class WebexBot(WebexWebsocketClient):
                         response.roomId = room_id
                     if not response.parentId and conv_target_id:
                         response.parentId = conv_target_id
-                    self.teams.messages.create(**response.as_dict())
+                    created = self.teams.messages.create(**response.as_dict())
+                    created_message_id = getattr(created, 'id', None)
                 else:
                     # Just a plain message
-                    self.send_message_to_room_or_person(user_email,
-                                                        room_id,
-                                                        reply_one_to_one,
-                                                        is_one_on_one_space,
-                                                        response,
-                                                        conv_target_id)
-            reply = "ok"
+                    created_message_id = self.send_message_to_room_or_person(user_email,
+                                                                            room_id,
+                                                                            reply_one_to_one,
+                                                                            is_one_on_one_space,
+                                                                            response,
+                                                                            conv_target_id)
         elif reply:
-            self.send_message_to_room_or_person(user_email,
-                                                room_id,
-                                                reply_one_to_one,
-                                                is_one_on_one_space,
-                                                reply,
-                                                conv_target_id)
-        return reply
+            created_message_id = self.send_message_to_room_or_person(user_email,
+                                                                    room_id,
+                                                                    reply_one_to_one,
+                                                                    is_one_on_one_space,
+                                                                    reply,
+                                                                    conv_target_id)
+        return created_message_id
 
     def send_message_to_room_or_person(self,
                                        user_email,
@@ -384,27 +397,29 @@ class WebexBot(WebexWebsocketClient):
                                        conv_target_id):
         default_move_to_one_to_one_heads_up = \
             quote_info(f"{user_email} I've messaged you 1-1. Please reply to me there.")
+        last_created = None
         if reply_one_to_one:
             if not is_one_on_one_space:
                 if self.threads:
-                    self.teams.messages.create(roomId=room_id,
-                                               markdown=default_move_to_one_to_one_heads_up,
-                                               parentId=conv_target_id)
+                    last_created = self.teams.messages.create(roomId=room_id,
+                                                              markdown=default_move_to_one_to_one_heads_up,
+                                                              parentId=conv_target_id)
                 else:
-                    self.teams.messages.create(roomId=room_id,
-                                               markdown=default_move_to_one_to_one_heads_up)
+                    last_created = self.teams.messages.create(roomId=room_id,
+                                                              markdown=default_move_to_one_to_one_heads_up)
             if self.threads:
-                self.teams.messages.create(toPersonEmail=user_email,
-                                           markdown=reply,
-                                           parentId=conv_target_id)
+                last_created = self.teams.messages.create(toPersonEmail=user_email,
+                                                          markdown=reply,
+                                                          parentId=conv_target_id)
             else:
-                self.teams.messages.create(toPersonEmail=user_email,
-                                           markdown=reply)
+                last_created = self.teams.messages.create(toPersonEmail=user_email,
+                                                          markdown=reply)
         else:
             if self.threads:
-                self.teams.messages.create(roomId=room_id, markdown=reply, parentId=conv_target_id)
+                last_created = self.teams.messages.create(roomId=room_id, markdown=reply, parentId=conv_target_id)
             else:
-                self.teams.messages.create(roomId=room_id, markdown=reply)
+                last_created = self.teams.messages.create(roomId=room_id, markdown=reply)
+        return getattr(last_created, 'id', None)
 
     def run_pre_card_load_reply(self, command, message, teams_message, activity):
         """
@@ -413,7 +428,7 @@ class WebexBot(WebexWebsocketClient):
         try:
             return command.pre_card_load_reply(message, teams_message, activity), False
         except BotException as e:
-            log.warn(f"BotException: {e.debug_message}")
+            log.warning(f"BotException: {e.debug_message}")
             return e.reply_message, e.reply_one_to_one
 
     def run_pre_execute(self, command, message, teams_message, activity):
@@ -423,14 +438,14 @@ class WebexBot(WebexWebsocketClient):
         try:
             return command.pre_execute(message, teams_message, activity), False
         except BotException as e:
-            log.warn(f"BotException: {e.debug_message}")
+            log.warning(f"BotException: {e.debug_message}")
             return e.reply_message, e.reply_one_to_one
 
     def run_command_and_handle_bot_exceptions(self, command, message, teams_message, activity):
         try:
             return command.card_callback(message, teams_message, activity), False
         except BotException as e:
-            log.warn(f"BotException: {e.debug_message}")
+            log.warning(f"BotException: {e.debug_message}")
             return e.reply_message, e.reply_one_to_one
 
     @staticmethod

{webex_bot-1.0.8 → webex_bot-1.1.12}/webex_bot/websockets/webex_websocket_client.py

@@ -1,5 +1,6 @@
 import asyncio
 import json
+import inspect
 import logging
 import socket
 import ssl
@@ -10,7 +11,10 @@ import certifi
 import requests
 import websockets
 from webexpythonsdk import WebexAPI
-from websockets.exceptions import InvalidStatusCode
+try:
+    from websockets import InvalidStatus
+except ImportError:  # pragma: no cover - fallback for older websockets versions
+    from websockets.exceptions import InvalidStatus
 
 from webex_bot import __version__
 
@@ -79,6 +83,20 @@ class WebexWebsocketClient(object):
             "trackingid": self.tracking_id
         }
 
+    def _get_websocket_connect_kwargs(self, connect_func):
+        headers = self._get_headers()
+        try:
+            params = inspect.signature(connect_func).parameters
+        except (TypeError, ValueError):
+            return {"extra_headers": headers}
+
+        if "extra_headers" in params:
+            return {"extra_headers": headers}
+        if "additional_headers" in params:
+            return {"additional_headers": headers}
+
+        return {"extra_headers": headers}
+
     def _process_incoming_websocket_message(self, msg):
         """
         Handle websocket data.
@@ -247,7 +265,7 @@ class WebexWebsocketClient(object):
                 websockets.ConnectionClosedOK,
                 websockets.ConnectionClosed,
                 socket.gaierror,
-                InvalidStatusCode,
+            InvalidStatus,
             ),
             max_time=MAX_BACKOFF_TIME
         )
@@ -258,14 +276,28 @@ class WebexWebsocketClient(object):
             if self.proxies and "wss" in self.proxies:
                 logger.info(f"Using proxy for websocket connection: {self.proxies['wss']}")
                 proxy = Proxy.from_url(self.proxies["wss"])
-                connect = proxy_connect(ws_url, ssl=ssl_context, proxy=proxy, extra_headers=self._get_headers())
+                connect = proxy_connect(
+                    ws_url,
+                    ssl=ssl_context,
+                    proxy=proxy,
+                    **self._get_websocket_connect_kwargs(proxy_connect),
+                )
             elif self.proxies and "https" in self.proxies:
                 logger.info(f"Using proxy for websocket connection: {self.proxies['https']}")
                 proxy = Proxy.from_url(self.proxies["https"])
-                connect = proxy_connect(ws_url, ssl=ssl_context, proxy=proxy, extra_headers=self._get_headers())
+                connect = proxy_connect(
+                    ws_url,
+                    ssl=ssl_context,
+                    proxy=proxy,
+                    **self._get_websocket_connect_kwargs(proxy_connect),
+                )
             else:
                 logger.debug(f"Not using proxy for websocket connection.")
-                connect = websockets.connect(ws_url, ssl=ssl_context, extra_headers=self._get_headers())
+                connect = websockets.connect(
+                    ws_url,
+                    ssl=ssl_context,
+                    **self._get_websocket_connect_kwargs(websockets.connect),
+                )
 
             async with connect as _websocket:
                 self.websocket = _websocket
@@ -287,10 +319,11 @@ class WebexWebsocketClient(object):
                 asyncio.get_event_loop().run_until_complete(_connect_and_listen())
                 # If we get here, the connection was successful, so break out of the loop
                 break
-            except InvalidStatusCode as e:
-                logger.error(f"WebSocket handshake to {ws_url} failed with status {e.status_code}")
+            except InvalidStatus as e:
+                status_code = getattr(e.response, "status_code", None)
+                logger.error(f"WebSocket handshake to {ws_url} failed with status {status_code}")
 
-                if e.status_code == 404:
+                if status_code == 404:
                     current_404_retries += 1
                     if current_404_retries >= max_404_retries:
                         logger.error(f"Reached maximum retries ({max_404_retries}) for 404 errors. Giving up.")

{webex_bot-1.0.8 → webex_bot-1.1.12/webex_bot.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.1
 Name: webex_bot
-Version: 1.0.8
+Version: 1.1.12
 Summary: Python package for a Webex Bot based on websockets.
 Home-page: https://github.com/fbradyirl/webex_bot
 Author: Finbarr Brady
@@ -18,29 +18,16 @@ Classifier: Programming Language :: Python :: 3.13
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: webexpythonsdk==2.0.4
+Requires-Dist: webexpythonsdk==2.0.5
 Requires-Dist: coloredlogs
-Requires-Dist: websockets==11.0.3
+Requires-Dist: websockets==16
 Requires-Dist: backoff
 Provides-Extra: proxy
-Requires-Dist: websockets_proxy>=0.1.1; extra == "proxy"
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: keywords
-Dynamic: license
-Dynamic: license-file
-Dynamic: provides-extra
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
+Requires-Dist: websockets_proxy>=0.1.3; extra == "proxy"
 
 # Introduction
 
-[![Pypi](https://img.shields.io/pypi/v/webex_bot.svg)](https://pypi.python.org/pypi/webex_bot) [![Build Status](https://github.com/fbradyirl/webex_bot/workflows/Python%20package/badge.svg)](https://github.com/fbradyirl/webex_bot/actions)
+[![Pypi](https://img.shields.io/pypi/v/webex_bot.svg)](https://pypi.python.org/pypi/webex_bot) [![Build Status](https://github.com/fbradyirl/webex_bot/workflows/Python%20package/badge.svg)](https://github.com/fbradyirl/webex_bot/actions) [![CodeQL](https://github.com/fbradyirl/webex_bot/actions/workflows/codeql.yml/badge.svg)](https://github.com/fbradyirl/webex_bot/actions/workflows/codeql.yml) [![Coverage](https://codecov.io/gh/fbradyirl/webex_bot/branch/main/graph/badge.svg)](https://codecov.io/gh/fbradyirl/webex_bot) [![Release](https://img.shields.io/github/v/release/fbradyirl/webex_bot?sort=semver)](https://github.com/fbradyirl/webex_bot/releases) [![Downloads](https://img.shields.io/pypi/dm/webex_bot)](https://pypi.python.org/pypi/webex_bot)
 
 > [!IMPORTANT]
 > This repository is only sporadically maintained. Breaking API changes will be maintained on a best efforts basis.
@@ -50,7 +37,7 @@ Dynamic: summary
 > Bug reports unrelated to API changes may not get the attention you want.
 
 
-By using this module, you can create a [Webex Teams][5] messaging bot quickly in just a couple of lines of code.
+By using this module, you can create a [Webex][5] messaging bot quickly in just a couple of lines of code.
 
 This module does not require you to set up an ngrok tunnel to receive incoming messages when behind a firewall or
 inside a LAN. This package instead uses a websocket to receive messages from the Webex cloud.
@@ -75,7 +62,7 @@ You can find a sample project, using OpenAI/ChatGPT with this library here: http
 
 ----
 
-**Only Python 3.13 is tested at this time.**
+**Python 3.10, 3.11, and 3.12 are tested at this time.**
 
 1. Install this module from pypi:
 
@@ -113,7 +100,7 @@ proxies = {
 # Create a Bot Object
 bot = WebexBot(teams_bot_token=os.getenv("WEBEX_ACCESS_TOKEN"),
                approved_rooms=['06586d8d-6aad-4201-9a69-0bf9eeb5766e'],
-               bot_name="My Teams Ops Bot",
+               bot_name="My Webex Ops Bot",
                include_demo_commands=True,
                proxies=proxies)
 
@@ -464,6 +451,14 @@ bot = WebexBot(teams_bot_token=os.getenv("WEBEX_ACCESS_TOKEN")
 
 * Allow flag to disable bot to bot check
 
+### 1.1.6 (2026-Feb-02)
+
+* Update dependancies. 
+* Expand test coverage and add CI matrix for Python 3.10–3.12
+* Add coverage reporting and update contributor docs
+* Refresh websocket status handling to avoid deprecations
+
+
 [1]: https://github.com/aaugustin/websockets
 
 [2]: https://github.com/WebexCommunity/WebexPythonSDK

{webex_bot-1.0.8 → webex_bot-1.1.12}/webex_bot.egg-info/SOURCES.txt

@@ -12,7 +12,14 @@ docs/installation.rst
 docs/make.bat
 docs/usage.rst
 tests/__init__.py
+tests/conftest.py
+tests/test_command_model.py
+tests/test_commands.py
+tests/test_exceptions.py
+tests/test_formatting.py
+tests/test_response.py
 tests/test_webex_bot.py
+tests/test_webex_websocket_client.py
 webex_bot/__init__.py
 webex_bot/exceptions.py
 webex_bot/formatting.py

webex_bot-1.1.12/webex_bot.egg-info/requires.txt

@@ -0,0 +1,7 @@
+webexpythonsdk==2.0.5
+coloredlogs
+websockets==16
+backoff
+
+[proxy]
+websockets_proxy>=0.1.3

webex_bot-1.0.8/tests/test_webex_bot.py

@@ -1,21 +0,0 @@
-#!/usr/bin/env python
-
-"""Tests for `webex_bot` package."""
-
-import pytest
-
-
-@pytest.fixture
-def response():
-    """Sample pytest fixture.
-
-    See more at: http://doc.pytest.org/en/latest/fixture.html
-    """
-    # import requests
-    # return requests.get('https://github.com/audreyr/cookiecutter-pypackage')
-
-
-def test_content(response):
-    """Sample pytest test function with the pytest fixture as an argument."""
-    # from bs4 import BeautifulSoup
-    # assert 'GitHub' in BeautifulSoup(response.content).title.string

webex_bot-1.0.8/webex_bot.egg-info/requires.txt

@@ -1,7 +0,0 @@
-webexpythonsdk==2.0.4
-coloredlogs
-websockets==11.0.3
-backoff
-
-[proxy]
-websockets_proxy>=0.1.1