Merge branch 'use_dict_not_custom_class' of https://github.com/joncotton/embedly-python into joncotton-use_dict_not_custom_class

Conflicts:
	embedly/models.py
	embedly/tests.py

Author: screeley

embedly/models.py

@@ -1,65 +1,16 @@
-"""
-Models
-
-Creates a sudo model class that makes it easy to access attributes
-"""
 from __future__ import unicode_literals
-class AttrDict(object):
-    """
-    UserDict is a pain in the ass. Let's just make our own.
-    """
-    def __init__(self, data=None):
-        if data is None:
-            data = {}
-
-        for key, value in data.items():
-            if isinstance(value, dict):
-                data[key] = AttrDict(value)
-            elif isinstance(value, list):
-                values = []
-                for v in value:
-                    if isinstance(v, dict):
-                        values.append(AttrDict(v))
-                    else:
-                        values.append(v)
-                data[key] = values
-
-        self.data = data
-
-    def __getattr__(self, name):
-        if name in ['data', 'method', 'original_url']:
-            return object.__getattr__(self, name)
-        try:
-            return self.data[name]
-        except KeyError:
-            return None
 
-    def __setattr__(self, name, value):
-        if name in ['data', 'method', 'original_url']:
-            object.__setattr__(self, name, value)
-        else:
-            self.data[name] = value
+from UserDict import IterableUserDict
 
-    def __getitem__(self, name): return self.data[name]
-    def __setitem__(self, name, value): self.data[name] = value
-    def __delitem__(self, name): del self.data[name]
-    def __len__(self): return len(self.data)
-    def get(self, name): return self.data.get(name)
-    def keys(self): return self.data.keys()
-    def values(self): return self.data.values()
-    def items(self): return self.data.items()
-
-    @property
-    def dict(self):
-        return self.data
-
-
-class Url(AttrDict):
+class Url(IterableUserDict, object):
+    """
+    A dictionary with two additional attributes for the method and url.
+    UserDict provides a dictionary interface along with the regular
+    dictionary accsesible via the `data` attribute.
 
-    def __init__(self, data=None, method=None, original_url=None):
-        if data is None:
-            data = {}
-        super(Url, self).__init__(data)
+    """
+    def __init__(self, data=None, method=None, original_url=None, **kwargs):
+        super(Url, self).__init__(data, **kwargs)
         self.method = method or 'url'
         self.original_url = original_url
 

embedly/tests.py

@@ -1,5 +1,6 @@
 from __future__ import unicode_literals
 import unittest
+import json
 
 from embedly.client import Embedly
 from embedly.models import Url
@@ -8,7 +9,9 @@
 class EmbedlyTestCase(unittest.TestCase):
     def setUp(self):
         self.key = 'internal'
