algoliasearch-rails 1.16.3 → 1.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 52de41878cc41dc76652c65d5756e3a7bd4388ef
-  data.tar.gz: fa59514cb2befd16b72e20fa99a324d17ed90eef
+  metadata.gz: 8cb64784062fdd3807e7188dee376b0a885e96c1
+  data.tar.gz: c96b2d0c53e20bcfe60ffe54a91a2ab5337e2c9f
 SHA512:
-  metadata.gz: 6a63d43c7956d7bed29fe961eeff363f873848c2a6040599ac71764eebf0919b26ddade734b2dcb6992fd862b5e5592dc66286673884a9c7d9d206ae7ed7ba1c
-  data.tar.gz: 59d339a85f0120d75a7392878fbec5dfa02eec4e182c182a1c59168b729d20e0ce658e8c6fad36652a474a13fb58f5922e887feffc85cd0142e2616535589464
+  metadata.gz: d23d7614758097f7b4d564346df34d0ada721b06762dd602389b63836fde982df35b2da6e6bfaa710674f2389e56813b5fa9d498de015c118079d99eba2b33a1
+  data.tar.gz: 0eebeb346a1b02a173edd743489e9414dba113b6c3ee4010e634b96aa207164c0adbe582b1eb647a173d8b1905360f5e9099db00993a65d724ffd119a4c5dee8

data/ChangeLog

@@ -1,5 +1,13 @@
 CHANGELOG
 
+2017-01-05 1.17.0
+
+      * Do not enqueue indexing operations if the indexing is disabled
+      * Add `searchableAttributes` and `numericAttributesForFiltering` index settings
+      * Fixed here and there synchronous behaviors (mostly unit tests related)
+      * Rename `slave` to `replica`
+      * Upgraded `algoliasearch-client-{ruby,js}` deps
+
 2016-11-25 1.16.3
 
       * Propagate `search_facet` to `search_for_facet_values` renaming (backward compatible)

data/Gemfile

@@ -1,7 +1,7 @@
 source "http://rubygems.org"
 
 gem 'json', '~> 1.5', '>= 1.5.1'
-gem 'algoliasearch', '~> 1.12.1'
+gem 'algoliasearch', '~> 1.12.4'
 gem 'rubysl', '~> 2.0', :platform => :rbx
 
 group :test do
@@ -14,9 +14,14 @@ group :test do
     gem 'rack-cache', '< 1.3'
     gem 'mime-types', '< 2.6'
     gem 'net-http-persistent', '< 3.0'
+    gem 'faraday', '< 0.10'
   elsif defined?(RUBY_VERSION) && RUBY_VERSION == "1.9.3"
+    gem 'rack', '< 2'
+    gem 'nokogiri', '< 1.7.0'
     if Gem::Version.new(ENV['RAILS_VERSION'] || '3.2.0') >= Gem::Version.new('4.0')
       gem 'mime-types', '~> 2.6'
+    else
+      gem 'mime-types', '< 3'
     end
   end
   if defined?(RUBY_VERSION) &&

data/Gemfile.lock

@@ -39,7 +39,7 @@ GEM
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     addressable (2.4.0)
-    algoliasearch (1.12.0)
+    algoliasearch (1.12.4)
       httpclient (~> 2.8.2.4)
       json (>= 1.5.1)
     arel (7.1.0)
@@ -372,7 +372,7 @@ PLATFORMS
 DEPENDENCIES
   activerecord-jdbc-adapter
   activerecord-jdbcsqlite3-adapter
-  algoliasearch (~> 1.12.0)
+  algoliasearch (~> 1.12.4)
   jdbc-sqlite3
   json (~> 1.5, >= 1.5.1)
   kaminari
@@ -388,4 +388,4 @@ DEPENDENCIES
   will_paginate (>= 2.3.15)
 
 BUNDLED WITH
-   1.12.5
+   1.13.6

data/README.md

@@ -1,9 +1,6 @@
-<!--NO_HTML-->
+# Algolia Search API Client for Rails
 
