Update list methods to receive limit and offset by parameter

Author: guiajlopes

messagebird/client.py

@@ -15,11 +15,6 @@
 from messagebird.conversation         import Conversation, ConversationList
 from messagebird.conversation_webhook import ConversationWebhook, ConversationWebhookList
 
-try:
-    from urllib.parse import urlencode
-except ImportError:
-    from urllib import urlencode
-
 ENDPOINT       = 'https://rest.messagebird.com'
 CLIENT_VERSION = '1.3.1'
 PYTHON_VERSION = '%d.%d.%d' % (sys.version_info[0], sys.version_info[1], sys.version_info[2])
@@ -45,7 +40,7 @@ def __init__(self, access_key, http_client=None):
     self.access_key = access_key
     self.http_client = http_client
 
-  def getHttpClient(self, type=REST_TYPE):
+  def _get_http_client(self, type=REST_TYPE):
     if self.http_client:
       return self.http_client
 
@@ -56,7 +51,7 @@ def getHttpClient(self, type=REST_TYPE):
 
   def request(self, path, method='GET', params=None, type=REST_TYPE):
     """Builds a request, gets a response and decodes it."""
-    response_text = self.getHttpClient(type).request(path, method, params)
+    response_text = self._get_http_client(type).request(path, method, params)
 
     if not response_text:
         return response_text
@@ -70,7 +65,7 @@ def request(self, path, method='GET', params=None, type=REST_TYPE):
 
   def request_plain_text(self, path, method='GET', params=None, type=REST_TYPE):
     """Builds a request, gets a response and returns the body."""
-    response_text = self.getHttpClient(type).request(path, method, params)
+    response_text = self._get_http_client(type).request(path, method, params)
 
     try:
       # Try to decode the response to JSON to see if the API returned any
@@ -173,7 +168,7 @@ def contact_update(self, id, params=None):
     self.request_plain_text('contacts/' + str(id), 'PATCH', params)
 
   def contact_list(self, limit=10, offset=0):
-    query = 'limit='+str(limit)+'&offset='+str(offset)
+    query = self._format_query(limit, offset)
     return ContactList().load(self.request('contacts?'+query, 'GET', None))
 
   def group(self, id):
@@ -188,7 +183,7 @@ def group_delete(self, id):
     self.request_plain_text('groups/' + str(id), 'DELETE', None)
 
   def group_list(self, limit=10, offset=0):
-    query = 'limit=' + str(limit) + '&offset=' + str(offset)
+    query = self._format_query(limit, offset)
     return GroupList().load(self.request('groups?'+query, 'GET', None))
 
   def group_update(self, id, name, params=None):
@@ -209,11 +204,8 @@ def __group_add_contacts_query(self, contactIds):
   def group_remove_contact(self, groupId, contactId):
     self.request_plain_text('groups/' + str(groupId) + '/contacts/' + str(contactId), 'DELETE', None)
 
-  def conversation_list(self, options=None):
-    uri = CONVERSATION_PATH
-    if options is not None:
-      uri += '?' + urlencode(options)
-
+  def conversation_list(self, limit=10, offset=0):
+    uri = CONVERSATION_PATH + '?' + self._format_query(limit, offset)
     return ConversationList().load(self.request(uri, 'GET', None, CONVERSATION_TYPE))
 
   def conversation_start(self, start_request):
@@ -228,11 +220,9 @@ def conversation_read(self, id):
     uri = CONVERSATION_PATH + '/' + str(id)
     return Conversation().load(self.request(uri, 'GET', None, CONVERSATION_TYPE))
 
-  def conversation_list_messages(self, conversation_id, options=None):
+  def conversation_list_messages(self, conversation_id, limit=10, offset=0):
     uri = CONVERSATION_PATH + '/' + str(conversation_id) + '/' + CONVERSATION_MESSAGES_PATH
