Add testcases for non breaking changes in api response

Author: amansquareboat

imagekitio/models/results/UploadFileResult.py

@@ -44,7 +44,7 @@ def __init__(
                 self.ai_tags.append(AITags(**camel_dict_to_snake_dict(i)))
         else:
             self.ai_tags.append(AITags(None, None, None))
-        self.version_info = VersionInfo(camel_dict_to_snake_dict(version_info))
+        self.version_info = VersionInfo(**camel_dict_to_snake_dict(version_info))
         self.is_private_file = is_private_file
         self.custom_coordinates = custom_coordinates
         self.custom_metadata = custom_metadata
@@ -55,7 +55,7 @@ def __init__(
                 self.embedded_metadata = embedded_metadata
             else:
                 self.embedded_metadata: EmbeddedMetadata = EmbeddedMetadata(
-                    **embedded_metadata
+                    **camel_dict_to_snake_dict(embedded_metadata)
                 )
         self.extension_status = extension_status
         self.file_type = file_type

imagekitio/utils/utils.py

@@ -76,11 +76,7 @@ def throw_other_exception(response: Response):
 
 
 def convert_to_response_object(resp: Response, response_object):
-    resp_json = resp.json()
-    embeddedMetadata = resp_json.get("embeddedMetadata")
-    if embeddedMetadata != None:
-        resp_json["embeddedMetadata"] = camel_dict_to_snake_dict(embeddedMetadata)
-    res_new = loads(dumps(camel_dict_to_snake_dict(resp_json)))
+    res_new = loads(dumps(camel_dict_to_snake_dict(resp.json())))
     u = response_object(**res_new)
     u.response_metadata = ResponseMetadata(resp.json(), resp.status_code, resp.headers)
     return u

tests/test_custom_metadata_fields_ops.py

@@ -213,6 +213,88 @@ def test_get_custom_metadata_fields_succeeds_with_include_deleted_true(self):
             responses.calls[0].request.url,
         )
 
+    @responses.activate
+    def test_get_custom_metadata_fields_succeeds_with_additional_attributes_in_response(self):
+        """
+        Tests if get_custom_metadata_fields succeeds with additional responses
+        """
+        URL.API_BASE_URL = "http://test.com"
+        url = "{}/v1/customMetadataFields".format(URL.API_BASE_URL)
+        headers = create_headers_for_test()
+        responses.add(
+            responses.GET,
+            url,
+            body="""[{
+                        "id": "62a9d5f6db485107347bb7f2",
+                        "name": "test10",
+                        "label": "test10",
+                        "schema": {
+                            "type": "Number",
+                            "isValueRequired": false,
+                            "minValue": 10,
+                            "maxValue": 1000,
+                            "currentValue":100
+                        }
+                    }, {
+                        "id": "62aab2cfdb4851833b8f5e64",
+                        "name": "test11",
+                        "label": "test11",
+                        "schema": {
+                            "type": "Number",
+                            "isValueRequired": false,
+                            "minValue": 10,
+                            "maxValue": 1000,
+                            "currentValue":1000
+                        }
+                    }]""",
+            match=[matchers.query_string_matcher("includeDeleted=true")],
+            headers=headers,
+        )
+        resp = self.client.get_custom_metadata_fields(include_deleted=True)
+
+        mock_response_metadata = {
+            "raw": [
+                {
+                    "id": "62a9d5f6db485107347bb7f2",
+                    "name": "test10",
+                    "label": "test10",
+                    "schema": {
+                        "type": "Number",
+                        "isValueRequired": False,
+                        "minValue": 10,
+                        "maxValue": 1000,
+                        "currentValue":100
+                    },
+                },
+                {
+                    "id": "62aab2cfdb4851833b8f5e64",
+                    "name": "test11",
+                    "label": "test11",
+                    "schema": {
+                        "type": "Number",
+                        "isValueRequired": False,
+                        "minValue": 10,
+                        "maxValue": 1000,
+                        "currentValue":1000
+                    },
+                },
+            ],
+            "httpStatusCode": 200,
+            "headers": {
+                "Content-Type": "text/plain",
+                "Accept-Encoding": "gzip, deflate",
+                "Authorization": "Basic ZmFrZTEyMjo=",
+            },
+        }
+
+        self.assertEqual(
+            camel_dict_to_snake_dict(mock_response_metadata),
+            resp.response_metadata.__dict__,
+        )
+        self.assertEqual(resp.list[0].schema.current_value,100)
+        self.assertEqual(resp.list[1].schema.current_value,1000)
+        self.assertEqual(resp.list[0].random,None)
+
     @responses.activate
     def test_delete_custom_metadata_fields_succeeds(self):
         """

tests/test_files_ops.py

@@ -1184,6 +1184,47 @@ def test_bulk_file_delete_succeeds(self):
         )
 
     @responses.activate
+    def test_bulk_file_delete_succeeds_and_recieves_extra_non_breaking_changes_from_apii(self):
+        """Test bulk_delete  on authenticated request
+        this function tests if bulk_file_delete working properly
+        """
+
+        URL.API_BASE_URL = "http://test.com"
+        url = URL.API_BASE_URL + "/v1/files" + URL.BULK_FILE_DELETE
+        headers = {"Content-Type": "application/json"}
+        headers.update(get_auth_headers_for_test())
+
+        responses.add(
+            responses.POST,
+            url,
+            body='{"successfullyDeletedFileIds": ["fake_123"],"nonDeletedFields":["fake_222"]}',
+            headers=headers,
+        )
+
+        resp = self.client.bulk_file_delete(self.bulk_delete_ids)
+
+        mock_response_metadata = {
+            "raw": {"successfullyDeletedFileIds": ["fake_123"],"nonDeletedFields":["fake_222"]},
+            "httpStatusCode": 200,
+            "headers": {
+                "Content-Type": "text/plain, application/json",
+                "Authorization": "Basic ZmFrZTEyMjo=",
+            },
+        }
+        self.assertEqual(
+            '{"fileIds": ["fake_123", "fake_222"]}', responses.calls[0].request.body
+        )
+        self.assertEqual(
+            camel_dict_to_snake_dict(mock_response_metadata),
+            resp.response_metadata.__dict__,
+        )
+        self.assertEqual(["fake_123"], resp.successfully_deleted_file_ids)
+        self.assertEqual(["fake_222"], resp.non_deleted_fields)
+        self.assertEqual(
+            "http://test.com/v1/files/batch/deleteByFileIds",
+            responses.calls[0].request.url,
+        )
+    @responses.activate
     def test_bulk_file_delete_fails_with_404_exception(self) -> None:
         """Test bulk_file_delete raises 404 error"""