Add delete, list webhook methods

Author: guiajlopes

examples/conversation_create_webhook.py

@@ -33,15 +33,15 @@
    })
 
   # Print the object information.
-  print('\nThe following information was returned as a Conversation List object:\n')
+  print('\nThe following information was returned as a Webhook object:\n')
   print('  id            : %s' % webhook.id)
   print('  events        : %s' % webhook.events)
   print('  channel id    : %s' % webhook.channelId)
   print('  created date  : %s' % webhook.createdDatetime)
   print('  updated date  : %s' % webhook.updatedDatetime)
 
 except messagebird.client.ErrorException as e:
-  print('\nAn error occured while requesting a Message object:\n')
+  print('\nAn error occured while requesting a Webhook object:\n')
 
   for error in e.errors:
     print('  code        : %d' % error.code)

examples/conversation_delete_webhook.py

@@ -0,0 +1,37 @@
+#!/usr/bin/env python
+
+import sys, os
+sys.path.append(os.path.join(os.path.dirname(__file__), '..'))
+
+import messagebird
+
+# ACCESS_KEY = ''
+# WEBHOOK_ID = ''
+
+try:
+  ACCESS_KEY
+except NameError:
+  print('You need to set an ACCESS_KEY constant in this file')
+  sys.exit(1)
+
+try:
+  WEBHOOK_ID
+except NameError:
+  print('You need to set an WEBHOOK_ID constant in this file')
+  sys.exit(1)
+
+try:
+  client = messagebird.ConversationClient(ACCESS_KEY)
+
+  client.delete_webhook(WEBHOOK_ID)
+
+  # Print the object information.
+  print('\nWebhook has been deleted:\n')
+
+except messagebird.client.ErrorException as e:
+  print('\nAn error occured while requesting a Webhook object:\n')
+
+  for error in e.errors:
+    print('  code        : %d' % error.code)
+    print('  description : %s' % error.description)
+    print('  parameter   : %s\n' % error.parameter)

examples/conversation_list_webhook.py

@@ -0,0 +1,38 @@
+#!/usr/bin/env python
+
+import sys, os
+sys.path.append(os.path.join(os.path.dirname(__file__), '..'))
+
+import messagebird
+
+# ACCESS_KEY = ''
+
+try:
+  ACCESS_KEY
+except NameError:
+  print('You need to set an ACCESS_KEY constant in this file')
+  sys.exit(1)
+
+try:
+  client = messagebird.ConversationClient(ACCESS_KEY)
+
+  webhookList = client.list()
+
+  itemIds = []
+  for msgItem in webhookList.items:
+    itemIds.append(msgItem.id)
+
+  # Print the object information.
+  print('\nThe following information was returned as a Conversation Webhook List object:\n')
+  print('  conversation ids  : %s' % itemIds)
+  print('  offset       : %s' % webhookList.offset)
+  print('  limit        : %s' % webhookList.limit)
+  print('  totalCount   : %s' % webhookList.totalCount)
+
+except messagebird.client.ErrorException as e:
+  print('\nAn error occured while requesting a Conversation Webhook List object:\n')
+
+  for error in e.errors:
+    print('  code        : %d' % error.code)
+    print('  description : %s' % error.description)
+    print('  parameter   : %s\n' % error.parameter)

messagebird/client.py

@@ -38,6 +38,10 @@ def __init__(self, access_key, http_client=None):
   def request(self, path, method='GET', params=None):
     """Builds a request, gets a response and decodes it."""
     response_text = self.http_client.request(path, method, params)
+
+    if not response_text:
+        return response_text
+
     response_json = json.loads(response_text)
 
     if 'errors' in response_json:

messagebird/conversation_client.py

@@ -3,7 +3,7 @@
 from messagebird.http_client import HttpClient
 from messagebird.conversation_message import ConversationMessage, ConversationMessageList
 from messagebird.conversation import Conversation, ConversationList
-from messagebird.conversation_webhook import ConversationWebhook
+from messagebird.conversation_webhook import ConversationWebhook, ConversationWebhookList
 
 try:
     from urllib.parse import urlencode
@@ -64,11 +64,16 @@ def read_message(self, message_id):
     def create_webhook(self, webhook_create_request):
         return ConversationWebhook().load(self.client.request(CONVERSATION_WEB_HOOKS_PATH, 'POST', webhook_create_request))
 
-    def delete_webhook(self):
-        return self.access_key
+    def delete_webhook(self, id):
+        uri = CONVERSATION_WEB_HOOKS_PATH + '/' + str(id)
+        self.client.request(uri, 'DELETE')
 
-    def list_webhooks(self):
-        return self.access_key
+    def list_webhooks(self, options=None):
+        uri = CONVERSATION_WEB_HOOKS_PATH
+        if options is not None:
+            uri += '?' + urlencode(options)
+
+        return ConversationWebhookList().load(self.client.request(uri))
 
     def read_webhook(self):
         return self.access_key

messagebird/conversation_webhook.py

@@ -30,4 +30,26 @@ def updatedDatetime(self):
 
     @updatedDatetime.setter
     def updatedDatetime(self, value):
-        self._updatedDatetime = self.value_to_time(value)
+        self._updatedDatetime = self.value_to_time(value, '%Y-%m-%dT%H:%M:%SZ')
+
+
+class ConversationWebhookList(Base):
+    def __init__(self):
+        self.offset = None
+        self.limit = None
+        self.count = None
+        self.totalCount = None
+        self._items = None
+
+    @property
+    def items(self):
+        return self._items
+
+    @items.setter
+    def items(self, value):
+        items = []
+        if isinstance(value, list):
+            for item in value:
+                items.append(ConversationWebhook().load(item))
+
+        self._items = items

tests/test_conversation_webhook.py

@@ -27,4 +27,28 @@ def test_conversation_webhook_create(self):
 
         ConversationClient('', http_client).create_webhook(webhookRequestData)
 
-        http_client.request.assert_called_once_with('webhooks', 'POST', webhookRequestData)
+        http_client.request.assert_called_once_with('webhooks', 'POST', webhookRequestData)
+
+    def test_conversation_webhook_delete(self):
+        http_client = Mock()
+        http_client.request.return_value = ''
+
+        ConversationClient('', http_client).delete_webhook('webhook-id')
+
+        http_client.request.assert_called_once_with('webhooks/webhook-id', 'DELETE', None)
+
+
+    def test_conversation_webhook_list(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"}}]}'
+
+        ConversationClient('', http_client).list_webhooks()
+        http_client.request.assert_called_once_with('webhooks', '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}
+        ConversationClient('', http_client).list_webhooks(params)
+        http_client.request.assert_called_once_with('webhooks?offset=1&limit=2', 'GET', None)