algoliasearch-rails 1.25.0 → 2.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71ddc460401250164dd2422b959edbb444a99bec59ba34fc26facf7b2783b141
-  data.tar.gz: 4500a5845bafdbc8794d1538056f1c59a7ced17cd49e7c80fa827507d155c532
+  metadata.gz: a93eb9160dcd68998d5f05a33a788a8737888c07d14c3e9fa1d3e36c758b6117
+  data.tar.gz: b397ac486ee7514abd0612bf80f28d37c09299441e1aeb5cf363a9c48d627fd7
 SHA512:
-  metadata.gz: 7e7512b284a7f61ff4a04f12e7979d632b04a208781b28f2b3690edc75da5b099c83a77205ca0f9ac7298a20e3b7674260b5d2fd1c9471498df95d1ac82be858
-  data.tar.gz: 51a2e7381403a45f0bdd2f587bdeffe30d375853eeae767a07385ca4ae0bab0c612f1d7b79b143460f5982be9d05bea85c636740b4f2141291155cc241a117bf
+  metadata.gz: f6b148d577533959db2df41f33169ad9df554287a771057fa5a980e8804ac40282cee2e49f50342de89d08806890766e88f06b94ea7a456496cc637cbdbc4a4a
+  data.tar.gz: 5dcea86a0adfbbef31067f679116873b2e30317950eac88dd9a6e9f9100ccfea1190d630ddd34cbca88d9c05ffa8b01e27550c5e371c0816a12461ccef97fac2

data/CHANGELOG.MD

@@ -1,6 +1,39 @@
 # CHANGELOG
 
