Improves UpdateApiKey wait algorithm

Author: nunomaduro

algoliasearch/responses.py

@@ -159,13 +159,17 @@ def _have_changed(self, api_key):
         valid_keys = (
             'acl', 'indexes', 'referers',
             'restrictSources', 'queryParameters', 'description',
-            'validity', 'maxQueriesPerIPPerHour', 'maxHitsPerQuery',
+            'maxQueriesPerIPPerHour', 'maxHitsPerQuery',
         )
 
         body = self._request_options.data
 
-        return any([(valid_key in body and body[valid_key] == api_key.get(
-            valid_key)) for valid_key in valid_keys])
+        valid_key_exists = any([key in valid_keys for key in body.keys()])
+
+        return not valid_key_exists or any(
+            [(valid_key in body and body[valid_key] == api_key.get(
+                valid_key)) for valid_key in valid_keys]
+        )
 
     def __getitem__(self, key):
         # type:(str) -> Union[int, str, dict, list]

tests/unit/test_responses.py

@@ -3,6 +3,7 @@
 import mock
 
 from algoliasearch.exceptions import RequestException
+from algoliasearch.http.request_options import RequestOptions
 from algoliasearch.responses import (
     IndexingResponse, MultipleResponse,
     AddApiKeyResponse, UpdateApiKeyResponse,
@@ -61,3 +62,21 @@ def test_request_exception(self):
         with self.assertRaises(RequestException) as cm:
             self.client.add_api_key(['search']).wait()
         self.assertEqual(cm.exception.status_code, 300)
+
+    def test_update_api_key_response(self):
+        request_options = RequestOptions({}, {}, {}, {
+            'data': {'validity': 300}
+        })
+        response = UpdateApiKeyResponse({}, {}, request_options)
+        self.assertTrue(response._have_changed({}))
+        self.assertTrue(response._have_changed({'validity': 297}))
+
+        request_options.data = {'maxQueriesPerIPPerHour': 2}
+        self.assertFalse(response._have_changed({}))
+        self.assertFalse(response._have_changed({'maxQueriesPerIPPerHour': 1}))
+        self.assertTrue(response._have_changed({'maxQueriesPerIPPerHour': 2}))
+
+        request_options.data = {'acl': ['search']}
+        self.assertFalse(response._have_changed({}))
+        self.assertFalse(response._have_changed({'acl': []}))
+        self.assertTrue(response._have_changed({'acl': ['search']}))