Merge pull request #29 from arjenzijlstra/add-list-messages

Added class MessageList and implemented message_list for text messages.

Author: marcelcorso

messagebird/client.py

@@ -6,7 +6,7 @@
 from messagebird.error import Error
 from messagebird.group import Group, GroupList
 from messagebird.hlr import HLR
-from messagebird.message import Message
+from messagebird.message import Message, MessageList
 from messagebird.mms import MMS
 from messagebird.voicemessage import VoiceMessage
 from messagebird.lookup import Lookup
@@ -98,6 +98,11 @@ def message(self, id):
         """Retrieve the information of a specific message."""
         return Message().load(self.request('messages/' + str(id)))
 
+    def message_list(self, limit=20, offset=0):
+        """Retrieve a list of the most recent messages."""
+        query = 'limit=' + str(limit) + '&offset=' + str(offset)
+        return MessageList().load(self.request('messages?' + query))
+
     def message_create(self, originator, recipients, body, params=None):
         """Create a new message."""
         if params is None: params = {}
@@ -276,6 +281,6 @@ def conversation_list_webhooks(self, limit=10, offset=0):
     def conversation_read_webhook(self, id):
         uri = CONVERSATION_WEB_HOOKS_PATH + '/' + str(id)
         return ConversationWebhook().load(self.request(uri, 'GET', None, CONVERSATION_TYPE))
-    
+
     def _format_query(self, limit, offset):
         return 'limit=' + str(limit) + '&offset=' + str(offset)

messagebird/message.py

@@ -1,6 +1,14 @@
 from messagebird.base      import Base
+from messagebird.base_list import BaseList
 from messagebird.recipient import Recipient
 
+
+class MessageList(BaseList):
+    def __init__(self):
+        # We're expecting items of type Message
+        super(MessageList, self).__init__(Message)
+
+
 class Message(Base):
   def __init__(self):
     self.id                 = None

tests/test_message.py

@@ -45,3 +45,15 @@ def test_message_delete_invalid(self):
             Client('', http_client).message_delete('non-existent-message-id')
 
         http_client.request.assert_called_once_with('messages/non-existent-message-id', 'DELETE', None)
+
+    def test_message_list(self):
+        http_client = Mock()
+        http_client.request.return_value = '{"offset": 0,"limit": 20,"count": 2,"totalCount": 2,"links": {"first": "https://rest.messagebird.com/messages/?offset=0","previous": null,"next": null,"last": "https://rest.messagebird.com/messages/?offset=0"},"items": [{"originator": "TEST","body": "This is a test message, sent through the MessageBird API, using the official Python SDK.","direction": "mt","mclass": 1,"reference": null,"createdDatetime": "2018-07-13T10:34:08+00:00","recipients": {"totalCount": 1,"totalSentCount": 1,"totalDeliveredCount": 1,"totalDeliveryFailedCount": 0,"items": [{"originator": null,"status": "delivered","statusDatetime": "2018-07-13T10:34:13+00:00","recipient": 123456789011}]},"validity": null,"gateway": 1,"typeDetails": {},"href": "https://rest.messagebird.com/messages/first-message-id","datacoding": "plain","scheduledDatetime": null,"type": "sms","id": "first-message-id"},{"originator": "TEST","body": "This is a test message, sent through the MessageBird API, using the official Python SDK.","direction": "mt","mclass": 1,"reference": null,"createdDatetime": "2018-07-13T10:33:52+00:00","recipients": {"totalCount": 1,"totalSentCount": 1,"totalDeliveredCount": 1,"totalDeliveryFailedCount": 0,"items": [{"originator": null,"status": "delivered","statusDatetime": "2018-07-13T10:33:56+00:00","recipient": 123456789012}]},"validity": null,"gateway": 1,"typeDetails": {},"href": "https://rest.messagebird.com/messages/second-message-id","datacoding": "plain","scheduledDatetime": null,"type": "sms","id": "second-message-id"}]}'
+
+        message_list = Client('', http_client).message_list(20, 0)
+
+        http_client.request.assert_called_once_with('messages?limit=20&offset=0', 'GET', None)
+
+        self.assertEqual(2, message_list.totalCount)
+        self.assertEqual('https://rest.messagebird.com/messages/?offset=0', message_list.links.first)
+        self.assertEqual('https://rest.messagebird.com/messages/first-message-id', message_list.items[0].href)