Merge pull request #21 from messagebird/add-groups

Add groups

Author: dysosmus

messagebird/client.py

@@ -5,6 +5,7 @@
 from messagebird.balance      import Balance
 from messagebird.contact      import Contact, ContactList
 from messagebird.error        import Error
+from messagebird.group        import ContactReference, Group, GroupList
 from messagebird.hlr          import HLR
 from messagebird.http_client  import HttpClient
 from messagebird.message      import Message
@@ -147,3 +148,36 @@ def contact_update(self, id, params=None):
   def contact_list(self, limit=0, offset=0):
     query = 'limit='+str(limit)+'&offset='+str(offset)
     return ContactList().load(self.request('contacts?'+query, 'GET', None))
+
+  def group(self, id):
+    return Group().load(self.request('groups/' + str(id), 'GET', None))
+
+  def group_create(self, name, params=None):
+    if params is None: params = {}
+    params.update({'name': name})
+    return Group().load(self.request('groups', 'POST', params))
+
+  def group_delete(self, id):
+    self.request_plain_text('groups/' + str(id), 'DELETE', None)
+
+  def group_list(self, limit=0, offset=0):
+    query = 'limit=' + str(limit) + '&offset=' + str(offset)
+    return GroupList().load(self.request('groups?'+query, 'GET', None))
+
+  def group_update(self, id, name, params=None):
+    if params is None: params = {}
+    params.update({'name': name})
+    self.request_plain_text('groups/' + str(id), 'PATCH', params)
+
+  def group_add_contacts(self, groupId, contactIds):
+    query = self.__group_add_contacts_query(contactIds)
+    self.request_plain_text('groups/' + str(groupId) + '?' + query, 'PUT', None)
+
+  def __group_add_contacts_query(self, contactIds):
+    # __group_add_contacts_query gets a query string to add contacts to a
+    # group. The expected format is ids[]=first-contact&ids[]=second-contact.
+    # See: https://developers.messagebird.com/docs/groups#add-contact-to-group.
+    return '&'.join('ids[]=' + str(id) for id in contactIds)
+
+  def group_remove_contact(self, groupId, contactId):
+    self.request_plain_text('groups/' + str(groupId) + '/contacts/' + str(contactId), 'DELETE', None)

messagebird/group.py

@@ -0,0 +1,51 @@
+from messagebird.base import Base
+from messagebird.base_list import BaseList
+
+
+class ContactReference(Base):
+
+    def __init__(self):
+        self.href = None
+        self.totalCount = None
+
+
+class GroupList(BaseList):
+
+    def __init__(self):
+        # Signal the BaseList that we're expecting items of type Group...
+        super(GroupList, self).__init__(Group)
+
+
+class Group(Base):
+
+    def __init__(self):
+        self.id = None
+        self.href = None
+        self.name = None
+        self._contacts = None
+        self.createdDatetime = None
+        self.updatedDatetime = None
+
+    @property
+    def contacts(self):
+        return self._contacts
+
+    @contacts.setter
+    def contacts(self, value):
+        self._contacts = ContactReference().load(value)
+
+    @property
+    def createdDatetime(self):
+        return self._createdDatetime
+
+    @createdDatetime.setter
+    def createdDatetime(self, value):
+        self._createdDatetime = self.value_to_time(value)
+
+    @property
+    def updatedDatetime(self):
+        return self._updatedDatetime
+
+    @updatedDatetime.setter
+    def updatedDatetime(self, value):
+        self._updatedDatetime = self.value_to_time(value)

tests/test_group.py

@@ -0,0 +1,75 @@
+import unittest
+from messagebird import Client
+
+try:
+    from unittest.mock import Mock
+except ImportError:
+    # mock was added to unittest in Python 3.3, but was an external library
+    # before.
+    from mock import Mock
+
+
+class TestGroup(unittest.TestCase):
+
+    def test_group(self):
+        http_client = Mock()
+        http_client.request.return_value = '{"id": "group-id","href": "https://rest.messagebird.com/groups/group-id","name": "Friends","contacts": {"totalCount": 3,"href": "https://rest.messagebird.com/groups/group-id"},"createdDatetime": "2018-07-25T12:16:10+00:00","updatedDatetime": "2018-07-25T12:16:23+00:00"}'
+
+        group = Client('', http_client).group('group-id')
+
+        http_client.request.assert_called_once_with('groups/group-id', 'GET', None)
+
+        self.assertEqual('Friends', group.name)
+        self.assertEqual(3, group.contacts.totalCount)
+
+    def test_group_create(self):
+        http_client = Mock()
+        http_client.request.return_value = '{}'
+
+        Client('', http_client).group_create('Family', {'foo': 'bar'})
+
+        http_client.request.assert_called_once_with('groups', 'POST', {'name': 'Family', 'foo': 'bar'})
+
+    def test_group_delete(self):
+        http_client = Mock()
+        http_client.request.return_value = ''
+
+        Client('', http_client).group_delete('group-id')
+
+        http_client.request.assert_called_once_with('groups/group-id', 'DELETE', None)
+
+    def test_list(self):
+        http_client = Mock()
+        http_client.request.return_value = '{"offset": 0,"limit": 25,"count": 2,"totalCount": 2,"links": {"first": "https://rest.messagebird.com/groups?offset=0&limit=10","previous": null,"next": null,"last": "https://rest.messagebird.com/groups?offset=0&limit=10"},"items": [{"id": "first-id","href": "https://rest.messagebird.com/groups/first-id","name": "First","contacts": {"totalCount": 3,"href": "https://rest.messagebird.com/groups/first-id/contacts"},"createdDatetime": "2018-07-25T11:47:42+00:00","updatedDatetime": "2018-07-25T14:03:09+00:00"},{"id": "second-id","href": "https://rest.messagebird.com/groups/second-id","name": "Second","contacts": {"totalCount": 4,"href": "https://rest.messagebird.com/groups/second-id/contacts"},"createdDatetime": "2018-07-25T11:47:39+00:00","updatedDatetime": "2018-07-25T14:03:09+00:00"}]}'
+
+        group_list = Client('', http_client).group_list(limit=25, offset=0)
+
+        http_client.request.assert_called_once_with('groups?limit=25&offset=0', 'GET', None)
+
+        self.assertEqual(2, group_list.totalCount)
+        self.assertEqual('https://rest.messagebird.com/groups?offset=0&limit=10', group_list.links.first)
+        self.assertEqual('Second', group_list.items[1].name)
+
+    def test_group_update(self):
+        http_client = Mock()
+        http_client.request.return_value = ''
+
+        Client('', http_client).group_update('group-id', 'friends')
+
+        http_client.request.assert_called_once_with('groups/group-id', 'PATCH', {'name': 'friends'})
+
+    def test_group_add_contacts(self):
+        http_client = Mock()
+        http_client.request.return_value = ''
+
+        Client('', http_client).group_add_contacts('group-id', ['contact-id', 'other-contact-id'])
+
+        http_client.request.assert_called_once_with('groups/group-id?ids[]=contact-id&ids[]=other-contact-id', 'PUT', None)
+
+    def test_group_remove_contact(self):
+        http_client = Mock()
+        http_client.request.return_value = ''
+
+        Client('', http_client).group_remove_contact('group-id', 'contact-id')
+
+        http_client.request.assert_called_once_with('groups/group-id/contacts/contact-id', 'DELETE', None)