algoliasearch-rails 1.23.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ac9c6a0bf5ab646bcde8da6a321cab385e1875e258e5a2f2e50120ae7fbd9f0
-  data.tar.gz: 1aef47abb42a2e5cf0fa5201560523c73a44488c763b38b6ad3ad82e55337340
+  metadata.gz: e9f821e4bb84fd0a2217a6ed58bbdef6ae894e18641ec2a9bbfb82b6f37103a8
+  data.tar.gz: fde9d6939506c96144fdd28b7ca09fb5702415d0518664958c5fef86f4631143
 SHA512:
-  metadata.gz: 0e4a6e309538e45b67b32b53f041b217cb249fd7dce3a61158b4d256a7d984a1d6b8bdddee38bc5665ff3721c1fdc62042037b385b2a86d0773e84c921abc0ed
-  data.tar.gz: 2dfd9c286a3a12b2a9ca37f0d29669abb5a6454a3368f0c8a0265fed5155c6f3af8f727ec5552ea334b955c78f6dc16918c99ba7db7d54adbe66cd1c84f47db1
+  metadata.gz: b371672188be5d851ed39bc3c9bfb7efceed38ce1a1c74b00f444c09c741ac9fd8aec3378aeccd4b5f15cd237944a11fdfbf37e5354934a84088205543a1eda1
+  data.tar.gz: fef38d14f51f32a39acee326c955fe07ff7860f8c7c1a4afed26615453fdefbd0427dd91562d12415e5d512cf087abb20144d830355a0928f54c18526696471d

data/.travis.yml

@@ -8,6 +8,7 @@ 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
@@ -32,8 +33,16 @@ matrix:
       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

data/{ChangeLog → CHANGELOG.MD}

@@ -1,5 +1,39 @@
 # CHANGELOG
 
+## [Unreleased](https://github.com/algolia/algoliasearch-rails/compare/2.0.0...master)
+
+## [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)
+
+### Added
+- Pass array argument to geoloc ([#372](https://github.com/algolia/algoliasearch-rails/pull/372))
+- Containerize the repo ([#391](https://github.com/algolia/algoliasearch-rails/pull/391))
+
+### Fixed
+- Use Zeitwerk for loading models in Rails 6 ([#364](https://github.com/algolia/algoliasearch-rails/pull/364))
+
+## [1.24.1](https://github.com/algolia/algoliasearch-rails/releases/tag/1.24.1) (2020-07-15)
+
+**Fixed**
+
+* Fixes ruby warning 'Proc.new is deprecated'
+
+## [1.24.0](https://github.com/algolia/algoliasearch-rails/releases/tag/1.24.0) (2020-02-21)
+
+**Added**
+
+* Adds indexLanguages in index settings
+
 ## [1.23.2](https://github.com/algolia/algoliasearch-rails/releases/tag/1.23.2) (2019-06-26)
 
 **Fixed**

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
@@ -53,13 +34,6 @@ 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,72 +1,90 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    actioncable (5.2.3)
-      actionpack (= 5.2.3)
+    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.3)
-      actionpack (= 5.2.3)
-      actionview (= 5.2.3)
-      activejob (= 5.2.3)
+    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.3)
-      actionview (= 5.2.3)
-      activesupport (= 5.2.3)
-      rack (~> 2.0)
+    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.3)
-      activesupport (= 5.2.3)
+      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.9)
-      actionpack (>= 4.1, < 6)
-      activemodel (>= 4.1, < 6)
+      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.3)
-      activesupport (= 5.2.3)
+    activejob (6.1.3.1)
+      activesupport (= 6.1.3.1)
       globalid (>= 0.3.6)
-    activemodel (5.2.3)
-      activesupport (= 5.2.3)
-    activerecord (5.2.3)
-      activemodel (= 5.2.3)
-      activesupport (= 5.2.3)
-      arel (>= 9.0)
-    activestorage (5.2.3)
-      actionpack (= 5.2.3)
-      activerecord (= 5.2.3)
-      marcel (~> 0.3.1)
-    activesupport (5.2.3)
+    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)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     addressable (2.4.0)
-    algoliasearch (1.26.0)
-      httpclient (~> 2.8, >= 2.8.3)
-      json (>= 1.5.1)
-    arel (9.0.0)
-    backports (3.15.0)
-    builder (3.2.3)
+    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.5)
-    crass (1.0.4)
-    diff-lcs (1.3)
-    erubi (1.8.0)
-    ethon (0.12.0)
-      ffi (>= 1.3.0)
-    faraday (0.15.4)
+    concurrent-ruby (1.1.8)
+    crass (1.0.6)
+    diff-lcs (1.4.4)
+    erubi (1.10.0)
+    ethon (0.13.0)
+      ffi (>= 1.15.0)
+    faraday (0.17.4)
       multipart-post (>= 1.2, < 3)
