algoliasearch 1.8.1 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 249bdbdfe9306f6396363418d097060519a2b666
-  data.tar.gz: 29cd2a19ac2652eb9b19ec9a6e1a4e74aa9d6faf
+  metadata.gz: 1035690a7833a5235345419a3376a771932d281e
+  data.tar.gz: d7eb3c02b159845109c25b7e49b61191e72a2d2d
 SHA512:
-  metadata.gz: c5fdf482ba1c5734c95009719c836132b7e1e18d810a7959d6d48bd767669648e8d75221103f2080359cbe8d611c17575b42da65ddfc60b22ed76a1a0e88e4ce
-  data.tar.gz: c1ddb83fbc011fb659831ba67545d7ed2b65ed8d2320fc16f76749d46a097a7cc22b92e44908eff216d636ecdf3f0d49b3f43ac9178f72a65dc1d5b0eba03e35
+  metadata.gz: 57f1c99c147f759f6c6a70ecae88b30ec607ab886d720fcc426bf47b1a528028494b54d2edbfd40eb2e560074866b6453fd5727e117ecb9e26abe98ec14f91b3
+  data.tar.gz: b19a6880521c58d9fd74a4b62244b61aeb348b7f61c06aaf6d90e0565681c4daf2cb5f16d4fa8bcec60a3c2d9762b0d521ac12e742715f7028d56b2589b942f0

data/.travis.yml

@@ -8,6 +8,7 @@ rvm:
 - 2.0.0
 - 2.1.5
 - 2.2.2
+- 2.3.0
 - jruby
 - rbx-2
 install:

data/ChangeLog

@@ -1,5 +1,8 @@
 CHANGELOG
 
+2016-06-17 1.9.0
+      * New synonyms API
+
 2016-04-14 1.8.1
       * Ensure we're using an absolute path for the `ca-bundle.crt` file (could fix some `OpenSSL::X509::StoreError: system lib` errors)
 

data/Gemfile

@@ -1,4 +1,4 @@
-source 'http://rubygems.org'
+source 'https://rubygems.org'
 
 gem 'httpclient', '~> 2.7.1'
 gem 'json', '>= 1.5.1'
@@ -8,7 +8,6 @@ group :development do
   gem 'highline', '< 1.7.0'
   gem 'coveralls'
   gem 'safe_yaml', '~> 1.0.4'
-  gem 'rest-client', '1.6.8'
   gem 'travis'
   gem 'rake'
   gem 'rdoc'

data/Gemfile.lock

@@ -1,15 +1,15 @@
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
     addressable (2.3.7)
     backports (3.6.4)
     coderay (1.1.0)
-    coveralls (0.7.11)
-      multi_json (~> 1.10)
-      rest-client (>= 1.6.8, < 2)
-      simplecov (~> 0.9.1)
+    coveralls (0.8.13)
+      json (~> 1.8)
+      simplecov (~> 0.11.0)
       term-ansicolor (~> 1.3)
       thor (~> 0.19.1)
+      tins (~> 1.6.0)
     crack (0.4.2)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.2.5)
@@ -32,8 +32,8 @@ GEM
       net-http-pipeline
     highline (1.6.21)
     httpclient (2.7.1)
-    json (1.8.2)
-    json (1.8.2-java)
+    json (1.8.3)
+    json (1.8.3-java)
     launchy (2.4.3)
       addressable (~> 2.3)
     launchy (2.4.3-java)
@@ -41,7 +41,7 @@ GEM
       spoon (~> 0.0.1)
     method_source (0.8.2)
     mime-types (1.25.1)
-    multi_json (1.10.1)
+    multi_json (1.12.0)
     multipart-post (2.0.0)
     net-http-persistent (2.9.4)
     net-http-pipeline (1.0.1)
@@ -58,12 +58,9 @@ GEM
       json
       websocket (~> 1.0)
     rake (10.4.2)
-    rdoc (4.2.0)
+    rdoc (4.2.2)
       json (~> 1.4)
     redgreen (1.2.2)
-    rest-client (1.6.8)
-      mime-types (~> 1.16)
-      rdoc (>= 2.4.2)
     rspec (3.2.0)
       rspec-core (~> 3.2.0)
       rspec-expectations (~> 3.2.0)
@@ -277,18 +274,18 @@ GEM
     rubysl-yaml (2.1.0)
     rubysl-zlib (2.0.1)
     safe_yaml (1.0.4)
-    simplecov (0.9.2)
+    simplecov (0.11.2)
       docile (~> 1.1.0)
