algoliasearch-rails 1.16.3 → 1.17.0

data/VERSION

@@ -1 +1 @@
-1.16.3
+1.17.0

data/algoliasearch-rails.gemspec

@@ -77,7 +77,7 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<json>, [">= 1.5.1"])
-      s.add_runtime_dependency(%q<algoliasearch>, ["~> 1.12.1"])
+      s.add_runtime_dependency(%q<algoliasearch>, ["~> 1.12.4"])
       s.add_development_dependency(%q<will_paginate>, [">= 2.3.15"])
       s.add_development_dependency(%q<kaminari>, [">= 0"])
       s.add_development_dependency "travis"

data/lib/algoliasearch-rails.rb

@@ -30,6 +30,7 @@ module AlgoliaSearch
   class NotConfigured < StandardError; end
   class BadConfiguration < StandardError; end
   class NoBlockGiven < StandardError; end
+  class MixedSlavesAndReplicas < StandardError; end
 
   autoload :Configuration, 'algoliasearch/configuration'
   extend Configuration
@@ -57,13 +58,13 @@ module AlgoliaSearch
     # AlgoliaSearch settings
     OPTIONS = [:minWordSizefor1Typo, :minWordSizefor2Typos, :typoTolerance,
       :hitsPerPage, :attributesToRetrieve,
-      :attributesToHighlight, :attributesToSnippet, :attributesToIndex,
+      :attributesToHighlight, :attributesToSnippet, :attributesToIndex, :searchableAttributes,
       :highlightPreTag, :highlightPostTag,
       :ranking, :customRanking, :queryType, :attributesForFaceting,
       :separatorsToIndex, :optionalWords, :attributeForDistinct,
       :synonyms, :placeholders, :removeWordsIfNoResults, :replaceSynonymsInHighlight,
       :unretrievableAttributes, :disableTypoToleranceOnWords, :disableTypoToleranceOnAttributes, :altCorrections,
-      :ignorePlurals, :maxValuesPerFacet, :distinct, :numericAttributesToIndex,
+      :ignorePlurals, :maxValuesPerFacet, :distinct, :numericAttributesToIndex, :numericAttributesForFiltering,
       :allowTyposOnNumericTokens, :allowCompressionOfIntegerArray,
       :advancedSyntax]
     OPTIONS.each do |k|
@@ -79,7 +80,7 @@ module AlgoliaSearch
 
     def attribute(*names, &block)
       raise ArgumentError.new('Cannot pass multiple attribute names if block given') if block_given? and names.length > 1
-      raise ArgumentError.new('Cannot specify additional attributes on a slave index') if @options[:slave]
+      raise ArgumentError.new('Cannot specify additional attributes on a replica index') if @options[:slave] || @options[:replica]
       @attributes ||= {}
       names.flatten.each do |name|
         @attributes[name.to_s] = block_given? ? Proc.new { |o| o.instance_eval(&block) } : Proc.new { |o| o.send(name) }
@@ -89,7 +90,7 @@ module AlgoliaSearch
 
     def add_attribute(*names, &block)
       raise ArgumentError.new('Cannot pass multiple attribute names if block given') if block_given? and names.length > 1
-      raise ArgumentError.new('Cannot specify additional attributes on a slave index') if @options[:slave]
+      raise ArgumentError.new('Cannot specify additional attributes on a replica index') if @options[:slave] || @options[:replica]
       @additional_attributes ||= {}
       names.each do |name|
         @additional_attributes[name.to_s] = block_given? ? Proc.new { |o| o.instance_eval(&block) } : Proc.new { |o| o.send(name) }
@@ -201,14 +202,14 @@ module AlgoliaSearch
     end
 
     def geoloc(lat_attr, lng_attr)
-      raise ArgumentError.new('Cannot specify additional attributes on a slave index') if @options[:slave]
+      raise ArgumentError.new('Cannot specify additional attributes on a replica index') if @options[:slave] || @options[:replica]
       add_attribute :_geoloc do |o|
         { :lat => o.send(lat_attr).to_f, :lng => o.send(lng_attr).to_f }
       end
     end
 
     def tags(*args, &block)
