Implement the delete user functionality.

jkeyes · jkeyes · commit 31d33075d8e6 · 2013-02-28T01:40:29.000Z
Fixes intercomgh-6
diff --git a/intercom/intercom.py b/intercom/intercom.py
@@ -73,9 +73,10 @@ class Intercom(object):
     @api_call
     def _call(cls, method, url, params=None):
         """ Construct an API request, send it to the API, and parse the response. """
+
         req_params = {}
         headers = { 'User-Agent': 'python-intercom/0.2.5', 'Accept': 'application/json' }
-        if method in ('POST', 'PUT'):
+        if method in ('POST', 'PUT', 'DELETE'):
             headers['content-type'] = 'application/json'
             req_params['data'] = json.dumps(params)
         elif method == 'GET':
@@ -160,6 +161,19 @@ def update_user(cls, user_id=None, email=None, name=None, created_at=None,
             name=name, created_at=created_at, custom_data=custom_data,
             last_seen_ip=last_seen_ip, last_seen_user_agent=last_seen_user_agent)
 
+    @classmethod
+    def delete_user(cls, user_id=None, email=None):
+        """ Delete a user.
+
+        >>> user = Intercom.get_user(user_id='7902')
+        >>> user['email']
+        u'bob@example.com'
+
+        """
+        params = { 'email': email, 'user_id': user_id }
+        user_dict = Intercom._call('DELETE', Intercom.api_endpoint + 'users', params)
+        return user_dict
+
     @classmethod
     def create_impression(cls, user_id=None, email=None, user_ip=None,
         user_agent=None, location=None):
diff --git a/intercom/user.py b/intercom/user.py
@@ -109,6 +109,21 @@ def create(cls, user_id=None, email=None, name=None, created_at=None,
                 last_seen_ip=last_seen_ip, last_seen_user_agent=last_seen_user_agent)
         return cls(resp)
 
+    @classmethod
+    def delete(cls, user_id=None, email=None):
+        """ Deletes a user. 
+
+        >>> user = User.delete(email="somebody@example.com")
+        >>> user.user_id
+        u'123'
+        >>> user = User.delete(user_id="123")
+        >>> user.email
+        u'bob@example.com'
+
+        """
+        resp = Intercom.delete_user(user_id=user_id, email=email)
+        return cls(resp)
+
     @classmethod
     def all(cls):
         """ Return all of the Users. 
diff --git a/tests/unit/fixtures/delete_user_valid.json b/tests/unit/fixtures/delete_user_valid.json
@@ -0,0 +1,39 @@
+{
+    "email": "ben@intercom.io",
+    "user_id": "7902",
+    "name": "Ben McRedmond",
+    "created_at": 1257553080,
+    "last_impression_at": 1300000000,
+    "custom_data": {
+      "plan": "pro"
+    },
+    "social_profiles": [
+        {
+            "type": "twitter",
+            "url": "http://twitter.com/abc",
+            "username": "abc"
+        },
+        {
+            "type": "facebook",
+            "url": "http://facebook.com/vanity",
+            "username": "vanity",
+            "id": "13241141441141413"
+        }
+    ],
+    "location_data": {
+        "city_name": "Santiago",
+        "continent_code": "SA",
+        "country_name": "Chile",
+        "latitude": -33.44999999999999,
+        "longitude": -70.6667,
+        "postal_code": "",
+        "region_name": "12",
+        "timezone": "Chile/Continental",
+        "country_code": "CHL"
+    },
+    "session_count": 0,
+    "last_seen_ip": "1.2.3.4",
+    "last_seen_user_agent": "ie6",
+    "relationship_score": 90,
+    "unsubscribed_from_emails": false
+}
diff --git a/tests/unit/test_intercom.py b/tests/unit/test_intercom.py
@@ -32,6 +32,11 @@ def test_create_valid(self):
         self.assertEqual(None, resp['user_id'])
         self.assertEqual('xxx@example.com', resp['email'])
 
+    @patch('requests.request', create_response(200, 'delete_user_valid.json'))
+    def test_delete_valid(self):
+        resp = Intercom.delete_user(email='ben@intercom.io')
+        self.assertEqual('ben@intercom.io', resp['email'])
+
     @raises(AuthenticationError)
     @patch('requests.request', create_response(401))
     def test_get_user_identifiers(self):
