Merge pull request #10 from edx/answer-distribution-list

Added Method to Retrieve Submission Counts for Multiple Problems

.pylintrc

@@ -73,9 +73,6 @@ disable=
 # (visual studio) and html
 output-format=text
 
-# Include message's id in output
-include-ids=yes
-
 # Put messages in a separate file for each module / package specified on the
 # command line instead of printing them on stdout. Reports (if any) will be
 # written in a file name "pylint_global.[txt|html]".

analyticsclient/module.py

 import analyticsclient.constants.data_format as DF
+from analyticsclient.exceptions import InvalidRequestError
 
 
 class Module(object):
@@ -28,6 +29,22 @@ class Module(object):
 
         return self.client.get(path, data_format=data_format)
 
+    def submission_counts(self, module_ids, data_format=DF.JSON):
+        """
+        Get submission counts data for multiple modules.
+
+        Arguments:
+            module_ids (list[str]): IDs of modules for which data should be returned
+            data_format (str): Format in which to return data (default is JSON)
+        """
+        if not module_ids:
+            raise InvalidRequestError('At least one module ID must be supplied.')
+
+        module_ids = ','.join(module_ids)
+        path = 'problems/submission_counts/?problem_ids={}'.format(module_ids)
+
+        return self.client.get(path, data_format=data_format)
+
     def grade_distribution(self, data_format=DF.JSON):
         """
         Get grade distribution data for a module.

analyticsclient/tests/test_module.py

 import json
 import httpretty
+from analyticsclient.exceptions import InvalidRequestError
 
 from analyticsclient.tests import ClientTestCase
 
@@ -94,3 +95,19 @@ class ModulesTests(ClientTestCase):
         uri = self.get_api_url('problems/{0}/grade_distribution/'.format(self.module_id))
         httpretty.register_uri(httpretty.GET, uri, body=json.dumps(body))
         self.assertEqual(body, self.module.grade_distribution())
+
+    @httpretty.activate
+    def test_submission_counts(self):
+        self.assertRaises(InvalidRequestError, self.module.submission_counts, None)
+
+        body = [
+            {
+                'module_id': self.module_id,
+                'total': 100,
+                'correct': 80
+            }
+        ]
+
+        uri = self.get_api_url('problems/submission_counts/')
+        httpretty.register_uri(httpretty.GET, uri, body=json.dumps(body))
+        self.assertEqual(body, self.module.submission_counts([self.module_id]))

setup.py

@@ -2,7 +2,7 @@ from distutils.core import setup
 
 setup(
     name='edx-analytics-data-api-client',
-    version='0.4.0',
+    version='0.5.0',
     packages=['analyticsclient'],
     url='https://github.com/edx/edx-analytics-data-api-client',
     description='Client used to access edX analytics data warehouse',