algoliasearch 1.15.1 → 1.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 83e8b3d9fb893a32b3ba573f94532bdad71aa666
-  data.tar.gz: 8a5707e5e4f88bb8dde14b13f6c21d4f4c1f67e7
+  metadata.gz: bb21e712b8f13f4624b33858edbe573acf33a7d1
+  data.tar.gz: 3bb19d2382c63494c56b43266fdf0898da59e9c9
 SHA512:
-  metadata.gz: 49a14746f93a764e0f8341f34509825e4533115df3c287b369e68a4cd2296a925c4c928b7bfd95e6c8144ddfb2be1e2825e28c14cace4dad4d096c6879997c7a
-  data.tar.gz: 3fbc6d92369121be3ed984e14fe925e802c84c11c0fbb1a0a3d281bd242eb46e10f08cb51768ade5fff063bb3e2136e39c52f1f59d5daa2c9828a98f44917296
+  metadata.gz: b6324fd4f0dc64f44edf75a8985004cc230de0ad418e114224b90e115f2feec52fa0389328904fa58188ea4e853e2994866cbbb498d479956a50b60f0a91fe69
+  data.tar.gz: 894a5a056b54195fa7b71703915ad58159e9f8b717487008d7395f255fd79a7659b36285caa345666fa0811a0d5cac0b4a774be32471f41b11f3293b0f97f98e

data/ChangeLog

@@ -1,5 +1,8 @@
 CHANGELOG
 
+2017-09-14 1.16.0
+      * New Query Rules API
+
 2017-08-17 1.15.1
       * Fixed regression introduced in 1.15.0
 
@@ -175,11 +178,11 @@ CHANGELOG
 2013-12-16  1.1.15
 
       * Embed ca-bundle.crt
-      
+
 2013-12-11  1.1.14
 
       * Added index.add_user_key(acls, validity, rate_limit, maxApiCalls)
-	
+
 2013-12-10  1.1.13
 
       * WebMock integration

data/README.md

