algoliasearch 1.16.0 → 1.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bb21e712b8f13f4624b33858edbe573acf33a7d1
-  data.tar.gz: 3bb19d2382c63494c56b43266fdf0898da59e9c9
+  metadata.gz: b003d66ce48ed84c00beee6a9e93bb65c704ca2e
+  data.tar.gz: f9ae3ed72cd92b351684a22b45ef9ccd2f486fc7
 SHA512:
-  metadata.gz: b6324fd4f0dc64f44edf75a8985004cc230de0ad418e114224b90e115f2feec52fa0389328904fa58188ea4e853e2994866cbbb498d479956a50b60f0a91fe69
-  data.tar.gz: 894a5a056b54195fa7b71703915ad58159e9f8b717487008d7395f255fd79a7659b36285caa345666fa0811a0d5cac0b4a774be32471f41b11f3293b0f97f98e
+  metadata.gz: e72ac4175524739045f3fdb369f2e65c29714744c63af237542f0f7086b2ec6acd19aa17736793bdf28a1e545488005724ce3d6437560a73175c06bc712aa20a
+  data.tar.gz: 3aa8a7e84b25d0487ac8cb7c6545c26b79fb5fa5b5b78f80e146c54cb0897457880cb68b834afd9a5f5e1239763a7b33c874e965e73b54d4736e4b3a21259ad0

data/ChangeLog

@@ -1,5 +1,8 @@
 CHANGELOG
 
+2017-10-10 1.17.0
+      * New delete_by method
+
 2017-09-14 1.16.0
       * New Query Rules API
 

data/lib/algolia/index.rb

@@ -434,6 +434,29 @@ module Algolia
       res
     end
 
+    #
+    # Delete all objects matching a query (doesn't work with actual text queries)
+    # This method deletes every record matching the filters provided
+    #
+    # @param params query parameters
+    #
+    def delete_by(params)
+      raise ArgumentError.new('params cannot be nil, use the `clear` method to wipe the entire index') if params.nil?
+      params = sanitized_delete_by_query_params(params)
+      client.post(Protocol.delete_by_uri(name), params.to_json)
+    end
+
+    #
+    # Delete all objects matching a query (doesn't work with actual text queries)
+    # This method deletes every record matching the filters provided and waits for the end of indexing
+    # @param params query parameters
+    #
+    def delete_by!(params)
+      res = delete_by(params)
+      wait_task(res['taskID']) if res
+      res
+    end
+
     #
     # Delete the index content
     #

data/lib/algolia/protocol.rb

@@ -167,5 +167,9 @@ module Algolia
       "#{rules_uri(index)}/batch"
     end
 
+    def Protocol.delete_by_uri(index)
+      "#{index_uri(index)}/deleteByQuery"
+    end
+
   end
 end

data/lib/algolia/version.rb

@@ -1,3 +1,3 @@
 module Algolia
-  VERSION = "1.16.0"
+  VERSION = "1.17.0"
 end

data/spec/client_spec.rb

@@ -249,6 +249,31 @@ describe 'Client' do
     expect { @index.delete_by_query(nil) }.to raise_error(ArgumentError)
   end
 
+  context 'delete_by' do
+    it 'should not wipe the entire index' do
+      expect { @index.delete_by(nil) }.to raise_error(ArgumentError)
+    end
+
+    it 'should fail with query passed' do
+      @index.clear
+      @index.add_object({:firstname => 'Robert1'})
+      @index.add_object!({:firstname => 'Robert2'})
+      @index.search('')['nbHits'].should eq(2)
+      expect { @index.delete_by({ 'query' => 'abc' }) }.to raise_error(Algolia::AlgoliaProtocolError)
+      @index.search('')['nbHits'].should eq(2)
+    end
+
+    it 'should work with filters' do
+      @index.clear
+      @index.set_settings!({:attributesForFaceting => ['firstname']})
+      @index.add_object({:firstname => 'Robert1'})
+      @index.add_object!({:firstname => 'Robert2'})
+      @index.search('')['nbHits'].should eq(2)
+      @index.delete_by!({ 'filters' => 'firstname:Robert1' })
+      @index.search('')['nbHits'].should eq(1)
+    end
+  end
+
   it "should copy the index" do
     index = Algolia::Index.new(safe_index_name("àlgol?à"))
     begin

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algoliasearch
 version: !ruby/object:Gem::Version
-  version: 1.16.0
+  version: 1.17.0
 platform: ruby
 authors:
 - Algolia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-14 00:00:00.000000000 Z
+date: 2017-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -131,7 +131,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: A simple Ruby client for the algolia.com REST API