algoliasearch-rails 1.17.1 → 1.18.0

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 0bb0ed3c6e61faa93d87f73b3486759e93f6d77b
-  data.tar.gz: 80bacfec7eb024e61a72196dde014d0cfdecb45d
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NzJhNzkwMzY2NzdkNDAzOTBmY2EyNDU4N2FmYzJiMDlkMTVhYzE4NA==
+  data.tar.gz: !binary |-
+    ZjBkYjBkOGJiODAwMjM4MzI3YTU4MWEwNGI1NmJlYWM1MzhmNjFiMA==
 SHA512:
-  metadata.gz: 803713e7a76f93c14309150aafef6ad66703d1e200ce887234914ea1301841e4225e0ecd001658efe8a3061d9c0857aa208310bfd04ce73267cabf2a35019c88
-  data.tar.gz: ff9f70b0815494a7847a36a02d1987d18bab009522dc3c86250134412d106f6cee44d7c416a20fed40594fd71b674e009c7001b1d3b7871a82943d045ead4230
+  metadata.gz: !binary |-
+    YmYwYmU4NTcwMmE1YWZmMWZkOTZjODU5MzhlYWExY2U0ZmFlMmQxNDg5MjFk
+    NWY3NmRmMzY5ZTU5MWJjY2Y4ZDgyN2IxM2MxMjc3NzBiZWVkYTFlZTEzYjM4
+    YmMxZWU2MmI3ZmQ1NTRhNmQ1YjJiMWVjYmZmOTFhZmIyOTg3MDM=
+  data.tar.gz: !binary |-
+    YjZhMWQ0YzU0NmQ2YTkwYTYwYzFlNDg1ODdjMjBmMmNiY2RlMmViNTViOGY2
+    NGFkOGQ4Y2QyNzhjZGNkNDJjNDZlYjY3MTAyZGZjYTY4YmNhMzI2YTQzODg4
+    OWE0NjBlZTdiMmJkYjZlNzVkYmM5MzM2YjU0NTcxNzFjYmJiN2U=

data/.travis.yml

@@ -40,6 +40,9 @@ matrix:
   #   env: RAILS_VERSION=5.0
   allow_failures:
   - rvm: rbx-2
+before_install:
+  - gem install bundler
+  - bundle --version
 install: rm -f Gemfile.lock && bundle install
 cache: bundler
 env:

data/ChangeLog

@@ -1,5 +1,9 @@
 CHANGELOG
 
