algoliasearch-rails 1.7.1 → 1.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2aa68e2724bc3f0c7b43545b8d5156ae476acfde
-  data.tar.gz: 4e3d1a69ce8cff145fc91b69f845cb2c38bde8bb
+  metadata.gz: 9862c9e947777afdb827b6ca9c9879e989573ce3
+  data.tar.gz: bbfcbd83a12f2ecaf38ed346a80167b214303d30
 SHA512:
-  metadata.gz: 7e685c99823cb8f047b1bfd8d390a5b2a535df639586f6e7e8d92fe5eb60b546370f2697bfbc07a3afbfc067195ec23ad7b81a17645699ac93b974dbb2331811
-  data.tar.gz: bf4848ce707351534dbe3fe03f952419a721a3ce4e37b7ecaf84c90c574721a1edae0373ec74eab936bf0146ee267fbbcc700a84eefeb13e02a1d1f7b3dce916
+  metadata.gz: ce9950505a350f386a8a778213a2352c98a0fac56fbdef99b0ba899270ed939b4bc92202e72ce16ad214fb7cad2ecbd9b816a7b811c3136ce12b263a9373a116
+  data.tar.gz: c1d747eedcec3a4fb90d9394e6f1476c72f22142e1dd2551c6661219c5a765f0472cf2c7ee583a115f0da47061eabfca4865ceb1b4be2ac5d4f9533025dfaf24

data/ChangeLog

@@ -1,5 +1,10 @@
 CHANGELOG
 
+2014-02-04  1.7.2
+
+      * Add a ```raw_search``` method, retrieving the JSON raw answer
+      * Updated dependencies
+
 2014-01-31  1.7.1
 
       * Ensure methods are not conflicting with already defined ones (use algolia_METHOD_NAME)

data/Gemfile.lock

@@ -17,10 +17,10 @@ GEM
       activesupport (= 4.0.2)
       arel (~> 4.0.0)
     activerecord-deprecated_finders (1.0.3)
-    activerecord-jdbc-adapter (1.3.4)
+    activerecord-jdbc-adapter (1.3.6)
       activerecord (>= 2.2)
-    activerecord-jdbcsqlite3-adapter (1.3.4)
-      activerecord-jdbc-adapter (~> 1.3.4)
+    activerecord-jdbcsqlite3-adapter (1.3.6)
+      activerecord-jdbc-adapter (~> 1.3.6)
       jdbc-sqlite3 (~> 3.7.2)
     activesupport (4.0.2)
       i18n (~> 0.6, >= 0.6.4)
@@ -29,7 +29,7 @@ GEM
       thread_safe (~> 0.1)
       tzinfo (~> 0.3.37)
     addressable (2.3.5)
-    algoliasearch (1.2.1)
+    algoliasearch (1.2.2)
       httpclient (~> 2.3)
       json (>= 1.5.1)
     arel (4.0.1)
@@ -40,7 +40,7 @@ GEM
     autotest-fsevent (0.2.9)
       sys-uname
     autotest-growl (0.2.16)
-    backports (3.4.0)
+    backports (3.5.0)
     builder (3.1.4)
     coderay (1.1.0)
     diff-lcs (1.2.5)
@@ -48,14 +48,14 @@ GEM
     ethon (0.6.2)
       ffi (>= 1.3.0)
       mime-types (~> 1.18)
-    faraday (0.8.8)
+    faraday (0.8.9)
       multipart-post (~> 1.2.0)
     faraday_middleware (0.9.0)
       faraday (>= 0.7.4, < 0.9)
     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)
@@ -68,23 +68,26 @@ GEM
     jdbc-sqlite3 (3.7.2.1)
     json (1.8.1)
     json (1.8.1-java)
-    kaminari (0.15.0)
+    kaminari (0.15.1)
       actionpack (>= 3.0.0)
       activesupport (>= 3.0.0)
     launchy (2.4.2)
       addressable (~> 2.3)
+    launchy (2.4.2-java)
+      addressable (~> 2.3)
+      spoon (~> 0.0.1)
     method_source (0.8.2)
     mime-types (1.25.1)
     minitest (4.7.5)
-    multi_json (1.8.2)
+    multi_json (1.8.4)
     multipart-post (1.2.0)
-    net-http-persistent (2.9)
+    net-http-persistent (2.9.1)
     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)
@@ -95,7 +98,7 @@ GEM
     rack-test (0.6.2)
       rack (>= 1.0)
     rake (10.1.1)
-    rdoc (4.1.0)
+    rdoc (4.1.1)
       json (~> 1.4)
     redgreen (1.2.2)
     rspec (2.14.1)
@@ -103,9 +106,9 @@ GEM
       rspec-expectations (~> 2.14.0)
       rspec-mocks (~> 2.14.0)
     rspec-core (2.14.7)
-    rspec-expectations (2.14.4)
+    rspec-expectations (2.14.5)
       diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.4)
+    rspec-mocks (2.14.5)
     rubysl (2.0.15)
       rubysl-abbrev (~> 2.0)
       rubysl-base64 (~> 2.0)
@@ -264,7 +267,7 @@ 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)
@@ -279,7 +282,7 @@ GEM
     rubysl-readline (2.0.2)
     rubysl-resolv (2.0.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)
@@ -318,7 +321,7 @@ GEM
       atomic
     thread_safe (0.1.3-java)
       atomic
-    travis (1.6.6)
+    travis (1.6.7)
       addressable (~> 2.3)
       backports
       faraday (~> 0.8.7)

data/README.md

@@ -102,10 +102,20 @@ class Product < ActiveRecord::Base
 end
 ```
 
+A search returns ORM-compliant objects reloading them from your database.
+
 ```ruby
 p Contact.search("jon doe")
 ```
 
+If you want to retrieve the raw JSON answer from the API, without re-loading the objects from the database, you can use:
+
+```ruby
+p Contact.raw_search("jon doe")
+```
+
+By the way, we recommend the usage of our [JavaScript API Client](https://github.com/algolia/algoliasearch-client-js) to perform queries.
+
 **Notes:** All methods injected by the ```AlgoliaSearch``` include are prefixed by ```algolia_``` and aliased to the associated short names if they aren't already defined.
 
 ```ruby

data/VERSION

@@ -1 +1 @@
-1.7.1
+1.7.2

data/algoliasearch-rails.gemspec

@@ -6,7 +6,7 @@
 
 Gem::Specification.new do |s|
   s.name = "algoliasearch-rails"
-  s.version = "1.7.1"
+  s.version = "1.7.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Algolia"]

data/lib/algoliasearch-rails.rb

@@ -128,16 +128,19 @@ module AlgoliaSearch
         alias_method :remove_from_index!, :algolia_remove_from_index! unless method_defined? :remove_from_index!
         alias_method :clear_index!, :algolia_clear_index! unless method_defined? :clear_index!
         alias_method :search, :algolia_search unless method_defined? :search
+        alias_method :raw_search, :algolia_raw_search unless method_defined? :raw_search
         alias_method :index, :algolia_index unless method_defined? :index
         alias_method :index_name, :algolia_index_name unless method_defined? :index_name
         alias_method :must_reindex?, :algolia_must_reindex? unless method_defined? :must_reindex?
       end
+
+      base.cattr_accessor :algolia_options, :algolia_settings, :algolia_index_settings
     end
 
     def algoliasearch(options = {}, &block)
-      @algolia_index_settings = IndexSettings.new(block_given? ? Proc.new : nil)
-      @algolia_settings = @algolia_index_settings.to_settings
-      @algolia_options = { type: algolia_full_const_get(model_name.to_s), per_page: @algolia_index_settings.get_setting(:hitsPerPage) || 10, page: 1 }.merge(options)
+      self.algolia_index_settings = IndexSettings.new(block_given? ? Proc.new : nil)
+      self.algolia_settings = algolia_index_settings.to_settings
+      self.algolia_options = { type: algolia_full_const_get(model_name.to_s), per_page: algolia_index_settings.get_setting(:hitsPerPage) || 10, page: 1 }.merge(options)
 
       attr_accessor :highlight_result
 
@@ -167,9 +170,10 @@ module AlgoliaSearch
       return if @algolia_without_auto_index_scope
       algolia_ensure_init
       last_task = nil
-      find_in_batches(batch_size: batch_size) do |group|
+
+      algolia_find_in_batches(batch_size) do |group|
         group.select! { |o| algolia_indexable?(o) } if algolia_conditional_index?
-        objects = group.map { |o| @algolia_index_settings.get_attributes(o).merge 'objectID' => algolia_object_id_of(o) }
+        objects = group.map { |o| algolia_index_settings.get_attributes(o).merge 'objectID' => algolia_object_id_of(o) }
         last_task = @algolia_index.save_objects(objects)
       end
       @algolia_index.wait_task(last_task["taskID"]) if last_task and synchronous == true
@@ -179,9 +183,9 @@ module AlgoliaSearch
       return if @algolia_without_auto_index_scope || !algolia_indexable?(object)
       algolia_ensure_init
       if synchronous
-        @algolia_index.add_object!(@algolia_index_settings.get_attributes(object), algolia_object_id_of(object))
+        @algolia_index.add_object!(algolia_index_settings.get_attributes(object), algolia_object_id_of(object))
       else
-        @algolia_index.add_object(@algolia_index_settings.get_attributes(object), algolia_object_id_of(object))
+        @algolia_index.add_object(algolia_index_settings.get_attributes(object), algolia_object_id_of(object))
       end
     end
 