-
-    if options is not None:
-      uri += '?' + urlencode(options)
+    uri += '?' + self._format_query(limit, offset)
 
     return ConversationMessageList().load(self.request(uri, 'GET', None, CONVERSATION_TYPE))
 
@@ -251,13 +241,14 @@ def conversation_delete_webhook(self, id):
     uri = CONVERSATION_WEB_HOOKS_PATH + '/' + str(id)
     self.request(uri, 'DELETE', None, CONVERSATION_TYPE)
 
-  def conversation_list_webhooks(self, options=None):
-    uri = CONVERSATION_WEB_HOOKS_PATH
-    if options is not None:
-      uri += '?' + urlencode(options)
+  def conversation_list_webhooks(self, limit=10, offset=0):
+    uri = CONVERSATION_WEB_HOOKS_PATH + '?' + self._format_query(limit, offset)
 
     return ConversationWebhookList().load(self.request(uri, 'GET', None, CONVERSATION_TYPE))
 
   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)

tests/test_conversation.py

@@ -41,7 +41,7 @@ def test_conversation_list(self):
 
         Client('', http_client).conversation_list()
 
-        http_client.request.assert_called_once_with('conversations', 'GET', None)
+        http_client.request.assert_called_once_with('conversations?limit=10&offset=0', 'GET', None)
 
     def test_conversation_read(self):
         http_client = Mock()

tests/test_conversation_message.py

@@ -21,7 +21,7 @@ def test_conversation_list_messages(self):
         self.assertEqual(1, msg.count)
         self.assertEqual('54445534', msg.items[0].id)
 
-        http_client.request.assert_called_once_with('conversations/54567/messages', 'GET', None)
+        http_client.request.assert_called_once_with('conversations/54567/messages?limit=10&offset=0', 'GET', None)
 
     def test_conversation_read_message(self):
         http_client = Mock()

tests/test_conversation_webhook.py

@@ -42,15 +42,14 @@ def test_conversation_webhook_list(self):
         http_client.request.return_value = '{"offset":0,"limit":10,"count":2,"totalCount":2,"items":[{"id":"57b96dbe0fda40f0a814f5e3268c30a9","contactId":"8846d44229094c20813cf9eea596e680","contact":{"id":"8846d44229094c20813cf9eea596e680","href":"https://contacts.messagebird.com/v2/contacts/8846d44229094c20813cf9eea596e680","msisdn":31617110163,"displayName":"31617110163","firstName":"","lastName":"","customDetails":{},"attributes":{},"createdDatetime":"2019-04-02T08:54:39Z","updatedDatetime":"2019-04-02T08:54:40Z"},"channels":[{"id":"c0dae31e440145e094c4708b7d908842","name":"test","platformId":"sms","status":"active","createdDatetime":"2019-04-01T15:25:12Z","updatedDatetime":"0001-01-01T00:00:00Z"}],"status":"active","createdDatetime":"2019-04-02T08:54:38Z","updatedDatetime":"2019-04-02T14:24:09.192202886Z","lastReceivedDatetime":"2019-04-02T14:24:09.14826339Z","lastUsedChannelId":"c0dae31e440145e094c4708b7d908842","messages":{"totalCount":2,"href":"https://conversations.messagebird.com/v1/conversations/57b96dbe0fda40f0a814f5e3268c30a9/messages"}},{"id":"07e823fdb36a462fb5e187d6d7b96493","contactId":"459a35432b0c4195abbdae353eb19359","contact":{"id":"459a35432b0c4195abbdae353eb19359","href":"https://contacts.messagebird.com/v2/contacts/459a35432b0c4195abbdae353eb19359","msisdn":31615164888,"displayName":"31615164888","firstName":"","lastName":"","customDetails":{},"attributes":{},"createdDatetime":"2019-04-02T08:19:37Z","updatedDatetime":"2019-04-02T08:19:38Z"},"channels":[{"id":"c0dae31e440145e094c4708b7d908842","name":"test","platformId":"sms","status":"active","createdDatetime":"2019-04-01T15:25:12Z","updatedDatetime":"0001-01-01T00:00:00Z"}],"status":"active","createdDatetime":"2019-04-02T08:19:37Z","updatedDatetime":"2019-04-03T07:35:47.35395356Z","lastReceivedDatetime":"2019-04-02T12:02:22.707634424Z","lastUsedChannelId":"c0dae31e440145e094c4708b7d908842","messages":{"totalCount":16,"href":"https://conversations.messagebird.com/v1/conversations/07e823fdb36a462fb5e187d6d7b96493/messages"}}]}'
 
         Client('', http_client).conversation_list_webhooks()