@@ -19,6 +19,7 @@ You can find the full reference on [Algolia's website](https://www.algolia.com/d
 ## Table of Contents
 
 
+
 1. **[Install](#install)**
 
     * [Ruby on Rails](#ruby-on-rails)
@@ -40,6 +41,7 @@ You can find the full reference on [Algolia's website](https://www.algolia.com/d
 
     * [index.html](#indexhtml)
 
+1. **[List of available methods](#list-of-available-methods)**
 
 
 
@@ -76,6 +78,7 @@ require 'algoliasearch'
 
 Algolia.init application_id: 'YourApplicationID',
              api_key:        'YourAPIKey'
+index = Algolia::Index.new("your_index_name")
 ```
 
 ## Push data
@@ -129,10 +132,10 @@ puts index.search('jimmie paint').to_json
 ## Search UI
 
 **Warning:** If you are building a web application, you may be more interested in using one of our
-[frontend search UI librairies](https://www.algolia.com/doc/guides/search-ui/search-libraries/)
+[frontend search UI libraries](https://www.algolia.com/doc/guides/search-ui/search-libraries/)
 
 The following example shows how to build a front-end search quickly using
-[InstanSearch.js](https://community.algolia.com/instantsearch.js/)
+[InstantSearch.js](https://community.algolia.com/instantsearch.js/)
 
 ### index.html
 
@@ -196,10 +199,97 @@ search.addWidget(
 search.start();
 ```
 
+
+
+
+## List of available methods
+
+
+
+
+
+### Search
+
+  - [Search an index](https://algolia.com/doc/api-reference/api-methods/search/?language=ruby)
+  - [Search for facet values](https://algolia.com/doc/api-reference/api-methods/search-for-facet-values/?language=ruby)
+  - [Search multiple indexes](https://algolia.com/doc/api-reference/api-methods/multiple-queries/?language=ruby)
+
+
+
+### Indexing
+
+  - [Add objects](https://algolia.com/doc/api-reference/api-methods/add-objects/?language=ruby)
+  - [Update objects](https://algolia.com/doc/api-reference/api-methods/update-objects/?language=ruby)
+  - [Partial update objects](https://algolia.com/doc/api-reference/api-methods/partial-update-objects/?language=ruby)
+  - [Delete objects](https://algolia.com/doc/api-reference/api-methods/delete-objects/?language=ruby)
+  - [Delete by query](https://algolia.com/doc/api-reference/api-methods/delete-by-query/?language=ruby)
+  - [Get objects](https://algolia.com/doc/api-reference/api-methods/get-objects/?language=ruby)
+  - [Wait for operations](https://algolia.com/doc/api-reference/api-methods/wait-task/?language=ruby)
+
+
+
+### Settings
+
+  - [Get settings](https://algolia.com/doc/api-reference/api-methods/get-settings/?language=ruby)
+  - [Set settings](https://algolia.com/doc/api-reference/api-methods/set-settings/?language=ruby)
+
+
+
+### Manage indices
+
+  - [List indexes](https://algolia.com/doc/api-reference/api-methods/list-indices/?language=ruby)
+  - [Delete index](https://algolia.com/doc/api-reference/api-methods/delete-index/?language=ruby)
+  - [Copy index](https://algolia.com/doc/api-reference/api-methods/copy-index/?language=ruby)
+  - [Move index](https://algolia.com/doc/api-reference/api-methods/move-index/?language=ruby)
+  - [Clear index](https://algolia.com/doc/api-reference/api-methods/clear-index/?language=ruby)
+
+
+
+### API Keys
+
+  - [Create secured API Key](https://algolia.com/doc/api-reference/api-methods/generate-secured-api-key/?language=ruby)
+  - [Add API Key](https://algolia.com/doc/api-reference/api-methods/add-api-key/?language=ruby)
+  - [Update API Key](https://algolia.com/doc/api-reference/api-methods/update-api-key/?language=ruby)
+  - [Delete API Key](https://algolia.com/doc/api-reference/api-methods/delete-api-key/?language=ruby)
+  - [Get API Key permissions](https://algolia.com/doc/api-reference/api-methods/get-api-key/?language=ruby)
+  - [List API Keys](https://algolia.com/doc/api-reference/api-methods/list-api-keys/?language=ruby)
+
+
+
+### Synonyms
+
+  - [Save synonym](https://algolia.com/doc/api-reference/api-methods/save-synonym/?language=ruby)
+  - [Batch synonyms](https://algolia.com/doc/api-reference/api-methods/batch-synonyms/?language=ruby)
+  - [Delete synonym](https://algolia.com/doc/api-reference/api-methods/delete-synonym/?language=ruby)
+  - [Clear all synonyms](https://algolia.com/doc/api-reference/api-methods/clear-synonyms/?language=ruby)
+  - [Get synonym](https://algolia.com/doc/api-reference/api-methods/get-synonym/?language=ruby)
+  - [Search synonyms](https://algolia.com/doc/api-reference/api-methods/search-synonyms/?language=ruby)
+
+
+
+### Query rules
+
+  - [Save a single rule](https://algolia.com/doc/api-reference/api-methods/rules-save/?language=ruby)
+  - [Batch save multiple rules](https://algolia.com/doc/api-reference/api-methods/rules-save-batch/?language=ruby)
+  - [Read a rule](https://algolia.com/doc/api-reference/api-methods/rules-read/?language=ruby)
+  - [Delete a single rule](https://algolia.com/doc/api-reference/api-methods/rules-delete/?language=ruby)
+  - [Clear all rules](https://algolia.com/doc/api-reference/api-methods/rules-clear/?language=ruby)
+  - [Search for rules](https://algolia.com/doc/api-reference/api-methods/rules-search/?language=ruby)
+
+
+
+### Advanced
+
+  - [Custom batch](https://algolia.com/doc/api-reference/api-methods/batch/?language=ruby)
+  - [Browse an index](https://algolia.com/doc/api-reference/api-methods/browse/?language=ruby)
+  - [Get latest logs](https://algolia.com/doc/api-reference/api-methods/get-logs/?language=ruby)
+
+
+
+
 ## Getting Help
 
 - **Need help**? Ask a question to the [Algolia Community](https://discourse.algolia.com/) or on [Stack Overflow](http://stackoverflow.com/questions/tagged/algolia).
 - **Found a bug?** You can open a [GitHub issue](https://github.com/algolia/algoliasearch-client-ruby/issues).
 
 
-

data/lib/algolia/index.rb

@@ -392,30 +392,34 @@ module Algolia
 
     #
     # Delete all objects matching a query
-    #
+    # This method retrieves all objects synchronously but deletes in batch
+    # asynchronously
     # @param query the query string
     # @param params the optional query parameters
     #
     def delete_by_query(query, params = nil)
       raise ArgumentError.new('query cannot be nil, use the `clear` method to wipe the entire index') if query.nil? && params.nil?
-      params ||= {}
-      params.delete(:hitsPerPage)
-      params.delete('hitsPerPage')
-      params.delete(:attributesToRetrieve)
-      params.delete('attributesToRetrieve')
+      params = sanitized_delete_by_query_params(params)
 
+      params[:query] = query
       params[:hitsPerPage] = 1000
       params[:distinct] = false
       params[:attributesToRetrieve] = ['objectID']
-      last_task = nil
-      loop do
-        res = search(query, params)
-        break if res['hits'].empty?
-        last_task = delete_objects(res['hits'].map { |h| h['objectID'] })
-        break if res['hits'].size < 1000
-        wait_task(last_task['taskID'])
+      params[:cursor] = ''
+      ids = []
+
+      while params[:cursor] != nil
+        result = browse(params)
+
+        params[:cursor] = result['cursor']
+
+        hits = result['hits']
+        break if hits.empty?
+
+        ids += hits.map { |h| h['objectID'] }
       end
-      last_task
+
+      delete_objects(ids)
     end
 
     #
@@ -796,6 +800,106 @@ module Algolia
       return res
     end
 
+    # Search rules
+    #
+    # @param query the query
+    # @param params an optional hash of :anchoring, :context, :page, :hitsPerPage
+    def search_rules(query, params = {})
+      anchoring = params[:anchoring]
+      context = params[:context]
+      page = params[:page] || params['page'] || 0
+      hits_per_page = params[:hitsPerPage] || params['hitsPerPage'] || 20
+      params = {
+        :query => query,
+        :page => page,
+        :hitsPerPage => hits_per_page
+      }
+      params[:anchoring] = anchoring unless anchoring.nil?
+      params[:context] = context unless context.nil?
+      client.post(Protocol.search_rules_uri(name), params.to_json, :read)
+    end
+
+    # Get a rule
+    #
+    # @param objectID the rule objectID
+    def get_rule(objectID)
+      client.get(Protocol.rule_uri(name, objectID), :read)
+    end
+
+    # Delete a rule
+    #
+    # @param objectID the rule objectID
+    # @param forward_to_replicas should we forward the delete to replica indices
+    def delete_rule(objectID, forward_to_replicas = false)
+      client.delete("#{Protocol.rule_uri(name, objectID)}?forwardToReplicas=#{forward_to_replicas}", :write)
+    end
+
+    # Delete a rule and wait the end of indexing
+    #
+    # @param objectID the rule objectID
+    # @param forward_to_replicas should we forward the delete to replica indices
+    def delete_rule!(objectID, forward_to_replicas = false)
+      res = delete_rule(objectID, forward_to_replicas)
+      wait_task(res["taskID"])
+      return res
+    end
+
+    # Save a rule
+    #
+    # @param objectID the rule objectID
+    # @param rule the rule
+    # @param forward_to_replicas should we forward the delete to replica indices
+    def save_rule(objectID, rule, forward_to_replicas = false)
+      client.put("#{Protocol.rule_uri(name, objectID)}?forwardToReplicas=#{forward_to_replicas}", rule.to_json, :write)
+    end
+
+    # Save a rule and wait the end of indexing
+    #
+    # @param objectID the rule objectID
+    # @param rule the rule
+    # @param forward_to_replicas should we forward the delete to replica indices
+    def save_rule!(objectID, rule, forward_to_replicas = false)
+      res = save_rule(objectID, rule, forward_to_replicas)
+      wait_task(res["taskID"])
+      return res
+    end
+
+    # Clear all rules
+    #
+    # @param forward_to_replicas should we forward the delete to replica indices
+    def clear_rules(forward_to_replicas = false)
+      client.post("#{Protocol.clear_rules_uri(name)}?forwardToReplicas=#{forward_to_replicas}")
+    end
+
+    # Clear all rules and wait the end of indexing
+    #
+    # @param forward_to_replicas should we forward the delete to replica indices
+    def clear_rules!(forward_to_replicas = false)
+      res = clear_rules(forward_to_replicas)
+      wait_task(res["taskID"])
+      return res
+    end
+
+    # Add/Update an array of rules
+    #
+    # @param rules the array of rules to add/update
+    # @param forward_to_replicas should we forward the delete to replica indices
+    # @param clear_existing_rules should we clear the existing rules before adding the new ones
+    def batch_rules(rules, forward_to_replicas = false, clear_existing_rules = false)
+      client.post("#{Protocol.batch_rules_uri(name)}?forwardToReplicas=#{forward_to_replicas}&clearExistingRules=#{clear_existing_rules}", rules.to_json, :batch)
+    end
+
+    # Add/Update an array of rules and wait the end of indexing
+    #
+    # @param rules the array of rules to add/update
+    # @param forward_to_replicas should we forward the delete to replica indices
+    # @param clear_existing_rules should we clear the existing rules before adding the new ones
+    def batch_rules!(rules, forward_to_replicas = false, clear_existing_rules = false)
+      res = batch_rules(rules, forward_to_replicas, clear_existing_rules)
+      wait_task(res["taskID"])
+      return res
+    end
+
     # Deprecated
     alias_method :get_user_key, :get_api_key
     alias_method :list_user_keys, :list_api_keys
@@ -838,5 +942,13 @@ module Algolia
       }
     end
 
+    def sanitized_delete_by_query_params(params)
+      params ||= {}
+      params.delete(:hitsPerPage)
+      params.delete('hitsPerPage')
+      params.delete(:attributesToRetrieve)
+      params.delete('attributesToRetrieve')
+      params
+    end
   end
 end

data/lib/algolia/protocol.rb

@@ -147,5 +147,25 @@ module Algolia
       "#{synonyms_uri(index)}/batch"
     end
 
+    def Protocol.rules_uri(index)
+      "#{index_uri(index)}/rules"
+    end
+
+    def Protocol.rule_uri(index, object_id)
+      "#{rules_uri(index)}/#{CGI.escape(object_id)}"
+    end
+
+    def Protocol.search_rules_uri(index)
+      "#{rules_uri(index)}/search"
+    end
+
+    def Protocol.clear_rules_uri(index)
+      "#{rules_uri(index)}/clear"
+    end
+
+    def Protocol.batch_rules_uri(index)
+      "#{rules_uri(index)}/batch"
+    end
+
   end
 end

data/lib/algolia/version.rb

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

data/lib/algolia/webmock.rb

@@ -8,7 +8,7 @@ end
 # list indexes
 WebMock.stub_request(:get, /.*\.algolia(net\.com|\.net)\/1\/indexes/).to_return(:body => '{ "items": [] }')
 # query index
-WebMock.stub_request(:get, /.*\.algolia(net\.com|\.net)\/1\/indexes\/[^\/]+/).to_return(:body => '{ "hits": [ { "objectID": 42 } ], "page": 1, "hitsPerPage": 1 }')
+WebMock.stub_request(:get, /.*\.algolia(net\.com|\.net)\/1\/indexes\/[^\/]+/).to_return(:body => '{ "hits": [ { "objectID": 42 } ], "page": 1, "hitsPerPage": 1, "nbHits": 1, "nbPages": 1 }')
 # delete index
 WebMock.stub_request(:delete, /.*\.algolia(net\.com|\.net)\/1\/indexes\/[^\/]+/).to_return(:body => '{ "taskID": 42 }')
 # clear index
@@ -29,7 +29,7 @@ WebMock.stub_request(:post, /.*\.algolia(net\.com|\.net)\/1\/indexes\/[^\/]+\/ba
 WebMock.stub_request(:get, /.*\.algolia(net\.com|\.net)\/1\/indexes\/[^\/]+\/settings/).to_return(:body => '{}')
 WebMock.stub_request(:put, /.*\.algolia(net\.com|\.net)\/1\/indexes\/[^\/]+\/settings/).to_return(:body => '{ "taskID": 42 }')
 # browse
-WebMock.stub_request(:get, /.*\.algolia(net\.com|\.net)\/1\/indexes\/[^\/]+\/browse/).to_return(:body => '{}')
+WebMock.stub_request(:get, /.*\.algolia(net\.com|\.net)\/1\/indexes\/[^\/]+\/browse/).to_return(:body => '{ "hits": [] }')
 # operations
 WebMock.stub_request(:post, /.*\.algolia(net\.com|\.net)\/1\/indexes\/[^\/]+\/operation/).to_return(:body => '{ "taskID": 42 }')
 # tasks
@@ -43,4 +43,4 @@ WebMock.stub_request(:get, /.*\.algolia(net\.com|\.net)\/1\/keys/).to_return(:bo
 WebMock.stub_request(:get, /.*\.algolia(net\.com|\.net)\/1\/keys\/[^\/]+/).to_return(:body => '{ }')
 WebMock.stub_request(:delete, /.*\.algolia(net\.com|\.net)\/1\/keys\/[^\/]+/).to_return(:body => '{ }')
 # query POST
-WebMock.stub_request(:post, /.*\.algolia(net\.com|\.net)\/1\/indexes\/[^\/]+\/query/).to_return(:body => '{ "hits": [ { "objectID": 42 } ], "page": 1, "hitsPerPage": 1 }')
+WebMock.stub_request(:post, /.*\.algolia(net\.com|\.net)\/1\/indexes\/[^\/]+\/query/).to_return(:body => '{ "hits": [ { "objectID": 42 } ], "page": 1, "hitsPerPage": 1, "nbHits": 1, "nbPages": 1 }')

data/spec/client_spec.rb

@@ -984,6 +984,37 @@ describe 'Client' do
     @index.search_synonyms('')['nbHits'].should eq(0)
   end
 
+  it 'should test Query Rules' do
+    rule_1 = {
+      :objectID => '42',
+      :condition => { :pattern => 'test', :anchoring => 'contains' },
+      :consequence => { :params => { :query => 'this is better' } }
+    }
+    rule_2 = {
+      :objectID => '2',
+      :condition => { :pattern => 'Pura', :anchoring => 'contains' },
+      :consequence => { :params => { :query => 'Pura Vida' } }
+    }
+
+    result = @index.save_rule!(rule_1[:objectID], rule_1)
+    result.should have_key('taskID')
+    result.should have_key('updatedAt')
+
+    @index.get_rule(rule_1[:objectID])['objectID'].should eq(rule_1[:objectID])
+
+    @index.search_rules('better')['nbHits'].should eq(1)
+    @index.search_rules('', { :anchoring => 'contains' })['nbHits'].should eq(1)
+
+    @index.delete_rule!(rule_1[:objectID])
+    @index.search_rules('')['nbHits'].should eq(0)
+
+    @index.batch_rules!([rule_1, rule_2])
+    @index.search_rules('')['nbHits'].should eq(2)
+
+    @index.clear_rules!
+    @index.search_rules('')['nbHits'].should eq(0)
+  end
+
   context 'DNS timeout' do
     before(:each) do
       @client = Algolia::Client.new :application_id => ENV['ALGOLIA_APPLICATION_ID'], :api_key => ENV['ALGOLIA_API_KEY'],

data/spec/mock_spec.rb

@@ -16,7 +16,7 @@ describe 'With a mocked client' do
   it "should add a simple object" do
     index = Algolia::Index.new("friends")
     index.add_object!({ :name => "John Doe", :email => "john@doe.org" })
-    index.search('').should == { "hits" => [ { "objectID" => 42 } ], "page" => 1, "hitsPerPage" => 1 } # mocked
+    index.search('').should == { "hits" => [ { "objectID" => 42 } ], "page" => 1, "hitsPerPage" => 1, "nbHits"=>1, "nbPages"=>1 } # mocked
     index.list_api_keys
     index.browse
     index.clear

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algoliasearch
 version: !ruby/object:Gem::Version
-  version: 1.15.1
+  version: 1.16.0
 platform: ruby
 authors:
 - Algolia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-19 00:00:00.000000000 Z
+date: 2017-09-14 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.8
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: A simple Ruby client for the algolia.com REST API