algoliasearch-rails 1.20.1 → 1.20.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 92f616205addc3e9e48ab6a23139233080fc7b97
-  data.tar.gz: cdb287198f237c25d22471c1a8d3d330ec13b210
+  metadata.gz: 4f68b4809609514c72b5c6b9cada34fb133283b5
+  data.tar.gz: 24eca8722672630c450d232b9f73af68505d0972
 SHA512:
-  metadata.gz: 348f1d24568376ccc5f6dc7473ea35237ee240401fa51fa4891d2f52fb1a0f279b21b916c10e0ee468dfbb2d094cd0e369b03187e25c244986e950d043258154
-  data.tar.gz: cacfa47e3db345ebefc78174fc8217e5acb6846ad279c44f926ab41191dd90ddd5b7a807b4cf01d1097e9ea1439e37c3f87c922710b07a781d2e83ad970a400e
+  metadata.gz: dd4c99dd108a20047b9d084c06af3dda1044fafd1b537ab9fbcf5164b0fc2d89c70be7526944159b2b51f121334a8004f2cb4600b721f7c1b7a7e90b88609c6a
+  data.tar.gz: eaa7f323256c42b7cc3d2c0e5188254db900881d52b593342a8d220dbacf767ae1fe08d42af55424b97b119459633a5fe13237de3d95f68c1422b38a15ceeb16

data/Gemfile

@@ -1,7 +1,7 @@
 source "http://rubygems.org"
 
 gem 'json', '~> 1.8', '>= 1.8.6'
-gem 'algoliasearch', '~> 1.14.0'
+gem 'algoliasearch', '~> 1.17.0'
 
 if defined?(RUBY_ENGINE) && RUBY_ENGINE == 'rbx'
   gem 'rubysl', '~> 2.0', :platform => :rbx

data/Gemfile.lock

@@ -39,7 +39,7 @@ GEM
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     addressable (2.4.0)
-    algoliasearch (1.14.0)
+    algoliasearch (1.17.0)
       httpclient (~> 2.8.3)
       json (>= 1.5.1)
     arel (7.1.4)
@@ -175,7 +175,7 @@ PLATFORMS
 DEPENDENCIES
   activerecord-jdbc-adapter
   activerecord-jdbcsqlite3-adapter
-  algoliasearch (~> 1.14.0)
+  algoliasearch (~> 1.17.0)
   jdbc-sqlite3
   json (~> 1.8, >= 1.8.6)
   kaminari
@@ -190,4 +190,4 @@ DEPENDENCIES
   will_paginate (>= 2.3.15)
 
 BUNDLED WITH
-   1.15.3
+   1.16.0

data/README.md

