algoliasearch-rails 1.11.11 → 1.11.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b7e0beb5d468bb3e779a277b898e76e95f700da7
-  data.tar.gz: fc59247435ee0df6e4048ec44f2126d3d20b1e8b
+  metadata.gz: e8acb586d687a6f969b2bf65d918df3d90928fa2
+  data.tar.gz: 1ecee0a5c9d4397e52e194982ce77e370def3452
 SHA512:
-  metadata.gz: 0c3007273908b5b1f2709dc11e2de88f315629dae96de6d34a6979ec3ca56bc9d5f65c1f2f696709621c278b1d8cae287c796c9b00f25667af3d321fa1f3d703
-  data.tar.gz: 3a1d3bd7077e9d34299bf6f1ae740d0f57dd8d3c1c1addb52172b4bc4781eb953ff2dc2881d10c461d38fd478d2bfb4f9f4aaab98965d67d978356f726cf39b9
+  metadata.gz: c6c787e1009b2ad28c6cd2098c32c629bb74602ee18b4646b6f8625c23b51d448227aee631ca27b205e292f9ee26feb7f971a93492bfca6805fff528085da116
+  data.tar.gz: 0bb8c9eba4902b3ac0a11ab9aaa0660a2daf45b547ff9fc5d1287f31c9aa3adf5c051dcc0588a63da223cccb695abe792cbf82cc2271be98da5151c8b61acf01

data/ChangeLog

@@ -1,5 +1,9 @@
 CHANGELOG
 
+2015-01-29 1.11.12
+
+      * Fixed potential namespace issue while trying to load the HTML sanitizer
+
 2014-11-27 1.11.11
 
       * Upgraded algoliasearch JavaScript client to 2.7.5 to prepare TLD migration

data/README.md

@@ -1,13 +1,12 @@
 Algolia Search for Rails
 ==================
 
-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.
+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. Both Rails 3.x and Rails 4.x are supported.
 
 You might be interested in the sample Ruby on Rails application providing a ```typeahead.js```-based auto-completion and ```Google```-like instant search: [algoliasearch-rails-example](https://github.com/algolia/algoliasearch-rails-example/).
 
 [![Build Status](https://travis-ci.org/algolia/algoliasearch-rails.png?branch=master)](https://travis-ci.org/algolia/algoliasearch-rails) [![Gem Version](https://badge.fury.io/rb/algoliasearch-rails.png)](http://badge.fury.io/rb/algoliasearch-rails) [![Code Climate](https://codeclimate.com/github/algolia/algoliasearch-rails.png)](https://codeclimate.com/github/algolia/algoliasearch-rails)
 
-
 Table of Content
 -------------
 **Get started**
@@ -35,7 +34,7 @@ Install
 gem install algoliasearch-rails
 ```
 
-If you are using Rails 3, add the gem to your <code>Gemfile</code>:
+Add the gem to your <code>Gemfile</code>:
 
 ```ruby
 gem "algoliasearch-rails"
@@ -163,7 +162,7 @@ You can temporary disable auto-indexing using the <code>without_auto_index</code
 ```ruby
 Contact.delete_all
 Contact.without_auto_index do
-  1.upto(10000) { Contact.create! attributes } # inside the block, auto indexing task will noop
+  1.upto(10000) { Contact.create! attributes } # inside this block, auto indexing task will not run.
 end
 Contact.reindex! # will use batch operations
 ```
@@ -182,7 +181,7 @@ end
 
 #### Custom index name
 
-You can force the index name using the following option:
+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:
 
 ```ruby
 class Contact < ActiveRecord::Base
@@ -249,6 +248,32 @@ class Contact < ActiveRecord::Base
 end
 ```
 
+#### 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).
+
+```ruby
+class Profile < ActiveRecord::Base
+  include AlgoliaSearch
+
+  belongs_to :user
+  has_many :specializations
+
+  algoliasearch do
+    attribute :user do
+      # restrict the nested "user" object to its `name` + `email`
+      { name: user.name, email: user.email }
+    end
+    attribute :public_specializations do
+      # build an array of public specialization (include only `title` and `another_attr`)
+      specializations.select { |s| s.public? }.map do |s|
+        { title: s.title, another_attr: s.another_attr }
+      end
+    end
+  end
+
+end
+```
 
 #### Custom ```objectID```
 
@@ -332,6 +357,13 @@ end
 
 ```
 
+If you're using Rails 4.2+, you also need to depend on `rails-html-sanitizer`:
+
+```ruby
+gem 'rails-html-sanitizer'
+```
+
+
 #### UTF-8 Encoding
 
 You can force the UTF-8 encoding of all your attributes using the ```force_utf8_encoding``` option:

data/VERSION

@@ -1 +1 @@
-1.11.11
+1.11.12

data/lib/algoliasearch-rails.rb

@@ -103,7 +103,12 @@ module AlgoliaSearch
       end
 
       if @options[:sanitize]
-        sanitizer = HTML::FullSanitizer.new
+        sanitizer = begin
+          ::HTML::FullSanitizer.new
+        rescue NameError
+          # from rails 4.2
+          ::Rails::Html::FullSanitizer.new
+        end
         attributes = sanitize_attributes(attributes, sanitizer)
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algoliasearch-rails
 version: !ruby/object:Gem::Version
-  version: 1.11.11
+  version: 1.11.12
 platform: ruby
 authors:
 - Algolia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-27 00:00:00.000000000 Z
+date: 2015-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json