-      raise ArgumentError.new('Cannot specify additional attributes on a slave index') if @options[:slave]
+      raise ArgumentError.new('Cannot specify additional attributes on a replica index') if @options[:slave] || @options[:replica]
       add_attribute :_tags do |o|
         v = block_given? ? o.instance_eval(&block) : args
         v.is_a?(Array) ? v : [v]
@@ -225,25 +226,41 @@ module AlgoliaSearch
         v = get_setting(k)
         settings[k] = v if !v.nil?
       end
-      settings[:slaves] = additional_indexes.select { |options, s| options[:slave] }.map do |options, s|
-        name = options[:index_name]
-        name = "#{name}_#{Rails.env.to_s}" if options[:per_environment]
-        name
-      end if !@options[:slave]
+      if !@options[:slave] && !@options[:replica]
+        settings[:slaves] = additional_indexes.select { |opts, s| opts[:slave] }.map do |opts, s|
+          name = opts[:index_name]
+          name = "#{name}_#{Rails.env.to_s}" if opts[:per_environment]
+          name
+        end
+        settings.delete(:slaves) if settings[:slaves].empty?
+        settings[:replicas] = additional_indexes.select { |opts, s| opts[:replica] }.map do |opts, s|
+          name = opts[:index_name]
+          name = "#{name}_#{Rails.env.to_s}" if opts[:per_environment]
+          name
+        end
+        settings.delete(:replicas) if settings[:replicas].empty?
+      end
       settings
     end
 
     def add_index(index_name, options = {}, &block)
-      raise ArgumentError.new('Cannot specify additional index on a slave index') if @options[:slave]
+      raise ArgumentError.new('Cannot specify additional index on a replica index') if @options[:slave] || @options[:replica]
       raise ArgumentError.new('No block given') if !block_given?
       raise ArgumentError.new('Options auto_index and auto_remove cannot be set on nested indexes') if options[:auto_index] || options[:auto_remove]
-      options[:index_name] = index_name
       @additional_indexes ||= {}
+      raise MixedSlavesAndReplicas.new('Cannot mix slaves and replicas in the same configuration (add_slave is deprecated)') if (options[:slave] && @additional_indexes.any? { |opts, _| opts[:replica] }) || (options[:replica] && @additional_indexes.any? { |opts, _| opts[:slave] })
+      options[:index_name] = index_name
       @additional_indexes[options] = IndexSettings.new(options, Proc.new)
     end
 
+    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)
+    end
+
     def add_slave(index_name, options = {}, &block)
-      raise ArgumentError.new('Cannot specify additional slaves on a slave index') if @options[:slave]
+      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)
     end
@@ -287,7 +304,7 @@ module AlgoliaSearch
 
     # special handling of get_settings to avoid raising errors on 404
     def get_settings(*args)
-      SafeIndex.log_or_throw(:move_index) do
+      SafeIndex.log_or_throw(:get_settings) do
         begin
           @index.get_settings(*args)
         rescue Algolia::AlgoliaError => e
@@ -452,7 +469,7 @@ module AlgoliaSearch
       algolia_configurations.each do |options, settings|
         next if algolia_indexing_disabled?(options)
         index = algolia_ensure_init(options, settings)
-        next if options[:slave]
+        next if options[:slave] || options[:replica]
         last_task = nil
 
         algolia_find_in_batches(batch_size) do |group|
@@ -472,7 +489,7 @@ module AlgoliaSearch
           end
           last_task = index.save_objects(objects)
         end
-        index.wait_task(last_task["taskID"]) if last_task and synchronous == true
+        index.wait_task(last_task["taskID"]) if last_task and (synchronous || options[:synchronous])
       end
       nil
     end
@@ -482,16 +499,18 @@ module AlgoliaSearch
       return if @algolia_without_auto_index_scope
       algolia_configurations.each do |options, settings|
         next if algolia_indexing_disabled?(options)
-        next if options[:slave]
+        next if options[:slave] || options[:replica]
 
         # fetch the master settings
         master_index = algolia_ensure_init(options, settings)
         master_settings = master_index.get_settings rescue {} # if master doesn't exist yet
         master_settings.merge!(JSON.parse(settings.to_settings.to_json)) # convert symbols to strings
 
