algoliasearch 1.2.8 → 1.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eaaabc5a559b204abd97ed48ee06b40414ed2201
-  data.tar.gz: 1d90fa315597cf218329b1c6bd5798c83cc688e5
+  metadata.gz: 3c2d37bc8e01bf59c2a23fd08ec86229e6b37f95
+  data.tar.gz: f2890ed7e2c1103ca6004ac91792c4c0ac3d62ac
 SHA512:
-  metadata.gz: de132995a5dcdef698e3a9fc949637925ea6922adbf6f4504de770f932781e0e4b019d65ad1d9285476ffd6530f33dffe261ab1406895333c6a44a5f06de220d
-  data.tar.gz: 035cf82798698c855d733d6e0aeb41fd468d6c671541d8d1e4180648d14e343e13ca55853e45b91051c5930e420053f3c564c7b353a97df3e9d3ca6b4336a383
+  metadata.gz: a83669bc6eedf16e80419534844ad6a654a9e8fb675800e5f68393689c205a77187a2c00fd1c82755d9ef68d4147be666a6c5a0fa97bafea9c0fbddc7b0de161
+  data.tar.gz: dee9c83ce0c9246f667663f1e683efda2f3e5c81476c61f3e75760438ccd6af3ab3fd77814a8149a5f1f9034f8fc59f467d9e3eefe0a7ebb015d11f62888a74d

data/.travis.yml

@@ -8,7 +8,7 @@ rvm:
 - 2.0.0
 - 1.9.3
 - jruby
-- rbx
+- rbx-2
 env:
   global:
   - secure: lBLtTjQyeJW7+TWgGmf1mmsXgUzsTnq3/KHvCk+BvOGwoHXTBR1Y6yiczWWHEP4/wBeXXm31xUQC+VoYc/7Ev/2NNB/mqlXAgGw+D0nwQriNXjYt1WV6lQvyoiaUzQ+w+7VahWdx0LuKvSYI+khe8M8BfHQqYacu0VlpAUnjb2I=

data/ChangeLog

@@ -1,5 +1,11 @@
 CHANGELOG
 
+2014-07-08  1.2.9
+
+      * Add new 'delete_by_query' method to delete all objects matching a specific query
+      * Add new 'get_objects' method to retrieve a list of objects from a single API call
+      * Add a helper to perform disjunctive faceting
+
 2014-03-27  1.2.8
 
       * Catch all exceptions before retrying with another host

data/Gemfile

@@ -19,4 +19,5 @@ group :test do
   gem 'autotest-growl'
   gem 'webmock'
   gem 'simplecov'
+  gem 'mime-types', '< 2.0'
 end

data/Gemfile.lock

@@ -1,14 +1,14 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    ZenTest (4.9.5)
-    addressable (2.3.5)
+    ZenTest (4.10.0)
+    addressable (2.3.6)
     autotest (4.4.6)
       ZenTest (>= 4.4.1)
     autotest-fsevent (0.2.9)
       sys-uname
     autotest-growl (0.2.16)
-    backports (3.4.0)
+    backports (3.6.0)
     coderay (1.1.0)
     coveralls (0.7.0)
       multi_json (~> 1.3)
@@ -16,28 +16,27 @@ GEM
       simplecov (>= 0.7)
       term-ansicolor
       thor
-    crack (0.4.1)
-      safe_yaml (~> 0.9.0)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
     diff-lcs (1.2.5)
-    docile (1.1.2)
-    ethon (0.6.2)
+    docile (1.1.3)
+    ethon (0.7.0)
       ffi (>= 1.3.0)
-      mime-types (~> 1.18)
-    faraday (0.8.8)
-      multipart-post (~> 1.2.0)
-    faraday_middleware (0.9.0)
-      faraday (>= 0.7.4, < 0.9)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.9.1)
+      faraday (>= 0.7.4, < 0.10)
     ffi (1.9.3)
     ffi (1.9.3-java)
     ffi2-generators (0.1.1)
-    gh (0.13.0)
+    gh (0.13.2)
       addressable
       backports
       faraday (~> 0.8)
       multi_json (~> 1.0)
       net-http-persistent (>= 2.7)
       net-http-pipeline
-    highline (1.6.20)
+    highline (1.6.21)
     httpclient (2.3.4.1)
     json (1.8.1)
     json (1.8.1-java)
@@ -48,35 +47,40 @@ GEM
       spoon (~> 0.0.1)
     method_source (0.8.2)
     mime-types (1.25.1)
-    multi_json (1.8.2)
-    multipart-post (1.2.0)
-    net-http-persistent (2.9)
+    multi_json (1.10.1)
+    multipart-post (2.0.0)
+    net-http-persistent (2.9.4)
     net-http-pipeline (1.0.1)
-    pry (0.9.12.4)
+    pry (0.9.12.6)
       coderay (~> 1.0)
       method_source (~> 0.8)
       slop (~> 3.4)
-    pry (0.9.12.4-java)
+    pry (0.9.12.6-java)
       coderay (~> 1.0)
       method_source (~> 0.8)
       slop (~> 3.4)
       spoon (~> 0.0)
