Merge pull request #322 from algolia/feat/scoped_copy

Feat/scoped copy

Author: LeoErcolanelli

algoliasearch/client.py

@@ -303,16 +303,22 @@ def move_index(self, src_index_name, dst_index_name, request_options=None):
     def copyIndex(self, src_index_name, dst_index_name):
         return self.copy_index(src_index_name, dst_index_name)
 
-    def copy_index(self, src_index_name, dst_index_name, request_options=None):
+    def copy_index(self, src_index_name, dst_index_name, request_options=None, scope=None):
         """
         Copy an existing index.
 
         @param src_index_name the name of index to copy.
         @param dst_index_name the new index name that will contains a copy of
             src_index_name (destination will be overriten if it already exist).
+        @param scope the scope of the copy, as a list. Possible items are:
+            settings, rules, synonyms.
         """
         path = '/1/indexes/%s/operation' % safe(src_index_name)
         request = {'operation': 'copy', 'destination': dst_index_name}
+
+        if scope is not None:
+            request['scope'] = scope
+
         return self._req(False, path, 'POST', request_options, data=request)
 
     @deprecated

tests/test_client.py

@@ -181,6 +181,29 @@ def test_copy(double_indexes):
     assert res[0]['hits'] == res[1]['hits']
 
 
+def test_scoped_copy(double_indexes):
+    index1 = double_indexes[0]
+    index2 = double_indexes[1]
+
+    task = index1.set_settings({'searchableAttributes': ['name']})
+    index1.wait_task(task['taskID'])
+
+    task = index1.client.copy_index(
+        index1.index_name, index2.index_name, scope=['settings']
+    )
+    index1.wait_task(task['taskID'])
+
+    # Check that the settings are the same.
+    settings1 = index1.get_settings()
+    settings2 = index2.get_settings()
+    assert settings1 == settings2
+
+    # Check that the objects are still different
+    res1 = index1.search('')
+    res2 = index2.search('')
+    assert res1 != res2
+
+
 def test_move(double_indexes):
     index1 = double_indexes[0]
     index2 = double_indexes[1]