-Algolia Search for Rails
-==================
-
-<!--/NO_HTML-->
+[Algolia Search](https://www.algolia.com) is a hosted full-text, numerical, and faceted search engine capable of delivering realtime results from the first keystroke.
 
 This gem let you easily integrate the Algolia Search API to your favorite ORM. It's based on the [algoliasearch-client-ruby](https://github.com/algolia/algoliasearch-client-ruby) gem. Rails 3.x, 4.x and 5.x are all supported.
 
@@ -11,34 +8,89 @@ You might be interested in the sample Ruby on Rails application providing a `aut
 
 [![Build Status](https://travis-ci.org/algolia/algoliasearch-rails.svg?branch=master)](https://travis-ci.org/algolia/algoliasearch-rails) [![Gem Version](https://badge.fury.io/rb/algoliasearch-rails.svg)](http://badge.fury.io/rb/algoliasearch-rails) [![Code Climate](https://codeclimate.com/github/algolia/algoliasearch-rails.svg)](https://codeclimate.com/github/algolia/algoliasearch-rails) ![ActiveRecord](https://img.shields.io/badge/ActiveRecord-yes-blue.svg?style=flat-square) ![Mongoid](https://img.shields.io/badge/Mongoid-yes-blue.svg?style=flat-square) ![Sequel](https://img.shields.io/badge/Sequel-yes-blue.svg?style=flat-square)
 
-<!--NO_HTML-->
 
-Table of Content
-=============
+# Table of Contents
+
+
+**Setup**
 
 1. [Install](#install)
-1. [Setup](#setup)
-1. [Quick Start](#quick-start)
-1. [Options](#options)
-1. [Configuration example](#configuration-example)
+1. [Configuration](#configuration)
+
+**Quick Start**
+
+1. [Schema](#schema)
+1. [Relevancy](#relevancy)
 1. [Indexing](#indexing)
-1. [Master/Slave](#masterslave)
+1. [Frontend Search (realtime experience)](#frontend-search-realtime-experience)
+1. [Backend Search](#backend-search)
+1. [Backend Pagination](#backend-pagination)
+1. [Notes](#notes)
+
+**Options**
+
+1. [Auto-indexing &amp; asynchronism](#auto-indexing--asynchronism)
+1. [Exceptions](#exceptions)
+1. [Custom index name](#custom-index-name)
+1. [Per-environment indexes](#per-environment-indexes)
+1. [Custom attribute definition](#custom-attribute-definition)
+1. [Nested objects/relations](#nested-objectsrelations)
+1. [Custom `objectID`](#custom-objectid)
+1. [Restrict indexing to a subset of your data](#restrict-indexing-to-a-subset-of-your-data)
+1. [Sanitizer](#sanitizer)
+1. [UTF-8 Encoding](#utf-8-encoding)
+1. [Configuration example](#configuration-example)
+
+**Indexing**
+
+1. [Manual indexing](#manual-indexing)
+1. [Manual removal](#manual-removal)
+1. [Reindexing](#reindexing)
+1. [Clearing an index](#clearing-an-index)
+1. [Using the underlying index](#using-the-underlying-index)
+
+**Indexes**
+
+1. [Primary/replica](#primaryreplica)
 1. [Share a single index](#share-a-single-index)
 1. [Target multiple indexes](#target-multiple-indexes)
+
+**Features**
+
 1. [Tags](#tags)
 1. [Search](#search)
 1. [Faceting](#faceting)
 1. [Facet search](#facet-search)
 1. [Group by](#group-by)
-1. [Geo-search](#geo-search)
+1. [Geo-Search](#geo-search)
 1. [Caveats](#caveats)
+1. [Timeouts](#timeouts)
 1. [Note on testing](#note-on-testing)
 
-<!--/NO_HTML-->
 
-## Setup
+# Guides & Tutorials
+
+Check our [online guides](https://www.algolia.com/doc):
+
+* [Data Formatting](https://www.algolia.com/doc/indexing/formatting-your-data)
+* [Import and Synchronize data](https://www.algolia.com/doc/indexing/import-synchronize-data/php)
+* [Autocomplete](https://www.algolia.com/doc/search/auto-complete)
+* [Instant search page](https://www.algolia.com/doc/search/instant-search)
+* [Filtering and Faceting](https://www.algolia.com/doc/search/filtering-faceting)
+* [Sorting](https://www.algolia.com/doc/relevance/sorting)
+* [Ranking Formula](https://www.algolia.com/doc/relevance/ranking)
+* [Typo-Tolerance](https://www.algolia.com/doc/relevance/typo-tolerance)
+* [Geo-Search](https://www.algolia.com/doc/geo-search/geo-search-overview)
+* [Security](https://www.algolia.com/doc/security/best-security-practices)
+* [API-Keys](https://www.algolia.com/doc/security/api-keys)
+* [REST API](https://www.algolia.com/doc/rest)
+
+
+# Setup
 
-### Install
+
+
+## Install
 
 ```sh
 gem install algoliasearch-rails
@@ -56,20 +108,22 @@ And run:
 bundle install
 ```
 
-### Configuration
+## Configuration
 
 Create a new file <code>config/initializers/algoliasearch.rb</code> to setup your <code>APPLICATION_ID</code> and <code>API_KEY</code>.
 
-
 ```ruby
 AlgoliaSearch.configuration = { application_id: 'YourApplicationID', api_key: 'YourAPIKey' }
 ```
 
 The gem is compatible with [ActiveRecord](https://github.com/rails/rails/tree/master/activerecord), [Mongoid](https://github.com/mongoid/mongoid) and [Sequel](https://github.com/jeremyevans/sequel).
 
-## Quick Start
 
-### Schema
+# Quick Start
+
+
+
+## Schema
 
 The following code will create a <code>Contact</code> index and add search capabilities to your <code>Contact</code> model:
 
@@ -112,7 +166,7 @@ class Product < ActiveRecord::Base
 end
 ```
 
-### Relevancy
+## Relevancy
 
 We provide many ways to configure your index allowing you to tune your overall index relevancy. The most important ones are the **searchable attributes** and the attributes reflecting **record popularity**.
 
@@ -124,11 +178,11 @@ class Product < ActiveRecord::Base
     # list of attribute used to build an Algolia record
     attributes :title, :subtitle, :description, :likes_count, :seller_name
 
-    # the attributesToIndex` setting defines the attributes
+    # the `searchableAttributes` (formerly known as attributesToIndex) setting defines the attributes
     # you want to search in: here `title`, `subtitle` & `description`.
     # You need to list them by order of importance. `description` is tagged as
     # `unordered` to avoid taking the position of a match into account in that attribute.
-    attributesToIndex ['title', 'subtitle', 'unordered(description)']
+    searchableAttributes ['title', 'subtitle', 'unordered(description)']
 
     # the `customRanking` setting defines the ranking criteria use to compare two matching
     # records in case their text-relevance is equal. It should reflect your record popularity.
@@ -138,7 +192,7 @@ class Product < ActiveRecord::Base
 end
 ```
 
-### Indexing
+## Indexing
 
 To index a model, simple call `reindex` on the class:
 
@@ -156,11 +210,11 @@ algolia_models = ActiveRecord::Base.descendants.select{ |model| model.respond_to
 algolia_models.each(&:reindex)
 ```
 
-### Frontend Search (realtime experience)
+## Frontend Search (realtime experience)
 
 Traditional search implementations tend to have search logic and functionality on the backend. This made sense when the search experience consisted of a user entering a search query, executing that search, and then being redirected to a search result page.
 
-Implementing search on the backend is no longer necessary. In fact, in most cases it is harmful to performance because of added network and processing latency. We highly recommend the usage of our [JavaScript API Client](https://github.com/algolia/algoliasearch-client-js) issuing all search requests directly from the end user's browser, mobile device, or client. It will reduce the overall search latency while offloading your servers at the same time.
+Implementing search on the backend is no longer necessary. In fact, in most cases it is harmful to performance because of added network and processing latency. We highly recommend the usage of our [JavaScript API Client](https://github.com/algolia/algoliasearch-client-javascript) issuing all search requests directly from the end user's browser, mobile device, or client. It will reduce the overall search latency while offloading your servers at the same time.
 
 The JS API client is part of the gem, just require `algolia/v3/algoliasearch.min` somewhere in your JavaScript manifest, for example in `application.js` if you are using Rails 3.1+:
 
@@ -182,9 +236,9 @@ index.search('something', { hitsPerPage: 10, page: 0 })
   });
 ```
 
-**We recently (March 2015) released a new version (V3) of our JavaScript client, if you were using our previous version (V2), [read the migration guide](https://github.com/algolia/algoliasearch-client-js/wiki/Migration-guide-from-2.x.x-to-3.x.x)**
+**We recently (March 2015) released a new version (V3) of our JavaScript client, if you were using our previous version (V2), [read the migration guide](https://github.com/algolia/algoliasearch-client-javascript/wiki/Migration-guide-from-2.x.x-to-3.x.x)**
 
-### Backend Search
+## Backend Search
 
 If you want to search from your backend you can use the `raw_search` method. It retrieves the raw JSON answer from the API:
 
@@ -198,7 +252,7 @@ You could also use `search` but it's not recommended. This method will fetch the
 p Contact.search("jon doe") # we recommend to use `raw_search` to avoid the database lookup
 ```
 
-### Backend Pagination
+## Backend Pagination
 
 Even if we **highly recommend to perform all search (and therefore pagination) operations from your frontend using JavaScript**, we support both [will_paginate](https://github.com/mislav/will_paginate) and [kaminari](https://github.com/amatsuda/kaminari) as pagination backend.
 
@@ -222,7 +276,7 @@ Then, as soon as you use the `search` method, the returning results will be a pa
 <%= paginate @results %>
 ```
 
-### Notes
+## 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.
 
@@ -232,9 +286,12 @@ Contact.algolia_reindex! # <=> Contact.reindex!
 Contact.algolia_search("jon doe") # <=> Contact.search("jon doe")
 ```
 
-## Options
 
-### Auto-indexing & asynchronism
+# Options
+
+
+
+## Auto-indexing & asynchronism
 
 Each time a record is saved; it will be - asynchronously - indexed. On the other hand, each time a record is destroyed, it will be - asynchronously - removed from the index. That means that a network call with the ADD/DELETE operation is sent **synchronously** to the Algolia API but then the engine will **asynchronously** process the operation (so if you do a search just after, the results may not reflect it yet).
 
@@ -250,7 +307,7 @@ class Contact < ActiveRecord::Base
 end
 ```
 
-#### Temporary disable auto-indexing
+### Temporary disable auto-indexing
 
 You can temporary disable auto-indexing using the <code>without_auto_index</code> scope. This is often used for performance reason.
 
@@ -262,7 +319,7 @@ end
 Contact.reindex! # will use batch operations
 ```
 
-#### Queues & background jobs
+### Queues & background jobs
 
 You can configure the auto-indexing & auto-removal process to use a queue to perform those operations in background. ActiveJob (Rails >=4.2) queues are used by default but you can define your own queuing mechanism:
 
@@ -276,7 +333,7 @@ class Contact < ActiveRecord::Base
 end
 ```
 
-#### Things to Consider
+### Things to Consider
 
 If you are performing updates & deletions in the background then a record deletion can be committed to your database prior
 to the job actually executing. Thus if you were to load the record to remove it from the database than your ActiveRecord#find will fail with a RecordNotFound.
@@ -300,7 +357,7 @@ class MySidekiqWorker
 end
 ```
 
-#### With Sidekiq
+### With Sidekiq
 
 If you're using [Sidekiq](https://github.com/mperham/sidekiq):
 
@@ -325,7 +382,7 @@ class MySidekiqWorker
 end
 ```
 
-#### With DelayedJob
+### With DelayedJob
 
 If you're using [delayed_job](https://github.com/collectiveidea/delayed_job):
 
@@ -348,7 +405,7 @@ end
 
 ```
 
-#### Synchronism & testing
+### Synchronism & testing
 
 You can force indexing and removing to be synchronous (in that case the gem will call the `wait_task` method to ensure the operation has been taken into account once the method returns) by setting the following option: (this is **NOT** recommended, except for testing purpose)
 
@@ -362,7 +419,7 @@ class Contact < ActiveRecord::Base
 end
 ```
 
-### Exceptions
+## Exceptions
 
 You can disable exceptions that could be raised while trying to reach Algolia's API by using the `raise_on_failure` option:
 
@@ -377,7 +434,7 @@ class Contact < ActiveRecord::Base
 end
 ```
 
-### Custom index name
+## Custom index name
 
 By default, the index name will be the class name, e.g. "Contact". You can customize the index name by using the `index_name` option:
 
@@ -391,7 +448,7 @@ class Contact < ActiveRecord::Base
 end
 ```
 
-### Per-environment indexes
+## Per-environment indexes
 
 You can suffix the index name with the current Rails environment using the following option:
 
@@ -405,7 +462,7 @@ class Contact < ActiveRecord::Base
 end
 ```
 
-### Custom attribute definition
+## Custom attribute definition
 
 You can use a block to specify a complex attribute value
 
@@ -446,7 +503,7 @@ class Contact < ActiveRecord::Base
 end
 ```
 
-### Nested objects/relations
+## Nested objects/relations
 
 You can easily embed nested objects defining an extra attribute returning any JSON-compliant object (an array or a hash or a combination of both).
 
@@ -473,7 +530,7 @@ class Profile < ActiveRecord::Base
 end
 ```
 
-### Custom `objectID`
+## Custom `objectID`
 
 By default, the `objectID` is based on your record's `id`. You can change this behavior specifying the `:id` option (be sure to use a uniq field).
 
@@ -486,7 +543,7 @@ class UniqUser < ActiveRecord::Base
 end
 ```
 
-### Restrict indexing to a subset of your data
+## Restrict indexing to a subset of your data
 
 You can add constraints controlling if a record must be indexed by using options the `:if` or `:unless` options.
 
@@ -528,7 +585,6 @@ class Contact < ActiveRecord::Base
 end
 ```
 
-
 You can index a subset of your records using either:
 
 ```ruby
@@ -542,7 +598,7 @@ or
 MyModel.index_objects MyModel.limit(5)
 ```
 
-### Sanitizer
+## Sanitizer
 
 You can sanitize all your attributes using the `sanitize` option. It will strip all HTML tags from your attributes.
 
@@ -563,8 +619,7 @@ If you're using Rails 4.2+, you also need to depend on `rails-html-sanitizer`:
 gem 'rails-html-sanitizer'
 ```
 
-
-### UTF-8 Encoding
+## UTF-8 Encoding
 
 You can force the UTF-8 encoding of all your attributes using the `force_utf8_encoding` option:
 
@@ -581,8 +636,7 @@ end
 
 ***Notes:*** This option is not compatible with Ruby 1.8
 
-
-### Configuration example
+## Configuration example
 
 Here is a real-word configuration example (from [HN Search](https://github.com/algolia/hn-search)):
 
@@ -601,7 +655,7 @@ class Item < ActiveRecord::Base
 
     # `title` is more important than `{story,comment}_text`, `{story,comment}_text` more than `url`, `url` more than `author`
     # btw, do not take into account position in most fields to avoid first word match boost
-    attributesToIndex ['unordered(title)', 'unordered(story_text)', 'unordered(comment_text)', 'unordered(url)', 'author']
+    searchableAttributes ['unordered(title)', 'unordered(story_text)', 'unordered(comment_text)', 'unordered(url)', 'author']
 
     # tags used for filtering
     tags do
@@ -639,9 +693,12 @@ class Item < ActiveRecord::Base
 end
 ```
 
-## Indexing
 
-### Manual indexing
+# Indexing
+
+
+
+## Manual indexing
 
 You can trigger indexing using the <code>index!</code> instance method.
 
@@ -650,7 +707,7 @@ c = Contact.create!(params[:contact])
 c.index!
 ```
 
-### Manual removal
+## Manual removal
 
 And trigger index removing using the <code>remove_from_index!</code> instance method.
 
@@ -659,11 +716,11 @@ c.remove_from_index!
 c.destroy
 ```
 
-### Reindexing
+## Reindexing
 
 The gem provides 2 ways to reindex all your objects:
 
-#### Atomical reindexing
+### Atomical reindexing
 
 To reindex all your records (taking into account the deleted objects), the `reindex` class method indexes all your objects to a temporary index called `<INDEX_NAME>.tmp` and moves the temporary index to the final one once everything is indexed (atomically). This is the safest way to reindex all your content.
 
@@ -673,7 +730,7 @@ Contact.reindex
 
 **Notes**: if you're using an index-specific API key, ensure you're allowing both `<INDEX_NAME>` and `<INDEX_NAME>.tmp`.
 
-#### Regular reindexing
+### Regular reindexing
 
 To reindex all your objects in place (without temporary index and therefore without deleting removed objects), use the `reindex!` class method:
 
@@ -681,7 +738,7 @@ To reindex all your objects in place (without temporary index and therefore with
 Contact.reindex!
 ```
 
-### Clearing an index
+## Clearing an index
 
 To clear an index, use the <code>clear_index!</code> class method:
 
@@ -689,7 +746,7 @@ To clear an index, use the <code>clear_index!</code> class method:
 Contact.clear_index!
 ```
 
-### Using the underlying index
+## Using the underlying index
 
 You can access the underlying `index` object by calling the `index` class method:
 
@@ -698,11 +755,13 @@ index = Contact.index
 # index.get_settings, index.partial_update_object, ...
 ```
 
-## Indexes
 
-### Master/slave
+# Indexes
+
+
+## Primary/replica
 
-You can define slave indexes using the <code>add_slave</code> method:
+You can define replica indices using the <code>add_replica</code> method:
 
 ```ruby
 class Book < ActiveRecord::Base
@@ -711,31 +770,31 @@ class Book < ActiveRecord::Base
   include AlgoliaSearch
 
   algoliasearch per_environment: true do
-    attributesToIndex [:name, :author, :editor]
+    searchableAttributes [:name, :author, :editor]
 
-    # define a slave index to search by `author` only
-    add_slave 'Book_by_author', per_environment: true do
-      attributesToIndex [:author]
+    # define a replica index to search by `author` only
+    add_replica 'Book_by_author', per_environment: true do
+      searchableAttributes [:author]
     end
 
-    # define a slave index to search by `editor` only
-    add_slave 'Book_by_editor', per_environment: true do
-      attributesToIndex [:editor]
+    # define a replica index to search by `editor` only
+    add_replica 'Book_by_editor', per_environment: true do
+      searchableAttributes [:editor]
     end
   end
 
 end
 ```
 
-To search using a slave, use the following code:
+To search using a replica, use the following code:
 
 ```ruby
-Book.raw_search 'foo bar', slave: 'Book_by_editor'
+Book.raw_search 'foo bar', replica: 'Book_by_editor'
 # or
-Book.search 'foo bar', slave: 'Book_by_editor'
+Book.search 'foo bar', replica: 'Book_by_editor'
 ```
 
-### Share a single index
+## Share a single index
 
 It can make sense to share an index between several models. In order to implement that, you'll need to ensure you don't have any conflict with the `objectID` of the underlying models.
 
@@ -773,7 +832,7 @@ end
 
 ***Notes:*** If you target a single index from several models, you must never use `MyModel.reindex` and only use `MyModel.reindex!`. The `reindex` method uses a temporary index to perform an atomic reindexing: if you use it, the resulting index will only contain records for the current model because it will not reindex the others.
 
-### Target multiple indexes
+## Target multiple indexes
 
 You can index a record in several indexes using the <code>add_index</code> method:
 
@@ -788,7 +847,7 @@ class Book < ActiveRecord::Base
 
   # store all books in index 'SECURED_INDEX_NAME'
   algoliasearch index_name: SECURED_INDEX_NAME do
-    attributesToIndex [:name, :author]
+    searchableAttributes [:name, :author]
     # convert security to tags
     tags do
       [released ? 'public' : 'private', premium ? 'premium' : 'standard']
@@ -796,7 +855,7 @@ class Book < ActiveRecord::Base
 
     # store all 'public' (released and not premium) books in index 'PUBLIC_INDEX_NAME'
     add_index PUBLIC_INDEX_NAME, if: :public? do
-      attributesToIndex [:name, :author]
+      searchableAttributes [:name, :author]
     end
   end
 
@@ -816,9 +875,12 @@ Book.raw_search 'foo bar', index: 'Book_by_editor'
 Book.search 'foo bar', index: 'Book_by_editor'
 ```
 
-## Features
 
-### Tags
+# Features
+
+
+
+## Tags
 
 Use the <code>tags</code> method to add tags to your record:
 
@@ -848,12 +910,11 @@ end
 
 At query time, specify <code>{ tagFilters: 'tagvalue' }</code> or <code>{ tagFilters: ['tagvalue1', 'tagvalue2'] }</code> as search parameters to restrict the result set to specific tags.
 
-### Search
+## Search
 
-***Notes:*** We recommend the usage of our [JavaScript API Client](https://github.com/algolia/algoliasearch-client-js) to perform queries directly from the end-user browser without going through your server.
-
-A search returns ORM-compliant objects reloading them from your database. We recommend the usage of our [JavaScript API Client](https://github.com/algolia/algoliasearch-client-js) to perform queries to decrease the overall latency and offload your servers.
+***Notes:*** We recommend the usage of our [JavaScript API Client](https://github.com/algolia/algoliasearch-client-javascript) to perform queries directly from the end-user browser without going through your server.
 
+A search returns ORM-compliant objects reloading them from your database. We recommend the usage of our [JavaScript API Client](https://github.com/algolia/algoliasearch-client-javascript) to perform queries to decrease the overall latency and offload your servers.
 
 ```ruby
 hits =  Contact.search("jon doe")
@@ -893,13 +954,12 @@ class Contact < ActiveRecord::Base
 end
 ```
 
-
 ```ruby
 # dynamical search parameters
 p Contact.raw_search("jon doe", { :hitsPerPage => 5, :page => 2 })
 ```
 
-### Faceting
+## Faceting
 
 Facets can be retrieved calling the extra `facets` method of the search answer.
 
@@ -916,7 +976,6 @@ class Contact < ActiveRecord::Base
 end
 ```
 
-
 ```ruby
 hits = Contact.search("jon doe", { :facets => '*' })
 p hits                    # ORM-compliant array of objects
@@ -925,13 +984,12 @@ p hits.facets['company']  # facet values+count of facet 'company'
 p hits.facets['zip_code'] # facet values+count of facet 'zip_code'
 ```
 
-
 ```ruby
 raw_json = Contact.raw_search("jon doe", { :facets => '*' })
 p raw_json['facets']
 ```
 
-### Facet search
+## Facet search
 
 You can also search for facet values.
 
@@ -950,7 +1008,7 @@ Product.search_for_facet_values('category', 'phone', {
 }) # Array of phone categories linked to red Apple products
 ```
 
-### Group by
+## Group by
 
 More info on distinct for grouping can be found
 [here](https://www.algolia.com/doc/guides/search/distinct#distinct-for-grouping).
@@ -969,7 +1027,7 @@ class Contact < ActiveRecord::Base
 end
 ```
 
-### Geo-Search
+## Geo-Search
 
 Use the <code>geoloc</code> method to localize your record:
 
@@ -985,11 +1043,11 @@ end
 
 At query time, specify <code>{ aroundLatLng: "37.33, -121.89", aroundRadius: 50000 }</code> as search parameters to restrict the result set to 50KM around San Jose.
 
-### Caveats
+## Caveats
 
 This gem makes intensive use of Rails' callbacks to trigger the indexing tasks. If you're using methods bypassing `after_validation`, `before_save` or `after_commit` callbacks, it will not index your changes. For example: `update_attribute` doesn't perform validations checks, to perform validations when updating use `update_attributes`.
 
-### Timeouts
+## Timeouts
 
 You can configure a bunch of timeout threshold by setting the following options at initialization time:
 
@@ -1005,7 +1063,7 @@ AlgoliaSearch.configuration = {
 }
 ```
 
-### Note on testing
+## Note on testing
 
 To run the specs, please set the <code>ALGOLIA_APPLICATION_ID</code> and <code>ALGOLIA_API_KEY</code> environment variables. Since the tests are creating and removing indexes, DO NOT use your production account.
 
@@ -1050,3 +1108,4 @@ describe 'With a mocked client' do
 end
 ```
 
+