Merge pull request #206 from symphony-youri/1.3-rc-1-3-5-release

Release 1.3.5

Author: symphony-youri

examples/ExpenseBot/listeners/processors/room_processor.py

@@ -12,7 +12,7 @@ def __init__(self, bot_client):
         self.sym_message_parser = SymMessageParser()
         #hard code to the userId of bot you are using.
         self.bot_id = '349026222344891'
-        self.default_message = self.default_message = self.message_formatter.format_message('type @karlPythonDemo help to view commands')
+        self.default_message = self.message_formatter.format_message('type @karlPythonDemo help to view commands')
 
     def process_room_message(self, msg):
         logging.debug('room_processor/process_room_message()')

requirements.txt

@@ -1,30 +1,32 @@
-requests-pkcs12==1.9
+aiohttp==3.7.4.post0
+aioresponses==0.7.2
+async-timeout==3.0.1
+attrs==21.2.0
+beautifulsoup4==4.8.2
+certifi==2021.5.30
+cffi==1.14.5
+chardet==4.0.0
+cryptography==3.4.7
+defusedxml==0.7.1
+ecdsa==0.14.1
+idna==2.10
+Jinja2==2.11.3
+MarkupSafe==2.0.1
+multidict==5.1.0
+py==1.10.0
+pyasn1==0.4.8
+pycparser==2.20
+pyOpenSSL==20.0.1
+python-jose==3.2.0
+python-json-logger==0.1.11
+requests==2.25.1
+requests-mock==1.7.0
+requests-pkcs12==1.10
 requests-toolbelt==0.9.1
+rsa==4.7.2
+six==1.16.0
+soupsieve==2.2.1
+typing-extensions==3.10.0.0
+urllib3==1.26.5
+yarl==1.6.3
 yattag==1.12.2
-python-json-logger==0.1.11
-beautifulsoup4==4.8.0
-Jinja2==2.10.1
-defusedxml==0.6.0
-
-rsa~=4.7
-pyasn1~=0.4.8
-six~=1.15.0
-ecdsa<0.15
-multidict~=4.7.6
-yarl~=1.4.2
-attrs~=19.3.0
-aiohttp>=3.7.4
-chardet~=3.0.4
-MarkupSafe~=1.1.1
-pycparser~=2.20
-idna~=2.9
-urllib3~=1.25.9
-certifi~=2020.4.5.2
-cffi~=1.14.0
-python-jose~=3.2.0
-requests~=2.24.0
-soupsieve~=2.0.1
-setuptools~=47.3.1
-aioresponses~=0.6.4
-pytest~=6.2.1
-

setup.py

@@ -9,7 +9,7 @@ def readme():
 setuptools.setup(
     name="sym_api_client_python",
 
-    version="1.3.4",
+    version="1.3.5",
     author="Symphony Platform Solutions",
     author_email="platformsolutions@symphony.com",
     description="Symphony REST API - Python Client",
@@ -20,19 +20,21 @@ def readme():
     packages=setuptools.find_packages(),
     install_requires=[
         'aiohttp',
-        'aioresponses>=0.6.1',
+        'aioresponses~=0.7.2',
         'pyOpenSSL',
         'rsa',
         'requests',
         'python-jose~=3.2.0',
-        'python-json-logger==0.1.11',
-        'beautifulsoup4==4.8.0',
-        'Jinja2==2.10.1',
-        'requests_pkcs12==1.9',
-        'requests-toolbelt==0.9.1',
-        'requests-mock>=1.7.0',
-        'yattag==1.12.2',
-        'defusedxml==0.6.0'
+        'python-json-logger~=0.1.11',
+        'beautifulsoup4~=4.8.0',
+        'Jinja2~=2.11.3',
+        'requests_pkcs12~=1.9',
+        'requests-toolbelt~=0.9.1',
+        'requests-mock~=1.7.0',
+        'yattag~=1.12.2',
+        'defusedxml~=0.7.1',
+        'urllib3~=1.26.5',
+        'py~=1.10.0'
     ],
     tests_require=['pytest'],
     include_package_data=True,

sym_api_client_python/auth/rsa_auth.py

@@ -80,7 +80,6 @@ def create_jwt(self):
                 'exp': expiration_date
             }
             encoded = jwt.encode(payload, private_key, algorithm='RS512')
-            f.close()
             return encoded
 
     def session_authenticate(self):

sym_api_client_python/clients/message_client.py

@@ -1,5 +1,6 @@
 import io
 import logging
