Add __getattr__ to GitHubObject class

itsmemattchung · itsmemattchung · commit e4dc72fb5615 · 2015-12-17T14:17:02.000Z
In github3.users.Key._update_attributes does not set the attribute verified.  Without explicitly updating, we can access the json attribute with __getattr__ on the base class

Unit tests have been added to verify that base class attributes are affected by the change. Another pull request will handle migrating existing test cases in tests/test_models
diff --git a/github3/models.py b/github3/models.py
@@ -39,6 +39,14 @@ def __init__(self, json):
     def _update_attributes(self, json):
         pass
 
+    def __getattr__(self, attribute):
+        """Proxy access to stored JSON."""
+        if attribute not in self._json_data:
+            raise AttributeError(attribute)
+        value = self._json_data.get(attribute, None)
+        setattr(self, attribute, value)
+        return value
+
     def as_dict(self):
         """Return the attributes for this object as a dictionary.
 
diff --git a/tests/unit/test_models.py b/tests/unit/test_models.py
@@ -0,0 +1,41 @@
+import github3
+import pytest
+import mock
+from .helper import create_example_data_helper
+
+get_user_key_example_data = create_example_data_helper('user_key_example')
+
+
+class TestGitHubObject:
+    """Test methods on GitHubObject class."""
+
+    def test_getattr(self):
+        """Test access to JSON data if attribute is not explicitly set."""
+
+        key = github3.users.Key(get_user_key_example_data())
+        # verified attribute is not set in _update_attributes for Key class
+        with pytest.raises(KeyError):
+            key.__dict__['verified']
+
+        assert key.verified is True
+
+    def test_getattr_attribute_not_in_json(self):
+        """Test AttributeError is raised when attribute is not in JSON."""
+        key = github3.users.Key(get_user_key_example_data())
+        with pytest.raises(AttributeError):
+            key.fakeattribute
+
+    @mock.patch('github3.models.GitHubObject.__getattr__')
+    def test_getattr_called(self, mocked_getattr):
+        """Show that getattr is called if attribute does not exist."""
+        key = github3.users.Key(get_user_key_example_data())
+        key.fakeattribute
+
+        assert mocked_getattr.called is True
+
+    @mock.patch('github3.models.GitHubObject.__getattr__')
+    def test_getattr_not_called_on_base_class(self, mocked_getattr):
+        """Show getattr is not called if attribute exists on base class."""
+        key = github3.users.Key(get_user_key_example_data())
+        key._uniq
+        assert mocked_getattr.called is False
