fixup! [BUG] Fix issue with results_iter when API returns an object CAT-213

Author: rhiannon-eldridge-lrn

ChangeLog.md

@@ -6,11 +6,14 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
-
-## [v0.3.1] - 2019-08-02
 ### Fixed
-- Resolved issue with results_iter where API calls
-  that returned objects failed. Fixes GitHub Issue #34
+- Fixed an issue where the DataApi class's results_iter method would return no data 
+  when receiving responses from Data API endpoints that set the "data" field of the
+  response to an object (like the [itembank/questions endpoint](https://reference.learnosity.com/data-api/endpoints/itembank_endpoints#getQuestions) 
+  when item_references is included in the request).
+
+### Added
+- utils.Future
 
 ## [v0.3.0] - 2019-06-17
 ### Added

learnosity_sdk/request/dataapi.py

@@ -3,6 +3,7 @@
 
 from learnosity_sdk.exceptions import DataApiException
 from learnosity_sdk.request import Init
+from learnosity_sdk.utils import Future
 
 
 class DataApi(object):
@@ -60,7 +61,7 @@ def results_iter(self, endpoint, security_packet,
                                           secret, request_packet,
                                           action):
             if isinstance(response['data'], dict):
-                for key, value in self.__iteritems(response['data']):
+                for key, value in Future.iteritems(response['data']):
                     yield {key: value}
             else:
                 for result in response['data']:
@@ -128,12 +129,3 @@ def request_iter(self, endpoint, security_packet,
                     'server returned unsuccessful status: ' + res.text)
             else:
                 yield data
-
-    @staticmethod
-    def __iteritems(obj, **kwargs):
-        func = getattr(obj, "iteritems", None)
-
-        if not func:
-            func = obj.items
-
-        return func(**kwargs)

learnosity_sdk/utils/__init__.py

@@ -1,5 +1,7 @@
 from .lrnuuid import Uuid
+from .lrnfuture import Future
 
 __all__ = [
         "Uuid",
+        "Future"
         ]

learnosity_sdk/utils/lrnfuture.py

@@ -0,0 +1,21 @@
+class Future:
+    """
+    This helper method allows the .items method of Python 3
+    to be wrapped to the equivalent .iteritems method
+    of Python 2.7
+
+    The code for this method was sourced from Python Future:
+    https://python-future.org/
+
+    Python Future is licenced under the MIT Licence. Full licence details
+    and credits can be found here:
+    https://python-future.org/credits.html
+    """
+    @staticmethod
+    def iteritems(obj, **kwargs):
+        func = getattr(obj, "iteritems", None)
+
+        if not func:
+            func = obj.items
+
+        return func(**kwargs)

tests/integration/test_dataapi.py

@@ -1,6 +1,7 @@
 import unittest
 import os
 from learnosity_sdk.request import DataApi
+from learnosity_sdk.utils import Future
 
 # This test uses the consumer key and secret for the demos consumer
 # this is the only consumer with publicly available keys
@@ -55,33 +56,20 @@ def _build_base_url(self):
     def test_real_request(self):
         """Make a request against Data Api to ensure the SDK works"""
         client = DataApi()
-
-        test_url = self._build_base_url() + items_endpoint
-
-        print("test_url is", test_url)
-
-        res = client.request(test_url, security, consumer_secret, items_request,
+        res = client.request(self._build_base_url() + items_endpoint, security, consumer_secret, items_request,
                              action)
-
         returned_json = res.json()
 
         assert len(returned_json['data']) > 0
 
         returned_ref = returned_json['data'][0]['reference']
-
         assert returned_ref in items_request['references']
 
     def test_paging(self):
         """Verify that paging works"""
         client = DataApi()
-
-        test_url = self._build_base_url() + items_endpoint
-
-        print("test_url is", test_url)
-
-        pages = client.request_iter(test_url, security, consumer_secret,
+        pages = client.request_iter(self._build_base_url() + items_endpoint, security, consumer_secret,
                                     items_request, action)
-
         results = set()
 
         for page in pages:
@@ -110,7 +98,7 @@ def test_real_question_request(self):
 
         keys = set()
 
-        for key, value in self.__iteritems(returned_json['data']):
+        for key, value in Future.iteritems(returned_json['data']):
             keys.add(key)
 
         assert keys == {'py-sdk-test-2019-1', 'py-sdk-test-2019-2'}
@@ -140,12 +128,3 @@ def test_question_paging(self):
 
         assert len(results) == 3
         assert keys == {'py-sdk-test-2019-1', 'py-sdk-test-2019-2'}
-
-    @staticmethod
-    def __iteritems(obj, **kwargs):
-        func = getattr(obj, "iteritems", None)
-
-        if not func:
-            func = obj.items
-
-        return func(**kwargs)