+from contextlib import contextmanager
 from typing import Union
 
 from .api_client import APIClient
@@ -12,6 +13,19 @@
 MESSAGE_CREATE = MESSAGE_STREAM_API + '/create'
 
 
+@contextmanager
+def open_file(file):
+    if isinstance(file, io.IOBase):
+        # already opened file
+        yield file
+    else:
+        try:
+            file_object = open(file, mode='rb')
+            yield file_object
+        finally:
+            file_object.close()
+
+
 class MessageClient(APIClient):
 
     def __init__(self, bot_client):
@@ -45,21 +59,14 @@ async def send_msg_async(self, stream_id, outbound_msg):
         url = MESSAGE_CREATE.format(stream_id=stream_id)
         return await self.bot_client.execute_rest_call_async('POST', url, files=outbound_msg)
 
-    def _data_and_headers_for_attachment(self, stream_id, msg, filename, attachment, aio=False):
+    def _data_and_headers_for_attachment(self, stream_id, msg, filename, attachment_file, aio=False):
         """Build an attachment out of either a path or a stream"""
         url = MESSAGE_CREATE.format(stream_id=stream_id)
 
-        try:
-            attachment_file_object = open(attachment, 'rb')
-        except TypeError:
-            # If it doesn't support open treat it as a stream already
-            attachment_file_object = attachment
-
         # The below states that Content-Type for attachments should be 'file' which is almost
         # certainly wrong - it's not a valid MIME-type. text/plain seems right
         fields = {'message': msg,
-                  'attachment': (
-                      filename, attachment_file_object, "file")}
+                  'attachment': (filename, attachment_file, "file")}
 
         parts = self.make_mulitpart_form(fields, aio=aio)
 
@@ -76,8 +83,9 @@ def send_msg_with_attachment(self, stream_id, msg,
             A path to a file or a stream of bytes.
         """
         logging.debug('MessageClient/send_msg_with_attachment()')
-        parts = self._data_and_headers_for_attachment(stream_id, msg, filename, attachment)
-        return self.bot_client.execute_rest_call("POST", **parts)
+        with open_file(attachment) as attachment_file:
+            parts = self._data_and_headers_for_attachment(stream_id, msg, filename, attachment_file)
+            return self.bot_client.execute_rest_call("POST", **parts)
 
     async def send_msg_with_attachment_async(self, stream_id, msg,
                                              filename, attachment: Union[str, io.BytesIO]):
@@ -86,9 +94,9 @@ async def send_msg_with_attachment_async(self, stream_id, msg,
             A path to a file or a stream of bytes.
         """
         logging.debug('MessageClient/send_msg_with_attachment()')
-
-        parts = self._data_and_headers_for_attachment(stream_id, msg, filename, attachment, aio=True)
-        return await self.bot_client.execute_rest_call_async('POST', **parts)
+        with open_file(attachment) as attachment_file:
+            parts = self._data_and_headers_for_attachment(stream_id, msg, filename, attachment_file, aio=True)
+            return await self.bot_client.execute_rest_call_async('POST', **parts)
 
     def get_msg_attachment(self, stream_id, msg_id, file_id):
         logging.debug('MessageClient/get_msg_attachment()')

sym_api_client_python/clients/user_client.py

@@ -1,6 +1,4 @@
 import logging
-from .api_client import APIClient
-import logging
 
 from .api_client import APIClient
 

sym_api_client_python/datafeed_event_service.py

@@ -7,7 +7,7 @@
 
 from asyncio import CancelledError
 
-#TODO: These imports are duplicated over the abstract class to avoid errors in the Async version
+# TODO: These imports are duplicated over the abstract class to avoid errors in the Async version
 from .exceptions.UnauthorizedException import UnauthorizedException
 from .exceptions.APIClientErrorException import APIClientErrorException
 from .exceptions.DatafeedExpiredException import DatafeedExpiredException
@@ -215,13 +215,13 @@ async def deactivate_datafeed(self, wait_for_handler_completions=True):
         log.debug('AsyncDataFeedEventService/deactivate_datafeed()')
         if wait_for_handler_completions:
             log.debug('AsyncDataFeedEventService/deactivate_datafeed() --> '
-                     'Waiting for {} events to finish'.format(self.queue.qsize()))
+                      'Waiting for {} events to finish'.format(self.queue.qsize()))
             await self.queue.join()
             log.debug('AsyncDataFeedEventService/deactivate_datafeed() --> '
-                     'Deactivating')
+                      'Deactivating')
         else:
             log.debug('AsyncDataFeedEventService/deactivate_datafeed() --> '
-                     '{} events still being handled, deactivating anyway'.format(self.queue.qsize()))
+                      '{} events still being handled, deactivating anyway'.format(self.queue.qsize()))
 
         if not self.stop:
             self.stop = True