-    pusher-client (0.4.0)
-      websocket (~> 1.0.0)
-    rake (10.1.1)
-    rdoc (4.1.0)
+    pusher-client (0.6.0)
+      json
+      websocket (~> 1.0)
+    rake (10.3.2)
+    rdoc (4.1.1)
       json (~> 1.4)
     redgreen (1.2.2)
     rest-client (1.6.7)
       mime-types (>= 1.16)
-    rspec (2.14.1)
-      rspec-core (~> 2.14.0)
-      rspec-expectations (~> 2.14.0)
-      rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.7)
-    rspec-expectations (2.14.4)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.4)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.0)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.0)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.0)
     rubysl (2.0.15)
       rubysl-abbrev (~> 2.0)
       rubysl-base64 (~> 2.0)
@@ -235,12 +239,12 @@ GEM
     rubysl-observer (2.0.0)
     rubysl-open-uri (2.0.0)
     rubysl-open3 (2.0.0)
-    rubysl-openssl (2.0.6)
+    rubysl-openssl (2.1.0)
     rubysl-optparse (2.0.1)
       rubysl-shellwords (~> 2.0)
     rubysl-ostruct (2.0.4)
     rubysl-pathname (2.0.0)
-    rubysl-prettyprint (2.0.2)
+    rubysl-prettyprint (2.0.3)
     rubysl-prime (2.0.1)
     rubysl-profile (2.0.0)
     rubysl-profiler (2.0.1)
@@ -248,9 +252,9 @@ GEM
     rubysl-pty (2.0.2)
     rubysl-rational (2.0.1)
     rubysl-readline (2.0.2)
-    rubysl-resolv (2.0.0)
+    rubysl-resolv (2.1.0)
     rubysl-rexml (2.0.2)
-    rubysl-rinda (2.0.0)
+    rubysl-rinda (2.0.1)
     rubysl-rss (2.0.0)
     rubysl-scanf (2.0.0)
     rubysl-securerandom (2.0.0)
@@ -268,7 +272,7 @@ GEM
     rubysl-thwait (2.0.0)
     rubysl-time (2.0.3)
     rubysl-timeout (2.0.0)
-    rubysl-tmpdir (2.0.0)
+    rubysl-tmpdir (2.0.1)
     rubysl-tsort (2.0.1)
     rubysl-un (2.0.0)
       rubysl-fileutils (~> 2.0)
@@ -279,38 +283,38 @@ GEM
     rubysl-xmlrpc (2.0.0)
     rubysl-yaml (2.0.4)
     rubysl-zlib (2.0.1)
-    safe_yaml (0.9.7)
+    safe_yaml (1.0.3)
     simplecov (0.8.2)
       docile (~> 1.1.0)
       multi_json
       simplecov-html (~> 0.8.0)
     simplecov-html (0.8.0)
-    slop (3.4.7)
+    slop (3.5.0)
     spoon (0.0.4)
       ffi
     sys-uname (0.9.2)
       ffi (>= 1.0.0)
-    term-ansicolor (1.2.2)
-      tins (~> 0.8)
-    thor (0.18.1)
-    tins (0.13.1)
-    travis (1.6.6)
+    term-ansicolor (1.3.0)
+      tins (~> 1.0)
+    thor (0.19.1)
+    tins (1.3.0)
+    travis (1.6.11)
       addressable (~> 2.3)
       backports
-      faraday (~> 0.8.7)
+      faraday (~> 0.9)
       faraday_middleware (~> 0.9)
       gh (~> 0.13)
       highline (~> 1.6)
       launchy (~> 2.1)
       pry (~> 0.9)
       pusher-client (~> 0.4)
-      typhoeus (~> 0.6)
-    typhoeus (0.6.7)
-      ethon (~> 0.6.2)
-    webmock (1.16.1)
-      addressable (>= 2.2.7)
+      typhoeus (~> 0.6, >= 0.6.8)
+    typhoeus (0.6.8)
+      ethon (>= 0.7.0)
+    webmock (1.18.0)
+      addressable (>= 2.3.6)
       crack (>= 0.3.2)
-    websocket (1.0.7)
+    websocket (1.1.4)
 
 PLATFORMS
   java
@@ -323,6 +327,7 @@ DEPENDENCIES
   coveralls
   httpclient (~> 2.3)
   json (>= 1.5.1)
+  mime-types (< 2.0)
   rake
   rdoc
   redgreen

data/README.md

@@ -212,9 +212,17 @@ You can use the following optional arguments:
   * **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.
- * **optionalWords**: a string that contains the list of words that should be considered as optional when found in the query. The list of words is comma separated.
+ * **typoTolerance**: if set to false, disable the typo-tolerance. Defaults to true.
  * **minWordSizefor1Typo**: the minimum number of characters in a query word to accept one typo in this word.<br/>Defaults to 3.
  * **minWordSizefor2Typos**: the minimum number of characters in a query word to accept two typos in this word.<br/>Defaults to 7.
