Adding support for last_request_at to User, create_user, and update_user.

jkeyes · jkeyes · commit d9fdde9c9360 · 2013-08-10T23:44:17.000+01:00
Fixes intercom#16
diff --git a/intercom/intercom.py b/intercom/intercom.py
@@ -155,34 +155,53 @@ def get_user(cls, email=None, user_id=None):
         return user_dict
 
     @classmethod
-    def create_user(
-            cls, user_id=None, email=None, name=None, created_at=None,
-            custom_data=None, last_seen_ip=None, last_seen_user_agent=None):
-        """ Create a user from the available parameters.
+    def create_user(cls, **kwargs):
+        """ Creates a user.
+
+        N.B. Social and geo location data is fetched asynchronously, so a
+        secondary call to users will be required to fetch it.
+
+        **Arguments**
+
+        - ``user_id``: required (if no email) — a unique string identifier
+          for the user
+        - ``email``: required (if no user_id) — the user's email address
+        - ``name``: The user's full name
+        - ``created_at``: A UNIX timestamp representing the date the user was
+          created
+        - ``custom_data``: A hash of key/value pairs containing any other data
+          about the user you want Intercom to store.
+        - ``last_seen_ip``: An ip address (e.g. "1.2.3.4") representing the
+          last ip address the user visited your application from. (Used for
+          updating location_data)
+        - ``last_seen_user_agent``: The user agent the user last visited your
+          application with.
+        - ``companies``: An array of hashes describing the companies this user
+          belongs to. Currently companies are not returned in the response.
+        - ``last_request_at or last_impression_at``: A UNIX timestamp
+          representing the date the user last visited your application.
+        - ``unsubscribed_from_emails``: A boolean value representing the users
+          unsubscribed status.
+
 
         >>> from datetime import datetime
         >>> import time
         >>> now = time.mktime(datetime.now().timetuple())
         >>> user = Intercom.create_user(user_id='987', email='joe@example.com',
         ... name='Joe Example', created_at=now, last_seen_ip='10.10.10.10',
-        ... custom_data={ 'job_type': 'smuggler'})
+        ... custom_data={ 'job_type': 'smuggler'}, last_request_at=1350000000)
         >>> user['name']
         u'Joe Example'
         >>> user['custom_data']['job_type']
         u'smuggler'
+        >>> user['last_impression_at']
+        1350000000
 
         """
-        return Intercom._create_or_update_user(
-            'POST', 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)
+        return Intercom._create_or_update_user('POST', **kwargs)
 
     @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,
-            unsubscribed_from_emails=None):
+    def update_user(cls, **kwargs):
         """ Update a user with the available parameters.
 
         >>> user = Intercom.get_user(user_id='123')
@@ -193,12 +212,7 @@ def update_user(
         u'Han'
 
         """
-        return Intercom._create_or_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,
-            unsubscribed_from_emails=unsubscribed_from_emails)
+        return Intercom._create_or_update_user('PUT', **kwargs)
 
     @classmethod
     def delete_user(cls, user_id=None, email=None):
diff --git a/intercom/user.py b/intercom/user.py
@@ -49,7 +49,8 @@ class User(UserId):
 
     attributes = (
         'user_id', 'email', 'name', 'created_at', 'custom_data',
-        'last_seen_ip', 'last_seen_user_agent', 'unsubscribed_from_emails')
+        'last_seen_ip', 'last_seen_user_agent', 'last_impression_at',
+        'last_request_at', 'unsubscribed_from_emails')
 
     @classmethod
     def find(cls, user_id=None, email=None):
@@ -99,20 +100,17 @@ def find_by_user_id(cls, user_id):
         return cls(resp)
 
     @classmethod
-    def create(
-            cls, user_id=None, email=None, name=None, created_at=None,
-            custom_data=None, last_seen_ip=None, last_seen_user_agent=None):
+    def create(cls, **kwargs):
         """ Create or update a user.
 
-        >>> user = User.create(email="somebody@example.com")
+        >>> user = User.create(email="somebody@example.com",last_impression_at=1400000000)
         >>> user.name
         u'Somebody'
+        >>> user.last_impression_at.year
+        2014
 
         """
-        resp = Intercom.create_user(
-            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)
+        resp = Intercom.create_user(**kwargs)
         return cls(resp)
 
     @classmethod
@@ -199,6 +197,18 @@ def last_seen_user_agent(self, last_seen_user_agent):
         """ Sets the last seen User Agent. """
         self['last_seen_user_agent'] = last_seen_user_agent
 
+    @property
+    def last_request_at(self):
+        """ Get last time this User interacted with your application. """
+        return dict.get(self, 'last_request_at', None)
+
+    @last_request_at.setter
+    @to_timestamp_property
+    def last_request_at(self, last_request_at):
+        """ Set time at which this User last made a request your application.
+        """
+        self['last_request_at'] = last_request_at
+
     @property
     def relationship_score(self):
         """ Returns the relationship score. """
@@ -216,6 +226,13 @@ def last_impression_at(self):
         """ Returns the datetime this User last used your application. """
         return dict.get(self, 'last_impression_at', None)
 
+    @last_impression_at.setter
+    @to_timestamp_property
+    def last_impression_at(self, last_impression_at):
+        """ Set time at which this User last made a request your application.
+        """
+        self['last_impression_at'] = last_impression_at
+
     @property
     @from_timestamp_property
     def created_at(self):