@@ -201,17 +205,21 @@ module AlgoliaSearch
       @algolia_index = nil
     end
 
-    def algolia_search(q, settings = {})
+    def algolia_raw_search(q, settings = {})
       algolia_ensure_init
-      json = @algolia_index.search(q, Hash[settings.map { |k,v| [k.to_s, v.to_s] }])
+      @algolia_index.search(q, Hash[settings.map { |k,v| [k.to_s, v.to_s] }])
+    end
+
+    def algolia_search(q, settings = {})
+      json = algolia_raw_search(q, settings)
       results = json['hits'].map do |hit|
-        o = @algolia_options[:type].where(algolia_object_id_method => hit['objectID']).first
+        o = algolia_options[:type].where(algolia_object_id_method => hit['objectID']).first
         if o
           o.highlight_result = hit['_highlightResult']
           o
         end
       end.compact
-      AlgoliaSearch::Pagination.create(results, json['nbHits'].to_i, @algolia_options)
+      AlgoliaSearch::Pagination.create(results, json['nbHits'].to_i, algolia_options)
     end
 
     def algolia_index
@@ -220,14 +228,14 @@ module AlgoliaSearch
     end
 
     def algolia_index_name
-      name = @algolia_options[:index_name] || model_name.to_s.gsub('::', '_')
-      name = "#{name}_#{Rails.env.to_s}" if @algolia_options[:per_environment]
+      name = algolia_options[:index_name] || model_name.to_s.gsub('::', '_')
+      name = "#{name}_#{Rails.env.to_s}" if algolia_options[:per_environment]
       name
     end
 
     def algolia_must_reindex?(object)
       return true if algolia_object_id_changed?(object)
-      @algolia_index_settings.get_attributes(object).each do |k, v|
+      algolia_index_settings.get_attributes(object).each do |k, v|
         changed_method = "#{k}_changed?"
         return true if object.respond_to?(changed_method) && object.send(changed_method)
       end
@@ -240,13 +248,13 @@ module AlgoliaSearch
       return if @algolia_index
       @algolia_index = Algolia::Index.new(algolia_index_name)
       current_settings = @algolia_index.get_settings rescue nil # if the index doesn't exist
-      @algolia_index.set_settings(@algolia_settings) if algolia_index_settings_changed?(current_settings, @algolia_settings)
+      @algolia_index.set_settings(algolia_settings) if algolia_index_settings_changed?(current_settings, algolia_settings)
     end
 
     private
 
     def algolia_object_id_method
-      @algolia_options[:id] || @algolia_options[:object_id] || :id
+      algolia_options[:id] || algolia_options[:object_id] || :id
     end
 
     def algolia_object_id_of(o)
@@ -285,12 +293,12 @@ module AlgoliaSearch
     end
 
     def algolia_conditional_index?
-      @algolia_options[:if].present? || @algolia_options[:unless].present?
+      algolia_options[:if].present? || algolia_options[:unless].present?
     end
 
     def algolia_indexable?(object)
-      if_passes = @algolia_options[:if].blank? || algolia_constraint_passes?(object, @algolia_options[:if])
-      unless_passes = @algolia_options[:unless].blank? || !algolia_constraint_passes?(object, @algolia_options[:unless])
+      if_passes = algolia_options[:if].blank? || algolia_constraint_passes?(object, algolia_options[:if])
+      unless_passes = algolia_options[:unless].blank? || !algolia_constraint_passes?(object, algolia_options[:unless])
       if_passes && unless_passes
     end
 
@@ -311,6 +319,23 @@ module AlgoliaSearch
         end
       end
     end
+
+    def algolia_find_in_batches(batch_size, &block)
+      if (defined?(::ActiveRecord) && ancestors.include?(::ActiveRecord::Base)) || respond_to?(:find_in_batches)
+        find_in_batches(batch_size: batch_size, &block)
+      else
+        # don't worry, mongoid has its own underlying cursor/streaming mechanism
+        items = []
+        all.each do |item|
+          items << item
+          if items.length % batch_size == 0
+            yield items
+            items = []
+          end
+          yield items unless items.empty?
+        end
+      end
+    end
   end
 
   # these are the instance methods included

data/vendor/assets/javascripts/algolia/algoliasearch.js

@@ -1,74 +1,216 @@
-/*!
- * algoliasearch 2.3.6
- * https://github.com/algolia/algoliasearch-client-js
- * Copyright 2013 Algolia SAS; Licensed MIT
+/*
+ * Copyright (c) 2013 Algolia
+ * http://www.algolia.com/
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
  */
 
-var VERSION = "2.3.6";
+var ALGOLIA_VERSION = '2.3.8';
 