@@ -21,6 +21,7 @@ You can find the full reference on [Algolia's website](https://www.algolia.com/d
 ## Table of Contents
 
 
+
 1. **[Setup](#setup)**
 
     * [Install](#install)
@@ -74,6 +75,9 @@ You can find the full reference on [Algolia's website](https://www.algolia.com/d
 
 
 
+
+
+
 # Setup
 
 
@@ -113,7 +117,7 @@ You can configure a various timeout thresholds by setting the following options
 ```ruby
 AlgoliaSearch.configuration = {
   application_id: 'YourApplicationID',
-  api_key: 'YourAPIKey'
+  api_key: 'YourAPIKey',
   connect_timeout: 2,
   receive_timeout: 30,
   send_timeout: 30,
@@ -124,7 +128,7 @@ AlgoliaSearch.configuration = {
 
 ## Notes
 
-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`.
+This gem makes extensive 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`.
 
 All methods injected by the `AlgoliaSearch` module are prefixed by `algolia_` and aliased to the associated short names if they aren't already defined.
 
@@ -135,6 +139,7 @@ Contact.algolia_search("jon doe") # <=> Contact.search("jon doe")
 ```
 
 
+
 # Usage
 
 
@@ -300,7 +305,7 @@ end
 
 ```ruby
 # dynamical search parameters
-p Contact.raw_search("jon doe", { :hitsPerPage => 5, :page => 2 })
+p Contact.raw_search('jon doe', { hitsPerPage: 5, page: 2 })
 ```
 
 ## Backend Pagination
@@ -375,7 +380,7 @@ end
 ```
 
 ```ruby
-hits = Contact.search("jon doe", { :facets => '*' })
+hits = Contact.search('jon doe', { facets: '*' })
 p hits                    # ORM-compliant array of objects
 p hits.facets             # extra method added to retrieve facets
 p hits.facets['company']  # facet values+count of facet 'company'
@@ -383,7 +388,7 @@ p hits.facets['zip_code'] # facet values+count of facet 'zip_code'
 ```
 
 ```ruby
-raw_json = Contact.raw_search("jon doe", { :facets => '*' })
+raw_json = Contact.raw_search('jon doe', { facets: '*' })
 p raw_json['facets']
 ```
 
@@ -409,7 +414,7 @@ Product.search_for_facet_values('category', 'phone', {
 ## Group by
 
 More info on distinct for grouping can be found
-[here](https://www.algolia.com/doc/guides/search/distinct#distinct-for-grouping).
+[here](https://www.algolia.com/doc/guides/ranking/distinct/).
 
 ```ruby
 class Contact < ActiveRecord::Base
@@ -442,6 +447,7 @@ 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.
 
 
+
 # Options
 
 
@@ -857,6 +863,7 @@ end
 ```
 
 
+
 # Indices
 
 
@@ -893,6 +900,8 @@ Contact.reindex
 
 **Notes**: if you're using an index-specific API key, ensure you're allowing both `<INDEX_NAME>` and `<INDEX_NAME>.tmp`.
 
+**Warning:** You should not use such an atomic reindexing operation while scoping/filtering the model because this operation **replaces the entire index**, keeping the filtered objects only. ie: Don't do `MyModel.where(...).reindex` but do `MyModel.where(...).reindex!` (with the trailing `!`)!!!
+
 ### Regular reindexing
 
 To reindex all your objects in place (without temporary index and therefore without deleting removed objects), use the `reindex!` class method:
@@ -1036,13 +1045,14 @@ Book.search 'foo bar', index: 'Book_by_editor'
 ```
 
 
+
 # Testing
 
 
 
 ## Notes
 
-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.
+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 indices, DO NOT use your production account.
 
 You may want to disable all indexing (add, update & delete operations) API calls, you can set the `disable_indexing` option:
 
@@ -1050,14 +1060,14 @@ You may want to disable all indexing (add, update & delete operations) API calls
 class User < ActiveRecord::Base
   include AlgoliaSearch
 
-  algoliasearch :per_environment => true, :disable_indexing => Rails.env.test? do
+  algoliasearch per_environment: true, disable_indexing: Rails.env.test? do
   end
 end
 
 class User < ActiveRecord::Base
   include AlgoliaSearch
 
-  algoliasearch :per_environment => true, :disable_indexing => Proc.new { Rails.env.test? || more_complex_condition } do
+  algoliasearch per_environment: true, disable_indexing: Proc.new { Rails.env.test? || more_complex_condition } do
   end
 end
 ```
@@ -1086,4 +1096,3 @@ end
 ```
 
 
-

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.14.0"])
+      s.add_runtime_dependency(%q<algoliasearch>, ["~> 1.17.0"])
       s.add_development_dependency(%q<will_paginate>, [">= 2.3.15"])
       s.add_development_dependency(%q<kaminari>, [">= 0"])
       s.add_development_dependency "travis"
@@ -85,11 +85,11 @@ Gem::Specification.new do |s|
       s.add_development_dependency "rdoc"
     else
       s.add_dependency(%q<json>, [">= 1.5.1"])
-      s.add_dependency(%q<algoliasearch>, ["~> 1.14.0"])
+      s.add_dependency(%q<algoliasearch>, ["~> 1.17.0"])
     end
   else
     s.add_dependency(%q<json>, [">= 1.5.1"])
-    s.add_dependency(%q<algoliasearch>, ["~> 1.14.0"])
+    s.add_dependency(%q<algoliasearch>, ["~> 1.17.0"])
   end
 end
 

data/lib/algoliasearch-rails.rb

@@ -745,12 +745,12 @@ module AlgoliaSearch
 
       @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
+      current_settings = @algolia_indexes[settings].get_settings(:getVersion => 1) rescue nil # if the index doesn't exist
 
       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))
+      if !algolia_indexing_disabled?(options) && 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') ||

data/lib/algoliasearch/version.rb

@@ -1,3 +1,3 @@
 module AlgoliaSearch
-  VERSION = '1.20.1'
+  VERSION = '1.20.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algoliasearch-rails
 version: !ruby/object:Gem::Version
-  version: 1.20.1
+  version: 1.20.2
 platform: ruby
 authors:
 - Algolia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-04 00:00:00.000000000 Z
+date: 2017-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.14.0
+        version: 1.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.14.0
+        version: 1.17.0
 - !ruby/object:Gem::Dependency
   name: will_paginate
   requirement: !ruby/object:Gem::Requirement
@@ -183,7 +183,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: AlgoliaSearch integration to your favorite ORM