webex-bot 0.5.0__tar.gz → 0.5.2__tar.gz

{webex_bot-0.5.0 → webex_bot-0.5.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: webex_bot
-Version: 0.5.0
+Version: 0.5.2
 Summary: Python package for a Webex Bot based on websockets.
 Home-page: https://github.com/fbradyirl/webex_bot
 Author: Finbarr Brady
@@ -16,12 +16,21 @@ Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
+Provides-Extra: proxy
 License-File: LICENSE
 
 # 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)
 
+> [!IMPORTANT]
+> This repository is only sporadically maintained. Breaking API changes will be maintained on a best efforts basis.
+>
+> Collaborators are welcome, as are PRs for enhancements.
+>
+> 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.
 
 This module does not require you to set up an ngrok tunnel to receive incoming messages when behind a firewall or
@@ -53,6 +62,10 @@ You can find a sample project, using OpenAI/ChatGPT with this library here: http
 
 `pip install webex_bot`
 
+If you need optional proxy support, use this command instead:
+
+`pip install webex_bot[proxy]`
+
 2. On the Webex Developer portal, create a new [bot token][3] and expose it as an environment variable.
 
 ```sh
@@ -71,11 +84,19 @@ import os
 from webex_bot.commands.echo import EchoCommand
 from webex_bot.webex_bot import WebexBot
 
+# (Optional) Proxy configuration
+# Supports https or wss proxy, wss prioritized.
+proxies = {
+    'https': 'http://proxy.esl.example.com:80',
+    'wss': 'socks5://proxy.esl.example.com:1080'
+}
+
 # Create a Bot Object
 bot = WebexBot(teams_bot_token=os.getenv("WEBEX_TEAMS_ACCESS_TOKEN"),
                approved_rooms=['06586d8d-6aad-4201-9a69-0bf9eeb5766e'],
                bot_name="My Teams Ops Bot",
-               include_demo_commands=True)
+               include_demo_commands=True,
+               proxies=proxies)
 
 # Add new commands for the bot to listen out for.
 bot.add_command(EchoCommand())
@@ -353,13 +374,20 @@ and off you go!
 
 ### 0.5.0 (2024-Apr-25)
 
-* Add max backoff time (#55)
-* Attached files. Help, threading and log level overrides. (#54)
-* add stop() call to gracefully exit the bot (#42)
-* feat(20231212): add help image size parameter (#46)
-* update websockets to 11.0.3 (#43)
+* Add max backoff time ([#55][pr55])
+* Attached files. Help, threading and log level overrides. ([#54][pr54])
+* add stop() call to gracefully exit the bot ([#42][pr42])
+* feat(20231212): add help image size parameter ([#46][pr46])
+* update websockets to 11.0.3 ([#43][pr43])
 * Fix for help_command syntax issue
 
+### 0.5.1 (2024-Apr-25)
+
+* Add Proxy Support. ([#56][pr56])
+
+### 0.5.2 (2024-Aug-21)
+
+* Introduce exact_command_keyword_match feature ([#59][pr59])
 
 [1]: https://github.com/aaugustin/websockets
 
@@ -375,6 +403,20 @@ and off you go!
 
 [7]: https://eurl.io/#TeBLqZjLs
 
+[pr43]: https://github.com/fbradyirl/webex_bot/pull/43
+
+[pr46]: https://github.com/fbradyirl/webex_bot/pull/46
+
+[pr42]: https://github.com/fbradyirl/webex_bot/pull/42
+
+[pr54]: https://github.com/fbradyirl/webex_bot/pull/54
+
+[pr55]: https://github.com/fbradyirl/webex_bot/pull/55
+
+[pr56]: https://github.com/fbradyirl/webex_bot/pull/56
+
+[pr59]: https://github.com/fbradyirl/webex_bot/pull/59
+
 [i1]: https://github.com/fbradyirl/webex_bot/issues/1
 
 [i2]: https://github.com/fbradyirl/webex_bot/issues/2

{webex_bot-0.5.0 → webex_bot-0.5.2}/README.md

@@ -2,6 +2,14 @@
 
 [![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)
 
+> [!IMPORTANT]
+> This repository is only sporadically maintained. Breaking API changes will be maintained on a best efforts basis.
+>
+> Collaborators are welcome, as are PRs for enhancements.
+>
+> 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.
 
 This module does not require you to set up an ngrok tunnel to receive incoming messages when behind a firewall or
@@ -33,6 +41,10 @@ You can find a sample project, using OpenAI/ChatGPT with this library here: http
 
 `pip install webex_bot`
 
+If you need optional proxy support, use this command instead:
+
+`pip install webex_bot[proxy]`
+
 2. On the Webex Developer portal, create a new [bot token][3] and expose it as an environment variable.
 
 ```sh
@@ -51,11 +63,19 @@ import os
 from webex_bot.commands.echo import EchoCommand
 from webex_bot.webex_bot import WebexBot
 
+# (Optional) Proxy configuration
+# Supports https or wss proxy, wss prioritized.
+proxies = {
+    'https': 'http://proxy.esl.example.com:80',
+    'wss': 'socks5://proxy.esl.example.com:1080'
+}
+
 # Create a Bot Object
 bot = WebexBot(teams_bot_token=os.getenv("WEBEX_TEAMS_ACCESS_TOKEN"),
                approved_rooms=['06586d8d-6aad-4201-9a69-0bf9eeb5766e'],
                bot_name="My Teams Ops Bot",
-               include_demo_commands=True)
+               include_demo_commands=True,
+               proxies=proxies)
 
 # Add new commands for the bot to listen out for.
 bot.add_command(EchoCommand())