+2017-02-16 1.18.0
+
+      * Add new replica parameter, `inherit` (#198)
+
 2017-01-05 1.17.1
 
       * Add missing `disablePrefixOnAttributes` and `disableTypoToleranceOnAttributes` attributes (#193)

data/Gemfile

@@ -2,7 +2,10 @@ source "http://rubygems.org"
 
 gem 'json', '~> 1.5', '>= 1.5.1'
 gem 'algoliasearch', '~> 1.12.4'
-gem 'rubysl', '~> 2.0', :platform => :rbx
+
+if defined?(RUBY_ENGINE) && RUBY_ENGINE == 'rbx'
+  gem 'rubysl', '~> 2.0', :platform => :rbx
+end
 
 group :test do
   rails_version = ENV["RAILS_VERSION"] ? "~> #{ENV["RAILS_VERSION"]}" : '>= 3.2.0'
@@ -47,5 +50,12 @@ end
 
 group :test, :development do
   gem 'will_paginate', '>= 2.3.15'
-  gem 'kaminari'
+  if defined?(RUBY_VERSION) &&
+     defined?(RUBY_ENGINE) &&
+     RUBY_ENGINE == 'ruby' &&
+     Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2')
+    gem 'kaminari', '< 1'
+  else
+    gem 'kaminari'
+  end
 end

data/README.md

@@ -2,86 +2,76 @@
 
 [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.
+[![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)
+
+
+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.
 
 You might be interested in the sample Ruby on Rails application providing a `autocomplete.js`-based auto-completion and `instantsearch.js`-based instant search results page: [algoliasearch-rails-example](https://github.com/algolia/algoliasearch-rails-example/).
 
-[![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)
 
 
-**Note:** An easier-to-read version of this documentation is available on
-[Algolia's website](https://www.algolia.com/doc/api-client/rails/).
 
-# Table of Contents
+## API Documentation
+
+You can find the full reference on [Algolia's website](https://www.algolia.com/doc/api-client/rails/).
 
 
-**Setup**
+## Table of Contents
 
-1. [Install](#install)
-1. [Configuration](#configuration)
-1. [Timeouts](#timeouts)
-1. [Notes](#notes)
 
-**Usage**
+1. **[Setup](#setup)**
 
-1. [Index Schema](#index-schema)
-1. [Relevancy](#relevancy)
-1. [Indexing](#indexing)
-1. [Frontend Search (realtime experience)](#frontend-search-realtime-experience)
-1. [Backend Search](#backend-search)
-1. [Backend Pagination](#backend-pagination)
-1. [Tags](#tags)
-1. [Faceting](#faceting)
-1. [Faceted search](#faceted-search)
-1. [Group by](#group-by)
-1. [Geo-Search](#geo-search)
+    * [Install](#install)
+    * [Configuration](#configuration)
+    * [Timeouts](#timeouts)
+    * [Notes](#notes)
 
-**Options**
+1. **[Usage](#usage)**
 
-1. [Auto-indexing & asynchronism](#auto-indexing--asynchronism)
-1. [Custom index name](#custom-index-name)
-1. [Per-environment indices](#per-environment-indices)
-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. [Exceptions](#exceptions)
-1. [Configuration example](#configuration-example)
+    * [Index Schema](#index-schema)
+    * [Relevancy](#relevancy)
+    * [Indexing](#indexing)
+    * [Frontend Search (realtime experience)](#frontend-search-realtime-experience)
+    * [Backend Search](#backend-search)
+    * [Backend Pagination](#backend-pagination)
+    * [Tags](#tags)
+    * [Faceting](#faceting)
+    * [Faceted search](#faceted-search)
+    * [Group by](#group-by)
+    * [Geo-Search](#geo-search)
 
-**Indices**
+1. **[Options](#options)**
 
-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)
-1. [Primary/replica](#primaryreplica)
-1. [Share a single index](#share-a-single-index)
-1. [Target multiple indices](#target-multiple-indices)
+    * [Auto-indexing & asynchronism](#auto-indexing--asynchronism)
+    * [Custom index name](#custom-index-name)
+    * [Per-environment indices](#per-environment-indices)
+    * [Custom attribute definition](#custom-attribute-definition)
+    * [Nested objects/relations](#nested-objectsrelations)
+    * [Custom `objectID`](#custom-objectid)
+    * [Restrict indexing to a subset of your data](#restrict-indexing-to-a-subset-of-your-data)
+    * [Sanitizer](#sanitizer)
+    * [UTF-8 Encoding](#utf-8-encoding)
+    * [Exceptions](#exceptions)
+    * [Configuration example](#configuration-example)
 
-**Testing**
+1. **[Indices](#indices)**
 
-1. [Notes](#notes)
+    * [Manual indexing](#manual-indexing)
+    * [Manual removal](#manual-removal)
+    * [Reindexing](#reindexing)
+    * [Clearing an index](#clearing-an-index)
+    * [Using the underlying index](#using-the-underlying-index)
+    * [Primary/replica](#primaryreplica)
+    * [Share a single index](#share-a-single-index)
+    * [Target multiple indices](#target-multiple-indices)
 
+1. **[Testing](#testing)**
 
-# Guides & Tutorials
+    * [Notes](#notes)
 
-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
@@ -922,7 +912,8 @@ index = Contact.index
 
 ## Primary/replica
 
-You can define replica indices using the <code>add_replica</code> method:
+You can define replica indices using the <code>add_replica</code> method.  
+Use `inherit: true` on the replica block if you want it  to inherit from the primary settings.
 
 ```ruby
 class Book < ActiveRecord::Base
@@ -939,7 +930,7 @@ class Book < ActiveRecord::Base
     end
 
     # define a replica index to search by `editor` only
-    add_replica 'Book_by_editor', per_environment: true do
+    add_replica 'Book_by_editor', inherit: true, per_environment: true do
       searchableAttributes [:editor]
     end
   end
@@ -1087,3 +1078,4 @@ end
 ```
 
 
+

data/VERSION

@@ -1 +1 @@
-1.17.1
+1.18.0

data/lib/algoliasearch-rails.rb

@@ -256,13 +256,13 @@ module AlgoliaSearch
     def add_replica(index_name, options = {}, &block)
       raise ArgumentError.new('Cannot specify additional replicas on a replica index') if @options[:slave] || @options[:replica]
       raise ArgumentError.new('No block given') if !block_given?
-      add_index(index_name, options.merge({ :replica => true }), &block)
+      add_index(index_name, options.merge({ :replica => true, :primary_settings => self }), &block)
     end
 
     def add_slave(index_name, options = {}, &block)
       raise ArgumentError.new('Cannot specify additional slaves on a slave index') if @options[:slave] || @options[:replica]
       raise ArgumentError.new('No block given') if !block_given?
-      add_index(index_name, options.merge({ :slave => true }), &block)
+      add_index(index_name, options.merge({ :slave => true, :primary_settings => self }), &block)
     end
 
     def additional_indexes
@@ -308,7 +308,7 @@ module AlgoliaSearch
         begin
           @index.get_settings(*args)
         rescue Algolia::AlgoliaError => e
-          return {} if e.status == 404 # not fatal
+          return {} if e.code == 404 # not fatal
           raise e
         end
       end
@@ -725,22 +725,31 @@ module AlgoliaSearch
 
     def algolia_ensure_init(options = nil, settings = nil, index_settings = nil)
       raise ArgumentError.new('No `algoliasearch` block found in your model.') if algoliasearch_settings.nil?
+
       @algolia_indexes ||= {}
+
       options ||= algoliasearch_options
       settings ||= algoliasearch_settings
+
       return @algolia_indexes[settings] if @algolia_indexes[settings]
+
       @algolia_indexes[settings] = SafeIndex.new(algolia_index_name(options), algoliasearch_options[:raise_on_failure])
+
       current_settings = @algolia_indexes[settings].get_settings rescue nil # if the index doesn't exist
-      if !algolia_indexing_disabled?(options) && (index_settings || algoliasearch_settings_changed?(current_settings, settings.to_settings))
-        index_settings ||= settings.to_settings
+
+      index_settings ||= settings.to_settings
+      index_settings = options[:primary_settings].to_settings.merge(index_settings) if options[:inherit]
+
+      if !algolia_indexing_disabled?(options) && (index_settings || algoliasearch_settings_changed?(current_settings, index_settings))
         used_slaves = !current_settings.nil? && !current_settings['slaves'].nil?
         replicas = index_settings.delete(:replicas) ||
                    index_settings.delete('replicas') ||
                    index_settings.delete(:slaves) ||
                    index_settings.delete('slaves')
-        index_settings[used_slaves ? :slaves : :replicas] = replicas
+        index_settings[used_slaves ? :slaves : :replicas] = replicas unless replicas.nil? || options[:inherit]
         @algolia_indexes[settings].set_settings(index_settings)
       end
+
       @algolia_indexes[settings]
     end
 

metadata

@@ -1,111 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: algoliasearch-rails
 version: !ruby/object:Gem::Version
-  version: 1.17.1
+  version: 1.18.0
 platform: ruby
 authors:
 - Algolia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-01 00:00:00.000000000 Z
+date: 2017-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.5.1
 - !ruby/object:Gem::Dependency
   name: algoliasearch
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.12.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.12.4
 - !ruby/object:Gem::Dependency
   name: will_paginate
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.3.15
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.3.15
 - !ruby/object:Gem::Dependency
   name: kaminari
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: travis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: AlgoliaSearch integration to your favorite ORM
@@ -117,9 +117,9 @@ extra_rdoc_files:
 - LICENSE
 - README.md
 files:
-- ".document"
-- ".rspec"
-- ".travis.yml"
+- .document
+- .rspec
+- .travis.yml
 - ChangeLog
 - Gemfile
 - Gemfile.lock
@@ -173,17 +173,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: AlgoliaSearch integration to your favorite ORM