webex-bot 1.0.7__py2.py3-none-any.whl → 1.1.12__py2.py3-none-any.whl

webex_bot/__init__.py

@@ -1,4 +1,4 @@
 """Top-level package for Webex Bot."""
 
 __author__ = """Finbarr Brady"""
-__version__ = '1.0.7'
+__version__ = '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/webex_bot.py

@@ -102,7 +102,8 @@ class WebexBot(WebexWebsocketClient):
         """
         me = self.teams.people.me()
         self.bot_display_name = me.displayName
-        log.info(f"Running as {me.type} '{me.displayName}' with email {me.emails}")
+        self.bot_email = me.emails[0]
+        log.info(f"Running as {me.type} '{me.displayName}' with email {self.bot_email}")
         log.debug(f"Running as bot '{me}'")
         return me
 
@@ -173,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):
@@ -207,12 +208,15 @@ class WebexBot(WebexWebsocketClient):
         is_one_on_one_space = 'ONE_ON_ONE' in activity['target']['tags']
 
         if activity['actor']['type'] != 'PERSON':
+            if self.bot_email == user_email:
+                log.warning(f"Message is from myself ({self.bot_email}), ignoring.")
+                return
             if not self.allow_bot_to_bot:
-                log.warning(f"Message is from a bot ({user_email}), ignoring")
+                log.warning(f"Message is from a bot ({user_email}), ignoring.")
                 return
             else:
                 log.warning(
-                    f"Message is from a bot ({user_email}), and allow_bot_to_bot is {self.allow_bot_to_bot}. Be careful not to create a message loop!")
+                    f"Message is from another bot ({user_email}), and allow_bot_to_bot is {self.allow_bot_to_bot}. Be careful not to create a message loop!")
 
         # Log details on message
         log.info(f"Message from {user_email}: {teams_message}")
@@ -304,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."
@@ -316,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}'")
@@ -324,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:
@@ -352,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,
@@ -380,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):
         """
@@ -409,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):
@@ -419,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/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.7.dist-info → webex_bot-1.1.12.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.1
 Name: webex_bot
-Version: 1.0.7
+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)
 
@@ -460,10 +447,18 @@ bot = WebexBot(teams_bot_token=os.getenv("WEBEX_ACCESS_TOKEN")
 
 * Update UA
 
-### 1.0.7 (2025-Sept-17)
+### 1.0.8 (2025-Sept-18)
 
 * 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.1.12.dist-info/RECORD

@@ -0,0 +1,18 @@
+webex_bot/__init__.py,sha256=be-WC6WXfNEs7SDFXNjf9a9eBf9j3BJeRd6KAFiPOLI,96
+webex_bot/exceptions.py,sha256=qs9yVitfJtvxwBMC8uCvTDOxUQ_oZjWFf1dU8Oaue14,740
+webex_bot/formatting.py,sha256=jvPKym-z8CIJygpPVTVbt6vFXQo9_HQHpRDJB-nh-SI,382
+webex_bot/webex_bot.py,sha256=IDCxIbVWyZX0SkDIcvb_iquEcrElXvYQdElDunvxTmA,23350
+webex_bot/cards/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+webex_bot/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+webex_bot/commands/echo.py,sha256=DwKAFHVEP0LrSj0l35uDQQhoeh9w62wUvP5C-IankeM,3441
+webex_bot/commands/help.py,sha256=n7sbnJHepNSqUgZ0-8PW37kbGsaqvGIk2-jYy6I7ch4,3470
+webex_bot/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+webex_bot/models/command.py,sha256=MyThlDaEkGlj1fDE_i_wr79O3QboakimRme8yI744yo,5327
+webex_bot/models/response.py,sha256=d4k2ohR5SUVzvuQzcnm7jQQVTMB0gH9Kz9y09vkoAaU,2545
+webex_bot/websockets/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+webex_bot/websockets/webex_websocket_client.py,sha256=ZIK4GFF0i_EqdDbQj5Sdc6Q0u-nWVWjMbq4Ex4_wToM,14911
+webex_bot-1.1.12.dist-info/LICENSE,sha256=93eGb10xmgkBP2Fh_n0E9YDXe0c0oz-FsnAimXG0S4Y,1072
+webex_bot-1.1.12.dist-info/METADATA,sha256=D2tHNMEEQLaSnn7wzEo6lCFwxYZU2VaQ85WxpRl4TiY,15358
+webex_bot-1.1.12.dist-info/WHEEL,sha256=YqkG3aKUxtNWfdKBz3DzkIakbboD_OAzmgL1ryH-ru4,110
+webex_bot-1.1.12.dist-info/top_level.txt,sha256=q1Y0RtYYinR7oXSwL93cK59c2KN_CbMVca8MLWeF63M,10
+webex_bot-1.1.12.dist-info/RECORD,,

{webex_bot-1.0.7.dist-info → webex_bot-1.1.12.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.9.0)
+Generator: bdist_wheel (0.46.3)
 Root-Is-Purelib: true
 Tag: py2-none-any
 Tag: py3-none-any

webex_bot-1.0.7.dist-info/RECORD

@@ -1,18 +0,0 @@
-webex_bot/__init__.py,sha256=khfK-5S8GGJi-F6Y8AYhEOeZtF7W7B2IBROMjDG_t6U,95
-webex_bot/exceptions.py,sha256=qs9yVitfJtvxwBMC8uCvTDOxUQ_oZjWFf1dU8Oaue14,740
-webex_bot/formatting.py,sha256=jvPKym-z8CIJygpPVTVbt6vFXQo9_HQHpRDJB-nh-SI,382
-webex_bot/webex_bot.py,sha256=fuqucqKCZ-jFo4qW3XAYo7n5g_LB3GQnuAuQHEZRw_Y,21866
-webex_bot/cards/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-webex_bot/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-webex_bot/commands/echo.py,sha256=STY-MikBRjUteDK-g8G4GPB0V-Yi7siPN1DRMXrT-QU,3399
-webex_bot/commands/help.py,sha256=n7sbnJHepNSqUgZ0-8PW37kbGsaqvGIk2-jYy6I7ch4,3470
-webex_bot/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-webex_bot/models/command.py,sha256=MyThlDaEkGlj1fDE_i_wr79O3QboakimRme8yI744yo,5327
-webex_bot/models/response.py,sha256=d4k2ohR5SUVzvuQzcnm7jQQVTMB0gH9Kz9y09vkoAaU,2545
-webex_bot/websockets/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-webex_bot/websockets/webex_websocket_client.py,sha256=ZlyTyNZuWr7cbf0mHBPu7JB432gVwBKT2Gvq9K1Pv5k,13895
-webex_bot-1.0.7.dist-info/licenses/LICENSE,sha256=93eGb10xmgkBP2Fh_n0E9YDXe0c0oz-FsnAimXG0S4Y,1072
-webex_bot-1.0.7.dist-info/METADATA,sha256=ZtQy9gjLJT6gFgrXLk94wBqn9ZGXZViQ2ATs2VX28_I,14887
-webex_bot-1.0.7.dist-info/WHEEL,sha256=JNWh1Fm1UdwIQV075glCn4MVuCRs0sotJIq-J6rbxCU,109
-webex_bot-1.0.7.dist-info/top_level.txt,sha256=q1Y0RtYYinR7oXSwL93cK59c2KN_CbMVca8MLWeF63M,10
-webex_bot-1.0.7.dist-info/RECORD,,