Support for Notes.

jkeyes · jkeyes · commit d1fe3298afb4 · 2013-02-28T10:28:45.000Z
Fixes intercomgh-9.
diff --git a/intercom/__init__.py b/intercom/__init__.py
@@ -17,7 +17,8 @@ def from_timestamp_property(func_to_decorate):
     def wrapper(instance):
         """ Closure that converts from timestamp to datetime. """
         value = func_to_decorate(instance)
-        return datetime.fromtimestamp(value)
+        if value:
+            return datetime.fromtimestamp(value)
     return wrapper
 
 def to_timestamp_property(func_to_decorate):
@@ -26,7 +27,8 @@ def to_timestamp_property(func_to_decorate):
     @functools.wraps(func_to_decorate)
     def wrapper(instance, value):
         """ Closure that converts from datetime to timestamp. """
-        value = time.mktime(value.timetuple())
+        if value:
+            value = time.mktime(value.timetuple())
         func_to_decorate(instance, value)
     return wrapper
 
@@ -37,4 +39,5 @@ def wrapper(instance, value):
 
 from .impression import Impression
 from .message_thread import MessageThread
+from .note import Note
 from .user import User
diff --git a/intercom/intercom.py b/intercom/intercom.py
@@ -191,6 +191,23 @@ def create_impression(cls, user_id=None, email=None, user_ip=None,
                 params=params)
         return user_dict
 
+    @classmethod
+    def create_note(cls, user_id=None, email=None, body=None):
+        """ Create a note.
+
+        >>> result = Intercom.create_note(email="somebody@example.com",
+        ... body="This is the text of my note.")
+        >>> result['html']
+        u'<p>This is the text of my note.</p>'
+        >>> result['user']['email']
+        u'somebody@example.com'
+
+        """
+        params = { 'email': email, 'user_id': user_id, 'body': body }
+        user_dict = Intercom._call('POST', Intercom.api_endpoint + 'users/notes',
+                params=params)
+        return user_dict
+
     @classmethod
     def get_message_threads(cls, user_id=None, email=None, thread_id=None):
         """ If a thread_id is specified, this returns a specific MessageThread
diff --git a/intercom/note.py b/intercom/note.py
@@ -0,0 +1,79 @@
+# coding=utf-8
+#
+# Copyright 2013 keyes.ie
+#
+# License: http://jkeyes.mit-license.org/
+#
+""" Note module. 
+
+>>> from intercom import Intercom
+>>> Intercom.app_id = 'dummy-app-id'
+>>> Intercom.api_key = 'dummy-api-key'
+>>> from intercom import Note
+
+"""
+
+from . import Intercom
+from . import from_timestamp_property
+from .user import User
+from .user import UserId
+
+class Note(UserId):
+    """ A note on a User. """
+
+    @classmethod
+    def create(cls, user_id=None, email=None, body=None):
+        """ Create a Note.
+
+        >>> note = Note.create(email="somebody@example.com", 
+        ...        body="This is the text of my note.")
+        >>> note['created_at']
+        >>> note.html
+        u'<p>This is the text of my note.</p>'
+
+        """
+        resp = Intercom.create_note(user_id=user_id, email=email, body=body)
+        return cls(resp)
+
+    def save(self):
+        """ Create a Note from this objects properties:
+
+        >>> note = Note()
+        >>> note.email = "somebody@example.com"
+        >>> note.body = "This is the text of my note."
+        >>> note.save()
+        >>> note.html
+        u'<p>This is the text of my note.</p>'
+
+        """
+        resp = Intercom.create_note(user_id=self.user_id, email=self.email, body=self.body)
+        self.update(resp)
+
+    @property
+    def body(self):
+        """ The body of the note. """
+        return dict.get(self, 'body', None)
+
+    @body.setter
+    def body(self, body):
+        """ Set the note body. """
+        self['body'] = body
+
+    @property
+    def html(self):
+        """ Get the html of the note – set by an API response. """
+        return dict.get(self, 'html', None)
+
+    @property
+    @from_timestamp_property
+    def created_at(self):
+        """ Returns the datetime this note was created – set by an API response. """
+        return dict.get(self, 'created_at', None)
+
+    @property
+    def user(self):
+        """ Get the noted user – set by an API response. """
+        data = dict.get(self, 'user', None)
+        if data:
+            return User(**data)
+
diff --git a/tests/unit/fixtures/create_note_valid.json b/tests/unit/fixtures/create_note_valid.json
@@ -0,0 +1,45 @@
+{
+    "html": "<p>This is the text of my note.</p>",
+    "created_at": null,
+    "user": {
+        "email": "somebody@example.com",
+        "user_id": "123",
+        "name": "Somebody",
+        "created_at": 1270000000,
+        "last_impression_at": 1300000000,
+        "custom_data": {
+            "app_name": "Genesis",
+            "monthly_spend": 155.5,
+            "team_mates": 7
+        },
+        "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": "127.0.0.1",
+        "last_seen_user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_7_3) AppleWebKit/535.11 (KHTML, like Gecko) Chrome/17.0.963.56 Safari/535.11",
+        "relationship_score": 90,
+        "unsubscribed_from_emails": false
+    }
+}
diff --git a/tests/unit/test_note.py b/tests/unit/test_note.py
@@ -0,0 +1,46 @@
+#
+# Copyright 2013 keyes.ie
+#
+# License: http://jkeyes.mit-license.org/
+#
+
+from mock import patch
+from nose.tools import raises
+from unittest import TestCase
+
+from . import create_response
+
+from intercom.intercom import AuthenticationError
+from intercom import Note
+
+class NoteTest(TestCase):
+
+    @raises(AuthenticationError)
+    @patch('requests.request', create_response(401))
+    def test_create_note_identifiers(self):
+        Note.create()
+
+    @patch('requests.request', create_response(200, 'create_note_valid.json'))
+    def test_create_note_valid(self):
+        note = Note.create(email='xxx@example.com')
+        self.assertEqual("<p>This is the text of my note.</p>", note.html)
+
+        # check params
+        note = Note.create(email='xxx@example.com', body="home")
+        self.assertEqual("<p>This is the text of my note.</p>", note.html)
+
+    def test_properties(self):
+        note = Note()
+        note.body = 'xxx'
+        note.email = 'xxx@example.com'
+        note.user_id = '123'
+
+        self.assertEqual('xxx', note.body)
+        self.assertEqual('xxx@example.com', note.email)
+        self.assertEqual('123', note.user_id)
+
+    @patch('requests.request', create_response(200, 'create_note_valid.json'))
+    def test_save(self):
+        note = Note(email='xxx@example.com')
+        note.save()        
+        self.assertEqual("<p>This is the text of my note.</p>", note.html)
