Support for bulk delete

Author: jasonbosco

README.md

@@ -33,6 +33,7 @@ Tests are also a good place to know how the the library works internally: [spec]
 
 | Typesense Server | typesense-ruby |
 |------------------|----------------|
+| \>= v0.17.0 | \>= v0.9.0 |
 | \>= v0.16.0 | \>= v0.8.0 |
 | \>= v0.15.0 | \>= v0.7.0 |
 | \>= v0.12.1 | \>= v0.5.0 |

examples/collections_and_documents.rb

@@ -258,6 +258,9 @@
 }
 ap @typesense.collections['companies'].documents.import(documents, action: :update)
 
+## You can also bulk delete documents, using filter_by fields:
+ap @typesense.collections['companies'].documents.delete(filter_by: 'num_employees:>100')
+
 ##
 # Export all documents in a collection in JSON Lines format
 #   We use JSON Lines format for performance reasons. You can choose to parse selected lines as needed, by splitting on \n.

lib/typesense/documents.rb

@@ -64,6 +64,10 @@ def [](document_id)
       @documents[document_id] ||= Document.new(@collection_name, document_id, @api_call)
     end
 
+    def delete(query_parameters = {})
+      @api_call.delete(endpoint_path, query_parameters)
+    end
+
     private
 
     def endpoint_path(operation = nil)

lib/typesense/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Typesense
-  VERSION = '0.8.0'
+  VERSION = '0.9.0'
 end

spec/typesense/documents_spec.rb

@@ -194,6 +194,24 @@
     end
   end
 
+  describe '#delete' do
+    it 'delete documents in a collection' do
+      stub_request(:delete, Typesense::ApiCall.new(typesense.configuration).send(:uri_for, '/collections/companies/documents', typesense.configuration.nodes[0]))
+        .with(headers: {
+                'X-Typesense-Api-Key' => typesense.configuration.api_key,
+                'Content-Type' => 'application/json'
+              },
+              query: {
+                filter_by: 'field:=value'
+              })
+        .to_return(status: 200, body: '{}', headers: { 'Content-Type': 'application/json' })
+
+      result = companies_documents.delete(filter_by: 'field:=value')
+
+      expect(result).to eq({})
+    end
+  end
+
   describe '#search' do
     let(:search_parameters) do
       {