Merged pull request from @sdorazio which fixes the User.all

jkeyes · jkeyes · commit 38a6d0a87e65 · 2013-08-10T22:38:58.000+01:00
method to return all users and adds ``unsubscribed_from_emails``
attribute to ``User``.

Removed change to ``User.all`` that added named parameters.
diff --git a/intercom/intercom.py b/intercom/intercom.py
@@ -110,9 +110,24 @@ def _create_or_update_user(cls, method, **kwargs):
         return user_dict
 
     @classmethod
-    def get_users(cls, page=None, per_page=None, tag_id=None, tag_name=None):
-        """ Return a dict for the user represented by the specified email
-        or user_id.
+    def get_users(cls, **kwargs):
+        """ 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,27 +136,7 @@ def get_users(cls, page=None, per_page=None, tag_id=None, tag_name=None):
         3
 
         """
-
-        # collate parameters
-        params = {}
-
-        if page:
-            params['page'] = page
-
-        if per_page:
-            # if per_page is outside bounds use default
-            if per_page < 1 or per_page > 500:
-                per_page = 500
-            params['per_page'] = per_page
-
-        if tag_id:
-            params['tag_id'] = tag_id
-
-        if tag_name:
-            params['tag_name'] = tag_name
-
-        user_dict = Intercom._call('GET', Intercom.api_endpoint + 'users', params=params)
-        return user_dict
+        return Intercom._call('GET', Intercom.api_endpoint + 'users', params=kwargs)
 
     @classmethod
     def get_user(cls, email=None, user_id=None):
@@ -186,7 +181,8 @@ def create_user(
     @classmethod
     def update_user(
             cls, user_id=None, email=None, name=None, created_at=None,
-            custom_data=None, last_seen_ip=None, last_seen_user_agent=None):
+            custom_data=None, last_seen_ip=None, last_seen_user_agent=None,
+            unsubscribed_from_emails=None):
         """ Update a user with the available parameters.
 
         >>> user = Intercom.get_user(user_id='123')
@@ -201,7 +197,8 @@ def update_user(
             'PUT', user_id=user_id, email=email, name=name,
             created_at=created_at, custom_data=custom_data,
             last_seen_ip=last_seen_ip,
-            last_seen_user_agent=last_seen_user_agent)
+            last_seen_user_agent=last_seen_user_agent,
+            unsubscribed_from_emails=unsubscribed_from_emails)
 
     @classmethod
     def delete_user(cls, user_id=None, email=None):
diff --git a/intercom/user.py b/intercom/user.py
@@ -49,7 +49,7 @@ class User(UserId):
 
     attributes = (
         'user_id', 'email', 'name', 'created_at', 'custom_data',
-        'last_seen_ip', 'last_seen_user_agent')
+        'last_seen_ip', 'last_seen_user_agent', 'unsubscribed_from_emails')
 
     @classmethod
     def find(cls, user_id=None, email=None):
@@ -131,7 +131,7 @@ def delete(cls, user_id=None, email=None):
         return cls(resp)
 
     @classmethod
-    def all(cls, page=None, per_page=None, tag_id=None, tag_name=None):
+    def all(cls):
         """ Return all of the Users.
 
         >>> users = User.all()
@@ -141,9 +141,15 @@ def all(cls, page=None, per_page=None, tag_id=None, tag_name=None):
         u'first.user@example.com'
 
         """
-        resp = Intercom.get_users(
-            page=page, per_page=per_page, tag_id=tag_id, tag_name=tag_name)
-        return [cls(u) for u in resp['users']]
+        page = 1
+        total_pages = 1
+        users = []
+        while page <= total_pages:
+            resp = Intercom.get_users(page=page)
+            page += 1
+            total_pages = resp.get('total_pages', 0)
+            users.extend([cls(u) for u in resp['users']])
+        return users
 
     def save(self):
         """ Creates or updates a User.
@@ -158,7 +164,7 @@ def save(self):
         attrs = {}
         for key in User.attributes:
             value = dict.get(self, key)
-            if value:
+            if value is not None:
                 attrs[key] = value
         resp = Intercom.update_user(**attrs)
         self.update(resp)
@@ -263,6 +269,16 @@ def location_data(self):
             dict.__setitem__(self, 'location_data', data)
         return data
 
+    @property
+    def unsubscribed_from_emails(self):
+        """ Returns whether or not the user has unsubscribed from emails """
+        return dict.get(self, 'unsubscribed_from_emails', None)
+
+    @unsubscribed_from_emails.setter
+    def unsubscribed_from_emails(self, unsubscribed_from_emails):
+        """  Sets whether or not the user has unsubscribed from email """
+        self['unsubscribed_from_emails'] = unsubscribed_from_emails
+
     @property
     def custom_data(self):
         """ Returns a CustomData object for this User.
diff --git a/tests/unit/__init__.py b/tests/unit/__init__.py
@@ -33,7 +33,6 @@ def _call(*args, **kwargs):
             reply[name] = value
         for name, value in params.items():
             reply[name] = value
-
         response.content = json.dumps(reply)
         response.status_code = 200
         return response
diff --git a/tests/unit/test_user.py b/tests/unit/test_user.py
@@ -172,18 +172,6 @@ def test_get_users_valid(self):
         self.assertEqual('foobloggs@example.com', users[1].email)
         self.assertEqual('barbloggs@example.com', users[2].email)
 
-    @patch('requests.request', local_response(users=[]))
-    def test_get_users_params(self):
-        resp = User.all()
-        resp = User.all(page=20)
-        resp = User.all(per_page=10)
-        resp = User.all(tag_id=100)
-        resp = User.all(tag_name="starter")
-        try:
-            resp = User.all(no_such_param="value")
-        except TypeError:
-            pass
-
     def test_properties(self):
         user = User()
         user.email = 'xxx@example.com'
