Merge pull request #75 from jkeyes/issue-72

jkeyes · jkeyes · commit 8bcbad017b30 · 2015-04-01T23:14:15.000+01:00
Issue 72 – handle empty response bodies and avoid UnboundLocalErrors.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -2,6 +2,9 @@
 Changelog
 =========
 
+* 2.0.beta (not yet released)
+   * fixed `UnboundLocalError` in `Request.parse_body`.
+   * added support for replies with an empty body.
 * 2.0.alpha
    * support for Intercom API v2
    * support for Python 3
diff --git a/intercom/api_operations/save.py b/intercom/api_operations/save.py
@@ -10,7 +10,8 @@ def create(cls, **params):
         from intercom import Intercom
         collection = utils.resource_class_to_collection_name(cls)
         response = Intercom.post("/%s/" % (collection), **params)
-        return cls(**response)
+        if response:  # may be empty if we received a 202
+            return cls(**response)
 
     def from_dict(self, pdict):
         for key, value in list(pdict.items()):
diff --git a/intercom/request.py b/intercom/request.py
@@ -42,12 +42,15 @@ def send_request_to_path(cls, method, url, auth, params=None):
     @classmethod
     def parse_body(cls, resp):
         try:
-            body = json.loads(resp.content.decode())
+            decoded_body = resp.content.decode()
+            if not decoded_body:  # return early for empty responses (issue-72)
+                return
+            body = json.loads(decoded_body)
+            if body.get('type') == 'error.list':
+                cls.raise_application_errors_on_failure(body, resp.status_code)
+            return body
         except ValueError:
             cls.raise_errors_on_failure(resp)
-        if body.get('type') == 'error.list':
-            cls.raise_application_errors_on_failure(body, resp.status_code)
-        return body
 
     @classmethod
     def set_rate_limit_details(cls, resp):
diff --git a/tests/integration/issues/__init__.py b/tests/integration/issues/__init__.py
@@ -0,0 +1 @@
+# -*- coding: utf-8 -*-
diff --git a/tests/integration/issues/test_72.py b/tests/integration/issues/test_72.py
@@ -0,0 +1,25 @@
+# -*- coding: utf-8 -*-
+
+import os
+import unittest
+import time
+from intercom import Intercom
+from intercom import Event
+from intercom import User
+
+Intercom.app_id = os.environ.get('INTERCOM_APP_ID')
+Intercom.app_api_key = os.environ.get('INTERCOM_APP_API_KEY')
+
+
+class Issue72Test(unittest.TestCase):
+
+    def test(self):
+        User.create(email='me@example.com')
+        # no exception here as empty response expected
+        data = {
+            'event_name': 'Eventful 1',
+            'created_at': int(time.time()),
+            'email': 'me@example.com'
+        }
+        print data
+        Event.create(**data)
diff --git a/tests/unit/test_event.py b/tests/unit/test_event.py
@@ -1,21 +1,16 @@
 # -*- coding: utf-8 -*-
 
 import httpretty
-import json
-import re
 import time
 import unittest
 
 from datetime import datetime
 from intercom import User
+from intercom import Intercom
 from intercom import Event
-from nose.tools import eq_
-from nose.tools import ok_
+from mock import patch
 from nose.tools import istest
 
-post = httpretty.POST
-r = re.compile
-
 
 class EventTest(unittest.TestCase):
 
@@ -29,7 +24,6 @@ def setUp(self):  # noqa
         self.created_time = now - 300
 
     @istest
-    @httpretty.activate
     def it_creates_an_event_with_metadata(self):
         data = {
             'event_name': 'Eventful 1',
@@ -41,13 +35,10 @@ def it_creates_an_event_with_metadata(self):
                 'found_date': 12909364407
             }
         }
-        httpretty.register_uri(
-            post, r(r'/events/$'), body=json.dumps(data), status=202)
-        event = Event.create(**data)
 
-        eq_('Eventful 1', event.event_name)
-        ok_(hasattr(event, 'metadata'))
-        eq_('pi@example.com', event.metadata['invitee_email'])
+        with patch.object(Intercom, 'post', return_value=data) as mock_method:
+            Event.create(**data)
+            mock_method.assert_called_once_with('/events/', **data)
 
     @istest
     @httpretty.activate
@@ -56,9 +47,6 @@ def it_creates_an_event_without_metadata(self):
             'event_name': 'sale of item',
             'email': 'joe@example.com',
         }
-        httpretty.register_uri(
-            post, r(r'/events/$'), body=json.dumps(data), status=202)
-        event = Event.create(**data)
-
-        eq_('sale of item', event.event_name)
-        ok_(not hasattr(event, 'metadata'))
+        with patch.object(Intercom, 'post', return_value=data) as mock_method:
+            Event.create(**data)
+            mock_method.assert_called_once_with('/events/', **data)