-    faraday_middleware (0.13.1)
+    faraday_middleware (0.14.0)
       faraday (>= 0.7.4, < 1.0)
-    ffi (1.11.1)
+    ffi (1.15.0)
     gh (0.15.1)
       addressable (~> 2.4.0)
       backports
@@ -77,76 +95,68 @@ GEM
     globalid (0.4.2)
       activesupport (>= 4.2.0)
     highline (1.7.10)
-    httpclient (2.8.3)
-    i18n (1.6.0)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    json (1.8.6)
+    json (2.5.1)
     jsonapi-renderer (0.2.2)
-    kaminari (1.1.1)
-      activesupport (>= 4.1.0)
-      kaminari-actionview (= 1.1.1)
-      kaminari-activerecord (= 1.1.1)
-      kaminari-core (= 1.1.1)
-    kaminari-actionview (1.1.1)
-      actionview
-      kaminari-core (= 1.1.1)
-    kaminari-activerecord (1.1.1)
-      activerecord
-      kaminari-core (= 1.1.1)
-    kaminari-core (1.1.1)
+    kaminari (0.17.0)
+      actionpack (>= 3.0.0)
+      activesupport (>= 3.0.0)
     launchy (2.4.3)
       addressable (~> 2.3)
-    loofah (2.2.3)
+    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)
-    method_source (0.9.2)
-    mimemagic (0.3.3)
-    mini_mime (1.0.1)
-    mini_portile2 (2.4.0)
-    minitest (5.11.3)
-    multi_json (1.13.1)
+    marcel (1.0.1)
+    method_source (1.0.0)
+    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.3.1)
-    nokogiri (1.10.3)
-      mini_portile2 (~> 2.4.0)
+    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)
-    rack (2.0.7)
+    racc (1.5.2)
+    rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rails (5.2.3)
-      actioncable (= 5.2.3)
-      actionmailer (= 5.2.3)
-      actionpack (= 5.2.3)
-      actionview (= 5.2.3)
-      activejob (= 5.2.3)
-      activemodel (= 5.2.3)
-      activerecord (= 5.2.3)
-      activestorage (= 5.2.3)
-      activesupport (= 5.2.3)
-      bundler (>= 1.3.0)
-      railties (= 5.2.3)
+    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.0.4)
-      loofah (~> 2.2, >= 2.2.2)
-    railties (5.2.3)
-      actionpack (= 5.2.3)
-      activesupport (= 5.2.3)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    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.1.1)
+    rdoc (6.3.0)
     redgreen (1.2.2)
     rspec (2.99.0)
       rspec-core (~> 2.99.0)
@@ -156,18 +166,17 @@ GEM
     rspec-expectations (2.99.2)
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-mocks (2.99.4)
-    sequel (5.21.0)
-    sprockets (3.7.2)
+    sequel (5.43.0)
+    sprockets (4.0.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
-    sprockets-rails (3.2.1)
+    sprockets-rails (3.2.2)
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
-    sqlite3 (1.3.13)
-    thor (0.20.3)
-    thread_safe (0.3.6)
-    travis (1.8.10)
+    sqlite3 (1.4.2)
+    thor (1.1.0)
+    travis (1.8.13)
       backports
       faraday (~> 0.9)
       faraday_middleware (~> 0.9, >= 0.9.1)
@@ -178,13 +187,14 @@ GEM
       typhoeus (~> 0.6, >= 0.6.8)
     typhoeus (0.8.0)
       ethon (>= 0.8.0)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
-    websocket (1.2.8)
-    websocket-driver (0.7.1)
+    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.4)
-    will_paginate (3.1.7)
+    websocket-extensions (0.1.5)
+    will_paginate (3.3.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
@@ -193,19 +203,19 @@ 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)
 
 BUNDLED WITH
