Adding support for per_page, page, tag_id, and tag_name.

jkeyes · jkeyes · commit 410deeadb23c · 2013-08-10T22:33:23.000+01:00
Also adding unsubscribed_from_emails attribute to User. Thanks https://github.com/sdorazio
diff --git a/intercom/intercom.py b/intercom/intercom.py
@@ -111,8 +111,23 @@ def _create_or_update_user(cls, method, **kwargs):
 
     @classmethod
     def get_users(cls, **kwargs):
-        """ Return a dict for the user represented by the specified email
-        or user_id.
+        """ Returns a paginated list of all users in your application on Intercom.
+
+        **Arguments**
+
+        * ``page``: optional (defaults to 1)
+        * ``per_page``: optional (defaults to 500, max value of 500)
+        * ``tag_id``: optional — query for users that are tagged with a specific tag.
+        * ``tag_name``: optional — query for users that are tagged with a specific tag.
+
+        **Response**
+
+        * ``users``: an array of User objects (same as returned by getting a single User)
+        * ``total_count``: the total number of Users tracked in your Intercom application
+        * ``page``: the current requested page
+        * ``next_page``: the next page number, if any
+        * ``previous_page``: the previous page number, if any
+        * ``total_pages``: the total number of pages
 
         >>> result = Intercom.get_users()
         >>> type(result)
@@ -121,8 +136,7 @@ def get_users(cls, **kwargs):
         3
 
         """
-        user_dict = Intercom._call('GET', Intercom.api_endpoint + 'users', params=kwargs)
-        return user_dict
+        return Intercom._call('GET', Intercom.api_endpoint + 'users', params=kwargs)
 
     @classmethod
     def get_user(cls, email=None, user_id=None):
diff --git a/intercom/user.py b/intercom/user.py
@@ -147,7 +147,7 @@ def all(cls):
         while page <= total_pages:
             resp = Intercom.get_users(page=page)
             page += 1
-            total_pages = resp['total_pages']
+            total_pages = resp.get('total_pages', 0)
             users.extend([cls(u) for u in resp['users']])
         return users
 
diff --git a/tests/unit/__init__.py b/tests/unit/__init__.py
@@ -5,13 +5,15 @@
 # License: http://jkeyes.mit-license.org/
 #
 
+import json
 import os
 
 from mock import Mock
 
 DIRPATH = os.path.dirname(__file__)
 FIXTURES = os.path.join(DIRPATH, 'fixtures')
 
+
 def create_response(status, fixture=None):
     def request(*args, **kwargs):
         response = Mock()
@@ -21,3 +23,15 @@ def request(*args, **kwargs):
             response.content = open(fixture_path).read()
         return response
     return request
+
+
+def local_response():
+    def _call(*args, **kwargs):
+        response = Mock()
+        reply = {}
+        for name, value in kwargs.items():
+            reply[name] = value
+        response.content = json.dumps(reply)
+        response.status_code = 200
+        return response
+    return _call
diff --git a/tests/unit/test_intercom.py b/tests/unit/test_intercom.py
@@ -7,8 +7,11 @@
 
 
 from . import create_response
+from . import local_response
 from mock import patch
 from nose.tools import raises
+from nose.tools import eq_
+from nose.tools import ok_
 from unittest import TestCase
 
 from intercom import ServerError
@@ -79,3 +82,32 @@ def test_api_error(self):
     @patch('requests.request', create_response(500, 'invalid.json'))
     def test_api_error_when_json_is_invalid(self):
         Intercom.get_users()
+
+    @patch('requests.request', local_response())
+    def test_get_users_params(self):
+        resp = Intercom.get_users()
+        ok_('params' in resp)
+        ok_('page' not in resp['params'])
+        ok_('per_page' not in resp['params'])
+        ok_('tag_id' not in resp['params'])
+        ok_('tag_id' not in resp['params'])
+
+        resp = Intercom.get_users(page=20)
+        ok_('params' in resp)
+        ok_('page' in resp['params'])
+        eq_(resp['params']['page'], 20)
+
+        resp = Intercom.get_users(per_page=10)
+        ok_('params' in resp)
+        ok_('per_page' in resp['params'])
+        eq_(resp['params']['per_page'], 10)
+
+        resp = Intercom.get_users(tag_id=100)
+        ok_('params' in resp)
+        ok_('tag_id' in resp['params'])
+        eq_(resp['params']['tag_id'], 100)
+
+        resp = Intercom.get_users(tag_name="starter")
+        ok_('params' in resp)
+        ok_('tag_name' in resp['params'])
+        eq_(resp['params']['tag_name'], "starter")
