webex-bot 0.4.0__tar.gz → 0.4.6__tar.gz

{webex_bot-0.4.0 → webex_bot-0.4.6}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.1
 Name: webex_bot
-Version: 0.4.0
+Version: 0.4.6
 Summary: Python package for a Webex Bot based on websockets.
 Home-page: https://github.com/fbradyirl/webex_bot
 Author: Finbarr Brady
-Author-email: finbarr.brady@gmail.com
+Author-email: finbarr@somemail.com
 License: MIT license
 Keywords: webex_bot
 Platform: UNKNOWN
@@ -343,6 +343,18 @@ and off you go!
 * Bot will reply in response to the original message via the thread ID. This is not always possible in the case of a
   card action response due to some server side issue.
 
+### 0.4.1 (2023-Sept-07)
+
+* Always ensure there is a thread ID in the Activity before accessing it
+
+### 0.4.6 (2024-Apr-24)
+
+* 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)
+
 [1]: https://github.com/aaugustin/websockets
 
 [2]: https://github.com/CiscoDevNet/webexteamssdk

{webex_bot-0.4.0 → webex_bot-0.4.6}/README.md

@@ -323,6 +323,18 @@ and off you go!
 * Bot will reply in response to the original message via the thread ID. This is not always possible in the case of a
   card action response due to some server side issue.
 
+### 0.4.1 (2023-Sept-07)
+
+* Always ensure there is a thread ID in the Activity before accessing it
+
+### 0.4.6 (2024-Apr-24)
+
+* 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)
+
 [1]: https://github.com/aaugustin/websockets
 
 [2]: https://github.com/CiscoDevNet/webexteamssdk

{webex_bot-0.4.0 → webex_bot-0.4.6}/setup.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.4.0
+current_version = 0.4.6
 commit = True
 tag = True
 

{webex_bot-0.4.0 → webex_bot-0.4.6}/setup.py

@@ -7,7 +7,7 @@ from setuptools import setup, find_packages
 with open('README.md') as readme_file:
     readme = readme_file.read()
 
-requirements = ['webexteamssdk==1.6.1', 'coloredlogs', 'websockets==10.2', 'backoff']
+requirements = ['webexteamssdk==1.6.1', 'coloredlogs', 'websockets==11.0.3', 'backoff']
 
 setup_requirements = ['pytest-runner', ]
 