@@ -314,25 +314,30 @@ def _process_full_trace(self, id):
         Use with messagedId if available
         """
 
-        if self.trace_enabled:
-            try:
-                intermediates = self.trace_dict[id]
-                assert len(intermediates) == 4
-                trace = EventTrace(id, intermediates[0], intermediates[1], intermediates[2],
-                                   intermediates[3])
-                total_time = intermediates[3] - intermediates[0]
-                time_in_bot = intermediates[3] - intermediates[1]
-
-                # This just writes out total seconds instead of formatting into minutes and hours
-                # for a typical bot response this seems reasonable
-                log.debug("Responded to message in: {:.4g}s. Including {:.4g}s inside the bot"
-                         .format(total_time.total_seconds(), time_in_bot.total_seconds()))
-                if self.trace_recorder is not None:
-                    self.trace_recorder.append(trace)
-                del self.trace_dict[id]
-            except Exception as exc:
-                log.error("Error while computing trace results for id: " + id)
-                log.exception(exc)
+        if not self.trace_enabled:
+            return
+
+        try:
+            intermediates = self.trace_dict[id]
+            if len(intermediates) != 4:
+                log.error("Error while computing trace results for id: " + id + ": trace item should have 4 elements")
+                return
+
+            trace = EventTrace(id, intermediates[0], intermediates[1], intermediates[2],
+                               intermediates[3])
+            total_time = intermediates[3] - intermediates[0]
+            time_in_bot = intermediates[3] - intermediates[1]
+
+            # This just writes out total seconds instead of formatting into minutes and hours
+            # for a typical bot response this seems reasonable
+            log.debug("Responded to message in: {:.4g}s. Including {:.4g}s inside the bot"
+                      .format(total_time.total_seconds(), time_in_bot.total_seconds()))
+            if self.trace_recorder is not None:
+                self.trace_recorder.append(trace)
+            del self.trace_dict[id]
+        except Exception as exc:
+            log.error("Error while computing trace results for id: " + id)
+            log.exception(exc)
 
     @staticmethod
     def _get_event_id(event):
@@ -348,16 +353,18 @@ def _add_trace(self, e_id, first_timestamp=None):
 
         Use with messageId if available
         """
-        if self.trace_enabled:
-            if first_timestamp is not None:
-                self.trace_dict[e_id] = [make_datetime(first_timestamp)]
-            try:
-                self.trace_dict[e_id].append(datetime.datetime.utcnow())
-            except KeyError:
-                log.error(
-                    'Error making traces for {}. Has the same messageId appeared'
-                    'more than once?'.format(e_id)
-                )
+        if not self.trace_enabled:
+            return
+
+        if first_timestamp is not None:
+            self.trace_dict[e_id] = [make_datetime(first_timestamp)]
+        try:
+            self.trace_dict[e_id].append(datetime.datetime.utcnow())
+        except KeyError:
+            log.error(
+                'Error making traces for {}. Has the same messageId appeared'
+                'more than once?'.format(e_id)
+            )
 
     async def handle_events(self):
         """For each event resolve its handler and add it to the queue to be processed"""

sym_api_client_python/processors/sym_elements_parser.py

@@ -69,8 +69,8 @@ def get_action_stream_id(self, elements_action_data):
         actionStream is where the formMessage is sent, this is a hidden stream
         so that the encryption context is between user and bot only and not everyone else on the room
         """
-        if elements_action_data['payload']['symphonyElementsAction']['actionStream'] != None and \
-                elements_action_data['payload']['symphonyElementsAction']['actionStream']['streamId'] != None:
+        if elements_action_data['payload']['symphonyElementsAction']['actionStream'] is not None and \
+                elements_action_data['payload']['symphonyElementsAction']['actionStream']['streamId'] is not None:
             return elements_action_data['payload']['symphonyElementsAction']['actionStream']['streamId']
 
     def get_form_message_id(self, elements_action_data):

sym_api_client_python/templates/elements_templates/forms/form.html

@@ -1,5 +1,5 @@
 <messageML>
-    <form id={{form_id}}> 
+    <form id="{{form_id}}">
 
     </form>
 </messageML>