-        # remove the slaves of the temporary index
+        # remove the replicas of the temporary index
         master_settings.delete :slaves
         master_settings.delete 'slaves'
+        master_settings.delete :replicas
+        master_settings.delete 'replicas'
 
         # init temporary index
         index_name = algolia_index_name(options)
@@ -510,7 +529,7 @@ module AlgoliaSearch
         end
 
         move_task = SafeIndex.move_index(tmp_index.name, index_name)
-        tmp_index.wait_task(move_task["taskID"]) if synchronous == true
+        master_index.wait_task(move_task["taskID"]) if synchronous || options[:synchronous]
       end
       nil
     end
@@ -519,9 +538,9 @@ module AlgoliaSearch
       algolia_configurations.each do |options, settings|
         next if algolia_indexing_disabled?(options)
         index = algolia_ensure_init(options, settings)
-        next if options[:slave]
+        next if options[:slave] || options[:replica]
         task = index.save_objects(objects.map { |o| settings.get_attributes(o).merge 'objectID' => algolia_object_id_of(o, options) })
-        index.wait_task(task["taskID"]) if synchronous == true
+        index.wait_task(task["taskID"]) if synchronous || options[:synchronous]
       end
     end
 
@@ -531,17 +550,17 @@ module AlgoliaSearch
         next if algolia_indexing_disabled?(options)
         object_id = algolia_object_id_of(object, options)
         index = algolia_ensure_init(options, settings)
-        next if options[:slave]
+        next if options[:slave] || options[:replica]
         if algolia_indexable?(object, options)
           raise ArgumentError.new("Cannot index a record with a blank objectID") if object_id.blank?
-          if synchronous
+          if synchronous || options[:synchronous]
             index.add_object!(settings.get_attributes(object), object_id)
           else
             index.add_object(settings.get_attributes(object), object_id)
           end
         elsif algolia_conditional_index?(options) && !object_id.blank?
           # remove non-indexable objects
-          if synchronous
+          if synchronous || options[:synchronous]
             index.delete_object!(object_id)
           else
             index.delete_object(object_id)
@@ -558,8 +577,8 @@ module AlgoliaSearch
       algolia_configurations.each do |options, settings|
         next if algolia_indexing_disabled?(options)
         index = algolia_ensure_init(options, settings)
-        next if options[:slave]
-        if synchronous
+        next if options[:slave] || options[:replica]
+        if synchronous || options[:synchronous]
           index.delete_object!(object_id)
         else
           index.delete_object(object_id)
@@ -572,15 +591,20 @@ module AlgoliaSearch
       algolia_configurations.each do |options, settings|
         next if algolia_indexing_disabled?(options)
         index = algolia_ensure_init(options, settings)
-        next if options[:slave]
-        synchronous ? index.clear! : index.clear
+        next if options[:slave] || options[:replica]
+        synchronous || options[:synchronous] ? index.clear! : index.clear
         @algolia_indexes[settings] = nil
       end
       nil
     end
 
     def algolia_raw_search(q, params = {})
-      index_name = params.delete(:index) || params.delete('index') || params.delete(:slave) || params.delete('slave')
+      index_name = params.delete(:index) ||
+                   params.delete('index') ||
+                   params.delete(:slave) ||
+                   params.delete('slave') ||
+                   params.delete(:replica) ||
+                   params.delete('replica')
       index = algolia_index(index_name)
       index.search(q, Hash[params.map { |k,v| [k.to_s, v.to_s] }])
     end
@@ -641,7 +665,12 @@ module AlgoliaSearch
     end
 
     def algolia_search_for_facet_values(facet, text, params = {})
-      index_name = params.delete(:index) || params.delete('index') || params.delete(:slave) || params.delete('slave')
+      index_name = params.delete(:index) ||
+                   params.delete('index') ||
+                   params.delete(:slave) ||
+                   params.delete('slave') ||
+                   params.delete(:replica) ||
+                   params.delete('replicas')
       index = algolia_index(index_name)
       query = Hash[params.map { |k, v| [k.to_s, v.to_s] }]
       index.search_facet(facet, text, query)['facetHits']
