Merge pull request #20 from messagebird/add-contacts

Add contacts

Author: dysosmus

messagebird/__init__.py

@@ -1 +1 @@
-from messagebird.client import Client
+from messagebird.client import Client, ErrorException

messagebird/base_list.py

@@ -0,0 +1,45 @@
+from messagebird.base import Base
+
+
+class Links(Base):
+
+    def __init__(self):
+        self.first = None
+        self.previous = None
+        self.next = None
+        self.last = None
+
+
+class BaseList(Base):
+
+    def __init__(self, item_type):
+        """When setting items, they are instantiated as objects of type item_type."""
+        self.limit = None
+        self.offset = None
+        self.count = None
+        self.totalCount = None
+        self._links = None
+        self._items = None
+
+        self.itemType = item_type
+
+    @property
+    def links(self):
+        return self._links
+
+    @links.setter
+    def links(self, value):
+        self._links = Links().load(value)
+
+    @property
+    def items(self):
+        return self._items
+
+    @items.setter
+    def items(self, value):
+        """Create typed objects from the dicts."""
+        items = []
+        for item in value:
+            items.append(self.itemType().load(item))
+
+        self._items = items

messagebird/client.py

@@ -3,6 +3,7 @@
 
 from messagebird.base         import Base
 from messagebird.balance      import Balance
+from messagebird.contact      import Contact, ContactList
 from messagebird.error        import Error
 from messagebird.hlr          import HLR
 from messagebird.http_client  import HttpClient
@@ -43,6 +44,24 @@ def request(self, path, method='GET', params=None):
 
     return response_json
 
+  def request_plain_text(self, path, method='GET', params=None):
+    """Builds a request, gets a response and returns the body."""
+    response_text = self.http_client.request(path, method, params)
+
+    try:
+      # Try to decode the response to JSON to see if the API returned any
+      # errors.
+      response_json = json.loads(response_text)
+
+      if 'errors' in response_json:
+        raise (ErrorException([Error().load(e) for e in response_json['errors']]))
+    except ValueError:
+      # Do nothing: json.loads throws if the input string is not valid JSON,
+      # which is expected. We'll just return the response body below.
+      pass
+
+    return response_text
+
   def balance(self):
     """Retrieve your balance."""
     return Balance().load(self.request('balance'))
@@ -109,3 +128,22 @@ def verify_create(self, recipient, params=None):
   def verify_verify(self, id, token):
     """Verify the token of a specific verification."""
     return Verify().load(self.request('verify/' + str(id), params={'token': token}))
+
+  def contact(self, id):
+    """Retrieve the information of a specific contact."""
+    return Contact().load(self.request('contacts/' + str(id)))
+
+  def contact_create(self, phonenumber, params=None):
+    if params is None: params = {}
+    params.update({'msisdn': phonenumber})
+    return Contact().load(self.request('contacts', 'POST', params))
+
+  def contact_delete(self, id):
+    self.request_plain_text('contacts/' + str(id), 'DELETE')
+
+  def contact_update(self, id, params=None):
+    self.request_plain_text('contacts/' + str(id), 'PATCH', params)
+
+  def contact_list(self, limit=0, offset=0):
+    query = 'limit='+str(limit)+'&offset='+str(offset)
+    return ContactList().load(self.request('contacts?'+query, 'GET', None))

messagebird/contact.py

@@ -0,0 +1,87 @@
+from messagebird.base import Base
+from messagebird.base_list import BaseList
+
+
+class CustomDetails(Base):
+
+    def __init__(self):
+        self.custom1 = None
+        self.custom2 = None
+        self.custom3 = None
+        self.custom4 = None
+
+
+class GroupReference(Base):
+
+    def __init__(self):
+        self.href = None
+        self.totalCount = None
+
+
+class MessageReference(Base):
+
+    def __init__(self):
+        self.href = None
+        self.totalCount = None
+
+
+class ContactList(BaseList):
+
+    def __init__(self):
+        # Signal the BaseList that we're expecting items of type Contact...
+        super(ContactList, self).__init__(Contact)
+
+
+class Contact(Base):
+
+    def __init__(self):
+        self.id = None
+        self.href = None
+        self.msisdn = None
+        self.firstName = None
+        self.lastName = None
+        self._customDetails = None
+        self._groups = None
+        self._messages = None
+        self._createdDatetime = None
+        self._updatedDatetime = None
+
+    @property
+    def customDetails(self):
+        return self._customDetails
+
+    @customDetails.setter
+    def customDetails(self, value):
+        self._customDetails = CustomDetails().load(value)
+
+    @property
+    def groups(self):
+        return self._groups
+
+    @groups.setter
+    def groups(self, value):
+        self._groups = GroupReference().load(value)
+
+    @property
+    def messages(self):
+        return self._messages
+
+    @messages.setter
+    def messages(self, value):
+        self._messages = MessageReference().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_contact.py

