Merge pull request #3 from equinor/bug/client-fixes

Client improvements

Author: mahewitt

README.rst

@@ -11,6 +11,12 @@ Note: This is currently a WIP so will be subject to breaking changes.
 Change Log
 ==========
 
+0.0.10
+------
+
+- Delete doesn't check status codes (consistency with other functions)
+- Put will pass list objects as json
+                   
 0.0.9
 -----
 

src/osdu/__init__.py

@@ -4,4 +4,4 @@
 # license information.
 # -----------------------------------------------------------------------------
 
-__VERSION__ = "0.0.9"
+__VERSION__ = "0.0.10"

src/osdu/client.py

@@ -187,12 +187,11 @@ def put(self, url: str, data: Union[str, dict]) -> requests.Response:
 
         # determine whether to send to requests as data or json
         _json = None
-        if isinstance(data, dict):
+        if isinstance(data, (dict, list)):
             _json = data
             data = None
 
         response = requests.put(url, data=data, json=_json, headers=headers)
-        # logger.debug(response.text)
         return response
 
     def put_returning_json(
@@ -221,25 +220,17 @@ def put_returning_json(
             raise HTTPError(response=response)
         return response.json()
 
-    def delete(self, url: str, ok_status_codes: list = None) -> requests.Response:
+    def delete(self, url: str) -> requests.Response:
         """GET to a url
 
         Args:
             url (str): url to PUT to
-            ok_status_codes (list, optional): Status codes indicating successful call. Defaults to [200].
 
         Returns:
             requests.Response: response object
         """
-        if ok_status_codes is None:
-            ok_status_codes = [200]
-
         headers = self.get_headers()
         response = requests.delete(url, headers=headers)
-
-        if response.status_code not in ok_status_codes:
-            raise HTTPError(response=response)
-
         return response
 
     # endregion HTTP Actions

tests/test_client.py

@@ -319,41 +319,21 @@ def test_put_returning_json_http_error_throws_exception(
     # endregion test put_returning_json
 
     # region test delete
-    @params((None, 200), ([200], 200), ([200, 202], 202), ([202], 202))
-    @patch.object(OsduClient, "get_headers", return_value=(None))
-    def test_delete(self, expected_status_codes, actual_status_code, _):
+    @params(
+        "http://www.test.com/",
+        "http://www.test.com/test2/",
+    )
+    @patch.object(OsduClient, "get_headers", return_value=dummy_headers)
+    def test_delete(self, url, _):
         """Test valid delete returns expected values"""
-        expected_response_data = {
-            "name": "value",
-        }
-        ok_response_mock = mock.Mock()
-        type(ok_response_mock).status_code = mock.PropertyMock(return_value=actual_status_code)
-        ok_response_mock.json.return_value = expected_response_data
-        with mock.patch("requests.delete", return_value=ok_response_mock) as mock_delete:
+        response_mock = mock.Mock()
+        with mock.patch("requests.delete", return_value=response_mock) as mock_delete:
             client = create_dummy_client()
-
-            if expected_status_codes:
-                response = client.delete("http://www.test.com/", expected_status_codes)
-            else:
-                response = client.delete("http://www.test.com/")
+            response = client.delete(url)
 
             mock_delete.assert_called_once()
-            mock_delete.assert_called_with("http://www.test.com/", headers=None)
-            self.assertEqual(ok_response_mock, response)
-
-    @params((None, 404), (None, 201), ([200], 404), ([200, 202], 500))
-    @patch.object(OsduClient, "get_headers", return_value=(None))
-    def test_delete_http_error_throws_exception(self, expected_status_codes, actual_status_code, _):
-        """Test delete http error returns expected values"""
-        error_response_mock = mock.MagicMock()
-        type(error_response_mock).status_code = mock.PropertyMock(return_value=actual_status_code)
-        with mock.patch("requests.delete", return_value=error_response_mock):
-            with self.assertRaises(HTTPError):
-                client = create_dummy_client()
-                if expected_status_codes:
-                    _ = client.delete("http://www.test.com/", expected_status_codes)
-                else:
-                    _ = client.delete("http://www.test.com/")
+            mock_delete.assert_called_with(url, headers=self.dummy_headers)
+            self.assertEqual(response_mock, response)
 
     # endregion test delete