Adding events support.

jkeyes · jkeyes · commit 77d20d69a3d2 · 2014-08-22T23:19:51.000+01:00
diff --git a/intercom/__init__.py b/intercom/__init__.py
@@ -47,9 +47,10 @@ def wrapper(instance, value):
 from .note import Note
 from .user import User
 from .tag import Tag
+from .events import Event
 
 __all__ = (
     AuthenticationError, BadGatewayError, Intercom, ResourceNotFound,
     ServerError, ServiceUnavailableError, Impression, MessageThread,
-    Note, User, Tag
+    Note, User, Tag, Event
 )
diff --git a/intercom/events.py b/intercom/events.py
@@ -0,0 +1,40 @@
+# coding=utf-8
+#
+# Copyright 2014 martin@mekkaoui.fr
+#
+# License: MIT
+#
+""" Intercom API wrapper. """
+
+from . import Intercom
+from .user import UserId
+
+
+class Event(UserId):
+
+    @classmethod
+    def create(cls, event_name=None, user_id=None, email=None, metadata=None):
+        resp = Intercom.create_event(event_name=event_name, user_id=user_id, email=email, metadata=metadata)
+        return Event(resp)
+
+    def save(self):
+        """ Create an Event from this objects properties:
+
+        >>> event = Event()
+        >>> event.event_name = "shared-item"
+        >>> event.email = "joe@example.com"
+        >>> event.save()
+
+        """
+        resp = Intercom.create_event(**self)
+        self.update(resp)
+
+    @property
+    def event_name(self):
+        """ The name of the Event. """
+        return dict.get(self, 'event_name', None)
+
+    @event_name.setter
+    def event_name(self, event_name):
+        """ Set the event name. """
+        self['event_name'] = event_name
diff --git a/intercom/intercom.py b/intercom/intercom.py
@@ -19,6 +19,7 @@
 import functools
 import json
 import requests
+import time
 
 DEFAULT_TIMEOUT = 10  # seconds
 
@@ -63,6 +64,8 @@ def wrapper(*args, **kwargs):
         """ Decorator closure. """
         response = func_to_decorate(*args, **kwargs)
         raise_errors_on_failure(response)
+        if not response.content.strip():
+            return ''
         result = json.loads(response.content)
         return result
     return wrapper
@@ -121,19 +124,24 @@ def _create_or_update_user(cls, method, **kwargs):
 
     @classmethod
     def get_users(cls, **kwargs):
-        """ Returns a paginated list of all users in your application on Intercom.
+        """ 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.
+        * ``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
+        * ``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
@@ -146,7 +154,8 @@ def get_users(cls, **kwargs):
         3
 
         """
-        return Intercom._call('GET', Intercom.api_endpoint + 'users', params=kwargs)
+        return Intercom._call(
+            'GET', Intercom.api_endpoint + 'users', params=kwargs)
 
     @classmethod
     def get_user(cls, email=None, user_id=None):
@@ -194,7 +203,8 @@ def create_user(cls, **kwargs):
           unsubscribed status.
 
 
-        >>> user = Intercom.create_user(user_id='7902', email='ben@intercom.io',
+        >>> user = Intercom.create_user(user_id='7902',
+        ... email='ben@intercom.io',
         ... name='Somebody', created_at=1270000000, last_seen_ip='1.2.3.4',
         ... custom_data={ 'app_name': 'Genesis'}, last_request_at=1300000000)
         >>> user['name']
@@ -433,3 +443,22 @@ def get_tag(cls, name=None):
         tag_dict = Intercom._call(
             'GET', Intercom.api_endpoint + 'tags', params=params)
         return tag_dict
+
+    @classmethod
+    def create_event(cls, event_name=None, user_id=None, email=None, metadata=None):
+        """
+        Create an event
+        """
+        params = {
+            'event_name': event_name,
+            'user_id': user_id,
+            'email': email,
+            'created': int(time.time()) 
+         }
+
+        if isinstance(metadata, dict):
+            params['metadata'] = metadata
+
+        call = Intercom._call(
+             'POST', Intercom.api_endpoint + 'events', params=params)
+        return call