-      multi_json (~> 1.0)
-      simplecov-html (~> 0.9.0)
-    simplecov-html (0.9.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
     slop (3.6.0)
     spoon (0.0.4)
       ffi
-    term-ansicolor (1.3.0)
+    term-ansicolor (1.3.2)
       tins (~> 1.0)
     thor (0.19.1)
-    tins (1.3.4)
+    tins (1.6.0)
     travis (1.7.5)
       addressable (~> 2.3)
       backports
@@ -320,7 +317,6 @@ DEPENDENCIES
   rake
   rdoc
   redgreen
-  rest-client (= 1.6.8)
   rspec (>= 2.5.0)
   rubysl (~> 2.0)
   safe_yaml (~> 1.0.4)

data/README.md

@@ -18,8 +18,8 @@ Our Ruby client lets you easily use the [Algolia Search API](https://www.algolia
 
 
 
+[![Build Status](https://travis-ci.org/algolia/algoliasearch-client-ruby.svg?branch=master)](https://travis-ci.org/algolia/algoliasearch-client-ruby) [![Gem Version](https://badge.fury.io/rb/algoliasearch.svg)](http://badge.fury.io/rb/algoliasearch) [![Code Climate](https://codeclimate.com/github/algolia/algoliasearch-client-ruby.svg)](https://codeclimate.com/github/algolia/algoliasearch-client-ruby) [![Coverage Status](https://coveralls.io/repos/algolia/algoliasearch-client-ruby/badge.svg)](https://coveralls.io/r/algolia/algoliasearch-client-ruby)
 
-[![Build Status](https://travis-ci.org/algolia/algoliasearch-client-ruby.svg?branch=master)](https://travis-ci.org/algolia/algoliasearch-client-ruby) [![Gem Version](https://badge.fury.io/rb/algoliasearch.svg)](http://badge.fury.io/rb/algoliasearch) [![Code Climate](https://codeclimate.com/github/algolia/algoliasearch-client-ruby.svg)](https://codeclimate.com/github/algolia/algoliasearch-client-ruby) [![Coverage Status](https://coveralls.io/repos/algolia/algoliasearch-client-ruby/badge.png)](https://coveralls.io/r/algolia/algoliasearch-client-ruby)
 
 
 
@@ -32,7 +32,6 @@ Table of Contents
 
 1. [Setup](#setup)
 1. [Quick Start](#quick-start)
-
 1. [Guides & Tutorials](#guides-tutorials)
 
 
@@ -196,7 +195,7 @@ Check our [online guides](https://www.algolia.com/doc):
 Add a new object to the Index
 ==================
 
-Each entry in an index has a unique identifier called `objectID`. There are two ways to add en entry to the index:
+Each entry in an index has a unique identifier called `objectID`. There are two ways to add an entry to the index:
 
  1. Using automatic `objectID` assignment. You will be able to access it in the answer.
  2. Supplying your own `objectID`.
@@ -306,7 +305,7 @@ Search
 
 To perform a search, you only need to initialize the index and perform a call to the search function.
 
-The search query allows only to retrieve 1000 hits, if you need to retrieve more than 1000 hits for seo, you can use [Backup / Retrieve all index content](#backup--retrieve-of-all-index-content)
+The search query allows only to retrieve 1000 hits, if you need to retrieve more than 1000 hits for seo, you can use [Backup / Retrieve all index content](#backup--export-an-index)
 
 ```ruby
 index = Algolia::Index.new("contacts")
@@ -801,6 +800,8 @@ You can use the following optional arguments:
 
 <p>Attributes are separated with a comma (for example <code>&quot;name,address&quot;</code>). You can also use a string array encoding (for example <code>[&quot;name&quot;,&quot;address&quot;]</code> ). By default, all attributes are retrieved. You can also use <code>*</code> to retrieve all values when an <strong>attributesToRetrieve</strong> setting is specified for your index.</p>
 
+<p><code>objectID</code> is always retrieved even when not specified.</p>
+
       </td>
     </tr>
     
@@ -909,7 +910,7 @@ You can use the following optional arguments:
         </div>
       </td>
       <td class='client-readme-param-content'>
-        <p>String used as an ellipsis indicator when a snippet is truncated (defaults to empty).</p>
+        <p>String used as an ellipsis indicator when a snippet is truncated. Defaults to an empty string for all accounts created before 10/2/2016, and to <code>…</code> (UTF-8 U+2026) for accounts created after that date.</p>
 
       </td>
     </tr>
@@ -963,7 +964,7 @@ You can also use a string array encoding (for example `numericFilters: ["price>1
         </div>
       </td>
       <td class='client-readme-param-content'>
-        <p>Filter the query by a set of tags. You can AND tags by separating them with commas. To OR tags, you must add parentheses. For example, <code>tags=tag1,(tag2,tag3)</code> means <em>tag1 AND (tag2 OR tag3)</em>. You can also use a string array encoding. For example, <code>tagFilters: [&quot;tag1&quot;,[&quot;tag2&quot;,&quot;tag3&quot;]]</code> means <em>tag1 AND (tag2 OR tag3)</em>.</p>
+        <p>Filter the query by a set of tags. You can AND tags by separating them with commas. To OR tags, you must add parentheses. For example, <code>tagFilters=tag1,(tag2,tag3)</code> means <em>tag1 AND (tag2 OR tag3)</em>. You can also use a string array encoding. For example, <code>tagFilters: [&quot;tag1&quot;,[&quot;tag2&quot;,&quot;tag3&quot;]]</code> means <em>tag1 AND (tag2 OR tag3)</em>. Negations are supported via the <code>-</code> operator, prefixing the value. For example: <code>tagFilters=tag1,-tag2</code>.</p>
 
 <p>At indexing, tags should be added in the <strong>_tags</strong> attribute of objects. For example <code>{&quot;_tags&quot;:[&quot;tag1&quot;,&quot;tag2&quot;]}</code>.</p>
 
@@ -1047,9 +1048,11 @@ You can also use a string array encoding (for example `numericFilters: ["price>1
       </td>
       <td class='client-readme-param-content'>
         <p>Filter the query with numeric, facet or/and tag filters. The syntax is a SQL like syntax, you can use the OR and AND keywords. The syntax for the underlying numeric, facet and tag filters is the same than in the other filters:
-<code>available=1 AND (category:Book OR NOT category:Ebook) AND public</code>
+<code>available=1 AND (category:Book OR NOT category:Ebook) AND _tags:public</code>
 <code>date: 1441745506 TO 1441755506 AND inStock &gt; 0 AND author:&quot;John Doe&quot;</code></p>
 
+<p>If no attribute name is specified, the filter applies to <code>_tags</code>. For example: <code>public OR user_42</code> will translate to <code>_tags:public OR _tags:user_42</code>.</p>
+
 <p>The list of keywords is:</p>
 
 <ul>
@@ -1111,7 +1114,7 @@ You can send multiple queries with a single API call using a batch of queries:
 # - 1st query targets index `categories`
 # - 2nd and 3rd queries target index `products`
 res = Algolia.multiple_queries([{:index_name => "categories", "query" => my_query_string, "hitsPerPage" => 3}
-  , {:index_name => "products", "query" => my_query_string, "hitsPerPage" => 3, "tagFilters" => "promotion"}
+  , {:index_name => "products", "query" => my_query_string, "hitsPerPage" => 3, "filters" => "_tags:promotion"}
   , {:index_name => "products", "query" => my_query_string, "hitsPerPage" => 10}])
 
 puts res["results"]
@@ -1154,12 +1157,12 @@ You can delete an object using its `objectID`:
 index.delete_object("myID")
 ```
 
-
 Delete by query
 ==================
 
 You can delete all objects matching a single query with the following code. Internally, the API client performs the query, deletes all matching hits, and waits until the deletions have been applied.
 
+
 ```ruby
 params = {}
 index.delete_by_query("John", params)
@@ -1472,6 +1475,38 @@ To get a full description of how the Ranking works, you can have a look at our <
     </tr>
     
   
+    <tr>
+      <td valign='top'>
+        <div class='client-readme-param-container'>
+          <div class='client-readme-param-container-inner'>
+            <div class='client-readme-param-name'><code>disablePrefixOnAttributes</code></div>
+            <div class="client-readme-param-meta"><div><em>Type: <strong>string array</strong></em></div></div>
+          </div>
+        </div>
+      </td>
+      <td class='client-readme-param-content'>
+        <p>List of attributes on which you want to disable prefix matching (must be a subset of the <code>attributesToIndex</code> index setting). This setting is useful on attributes that contain string that should not be matched as a prefix (for example a product SKU). By default the list is empty.</p>
+
+      </td>
+    </tr>
+    
+  
+    <tr>
+      <td valign='top'>
+        <div class='client-readme-param-container'>
+          <div class='client-readme-param-container-inner'>
+            <div class='client-readme-param-name'><code>disableExactOnAttributes</code></div>
+            <div class="client-readme-param-meta"><div><em>Type: <strong>string array</strong></em></div></div>
+          </div>
+        </div>
+      </td>
+      <td class='client-readme-param-content'>
+        <p>List of attributes on which you want to disable the computation of <code>exact</code> criteria (must be a subset of the <code>attributesToIndex</code> index setting). By default the list is empty.</p>
+
+      </td>
+    </tr>
+    
+  
     <tr>
       <td valign='top'>
         <div class='client-readme-param-container'>
@@ -1929,7 +1964,6 @@ The move command is particularly useful if you want to update a big index atomic
 puts Algolia.move_index("MyNewIndex", "MyIndex")
 ```
 
-
 Backup / Export an index
 ==================
 
@@ -1947,18 +1981,20 @@ Example:
 
 ```ruby
 # Iterate with a filter over the index
-index.browse({:query => "test", :numericFilters => 'i=42'}) do
-	# Do something
+index.browse({:query => "test", :filters => 'i=42'}) do |hit|
+  # Do something
 end
 ```
 
 
 
 
+
 API Keys
 ==================
 
-The ADMIN API key provides full control of all your indices.
+The **admin** API key provides full control of all your indices. *The admin API key should always be kept secure; do NOT use it from outside your back-end.*
+
 You can also generate user API keys to control security.
 These API keys can be restricted to a set of operations or/and restricted to a given index.
 
@@ -2183,7 +2219,7 @@ You may have a single index containing **per user** data. In that case, all reco
 ```ruby
 # generate a public API key for user 42. Here, records are tagged with:
 #  - 'user_XXXX' if they are visible by user XXXX
-public_key = Algolia.generate_secured_api_key 'YourSearchOnlyApiKey', {'tagFilters'=> 'user_42'}
+public_key = Algolia.generate_secured_api_key 'YourSearchOnlyApiKey', {'filters'=> '_tags:user_42'}
 ```
 
 This public API key can then be used in your JavaScript code as follow:
@@ -2208,7 +2244,7 @@ You can mix rate limits and secured API keys by setting a `userToken` query para
 ```ruby
 # generate a public API key for user 42. Here, records are tagged with:
 #  - 'user_XXXX' if they are visible by user XXXX
-public_key = Algolia.generate_secured_api_key 'YourSearchOnlyApiKey', {'tagFilters'=> 'user_42', 'userToken'=> 'user_42'}
+public_key = Algolia.generate_secured_api_key 'YourSearchOnlyApiKey', {'filters'=> '_tags:user_42', 'userToken'=> 'user_42'}
 ```
 
 This public API key can then be used in your JavaScript code as follow:
@@ -2229,6 +2265,8 @@ index.search('another query', function(err, content) {
 ```
 
 
+
+
 Logs
 ==================
 

data/lib/algolia/index.rb

@@ -176,23 +176,24 @@ module Algolia
     # @param hitsPerPage: Pagination parameter used to select the number of hits per page. Defaults to 1000.
     #
     def browse(pageOrQueryParameters = nil, hitsPerPage = nil, &block)
+      params = {}
+      if pageOrQueryParameters.is_a?(Hash)
+        params.merge!(pageOrQueryParameters)
+      else
+        params[:page] = pageOrQueryParameters unless pageOrQueryParameters.nil?
+      end
+      if hitsPerPage.is_a?(Hash)
+        params.merge!(hitsPerPage)
+      else
+        params[:hitsPerPage] = hitsPerPage unless hitsPerPage.nil?
+      end
+
       if block_given?
-        params = {}
-        if pageOrQueryParameters.is_a?(Hash)
-          params.merge!(pageOrQueryParameters)
-        else
-          params[:page] = pageOrQueryParameters unless pageOrQueryParameters.nil?
-        end
-        if hitsPerPage.is_a?(Hash)
-          params.merge!(hitsPerPage)
-        else
-          params[:hitsPerPage] = hitsPerPage unless hitsPerPage.nil?
-        end
         IndexBrowser.new(client, name, params).browse(&block)
       else
-        pageOrQueryParameters ||= 0
-        hitsPerPage ||= 1000
-        client.get(Protocol.browse_uri(name, {:page => pageOrQueryParameters, :hitsPerPage => hitsPerPage}), :read)
+        params[:page] ||= 0
+        params[:hitsPerPage] ||= 1000
+        client.get(Protocol.browse_uri(name, params), :read)
       end
     end
 
@@ -378,7 +379,9 @@ module Algolia
     # @param query the query string
     # @param params the optional query parameters
     #
-    def delete_by_query(query, params = {})
+    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)
@@ -416,61 +419,21 @@ module Algolia
     #
     # Set settings for this index
     #
-    # @param settigns the settings object that can contains :
-    # - minWordSizefor1Typo: (integer) the minimum number of characters to accept one typo (default = 3).
-    # - minWordSizefor2Typos: (integer) the minimum number of characters to accept two typos (default = 7).
-    # - hitsPerPage: (integer) the number of hits per page (default = 10).
-    # - attributesToRetrieve: (array of strings) default list of attributes to retrieve in objects.
-    #   If set to null, all attributes are retrieved.
-    # - attributesToHighlight: (array of strings) default list of attributes to highlight.
-    #   If set to null, all indexed attributes are highlighted.
-    # - attributesToSnippet**: (array of strings) default list of attributes to snippet alongside the number of words to return (syntax is attributeName:nbWords).
-    #   By default no snippet is computed. If set to null, no snippet is computed.
-    # - attributesToIndex: (array of strings) the list of fields you want to index.
-    #   If set to null, all textual and numerical attributes of your objects are indexed, but you should update it to get optimal results.
-    #   This parameter has two important uses:
-    #     - Limit the attributes to index: For example if you store a binary image in base64, you want to store it and be able to
-    #       retrieve it but you don't want to search in the base64 string.
-    #     - Control part of the ranking*: (see the ranking parameter for full explanation) Matches in attributes at the beginning of
-    #       the list will be considered more important than matches in attributes further down the list.
-    #       In one attribute, matching text at the beginning of the attribute will be considered more important than text after, you can disable
-    #       this behavior if you add your attribute inside `unordered(AttributeName)`, for example attributesToIndex: ["title", "unordered(text)"].
-    # - attributesForFaceting: (array of strings) The list of fields you want to use for faceting.
-    #   All strings in the attribute selected for faceting are extracted and added as a facet. If set to null, no attribute is used for faceting.
-    # - attributeForDistinct: (string) The attribute name used for the Distinct feature. This feature is similar to the SQL "distinct" keyword: when enabled
-    #   in query with the distinct=1 parameter, all hits containing a duplicate value for this attribute are removed from results.
-    #   For example, if the chosen attribute is show_name and several hits have the same value for show_name, then only the best one is kept and others are removed.
-    # - ranking: (array of strings) controls the way results are sorted.
-    #   We have six available criteria:
-    #    - typo: sort according to number of typos,
-    #    - geo: sort according to decreassing distance when performing a geo-location based search,
-    #    - proximity: sort according to the proximity of query words in hits,
-    #    - attribute: sort according to the order of attributes defined by attributesToIndex,
-    #    - exact:
-    #        - if the user query contains one word: sort objects having an attribute that is exactly the query word before others.
-    #          For example if you search for the "V" TV show, you want to find it with the "V" query and avoid to have all popular TV
-    #          show starting by the v letter before it.
-    #        - if the user query contains multiple words: sort according to the number of words that matched exactly (and not as a prefix).
-    #    - custom: sort according to a user defined formula set in **customRanking** attribute.
-    #   The standard order is ["typo", "geo", "proximity", "attribute", "exact", "custom"]
-    # - customRanking: (array of strings) lets you specify part of the ranking.
-    #   The syntax of this condition is an array of strings containing attributes prefixed by asc (ascending order) or desc (descending order) operator.
-    #   For example `"customRanking" => ["desc(population)", "asc(name)"]`
-    # - queryType: Select how the query words are interpreted, it can be one of the following value:
-    #   - prefixAll: all query words are interpreted as prefixes,
-    #   - prefixLast: only the last word is interpreted as a prefix (default behavior),
-    #   - prefixNone: no query word is interpreted as a prefix. This option is not recommended.
-    # - highlightPreTag: (string) Specify the string that is inserted before the highlighted parts in the query result (default to "<em>").
-    # - highlightPostTag: (string) Specify the string that is inserted after the highlighted parts in the query result (default to "</em>").
-    # - optionalWords: (array of strings) Specify a list of words that should be considered as optional when found in the query.
-    #
     def set_settings(new_settings)
       client.put(Protocol.settings_uri(name), new_settings.to_json)
     end
 
+    # Set settings for this index and wait end of indexing
+    #
+    def set_settings!(new_settings)
+      res = set_settings(new_settings)
+      wait_task(res["taskID"])
+      return res
+    end
+
     # Get settings of this index
     def get_settings
-      client.get(Protocol.settings_uri(name), :read)
+      client.get("#{Protocol.settings_uri(name)}?getVersion=2", :read)
     end
 
     # List all existing user keys with their associated ACLs
@@ -683,6 +646,105 @@ module Algolia
       Algolia.list_indexes
     end
 
+    # Search synonyms
+    #
+    # @param query the query
+    # @param params an optional hash of :type, :page, :hitsPerPage
+    def search_synonyms(query, params = {})
+      type = params[:type] || params['type']
+      type = type.join(',') if type.is_a?(Array)
+      page = params[:page] || params['page'] || 0
+      hits_per_page = params[:hitsPerPage] || params['hitsPerPage'] || 20
+      params = {
+        :query => query,
+        :type => type.to_s,
+        :page => page,
+        :hitsPerPage => hits_per_page
+      }
+      client.post(Protocol.search_synonyms_uri(name), params.to_json, :read)
+    end
+
+    # Get a synonym
+    #
+    # @param objectID the synonym objectID
+    def get_synonym(objectID)
+      client.get(Protocol.synonym_uri(name, objectID), :read)
+    end
+
+    # Delete a synonym
+    #
+    # @param objectID the synonym objectID
+    # @param forward_to_slaves should we forward the delete to slave indices
+    def delete_synonym(objectID, forward_to_slaves = false)
+      client.delete("#{Protocol.synonym_uri(name, objectID)}?forwardToSlaves=#{forward_to_slaves}", :write)
+    end
+
+    # Delete a synonym and wait the end of indexing
+    #
+    # @param objectID the synonym objectID
+    # @param forward_to_slaves should we forward the delete to slave indices
+    def delete_synonym!(objectID, forward_to_slaves = false)
+      res = delete_synonym(objectID, forward_to_slaves)
+      wait_task(res["taskID"])
+      return res
+    end
+
+    # Save a synonym
+    #
+    # @param objectID the synonym objectID
+    # @param synonym the synonym
+    # @param forward_to_slaves should we forward the delete to slave indices
+    def save_synonym(objectID, synonym, forward_to_slaves = false)
+      client.put("#{Protocol.synonym_uri(name, objectID)}?forwardToSlaves=#{forward_to_slaves}", synonym.to_json, :write)
+    end
+
+    # Save a synonym and wait the end of indexing
+    #
+    # @param objectID the synonym objectID
+    # @param synonym the synonym
+    # @param forward_to_slaves should we forward the delete to slave indices
+    def save_synonym!(objectID, synonym, forward_to_slaves = false)
+      res = save_synonym(objectID, synonym, forward_to_slaves)
+      wait_task(res["taskID"])
+      return res
+    end
+
+    # Clear all synonyms
+    #
+    # @param forward_to_slaves should we forward the delete to slave indices
+    def clear_synonyms(forward_to_slaves = false)
+      client.post("#{Protocol.clear_synonyms_uri(name)}?forwardToSlaves=#{forward_to_slaves}", :write)
+    end
+
+    # Clear all synonyms and wait the end of indexing
+    #
+    # @param forward_to_slaves should we forward the delete to slave indices
+    def clear_synonyms!(forward_to_slaves = false)
+      res = clear_synonyms(forward_to_slaves)
+      wait_task(res["taskID"])
+      return res
+    end
+
+    # Add/Update an array of synonyms
+    #
+    # @param synonyms the array of synonyms to add/update
+    # @param forward_to_slaves should we forward the delete to slave indices
+    # @param replace_existing_synonyms should we replace the existing synonyms before adding the new ones
+    def batch_synonyms(synonyms, forward_to_slaves = false, replace_existing_synonyms = false)
+      client.post("#{Protocol.batch_synonyms_uri(name)}?forwardToSlaves=#{forward_to_slaves}&replaceExistingSynonyms=#{replace_existing_synonyms}", synonyms.to_json, :batch)
+    end
+
+    # Add/Update an array of synonyms and wait the end of indexing
+    #
+    # @param synonyms the array of synonyms to add/update
+    # @param forward_to_slaves should we forward the delete to slave indices
+    # @param replace_existing_synonyms should we replace the existing synonyms before adding the new ones
+    def batch_synonyms!(synonyms, forward_to_slaves = false, replace_existing_synonyms = false)
+      res = batch_synonyms(synonyms, forward_to_slaves, replace_existing_synonyms)
+      wait_task(res["taskID"])
+      return res
+    end
+
     private
     def check_array(objs)
       raise ArgumentError.new("argument must be an array of objects") if !objs.is_a?(Array)

data/lib/algolia/protocol.rb

@@ -5,7 +5,7 @@ module Algolia
   module Protocol
 
     # Basics
- 
+
     # The version of the REST API implemented by this module.
     VERSION         = 1
 
@@ -19,11 +19,11 @@ module Algolia
     # The HTTP header used for passing your API key to the
     # Algolia API.
     HEADER_API_KEY  = "X-Algolia-API-Key"
-    
+
     HEADER_FORWARDED_IP = "X-Forwarded-For"
 
     HEADER_FORWARDED_API_KEY = "X-Forwarded-API-Key"
-    
+
     # HTTP ERROR CODES
     # ----------------------------------------
 
@@ -35,7 +35,7 @@ module Algolia
     # ----------------------------------------
 
     # Construct a uri to list available indexes
-    def Protocol.indexes_uri      
+    def Protocol.indexes_uri
       "/#{VERSION}/indexes"
     end
 
@@ -54,8 +54,8 @@ module Algolia
 
     def Protocol.batch_uri(index = nil)
       "#{index.nil? ? "/#{VERSION}/indexes/*" : index_uri(index)}/batch"
-    end  
-    
+    end
+
     def Protocol.index_operation_uri(index)
       "#{index_uri(index)}/operation"
     end
@@ -63,7 +63,7 @@ module Algolia
     def Protocol.task_uri(index, task_id)
       "#{index_uri(index)}/task/#{task_id}"
     end
-    
+
     def Protocol.object_uri(index, object_id, params = {})
       params = params.nil? || params.size == 0 ? "" : "?#{to_query(params)}"
       "#{index_uri(index)}/#{CGI.escape(object_id.to_s)}#{params}"
@@ -87,15 +87,15 @@ module Algolia
       params = create_if_not_exits ? "" : "?createIfNotExists=false"
       "#{index_uri(index)}/#{CGI.escape(object_id)}/partial#{params}"
     end
-    
+
     def Protocol.settings_uri(index)
       "#{index_uri(index)}/settings"
     end
-    
+
     def Protocol.clear_uri(index)
       "#{index_uri(index)}/clear"
     end
-    
+
     def Protocol.logs(offset, length, only_errors = false)
       "/#{VERSION}/logs?offset=#{offset}&length=#{length}&onlyErrors=#{only_errors}"
     end
@@ -121,6 +121,26 @@ module Algolia
         "#{CGI.escape(k.to_s)}=#{CGI.escape(v.to_s)}"
       end.join('&')
     end
-    
+
+    def Protocol.synonyms_uri(index)
+      "#{index_uri(index)}/synonyms"
+    end
+
+    def Protocol.synonym_uri(index, object_id)
+      "#{synonyms_uri(index)}/#{CGI.escape(object_id)}"
+    end
+
+    def Protocol.search_synonyms_uri(index)
+      "#{synonyms_uri(index)}/search"
+    end
+
+    def Protocol.clear_synonyms_uri(index)
+      "#{synonyms_uri(index)}/clear"
+    end
+
+    def Protocol.batch_synonyms_uri(index)
+      "#{synonyms_uri(index)}/batch"
+    end
+
   end
 end

data/lib/algolia/version.rb

@@ -1,3 +1,3 @@
 module Algolia
-  VERSION = "1.8.1"
+  VERSION = "1.9.0"
 end

data/spec/client_spec.rb

@@ -225,6 +225,10 @@ describe 'Client' do
     @index.search('')['nbHits'].should eq(0)
   end
 
+  it "should not wipe the entire index with delete_by_query" do
+    expect { @index.delete_by_query(nil) }.to raise_error(ArgumentError)
+  end
+
   it "should copy the index" do
     index = Algolia::Index.new(safe_index_name("àlgol?à"))
     begin
@@ -373,52 +377,111 @@ describe 'Client' do
     res['facets']['g']['g2'].should be_nil
   end
 
-  it "should test keys" do
+  def wait_key(index, key, &block)
+    1.upto(60) do # do not wait too long
+      begin
+        k = index.get_user_key(key)
+        if block_given?
+          return if yield k
+          # not found
+          sleep 1
+          next
+        end
+        return
+      rescue
+        # not found
+        sleep 1
+      end
+    end
+  end
+
+  def wait_key_missing(index, key)
+    1.upto(60) do # do not wait too long
+      begin
+        k = index.get_user_key(key)
+        sleep 1
+      rescue
+        # not found
+        return
+      end
+    end
+  end
+
+  def wait_global_key(key, &block)
+    1.upto(60) do # do not wait too long
+      begin
+        k = Algolia.get_user_key(key)
+        if block_given?
+          return if yield k
+          # not found
+          sleep 1
+          next
+        end
+        return
+      rescue
+        # not found
+        sleep 1
+      end
+    end
+  end
+
+  def wait_global_key_missing(key)
+    1.upto(60) do # do not wait too long
+      begin
+        k = Algolia.get_user_key(key)
+        sleep 1
+      rescue
+        # not found
+        return
+      end
+    end
+  end
+
+  it "should test index keys" do
+    @index.set_settings!({}) # ensure the index exists
     resIndex = @index.list_user_keys
     newIndexKey = @index.add_user_key(['search'])
     newIndexKey['key'].should_not eq("")
-    sleep 5 # no task ID here
+    wait_key(@index, newIndexKey['key'])
     resIndexAfter = @index.list_user_keys
     is_include(resIndex['keys'], 'value', newIndexKey['key']).should eq(false)
     is_include(resIndexAfter['keys'], 'value', newIndexKey['key']).should eq(true)
     indexKey = @index.get_user_key(newIndexKey['key'])
     indexKey['acl'][0].should eq('search')
     @index.update_user_key(newIndexKey['key'], ['addObject'])
-    sleep 5 # no task ID here
+    wait_key(@index, newIndexKey['key']) do |key|
+      key['acl'] == ['addObject']
+    end
     indexKey = @index.get_user_key(newIndexKey['key'])
     indexKey['acl'][0].should eq('addObject')
     @index.delete_user_key(newIndexKey['key'])
-    sleep 5 # no task ID here
+    wait_key_missing(@index, newIndexKey['key'])
     resIndexEnd = @index.list_user_keys
     is_include(resIndexEnd['keys'], 'value', newIndexKey['key']).should eq(false)
+  end
 
-
+  it "should test global keys" do
     res = Algolia.list_user_keys
     newKey = Algolia.add_user_key(['search'])
     newKey['key'].should_not eq("")
-    sleep 5 # no task ID here
+    wait_global_key(newKey['key'])
     resAfter = Algolia.list_user_keys
     is_include(res['keys'], 'value', newKey['key']).should eq(false)
     is_include(resAfter['keys'], 'value', newKey['key']).should eq(true)
     key = Algolia.get_user_key(newKey['key'])
     key['acl'][0].should eq('search')
     Algolia.update_user_key(newKey['key'], ['addObject'])
-    sleep 5 # no task ID here
+    wait_global_key(newKey['key']) do |key|
+      key['acl'] == ['addObject']
+    end
     key = Algolia.get_user_key(newKey['key'])
     key['acl'][0].should eq('addObject')
     Algolia.delete_user_key(newKey['key'])
-    sleep 5 # no task ID here
+    wait_global_key_missing(newKey['key'])
     resEnd = Algolia.list_user_keys
     is_include(resEnd['keys'], 'value', newKey['key']).should eq(false)
   end
 
-  it "should check functions" do
-    @index.get_settings
-    @index.list_user_keys
-    Algolia.list_user_keys
-
-  end
-
   it "should handle slash in objectId" do
     @index.clear_index!()
     @index.add_object!({:firstname => "Robert", :objectID => "A/go/?a"})
@@ -808,4 +871,47 @@ describe 'Client' do
     @index.browse_from(answer['cursor'])['hits'].size.should eq(500)
   end
 
+  it "should test synonyms" do
+    @index.add_object! :name => '589 Howard St., San Francisco'
+    @index.search('Howard St San Francisco')['nbHits'].should eq(1)
+    @index.batch_synonyms! [
+      { :objectID => 'city', :type => 'synonym', :synonyms => ['San Francisco', 'SF'] },
+      { :objectID => 'street', :type => 'altCorrection1', :word => 'street', :corrections => ['st'] }
+    ]
+    @index.search_synonyms('')['nbHits'].should eq(2)
+    @index.search('Howard St SF')['nbHits'].should eq(1)
+
+    s = @index.get_synonym('city')
+    s['objectID'].should eq('city')
+    s['type'].should eq('synonym')
+
+    @index.search('Howard Street')['nbHits'].should eq(1)
+
+    @index.delete_synonym! 'city'
+    @index.search('Howard Street SF')['nbHits'].should eq(0)
+
+    @index.clear_synonyms!
+    @index.search_synonyms('')['nbHits'].should eq(0)
+  end
+
+  context 'DNS timeout' do
+    before(:all) do
+      @client = Algolia::Client.new :application_id => ENV['ALGOLIA_APPLICATION_ID'], :api_key => ENV['ALGOLIA_API_KEY'],
+        :hosts => [
+          "#{ENV['ALGOLIA_APPLICATION_ID']}.algolia.biz",
+          "#{ENV['ALGOLIA_APPLICATION_ID']}.algolia.net",
+          "#{ENV['ALGOLIA_APPLICATION_ID']}-1.algolianet.com",
+          "#{ENV['ALGOLIA_APPLICATION_ID']}-2.algolianet.com",
+          "#{ENV['ALGOLIA_APPLICATION_ID']}-3.algolianet.com"
+        ],
+        :connect_timeout => 5
+    end
+
+    it "should fallback to the 2nd host after a few seconds" do
+      start_time = Time.now
+      @client.list_indexes # fallback on the second host after 5 sec (connection timeout)
+      expect(start_time.to_i + 5).to be <= Time.now.to_i + 1
+    end
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algoliasearch
 version: !ruby/object:Gem::Version
-  version: 1.8.1
+  version: 1.9.0
 platform: ruby
 authors:
 - Algolia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-14 00:00:00.000000000 Z
+date: 2016-06-17 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.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A simple Ruby client for the algolia.com REST API