@@ -0,0 +1,70 @@
+import unittest
+from messagebird import Client, ErrorException
+
+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 TestContact(unittest.TestCase):
+
+    def test_contact(self):
+        http_client = Mock()
+        http_client.request.return_value = '{"id": "contact-id","href": "https://rest.messagebird.com/contacts/contact-id","msisdn": 31612345678,"firstName": "Foo","lastName": "Bar","customDetails": {"custom1": "First","custom2": "Second","custom3": "Third","custom4": "Fourth"},"groups": {"totalCount": 3,"href": "https://rest.messagebird.com/contacts/contact-id/groups"},"messages": {"totalCount": 5,"href": "https://rest.messagebird.com/contacts/contact-id/messages"},"createdDatetime": "2018-07-13T10:34:08+00:00","updatedDatetime": "2018-07-13T10:44:08+00:00"}'
+
+        contact = Client('', http_client).contact('contact-id')
+
+        http_client.request.assert_called_once_with('contacts/contact-id', 'GET', None)
+
+        self.assertEqual(31612345678, contact.msisdn)
+        self.assertEqual('First', contact.customDetails.custom1)
+        self.assertEqual(3, contact.groups.totalCount)
+        self.assertEqual('https://rest.messagebird.com/contacts/contact-id/messages', contact.messages.href)
+
+    def test_contact_create(self):
+        http_client = Mock()
+        http_client.request.return_value = '{}'
+
+        Client('', http_client).contact_create(31612345678, {'firstName': 'Foo', 'custom3': 'Third'})
+
+        http_client.request.assert_called_once_with('contacts', 'POST', {'msisdn': 31612345678, 'firstName': 'Foo', 'custom3': 'Third'})
+
+    def test_contact_delete(self):
+        http_client = Mock()
+        http_client.request.return_value = ''
+
+        Client('', http_client).contact_delete('contact-id')
+
+        http_client.request.assert_called_once_with('contacts/contact-id', 'DELETE', None)
+
+    def test_contact_delete_invalid(self):
+        http_client = Mock()
+        http_client.request.return_value = '{"errors": [{"code": 20,"description": "contact not found","parameter": null}]}'
+
+        with self.assertRaises(ErrorException):
+            Client('', http_client).contact_delete('non-existent-contact-id')
+
+        http_client.request.assert_called_once_with('contacts/non-existent-contact-id', 'DELETE', None)
+
+    def test_contact_update(self):
+        http_client = Mock()
+        http_client.request.return_value = ''
+
+        Client('', http_client).contact_update('contact-id', {'msisdn': 31687654321, 'custom4': 'fourth'})
+
+        http_client.request.assert_called_once_with('contacts/contact-id', 'PATCH', {'msisdn': 31687654321, 'custom4': 'fourth'})
+
+    def test_contact_list(self):
+        http_client = Mock()
+        http_client.request.return_value = '{"offset": 0,"limit": 20,"count": 2,"totalCount": 2,"links": {"first": "https://rest.messagebird.com/contacts?offset=0","previous": null,"next": null,"last": "https://rest.messagebird.com/contacts?offset=0"},"items": [{"id": "first-id","href": "https://rest.messagebird.com/contacts/first-id","msisdn": 31612345678,"firstName": "Foo","lastName": "Bar","customDetails": {"custom1": null,"custom2": null,"custom3": null,"custom4": null},"groups": {"totalCount": 0,"href": "https://rest.messagebird.com/contacts/first-id/groups"},"messages": {"totalCount": 0,"href": "https://rest.messagebird.com/contacts/first-id/messages"},"createdDatetime": "2018-07-13T10:34:08+00:00","updatedDatetime": "2018-07-13T10:34:08+00:00"},{"id": "second-id","href": "https://rest.messagebird.com/contacts/second-id","msisdn": 49612345678,"firstName": "Hello","lastName": "World","customDetails": {"custom1": null,"custom2": null,"custom3": null,"custom4": null},"groups": {"totalCount": 0,"href": "https://rest.messagebird.com/contacts/second-id/groups"},"messages": {"totalCount": 0,"href": "https://rest.messagebird.com/contacts/second-id/messages"},"createdDatetime": "2018-07-13T10:33:52+00:00","updatedDatetime": null}]}'
+
+        contact_list = Client('', http_client).contact_list(10, 20)
+
+        http_client.request.assert_called_once_with('contacts?limit=10&offset=20', 'GET', None)
+
+        self.assertEqual(2, contact_list.totalCount)
+        self.assertEqual('https://rest.messagebird.com/contacts?offset=0', contact_list.links.first)
+        self.assertEqual('https://rest.messagebird.com/contacts/first-id/groups', contact_list.items[0].groups.href)