@@ -15,7 +15,7 @@ test_requirements = ['pytest>=3', ]
 
 setup(
     author="Finbarr Brady",
-    author_email='finbarr.brady@gmail.com',
+    author_email='finbarr@somemail.com',
     python_requires='>=3.8',
     classifiers=[
         'Development Status :: 2 - Pre-Alpha',
@@ -38,6 +38,6 @@ setup(
     test_suite='tests',
     tests_require=test_requirements,
     url='https://github.com/fbradyirl/webex_bot',
-    version='0.4.0',
+    version='0.4.6',
     zip_safe=False,
 )

{webex_bot-0.4.0 → webex_bot-0.4.6}/webex_bot/__init__.py

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

{webex_bot-0.4.0 → webex_bot-0.4.6}/webex_bot/commands/help.py

@@ -14,7 +14,7 @@ HELP_COMMAND_KEYWORD = "help"
 
 class HelpCommand(Command):
 
-    def __init__(self, bot_name, bot_help_subtitle, bot_help_image):
+    def __init__(self, bot_name, bot_help_subtitle, bot_help_image, bot_help_image_size=ImageSize.SMALL):
         self.commands = None
         super().__init__(
             command_keyword=HELP_COMMAND_KEYWORD,
@@ -25,6 +25,7 @@ class HelpCommand(Command):
         self.bot_name = bot_name
         self.bot_help_subtitle = bot_help_subtitle
         self.bot_help_image = bot_help_image
+        self.bot_help_image_size = bot_help_image_size
 
     def execute(self, message, attachment_actions, activity):
         pass
@@ -42,7 +43,7 @@ class HelpCommand(Command):
 
         image = Image(
             url=self.bot_help_image,
-            size=ImageSize.SMALL)
+            size=self.bot_help_image_size)
 
         header_column = Column(items=[heading, subtitle], width=2)
         header_image_column = Column(

{webex_bot-0.4.0 → webex_bot-0.4.6}/webex_bot/webex_bot.py

@@ -16,10 +16,6 @@ from webex_bot.models.response import Response
 from webex_bot.websockets.webex_websocket_client import WebexWebsocketClient, DEFAULT_DEVICE_URL
 
 log = logging.getLogger(__name__)
-coloredlogs.install(level=os.getenv("LOG_LEVEL", "INFO"),
-                    fmt='%(asctime)s  [%(levelname)s]  '
-                        '[%(module)s.%(name)s.%(funcName)'
-                        's]:%(lineno)s %(message)s')
 
 
 class WebexBot(WebexWebsocketClient):
@@ -32,7 +28,10 @@ class WebexBot(WebexWebsocketClient):
                  device_url=DEFAULT_DEVICE_URL,
                  include_demo_commands=False,
                  bot_name="Webex Bot",
-                 bot_help_subtitle="Here are my available commands. Click one to begin."):
+                 bot_help_subtitle="Here are my available commands. Click one to begin.",
+                 threads=True,
+                 help_command=None,
+                 log_level="INFO"):
         """
         Initialise WebexBot.
 
@@ -44,8 +43,16 @@ class WebexBot(WebexWebsocketClient):
         @param include_demo_commands: If True, any demo commands will be included.
         @param bot_name: Your custom name for the bot.
         @param bot_help_subtitle: Text to show in the help card.
+        @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.
+
         """
 
+        coloredlogs.install(level=os.getenv("LOG_LEVEL", log_level),
+                            fmt='%(asctime)s  [%(levelname)s]  '
+                                '[%(module)s.%(name)s.%(funcName)'
+                                's]:%(lineno)s %(message)s')
         log.info("Registering bot with Webex cloud")
         WebexWebsocketClient.__init__(self,
                                       teams_bot_token,
@@ -58,27 +65,30 @@ class WebexBot(WebexWebsocketClient):
         # text and callback function
         # By default supports 2 command, echo and help
 
-        self.help_command = HelpCommand(
-            bot_name=bot_name,
-            bot_help_subtitle=bot_help_subtitle,
-            bot_help_image=self.teams.people.me().avatar)
+        if help_command is None:
+            self.help_command = HelpCommand(
+                bot_name=bot_name,
+                bot_help_subtitle=bot_help_subtitle,
+                bot_help_image=self.teams.people.me().avatar)
+            self.help_command.commands = self.commands
+            # Set default help message
+            self.help_message = "Hello!  I understand the following commands:  \n"
+        else:
+            self.help_command = help_command
         self.commands = {
             self.help_command
         }
         if include_demo_commands:
             self.add_command(EchoCommand())
 
-        self.help_command.commands = self.commands
-
         self.card_callback_commands = {}
         self.approved_users = approved_users
         self.approved_domains = approved_domains
         self.approved_rooms = approved_rooms
-        # Set default help message
-        self.help_message = "Hello!  I understand the following commands:  \n"
         self.approval_parameters_check()
         self.bot_display_name = ""
         self.get_me_info()
+        self.threads = threads
 
     @backoff.on_exception(backoff.expo, requests.exceptions.ConnectionError)
     def get_me_info(self):
@@ -263,8 +273,10 @@ class WebexBot(WebexWebsocketClient):
                             f"response to cardAction inside a thread. "
                             f"Must reply outside of the thread in this case.: {activity}")
                 thread_parent_id = None
-        else:
+        elif 'id' in activity:
             thread_parent_id = activity['id']
+        else:
+            log.info("There is no activity id (thread ID) for this request.")
 
         if command.delete_previous_message and hasattr(teams_message, 'messageId'):
             previous_message_id = teams_message.messageId
@@ -305,7 +317,7 @@ class WebexBot(WebexWebsocketClient):
             # 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:
+            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)
@@ -349,14 +361,25 @@ class WebexBot(WebexWebsocketClient):
             quote_info(f"{user_email} I've messaged you 1-1. Please reply to me there.")
         if reply_one_to_one:
             if not is_one_on_one_space:
-                self.teams.messages.create(roomId=room_id,
-                                           markdown=default_move_to_one_to_one_heads_up,
+                if self.threads:
+                    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)
+            if self.threads:
+                self.teams.messages.create(toPersonEmail=user_email,
+                                           markdown=reply,
                                            parentId=conv_target_id)
-            self.teams.messages.create(toPersonEmail=user_email,
-                                       markdown=reply,
-                                       parentId=conv_target_id)
+            else:
+                self.teams.messages.create(toPersonEmail=user_email,
+                                           markdown=reply)
         else:
-            self.teams.messages.create(roomId=room_id, markdown=reply, parentId=conv_target_id)
+            if self.threads:
+                self.teams.messages.create(roomId=room_id, markdown=reply, parentId=conv_target_id)
+            else:
+                self.teams.messages.create(roomId=room_id, markdown=reply)
 
     def run_pre_card_load_reply(self, command, message, teams_message, activity):
         """

{webex_bot-0.4.0 → webex_bot-0.4.6}/webex_bot/websockets/webex_websocket_client.py

@@ -28,6 +28,8 @@ DEVICE_DATA = {
 ssl_context = ssl.create_default_context()
 ssl_context.load_verify_locations(certifi.where())
 
+MAX_BACKOFF_TIME = 240
+
 
 class WebexWebsocketClient(object):
     def __init__(self,
@@ -42,12 +44,14 @@ class WebexWebsocketClient(object):
         self.on_message = on_message
         self.on_card_action = on_card_action
         self.websocket = None
+        self.share_id = None
 
     def _process_incoming_websocket_message(self, msg):
         """
         Handle websocket data.
         :param msg: The raw websocket message
         """
+        logger.info(f"msg['data'] = {msg['data']}")
         if msg['data']['eventType'] == 'conversation.activity':
             activity = msg['data']['activity']
             if activity['verb'] == 'post':
@@ -61,6 +65,31 @@ class WebexWebsocketClient(object):
                     self._ack_message(message_base_64_id)
                     # Now process it with the handler
                     self.on_message(teams_message=webex_message, activity=activity)
+            elif activity['verb'] == 'share':
+                logger.debug(f"activity={activity}")
+                self.share_id = activity['id']
+                return
+            elif activity['verb'] == 'update':
+                logger.debug(f"activity={activity}")
+
+                object = activity['object']
+                if object['objectType'] == 'content' and object['contentCategory'] == 'documents':
+                    if 'files' in object.keys():
+                        for item in object['files']['items']:
+                            if not item['malwareQuarantineState'] == 'safe':
+                                return
+                    else:
+                        return
+                else:
+                    return
+                message_base_64_id = self._get_base64_message_id(activity)
+                webex_message = self.teams.messages.get(message_base_64_id)
+                logger.debug(f"webex_message from message_base_64_id: {webex_message}")
+                if self.on_message:
+                    # ack message first
+                    self._ack_message(message_base_64_id)
+                    # Now process it with the handler
+                    self.on_message(teams_message=webex_message, activity=activity)
             elif activity['verb'] == 'cardAction':
                 logger.debug(f"activity={activity}")
 
@@ -83,10 +112,14 @@ class WebexWebsocketClient(object):
         @return: base 64 message id
         """
         activity_id = activity['id']
-        logger.debug(f"activity verb=post. message id={activity_id}")
+        logger.debug(f"activity verb={activity['verb']}. message id={activity_id}")
         conversation_url = activity['target']['url']
         conv_target_id = activity['target']['id']
-        verb = "messages" if activity['verb'] == "post" else "attachment/actions"
+        verb = "messages" if activity['verb'] in ["post", "update"] else "attachment/actions"
+        if activity['verb'] == "update" and self.share_id is not None:
+            activity_id = self.share_id
+            self.share_id = None
+        logger.debug(f"activity_id={activity_id}")
         conversation_message_url = conversation_url.replace(f"conversations/{conv_target_id}",
                                                             f"{verb}/{activity_id}")
         headers = {"Authorization": f"Bearer {self.access_token}"}
@@ -134,6 +167,12 @@ class WebexWebsocketClient(object):
         logger.debug(f"self.device_info: {self.device_info}")
         return resp
 
+    def stop(self):
+        def terminate():
+            raise SystemExit()
+
+        asyncio.get_event_loop().create_task(terminate())
+
     def run(self):
         if self.device_info is None:
             if self._get_device_info() is None:
@@ -151,10 +190,10 @@ class WebexWebsocketClient(object):
                 logger.warning(
                     f"An exception occurred while processing message. Ignoring. {messageProcessingException}")
 
-        @backoff.on_exception(backoff.expo, websockets.ConnectionClosedError)
-        @backoff.on_exception(backoff.expo, websockets.ConnectionClosedOK)
-        @backoff.on_exception(backoff.expo, websockets.ConnectionClosed)
-        @backoff.on_exception(backoff.expo, socket.gaierror)
+        @backoff.on_exception(backoff.expo, websockets.ConnectionClosedError, max_time=MAX_BACKOFF_TIME)
+        @backoff.on_exception(backoff.expo, websockets.ConnectionClosedOK, max_time=MAX_BACKOFF_TIME)
+        @backoff.on_exception(backoff.expo, websockets.ConnectionClosed, max_time=MAX_BACKOFF_TIME)
+        @backoff.on_exception(backoff.expo, socket.gaierror, max_time=MAX_BACKOFF_TIME)
         async def _connect_and_listen():
             ws_url = self.device_info['webSocketUrl']
             logger.info(f"Opening websocket connection to {ws_url}")

{webex_bot-0.4.0 → webex_bot-0.4.6}/webex_bot.egg-info/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.1
 Name: webex-bot
-Version: 0.4.0
+Version: 0.4.6
 Summary: Python package for a Webex Bot based on websockets.
 Home-page: https://github.com/fbradyirl/webex_bot
 Author: Finbarr Brady
-Author-email: finbarr.brady@gmail.com
+Author-email: finbarr@somemail.com
 License: MIT license
 Keywords: webex_bot
 Platform: UNKNOWN
@@ -343,6 +343,18 @@ and off you go!
 * Bot will reply in response to the original message via the thread ID. This is not always possible in the case of a
   card action response due to some server side issue.
 
+### 0.4.1 (2023-Sept-07)
+
+* Always ensure there is a thread ID in the Activity before accessing it
+
+### 0.4.6 (2024-Apr-24)
+
+* 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)
+
 [1]: https://github.com/aaugustin/websockets
 
 [2]: https://github.com/CiscoDevNet/webexteamssdk

{webex_bot-0.4.0 → webex_bot-0.4.6}/webex_bot.egg-info/requires.txt

@@ -1,4 +1,4 @@
 webexteamssdk==1.6.1
 coloredlogs
-websockets==10.2
+websockets==11.0.3
 backoff