-## [Unreleased](https://github.com/algolia/algoliasearch-rails/compare/1.25.0...master)
+## [Unreleased](https://github.com/algolia/algoliasearch-rails/compare/2.1.4...master)
+
+## [2.1.4](https://github.com/algolia/algoliasearch-rails/compare/2.1.4...2.1.3)
+### Fixed
+- File formatting [`#414`](https://github.com/algolia/algoliasearch-rails/pull/414)
+- Document supported Rails versions [`#407`](https://github.com/algolia/algoliasearch-rails/pull/407)
+- Fixed error when using `:check_settings => false` [`#413`](https://github.com/algolia/algoliasearch-rails/pull/413)
+
+### Removed
+- Old references to TravisCI [`#408`](https://github.com/algolia/algoliasearch-rails/pull/408)
+
+## [2.1.3](https://github.com/algolia/algoliasearch-rails/compare/2.1.3...2.1.2)
+### Fixed
+- Prevent an extra get_settings call even if `check_settings` is false [`#367`](https://github.com/algolia/algoliasearch-rails/pull/367)
+
+## [2.1.2](https://github.com/algolia/algoliasearch-rails/compare/2.1.2...2.1.1)
+### Fixed
+- Error with keys that got symbolized by default [`#403`](https://github.com/algolia/algoliasearch-rails/pull/403)
+
+## [2.1.1](https://github.com/algolia/algoliasearch-rails/compare/2.1.1...2.1.0)
+### Fixed
+- Error with Ruby 3 in regards to default splat behavior [`#400`](https://github.com/algolia/algoliasearch-rails/pull/400)
+
+## [2.1.0](https://github.com/algolia/algoliasearch-rails/compare/2.1.0...2.0.0)
+### Added
+- Add support for [virtual replicas](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/#what-are-virtual-replicas) ([#386](https://github.com/algolia/algoliasearch-rails/pull/386))
+
+
+## [2.0.0](https://github.com/algolia/algoliasearch-rails/compare/2.0.0...1.25.0)
+
+### Breaking changes
+- Adds support for `algolia` gem.
+- Drops support for Ruby < 2.4
+- Drops support for Rails < 5.1
 
 ## [1.25.0](https://github.com/algolia/algoliasearch-rails/compare/1.24.1...1.25.0) (2020-11-24)
 

data/Gemfile

@@ -1,41 +1,22 @@
 source "http://rubygems.org"
 
-gem 'json', '~> 1.8', '>= 1.8.6'
-gem 'algoliasearch', '>= 1.26.0', '< 2.0.0'
+gem 'json', '>= 1.5.1'
+gem 'algolia', '< 3.0.0'
 
 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'
-  gem 'rails', rails_version
+  rails_version = ENV["RAILS_VERSION"] || '6.1'
+  gem 'rails', "~> #{rails_version}"
   gem 'active_model_serializers'
-  if defined?(RUBY_VERSION) && RUBY_VERSION == "1.8.7"
-    gem 'i18n', '< 0.7'
-    gem 'highline', '< 1.7'
-    gem 'addressable', '<= 2.2.7'
-    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 'rack-cache', '<= 1.7.1'
-    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) &&
-     defined?(RUBY_ENGINE) &&
-     RUBY_ENGINE == 'ruby' &&
-     Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.1')
-    gem 'net-http-persistent', '< 3.0'
+  if Gem::Version.new(rails_version) >= Gem::Version.new('6.0')
+    gem 'sqlite3', '~> 1.4.0', :platform => [:rbx, :ruby]
+  else
+    gem 'sqlite3', '< 1.4.0', :platform => [:rbx, :ruby]
   end
   gem 'rspec', '>= 2.5.0', '< 3.0'
-  gem 'sqlite3', '< 1.4.0', :platform => [:rbx, :ruby]
   gem 'jdbc-sqlite3', :platform => :jruby
   gem 'activerecord-jdbc-adapter', :platform => :jruby
   gem 'activerecord-jdbcsqlite3-adapter', :platform => :jruby
@@ -46,20 +27,12 @@ group :test do
 end
 
 group :development do
-  gem 'travis'
   gem 'rake', '~> 10.1.0'
   gem 'rdoc'
 end
 
 group :test, :development do
   gem 'will_paginate', '>= 2.3.15'
-  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
+  gem 'kaminari', '< 1'
 end
 

data/Gemfile.lock

@@ -1,153 +1,162 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    actioncable (5.2.4.4)
-      actionpack (= 5.2.4.4)
+    actioncable (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailer (5.2.4.4)
-      actionpack (= 5.2.4.4)
-      actionview (= 5.2.4.4)
-      activejob (= 5.2.4.4)
+    actionmailbox (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      activejob (= 6.1.3.1)
+      activerecord (= 6.1.3.1)
+      activestorage (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      mail (>= 2.7.1)
+    actionmailer (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      actionview (= 6.1.3.1)
+      activejob (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (5.2.4.4)
-      actionview (= 5.2.4.4)
-      activesupport (= 5.2.4.4)
-      rack (~> 2.0, >= 2.0.8)
+    actionpack (6.1.3.1)
+      actionview (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      rack (~> 2.0, >= 2.0.9)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.2.4.4)
-      activesupport (= 5.2.4.4)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      activerecord (= 6.1.3.1)
+      activestorage (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      nokogiri (>= 1.8.5)
+    actionview (6.1.3.1)
+      activesupport (= 6.1.3.1)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    active_model_serializers (0.10.10)
-      actionpack (>= 4.1, < 6.1)
-      activemodel (>= 4.1, < 6.1)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    active_model_serializers (0.10.12)
+      actionpack (>= 4.1, < 6.2)
+      activemodel (>= 4.1, < 6.2)
       case_transform (>= 0.2)
       jsonapi-renderer (>= 0.1.1.beta1, < 0.3)
-    activejob (5.2.4.4)
-      activesupport (= 5.2.4.4)
+    activejob (6.1.3.1)
+      activesupport (= 6.1.3.1)
       globalid (>= 0.3.6)
-    activemodel (5.2.4.4)
-      activesupport (= 5.2.4.4)
-    activerecord (5.2.4.4)
-      activemodel (= 5.2.4.4)
-      activesupport (= 5.2.4.4)
-      arel (>= 9.0)
-    activestorage (5.2.4.4)
-      actionpack (= 5.2.4.4)
-      activerecord (= 5.2.4.4)
-      marcel (~> 0.3.1)
-    activesupport (5.2.4.4)
+    activemodel (6.1.3.1)
+      activesupport (= 6.1.3.1)
+    activerecord (6.1.3.1)
+      activemodel (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+    activestorage (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      activejob (= 6.1.3.1)
+      activerecord (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      marcel (~> 1.0.0)
+      mini_mime (~> 1.0.2)
+    activesupport (6.1.3.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    addressable (2.7.0)
-      public_suffix (>= 2.0.2, < 5.0)
-    algoliasearch (1.27.5)
-      httpclient (~> 2.8, >= 2.8.3)
-      json (>= 1.5.1)
-    arel (9.0.0)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    addressable (2.4.0)
+    algolia (2.0.4)
+      faraday (>= 0.15, < 2.0)
+      multi_json (~> 1.0)
+      net-http-persistent
+    backports (3.21.0)
     builder (3.2.4)
     case_transform (0.2)
       activesupport
-    concurrent-ruby (1.1.7)
+    concurrent-ruby (1.1.8)
     crass (1.0.6)
     diff-lcs (1.4.4)
-    erubi (1.9.0)
-    faraday (1.1.0)
+    erubi (1.10.0)
+    ethon (0.13.0)
+      ffi (>= 1.15.0)
+    faraday (0.17.4)
       multipart-post (>= 1.2, < 3)
-      ruby2_keywords
-    faraday_middleware (1.0.0)
-      faraday (~> 1.0)
-    gh (0.18.0)
-      activesupport (~> 5.0)
-      addressable (~> 2.4)
-      faraday (~> 1.0)
-      faraday_middleware (~> 1.0)
+    faraday_middleware (0.14.0)
+      faraday (>= 0.7.4, < 1.0)
+    ffi (1.15.0)
+    gh (0.15.1)
+      addressable (~> 2.4.0)
+      backports
+      faraday (~> 0.8)
       multi_json (~> 1.0)
       net-http-persistent (~> 2.9)
       net-http-pipeline
     globalid (0.4.2)
       activesupport (>= 4.2.0)
-    highline (2.0.3)
-    httpclient (2.8.3)
-    i18n (1.8.5)
+    highline (1.7.10)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    json (1.8.6)
-    json_pure (2.3.1)
+    json (2.5.1)
     jsonapi-renderer (0.2.2)
-    kaminari (1.2.1)
-      activesupport (>= 4.1.0)
-      kaminari-actionview (= 1.2.1)
-      kaminari-activerecord (= 1.2.1)
-      kaminari-core (= 1.2.1)
-    kaminari-actionview (1.2.1)
-      actionview
-      kaminari-core (= 1.2.1)
-    kaminari-activerecord (1.2.1)
-      activerecord
-      kaminari-core (= 1.2.1)
-    kaminari-core (1.2.1)
+    kaminari (0.17.0)
+      actionpack (>= 3.0.0)
+      activesupport (>= 3.0.0)
     launchy (2.4.3)
       addressable (~> 2.3)
-    loofah (2.7.0)
+    loofah (2.9.1)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
       mini_mime (>= 0.1.1)
-    marcel (0.3.3)
-      mimemagic (~> 0.3.2)
+    marcel (1.0.1)
     method_source (1.0.0)
-    mimemagic (0.3.5)
-    mini_mime (1.0.2)
-    mini_portile2 (2.4.0)
-    minitest (5.14.2)
+    mini_mime (1.0.3)
+    mini_portile2 (2.5.0)
+    minitest (5.14.4)
     multi_json (1.15.0)
     multipart-post (2.1.1)
     net-http-persistent (2.9.4)
     net-http-pipeline (1.0.1)
-    nio4r (2.5.4)
-    nokogiri (1.10.10)
-      mini_portile2 (~> 2.4.0)
-    public_suffix (4.0.6)
+    nio4r (2.5.7)
+    nokogiri (1.11.3)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
     pusher-client (0.6.2)
       json
       websocket (~> 1.0)
+    racc (1.5.2)
     rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rails (5.2.4.4)
-      actioncable (= 5.2.4.4)
-      actionmailer (= 5.2.4.4)
-      actionpack (= 5.2.4.4)
-      actionview (= 5.2.4.4)
-      activejob (= 5.2.4.4)
-      activemodel (= 5.2.4.4)
-      activerecord (= 5.2.4.4)
-      activestorage (= 5.2.4.4)
-      activesupport (= 5.2.4.4)
-      bundler (>= 1.3.0)
-      railties (= 5.2.4.4)
+    rails (6.1.3.1)
+      actioncable (= 6.1.3.1)
+      actionmailbox (= 6.1.3.1)
+      actionmailer (= 6.1.3.1)
+      actionpack (= 6.1.3.1)
+      actiontext (= 6.1.3.1)
+      actionview (= 6.1.3.1)
+      activejob (= 6.1.3.1)
+      activemodel (= 6.1.3.1)
+      activerecord (= 6.1.3.1)
+      activestorage (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      bundler (>= 1.15.0)
+      railties (= 6.1.3.1)
       sprockets-rails (>= 2.0.0)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.3.0)
       loofah (~> 2.3)
-    railties (5.2.4.4)
-      actionpack (= 5.2.4.4)
-      activesupport (= 5.2.4.4)
+    railties (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
       method_source
       rake (>= 0.8.7)
-      thor (>= 0.19.0, < 2.0)
+      thor (~> 1.0)
     rake (10.1.1)
-    rdoc (6.2.1)
+    rdoc (6.3.0)
     redgreen (1.2.2)
     rspec (2.99.0)
       rspec-core (~> 2.99.0)
@@ -157,8 +166,7 @@ GEM
     rspec-expectations (2.99.2)
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-mocks (2.99.4)
-    ruby2_keywords (0.0.2)
-    sequel (5.38.0)
+    sequel (5.43.0)
     sprockets (4.0.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
@@ -166,24 +174,27 @@ GEM
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
-    sqlite3 (1.3.13)
-    thor (1.0.1)
-    thread_safe (0.3.6)
-    travis (1.10.0)
-      faraday (~> 1.0)
-      faraday_middleware (~> 1.0)
+    sqlite3 (1.4.2)
+    thor (1.1.0)
+    travis (1.8.13)
+      backports
+      faraday (~> 0.9)
+      faraday_middleware (~> 0.9, >= 0.9.1)
       gh (~> 0.13)
-      highline (~> 2.0)
-      json_pure (~> 2.3)
-      launchy (~> 2.1, < 2.5.0)
+      highline (~> 1.6)
+      launchy (~> 2.1)
       pusher-client (~> 0.4)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
-    websocket (1.2.8)
+      typhoeus (~> 0.6, >= 0.6.8)
+    typhoeus (0.8.0)
+      ethon (>= 0.8.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    websocket (1.2.9)
     websocket-driver (0.7.3)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
     will_paginate (3.3.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
@@ -192,17 +203,17 @@ DEPENDENCIES
   active_model_serializers
   activerecord-jdbc-adapter
   activerecord-jdbcsqlite3-adapter
-  algoliasearch (>= 1.26.0, < 2.0.0)
+  algolia (< 3.0.0)
   jdbc-sqlite3
-  json (~> 1.8, >= 1.8.6)
-  kaminari
-  rails (>= 3.2.0)
+  json (>= 1.5.1)
+  kaminari (< 1)
+  rails (~> 6.1)
   rake (~> 10.1.0)
   rdoc
   redgreen
   rspec (>= 2.5.0, < 3.0)
   sequel (>= 4.0)
-  sqlite3 (< 1.4.0)
+  sqlite3 (~> 1.4.0)
   travis
   will_paginate (>= 2.3.15)
 

data/README.md

@@ -1,18 +1,18 @@
 <p align="center">
   <a href="https://www.algolia.com">
-    <img alt="Algolia for Rails" src="https://raw.githubusercontent.com/algolia/algoliasearch-client-common/master/banners/rails.png" >
+    <img alt="Algolia for Rails" src="https://raw.githubusercontent.com/algolia/algoliasearch-client-common/master/banners/rails.png"/>
   </a>
+</p>
 
-  <h4 align="center">The perfect starting point to integrate <a href="https://algolia.com" target="_blank">Algolia</a> within your Rails project</h4>
+<h4 align="center">The perfect starting point to integrate <a href="https://algolia.com" target="_blank">Algolia</a> within your Rails project</h4>
 
-  <p align="center">
-    <a href="https://travis-ci.org/algolia/algoliasearch-rails"><img src="https://img.shields.io/travis/algolia/algoliasearch-rails/master.svg" alt="Build Status"></img></a>
-    <a href="http://badge.fury.io/rb/algoliasearch-rails"><img src="https://badge.fury.io/rb/algoliasearch-rails.svg" alt="Gem Version"></img></a>
-    <a href="https://codeclimate.com/github/algolia/algoliasearch-rails"><img src="https://codeclimate.com/github/algolia/algoliasearch-rails.svg" alt="Code Climate"></img></a>
-    <img src="https://img.shields.io/badge/ActiveRecord-yes-blue.svg?style=flat-square" alt="ActiveRecord"></img>
-    <img src="https://img.shields.io/badge/Mongoid-yes-blue.svg?style=flat-square" alt="Mongoid"></img>
-    <img src="https://img.shields.io/badge/Sequel-yes-blue.svg?style=flat-square" alt="Sequel"></img>
-  </p>
+<p align="center">
+  <a href="https://circleci.com/gh/algolia/algoliasearch-rails"><img src="https://circleci.com/gh/algolia/algoliasearch-rails.svg?style=shield" alt="CircleCI" /></a>
+  <a href="http://badge.fury.io/rb/algoliasearch-rails"><img src="https://badge.fury.io/rb/algoliasearch-rails.svg" alt="Gem Version"/></a>
+  <a href="https://codeclimate.com/github/algolia/algoliasearch-rails"><img src="https://codeclimate.com/github/algolia/algoliasearch-rails.svg" alt="Code Climate"/></a>
+  <img src="https://img.shields.io/badge/ActiveRecord-yes-blue.svg?style=flat-square" alt="ActiveRecord"/>
+  <img src="https://img.shields.io/badge/Mongoid-yes-blue.svg?style=flat-square" alt="Mongoid"/>
+  <img src="https://img.shields.io/badge/Sequel-yes-blue.svg?style=flat-square" alt="Sequel"/>
 </p>
 
 <p align="center">
@@ -26,7 +26,7 @@
 
 
 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.
+Rails 5.x and 6.x are 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/).
 
@@ -1160,29 +1160,6 @@ class User < ActiveRecord::Base
 end
 ```
 
-Or you may want to mock Algolia's API calls. We provide a [WebMock](https://github.com/bblimke/webmock) sample configuration that you can use including `algolia/webmock`:
-
-```ruby
-require 'algolia/webmock'
-
-describe 'With a mocked client' do
-
-  before(:each) do
-    WebMock.enable!
-  end
-
-  it "shouldn't perform any API calls here" do
-    User.create(name: 'My Indexed User')  # mocked, no API call performed
-    User.search('').should == {}          # mocked, no API call performed
-  end
-
-  after(:each) do
-    WebMock.disable!
-  end
-
-end
-```
-
 
 ## ❓ Troubleshooting
 

data/algoliasearch-rails.gemspec

@@ -21,7 +21,6 @@ Gem::Specification.new do |s|
   s.files = [
     ".document",
     ".rspec",
-    ".travis.yml",
     "CHANGELOG.MD",
     "Gemfile",
     "Gemfile.lock",
@@ -79,19 +78,18 @@ 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.26.0", "< 2.0.0"])
+      s.add_runtime_dependency(%q<algolia>, ["< 3.0.0"])
       s.add_development_dependency(%q<will_paginate>, [">= 2.3.15"])
       s.add_development_dependency(%q<kaminari>, [">= 0"])
-      s.add_development_dependency "travis"
       s.add_development_dependency "rake"
       s.add_development_dependency "rdoc"
     else
       s.add_dependency(%q<json>, [">= 1.5.1"])
-      s.add_dependency(%q<algoliasearch>, [">= 1.26.0", "< 2.0.0"])
+      s.add_dependency(%q<algolia>, ["< 3.0.0"])
     end
   else
     s.add_dependency(%q<json>, [">= 1.5.1"])
-    s.add_dependency(%q<algoliasearch>, [">= 1.26.0", "< 2.0.0"])
+    s.add_dependency(%q<algolia>, ["< 3.0.0"])
   end
 end
 

data/lib/algoliasearch/configuration.rb

@@ -1,14 +1,30 @@
 module AlgoliaSearch
   module Configuration
+    def initiliaze
+      @client = nil
+    end
+
     def configuration
       @@configuration || raise(NotConfigured, "Please configure AlgoliaSearch. Set AlgoliaSearch.configuration = {application_id: 'YOUR_APPLICATION_ID', api_key: 'YOUR_API_KEY'}")
     end
 
     def configuration=(configuration)
       @@configuration = configuration.merge(
-          :user_agent => "Algolia for Rails (#{AlgoliaSearch::VERSION}); Rails (#{Rails::VERSION::STRING})"
+        :user_agent => "Algolia for Rails (#{AlgoliaSearch::VERSION}); Rails (#{Rails::VERSION::STRING})",
+        :symbolize_keys => false
       )
-      Algolia.init @@configuration
+    end
+
+    def client
+      if @client.nil?
+        setup_client
+      end
+
+      @client
+    end
+
+    def setup_client
+      @client = Algolia::Search::Client.create_with_config(Algolia::Search::Config.new(@@configuration))
     end
   end
 end

data/lib/algoliasearch/pagination/kaminari.rb

@@ -9,7 +9,7 @@ module AlgoliaSearch
     class Kaminari < ::Kaminari::PaginatableArray
 
       def initialize(array, options)
-        super(array, options)
+        super(array, **options)
       end
 
       def limit(num)

data/lib/algoliasearch/utilities.rb

@@ -2,7 +2,7 @@ module AlgoliaSearch
   module Utilities
     class << self
       def get_model_classes
-        if defined?(Rails.autoloaders) && Rails.autoloaders.zeitwerk_enabled?
+        if Rails.application && defined?(Rails.autoloaders) && Rails.autoloaders.zeitwerk_enabled?
           Zeitwerk::Loader.eager_load_all
         elsif Rails.application
           Rails.application.eager_load!

data/lib/algoliasearch/version.rb

@@ -1,3 +1,3 @@
 module AlgoliaSearch
-  VERSION = '1.25.0'
+  VERSION = '2.1.4'
 end

data/lib/algoliasearch-rails.rb

@@ -1,4 +1,4 @@
-require 'algoliasearch'
+require 'algolia'
 
 require 'algoliasearch/version'
 require 'algoliasearch/utilities'
@@ -53,7 +53,6 @@ module AlgoliaSearch
     OPTIONS = [
       # Attributes
       :searchableAttributes, :attributesForFaceting, :unretrievableAttributes, :attributesToRetrieve,
-      :attributesToIndex, #Legacy name of searchableAttributes
       # Ranking
       :ranking, :customRanking, # Replicas are handled via `add_replica`
       # Faceting
@@ -76,7 +75,6 @@ module AlgoliaSearch
       :disablePrefixOnAttributes, :disableExactOnAttributes, :exactOnSingleWordQuery, :alternativesAsExact,
       # Performance
       :numericAttributesForFiltering, :allowCompressionOfIntegerArray,
-      :numericAttributesToIndex, # Legacy name of numericAttributesForFiltering
       # Advanced
       :attributeForDistinct, :distinct, :replaceSynonymsInHighlight, :minProximity, :responseFields,
       :maxFacetHits,
@@ -102,7 +100,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 replica index') if @options[:slave] || @options[:replica]
+      raise ArgumentError.new('Cannot specify additional attributes on a replica index') if @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) }
@@ -112,7 +110,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 replica index') if @options[:slave] || @options[:replica]
+      raise ArgumentError.new('Cannot specify additional attributes on a replica index') if @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) }
@@ -224,14 +222,14 @@ module AlgoliaSearch
     end
 
     def geoloc(lat_attr = nil, lng_attr = nil, &block)
-      raise ArgumentError.new('Cannot specify additional attributes on a replica index') if @options[:slave] || @options[:replica]
+      raise ArgumentError.new('Cannot specify additional attributes on a replica index') if @options[:replica]
       add_attribute :_geoloc do |o|
         block_given? ? o.instance_eval(&block) : { :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 replica index') if @options[:slave] || @options[:replica]
+      raise ArgumentError.new('Cannot specify additional attributes on a replica index') if @options[:replica]
       add_attribute :_tags do |o|
         v = block_given? ? o.instance_eval(&block) : args
         v.is_a?(Array) ? v : [v]
@@ -248,16 +246,12 @@ module AlgoliaSearch
         v = get_setting(k)
         settings[k] = v if !v.nil?
       end
-      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?
+
+      if !@options[:replica]
         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 = "virtual(#{name})" if opts[:virtual]
           name
         end
         settings.delete(:replicas) if settings[:replicas].empty?
@@ -266,27 +260,20 @@ module AlgoliaSearch
     end
 
     def add_index(index_name, options = {}, &block)
-      raise ArgumentError.new('Cannot specify additional index on a replica index') if @options[:slave] || @options[:replica]
+      raise ArgumentError.new('Cannot specify additional index on a replica index') if @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]
       @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, &block)
     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('Cannot specify additional replicas on a replica index') if @options[:replica]
       raise ArgumentError.new('No block given') if !block_given?
       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, :primary_settings => self }), &block)
-    end
-
     def additional_indexes
       @additional_indexes || {}
     end
@@ -304,11 +291,11 @@ module AlgoliaSearch
   # are correctly logged or thrown depending on the `raise_on_failure` option
   class SafeIndex
     def initialize(name, raise_on_failure)
-      @index = ::Algolia::Index.new(name)
+      @index = AlgoliaSearch.client.init_index(name)
       @raise_on_failure = raise_on_failure.nil? || raise_on_failure
     end
 
-    ::Algolia::Index.instance_methods(false).each do |m|
+    ::Algolia::Search::Index.instance_methods(false).each do |m|
       define_method(m) do |*args, &block|
         SafeIndex.log_or_throw(m, @raise_on_failure) do
           @index.send(m, *args, &block)
@@ -329,7 +316,7 @@ module AlgoliaSearch
       SafeIndex.log_or_throw(:get_settings, @raise_on_failure) do
         begin
           @index.get_settings(*args)
-        rescue Algolia::AlgoliaError => e
+        rescue Algolia::AlgoliaHttpError => e
           return {} if e.code == 404 # not fatal
           raise e
         end
@@ -339,7 +326,7 @@ module AlgoliaSearch
     # expose move as well
     def self.move_index(old_name, new_name)
       SafeIndex.log_or_throw(:move_index, true) do
-        ::Algolia.move_index(old_name, new_name)
+        AlgoliaSearch.client.move_index(old_name, new_name)
       end
     end
 
@@ -511,7 +498,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] || options[:replica]
+        next if options[:replica]
         last_task = nil
 
         algolia_find_in_batches(batch_size) do |group|
@@ -531,7 +518,7 @@ module AlgoliaSearch
           end
           last_task = index.save_objects(objects)
         end
-        index.wait_task(last_task["taskID"]) if last_task and (synchronous || options[:synchronous])
+        index.wait_task(last_task.raw_response["taskID"]) if last_task and (synchronous || options[:synchronous])
       end
       nil
     end
@@ -541,7 +528,7 @@ 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] || options[:replica]
+        next if options[:replica]
 
         # fetch the master settings
         master_index = algolia_ensure_init(options, settings)
@@ -549,8 +536,6 @@ module AlgoliaSearch
         master_settings.merge!(JSON.parse(settings.to_settings.to_json)) # convert symbols to strings
 
         # remove the replicas of the temporary index
-        master_settings.delete :slaves
-        master_settings.delete 'slaves'
         master_settings.delete :replicas
         master_settings.delete 'replicas'
 
@@ -562,13 +547,13 @@ module AlgoliaSearch
         tmp_settings = settings.dup
 
         if options[:check_settings] == false
-          ::Algolia::copy_index!(src_index_name, tmp_index_name, %w(settings synonyms rules))
+          AlgoliaSearch.client.copy_index!(src_index_name, tmp_index_name, { scope: %w[settings synonyms rules] })
           tmp_index = SafeIndex.new(tmp_index_name, !!options[:raise_on_failure])
         else
           tmp_index = algolia_ensure_init(tmp_options, tmp_settings, master_settings)
         end
 
-          algolia_find_in_batches(batch_size) do |group|
+        algolia_find_in_batches(batch_size) do |group|
           if algolia_conditional_index?(options)
             # select only indexable objects
             group = group.select { |o| algolia_indexable?(o, tmp_options) }
@@ -578,7 +563,7 @@ module AlgoliaSearch
         end
 
         move_task = SafeIndex.move_index(tmp_index.name, src_index_name)
-        master_index.wait_task(move_task["taskID"]) if synchronous || options[:synchronous]
+        master_index.wait_task(move_task.raw_response["taskID"]) if synchronous || options[:synchronous]
       end
       nil
     end
@@ -587,8 +572,6 @@ module AlgoliaSearch
       algolia_configurations.each do |options, settings|
         if options[:primary_settings] && options[:inherit]
           primary = options[:primary_settings].to_settings
-          primary.delete :slaves
-          primary.delete 'slaves'
           primary.delete :replicas
           primary.delete 'replicas'
           final_settings = primary.merge(settings.to_settings)
@@ -598,7 +581,7 @@ module AlgoliaSearch
 
         index = SafeIndex.new(algolia_index_name(options), true)
         task = index.set_settings(final_settings)
-        index.wait_task(task["taskID"]) if synchronous
+        index.wait_task(task.raw_response["taskID"]) if synchronous
       end
     end
 
@@ -606,9 +589,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] || options[:replica]
+        next if 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 || options[:synchronous]
+        index.wait_task(task.raw_response["taskID"]) if synchronous || options[:synchronous]
       end
     end
 
@@ -618,13 +601,13 @@ 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] || options[:replica]
+        next if options[:replica]
         if algolia_indexable?(object, options)
           raise ArgumentError.new("Cannot index a record with a blank objectID") if object_id.blank?
           if synchronous || options[:synchronous]
-            index.add_object!(settings.get_attributes(object), object_id)
+            index.save_object!(settings.get_attributes(object).merge 'objectID' => algolia_object_id_of(object, options))
           else
-            index.add_object(settings.get_attributes(object), object_id)
+            index.save_object(settings.get_attributes(object).merge 'objectID' => algolia_object_id_of(object, options))
           end
         elsif algolia_conditional_index?(options) && !object_id.blank?
           # remove non-indexable objects
@@ -645,7 +628,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] || options[:replica]
+        next if options[:replica]
         if synchronous || options[:synchronous]
           index.delete_object!(object_id)
         else
@@ -659,8 +642,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] || options[:replica]
-        synchronous || options[:synchronous] ? index.clear! : index.clear
+        next if options[:replica]
+        synchronous || options[:synchronous] ? index.clear_objects! : index.clear_objects
         @algolia_indexes[settings] = nil
       end
       nil
@@ -669,8 +652,6 @@ module AlgoliaSearch
     def algolia_raw_search(q, params = {})
       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)
@@ -735,13 +716,11 @@ module AlgoliaSearch
     def algolia_search_for_facet_values(facet, text, params = {})
       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']
+      index.search_for_facet_values(facet, text, query)['facetHits']
     end
 
     # deprecated (renaming)
@@ -770,7 +749,7 @@ module AlgoliaSearch
       # Loop over each index to see if a attribute used in records has changed
       algolia_configurations.each do |options, settings|
         next if algolia_indexing_disabled?(options)
-        next if options[:slave] || options[:replica]
+        next if options[:replica]
         return true if algolia_object_id_changed?(object, options)
         settings.get_attribute_names(object).each do |k|
           return true if algolia_attribute_changed?(object, k)
@@ -807,21 +786,20 @@ module AlgoliaSearch
 
       @algolia_indexes[settings] = SafeIndex.new(algolia_index_name(options), algoliasearch_options[:raise_on_failure])
 
-      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]
 
       options[:check_settings] = true if options[:check_settings].nil?
 
+      current_settings = if options[:check_settings]
+                           @algolia_indexes[settings].get_settings(:getVersion => 1) rescue nil # if the index doesn't exist
+                         end
+
       if !algolia_indexing_disabled?(options) && options[:check_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 unless replicas.nil? || options[:inherit]
-        @algolia_indexes[settings].set_settings(index_settings)
+                   index_settings.delete('replicas')
+        index_settings[:replicas] = replicas unless replicas.nil? || options[:inherit]
+        @algolia_indexes[settings].set_settings!(index_settings)
       end
 
       @algolia_indexes[settings]

data/spec/spec_helper.rb

@@ -29,8 +29,9 @@ RSpec.configure do |c|
 
   # Remove all indexes setup in this run in local or CI
   c.after(:suite) do
-    safe_index_list.each do |index|
-      Algolia.client.delete_index!(index['name'])
+    safe_index_list.each do |i|
+      index = AlgoliaSearch.client.init_index(i['name'])
+      index.delete!
     end
   end
 end
@@ -45,7 +46,7 @@ end
 
 # get a list of safe indexes in local or CI
 def safe_index_list
-  list = Algolia.client.list_indexes()['items']
+  list = AlgoliaSearch.client.list_indexes['items']
   list = list.select { |index| index["name"].include?(SAFE_INDEX_PREFIX) }
   list.sort_by { |index| index["primary"] || "" }
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algoliasearch-rails
 version: !ruby/object:Gem::Version
-  version: 1.25.0
+  version: 2.1.4
 platform: ruby
 authors:
 - Algolia
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-24 00:00:00.000000000 Z
+date: 2021-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -25,25 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.5.1
 - !ruby/object:Gem::Dependency
-  name: algoliasearch
+  name: algolia
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.26.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.26.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: will_paginate
   requirement: !ruby/object:Gem::Requirement
@@ -72,20 +66,6 @@ dependencies:
     - - ">="
       - !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
@@ -125,7 +105,6 @@ extra_rdoc_files:
 files:
 - ".document"
 - ".rspec"
-- ".travis.yml"
 - CHANGELOG.MD
 - Gemfile
 - Gemfile.lock
@@ -188,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.6
 signing_key:
 specification_version: 4
 summary: AlgoliaSearch integration to your favorite ORM

data/.travis.yml

@@ -1,62 +0,0 @@
-language: ruby
-
-branches:
-  only:
-    - master
-
-matrix:
-  include:
-    - rvm: 1.8.7
-      env: RAILS_VERSION=3.2.0 SEQUEL_VERSION=4.0
-      dist: trusty
-    - rvm: 1.9.3
-      env: RAILS_VERSION=3.2.0
-    - rvm: 1.9.3
-      env: RAILS_VERSION=4.2
-    - rvm: 2.2.9
-      env: RAILS_VERSION=3.2.0
-    - rvm: 2.2.9
-      env: RAILS_VERSION=4.2
-    - rvm: 2.2.9
-      env: RAILS_VERSION=5.1
-    - rvm: 2.3.6
-      env: RAILS_VERSION=3.2.0
-    - rvm: 2.3.6
-      env: RAILS_VERSION=4.2
-    - rvm: 2.3.6
-      env: RAILS_VERSION=5.1
-    - rvm: 2.4.3
-      env: RAILS_VERSION=4.2
-    - rvm: 2.4.3
-      env: RAILS_VERSION=5.1 SEQUEL_VERSION=4.0
-    - rvm: 2.4.3
-      env: RAILS_VERSION=5.1 SEQUEL_VERSION=5.0
-    - rvm: 2.5.3
-      env: RAILS_VERSION=5.1 SEQUEL_VERSION=5.0
-    - rvm: 2.5.3
-      env: RAILS_VERSION=6.0 SEQUEL_VERSION=5.0
-    - rvm: 2.6.0
-      env: RAILS_VERSION=5.2 SEQUEL_VERSION=5.0
-    - rvm: 2.6.0
-      env: RAILS_VERSION=6.0 SEQUEL_VERSION=5.0
-    - rvm: 2.7.0
-      env: RAILS_VERSION=5.2 SEQUEL_VERSION=5.0
-    - rvm: 2.7.0
-      env: RAILS_VERSION=6.0 SEQUEL_VERSION=5.0
-
-before_install:
-  - wget http://api-key-dealer.herokuapp.com/clients/algolia-keys && chmod +x algolia-keys
-  - which bundle || true
-  - find /home/travis/.rvm -wholename "*/bundler-*.gemspec" -print -delete || true
-  - bundle --version || true
-  - gem uninstall bundler || true
-  - bundle --version || true
-  - gem install bundler -v 1.17.3
-  - bundle --version
-
-install: rm -f Gemfile.lock && bundle install --without development
-
-cache: bundler
-
-script:
-  - eval $(./algolia-keys export) && bundle exec rake