Add a way to delete documents by filter

Author: brunoocasali

lib/meilisearch/index.rb

@@ -153,11 +153,20 @@ def update_documents_in_batches!(documents, batch_size = 1000, primary_key = nil
       responses
     end
 
-    def delete_documents(documents_ids)
-      if documents_ids.is_a?(Array)
-        http_post "/indexes/#{@uid}/documents/delete-batch", documents_ids
+    # Public: Delete documents from an index
+    #
+    # documents_ids - An array with document ids (deprecated, optional)
+    # filter - A hash containing a filter that should match documents.
+    #          Available ONLY with Meilisearch v1.2 and newer (optional)
+    #
+    # Returns a Task object.
+    def delete_documents(documents_ids = nil, filter: nil)
+      if documents_ids.nil?
+        http_post "/indexes/#{@uid}/documents/delete", { filter: filter }
       else
-        delete_document(documents_ids)
+        documents_ids = [documents_ids] unless documents_ids.is_a?(Array)
+
+        http_post "/indexes/#{@uid}/documents/delete-batch", documents_ids
       end
     end
     alias delete_multiple_documents delete_documents

spec/meilisearch/index/documents_spec.rb

@@ -390,6 +390,32 @@
         expect { index.document(id) }.to raise_document_not_found_meilisearch_api_error
       end
 
+      it 'deletes documents based on filter from index (with delete route)' do
+        expect do
+          index.update_filterable_attributes(['objectId'])
+          task = index.delete_documents(nil, filter: ['objectId > 0'])
+
+          client.wait_for_task(task['taskUid'])
+        end.to(change { index.documents['results'].size }.by(-documents.size))
+      end
+
+      it 'ignores filter even when documents_ids is empty (with delete-batch route)' do
+        expect do
+          task = index.delete_documents([], filter: ['objectId > 0'])
+
+          client.wait_for_task(task['taskUid'])
+        end.to(change { index.documents['results'].size }.by(0))
+      end
+
+      it 'deletes documents based on ids even when receive a filter (with delete-batch route)' do
+        expect do
+          index.update_filterable_attributes(['objectId'])
+          task = index.delete_documents([2], filter: ['objectId > 0'])
+
+          client.wait_for_task(task['taskUid'])
+        end.to(change { index.documents['results'].size }.by(-1))
+      end
+
       it 'deletes one document synchronously from index (with delete-batch route)' do
         id = 2
         expect do