@@ -655,7 +684,7 @@ module AlgoliaSearch
         algolia_configurations.each do |o, s|
           return algolia_ensure_init(o, s) if o[:index_name].to_s == name.to_s
         end
-        raise ArgumentError.new("Invalid index/slave name: #{name}")
+        raise ArgumentError.new("Invalid index/replica name: #{name}")
       end
       algolia_ensure_init
     end
@@ -669,7 +698,7 @@ module AlgoliaSearch
 
     def algolia_must_reindex?(object)
       algolia_configurations.each do |options, settings|
-        next if options[:slave]
+        next if options[:slave] || options[:replica]
         return true if algolia_object_id_changed?(object, options)
         settings.get_attribute_names(object).each do |k|
           changed_method = "#{k}_changed?"
@@ -682,6 +711,10 @@ module AlgoliaSearch
             changed_method = "#{condition}_changed?"
             return true if !object.respond_to?(changed_method) || object.send(changed_method)
           else
+            # if the :if, :unless condition is a anything else,
+            # we have no idea whether we should reindex or not
+            # let's always reindex then
+            return true
           end
         end
       end
@@ -700,6 +733,12 @@ module AlgoliaSearch
       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
+        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
         @algolia_indexes[settings].set_settings(index_settings)
       end
       @algolia_indexes[settings]
@@ -851,15 +890,15 @@ module AlgoliaSearch
 
     def algolia_enqueue_remove_from_index!(synchronous)
       if algoliasearch_options[:enqueue]
-        algoliasearch_options[:enqueue].call(self, true)
+        algoliasearch_options[:enqueue].call(self, true) unless self.class.send(:algolia_indexing_disabled?, algoliasearch_options)
       else
-        algolia_remove_from_index!(synchronous)
+        algolia_remove_from_index!(synchronous || algolia_synchronous?)
       end
     end
 
     def algolia_enqueue_index!(synchronous)
       if algoliasearch_options[:enqueue]
-        algoliasearch_options[:enqueue].call(self, false)
+        algoliasearch_options[:enqueue].call(self, false) unless self.class.send(:algolia_indexing_disabled?, algoliasearch_options)
       else
         algolia_index!(synchronous)
       end

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 require 'rubygems'
 require 'bundler'
+require 'timeout'
 
 Bundler.setup :test
 
@@ -19,6 +20,12 @@ RSpec.configure do |c|
   c.filter_run :focus => true
   c.run_all_when_everything_filtered = true
   c.formatter = 'documentation'
+
+  c.around(:each) do |example|
+    Timeout::timeout(120) {
+      example.run
+    }
+  end
 end
 
 # avoid concurrent access to the same index

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

@@ -21,7 +21,7 @@
  * THE SOFTWARE.
  */
 
