Changed LocationData from a dict to a LocationData object for consistency.

jkeyes · jkeyes · commit 6b6b2e58dc5c · 2012-03-21T01:20:31.000Z
Added missing __init__.py files (error in my .gitignore).
diff --git a/.gitignore b/.gitignore
@@ -5,7 +5,7 @@ venv
 *.egg-info
 *.pyc
 .DS_Store
-_*
+docs/_build
 
 intercom.sublime-project
 intercom.sublime-workspace
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,8 +1,3 @@
-.. intercom documentation master file, created by
-   sphinx-quickstart on Tue Mar 20 09:38:03 2012.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
 ========
 intercom
 ========
diff --git a/intercom/user.py b/intercom/user.py
@@ -127,7 +127,11 @@ def social_profiles(self):
 
     @property
     def location_data(self):
-        return dict.get(self, 'location_data', None)
+        data = dict.get(self, 'location_data', None)
+        if not isinstance(data, LocationData):
+            data = LocationData(data)
+            dict.__setitem__(self, 'location_data', data)
+        return data
 
     @property
     def custom_data(self):
@@ -181,3 +185,46 @@ def username(self):
     def __setitem__(self, key, value):
         """ Do not allow items to be set. """
         raise NotImplementedError
+
+class LocationData(dict):
+    """ Object representing a user's location data """
+
+    @property
+    def city_name(self):
+        return self.get('city_name', None)
+
+    @property
+    def continent_code(self):
+        return self.get('continent_code', None)
+
+    @property
+    def country_name(self):
+        return self.get('country_name', None)
+
+    @property
+    def latitude(self):
+        return self.get('latitude', None)
+
+    @property
+    def longitude(self):
+        return self.get('longitude', None)
+
+    @property
+    def postal_code(self):
+        return self.get('postal_code', None)
+
+    @property
+    def region_name(self):
+        return self.get('region_name', None)
+
+    @property
+    def timezone(self):
+        return self.get('timezone', None)
+
+    @property
+    def country_code(self):
+        return self.get('country_code', None)
+
+    def __setitem__(self, key, value):
+        """ Do not allow items to be set. """
+        raise NotImplementedError
diff --git a/tests/integration/__init__.py b/tests/integration/__init__.py
diff --git a/tests/unit/__init__.py b/tests/unit/__init__.py
@@ -0,0 +1,23 @@
+#
+# Copyright 2012 keyes.ie
+#
+# License: http://jkeyes.mit-license.org/
+#
+
+import os
+
+from os import environ as ENV
+from mock import Mock
+
+DIRPATH = os.path.dirname(__file__)
+FIXTURES = os.path.join(DIRPATH, 'fixtures')
+
+def create_response(status, fixture=None):
+    def request(*args, **kwargs):
+        response = Mock()
+        response.status_code = status
+        if fixture:
+            fixture_path = os.path.join(FIXTURES, fixture)
+            response.content = open(fixture_path).read()
+        return response
+    return request
diff --git a/tests/unit/test_user.py b/tests/unit/test_user.py
@@ -16,6 +16,7 @@
 
 from intercom.intercom import AuthError
 from intercom.user import CustomData
+from intercom.user import LocationData
 from intercom.user import SocialProfile
 from intercom.user import User
 
@@ -132,11 +133,14 @@ def test_find_by_email(self):
                 time.mktime(user.created_at.timetuple()))
         self.assertTrue(1, len(user.social_profiles))
         profile = user.social_profiles[0]
+        self.assertTrue(isinstance(profile, SocialProfile))
         self.assertEqual('twitter', profile.type)
         self.assertEqual('foo', profile.username)
         self.assertEqual('http://twitter.com/foo', profile.url)
         self.assertEqual('1234567', profile.id)
         self.assertEqual('Santiago', user.location_data['city_name'])
+        self.assertEqual('Santiago', user.location_data.city_name)
+        self.assertTrue(isinstance(user.location_data, LocationData))
         self.assertEqual('johnny', user.custom_data['nick'])
 
     @patch('requests.request', create_response(200, 'get_user_id_valid.json'))
@@ -186,3 +190,38 @@ def test_properties(self):
         self.assertEqual(1331764344, 
                 time.mktime(user.created_at.timetuple()))
         self.assertEqual('Ace', user.custom_data['name'])
+
+class LocationDataTest(TestCase):
+
+    @raises(AttributeError)
+    def test_setattr(self):
+        location_data = LocationData()
+        location_data.city_name = "Dublin"
+
+    @raises(NotImplementedError)
+    def test_setitem(self):
+        location_data = LocationData()
+        location_data['city_name'] = "Dublin"
+
+    def test_properties(self):
+        location_data = LocationData({
+            "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"
+        })
+
+        self.assertEqual('Santiago', location_data.city_name)
+        self.assertEqual('SA', location_data.continent_code)
+        self.assertEqual('Chile', location_data.country_name)
+        self.assertEqual(-33.44999999999999, location_data.latitude)
+        self.assertEqual(-70.6667, location_data.longitude)
+        self.assertEqual('', location_data.postal_code)
+        self.assertEqual('12', location_data.region_name)
+        self.assertEqual('Chile/Continental', location_data.timezone)
+        self.assertEqual('CHL', location_data.country_code)
