Add message_type and space_id to fetch_history endpoint

Author: Sebastian Molenda

pubnub/endpoints/fetch_messages.py

@@ -85,7 +85,8 @@ def include_space_id(self, include_space_id):
     def custom_params(self):
         params = {
             'max': int(self._count),
-            'include_message_type': "true" if self._include_message_type else "false",
+            'include_type': 'true' if self._include_message_type else 'false',
+            'include_message_type': 'true' if self._include_message_type else 'false',
         }
 
         if self._start is not None:
@@ -163,6 +164,8 @@ def create_response(self, envelope):  # pylint: disable=W0221
         return PNFetchMessagesResult.from_json(
             json_input=envelope,
             include_message_actions=self._include_message_actions,
+            include_message_type=self._include_message_type,
+            include_space_id=self._include_space_id,
             start_timetoken=self._start,
             end_timetoken=self._end)
 

pubnub/models/consumer/history.py

@@ -1,3 +1,4 @@
+from pubnub.models.consumer.message_type import PNMessageType
 class PNHistoryResult(object):
     def __init__(self, messages, start_timetoken, end_timetoken):
         self.messages = messages
@@ -63,7 +64,8 @@ def __str__(self):
         return "Fetch messages result for range %d..%d" % (self.start_timetoken, self.end_timetoken)
 
     @classmethod
-    def from_json(cls, json_input, include_message_actions=False, start_timetoken=None, end_timetoken=None):
+    def from_json(cls, json_input, include_message_actions=False, include_message_type=False, include_space_id=False,
+                start_timetoken=None, end_timetoken=None):
         channels = {}
 
         for key, entry in json_input['channels'].items():
@@ -84,6 +86,14 @@ def from_json(cls, json_input, include_message_actions=False, start_timetoken=No
                     else:
                         message.actions = {}
 
+                if include_message_type:
+                    message.message_type = PNMessageType.from_response(
+                        user_type=item['type'] if 'type' in item.keys() else None,
+                        internal_type=item['message_type'])
+
+                if include_space_id:
+                    message.space_id = item['space_id']
+
                 channels[key].append(message)
 
         return PNFetchMessagesResult(

pubnub/models/consumer/message_type.py

@@ -1,18 +1,24 @@
 class PNMessageType:
-    _internal_type: str = 0
+    _internal_type: str = None
     _user_type: str = None
+    _type_mapping = {
+        'None': 'message',
+        '0': 'message',
+        '1': 'signal',
+        '2': 'object',
+        '3': 'message_action',
+        '4': 'file',
+    }
 
     def __init__(self, user_type: str = None) -> None:
         self._user_type = user_type
 
     def set_internal_type(self, internal_type: str):
-        self._internal_type = internal_type
+        self._internal_type = self._type_mapping[str(internal_type)]
+        return self
 
     def from_response(user_type: str = None, internal_type: str = None):
-        message_type = PNMessageType(user_type)
-        if internal_type is not None:
-            message_type.set_internal_type(internal_type)
-        return message_type
+        return PNMessageType(user_type).set_internal_type(internal_type)
 
     def __str__(self) -> str:
         return self._user_type if self._user_type is not None else str(self._internal_type)

tests/acceptance/history/environment.py

@@ -0,0 +1,23 @@
+import requests
+
+from tests.acceptance import MOCK_SERVER_URL, CONTRACT_INIT_ENDPOINT, CONTRACT_EXPECT_ENDPOINT
+
+
+def before_scenario(context, feature):
+    for tag in feature.tags:
+        if "contract" in tag:
+            _, contract_name = tag.split("=")
+            response = requests.get(MOCK_SERVER_URL + CONTRACT_INIT_ENDPOINT + contract_name)
+            assert response
+
+
+def after_scenario(context, feature):
+    for tag in feature.tags:
+        if "contract" in tag:
+            response = requests.get(MOCK_SERVER_URL + CONTRACT_EXPECT_ENDPOINT)
+            assert response
+
+            response_json = response.json()
+
+            assert not response_json["expectations"]["failed"]
+            assert not response_json["expectations"]["pending"]

tests/acceptance/history/steps/given_steps.py

@@ -0,0 +1,12 @@
+from behave import given
+from tests.helper import pnconf_demo_copy
+from pubnub.pubnub import PubNub
+
+
+@given('the demo keyset with enabled storage')
+def step_impl(context):
+    config = pnconf_demo_copy()
+    config.origin = "localhost:8090"
+    config.ssl = False
+    pubnub_instance = PubNub(config)
+    context.peer = pubnub_instance

tests/acceptance/history/steps/then_steps.py

@@ -0,0 +1,33 @@
+from behave import then
+from pubnub.models.consumer.history import PNFetchMessagesResult
+
+
+@then("I receive a successful response")
+def step_impl(context):
+    assert context.status.error is None
+    assert type(context.result) == PNFetchMessagesResult
+
+
+@then("history response contains messages with '{type1}' and '{type2}' message types")
+def step_impl(context, type1, type2):
+    assert all(str(item.message_type) in [type1, type2] for item in context.messages)
+
+
+@then('history response contains messages with message types')
+def step_impl(context):
+    assert all('message_type' in item.__dict__.keys() for item in context.messages)
+
+
+@then('history response contains messages without message types')
+def step_impl(context):
+    assert all('message_type' not in item.__dict__.keys() for item in context.messages)
+
+
+@then('history response contains messages without space ids')
+def step_impl(context):
+    assert all('space_id' not in item.__dict__.keys() for item in context.messages)
+
+
+@then('history response contains messages with space ids')
+def step_impl(context):
+    assert all('space_id' in item.__dict__.keys() for item in context.messages)

tests/acceptance/history/steps/when_steps.py

@@ -0,0 +1,24 @@
+from behave import when
+
+
+@when("I fetch message history for '{channel}' channel")
+def step_impl(context, channel):
+    envelope = context.peer.fetch_messages().channels(channel).include_message_type(True).sync()
+    context.status = envelope.status
+    context.result = envelope.result
+    context.messages = envelope.result.channels[channel]
+
+
+@when("I fetch message history with '{flag}' set to '{value}' for '{channel}' channel")
+def step_impl(context, flag, value, channel):
+    request = context.peer.fetch_messages().channels(channel)
+    value = True if value == 'true' else False
+    if flag == 'includeMessageType':
+        request.include_message_type(value)
+    if flag == 'includeSpaceId':
+        request.include_space_id(value)
+
+    envelope = request.sync()
+    context.status = envelope.status
+    context.result = envelope.result
+    context.messages = envelope.result.channels[channel]