@@ -333,13 +353,20 @@ and off you go!
 
 ### 0.5.0 (2024-Apr-25)
 
-* Add max backoff time (#55)
-* Attached files. Help, threading and log level overrides. (#54)
-* add stop() call to gracefully exit the bot (#42)
-* feat(20231212): add help image size parameter (#46)
-* update websockets to 11.0.3 (#43)
+* Add max backoff time ([#55][pr55])
+* Attached files. Help, threading and log level overrides. ([#54][pr54])
+* add stop() call to gracefully exit the bot ([#42][pr42])
+* feat(20231212): add help image size parameter ([#46][pr46])
+* update websockets to 11.0.3 ([#43][pr43])
 * Fix for help_command syntax issue
 
+### 0.5.1 (2024-Apr-25)
+
+* Add Proxy Support. ([#56][pr56])
+
+### 0.5.2 (2024-Aug-21)
+
+* Introduce exact_command_keyword_match feature ([#59][pr59])
 
 [1]: https://github.com/aaugustin/websockets
 
@@ -355,6 +382,20 @@ and off you go!
 
 [7]: https://eurl.io/#TeBLqZjLs
 
+[pr43]: https://github.com/fbradyirl/webex_bot/pull/43
+
+[pr46]: https://github.com/fbradyirl/webex_bot/pull/46
+
+[pr42]: https://github.com/fbradyirl/webex_bot/pull/42
+
+[pr54]: https://github.com/fbradyirl/webex_bot/pull/54
+
+[pr55]: https://github.com/fbradyirl/webex_bot/pull/55
+
+[pr56]: https://github.com/fbradyirl/webex_bot/pull/56
+
+[pr59]: https://github.com/fbradyirl/webex_bot/pull/59
+
 [i1]: https://github.com/fbradyirl/webex_bot/issues/1
 
 [i2]: https://github.com/fbradyirl/webex_bot/issues/2

{webex_bot-0.5.0 → webex_bot-0.5.2}/setup.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.5.0
+current_version = 0.5.2
 commit = True
 tag = True
 

{webex_bot-0.5.0 → webex_bot-0.5.2}/setup.py

@@ -13,6 +13,10 @@ setup_requirements = ['pytest-runner', ]
 
 test_requirements = ['pytest>=3', ]
 
+extras_requirements = {
+    "proxy": ["websockets_proxy>=0.1.1"]
+}
+
 setup(
     author="Finbarr Brady",
     author_email='finbarr@somemail.com',
@@ -26,6 +30,7 @@ setup(
         'Programming Language :: Python :: 3.9',
     ],
     description="Python package for a Webex Bot based on websockets.",
+    extras_require=extras_requirements,
     install_requires=requirements,
     license="MIT license",
     long_description=readme,
@@ -38,6 +43,6 @@ setup(
     test_suite='tests',
     tests_require=test_requirements,
     url='https://github.com/fbradyirl/webex_bot',
-    version='0.5.0',
+    version='0.5.2',
     zip_safe=False,
 )

{webex_bot-0.5.0 → webex_bot-0.5.2}/webex_bot/__init__.py

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

{webex_bot-0.5.0 → webex_bot-0.5.2}/webex_bot/models/command.py

@@ -9,8 +9,9 @@ COMMAND_KEYWORD_KEY = "command_keyword"
 
 class Command(ABC):
 
-    def __init__(self, command_keyword=None, chained_commands=[], card=None, help_message=None,
-                 delete_previous_message=False,
+    def __init__(self, command_keyword=None, exact_command_keyword_match=False,
+                 chained_commands=[], card=None,
+                 help_message=None, delete_previous_message=False,
                  card_callback_keyword=None, approved_rooms=None):
         """
         Create a new bot command.
@@ -25,6 +26,7 @@ class Command(ABC):
                     )
 
         @param command_keyword: (optional) Text indicating a phrase to invoke this card.
+        @param exact_command_keyword_match: If True, there will be an exact command_keyword match performed. If False, then a sub-string match will be performed. Default: False. 
         @param chained_commands: (optional) List of other commands related
         to this command. This allows multiple related cards to be added at once.
         @param card: (deprecated) A dict representation of the JSON card.
@@ -37,6 +39,7 @@ class Command(ABC):
         @param approved_rooms: If defined, only members of these spaces will be allowed to run this command. Default: None (everyone)
         """
         self.command_keyword = command_keyword
+        self.exact_command_keyword_match = exact_command_keyword_match
         self.help_message = help_message
         self.card = card
         self.pre_card_callback = self.execute

{webex_bot-0.5.0 → webex_bot-0.5.2}/webex_bot/webex_bot.py

@@ -31,7 +31,8 @@ class WebexBot(WebexWebsocketClient):
                  bot_help_subtitle="Here are my available commands. Click one to begin.",
                  threads=True,
                  help_command=None,
-                 log_level="INFO"):
+                 log_level="INFO",
+                 proxies=None):
         """
         Initialise WebexBot.
 
@@ -46,7 +47,7 @@ class WebexBot(WebexWebsocketClient):
         @param threads: If True, respond to msg by creating a thread.
         @param help_command: If None, use internal HelpCommand, otherwise override.
         @param log_level: Set loggin level.
-
+        @param proxies: Dictionary of proxies for connections.
         """
 
         coloredlogs.install(level=os.getenv("LOG_LEVEL", log_level),
@@ -58,7 +59,8 @@ class WebexBot(WebexWebsocketClient):
                                       teams_bot_token,
                                       on_message=self.process_incoming_message,
                                       on_card_action=self.process_incoming_card_action,
-                                      device_url=device_url)
+                                      device_url=device_url,
+                                      proxies=proxies)
 
         if help_command is None:
             self.help_command = HelpCommand(
@@ -232,10 +234,21 @@ class WebexBot(WebexWebsocketClient):
 
             if not is_card_callback_command and c.command_keyword:
                 log.debug(f"c.command_keyword: {c.command_keyword}")
-                if user_command.find(c.command_keyword) != -1:
-                    command = c
-                    # If a command was found, stop looking for others
-                    break
+                log.info(f"exact_command_keyword_match: {c.exact_command_keyword_match}")
+                log.info(f"user_command: {user_command}")
+                log.info(f"command_keyword: {c.command_keyword}")
+                if c.exact_command_keyword_match: # Check if the "exact_command_keyword_match" flag is set to True
+                    if user_command == c.command_keyword:
+                        log.info("Exact match found!")
+                        command=c
+                        # If a command was found, stop looking for others
+                        break
+                else: # Enter here if the "exact_command_keyword_match" flag is set to False
+                    if user_command.find(c.command_keyword) != -1:
+                        log.info("Sub-string match found!")
+                        command = c
+                        # If a command was found, stop looking for others
+                        break
             else:
                 log.debug(f"card_callback_keyword: {c.card_callback_keyword}")
                 if user_command == c.command_keyword or user_command == c.card_callback_keyword:

{webex_bot-0.5.0 → webex_bot-0.5.2}/webex_bot/websockets/webex_websocket_client.py

@@ -11,6 +11,12 @@ import requests
 import websockets
 from webexteamssdk import WebexTeamsAPI
 
+try:
+    from websockets_proxy import Proxy, proxy_connect
+except ImportError:
+    Proxy = None
+    proxy_connect = None
+
 logger = logging.getLogger(__name__)
 
 DEFAULT_DEVICE_URL = "https://wdm-a.wbx2.com/wdm/api/v1"
@@ -36,16 +42,23 @@ class WebexWebsocketClient(object):
                  access_token,
                  device_url=DEFAULT_DEVICE_URL,
                  on_message=None,
-                 on_card_action=None):
+                 on_card_action=None,
+                 proxies=None):
         self.access_token = access_token
-        self.teams = WebexTeamsAPI(access_token=access_token)
+        self.teams = WebexTeamsAPI(access_token=access_token, proxies=proxies)
         self.device_url = device_url
         self.device_info = None
         self.on_message = on_message
         self.on_card_action = on_card_action
+        self.proxies = proxies
         self.websocket = None
         self.share_id = None
 
+        if self.proxies:
+            # Connecting through a proxy
+            if proxy_connect is None:
+                raise ImportError("Failed to load libraries for proxy, maybe forgot [proxy] option during installation.")
+
     def _process_incoming_websocket_message(self, msg):
         """
         Handle websocket data.
@@ -124,7 +137,8 @@ class WebexWebsocketClient(object):
                                                             f"{verb}/{activity_id}")
         headers = {"Authorization": f"Bearer {self.access_token}"}
         conversation_message = requests.get(conversation_message_url,
-                                            headers=headers).json()
+                                            headers=headers,
+                                            proxies=self.proxies).json()
         logger.debug(f"conversation_message={conversation_message}")
         return conversation_message['id']
 
@@ -197,7 +211,20 @@ class WebexWebsocketClient(object):
         async def _connect_and_listen():
             ws_url = self.device_info['webSocketUrl']
             logger.info(f"Opening websocket connection to {ws_url}")
-            async with websockets.connect(ws_url, ssl=ssl_context) as _websocket:
+
+            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)
+            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)
+            else:
+                logger.debug(f"Not using proxy for websocket connection.")
+                connect = websockets.connect(ws_url, ssl=ssl_context)
+
+            async with connect as _websocket:
                 self.websocket = _websocket
                 logger.info("WebSocket Opened.")
                 msg = {'id': str(uuid.uuid4()),
@@ -216,4 +243,4 @@ class WebexWebsocketClient(object):
                 logger.error('could not create device info')
                 raise Exception("No WDM device info")
             # trigger re-connect
-            asyncio.get_event_loop().run_until_complete(_connect_and_listen())
+            asyncio.get_event_loop().run_until_complete(_connect_and_listen())

{webex_bot-0.5.0 → webex_bot-0.5.2}/webex_bot.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: webex-bot
-Version: 0.5.0
+Version: 0.5.2
 Summary: Python package for a Webex Bot based on websockets.
 Home-page: https://github.com/fbradyirl/webex_bot
 Author: Finbarr Brady
@@ -16,12 +16,21 @@ Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
+Provides-Extra: proxy
 License-File: LICENSE
 
 # 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)
 
+> [!IMPORTANT]
+> This repository is only sporadically maintained. Breaking API changes will be maintained on a best efforts basis.
+>
+> Collaborators are welcome, as are PRs for enhancements.
+>
+> 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.
 
 This module does not require you to set up an ngrok tunnel to receive incoming messages when behind a firewall or
@@ -53,6 +62,10 @@ You can find a sample project, using OpenAI/ChatGPT with this library here: http
 
 `pip install webex_bot`
 
+If you need optional proxy support, use this command instead:
+
+`pip install webex_bot[proxy]`
+
 2. On the Webex Developer portal, create a new [bot token][3] and expose it as an environment variable.
 
 ```sh
@@ -71,11 +84,19 @@ import os
 from webex_bot.commands.echo import EchoCommand
 from webex_bot.webex_bot import WebexBot
 
+# (Optional) Proxy configuration
+# Supports https or wss proxy, wss prioritized.
+proxies = {
+    'https': 'http://proxy.esl.example.com:80',
+    'wss': 'socks5://proxy.esl.example.com:1080'
+}
+
 # Create a Bot Object
 bot = WebexBot(teams_bot_token=os.getenv("WEBEX_TEAMS_ACCESS_TOKEN"),
                approved_rooms=['06586d8d-6aad-4201-9a69-0bf9eeb5766e'],
                bot_name="My Teams Ops Bot",
-               include_demo_commands=True)
+               include_demo_commands=True,
+               proxies=proxies)
 
 # Add new commands for the bot to listen out for.
 bot.add_command(EchoCommand())
@@ -353,13 +374,20 @@ and off you go!
 
 ### 0.5.0 (2024-Apr-25)
 
-* Add max backoff time (#55)
-* Attached files. Help, threading and log level overrides. (#54)
-* add stop() call to gracefully exit the bot (#42)
-* feat(20231212): add help image size parameter (#46)
-* update websockets to 11.0.3 (#43)
+* Add max backoff time ([#55][pr55])
+* Attached files. Help, threading and log level overrides. ([#54][pr54])
+* add stop() call to gracefully exit the bot ([#42][pr42])
+* feat(20231212): add help image size parameter ([#46][pr46])
+* update websockets to 11.0.3 ([#43][pr43])
 * Fix for help_command syntax issue
 
+### 0.5.1 (2024-Apr-25)
+
+* Add Proxy Support. ([#56][pr56])
+
+### 0.5.2 (2024-Aug-21)
+
+* Introduce exact_command_keyword_match feature ([#59][pr59])
 
 [1]: https://github.com/aaugustin/websockets
 
@@ -375,6 +403,20 @@ and off you go!
 
 [7]: https://eurl.io/#TeBLqZjLs
 
+[pr43]: https://github.com/fbradyirl/webex_bot/pull/43
+
+[pr46]: https://github.com/fbradyirl/webex_bot/pull/46
+
+[pr42]: https://github.com/fbradyirl/webex_bot/pull/42
+
+[pr54]: https://github.com/fbradyirl/webex_bot/pull/54
+
+[pr55]: https://github.com/fbradyirl/webex_bot/pull/55
+
+[pr56]: https://github.com/fbradyirl/webex_bot/pull/56
+
+[pr59]: https://github.com/fbradyirl/webex_bot/pull/59
+
 [i1]: https://github.com/fbradyirl/webex_bot/issues/1
 
 [i2]: https://github.com/fbradyirl/webex_bot/issues/2

{webex_bot-0.5.0 → webex_bot-0.5.2}/webex_bot.egg-info/requires.txt

@@ -2,3 +2,6 @@ webexteamssdk==1.6.1
 coloredlogs
 websockets==11.0.3
 backoff
+
+[proxy]
+websockets_proxy>=0.1.1