-        http_client.request.assert_called_once_with('webhooks', 'GET', None)
+        http_client.request.assert_called_once_with('webhooks?limit=10&offset=0', 'GET', None)
 
     def test_conversation_webhook_list_pagination(self):
         http_client = Mock()
         http_client.request.return_value = '{"offset":0,"limit":10,"count":2,"totalCount":2,"items":[{"id":"57b96dbe0fda40f0a814f5e3268c30a9","contactId":"8846d44229094c20813cf9eea596e680","contact":{"id":"8846d44229094c20813cf9eea596e680","href":"https://contacts.messagebird.com/v2/contacts/8846d44229094c20813cf9eea596e680","msisdn":31617110163,"displayName":"31617110163","firstName":"","lastName":"","customDetails":{},"attributes":{},"createdDatetime":"2019-04-02T08:54:39Z","updatedDatetime":"2019-04-02T08:54:40Z"},"channels":[{"id":"c0dae31e440145e094c4708b7d908842","name":"test","platformId":"sms","status":"active","createdDatetime":"2019-04-01T15:25:12Z","updatedDatetime":"0001-01-01T00:00:00Z"}],"status":"active","createdDatetime":"2019-04-02T08:54:38Z","updatedDatetime":"2019-04-02T14:24:09.192202886Z","lastReceivedDatetime":"2019-04-02T14:24:09.14826339Z","lastUsedChannelId":"c0dae31e440145e094c4708b7d908842","messages":{"totalCount":2,"href":"https://conversations.messagebird.com/v1/conversations/57b96dbe0fda40f0a814f5e3268c30a9/messages"}},{"id":"07e823fdb36a462fb5e187d6d7b96493","contactId":"459a35432b0c4195abbdae353eb19359","contact":{"id":"459a35432b0c4195abbdae353eb19359","href":"https://contacts.messagebird.com/v2/contacts/459a35432b0c4195abbdae353eb19359","msisdn":31615164888,"displayName":"31615164888","firstName":"","lastName":"","customDetails":{},"attributes":{},"createdDatetime":"2019-04-02T08:19:37Z","updatedDatetime":"2019-04-02T08:19:38Z"},"channels":[{"id":"c0dae31e440145e094c4708b7d908842","name":"test","platformId":"sms","status":"active","createdDatetime":"2019-04-01T15:25:12Z","updatedDatetime":"0001-01-01T00:00:00Z"}],"status":"active","createdDatetime":"2019-04-02T08:19:37Z","updatedDatetime":"2019-04-03T07:35:47.35395356Z","lastReceivedDatetime":"2019-04-02T12:02:22.707634424Z","lastUsedChannelId":"c0dae31e440145e094c4708b7d908842","messages":{"totalCount":16,"href":"https://conversations.messagebird.com/v1/conversations/07e823fdb36a462fb5e187d6d7b96493/messages"}}]}'
 
-        params = {'offset': 1, 'limit': 2}
-        Client('', http_client).conversation_list_webhooks(params)
-        http_client.request.assert_called_once_with('webhooks?offset=1&limit=2', 'GET', None)
+        Client('', http_client).conversation_list_webhooks(2, 1)
+        http_client.request.assert_called_once_with('webhooks?limit=2&offset=1', 'GET', None)
 
     def test_conversation_webhook_read(self):
         http_client = Mock()