-   2.0.1
+   2.1.4

data/README.md

@@ -1,9 +1,28 @@
-
-# Algolia Search API Client for Rails
-
-[Algolia Search](https://www.algolia.com) is a hosted search engine capable of delivering real-time results from the first keystroke.
-
-[![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)
+<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" >
+  </a>
+
+  <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://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"></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>
+
+<p align="center">
+  <a href="https://www.algolia.com/doc/framework-integration/rails/getting-started/setup/?language=ruby" target="_blank">Documentation</a>  •
+  <a href="https://discourse.algolia.com" target="_blank">Community Forum</a>  •
+  <a href="http://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a>  •
+  <a href="https://github.com/algolia/algoliasearch-rails/issues" target="_blank">Report a bug</a>  •
+  <a href="https://www.algolia.com/doc/framework-integration/rails/troubleshooting/faq/" target="_blank">FAQ</a>  •
+  <a href="https://www.algolia.com/support" target="_blank">Support</a>
+</p>
 
 
 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.
@@ -64,6 +83,8 @@ You can find the full reference on [Algolia's website](https://www.algolia.com/d
 1. **[Testing](#testing)**
     * [Notes](#notes)
 
+1. **[Troubleshooting](#troubleshooting)**
+    * [Frequently asked questions](#frequently-asked-questions)
 
 
 
@@ -142,7 +163,7 @@ class Contact < ActiveRecord::Base
   include AlgoliaSearch
 
   algoliasearch do
-    attribute :first_name, :last_name, :email
+    attributes :first_name, :last_name, :email
   end
 end
 ```
@@ -1163,4 +1184,11 @@ end
 ```
 
 
+## ❓ Troubleshooting
+
+Encountering an issue? Before reaching out to support, we recommend heading to our [FAQ](https://www.algolia.com/doc/api-client/troubleshooting/faq/ruby/) where you will find answers for the most common issues and gotchas with the client.
+
+## Use the Dockerfile
+
+If you want to contribute to this project without installing all its dependencies, you can use our Docker image. Please check our [dedicated guide](DOCKER_README.MD) to learn more.
 

data/algoliasearch-rails.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |s|
   s.description = "AlgoliaSearch integration to your favorite ORM"
   s.email = "contact@algolia.com"
   s.extra_rdoc_files = [
-    "ChangeLog",
+    "CHANGELOG.MD",
     "LICENSE",
     "README.md"
   ]
@@ -22,7 +22,7 @@ Gem::Specification.new do |s|
     ".document",
     ".rspec",
     ".travis.yml",
-    "ChangeLog",
+    "CHANGELOG.MD",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE",
@@ -79,7 +79,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.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"
@@ -87,11 +87,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.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-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
@@ -68,7 +67,7 @@ module AlgoliaSearch
       :disableTypoToleranceOnAttributes, :disableTypoToleranceOnWords, :separatorsToIndex,
       # Language
       :ignorePlurals, :removeStopWords, :camelCaseAttributes, :decompoundedAttributes,
-      :keepDiacriticsOnCharacters, :queryLanguages,
+      :keepDiacriticsOnCharacters, :queryLanguages, :indexLanguages,
       # Query Rules
       :enableRules,
       # Query Strategy
@@ -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,
@@ -90,9 +88,9 @@ module AlgoliaSearch
       end
     end
 
-    def initialize(options, block)
+    def initialize(options, &block)
       @options = options
-      instance_exec(&block) if block
+      instance_exec(&block) if block_given?
     end
 
     def use_serializer(serializer)
@@ -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) }
@@ -223,15 +221,15 @@ module AlgoliaSearch
       end
     end
 
-    def geoloc(lat_attr, lng_attr)
-      raise ArgumentError.new('Cannot specify additional attributes on a replica index') if @options[:slave] || @options[:replica]
+    def geoloc(lat_attr = nil, lng_attr = nil, &block)
+      raise ArgumentError.new('Cannot specify additional attributes on a replica index') if @options[:replica]
       add_attribute :_geoloc do |o|
-        { :lat => o.send(lat_attr).to_f, :lng => o.send(lng_attr).to_f }
+        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, Proc.new)
+      @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
 
@@ -389,7 +376,7 @@ module AlgoliaSearch
     end
 
     def algoliasearch(options = {}, &block)
-      self.algoliasearch_settings = IndexSettings.new(options, block_given? ? Proc.new : nil)
+      self.algoliasearch_settings = IndexSettings.new(options, &block)
       self.algoliasearch_options = { :type => algolia_full_const_get(model_name.to_s), :per_page => algoliasearch_settings.get_setting(:hitsPerPage) || 10, :page => 1 }.merge(options)
 
       attr_accessor :highlight_result, :snippet_result
@@ -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,7 +547,7 @@ module AlgoliaSearch
         tmp_settings = settings.dup
 
         if options[:check_settings] == false
-          ::Algolia::copy_index!(src_index_name, tmp_index_name, %w(settings synonyms rules))
+          @client.copy_index!(src_index_name, tmp_index_name, %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)
@@ -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)
@@ -815,13 +794,10 @@ module AlgoliaSearch
       options[:check_settings] = true if options[:check_settings].nil?
 
       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/lib/algoliasearch/configuration.rb

@@ -1,14 +1,29 @@
 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})"
+        :user_agent => "Algolia for Rails (#{AlgoliaSearch::VERSION}); Rails (#{Rails::VERSION::STRING})"
       )
-      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/utilities.rb

@@ -2,7 +2,11 @@ module AlgoliaSearch
   module Utilities
     class << self
       def get_model_classes
-        Rails.application.eager_load! if Rails.application # Ensure all models are loaded (not necessary in production when cache_classes is true).
+        if Rails.application && defined?(Rails.autoloaders) && Rails.autoloaders.zeitwerk_enabled?
+          Zeitwerk::Loader.eager_load_all
+        elsif Rails.application
+          Rails.application.eager_load!
+        end
         AlgoliaSearch.instance_variable_get :@included_in
       end
 

data/lib/algoliasearch/version.rb

@@ -1,3 +1,3 @@
 module AlgoliaSearch
-  VERSION = '1.23.2'
+  VERSION = '2.1.0'
 end

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

data/spec/utilities_spec.rb

@@ -1,6 +1,6 @@
 require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
 
-AlgoliaSearch.configuration = { :application_id => ENV['ALGOLIA_APPLICATION_ID'], :api_key => ENV['ALGOLIA_API_KEY'] }
+AlgoliaSearch.configuration = { :application_id => ENV['ALGOLIA_APPLICATION_ID'], :api_key => ENV['ALGOLIA_API_KEY'], :symbolize_keys => false }
 
 describe AlgoliaSearch::Utilities do
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algoliasearch-rails
 version: !ruby/object:Gem::Version
-  version: 1.23.2
+  version: 2.1.0
 platform: ruby
 authors:
 - Algolia
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-06-26 00:00:00.000000000 Z
+date: 2021-06-22 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
@@ -119,14 +113,14 @@ email: contact@algolia.com
 executables: []
 extensions: []
 extra_rdoc_files:
-- ChangeLog
+- CHANGELOG.MD
 - LICENSE
 - README.md
 files:
 - ".document"
 - ".rspec"
 - ".travis.yml"
-- ChangeLog
+- CHANGELOG.MD
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -173,7 +167,7 @@ homepage: http://github.com/algolia/algoliasearch-rails
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -188,8 +182,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.0.6
+signing_key:
 specification_version: 4
 summary: AlgoliaSearch integration to your favorite ORM
 test_files: []