Merge pull request #160 from Crown-Commercial-Service/add-with-evalua…

…tions-option

Add `with_evaluations` param to some routes

dmapiclient/__init__.py

@@ -1,4 +1,4 @@
-__version__ = '29.10.0'
+__version__ = '29.11.0'
 
 from .errors import APIError, HTTPError, InvalidResponse  # noqa
 from .errors import REQUEST_ERROR_STATUS_CODE, REQUEST_ERROR_MESSAGE  # noqa

dmapiclient/data.py

@@ -1687,6 +1687,7 @@ def find_evaluator_framework_lots(
         assigned=True,
         locked=None,
         with_sections=None,
+        with_evaluations=None,
         page=None,
     ):
         params = {
@@ -1696,6 +1697,7 @@ def find_evaluator_framework_lots(
             'page': page,
             'user_id': user_id,
             'with_sections': with_sections,
+            'with_evaluations': with_evaluations,
             'locked': locked,
         }
 
@@ -1726,10 +1728,12 @@ def update_assigned_evaluators_for_framework_lot(
     def get_evaluator_framework_lot(
         self,
         evaluator_framework_lot_id,
-        with_sections=True
+        with_sections=True,
+        with_evaluations=True,
     ):
         params = {
             'with_sections': bool(with_sections),
+            'with_evaluations': bool(with_evaluations),
         }
 
         return self._get(f"/evaluations/evaluator-framework-lots/{evaluator_framework_lot_id}", params=params)
@@ -1796,10 +1800,16 @@ def update_assigned_sections_for_evaluator_framework_lot(
     def get_evaluator_framework_lot_section(
         self,
         evaluator_framework_lot_section_id,
+        with_evaluations=True,
     ):
+        params = {
+            'with_evaluations': bool(with_evaluations),
+        }
+
         return self._get(
             "/evaluations/evaluator-framework-lot-sections/"
-            f"{evaluator_framework_lot_section_id}"
+            f"{evaluator_framework_lot_section_id}",
+            params=params
         )
 
     def find_evaluator_framework_lot_section_evaluations(

tests/test_data_api_client.py

@@ -4424,9 +4424,21 @@ def test_find_evaluator_framework_lot_adds_with_sections_parameter(self, data_cl
         assert result == {"evaluatorFrameworkLotSections": "result"}
         assert rmock.called
 
+    def test_find_evaluator_framework_lot_adds_with_evaluations_parameter(self, data_client, rmock):
+        rmock.get(
+            "http://baseurl/evaluations/evaluator-framework-lots?"
+            "framework=g-cloud-6&lot=g-things&assigned=True&with_evaluations=True",
+            json={"evaluatorFrameworkLotSections": "result"},
+            status_code=200)
+
+        result = data_client.find_evaluator_framework_lots('g-cloud-6', 'g-things', with_evaluations=True)
+
+        assert result == {"evaluatorFrameworkLotSections": "result"}
+        assert rmock.called
+
     def test_get_evaluator_framework_lot(self, data_client, rmock):
         rmock.get(
-            "http://baseurl/evaluations/evaluator-framework-lots/1234?with_sections=True",
+            "http://baseurl/evaluations/evaluator-framework-lots/1234?with_sections=True&with_evaluations=True",
             json={"evaluatorFrameworkLots": "result"},
             status_code=200)
 
@@ -4437,7 +4449,7 @@ def test_get_evaluator_framework_lot(self, data_client, rmock):
 
     def test_get_evaluator_framework_lot_adds_with_sections_parameter(self, data_client, rmock):
         rmock.get(
-            "http://baseurl/evaluations/evaluator-framework-lots/1234?with_sections=False",
+            "http://baseurl/evaluations/evaluator-framework-lots/1234?with_sections=False&with_evaluations=True",
             json={"evaluatorFrameworkLots": "result"},
             status_code=200)
 
@@ -4446,6 +4458,17 @@ def test_get_evaluator_framework_lot_adds_with_sections_parameter(self, data_cli
         assert result == {"evaluatorFrameworkLots": "result"}
         assert rmock.called
 
+    def test_get_evaluator_framework_lot_adds_with_evaluations_parameter(self, data_client, rmock):
+        rmock.get(
+            "http://baseurl/evaluations/evaluator-framework-lots/1234?with_sections=True&with_evaluations=False",
+            json={"evaluatorFrameworkLots": "result"},
+            status_code=200)
+
+        result = data_client.get_evaluator_framework_lot(1234, with_evaluations=False)
+
+        assert result == {"evaluatorFrameworkLots": "result"}
+        assert rmock.called
+
     def test_update_assigned_evaluators_for_framework_lot(self, data_client, rmock):
         rmock.post(
             "http://baseurl/evaluations/evaluator-framework-lots",
@@ -4591,7 +4614,7 @@ def test_update_assigned_sections_for_evaluator_framework_lot(self, data_client,
 
     def test_get_evaluator_framework_lot_section(self, data_client, rmock):
         rmock.get(
-            "http://baseurl/evaluations/evaluator-framework-lot-sections/1234",
+            "http://baseurl/evaluations/evaluator-framework-lot-sections/1234?with_evaluations=True",
             json={"evaluatorFrameworkLotSections": "result"},
             status_code=200)
 
@@ -4600,6 +4623,17 @@ def test_get_evaluator_framework_lot_section(self, data_client, rmock):
         assert result == {"evaluatorFrameworkLotSections": "result"}
         assert rmock.called
 
+    def test_get_evaluator_framework_lot_section_adds_with_evaluations_parameter(self, data_client, rmock):
+        rmock.get(
+            "http://baseurl/evaluations/evaluator-framework-lot-sections/1234?with_evaluations=False",
+            json={"evaluatorFrameworkLotSections": "result"},
+            status_code=200)
+
+        result = data_client.get_evaluator_framework_lot_section(1234, with_evaluations=False)
+
+        assert result == {"evaluatorFrameworkLotSections": "result"}
+        assert rmock.called
+
     def test_find_evaluator_framework_lot_section_evaluations(self, data_client, rmock):
         rmock.get(
             "http://baseurl/evaluations/evaluator-framework-lot-section-evaluations?"