+ * **allowTyposOnNumericTokens**: if set to false, disable typo-tolerance on numeric tokens (numbers). Default to true.
+ * **advancedSyntax**: Enable the advanced query syntax. Defaults to 0 (false).
+    * **Phrase query**: a phrase query defines a particular sequence of terms. A phrase query is build by Algolia's query parser for words surrounded by `"`. For example, `"search engine"` will retrieve records having `search` next to `engine` only. Typo-tolerance is _disabled_ on phrase queries.
+    * **Prohibit operator**: The prohibit operator excludes records that contain the term after the `-` symbol. For example `search -engine` will retrieve records containing `search` but not `engine`.
+ * **analytics**: If set to false, this query will not be taken into account in analytics feature. Default to true.
+ * **synonyms**: If set to false, this query will not use synonyms defined in configuration. Default to true.
+ * **replaceSynonymsInHighlight**: If set to false, words matched via synonyms expansion will not be replaced by the matched synonym in highlight result. Default to true.
+ * **optionalWords**: a string that contains the list of words that should be considered as optional when found in the query. The list of words is comma separated.
 
 #### Pagination parameters
 
@@ -239,7 +247,12 @@ You can use the following optional arguments:
 
 #### Numeric search parameters
  * **numericFilters**: a string that contains the list of numeric filters you want to apply separated by a comma. The syntax of one filter is `attributeName` followed by `operand` followed by `value`. Supported operands are `<`, `<=`, `=`, `>` and `>=`. 
- You can have multiple conditions on one attribute like for example `numericFilters=price>100,price<1000`. You can also use a string array encoding (for example `numericFilters: ["price>100","price<1000"]`).
+
+You can easily perform range queries via the `:` operator (equivalent to combining a `>=` and `<=` operand), for example `numericFilters=price:10 to 1000`.
+
+You can also mix OR and AND operators. The OR operator is defined with a parenthesis syntax. For example `(code=1 AND (price:[0-100] OR price:[1000-2000]))` translates in `encodeURIComponent("code=1,(price:0 to 10,price:1000 to 2000)")`.
+
+You can also use a string array encoding (for example `numericFilters: ["price>100","price<1000"]`).
 
 #### Category search parameters
  * **tagFilters**: filter the query by a set of tags. You can AND tags by separating them by commas. To OR tags, you must add parentheses. For example, `tags=tag1,(tag2,tag3)` means *tag1 AND (tag2 OR tag3)*. You can also use a string array encoding, for example `tagFilters: ["tag1",["tag2","tag3"]]` means *tag1 AND (tag2 OR tag3)*.<br/>At indexing, tags should be added in the **_tags** attribute of objects (for example `{"_tags":["tag1","tag2"]}`). 
@@ -251,6 +264,7 @@ You can use the following optional arguments:
 
 #### Distinct parameter
  * **distinct**: If set to 1, enable the distinct feature (disabled by default) if the `attributeForDistinct` index setting is set. This feature is similar to the SQL "distinct" keyword: when enabled in a query with the `distinct=1` parameter, all hits containing a duplicate value for the attributeForDistinct 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.
+**Note**: This feature is disabled if the query string is empty and there isn't any `tagFilters`, nor any `facetFilters`, nor any `numericFilters` parameters.
 
 ```ruby
 index = Algolia::Index.new("contacts")
@@ -331,16 +345,19 @@ You can retrieve all settings using the `get_settings` function. The result will
   * *Limit the attributes to index*.<br/>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*.<br/>(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**: 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.<br/>We have six available criteria: 
+ * **attributeForDistinct**: 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. **Note**: This feature is disabled if the query string is empty and there isn't any `tagFilters`, nor any `facetFilters`, nor any `numericFilters` parameters.
+ * **ranking**: (array of strings) controls the way results are sorted.<br/>We have nine available criteria: 
   * **typo**: sort according to number of typos,
   * **geo**: sort according to decreassing distance when performing a geo-location based search,
+  * **words**: sort according to the number of query words matched by decreasing order. This parameter is useful when you use `optionalWords` query parameter to have results with the most matched words first.
   * **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.<br/>The standard order is ["typo", "geo", "proximity", "attribute", "exact", "custom"]
+  * **custom**: sort according to a user defined formula set in **customRanking** attribute.
+  * **asc(attributeName)**: sort according to a numeric attribute by ascending order. **attributeName** can be the name of any numeric attribute of your records (integer, a double or boolean).
+  * **desc(attributeName)**: sort according to a numeric attribute by descending order. **attributeName** can be the name of any numeric attribute of your records (integer, a double or boolean). <br/>The standard order is ["typo", "geo", "words", "proximity", "attribute", "exact", "custom"]
  * **customRanking**: (array of strings) lets you specify part of the ranking.<br/>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:
@@ -349,6 +366,19 @@ For example `"customRanking" => ["desc(population)", "asc(name)"]`
   * **prefixNone**: no query word is interpreted as a prefix. This option is not recommended.
  * **slaves**: The list of indexes on which you want to replicate all write operations. In order to get response times in milliseconds, we pre-compute part of the ranking during indexing. If you want to use different ranking configurations depending of the use-case, you need to create one index per ranking configuration. This option enables you to perform write operations only on this index, and to automatically update slave indexes with the same operations.
 
+#### Query expansion
+ * **synonyms**: (array of array of words considered as equals). For example, you may want to retrieve your **black ipad** record when your users are searching for **dark ipad**, even if the **dark** word is not part of the record: so you need to configure **black** as a synonym of **dark**. For example `"synomyms": [ [ "black", "dark" ], [ "small", "little", "mini" ], ... ]`.
+ * **placeholders**: (hash of array of words). This is an advanced use case to define a token substitutable by a list of words without having the original token searchable. It is defined by a hash associating placeholders to lists of substitutable words. For example `"placeholders": { "<streetnumber>": ["1", "2", "3", ..., "9999"]}` placeholder to be able to match all street numbers (we use the `< >` tag syntax to define placeholders in an attribute). For example:
+  * Push a record with the placeholder: `{ "name" : "Apple Store", "address" : "&lt;streetnumber&gt; Opera street, Paris" }`
+  * Configure the placeholder in your index settings: `"placeholders": { "<streetnumber>" : ["1", "2", "3", "4", "5", ... ], ... }`.
+ * **disableTypoToleranceOn**: (string array). Specify a list of words on which the automatic typo tolerance will be disabled.
+ * **altCorrections**: (object array). Specify alternative corrections that you want to consider. Each alternative correction is described by an object containing three attributes:
+  * **word**: the word to correct
+  * **correction**: the corrected word
+  * **nbTypos** the number of typos (1 or 2) that will be considered for the ranking algorithm (1 typo is better than 2 typos)
+
+  For example `"altCorrections": [ { "word" : "foot", "correction": "feet", "nbTypos": 1}, { "word": "feet", "correction": "foot", "nbTypos": 1}].`
+
 #### Default query parameters (can be overwrite by query)
  * **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).
@@ -527,6 +557,8 @@ Algolia.delete_user_key("f420238212c54dcfad07ea0aa6d5c45f")
 index.delete_user_key("71671c38001bf3ac857bc82052485107")
 ```
 
