Merge pull request #186 from box/add_contains_method_to_base_api_json_object

Add ability to perform contains checks on BaseAPIJsonObject

Author: Taejun Lee

boxsdk/object/api_json_object.py

@@ -22,6 +22,3 @@ class APIJSONObject(with_metaclass(APIJSONObjectMeta, BaseAPIJSONObject, Mapping
 
     def __len__(self):
         return len(self._response_object)
-
-    def __iter__(self):
-        return iter(self._response_object)

boxsdk/object/base_api_json_object.py

@@ -95,6 +95,23 @@ def __getitem__(self, item):
         """
         return self._response_object[item]
 
+    def __contains__(self, item):
+        """
+        Does the response object contains this item attribute?
+
+        :param item:
+            The attribute to check for in the API response object.
+        :type item:
+            `unicode`
+        """
+        return item in self._response_object
+
+    def __iter__(self):
+        """
+        Get all of the keys of the API response object.
+        """
+        return iter(self._response_object)
+
     def __repr__(self):
         """Base class override. Return a human-readable representation using the Box ID or name of the object."""
         extra_description = ' - {0}'.format(self._description) if self._description else ''

test/unit/object/test_base_api_json_object.py

@@ -26,6 +26,20 @@ def test_getitem(base_api_json_object):
         assert test_object[key] == dictionary_response[key]
 
 
+def test_contains(base_api_json_object):
+    dictionary_response, test_object = base_api_json_object
+    for key in dictionary_response:
+        assert key in test_object
+    assert 'some_key_that_doesnt_exist' not in test_object
+
+
+def test_iter(base_api_json_object):
+    dictionary_response, test_object = base_api_json_object
+    all_test_object_keys = [key for key in test_object]
+    all_dictionary_response_keys = [key for key in dictionary_response]
+    assert set(all_test_object_keys) == set(all_dictionary_response_keys)
+
+
 def test_meta_registers_new_item_type_in_default_translator(default_translator, original_default_translator):
     item_type = u'ƒøø'