+/*
+ * Copyright (c) 2013 Algolia
+ * http://www.algolia.com/
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+/*
+ * Algolia Search library initialization
+ * @param applicationID the application ID you have in your admin interface
+ * @param apiKey a valid API key for the service
+ * @param method specify if the protocol used is http or https (http by default to make the first search query faster).
+ *        You need to use https is you are doing something else than just search queries.
+ * @param resolveDNS let you disable first empty query that is launch to warmup the service
+ * @param hostsArray (optionnal) the list of hosts that you have received for the service
+ */
 var AlgoliaSearch = function(applicationID, apiKey, method, resolveDNS, hostsArray) {
     this.applicationID = applicationID;
     this.apiKey = apiKey;
+
     if (this._isUndefined(hostsArray)) {
-        hostsArray = [ applicationID + "-1.algolia.io", applicationID + "-2.algolia.io", applicationID + "-3.algolia.io" ];
+        hostsArray = [applicationID + '-1.algolia.io',
+                      applicationID + '-2.algolia.io',
+                      applicationID + '-3.algolia.io'];
     }
     this.hosts = [];
+    // Add hosts in random order
     for (var i = 0; i < hostsArray.length; ++i) {
-        if (Math.random() > .5) {
+        if (Math.random() > 0.5) {
             this.hosts.reverse();
         }
         if (this._isUndefined(method) || method == null) {
-            this.hosts.push(("https:" == document.location.protocol ? "https" : "http") + "://" + hostsArray[i]);
-        } else if (method === "https" || method === "HTTPS") {
-            this.hosts.push("https://" + hostsArray[i]);
+            this.hosts.push(('https:' == document.location.protocol ? 'https' : 'http') + '://' + hostsArray[i]);
+        } else if (method === 'https' || method === 'HTTPS') {
+            this.hosts.push('https://' + hostsArray[i]);
         } else {
-            this.hosts.push("http://" + hostsArray[i]);
+            this.hosts.push('http://' + hostsArray[i]);
         }
     }
-    if (Math.random() > .5) {
+    if (Math.random() > 0.5) {
         this.hosts.reverse();
     }
     if (this._isUndefined(resolveDNS) || resolveDNS) {
-        this._jsonRequest({
-            method: "GET",
-            url: "/1/isalive"
-        });
+        // Perform a call to solve DNS (avoid to slow down the first user query)
+        this._jsonRequest({ method: 'GET',
+                            url: '/1/isalive' });
     }
     this.extraHeaders = [];
 };
 
+function AlgoliaExplainResults(hit, titleAttribute, otherAttributes) {
+
+    function _getHitAxplainationForOneAttr_recurse(obj, foundWords) {
+        if (typeof obj === 'object' && 'matchedWords' in obj && 'value' in obj) {
+            var match = false;
+            for (var j = 0; j < obj.matchedWords.length; ++j) {
+                var word = obj.matchedWords[j];
+                if (!(word in foundWords)) {
+                    foundWords[word] = 1;
+                    match = true;
+                }
+            }
+            return match ? [obj.value] : [];
+        } else if (obj instanceof Array) {
+            var res = [];
+            for (var i = 0; i < obj.length; ++i) {
+                var array = _getHitAxplainationForOneAttr_recurse(obj[i], foundWords);
+                res = res.concat(array);
+            }
+            return res;
+        } else if (typeof obj === 'object') {
+            var res = [];
+            for (prop in obj) {
+                if (obj.hasOwnProperty(prop)){
+                    res = res.concat(_getHitAxplainationForOneAttr_recurse(obj[prop], foundWords));
+                }
+            }
+            return res;
+        }
+        return [];
+    }
+    
+    function _getHitAxplainationForOneAttr(hit, foundWords, attr) {
+        if (attr.indexOf('.') === -1) {
+            if (attr in hit._highlightResult) {
+                return _getHitAxplainationForOneAttr_recurse(hit._highlightResult[attr], foundWords);
+            }
+            return [];
+        }
+        var array = attr.split('.');
+        var obj = hit._highlightResult;
+        for (var i = 0; i < array.length; ++i) {
+            if (array[i] in obj) {
+                obj = obj[array[i]];
+            } else {
+                return [];
+            }
+        }
+        return _getHitAxplainationForOneAttr_recurse(obj, foundWords);
+    }
+
+    var res = {};
+    var foundWords = {};
+    var title = _getHitAxplainationForOneAttr(hit, foundWords, titleAttribute);
+    res.title = (title.length > 0) ? title[0] : "";
+    res.subtitles = [];
+
+    if (typeof otherAttributes !== 'undefined') {
+        for (var i = 0; i < otherAttributes.length; ++i) {
+            var attr = _getHitAxplainationForOneAttr(hit, foundWords, otherAttributes[i]);
+            for (var j = 0; j < attr.length; ++j) {
+                res.subtitles.push({ attr: otherAttributes[i], value: attr[j] });
+            }
+        }
+    }
+    return res;
+}
+
+
 AlgoliaSearch.prototype = {
+    /*
+     * Delete an index
+     *
+     * @param indexName the name of index to delete
+     * @param callback the result callback with two arguments
+     *  success: boolean set to true if the request was successfull
+     *  content: the server answer that contains the task ID
+     */
     deleteIndex: function(indexName, callback) {
-        this._jsonRequest({
-            method: "DELETE",
-            url: "/1/indexes/" + encodeURIComponent(indexName),
-            callback: callback
-        });
+        this._jsonRequest({ method: 'DELETE',
+                            url: '/1/indexes/' + encodeURIComponent(indexName),
+                            callback: callback });
     },
+    /**
+     * Move an existing index.
+     * @param srcIndexName the name of index to copy.
+     * @param dstIndexName the new index name that will contains a copy of srcIndexName (destination will be overriten if it already exist).
+     * @param callback the result callback with two arguments
+     *  success: boolean set to true if the request was successfull
+     *  content: the server answer that contains the task ID
+     */
     moveIndex: function(srcIndexName, dstIndexName, callback) {
-        var postObj = {
-            operation: "move",
-            destination: dstIndexName
-        };
-        this._jsonRequest({
-            method: "POST",
-            url: "/1/indexes/" + encodeURIComponent(srcIndexName) + "/operation",
-            body: postObj,
-            callback: callback
-        });
+        var postObj = {operation: 'move', destination: dstIndexName};
+        this._jsonRequest({ method: 'POST',
+                            url: '/1/indexes/' + encodeURIComponent(srcIndexName) + '/operation',
+                            body: postObj,
+                            callback: callback });
+
     },
+    /**
+     * Copy an existing index.
+     * @param srcIndexName the name of index to copy.
+     * @param dstIndexName the new index name that will contains a copy of srcIndexName (destination will be overriten if it already exist).
+     * @param callback the result callback with two arguments
+     *  success: boolean set to true if the request was successfull
+     *  content: the server answer that contains the task ID
+     */
     copyIndex: function(srcIndexName, dstIndexName, callback) {
-        var postObj = {
-            operation: "copy",
-            destination: dstIndexName
-        };
-        this._jsonRequest({
-            method: "POST",
-            url: "/1/indexes/" + encodeURIComponent(srcIndexName) + "/operation",
-            body: postObj,
-            callback: callback
-        });
+        var postObj = {operation: 'copy', destination: dstIndexName};
+        this._jsonRequest({ method: 'POST',
+                            url: '/1/indexes/' + encodeURIComponent(srcIndexName) + '/operation',
+                            body: postObj,
+                            callback: callback });
     },
+    /**
+     * Return last log entries.
+     * @param offset Specify the first entry to retrieve (0-based, 0 is the most recent log entry).
+     * @param length Specify the maximum number of entries to retrieve starting at offset. Maximum allowed value: 1000.
+     * @param callback the result callback with two arguments
+     *  success: boolean set to true if the request was successfull
+     *  content: the server answer that contains the task ID
+     */
     getLogs: function(callback, offset, length) {
         if (this._isUndefined(offset)) {
             offset = 0;
@@ -76,53 +218,110 @@ AlgoliaSearch.prototype = {
         if (this._isUndefined(length)) {
             length = 10;
         }
-        this._jsonRequest({
-            method: "GET",
-            url: "/1/logs?offset=" + offset + "&length=" + length,
-            callback: callback
-        });
+
+        this._jsonRequest({ method: 'GET',
+                            url: '/1/logs?offset=' + offset + '&length=' + length,
+                            callback: callback });
     },
+    /*
+     * List all existing indexes
+     *
+     * @param callback the result callback with two arguments
+     *  success: boolean set to true if the request was successfull
+     *  content: the server answer with index list or error description if success is false.
+     */
     listIndexes: function(callback) {
-        this._jsonRequest({
-            method: "GET",
-            url: "/1/indexes/",
-            callback: callback
-        });
+        this._jsonRequest({ method: 'GET',
+                            url: '/1/indexes/',
+                            callback: callback });
     },
+
+    /*
+     * Get the index object initialized
+     *
+     * @param indexName the name of index
+     * @param callback the result callback with one argument (the Index instance)
+     */
     initIndex: function(indexName) {
         return new this.Index(this, indexName);
     },
+    /*
+     * List all existing user keys with their associated ACLs
+     *
+     * @param callback the result callback with two arguments
+     *  success: boolean set to true if the request was successfull
+     *  content: the server answer with user keys list or error description if success is false.
+     */
     listUserKeys: function(callback) {
-        this._jsonRequest({
-            method: "GET",
-            url: "/1/keys",
-            callback: callback
-        });
+        this._jsonRequest({ method: 'GET',
+                            url: '/1/keys',
+                            callback: callback });
     },
+    /*
+     * Get ACL of a user key
+     *
+     * @param callback the result callback with two arguments
+     *  success: boolean set to true if the request was successfull
+     *  content: the server answer with user keys list or error description if success is false.
+     */
     getUserKeyACL: function(key, callback) {
-        this._jsonRequest({
-            method: "GET",
-            url: "/1/keys/" + key,
-            callback: callback
-        });
+        this._jsonRequest({ method: 'GET',
+                            url: '/1/keys/' + key,
+                            callback: callback });
     },
+    /*
+     * Delete an existing user key
+     *
+     * @param callback the result callback with two arguments
+     *  success: boolean set to true if the request was successfull
+     *  content: the server answer with user keys list or error description if success is false.
+     */
     deleteUserKey: function(key, callback) {
-        this._jsonRequest({
-            method: "DELETE",
-            url: "/1/keys/" + key,
-            callback: callback
-        });
+        this._jsonRequest({ method: 'DELETE',
+                            url: '/1/keys/' + key,
+                            callback: callback });
     },
+    /*
+     * Add an existing user key
+     *
+     * @param acls the list of ACL for this key. Defined by an array of strings that
+     * can contains the following values:
+     *   - search: allow to search (https and http)
+     *   - addObject: allows to add/update an object in the index (https only)
+     *   - deleteObject : allows to delete an existing object (https only)
+     *   - deleteIndex : allows to delete index content (https only)
+     *   - settings : allows to get index settings (https only)
+     *   - editSettings : allows to change index settings (https only)
+     * @param callback the result callback with two arguments
+     *  success: boolean set to true if the request was successfull
+     *  content: the server answer with user keys list or error description if success is false.
+     */
     addUserKey: function(acls, callback) {
         var aclsObject = {};
         aclsObject.acl = acls;
-        this._jsonRequest({
-            method: "POST",
-            url: "/1/keys",
-            body: aclsObject,
-            callback: callback
-        });
+        this._jsonRequest({ method: 'POST',
+                            url: '/1/keys',
+                            body: aclsObject,
+                            callback: callback });
     },
+    /*
+     * Add an existing user key
+     *
+     * @param acls the list of ACL for this key. Defined by an array of strings that
+     * can contains the following values:
+     *   - search: allow to search (https and http)
+     *   - addObject: allows to add/update an object in the index (https only)
+     *   - deleteObject : allows to delete an existing object (https only)
+     *   - deleteIndex : allows to delete index content (https only)
+     *   - settings : allows to get index settings (https only)
+     *   - editSettings : allows to change index settings (https only)
+     * @param validity the number of seconds after which the key will be automatically removed (0 means no time limit for this key)
+     * @param maxQueriesPerIPPerHour Specify the maximum number of API calls allowed from an IP address per hour.
+     * @param maxHitsPerQuery Specify the maximum number of hits this API key can retrieve in one call.
+     * @param callback the result callback with two arguments
+     *  success: boolean set to true if the request was successfull
+     *  content: the server answer with user keys list or error description if success is false.
+     */
     addUserKeyWithValidity: function(acls, validity, maxQueriesPerIPPerHour, maxHitsPerQuery, callback) {
         var indexObj = this;
         var aclsObject = {};
@@ -130,42 +329,64 @@ AlgoliaSearch.prototype = {
         aclsObject.validity = validity;
         aclsObject.maxQueriesPerIPPerHour = maxQueriesPerIPPerHour;
         aclsObject.maxHitsPerQuery = maxHitsPerQuery;
-        this._jsonRequest({
-            method: "POST",
-            url: "/1/indexes/" + indexObj.indexName + "/keys",
-            body: aclsObject,
-            callback: callback
-        });
+        this._jsonRequest({ method: 'POST',
+                            url: '/1/indexes/' + indexObj.indexName + '/keys',
+                            body: aclsObject,
+                            callback: callback });
     },
+    /*
+     * Initialize a new batch of search queries
+     */
     startQueriesBatch: function() {
         this.batch = [];
     },
+    /*
+     * Add a search query in the batch
+     *
+     * @param query the full text query
+     * @param args (optional) if set, contains an object with query parameters:
+     *  - attributes: an array of object attribute names to retrieve
+     *     (if not set all attributes are retrieve)
+     *  - attributesToHighlight: an array of object attribute names to highlight
+     *     (if not set indexed attributes are highlighted)
+     *  - minWordSizefor1Typo: the minimum number of characters to accept one typo.
+     *     Defaults to 3.
+     *  - minWordSizefor2Typos: the minimum number of characters to accept two typos.
+     *     Defaults to 7.
+     *  - getRankingInfo: if set, the result hits will contain ranking information in
+     *     _rankingInfo attribute
+     *  - page: (pagination parameter) page to retrieve (zero base). Defaults to 0.
+     *  - hitsPerPage: (pagination parameter) number of hits per page. Defaults to 10.
+     */
     addQueryInBatch: function(indexName, query, args) {
-        var params = "query=" + encodeURIComponent(query);
+        var params = 'query=' + encodeURIComponent(query);
         if (!this._isUndefined(args) && args != null) {
             params = this._getSearchParams(args, params);
         }
-        this.batch.push({
-            indexName: indexName,
-            params: params
-        });
+        this.batch.push({ indexName: indexName, params: params });
     },
+    /*
+     * Clear all queries in cache
+     */
     clearCache: function() {
         this.cache = {};
     },
+    /*
+     * Launch the batch of queries using XMLHttpRequest.
+     * (Optimized for browser using a POST query to minimize number of OPTIONS queries)
+     *
+     * @param callback the function that will receive results
+     * @param delay (optional) if set, wait for this delay (in ms) and only send the batch if there was no other in the meantime.
+     */
     sendQueriesBatch: function(callback, delay) {
         var as = this;
-        var params = {
-            requests: [],
-            apiKey: this.apiKey,
-            appID: this.applicationID
-        };
+        var params = {requests: [], apiKey: this.apiKey, appID: this.applicationID};
         for (var i = 0; i < as.batch.length; ++i) {
             params.requests.push(as.batch[i]);
         }
         window.clearTimeout(as.onDelayTrigger);
         if (!this._isUndefined(delay) && delay != null && delay > 0) {
-            var onDelayTrigger = window.setTimeout(function() {
+            var onDelayTrigger = window.setTimeout( function() {
                 as._sendQueriesBatch(params, callback);
             }, delay);
             as.onDelayTrigger = onDelayTrigger;
@@ -173,34 +394,38 @@ AlgoliaSearch.prototype = {
             this._sendQueriesBatch(params, callback);
         }
     },
+    /*
+     * Index class constructor.
+     * You should not use this method directly but use initIndex() function
+     */
     Index: function(algoliasearch, indexName) {
         this.indexName = indexName;
         this.as = algoliasearch;
         this.typeAheadArgs = null;
         this.typeAheadValueOption = null;
     },
+
     setExtraHeader: function(key, value) {
-        this.extraHeaders.push({
-            key: key,
-            value: value
-        });
+        this.extraHeaders.push({ key: key, value: value});
     },
+
     _sendQueriesBatch: function(params, callback) {
-        this._jsonRequest({
-            cache: this.cache,
-            method: "POST",
-            url: "/1/indexes/*/queries",
-            body: params,
-            callback: callback
-        });
+        this._jsonRequest({ cache: this.cache,
+                               method: 'POST',
+                               url: '/1/indexes/*/queries',
+                               body: params,
+                               callback: callback });
     },
+    /*
+     * Wrapper that try all hosts to maximize the quality of service
+     */
     _jsonRequest: function(opts) {
         var self = this;
         var callback = opts.callback;
         var cache = null;
         var cacheID = opts.url;
         if (!this._isUndefined(opts.body)) {
-            cacheID = opts.url + "_body_" + JSON.stringify(opts.body);
+            cacheID = opts.url + '_body_' + JSON.stringify(opts.body);
         }
         if (!this._isUndefined(opts.cache)) {
             cache = opts.cache;
@@ -211,6 +436,7 @@ AlgoliaSearch.prototype = {
                 return;
             }
         }
+
         var impl = function(position) {
             var idx = 0;
             if (!self._isUndefined(position)) {
@@ -218,20 +444,18 @@ AlgoliaSearch.prototype = {
             }
             if (self.hosts.length <= idx) {
                 if (!self._isUndefined(callback)) {
-                    callback(false, {
-                        message: "Cannot contact server"
-                    });
+                    callback(false, { message: 'Cannot contact server'});
                 }
                 return;
             }
             opts.callback = function(retry, success, res, body) {
                 if (!success && !self._isUndefined(body)) {
-                    console.log("Error: " + body.message);
+                    console.log('Error: ' + body.message);
                 }
                 if (success && !self._isUndefined(opts.cache)) {
                     cache[cacheID] = body;
                 }
-                if (!success && retry && idx + 1 < self.hosts.length) {
+                if (!success && retry && (idx + 1) < self.hosts.length) {
                     impl(idx + 1);
                 } else {
                     if (!self._isUndefined(callback)) {
@@ -244,6 +468,7 @@ AlgoliaSearch.prototype = {
         };
         impl();
     },
+
     _jsonRequestByHost: function(opts) {
         var body = null;
         var self = this;
@@ -252,47 +477,53 @@ AlgoliaSearch.prototype = {
         }
         var url = opts.hostname + opts.url;
         var xmlHttp = null;
+
         xmlHttp = new XMLHttpRequest();
-        if ("withCredentials" in xmlHttp) {
-            xmlHttp.open(opts.method, url, true);
-            xmlHttp.setRequestHeader("X-Algolia-API-Key", this.apiKey);
-            xmlHttp.setRequestHeader("X-Algolia-Application-Id", this.applicationID);
+        if ('withCredentials' in xmlHttp) {
+            xmlHttp.open(opts.method, url , true);
+            xmlHttp.setRequestHeader('X-Algolia-API-Key', this.apiKey);
+            xmlHttp.setRequestHeader('X-Algolia-Application-Id', this.applicationID);
             for (var i = 0; i < this.extraHeaders.length; ++i) {
                 xmlHttp.setRequestHeader(this.extraHeaders[i].key, this.extraHeaders[i].value);
             }
             if (body != null) {
-                xmlHttp.setRequestHeader("Content-type", "application/json");
+                xmlHttp.setRequestHeader('Content-type', 'application/json');
             }
-        } else if (typeof XDomainRequest != "undefined") {
+        } else if (typeof XDomainRequest != 'undefined') {
+            // Handle IE8/IE9
+            // XDomainRequest only exists in IE, and is IE's way of making CORS requests.
             xmlHttp = new XDomainRequest();
             xmlHttp.open(opts.method, url);
         } else {
-            console.log("your browser is too old to support CORS requests");
+            // very old browser, not supported
+            console.log('your browser is too old to support CORS requests');
         }
         xmlHttp.send(body);
         xmlHttp.onload = function(event) {
             if (!self._isUndefined(event) && event.target != null) {
-                var retry = event.target.status === 0 || event.target.status === 503;
-                var success = event.target.status === 200 || event.target.status === 201;
+                var retry = (event.target.status === 0 || event.target.status === 503);
+                var success = (event.target.status === 200 || event.target.status === 201);
                 opts.callback(retry, success, event.target, event.target.response != null ? JSON.parse(event.target.response) : null);
             } else {
                 opts.callback(false, true, event, JSON.parse(xmlHttp.responseText));
             }
         };
         xmlHttp.onerror = function() {
-            opts.callback(true, false, null, {
-                message: "Could not connect to Host"
-            });
+            opts.callback(true, false, null, { 'message': 'Could not connect to Host'} );
         };
     },
+
+     /*
+     * Transform search param object in query string
+     */
     _getSearchParams: function(args, params) {
         if (this._isUndefined(args) || args == null) {
             return params;
         }
         for (var key in args) {
             if (key != null && args.hasOwnProperty(key)) {
-                params += params.length === 0 ? "?" : "&";
-                params += key + "=" + encodeURIComponent(Object.prototype.toString.call(args[key]) === "[object Array]" ? JSON.stringify(args[key]) : args[key]);
+                params += (params.length === 0) ? '?' : '&';
+                params += key + '=' + encodeURIComponent(Object.prototype.toString.call(args[key]) === '[object Array]' ? JSON.stringify(args[key]) : args[key]);
             }
         }
         return params;
@@ -300,6 +531,8 @@ AlgoliaSearch.prototype = {
     _isUndefined: function(obj) {
         return obj === void 0;
     },
+
+    /// internal attributes
     applicationID: null,
     apiKey: null,
     hosts: [],
@@ -307,311 +540,803 @@ AlgoliaSearch.prototype = {
     extraHeaders: []
 };
 
+/*
+ * Contains all the functions related to one index
+ * You should use AlgoliaSearch.initIndex(indexName) to retrieve this object
+ */
 AlgoliaSearch.prototype.Index.prototype = {
-    clearCache: function() {
-        this.cache = {};
-    },
-    addObject: function(content, callback, objectID) {
-        var indexObj = this;
-        if (this.as._isUndefined(objectID)) {
-            this.as._jsonRequest({
-                method: "POST",
-                url: "/1/indexes/" + encodeURIComponent(indexObj.indexName),
-                body: content,
-                callback: callback
-            });
-        } else {
-            this.as._jsonRequest({
-                method: "PUT",
-                url: "/1/indexes/" + encodeURIComponent(indexObj.indexName) + "/" + encodeURIComponent(objectID),
-                body: content,
-                callback: callback
-            });
-        }
-    },
-    addObjects: function(objects, callback) {
-        var indexObj = this;
-        var postObj = {
-            requests: []
-        };
-        for (var i = 0; i < objects.length; ++i) {
-            var request = {
-                action: "addObject",
-                body: objects[i]
-            };
-            postObj.requests.push(request);
-        }
-        this.as._jsonRequest({
-            method: "POST",
-            url: "/1/indexes/" + encodeURIComponent(indexObj.indexName) + "/batch",
-            body: postObj,
-            callback: callback
-        });
-    },
-    getObject: function(objectID, callback, attributes) {
-        var indexObj = this;
-        var params = "";
-        if (!this.as._isUndefined(attributes)) {
-            params = "?attributes=";
-            for (var i = 0; i < attributes.length; ++i) {
-                if (i !== 0) {
-                    params += ",";
+        /*
+         * Clear all queries in cache
+         */
+        clearCache: function() {
+            this.cache = {};
+        },
+        /*
+         * Add an object in this index
+         *
+         * @param content contains the javascript object to add inside the index
+         * @param callback (optional) the result callback with two arguments:
+         *  success: boolean set to true if the request was successfull
+         *  content: the server answer that contains 3 elements: createAt, taskId and objectID
+         * @param objectID (optional) an objectID you want to attribute to this object
+         * (if the attribute already exist the old object will be overwrite)
+         */
+        addObject: function(content, callback, objectID) {
+            var indexObj = this;
+            if (this.as._isUndefined(objectID)) {
+                this.as._jsonRequest({ method: 'POST',
+                                       url: '/1/indexes/' + encodeURIComponent(indexObj.indexName),
+                                       body: content,
+                                       callback: callback });
+            } else {
+                this.as._jsonRequest({ method: 'PUT',
+                                       url: '/1/indexes/' + encodeURIComponent(indexObj.indexName) + '/' + encodeURIComponent(objectID),
+                                       body: content,
+                                       callback: callback });
+            }
+
+        },
+        /*
+         * Add several objects
+         *
+         * @param objects contains an array of objects to add
+         * @param callback (optional) the result callback with two arguments:
+         *  success: boolean set to true if the request was successfull
+         *  content: the server answer that updateAt and taskID
+         */
+        addObjects: function(objects, callback) {
+            var indexObj = this;
+            var postObj = {requests:[]};
+            for (var i = 0; i < objects.length; ++i) {
+                var request = { action: 'addObject',
+                                body: objects[i] };
+                postObj.requests.push(request);
+            }
+            this.as._jsonRequest({ method: 'POST',
+                                   url: '/1/indexes/' + encodeURIComponent(indexObj.indexName) + '/batch',
+                                   body: postObj,
+                                   callback: callback });
+        },
+        /*
+         * Get an object from this index
+         *
+         * @param objectID the unique identifier of the object to retrieve
+         * @param callback (optional) the result callback with two arguments
+         *  success: boolean set to true if the request was successfull
+         *  content: the object to retrieve or the error message if a failure occured
+         * @param attributes (optional) if set, contains the array of attribute names to retrieve
+         */
+        getObject: function(objectID, callback, attributes) {
+            var indexObj = this;
+            var params = '';
+            if (!this.as._isUndefined(attributes)) {
+                params = '?attributes=';
+                for (var i = 0; i < attributes.length; ++i) {
+                    if (i !== 0) {
+                        params += ',';
+                    }
+                    params += attributes[i];
                 }
-                params += attributes[i];
             }
-        }
-        this.as._jsonRequest({
-            method: "GET",
-            url: "/1/indexes/" + encodeURIComponent(indexObj.indexName) + "/" + encodeURIComponent(objectID) + params,
-            callback: callback
-        });
-    },
-    partialUpdateObject: function(partialObject, callback) {
-        var indexObj = this;
-        this.as._jsonRequest({
-            method: "POST",
-            url: "/1/indexes/" + encodeURIComponent(indexObj.indexName) + "/" + encodeURIComponent(partialObject.objectID) + "/partial",
-            body: partialObject,
-            callback: callback
-        });
-    },
-    partialUpdateObjects: function(objects, callback) {
-        var indexObj = this;
-        var postObj = {
-            requests: []
-        };
-        for (var i = 0; i < objects.length; ++i) {
-            var request = {
-                action: "partialUpdateObject",
-                objectID: encodeURIComponent(objects[i].objectID),
-                body: objects[i]
-            };
-            postObj.requests.push(request);
-        }
-        this.as._jsonRequest({
-            method: "POST",
-            url: "/1/indexes/" + encodeURIComponent(indexObj.indexName) + "/batch",
-            body: postObj,
-            callback: callback
-        });
-    },
-    saveObject: function(object, callback) {
-        var indexObj = this;
-        this.as._jsonRequest({
-            method: "PUT",
-            url: "/1/indexes/" + encodeURIComponent(indexObj.indexName) + "/" + encodeURIComponent(object.objectID),
-            body: object,
-            callback: callback
-        });
-    },
-    saveObjects: function(objects, callback) {
-        var indexObj = this;
-        var postObj = {
-            requests: []
-        };
-        for (var i = 0; i < objects.length; ++i) {
-            var request = {
-                action: "updateObject",
-                objectID: encodeURIComponent(objects[i].objectID),
-                body: objects[i]
-            };
-            postObj.requests.push(request);
-        }
-        this.as._jsonRequest({
-            method: "POST",
-            url: "/1/indexes/" + encodeURIComponent(indexObj.indexName) + "/batch",
-            body: postObj,
-            callback: callback
-        });
-    },
-    deleteObject: function(objectID, callback) {
-        if (objectID == null || objectID.length === 0) {
-            callback(false, {
-                message: "empty objectID"
-            });
-            return;
-        }
-        var indexObj = this;
-        this.as._jsonRequest({
-            method: "DELETE",
-            url: "/1/indexes/" + encodeURIComponent(indexObj.indexName) + "/" + encodeURIComponent(objectID),
-            callback: callback
-        });
-    },
-    search: function(query, callback, args, delay) {
-        var indexObj = this;
-        var params = "query=" + encodeURIComponent(query);
-        if (!this.as._isUndefined(args) && args != null) {
-            params = this.as._getSearchParams(args, params);
-        }
-        window.clearTimeout(indexObj.onDelayTrigger);
-        if (!this.as._isUndefined(delay) && delay != null && delay > 0) {
-            var onDelayTrigger = window.setTimeout(function() {
-                indexObj._search(params, callback);
-            }, delay);
-            indexObj.onDelayTrigger = onDelayTrigger;
-        } else {
-            this._search(params, callback);
-        }
-    },
-    browse: function(page, callback, hitsPerPage) {
-        var indexObj = this;
-        var params = "?page=" + page;
-        if (!_.isUndefined(hitsPerPage)) {
-            params += "&hitsPerPage=" + hitsPerPage;
-        }
-        this.as._jsonRequest({
-            method: "GET",
-            url: "/1/indexes/" + encodeURIComponent(indexObj.indexName) + "/browse" + params,
-            callback: callback
-        });
-    },
-    getTypeaheadTransport: function(args, valueOption) {
-        this.typeAheadArgs = args;
-        if (typeof valueOption !== "undefined") {
-            this.typeAheadValueOption = valueOption;
-        }
-        return this;
-    },
-    get: function(query, processRemoteData, that, cb, suggestions) {
-        self = this;
-        this.search(query, function(success, content) {
-            if (success) {
-                for (var i = 0; i < content.hits.length; ++i) {
-                    var obj = content.hits[i], found = false;
-                    if (typeof obj.value === "undefined") {
-                        if (self.typeAheadValueOption != null) {
-                            if (typeof self.typeAheadValueOption === "function") {
-                                obj.value = self.typeAheadValueOption(obj);
-                                found = true;
-                            } else if (typeof obj[self.typeAheadValueOption] !== "undefined") {
-                                obj.value = obj[self.typeAheadValueOption];
-                                found = true;
-                            }
-                        }
-                        if (!found) {
-                            for (var propertyName in obj) {
-                                if (!found && obj.hasOwnProperty(propertyName) && typeof obj[propertyName] === "string") {
-                                    obj.value = obj[propertyName];
+            this.as._jsonRequest({ method: 'GET',
+                                   url: '/1/indexes/' + encodeURIComponent(indexObj.indexName) + '/' + encodeURIComponent(objectID) + params,
+                                   callback: callback });
+        },
+
+        /*
+         * Update partially an object (only update attributes passed in argument)
+         *
+         * @param partialObject contains the javascript attributes to override, the
+         *  object must contains an objectID attribute
+         * @param callback (optional) the result callback with two arguments:
+         *  success: boolean set to true if the request was successfull
+         *  content: the server answer that contains 3 elements: createAt, taskId and objectID
+         */
+        partialUpdateObject: function(partialObject, callback) {
+            var indexObj = this;
+            this.as._jsonRequest({ method: 'POST',
+                                   url: '/1/indexes/' + encodeURIComponent(indexObj.indexName) + '/' + encodeURIComponent(partialObject.objectID) + '/partial',
+                                   body: partialObject,
+                                   callback:  callback });
+        },
+        /*
+         * Partially Override the content of several objects
+         *
+         * @param objects contains an array of objects to update (each object must contains a objectID attribute)
+         * @param callback (optional) the result callback with two arguments:
+         *  success: boolean set to true if the request was successfull
+         *  content: the server answer that updateAt and taskID
+         */
+        partialUpdateObjects: function(objects, callback) {
+            var indexObj = this;
+            var postObj = {requests:[]};
+            for (var i = 0; i < objects.length; ++i) {
+                var request = { action: 'partialUpdateObject',
+                                objectID: objects[i].objectID,
+                                body: objects[i] };
+                postObj.requests.push(request);
+            }
+            this.as._jsonRequest({ method: 'POST',
+                                   url: '/1/indexes/' + encodeURIComponent(indexObj.indexName) + '/batch',
+                                   body: postObj,
+                                   callback: callback });
+        },
+        /*
+         * Override the content of object
+         *
+         * @param object contains the javascript object to save, the object must contains an objectID attribute
+         * @param callback (optional) the result callback with two arguments:
+         *  success: boolean set to true if the request was successfull
+         *  content: the server answer that updateAt and taskID
+         */
+        saveObject: function(object, callback) {
+            var indexObj = this;
+            this.as._jsonRequest({ method: 'PUT',
+                                   url: '/1/indexes/' + encodeURIComponent(indexObj.indexName) + '/' + encodeURIComponent(object.objectID),
+                                   body: object,
+                                   callback: callback });
+        },
+        /*
+         * Override the content of several objects
+         *
+         * @param objects contains an array of objects to update (each object must contains a objectID attribute)
+         * @param callback (optional) the result callback with two arguments:
+         *  success: boolean set to true if the request was successfull
+         *  content: the server answer that updateAt and taskID
+         */
+        saveObjects: function(objects, callback) {
+            var indexObj = this;
+            var postObj = {requests:[]};
+            for (var i = 0; i < objects.length; ++i) {
+                var request = { action: 'updateObject',
+                                objectID: objects[i].objectID,
+                                body: objects[i] };
+                postObj.requests.push(request);
+            }
+            this.as._jsonRequest({ method: 'POST',
+                                   url: '/1/indexes/' + encodeURIComponent(indexObj.indexName) + '/batch',
+                                   body: postObj,
+                                   callback: callback });
+        },
+        /*
+         * Delete an object from the index
+         *
+         * @param objectID the unique identifier of object to delete
+         * @param callback (optional) the result callback with two arguments:
+         *  success: boolean set to true if the request was successfull
+         *  content: the server answer that contains 3 elements: createAt, taskId and objectID
+         */
+        deleteObject: function(objectID, callback) {
+            if (objectID == null || objectID.length === 0) {
+                callback(false, { message: 'empty objectID'});
+                return;
+            }
+            var indexObj = this;
+            this.as._jsonRequest({ method: 'DELETE',
+                                   url: '/1/indexes/' + encodeURIComponent(indexObj.indexName) + '/' + encodeURIComponent(objectID),
+                                   callback: callback });
+        },
+        /*
+         * Search inside the index using XMLHttpRequest request (Using a POST query to
+         * minimize number of OPTIONS queries: Cross-Origin Resource Sharing).
+         *
+         * @param query the full text query
+         * @param callback the result callback with two arguments:
+         *  success: boolean set to true if the request was successfull. If false, the content contains the error.
+         *  content: the server answer that contains the list of results.
+         * @param args (optional) if set, contains an object with query parameters:
+         * - page: (integer) Pagination parameter used to select the page to retrieve.
+         *                   Page is zero-based and defaults to 0. Thus, to retrieve the 10th page you need to set page=9
+         * - hitsPerPage: (integer) Pagination parameter used to select the number of hits per page. Defaults to 20.
+         * - attributesToRetrieve: a string that contains the list of object attributes you want to retrieve (let you minimize the answer size).
+         *   Attributes are separated with a comma (for example "name,address").
+         *   You can also use a string array encoding (for example ["name","address"]).
+         *   By default, all attributes are retrieved. You can also use '*' to retrieve all values when an attributesToRetrieve setting is specified for your index.
+         * - attributesToHighlight: a string that contains the list of attributes you want to highlight according to the query.
+         *   Attributes are separated by a comma. You can also use a string array encoding (for example ["name","address"]).
+         *   If an attribute has no match for the query, the raw value is returned. By default all indexed text attributes are highlighted.
+         *   You can use `*` if you want to highlight all textual attributes. Numerical attributes are not highlighted.
+         *   A matchLevel is returned for each highlighted attribute and can contain:
+         *      - full: if all the query terms were found in the attribute,
+         *      - partial: if only some of the query terms were found,
+         *      - none: if none of the query terms were found.
+         * - attributesToSnippet: a string that contains the list of attributes to snippet alongside the number of words to return (syntax is `attributeName:nbWords`).
+         *    Attributes are separated by a comma (Example: attributesToSnippet=name:10,content:10).
+         *    You can also use a string array encoding (Example: attributesToSnippet: ["name:10","content:10"]). By default no snippet is computed.
+         * - minWordSizefor1Typo: the minimum number of characters in a query word to accept one typo in this word. Defaults to 3.
+         * - minWordSizefor2Typos: the minimum number of characters in a query word to accept two typos in this word. Defaults to 7.
+         * - getRankingInfo: if set to 1, the result hits will contain ranking information in _rankingInfo attribute.
+         * - aroundLatLng: search for entries around a given latitude/longitude (specified as two floats separated by a comma).
+         *   For example aroundLatLng=47.316669,5.016670).
+         *   You can specify the maximum distance in meters with the aroundRadius parameter (in meters) and the precision for ranking with aroundPrecision
+         *   (for example if you set aroundPrecision=100, two objects that are distant of less than 100m will be considered as identical for "geo" ranking parameter).
+         *   At indexing, you should specify geoloc of an object with the _geoloc attribute (in the form {"_geoloc":{"lat":48.853409, "lng":2.348800}})
+         * - insideBoundingBox: search entries inside a given area defined by the two extreme points of a rectangle (defined by 4 floats: p1Lat,p1Lng,p2Lat,p2Lng).
+         *   For example insideBoundingBox=47.3165,4.9665,47.3424,5.0201).
+         *   At indexing, you should specify geoloc of an object with the _geoloc attribute (in the form {"_geoloc":{"lat":48.853409, "lng":2.348800}})
+         * - 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"]).
+         * - 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).
+         *   At indexing, tags should be added in the _tags** attribute of objects (for example {"_tags":["tag1","tag2"]}).
+         * - facetFilters: filter the query by a list of facets.
+         *   Facets are separated by commas and each facet is encoded as `attributeName:value`.
+         *   For example: `facetFilters=category:Book,author:John%20Doe`.
+         *   You can also use a string array encoding (for example `["category:Book","author:John%20Doe"]`).
+         * - facets: List of object attributes that you want to use for faceting.
+         *   Attributes are separated with a comma (for example `"category,author"` ).
+         *   You can also use a JSON string array encoding (for example ["category","author"]).
+         *   Only attributes that have been added in **attributesForFaceting** index setting can be used in this parameter.
+         *   You can also use `*` to perform faceting on all attributes specified in **attributesForFaceting**.
+         * - 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.
+         * - 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.
+         * - 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.
+         * @param delay (optional) if set, wait for this delay (in ms) and only send the query if there was no other in the meantime.
+         */
+        search: function(query, callback, args, delay) {
+            var indexObj = this;
+            var params = 'query=' + encodeURIComponent(query);
+            if (!this.as._isUndefined(args) && args != null) {
+                params = this.as._getSearchParams(args, params);
+            }
+            window.clearTimeout(indexObj.onDelayTrigger);
+            if (!this.as._isUndefined(delay) && delay != null && delay > 0) {
+                var onDelayTrigger = window.setTimeout( function() {
+                    indexObj._search(params, callback);
+                }, delay);
+                indexObj.onDelayTrigger = onDelayTrigger;
+            } else {
+                this._search(params, callback);
+            }
+        },
+
+        /*
+         * Browse all index content
+         *
+         * @param page Pagination parameter used to select the page to retrieve.
+         *             Page is zero-based and defaults to 0. Thus, to retrieve the 10th page you need to set page=9
+         * @param hitsPerPage: Pagination parameter used to select the number of hits per page. Defaults to 1000.
+         */
+        browse: function(page, callback, hitsPerPage) {
+            var indexObj = this;
+            var params = '?page=' + page;
+            if (!_.isUndefined(hitsPerPage)) {
+                params += '&hitsPerPage=' + hitsPerPage;
+            }
+            this.as._jsonRequest({ method: 'GET',
+                                   url: '/1/indexes/' + encodeURIComponent(indexObj.indexName) + '/browse' + params,
+                                   callback: callback });
+        },
+
+        /*
+         * Get transport layer for Typeahead.js
+         * @param args (optional) if set, contains an object with query parameters (see search for details)
+         * @param propertyName(optional) if set, contains the name of property that will be used for
+         */
+        getTypeaheadTransport: function(args, valueOption) {
+            this.typeAheadArgs = args;
+            if (typeof valueOption !== 'undefined') {
+                this.typeAheadValueOption = valueOption;
+            }
+            return this;
+        },
+        /*
+         * Update parameter of transport layer for Typeahead.js
+         * @param args contains an object with query parameters (see search for details)
+         * @param propertyName(optional) if set, contains the name of property that will be used for
+         */
+        setTypeaheadParams: function(args, valueOption) {
+            this.typeAHeadArgs = args;
+            if (typeof valueOption !== 'undefined') {
+                this.typeAheadValueOption = valueOption;
+            }
+        },
+        // Method used by Typeahead.js.
+        get: function(query, processRemoteData, that, cb, suggestions) {
+            self = this;
+            this.search(query, function(success, content) {
+                if (success) {
+                    for (var i = 0; i < content.hits.length; ++i) {
+                        // Add an attribute value with the first string
+                        var obj = content.hits[i],
+                            found = false;
+
+                        if (typeof obj.value === 'undefined') {
+                            if (self.typeAheadValueOption != null) {
+                                if (typeof self.typeAheadValueOption === 'function') {
+                                    obj.value = self.typeAheadValueOption(obj);
+                                    found = true;
+                                } else if (typeof obj[self.typeAheadValueOption] !== 'undefined') {
+                                    obj.value = obj[self.typeAheadValueOption];
                                     found = true;
                                 }
                             }
+                            if (! found) {
+                                for (var propertyName in obj) {
+                                    if (!found && obj.hasOwnProperty(propertyName) && typeof obj[propertyName] === 'string') {
+                                        obj.value = obj[propertyName];
+                                        found = true;
+                                    }
+                                }
+                            }
                         }
+                        suggestions.push(that._transformDatum(obj));
                     }
-                    suggestions.push(that._transformDatum(obj));
+                    cb && cb(suggestions);
                 }
-                cb && cb(suggestions);
-            }
-        }, self.typeAheadArgs);
-        return true;
-    },
-    waitTask: function(taskID, callback) {
-        var indexObj = this;
-        this.as._jsonRequest({
-            method: "GET",
-            url: "/1/indexes/" + encodeURIComponent(indexObj.indexName) + "/task/" + taskID,
-            callback: function(success, body) {
-                if (success && body.status === "published") {
+            }, self.typeAheadArgs);
+            return true;
+        },
+        /*
+         * 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.
+         *
+         * @param taskID the id of the task returned by server
+         * @param callback the result callback with with two arguments:
+         *  success: boolean set to true if the request was successfull
+         *  content: the server answer that contains the list of results
+         */
+        waitTask: function(taskID, callback) {
+            var indexObj = this;
+            this.as._jsonRequest({ method: 'GET',
+                                   url: '/1/indexes/' + encodeURIComponent(indexObj.indexName) + '/task/' + taskID,
+                                   callback: function(success, body) {
+                if (success && body.status === 'published') {
                     callback(true, body);
                 } else if (success && body.pendingTask) {
                     return indexObj.waitTask(taskID, callback);
                 } else {
                     callback(false, body);
                 }
-            }
-        });
+            }});
+        },
+
+        /*
+         * This function deletes the index content. Settings and index specific API keys are kept untouched.
+         *
+         * @param callback (optional) the result callback with two arguments
+         *  success: boolean set to true if the request was successfull
+         *  content: the settings object or the error message if a failure occured
+         */
+        clearIndex: function(callback) {
+            var indexObj = this;
+            this.as._jsonRequest({ method: 'POST',
+                                   url: '/1/indexes/' + encodeURIComponent(indexObj.indexName) + '/clear',
+                                   callback: callback });
+        },
+        /*
+         * Get settings of this index
+         *
+         * @param callback (optional) the result callback with two arguments
+         *  success: boolean set to true if the request was successfull
+         *  content: the settings object or the error message if a failure occured
+         */
+        getSettings: function(callback) {
+            var indexObj = this;
+            this.as._jsonRequest({ method: 'GET',
+                                   url: '/1/indexes/' + encodeURIComponent(indexObj.indexName) + '/settings',
+                                   callback: callback });
+        },
+
+        /*
+         * 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.
+         * @param callback (optional) the result callback with two arguments
+         *  success: boolean set to true if the request was successfull
+         *  content: the server answer or the error message if a failure occured
+         */
+        setSettings: function(settings, callback) {
+            var indexObj = this;
+            this.as._jsonRequest({ method: 'PUT',
+                                   url: '/1/indexes/' + encodeURIComponent(indexObj.indexName) + '/settings',
+                                   body: settings,
+                                   callback: callback });
+        },
+        /*
+         * List all existing user keys associated to this index
+         *
+         * @param callback the result callback with two arguments
+         *  success: boolean set to true if the request was successfull
+         *  content: the server answer with user keys list or error description if success is false.
+         */
+        listUserKeys: function(callback) {
+            var indexObj = this;
+            this.as._jsonRequest({ method: 'GET',
+                                   url: '/1/indexes/' + encodeURIComponent(indexObj.indexName) + '/keys',
+                                   callback: callback });
+        },
+        /*
+         * Get ACL of a user key associated to this index
+         *
+         * @param callback the result callback with two arguments
+         *  success: boolean set to true if the request was successfull
+         *  content: the server answer with user keys list or error description if success is false.
+         */
+        getUserKeyACL: function(key, callback) {
+            var indexObj = this;
+            this.as._jsonRequest({ method: 'GET',
+                                   url: '/1/indexes/' + encodeURIComponent(indexObj.indexName) + '/keys/' + key,
+                                   callback: callback });
+        },
+        /*
+         * Delete an existing user key associated to this index
+         *
+         * @param callback the result callback with two arguments
+         *  success: boolean set to true if the request was successfull
+         *  content: the server answer with user keys list or error description if success is false.
+         */
+        deleteUserKey: function(key, callback) {
+            var indexObj = this;
+            this.as._jsonRequest({ method: 'DELETE',
+                                   url: '/1/indexes/' + encodeURIComponent(indexObj.indexName) + '/keys/' + key,
+                                   callback: callback });
+        },
+        /*
+         * Add an existing user key associated to this index
+         *
+         * @param acls the list of ACL for this key. Defined by an array of strings that
+         * can contains the following values:
+         *   - search: allow to search (https and http)
+         *   - addObject: allows to add/update an object in the index (https only)
+         *   - deleteObject : allows to delete an existing object (https only)
+         *   - deleteIndex : allows to delete index content (https only)
+         *   - settings : allows to get index settings (https only)
+         *   - editSettings : allows to change index settings (https only)
+         * @param callback the result callback with two arguments
+         *  success: boolean set to true if the request was successfull
+         *  content: the server answer with user keys list or error description if success is false.
+         */
+        addUserKey: function(acls, callback) {
+            var indexObj = this;
+            var aclsObject = {};
+            aclsObject.acl = acls;
+            this.as._jsonRequest({ method: 'POST',
+                                   url: '/1/indexes/' + encodeURIComponent(indexObj.indexName) + '/keys',
+                                   body: aclsObject,
+                                   callback: callback });
+        },
+        /*
+         * Add an existing user key associated to this index
+         *
+         * @param acls the list of ACL for this key. Defined by an array of strings that
+         * can contains the following values:
+         *   - search: allow to search (https and http)
+         *   - addObject: allows to add/update an object in the index (https only)
+         *   - deleteObject : allows to delete an existing object (https only)
+         *   - deleteIndex : allows to delete index content (https only)
+         *   - settings : allows to get index settings (https only)
+         *   - editSettings : allows to change index settings (https only)
+         * @param validity the number of seconds after which the key will be automatically removed (0 means no time limit for this key)
+         * @param maxQueriesPerIPPerHour Specify the maximum number of API calls allowed from an IP address per hour.
+         * @param maxHitsPerQuery Specify the maximum number of hits this API key can retrieve in one call.
+         * @param callback the result callback with two arguments
+         *  success: boolean set to true if the request was successfull
+         *  content: the server answer with user keys list or error description if success is false.
+         */
+        addUserKeyWithValidity: function(acls, validity, maxQueriesPerIPPerHour, maxHitsPerQuery, callback) {
+            var indexObj = this;
+            var aclsObject = {};
+            aclsObject.acl = acls;
+            aclsObject.validity = validity;
+            aclsObject.maxQueriesPerIPPerHour = maxQueriesPerIPPerHour;
+            aclsObject.maxHitsPerQuery = maxHitsPerQuery;
+            this.as._jsonRequest({ method: 'POST',
+                                   url: '/1/indexes/' + encodeURIComponent(indexObj.indexName) + '/keys',
+                                   body: aclsObject,
+                                   callback: callback });
+        },
+        ///
+        /// Internal methods only after this line
+        ///
+        _search: function(params, callback) {
+            this.as._jsonRequest({ cache: this.cache,
+                                   method: 'POST',
+                                   url: '/1/indexes/' + encodeURIComponent(this.indexName) + '/query',
+                                   body: {params: params, apiKey: this.as.apiKey, appID: this.as.applicationID},
+                                   callback: callback });
+        },
+
+        // internal attributes
+        as: null,
+        indexName: null,
+        cache: {},
+        typeAheadArgs: null,
+        typeAheadValueOption: null,
+        emptyConstructor: function() {}
+};
+
+/*
+ * Copyright (c) 2014 Algolia
+ * http://www.algolia.com/
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+(function($) {
+  var self;
+  
+  /**
+   * Algolia Search Helper providing faceting and disjunctive faceting
+   * @param {AlgoliaSearch} client an AlgoliaSearch client
+   * @param {string} index the index name to query
+   * @param {hash} options an associative array defining the hitsPerPage, list of facets and list of disjunctive facets
+   */
+  window.AlgoliaSearchHelper = function(client, index, options) {
+    /// Default options
+    var defaults = {
+      facets: [],            // list of facets to compute
+      disjunctiveFacets: [], // list of disjunctive facets to compute
+      hitsPerPage: 20        // number of hits per page
+    };
+
+    this.init(client, index, $.extend({}, defaults, options));
+    self = this;
+  };
+
+  AlgoliaSearchHelper.prototype = {
+    /**
+     * Initialize a new AlgoliaSearchHelper
+     * @param  {AlgoliaSearch} client an AlgoliaSearch client
+     * @param  {string} index the index name to query
+     * @param  {hash} options an associative array defining the hitsPerPage, list of facets and list of disjunctive facets
+     * @return {AlgoliaSearchHelper}
+     */
+    init: function(client, index, options) {
+      this.client = client;
+      this.index = index;
+      this.options = options;
+      this.page = 0;
+      this.refinements = {};
+      this.disjunctiveRefinements = {};
     },
-    clearIndex: function(callback) {
-        var indexObj = this;
-        this.as._jsonRequest({
-            method: "POST",
-            url: "/1/indexes/" + encodeURIComponent(indexObj.indexName) + "/clear",
-            callback: callback
-        });
+
+    /**
+     * Perform a query
+     * @param  {string} q the user query
+     * @param  {function} searchCallback the result callback called with two arguments:
+     *  success: boolean set to true if the request was successfull
+     *  content: the query answer with an extra 'disjunctiveFacets' attribute
+     */
+    search: function(q, searchCallback) {
+      this.q = q;
+      this.searchCallback = searchCallback;
+      this.page = 0;
+      this.refinements = {};
+      this.disjunctiveRefinements = {};
+      this._search();
     },
-    getSettings: function(callback) {
-        var indexObj = this;
-        this.as._jsonRequest({
-            method: "GET",
-            url: "/1/indexes/" + encodeURIComponent(indexObj.indexName) + "/settings",
-            callback: callback
-        });
+
+    /**
+     * Toggle refinement state of a facet
+     * @param  {string} facet the facet to refine
+     * @param  {string} value the associated value
+     * @return {boolean} true if the facet has been found
+     */
+    toggleRefine: function(facet, value) {
+      for (var i = 0; i < this.options.facets.length; ++i) {
+        if (this.options.facets[i] == facet) {
+          var refinement = facet + ':' + value;
+          this.refinements[refinement] = !this.refinements[refinement];
+          this.page = 0;
+          this._search();
+          return true;
+        }
+      }
+      this.disjunctiveRefinements[facet] = this.disjunctiveRefinements[facet] || {};
+      for (var j = 0; j < this.options.disjunctiveFacets.length; ++j) {
+        if (this.options.disjunctiveFacets[j] == facet) {
+          this.disjunctiveRefinements[facet][value] = !this.disjunctiveRefinements[facet][value];
+          this.page = 0;
+          this._search();
+          return true;
+        }
+      }
+      return false;
     },
-    setSettings: function(settings, callback) {
-        var indexObj = this;
-        this.as._jsonRequest({
-            method: "PUT",
-            url: "/1/indexes/" + encodeURIComponent(indexObj.indexName) + "/settings",
-            body: settings,
-            callback: callback
-        });
+
+    /**
+     * Check the refinement state of a facet
+     * @param  {string}  facet the facet
+     * @param  {string}  value the associated value
+     * @return {boolean} true if refined
+     */
+    isRefined: function(facet, value) {
+      var refinement = facet + ':' + value;
+      if (this.refinements[refinement]) {
+        return true;
+      }
+      if (this.disjunctiveRefinements[facet] && this.disjunctiveRefinements[facet][value]) {
+        return true;
+      }
+      return false;
     },
-    listUserKeys: function(callback) {
-        var indexObj = this;
-        this.as._jsonRequest({
-            method: "GET",
-            url: "/1/indexes/" + encodeURIComponent(indexObj.indexName) + "/keys",
-            callback: callback
-        });
+
+    /**
+     * Go to next page
+     */
+    nextPage: function() {
+      this._gotoPage(this.page + 1);
     },
-    getUserKeyACL: function(key, callback) {
-        var indexObj = this;
-        this.as._jsonRequest({
-            method: "GET",
-            url: "/1/indexes/" + encodeURIComponent(indexObj.indexName) + "/keys/" + key,
-            callback: callback
-        });
+
+    /**
+     * Go to previous page
+     */
+    previousPage: function() {
+      if (this.page > 0) {
+        this._gotoPage(this.page - 1);
+      }
     },
-    deleteUserKey: function(key, callback) {
-        var indexObj = this;
-        this.as._jsonRequest({
-            method: "DELETE",
-            url: "/1/indexes/" + encodeURIComponent(indexObj.indexName) + "/keys/" + key,
-            callback: callback
-        });
+
+    ///////////// PRIVATE
+
+    /**
+     * Goto a page
+     * @param  {integer} page The page number
+     */
+    _gotoPage: function(page) {
+      this.page = page;
+      this._search();
     },
-    addUserKey: function(acls, callback) {
-        var indexObj = this;
-        var aclsObject = {};
-        aclsObject.acl = acls;
-        this.as._jsonRequest({
-            method: "POST",
-            url: "/1/indexes/" + encodeURIComponent(indexObj.indexName) + "/keys",
-            body: aclsObject,
-            callback: callback
-        });
+
+    /**
+     * Perform the underlying queries
+     */
+    _search: function() {
+      this.client.startQueriesBatch();
+      this.client.addQueryInBatch(this.index, this.q, this._getHitsSearchParams());
+      for (var i = 0; i < this.options.disjunctiveFacets.length; ++i) {
+        this.client.addQueryInBatch(this.index, this.q, this._getDisjunctiveFacetSearchParams(this.options.disjunctiveFacets[i]));
+      }
+      this.client.sendQueriesBatch(function(success, content) {
+        if (!success) {
+          self.searchCallback(false, content);
+          return;
+        }
+        var aggregatedAnswer = content.results[0];
+        aggregatedAnswer.disjunctiveFacets = {};
+        for (var i = 1; i < content.results.length; ++i) {
+          for (var facet in content.results[i].facets) {
+            aggregatedAnswer.disjunctiveFacets[facet] = content.results[i].facets[facet];
+            if (self.disjunctiveRefinements[facet]) {
+              for (var value in self.disjunctiveRefinements[facet]) {
+                if (!aggregatedAnswer.disjunctiveFacets[facet][value] && self.disjunctiveRefinements[facet][value]) {
+                  aggregatedAnswer.disjunctiveFacets[facet][value] = 0;
+                }
+              }
+            }
+          }
+        }
+        self.searchCallback(true, aggregatedAnswer);
+      });
     },
-    addUserKeyWithValidity: function(acls, validity, maxQueriesPerIPPerHour, maxHitsPerQuery, callback) {
-        var indexObj = this;
-        var aclsObject = {};
-        aclsObject.acl = acls;
-        aclsObject.validity = validity;
-        aclsObject.maxQueriesPerIPPerHour = maxQueriesPerIPPerHour;
-        aclsObject.maxHitsPerQuery = maxHitsPerQuery;
-        this.as._jsonRequest({
-            method: "POST",
-            url: "/1/indexes/" + encodeURIComponent(indexObj.indexName) + "/keys",
-            body: aclsObject,
-            callback: callback
-        });
-    },
-    _search: function(params, callback) {
-        this.as._jsonRequest({
-            cache: this.cache,
-            method: "POST",
-            url: "/1/indexes/" + encodeURIComponent(this.indexName) + "/query",
-            body: {
-                params: params,
-                apiKey: this.as.apiKey,
-                appID: this.as.applicationID
-            },
-            callback: callback
-        });
-    },
-    as: null,
-    indexName: null,
-    cache: {},
-    typeAheadArgs: null,
-    typeAheadValueOption: null,
-    emptyConstructor: function() {}
-};
+
+    /**
+     * Build search parameters used to fetch hits
+     * @return {hash}
+     */
+    _getHitsSearchParams: function() {
+      return {
+        hitsPerPage: this.options.hitsPerPage,
+        page: this.page,
+        facets: this.options.facets,
+        facetFilters: this._getFacetFilters()
+      };
+    },
+
+    /**
+     * Build search parameters used to fetch a disjunctive facet
+     * @param  {string} facet the associated facet name
+     * @return {hash}
+     */
+    _getDisjunctiveFacetSearchParams: function(facet) {
+      return {
+        hitsPerPage: 1,
+        page: 0,
+        facets: facet,
+        facetFilters: this._getFacetFilters(facet)
+      };
+    },
+
+    /**
+     * Build facetFilters parameter based on current refinements
+     * @param  {string} facet if set, the current disjunctive facet
+     * @return {hash}
+     */
+    _getFacetFilters: function(facet) {
+      var facetFilters = [];
+      for (var refinement in this.refinements) {
+        if (this.refinements[refinement]) {
+          facetFilters.push(refinement);
+        }
+      }
+      for (var disjunctiveRefinement in this.disjunctiveRefinements) {
+        if (disjunctiveRefinement != facet) {
+          var refinements = [];
+          for (var value in this.disjunctiveRefinements[disjunctiveRefinement]) {
+            if (this.disjunctiveRefinements[disjunctiveRefinement][value]) {
+              refinements.push(disjunctiveRefinement + ':' + value);
+            }
+          }
+          if (refinements.length > 0) {
+            facetFilters.push(refinements);
+          }
+        }
+      }
+      return facetFilters;
+    }
+  };
+})(jQuery);