-var ALGOLIA_VERSION = '2.9.4';
+var ALGOLIA_VERSION = '2.9.7';
 
 /*
  * Copyright (c) 2013 Algolia
@@ -106,9 +106,9 @@ var AlgoliaSearch = function(applicationID, apiKey, methodOrOptions, resolveDNS,
   // If hosts is undefined, initialize it with applicationID
   if (this._isUndefined(hosts)) {
     hosts = [
-      this.applicationID + '-1.algolia.' + tld,
-      this.applicationID + '-2.algolia.' + tld,
-      this.applicationID + '-3.algolia.' + tld
+      this.applicationID + '-1.algolianet.com',
+      this.applicationID + '-2.algolianet.com',
+      this.applicationID + '-3.algolianet.com'
     ];
   }
   // detect is we use http or https
@@ -118,16 +118,10 @@ var AlgoliaSearch = function(applicationID, apiKey, methodOrOptions, resolveDNS,
   } else if (method === 'https' || method === 'HTTPS') {
     this.host_protocol = 'https://';
   }
-  // Add hosts in random order
+  // Add protocol to hosts
   for (var i = 0; i < hosts.length; ++i) {
-    if (Math.random() > 0.5) {
-      this.hosts.reverse();
-    }
     this.hosts.push(this.host_protocol + hosts[i]);
   }
-  if (Math.random() > 0.5) {
-    this.hosts.reverse();
-  }
   // then add Distributed Search Network host if there is one
   if (this.dsn || this.dsnHost != null) {
     if (this.dsnHost) {
@@ -143,6 +137,8 @@ var AlgoliaSearch = function(applicationID, apiKey, methodOrOptions, resolveDNS,
       self.options.angular.$http = $http;
     }]);
   }
+
+  this._ua = this.options._ua || 'Algolia for vanilla JavaScript ' + window.ALGOLIA_VERSION;
 };
 
 // This holds the number of JSONP requests done accross clients
@@ -595,6 +591,7 @@ AlgoliaSearch.prototype = {
 
     opts.successiveRetryCount = 0;
     var impl = function() {
+
       if (opts.successiveRetryCount >= self.hosts.length) {
         var error = { message: 'Cannot connect the Algolia\'s Search API. Please send an email to support@algolia.com to report the issue.' };
         if (!self._isUndefined(callback) && callback) {
@@ -665,6 +662,7 @@ AlgoliaSearch.prototype = {
     if (this.tagFilters) {
       url += '&X-Algolia-TagFilters=' + encodeURIComponent(this.tagFilters);
     }
+    url += '&X-Algolia-Agent=' + encodeURIComponent(this._ua);
     for (var i = 0; i < this.extraHeaders.length; ++i) {
       url += '&' + this.extraHeaders[i].key + '=' + this.extraHeaders[i].value;
     }
@@ -711,6 +709,7 @@ AlgoliaSearch.prototype = {
     if (this.tagFilters) {
       url += '&X-Algolia-TagFilters=' + encodeURIComponent(this.tagFilters);
     }
+    url += '&X-Algolia-Agent=' + encodeURIComponent(this._ua);
     for (var i = 0; i < this.extraHeaders.length; ++i) {
       url += '&' + this.extraHeaders[i].key + '=' + this.extraHeaders[i].value;
     }
@@ -786,6 +785,8 @@ AlgoliaSearch.prototype = {
       url += '&X-Algolia-UserToken=' + encodeURIComponent(this.userToken);
     }
 
+    url += '&X-Algolia-Agent=' + encodeURIComponent(this._ua);
+
     for (var i = 0; i < this.extraHeaders.length; ++i) {
       url += '&' + this.extraHeaders[i].key + '=' + this.extraHeaders[i].value;
     }
@@ -799,7 +800,7 @@ AlgoliaSearch.prototype = {
       clean();
 
       opts.callback(true, false, { 'message': 'Timeout - Failed to load JSONP script.' });
-    }, this.requestTimeoutInMs);
+    }, this.requestTimeoutInMs * (opts.successiveRetryCount + 1));
 
     success = function() {
       if (done || timedOut) {
@@ -896,6 +897,8 @@ AlgoliaSearch.prototype = {
       url += '&X-Algolia-TagFilters=' + encodeURIComponent(this.tagFilters);
     }
 
+    url += '&X-Algolia-Agent=' + encodeURIComponent(this._ua);
+
     for (var i = 0; i < this.extraHeaders.length; ++i) {
       url += '&' + this.extraHeaders[i].key + '=' + this.extraHeaders[i].value;
     }
@@ -958,6 +961,13 @@ AlgoliaSearch.prototype = {
       opts.callback(retry, success, response);
     };
 
+    // we set an empty onprogress listener
+    // so that XDomainRequest on IE9 is not aborted
+    // refs:
+    //  - https://github.com/algolia/algoliasearch-client-js/issues/76
+    //  - https://social.msdn.microsoft.com/Forums/ie/en-US/30ef3add-767c-4436-b8a9-f1ca19b4812e/ie9-rtm-xdomainrequest-issued-requests-may-abort-if-all-event-handlers-not-specified?forum=iewebdevelopment
+    request.onprogress = function noop() {};
+
     if (this._support.timeout) {
       // .timeout supported by both XHR and XDR,
       // we do receive timeout event, tested
@@ -2661,6 +2671,7 @@ angular.module('algoliasearch', [])
         options.angular = {
           '$injector': $injector
         };
+        options._ua = 'Algolia for AngularJS ' + window.ALGOLIA_VERSION;
         return new AlgoliaSearch(applicationID, apiKey, options);
       }
     };