-        self.data = {
+
+    def test_model(self):
+        data = {
             'provider_url': 'http://www.google.com/',
             'safe': True,
             'description': 'Google',
@@ -29,103 +32,70 @@ def setUp(self):
             'cache_age': 86400,
             'embeds': []
         }
-
-    def test_model(self):
-        obj = Url(self.data, 'preview', 'http://google.com/')
+        obj = Url(data, 'preview', 'http://original.url.com/')
 
         self.assertEqual(len(obj), 16)
         self.assertEqual(len(obj.values()), 16)
         self.assertEqual(len(obj.keys()), 16)
         self.assertEqual(len(obj.items()), 16)
 
-        # look for expected data
+        # check for expected data
         self.assertTrue('type' in obj.keys())
         self.assertTrue('html' in obj.values())
-
-        # adding new data
-        obj['new_key'] = "new value"
-        self.assertEqual(len(obj), 17)
-        self.assertEqual(len(obj.items()), 17)
-        self.assertTrue('new_key' in obj.keys())
-        self.assertTrue('new value' in obj.values())
+        self.assertEqual(obj['type'], 'html')
+        self.assertEqual(obj.get('type'), 'html')
+        self.assertEqual(obj.data['type'], 'html')
+        self.assertEqual(obj.data.get('type'), 'html')
 
         # our special attrs shouldn't be in the data dict
         self.assertFalse('method' in obj.keys())
-        self.assertFalse('original_url' in obj.keys())
-
         with self.assertRaises(KeyError):
             obj['method']
-        with self.assertRaises(KeyError):
-            obj['original_url']
-
-        # attr access = dict access
-        obj.nothing = 'something'
-        self.assertEqual(obj['nothing'], 'something')
-        obj['nothing'] = 'maybe'
-        self.assertEqual(obj.nothing, 'maybe')
-
-        del obj['nothing']
-        self.assertTrue(obj.nothing is None)
-
-    def test_model_attributes(self):
-        obj = Url(self.data, 'preview', 'http://original.url.com/')
 
-        self.assertEqual(obj.method, 'preview')
+        # attrs and data dict values should be separate
         self.assertEqual(obj.original_url, 'http://original.url.com/')
 
-    def test_model_with_empty_data(self):
-        obj = Url()
+        obj.new_attr = 'attr value'
+        obj['new_key'] = 'dict value'
+        self.assertEqual(obj.new_attr, 'attr value')
+        self.assertEqual(obj['new_key'], 'dict value')
 
-        self.assertEqual(obj.data, {})
-        self.assertEqual(obj.method, 'url')
-        self.assertTrue(obj.original_url is None)
-
-    def test_model_data(self):
-        obj = Url(self.data, 'preview', 'http://google.com/')
-
-        self.assertEqual(obj['type'], 'html')
-        self.assertEqual(obj.get('type'), 'html')
-        self.assertEqual(obj.data['type'], 'html')
-        self.assertEqual(obj.data.get('type'), 'html')
-
-        obj['nothing'] = 'something'
-        self.assertEqual(obj['nothing'], 'something')
-        self.assertEqual(obj.get('nothing'), 'something')
-        self.assertEqual(obj.data['nothing'], 'something')
-        self.assertEqual(obj.data.get('nothing'), 'something')
-
-        # deep get attrs
-        self.assertEqual(obj.images[0].width, 275)
-        self.assertTrue(obj.images[0].nothing is None)
-        self.assertTrue(obj.object.type is None)
+    def test_model_data_can_serialize(self):
+        obj = Url({'a': {'key': 'value'}})
+        unserialzed = json.loads(json.dumps(obj.data))
+        self.assertDictEqual(obj.data, unserialzed)
 
     def test_provider(self):
         http = Embedly(self.key)
 
         obj = http.oembed('http://www.scribd.com/doc/13994900/Easter')
-        self.assertEqual(obj.provider_url, 'http://www.scribd.com/')
+
+        self.assertEqual(obj['provider_url'], 'http://www.scribd.com/')
 
         obj = http.oembed('http://www.scribd.com/doc/28452730/Easter-Cards')
-        self.assertEqual(obj.provider_url, 'http://www.scribd.com/')
+        self.assertEqual(obj['provider_url'], 'http://www.scribd.com/')
 
         obj = http.oembed('http://www.youtube.com/watch?v=Zk7dDekYej0')
-        self.assertEqual(obj.provider_url, 'http://www.youtube.com/')
+        self.assertEqual(obj['provider_url'], 'http://www.youtube.com/')
 
         obj = http.oembed('http://yfrog.com/h22eu4j')
-        self.assertEqual(obj.provider_url, 'http://yfrog.com')
+        self.assertEqual(obj['provider_url'], 'http://yfrog.com')
+
 
     def test_providers(self):
         http = Embedly(self.key)
 
         objs = list(http.oembed(['http://www.scribd.com/doc/13994900/Easter',
                                  'http://www.scribd.com/doc/28452730/Easter-Cards']))
-        self.assertEqual(objs[0].provider_url, 'http://www.scribd.com/')
-        self.assertEqual(objs[1].provider_url, 'http://www.scribd.com/')
+
+        self.assertEqual(objs[0]['provider_url'], 'http://www.scribd.com/')
+        self.assertEqual(objs[1]['provider_url'], 'http://www.scribd.com/')
 
         objs = list(http.oembed(['http://www.youtube.com/watch?v=Zk7dDekYej0',
                                  'http://yfrog.com/h22eu4']))
-        self.assertEqual(objs[0].provider_url, 'http://www.youtube.com/')
-        self.assertEqual(objs[1].provider_url, 'http://yfrog.com')
+        self.assertEqual(objs[0]['provider_url'], 'http://www.youtube.com/')
+        self.assertEqual(objs[1]['provider_url'], 'http://yfrog.com')
+
 
     def test_error(self):
         http = Embedly(self.key)
@@ -142,23 +112,25 @@ def test_multi_errors(self):
 
         objs = list(http.oembed(['http://www.embedly.com/this/is/a/bad/url',
                                  'http://blog.embed.ly/alsd/slsdlf/asdlfj']))
-        self.assertEqual(objs[0].type, 'error')
-        self.assertEqual(objs[1].type, 'error')
+
+        self.assertEqual(objs[0]['type'], 'error')
+        self.assertEqual(objs[1]['type'], 'error')
 
         objs = list(http.oembed(['http://blog.embed.ly/lsbsdlfldsf/asdf/kl',
                                  'http://twitpic.com/nothing/to/see/here']))
-        self.assertEqual(objs[0].type, 'error')
-        self.assertEqual(objs[1].type, 'error')
+        self.assertEqual(objs[0]['type'], 'error')
+        self.assertEqual(objs[1]['type'], 'error')
 
         objs = list(http.oembed(['http://blog.embed.ly/lsbsdlfldsf/asdf/kl',
                                  'http://yfrog.com/h22eu4j']))
-        self.assertEqual(objs[0].type, 'error')
-        self.assertEqual(objs[1].type, 'photo')
+        self.assertEqual(objs[0]['type'], 'error')
+        self.assertEqual(objs[1]['type'], 'photo')
 
         objs = list(http.oembed(['http://yfrog.com/h22eu4j',
                                  'http://www.scribd.com/asdf/asdf/asdfasdf']))
-        self.assertEqual(objs[0].type, 'photo')
-        self.assertEqual(objs[1].type, 'error')
+        self.assertEqual(objs[0]['type'], 'photo')
+        self.assertEqual(objs[1]['type'], 'error')
+
 
     def test_exception_on_too_many_urls(self):
         http = Embedly(self.key)