Merge pull request #62 from livechat/API-9999-align-responses-from-rtm-and-web

API-9999: Add RtmResponse structure for RTM clients

Author: skamieniarz

examples/agent_rtm_example.py

@@ -5,9 +5,9 @@
 agent_rtm = AgentRTM.get_client()
 agent_rtm.open_connection()
 agent_rtm.login(token='<your access token>')
-results = agent_rtm.start_chat(continuous=True)
-chat_id = results['response']['payload']['chat_id']
-thread_id = results['response']['payload']['thread_id']
+response = agent_rtm.start_chat(continuous=True)
+chat_id = response.payload.get('chat_id')
+thread_id = response.payload.get('thread_id')
 agent_rtm.send_event(chat_id=chat_id,
                      event={
                          'type': 'message',

examples/customer_rtm_example.py

@@ -5,9 +5,9 @@
 customer_rtm = CustomerRTM.get_client(license_id=12345)
 customer_rtm.open_connection()
 customer_rtm.login(token='Bearer <your bearer token>')
-results = customer_rtm.start_chat(continuous=True)
-chat_id = results['response']['payload']['chat_id']
-thread_id = results['response']['payload']['thread_id']
+response = customer_rtm.start_chat(continuous=True)
+chat_id = response.payload.get('chat_id')
+thread_id = response.payload.get('thread_id')
 customer_rtm.send_event(chat_id=chat_id,
                         event={
                             'type': 'message',

livechat/agent/rtm/client.py

@@ -40,7 +40,7 @@ def test_client_logs_in_with_token():
     client.open_connection()
     response = client.login(token='Bearer 10386012')
     client.close_connection()
-    assert response['response']['payload'] == {
+    assert response.payload == {
         'error': {
             'type': 'authentication',
             'message': 'Invalid access token'
@@ -57,9 +57,23 @@ def test_client_logs_in_with_payload():
         'token': 'Bearer 10386012'
     })
     client.close_connection()
-    assert response['response']['payload'] == {
+    assert response.payload == {
         'error': {
             'type': 'authentication',
             'message': 'Invalid access token'
         }
     }, 'Request was not sent.'
+
+
+def test_rtm_response_structure():
+    ''' Test if returned `RtmResponse` structure contains expected properties. '''
+    client = AgentRTM.get_client()
+    client.open_connection()
+    response = client.login(token='Bearer 10386012')
+    client.close_connection()
+    assert isinstance(response.request_id,
+                      str) and len(response.request_id) >= 1
+    assert response.action == 'login'
+    assert response.type == 'response'
+    assert response.success is False
+    assert isinstance(response.payload, dict)

livechat/customer/rtm/client.py

@@ -61,7 +61,7 @@ def test_client_logs_in_with_token():
     client.open_connection()
     response = client.login(token='Bearer 10386012')
     client.close_connection()
-    assert response['response']['payload'] == {
+    assert response.payload == {
         'error': {
             'type': 'authentication',
             'message': 'Invalid access token'
@@ -83,9 +83,23 @@ def test_client_logs_in_with_payload():
             'token': 'Bearer 10386012'
         })
     client.close_connection()
-    assert response['response']['payload'] == {
+    assert response.payload == {
         'error': {
             'type': 'authentication',
             'message': 'Invalid access token'
         }
     }, 'Request was not sent.'
+
+
+def test_rtm_response_structure():
+    ''' Test if returned `RtmResponse` structure contains expected properties. '''
+    client = CustomerRTM.get_client(organization_id=ORGANIZATION_ID)
+    client.open_connection()
+    response = client.login(token='Bearer 10386012')
+    client.close_connection()
+    assert isinstance(response.request_id,
+                      str) and len(response.request_id) >= 1
+    assert response.action == 'login'
+    assert response.type == 'response'
+    assert response.success is False
+    assert isinstance(response.payload, dict)

livechat/tests/test_agent_rtm_client.py

@@ -58,7 +58,7 @@ def test_websocket_send_and_receive_message():
     ws.open()
     response = ws.send({'action': 'login', 'payload': {'token': 'Bearer xxx'}})
     ws.close()
-    assert response['response']['payload'] == {
+    assert response.payload == {
         'error': {
             'type': 'authentication',
             'message': 'Invalid access token'

livechat/tests/test_customer_rtm_client.py

@@ -0,0 +1,32 @@
+''' Module containing structures. '''
+
+
+class RtmResponse:
+    ''' RTM response structure class. '''
+    def __init__(self, rtm_response: dict):
+        self.rtm_response = rtm_response
+
+    @property
+    def request_id(self) -> str:
+        ''' `request_id` from the RTM response. '''
+        return self.rtm_response.get('request_id')
+
+    @property
+    def action(self) -> str:
+        ''' `action` from the RTM response. '''
+        return self.rtm_response.get('action')
+
+    @property
+    def type(self) -> str:
+        ''' Response `type` from the RTM response. '''
+        return self.rtm_response.get('type')
+
+    @property
+    def success(self) -> bool:
+        ''' Response `success` state from the RTM response. '''
+        return self.rtm_response.get('success')
+
+    @property
+    def payload(self) -> dict:
+        ''' `payload` from the RTM response. '''
+        return self.rtm_response.get('payload')

livechat/tests/test_ws_client.py

@@ -13,6 +13,8 @@
 from websocket import WebSocketApp, WebSocketConnectionClosedException
 from websocket._abnf import ABNF
 
+from livechat.utils.structures import RtmResponse
+
 
 def on_message(ws_client: WebSocketApp, message: str):
     ''' Custom WebSocketApp handler that inserts new messages in front of `self.messages` list. '''
@@ -67,8 +69,10 @@ def send(self,
                     data must be utf-8 string or unicode.
                 opcode (int): operation code of data. default is OPCODE_TEXT.
                 response_timeout (int): time in seconds to wait for the response.
+
             Returns:
-                dict: Dictionary with response.
+                RtmResponse: RTM response structure (`request_id`, `action`,
+                             `type`, `success` and `payload` properties)
         '''
         request_id = str(random.randint(1, 9999999999))
         request.update({'request_id': request_id})
@@ -83,7 +87,7 @@ def send(self,
             sleep(0.2)
             response_timeout -= 0.2
         self.logger.info(f'\nRESPONSE:\n{json.dumps(response, indent=4)}')
-        return {'response': response}
+        return RtmResponse(response)
 
     def _wait_till_sock_connected(self, timeout: float = 3) -> NoReturn:
         ''' Polls until `self.sock` is connected.