+
+
 You may have a single index containing per-user data. In that case, all records should be tagged with their associated user_id in order to add a `tagFilters=(public,user_42)` filter at query time to retrieve only what a user has access to. If you're using the [JavaScript client](http://github.com/algolia/algoliasearch-client-js), it will result in a security breach since the user is able to modify the `tagFilters` you've set modifying the code from the browser. To keep using the JavaScript client (recommended for optimal latency) and target secured records, you can generate secured API key from your backend:
 
 ```ruby
@@ -570,6 +602,8 @@ This public API key must then be used in your JavaScript code as follow:
 </script>
 ```
 
+
+
 Copy or rename an index
 -------------
 
@@ -595,7 +629,7 @@ puts Algolia.move_index("MyNewIndex", "MyIndex")
 Backup / Retrieve all index content
 -------------
 
-You can retrieve all index content for backup purpose of for analytics using the browse method. 
+You can retrieve all index content for backup purpose or for analytics using the browse method. 
 This method retrieve 1000 objects by API call and support pagination.
 
 ```ruby

data/algoliasearch.gemspec

@@ -6,12 +6,12 @@
 
 Gem::Specification.new do |s|
   s.name = "algoliasearch"
-  s.version = "1.2.8"
+  s.version = "1.2.9"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Algolia"]
-  s.date = "2014-03-27"
+  s.date = "2014-07-08"
   s.description = "A simple Ruby client for the algolia.com REST API"
   s.email = "contact@algolia.com"
   s.extra_rdoc_files = [

data/lib/algolia/client.rb

@@ -10,14 +10,17 @@ module Algolia
   # A class which encapsulates the HTTPS communication with the Algolia
   # API server. Uses the HTTPClient library for low-level HTTP communication.
   class Client
-    attr_reader :hosts, :application_id, :api_key, :headers
+    attr_reader :ssl, :hosts, :application_id, :api_key, :headers, :connect_timeout, :send_timeout, :receive_timeout
 
 
     def initialize(data = {})
-      @ssl            = data[:ssl].nil? ? true : data[:ssl]
-      @application_id = data[:application_id]
-      @api_key        = data[:api_key]
-      @hosts          = (data[:hosts] || 1.upto(3).map { |i| "#{@application_id}-#{i}.algolia.io" }).shuffle
+      @ssl             = data[:ssl].nil? ? true : data[:ssl]
+      @application_id  = data[:application_id]
+      @api_key         = data[:api_key]
+      @hosts           = (data[:hosts] || 1.upto(3).map { |i| "#{@application_id}-#{i}.algolia.io" }).shuffle
+      @connect_timeout = data[:connect_timeout]
+      @send_timeout    = data[:send_timeout]
+      @receive_timeout = data[:receive_timeout]
       @headers = {
         Protocol::HEADER_API_KEY => api_key,
         Protocol::HEADER_APP_ID  => application_id,
@@ -71,6 +74,9 @@ module Algolia
           :session => HTTPClient.new
         }
         hinfo[:session].transparent_gzip_decompression = true
+        hinfo[:session].connect_timeout = @connect_timeout if @connect_timeout
+        hinfo[:session].send_timeout = @send_timeout if @send_timeout
+        hinfo[:session].receive_timeout = @receive_timeout if @receive_timeout
         hinfo[:session].ssl_config.add_trust_ca File.join(File.dirname(__FILE__), '..', '..', 'resources', 'ca-bundle.crt')
         hinfo
       end
@@ -177,7 +183,8 @@ module Algolia
     requests = {
       :requests => queries.map do |query|
         indexName = query.delete(index_name_key) || query.delete(index_name_key.to_s)
-        { :indexName => indexName, :params => Protocol.to_query(query) }
+        encoded_params = Hash[query.map { |k,v| [k.to_s, v.is_a?(Array) ? v.to_json : v] }]
+        { :indexName => indexName, :params => Protocol.to_query(encoded_params) }
       end
     }
     Algolia.client.post(Protocol.multiple_queries_uri, requests.to_json)
@@ -203,6 +210,17 @@ module Algolia
       Algolia.client.post(Protocol.index_operation_uri(src_index), request.to_json)
   end
 
+  #
+  # Move an existing index and wait until the move has been processed
+  # @param src_index the name of index to copy.
+  # @param dst_index the new index name that will contains a copy of srcIndexName (destination will be overriten if it already exist).
+  #
+  def Algolia.move_index!(src_index, dst_index)
+      res = Algolia.move_index(src_index, dst_index)
+      Index.new(dst_index).wait_task(res['taskID'])
+      res
+  end
+
   #
   # Copy an existing index.
   # @param src_index the name of index to copy.
@@ -213,6 +231,29 @@ module Algolia
       Algolia.client.post(Protocol.index_operation_uri(src_index), request.to_json)
   end
 
+  #
+  # Copy an existing index and wait until the copy has been processed.
+  # @param src_index the name of index to copy.
+  # @param dst_index the new index name that will contains a copy of srcIndexName (destination will be overriten if it already exist).
+  #
+  def Algolia.copy_index!(src_index, dst_index)
+      res = Algolia.copy_index(src_index, dst_index)
+      Index.new(dst_index).wait_task(res['taskID'])
+      res
+  end
+
+  # Delete an index
+  #
+  def delete_index(name)
+    Index.new(name).delete
+  end
+
+  # Delete an index and wait until the deletion has been processed.
+  #
+  def delete_index!(name)
+    Index.new(name).delete!
+  end
+
   #
   # Return last logs entries.
   #

data/lib/algolia/index.rb

@@ -11,13 +11,23 @@ module Algolia
     end
     
     # Delete an index
-    # 
-    # return an hash of the form { "deletedAt" => "2013-01-18T15:33:13.556Z" }
+    #
+    # return an hash of the form { "deletedAt" => "2013-01-18T15:33:13.556Z", "taskID" => "42" }
     def delete
       Algolia.client.delete(Protocol.index_uri(name))
     end
     alias_method :delete_index, :delete
 
+    # Delete an index and wait until the deletion has been processed
+    #
+    # return an hash of the form { "deletedAt" => "2013-01-18T15:33:13.556Z", "taskID" => "42" }
+    def delete!
+      res = delete
+      wait_task(res['taskID'])
+      res
+    end
+    alias_method :delete_index!, :delete!
+
     # Add an object in this index
     # 
     # @param obj the object to add to the index. 
@@ -154,6 +164,15 @@ module Algolia
       end
     end
 
+    #
+    # Get a list of objects from this index
+    #
+    # @param objectIDs the array of unique identifier of the objects to retrieve
+    #
+    def get_objects(objectIDs)
+      Algolia.client.post(Protocol.objects_uri, { :requests => objectIDs.map { |objectID| { :indexName => name, :objectID => objectID } } }.to_json)['results']
+    end
+
     # Wait the publication of a task on the server. 
     # All server task are asynchronous and you can check with this method that the task is published.
     #
@@ -291,6 +310,28 @@ module Algolia
       return res
     end
 
+    #
+    # Delete all objects matching a query
+    #
+    # @param query the query string
+    # @param params the optional query parameters
+    #
+    def delete_by_query(query, params = {})
+      params.delete(:hitsPerPage)
+      params.delete('hitsPerPage')
+      params.delete(:attributesToRetrieve)
+      params.delete('attributesToRetrieve')
+
+      params[:hitsPerPage] = 1000
+      params[:attributesToRetrieve] = ['objectID']
+      loop do
+        res = search(query, params)
+        break if res['hits'].empty?
+        res = delete_objects(res['hits'].map { |h| h['objectID'] })
+        wait_task res['taskID']
+      end
+    end
+
     #
     # Delete the index content
     # 
@@ -408,6 +449,104 @@ module Algolia
       Algolia.client.post(Protocol.batch_uri(name), request.to_json)
     end
 
+    # Send a batch request and wait the end of the indexing
+    def batch!(request)
+      res = batch(request)
+      wait_task(res['taskID'])
+      res
+    end
+
+    # Perform a search with disjunctive facets generating as many queries as number of disjunctive facets
+    #
+    # @param query the query
+    # @param disjunctive_facets the array of disjunctive facets
+    # @param params a hash representing the regular query parameters
+    # @param refinements a hash ("string" -> ["array", "of", "refined", "values"]) representing the current refinements
+    #                    ex: { "my_facet1" => ["my_value1", ["my_value2"], "my_disjunctive_facet1" => ["my_value1", "my_value2"] }
+    def search_disjunctive_faceting(query, disjunctive_facets, params = {}, refinements = {})
+      raise ArgumentError.new('Argument "disjunctive_facets" must be a String or an Array') unless disjunctive_facets.is_a?(String) || disjunctive_facets.is_a?(Array)
+      raise ArgumentError.new('Argument "refinements" must be a Hash of Arrays') if !refinements.is_a?(Hash) || !refinements.select { |k, v| !v.is_a?(Array) }.empty?
+
+      # extract disjunctive facets & associated refinements
+      disjunctive_facets = disjunctive_facets.split(',') if disjunctive_facets.is_a?(String)
+      disjunctive_refinements = {}
+      refinements.each do |k, v|
+        disjunctive_refinements[k] = v if disjunctive_facets.include?(k) || disjunctive_facets.include?(k.to_s)
+      end
+
+      # build queries
+      queries = []
+      ## hits + regular facets query
+      filters = []
+      refinements.to_a.each do |k, values|
+        r = values.map { |v| "#{k}:#{v}" }
+        if disjunctive_refinements[k.to_s] || disjunctive_refinements[k.to_sym]
+          # disjunctive refinements are ORed
+          filters << r
+        else
+          # regular refinements are ANDed
+          filters += r
+        end
+      end
+      queries << params.merge({ :index_name => self.name, :query => query, :facetFilters => filters })
+      ## one query per disjunctive facet (use all refinements but the current one + hitsPerPage=1 + single facet)
+      disjunctive_facets.each do |disjunctive_facet|
+        filters = []
+        refinements.each do |k, values|
+          if k.to_s != disjunctive_facet.to_s
+            r = values.map { |v| "#{k}:#{v}" }
+            if disjunctive_refinements[k.to_s] || disjunctive_refinements[k.to_sym]
+              # disjunctive refinements are ORed
+              filters << r
+            else
+              # regular refinements are ANDed
+              filters += r
+            end
+          end
+        end
+        queries << params.merge({
+          :index_name => self.name,
+          :query => query,
+          :page => 0,
+          :hitsPerPage => 1,
+          :attributesToRetrieve => [],
+          :attributesToHighlight => [],
+          :attributesToSnippet => [],
+          :facets => disjunctive_facet,
+          :facetFilters => filters
+        })
+      end
+      answers = Algolia.multiple_queries(queries)
+
+      # aggregate answers
+      ## first answer stores the hits + regular facets
+      aggregated_answer = answers['results'][0]
+      ## others store the disjunctive facets
+      aggregated_answer['disjunctiveFacets'] = {}
+      answers['results'].each_with_index do |a, i|
+        next if i == 0
+        a['facets'].each do |facet, values|
+          ## add the facet to the disjunctive facet hash
+          aggregated_answer['disjunctiveFacets'][facet] = values
+          ## concatenate missing refinements
+          (disjunctive_refinements[facet.to_s] || disjunctive_refinements[facet.to_sym] || []).each do |r|
+            if aggregated_answer['disjunctiveFacets'][facet][r].nil?
+              aggregated_answer['disjunctiveFacets'][facet][r] = 0
+            end
+          end
+        end
+      end
+
+      aggregated_answer
+    end
+
+    #
+    # Alias of Algolia.list_indexes
+    #
+    def Index.all
+      Algolia.list_indexes
+    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

@@ -42,6 +42,10 @@ module Algolia
       "/#{VERSION}/indexes/*/queries"
     end
 
+    def Protocol.objects_uri
+      "/#{VERSION}/indexes/*/objects"
+    end
+
     # Construct a uri referencing a given Algolia index
     def Protocol.index_uri(index)
       "/#{VERSION}/indexes/#{CGI.escape(index)}"

data/lib/algolia/version.rb

@@ -1,3 +1,3 @@
 module Algolia
-  VERSION = "1.2.8"
+  VERSION = "1.2.9"
 end

data/spec/client_spec.rb

@@ -124,8 +124,7 @@ describe 'Client' do
   it "should have another index after" do
     index = Algolia::Index.new(safe_index_name("àlgol?a"))
     begin
-      index.delete_index
-      sleep 4 # Dirty but temporary
+      index.delete_index!
     rescue
       # friends_2 does not exist
     end
@@ -139,12 +138,17 @@ describe 'Client' do
   it "should get a object" do
     @index.clear_index
     @index.add_object!({:firstname => "Robert"})
+    @index.add_object!({:firstname => "Robert2"})
     res = @index.search('')
-    @index.search("")["nbHits"].should eq(1)
+    res["nbHits"].should eq(2)
     object = @index.get_object(res['hits'][0]['objectID'])
-    object['firstname'].should eq('Robert')
+    object['firstname'].should eq(res['hits'][0]['firstname'])
+
     object = @index.get_object(res['hits'][0]['objectID'], 'firstname')
-    object['firstname'].should eq('Robert') 
+    object['firstname'].should eq(res['hits'][0]['firstname'])
+
+    objects = @index.get_objects([ res['hits'][0]['objectID'], res['hits'][1]['objectID'] ])
+    objects.size.should eq(2)
   end
 
   it "should delete the object" do
@@ -166,11 +170,20 @@ describe 'Client' do
     @index.search('')['nbHits'].should eq(0)
   end
 
+  it "should delete several objects by query" do
+    @index.clear
+    @index.add_object({:firstname => "Robert1"})
+    @index.add_object!({:firstname => "Robert2"})
+    @index.search('')['nbHits'].should eq(2)
+    @index.delete_by_query('rob')
+    @index.search('')['nbHits'].should eq(0)
+  end
+
   it "should copy the index" do
     index = Algolia::Index.new(safe_index_name("àlgol?à"))
     begin
       @index.clear_index
-      index.delete_index
+      Algolia.delete_index index.name
     rescue
       # friends_2 does not exist
     end
@@ -178,18 +191,18 @@ describe 'Client' do
     @index.add_object!({:firstname => "Robert"})
     @index.search('')['nbHits'].should eq(1)
     
-    Algolia.copy_index(safe_index_name("àlgol?a"), safe_index_name("àlgol?à"))
-    @index.delete_index
+    Algolia.copy_index!(safe_index_name("àlgol?a"), safe_index_name("àlgol?à"))
+    @index.delete_index!
     
     index.search('')['nbHits'].should eq(1)
-    index.delete_index
+    index.delete_index!
   end
 
   it "should move the index" do
     @index.clear_index rescue "friends does not exist"
     index = Algolia::Index.new(safe_index_name("àlgol?à"))
     begin
-      index.delete_index
+      Algolia.delete_index! index.name
     rescue
       # friends_2 does not exist
     end
@@ -197,7 +210,7 @@ describe 'Client' do
     @index.add_object!({:firstname => "Robert"})
     @index.search('')['nbHits'].should eq(1)
     
-    Algolia.move_index(safe_index_name("àlgol?a"), safe_index_name("àlgol?à"))
+    Algolia.move_index!(safe_index_name("àlgol?a"), safe_index_name("àlgol?à"))
     
     index.search('')['nbHits'].should eq(1)
     index.delete_index
@@ -220,6 +233,7 @@ describe 'Client' do
   end
 
   it "should search on multipleIndex" do
+    @index.clear_index! rescue "Not fatal"
     @index.add_object!({ :name => "John Doe", :email => "john@doe.org" }, "1")
     res = Algolia.multiple_queries([{:index_name => safe_index_name("àlgol?a"), "query" => ""}])
     res["results"][0]["hits"].length.should eq(1)
@@ -254,7 +268,7 @@ describe 'Client' do
         "objectID" => "42"
       }
       ]}
-    res = @index.batch(request)
+    res = @index.batch!(request)
     @index.search('')['nbHits'].should eq(4)
   end
 
@@ -293,19 +307,34 @@ describe 'Client' do
     res['facets']['f']['f1'].should eq(1)
     res['facets']['f']['f2'].should be_nil
     res['facets']['f']['f3'].should be_nil
+
+    res = @index.search("", { :facets => "f,g", :facetFilters => [["f:f1", "g:g2"]] })
+    res['nbHits'].should eq(4)
+    res['facets']['f']['f1'].should eq(2)
+    res['facets']['f']['f2'].should eq(1)
+    res['facets']['f']['f3'].should eq(1)
+
+    res = @index.search("", { :facets => "f,g", :facetFilters => [["f:f1", "g:g2"], "g:g1"] })
+    res['nbHits'].should eq(1)
+    res['facets']['f']['f1'].should eq(1)
+    res['facets']['f']['f2'].should be_nil
+    res['facets']['f']['f3'].should be_nil
+    res['facets']['g']['g1'].should eq(1)
+    res['facets']['g']['g2'].should be_nil
   end
 
   it "should test keys" do
     resIndex = @index.list_user_keys
     newIndexKey = @index.add_user_key(['search'])
     newIndexKey['key'].should_not eq("")
+    sleep 2 # no task ID here
     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.delete_user_key(newIndexKey['key'])
-    sleep 1 # Dirty but temporary
+    sleep 2 # no task ID here
     resIndexEnd = @index.list_user_keys
     is_include(resIndexEnd['keys'], 'value', newIndexKey['key']).should eq(false)
 
@@ -313,13 +342,14 @@ describe 'Client' do
     res = Algolia.list_user_keys
     newKey = Algolia.add_user_key(['search'])
     newKey['key'].should_not eq("")
+    sleep 2 # no task ID here
     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.delete_user_key(newKey['key'])
-    sleep 1 # Dirty but temporary
+    sleep 2 # no task ID here
     resEnd = Algolia.list_user_keys
     is_include(resEnd['keys'], 'value', newKey['key']).should eq(false)
 
@@ -358,7 +388,7 @@ describe 'Client' do
   end
 
   it "Check attributes list_indexes:" do
-    res = Algolia.list_indexes
+    res = Algolia::Index.all
     res.should have_key('items')     
     res['items'][0].should have_key('name')    
     res['items'][0]['name'].should be_a(String)    
@@ -492,7 +522,7 @@ describe 'Client' do
     index = Algolia::Index.new(safe_index_name("àlgol?à"))
     index2 = Algolia::Index.new(safe_index_name("àlgol?à2"))
     index2.add_object!({ :name => "John Doe", :email => "john@doe.org" }, "1")
-    task = Algolia.move_index(safe_index_name("àlgol?à2"), safe_index_name("àlgol?à"))
+    task = Algolia.move_index!(safe_index_name("àlgol?à2"), safe_index_name("àlgol?à"))
     task.should have_key('updatedAt')
     task['updatedAt'].should be_a(String)
     task.should have_key('taskID')
@@ -504,7 +534,7 @@ describe 'Client' do
     index = Algolia::Index.new(safe_index_name("àlgol?à"))
     index2 = Algolia::Index.new(safe_index_name("àlgol?à2"))
     index2.add_object!({ :name => "John Doe", :email => "john@doe.org" }, "1")
-    task = Algolia.copy_index(safe_index_name("àlgol?à2"), safe_index_name("àlgol?à"))
+    task = Algolia.copy_index!(safe_index_name("àlgol?à2"), safe_index_name("àlgol?à"))
     task.should have_key('updatedAt')
     task['updatedAt'].should be_a(String)
     task.should have_key('taskID')
@@ -528,6 +558,7 @@ describe 'Client' do
     newIndexKey['key'].should be_a(String)
     newIndexKey.should have_key('createdAt')
     newIndexKey['createdAt'].should be_a(String)
+    sleep 2 # no task ID here
     resIndex = @index.list_user_keys
     resIndex.should have_key('keys')
     resIndex['keys'].should be_a(Array)
@@ -605,4 +636,44 @@ describe 'Client' do
     res['results'][0].should have_key('params')     
     res['results'][0]['params'].should be_a(String)  
   end
+
+  it 'should handle disjunctive faceting' do
+    index = Algolia::Index.new(safe_index_name("test_hotels"))
+    index.set_settings :attributesForFacetting => ['city', 'stars', 'facilities']
+    index.clear_index rescue nil
+    index.add_objects! [
+      { :name => 'Hotel A', :stars => '*', :facilities => ['wifi', 'bath', 'spa'], :city => 'Paris' },
+      { :name => 'Hotel B', :stars => '*', :facilities => ['wifi'], :city => 'Paris' },
+      { :name => 'Hotel C', :stars => '**', :facilities => ['bath'], :city => 'San Francisco' },
+      { :name => 'Hotel D', :stars => '****', :facilities => ['spa'], :city => 'Paris' },
+      { :name => 'Hotel E', :stars => '****', :facilities => ['spa'], :city => 'New York' },
+    ]
+
+    answer = index.search_disjunctive_faceting('h', ['stars', 'facilities'], { :facets => 'city' })
+    answer['nbHits'].should eq(5)
+    answer['facets'].size.should eq(1)
+    answer['disjunctiveFacets'].size.should eq(2)
+
+    answer = index.search_disjunctive_faceting('h', ['stars', 'facilities'], { :facets => 'city' }, { :stars => ['*'] })
+    answer['nbHits'].should eq(2)
+    answer['facets'].size.should eq(1)
+    answer['disjunctiveFacets'].size.should eq(2)
+    answer['disjunctiveFacets']['stars']['*'].should eq(2)
+    answer['disjunctiveFacets']['stars']['**'].should eq(1)
+    answer['disjunctiveFacets']['stars']['****'].should eq(2)
+
+    answer = index.search_disjunctive_faceting('h', ['stars', 'facilities'], { :facets => 'city' }, { :stars => ['*'], :city => ['Paris'] })
+    answer['nbHits'].should eq(2)
+    answer['facets'].size.should eq(1)
+    answer['disjunctiveFacets'].size.should eq(2)
+    answer['disjunctiveFacets']['stars']['*'].should eq(2)
+    answer['disjunctiveFacets']['stars']['****'].should eq(1)
+
+    answer = index.search_disjunctive_faceting('h', ['stars', 'facilities'], { :facets => 'city' }, { :stars => ['*', '****'], :city => ['Paris'] })
+    answer['nbHits'].should eq(3)
+    answer['facets'].size.should eq(1)
+    answer['disjunctiveFacets'].size.should eq(2)
+    answer['disjunctiveFacets']['stars']['*'].should eq(2)
+    answer['disjunctiveFacets']['stars']['****'].should eq(1)
+  end
 end

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: algoliasearch
 version: !ruby/object:Gem::Version
-  version: 1.2.8
+  version: 1.2.9
 platform: ruby
 authors:
 - Algolia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-27 00:00:00.000000000 Z
+date: 2014-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.1
 - !ruby/object:Gem::Dependency
   name: travis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: A simple Ruby client for the algolia.com REST API
@@ -89,8 +89,8 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.md
 files:
-- .rspec
-- .travis.yml
+- ".rspec"
+- ".travis.yml"
 - ChangeLog
 - Gemfile
 - Gemfile.lock
@@ -121,12 +121,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []