meilisearch-rails 0.2.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dff716ea4a13c0f64718942f4988550a36076ae5dc52ac8ec7282000d116a99d
-  data.tar.gz: 1346eb18ddb24bf718693b7b3efa89d4b0084ecffe9f7ccae1d71956b3b8bf56
+  metadata.gz: 9ad6c51de59755b283d9371028f127537f8eae862603d65469f3867e7e62b6ec
+  data.tar.gz: a2ef9d38103f8e2750e687f1fae309818b210576b63c6951b913b7856c713598
 SHA512:
-  metadata.gz: 38e1657c75e4eec945502ead72001ba56dc194d3ce5217e65f40abc49de34312087aa30d401d342a15c4c0701f0d41d49faf8c94aef5cc40d79ed9bdc345f414
-  data.tar.gz: 2cd31c3b6b70fb4d2c38977870ab28256de22422c410280e7615e11dfe64dd8eaa98295c7bdf553655b427837b8864ee60930a0aafa39e8f1272af34210c0479
+  metadata.gz: 5720f087c6c85aa34b553ba01614968fe4862a416c6e72c1829b4107470862a30db4e4107455d2a45ab94497ff69b084460196f6173c4f584aa1364769a0564a
+  data.tar.gz: 5cebff7daa2d2caf3ed62e9a49fe4f3f17d4ccf2b6dcfed90f92645fdac4c7d8adddea521aff563aca9f454942529b1444c9fea092fd329e2cfda187ef885eba

data/Gemfile

@@ -1,31 +1,39 @@
-source "http://rubygems.org"
+source 'http://rubygems.org'
 
 gem 'json', '~> 2.5', '>= 2.5.1'
-gem 'meilisearch', '~> 0.16.0'
+gem 'meilisearch', '~> 0.18.0'
 
-if defined?(RUBY_ENGINE) && RUBY_ENGINE == 'rbx'
-  gem 'rubysl', '~> 2.0', :platform => :rbx
+gem 'rubysl', '~> 2.0', platform: :rbx if defined?(RUBY_ENGINE) && RUBY_ENGINE == 'rbx'
+
+group :development do
+  gem 'rubocop', '~> 1.22'
+  gem 'rubocop-rails'
+  gem 'rubocop-rspec'
 end
 
 group :test do
-  rails_version = ENV["RAILS_VERSION"] || '5.2'
-  gem 'rails', "~> #{rails_version}"
+  rails_version = ENV['RAILS_VERSION'] || '5.2'
+  sequel_version = ENV['SEQUEL_VERSION'] ? "~> #{ENV['SEQUEL_VERSION']}" : '>= 4.0'
+
   gem 'active_model_serializers'
+  gem 'rails', "~> #{rails_version}"
+  gem 'sequel', sequel_version
+
   if Gem::Version.new(rails_version) >= Gem::Version.new('6.0')
-    gem 'sqlite3', '~> 1.4.0', :platform => [:rbx, :ruby]
+    gem 'sqlite3', '~> 1.4.0', platform: %i[rbx ruby]
   else
-    gem 'sqlite3', '< 1.4.0', :platform => [:rbx, :ruby]
+    gem 'sqlite3', '< 1.4.0', platform: %i[rbx ruby]
   end
-  gem 'rspec', '>= 2.5.0', '< 3.0'
-  gem 'jdbc-sqlite3', :platform => :jruby
-  gem 'activerecord-jdbc-adapter', :platform => :jruby
-  gem 'activerecord-jdbcsqlite3-adapter', :platform => :jruby
 
-  sequel_version = ENV['SEQUEL_VERSION'] ? "~> #{ENV['SEQUEL_VERSION']}" : '>= 4.0'
-  gem 'sequel', sequel_version
+  gem 'activerecord-jdbc-adapter', platform: :jruby
+  gem 'activerecord-jdbcsqlite3-adapter', platform: :jruby
+  gem 'jdbc-sqlite3', platform: :jruby
+  gem 'rspec', '~> 3.0'
+  gem 'simplecov', require: 'false'
+
+  gem 'byebug'
+  gem 'dotenv', '~> 2.7', '>= 2.7.6'
   gem 'faker', '~> 2.17'
-  gem 'will_paginate', '>= 2.3.15'
   gem 'kaminari'
-  gem 'dotenv', '~> 2.7', '>= 2.7.6'
-  gem 'byebug'
+  gem 'will_paginate', '>= 2.3.15'
 end

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 MeiliSearch
+Copyright (c) 2021 Meilisearch
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,11 +1,11 @@
 <p align="center">
-  <img src="https://res.cloudinary.com/meilisearch/image/upload/v1587402338/SDKs/meilisearch_rails.svg" alt="MeiliSearch-Rails" width="200" height="200" />
+  <img src="https://raw.githubusercontent.com/meilisearch/integration-guides/main/assets/logos/meilisearch_rails.svg" alt="Meilisearch-Rails" width="200" height="200" />
 </p>
 
-<h1 align="center">MeiliSearch Rails</h1>
+<h1 align="center">Meilisearch Rails</h1>
 
 <h4 align="center">
-  <a href="https://github.com/meilisearch/MeiliSearch">MeiliSearch</a> |
+  <a href="https://github.com/meilisearch/meilisearch">Meilisearch</a> |
   <a href="https://docs.meilisearch.com">Documentation</a> |
   <a href="https://slack.meilisearch.com">Slack</a> |
   <a href="https://roadmap.meilisearch.com/tabs/1-under-consideration">Roadmap</a> |
@@ -19,55 +19,48 @@
   <a href="https://app.bors.tech/repositories/33032"><img src="https://bors.tech/images/badge_small.svg" alt="Bors enabled"></a>
 </p>
 
-<p align="center">⚡ The MeiliSearch integration for Ruby on Rails 💎</p>
+<p align="center">⚡ The Meilisearch integration for Ruby on Rails 💎</p>
 
-**MeiliSearch Rails** is the MeiliSearch integration for Ruby on Rails developers.
+**Meilisearch Rails** is the Meilisearch integration for Ruby on Rails developers.
 
-**MeiliSearch** is an open-source search engine. [Discover what MeiliSearch is!](https://github.com/meilisearch/MeiliSearch)
+**Meilisearch** is an open-source search engine. [Discover what Meilisearch is!](https://github.com/meilisearch/meilisearch)
 
 ## Table of Contents <!-- omit in toc -->
 
 - [📖 Documentation](#-documentation)
-- [🤖 Compatibility with MeiliSearch](#-compatibility-with-meilisearch)
-- [🔧 Installation](#-installation)
-- [🔩 Settings](#-settings)
+- [🤖 Compatibility with Meilisearch](#-compatibility-with-meilisearch)
+- [🚀 Getting Started](#-getting-started)
+- [⚙️ Settings](#️-settings)
 - [🔍 Custom search](#-custom-search)
 - [🪛 Options](#-options)
-  - [MeiliSearch configuration & environment](#meilisearch-configuration-&-environment)
-    - [Custom index_uid](#custom-index_uid)
-    - [Per-environment index_uid](#per-environment-index_uid)
+  - [Meilisearch configuration & environment](#meilisearch-configuration--environment)
   - [Index configuration](#index-configuration)
     - [Custom attribute definition](#custom-attribute-definition)
     - [Custom primary key](#custom-primary-key)
     - [Conditional indexing](#conditional-indexing)
-      - [Target multiple indexes](#target-multiple-indexes)
     - [Share a single index](#share-a-single-index)
-    - [Queues & background jobs](#queues-&-background-jobs)
+    - [Queues & background jobs](#queues--background-jobs)
     - [Relations](#relations)
     - [Sanitize attributes](#sanitize-attributes)
     - [UTF-8 encoding](#utf-8-encoding)
   - [Manual operations](#manual-operations)
-    - [Indexing & deletion](#indexing-&-deletion)
+    - [Indexing & deletion](#indexing--deletion)
     - [Access the underlying index object](#access-the-underlying-index-object)
-  - [Development & testing](#development-&-testing)
-    - [Exceptions](#exceptions)
-    - [Testing](#testing)
-      - [Synchronous testing](#synchronous-testing)
-      - [Disable auto-indexing & auto-removal](#disable-auto-indexing-&-auto-removal)
-- [⚙️ Development Workflow and Contributing](#️-development-workflow-and-contributing)
-- [👏 Credits](#-credits)
+  - [Development & testing](#development--testing)
+- [⚙️ Development workflow & contributing](#️-development-workflow--contributing)
+- [👏  Credits](#--credits)
 
 ## 📖 Documentation
 
 The whole usage of this gem is detailed in this README.
 
-To learn more about MeiliSearch, check out our [Documentation](https://docs.meilisearch.com/learn/tutorials/getting_started.html) or our [API References](https://docs.meilisearch.com/reference/api/).
+To learn more about Meilisearch, check out our [Documentation](https://docs.meilisearch.com/learn/tutorials/getting_started.html) or our [API References](https://docs.meilisearch.com/reference/api/).
 
-## 🤖 Compatibility with MeiliSearch
+## 🤖 Compatibility with Meilisearch
 
-This package only guarantees the compatibility with the [version v0.21.0 of MeiliSearch](https://github.com/meilisearch/MeiliSearch/releases/tag/v0.21.0).
+This package only guarantees the compatibility with the [version v0.25.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.25.0).
 
-## 🔧 Installation
+## 🔧 Installation <!-- omit in toc -->
 
 This package requires Ruby version 2.6.0 or later and Rails 5.2 or later.
 
@@ -83,18 +76,18 @@ source 'https://rubygems.org'
 gem 'meilisearch-rails'
 ```
 
-### Run MeiliSearch <!-- omit in toc -->
+### Run Meilisearch <!-- omit in toc -->
 
-There are many easy ways to [download and run a MeiliSearch instance](https://docs.meilisearch.com/reference/features/installation.html#download-and-launch).
+There are many easy ways to [download and run a Meilisearch instance](https://docs.meilisearch.com/reference/features/installation.html#download-and-launch).
 
 For example, if you use Docker:
 
 ```bash
-docker pull getmeili/meilisearch:latest # Fetch the latest version of MeiliSearch image from Docker Hub
+docker pull getmeili/meilisearch:latest # Fetch the latest version of Meilisearch image from Docker Hub
 docker run -it --rm -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey
 ```
 
-NB: you can also download MeiliSearch from **Homebrew** or **APT**.
+NB: you can also download Meilisearch from **Homebrew** or **APT**.
 
 ## 🚀 Getting Started
 
@@ -103,9 +96,9 @@ NB: you can also download MeiliSearch from **Homebrew** or **APT**.
 Create a new file `config/initializers/meilisearch.rb` to setup your `MEILISEARCH_HOST` and `MEILISEARCH_API_KEY`
 
 ```ruby
-MeiliSearch.configuration = {
-  meilisearch_host: 'YourMeiliSearchHost',
-  meilisearch_api_key: 'YourMeiliSearchAPIKey',
+MeiliSearch::Rails.configuration = {
+  meilisearch_host: 'YourMeilisearchHost', # example: http://localhost:7700
+  meilisearch_api_key: 'YourMeilisearchAPIKey',
 }
 ```
 
@@ -117,11 +110,11 @@ The following code will create a `Book` index and add search capabilities to you
 
 ```ruby
 class Book < ActiveRecord::Base
-  include MeiliSearch
+  include MeiliSearch::Rails
 
   meilisearch do
-    attribute :title, :author # only the attributes 'title', and 'author' will be sent to MeiliSearch
-    # all attributes will be sent to MeiliSearch if block is left empty
+    attribute :title, :author # only the attributes 'title', and 'author' will be sent to Meilisearch
+    # all attributes will be sent to Meilisearch if block is left empty
   end
 end
 ```
@@ -135,7 +128,7 @@ We **strongly recommend the use of front-end search** through our [JavaScript AP
 Search returns ORM-compliant objects reloaded from your database.
 
 ```ruby
-# MeiliSearch is typo-tolerant:
+# Meilisearch is typo-tolerant:
 hits = Book.search('harry pottre')
 hits.each do |hit|
   puts hit.title
@@ -153,9 +146,9 @@ This gem supports:
 Specify the `:pagination_backend` in the configuration file:
 
 ```ruby
-MeiliSearch.configuration = {
-  meilisearch_host: 'YourMeiliSearchHost',
-  meilisearch_api_key: 'YourMeiliSearchAPIKey',
+MeiliSearch::Rails.configuration = {
+  meilisearch_host: 'YourMeilisearchHost',
+  meilisearch_api_key: 'YourMeilisearchAPIKey',
   pagination_backend: :kaminari #:will_paginate
 }
 ```
@@ -185,13 +178,13 @@ Book.search('harry potter', hitsPerPage: 10)
 
 #### Extra Configuration <!-- omit in toc -->
 
-Requests made to MeiliSearch may timeout and retry. To adapt the behavior to
+Requests made to Meilisearch may timeout and retry. To adapt the behavior to
 your needs, you can change the parameters during configuration:
 
 ```ruby
-MeiliSearch.configuration = {
-  meilisearch_host: 'YourMeiliSearchHost',
-  meilisearch_api_key: 'YourMeiliSearchAPIKey',
+MeiliSearch::Rails.configuration = {
+  meilisearch_host: 'YourMeilisearchHost',
+  meilisearch_api_key: 'YourMeilisearchAPIKey',
   timeout: 2,
   max_retries: 1,
 }
@@ -203,18 +196,20 @@ You can configure the index settings by adding them inside the `meilisearch` blo
 
 ```ruby
 class Book < ApplicationRecord
-  include MeiliSearch
+  include MeiliSearch::Rails
 
   meilisearch do
     searchable_attributes [:title, :author, :publisher, :description]
     filterable_attributes [:genre]
+    sortable_attributes [:title]
     ranking_rules [
       'proximity',
       'typo',
       'words',
       'attribute',
+      'sort',
       'exactness',
-      'desc(publication_year)'
+      'publication_year:desc'
     ]
     synonyms nyc: ['new york']
 
@@ -238,30 +233,41 @@ Book.search('Harry', attributesToHighlight: ['*'])
 👉 Don't forget that `attributes_to_highlight`, `attributes_to_crop`, and
 `crop_length` can be set up in the `meilisearch` block of your model.
 
+## 🔍 Sorted search
+
+As an example of how to use the sort option, here is how you could achieve
+returning all books sorted by title in ascending order:
+
+```ruby
+Book.search('*', sort: ['title:asc'])
+```
+
+👉 Don't forget to set up the `sortable_attributes` option in the `meilisearch` block of your model.
+
 ## 🪛 Options
 
-### MeiliSearch configuration & environment
+### Meilisearch configuration & environment
 
-#### Custom index_uid
+#### Custom index_uid <!-- omit in toc -->
 
 By default, the **index_uid** will be the class name, e.g. `Book`. You can customize the index_uid by using the `index_uid:` option.
 
 ```ruby
 class Book < ActiveRecord::Base
-  include MeiliSearch
+  include MeiliSearch::Rails
 
   meilisearch index_uid: 'MyCustomUID' do
   end
 end
 ```
 
-#### Index UID according to the environment
+#### Index UID according to the environment <!-- omit in toc -->
 
 You can suffix the index UID with the current Rails environment using the following option:
 
 ```ruby
 class Book < ActiveRecord::Base
-  include MeiliSearch
+  include MeiliSearch::Rails
 
   meilisearch per_environment: true do # The index UID will be "Book_#{Rails.env}"
   end
@@ -278,7 +284,7 @@ You can add a custom attribute by using the `add_attribute` option or by using a
 
 ```ruby
 class Author < ApplicationRecord
-  include MeiliSearch
+  include MeiliSearch::Rails
 
   meilisearch do
     attribute :first_name, :last_name
@@ -310,7 +316,7 @@ Note that the primary key must have a **unique value**.
 
 ```ruby
 class Book < ActiveRecord::Base
-  include MeiliSearch
+  include MeiliSearch::Rails
 
   meilisearch primary_key: 'ISBN' do
   end
@@ -323,7 +329,7 @@ As soon as you use those constraints, `add_documents` and `delete_documents` cal
 
 ```ruby
 class Book < ActiveRecord::Base
-  include MeiliSearch
+  include MeiliSearch::Rails
 
   meilisearch if: :published?, unless: :premium? do
   end
@@ -341,13 +347,13 @@ class Book < ActiveRecord::Base
   end
 end
 ```
-##### Target multiple indexes
+##### Target multiple indexes <!-- omit in toc -->
 
 You can index a record in several indexes using the `add_index` option:
 
 ```ruby
 class Book < ActiveRecord::Base
-  include MeiliSearch
+  include MeiliSearch::Rails
 
   PUBLIC_INDEX_UID = 'Books'
   SECURED_INDEX_UID = 'PrivateBooks'
@@ -375,7 +381,7 @@ You may want to share an index between several models. You'll need to ensure you
 
 ```ruby
 class Cat < ActiveRecord::Base
-  include MeiliSearch
+  include MeiliSearch::Rails
 
   meilisearch index_uid: 'Animals', primary_key: :ms_id do
   end
@@ -387,7 +393,7 @@ class Cat < ActiveRecord::Base
 end
 
 class Dog < ActiveRecord::Base
-  include MeiliSearch
+  include MeiliSearch::Rails
 
   meilisearch index_uid: 'Animals', primary_key: :ms_id do
   end
@@ -405,7 +411,7 @@ You can configure the auto-indexing & auto-removal process to use a queue to per
 
 ```ruby
 class Book < ActiveRecord::Base
-  include MeiliSearch
+  include MeiliSearch::Rails
 
   meilisearch enqueue: true do # ActiveJob will be triggered using a `meilisearch` queue
   end
@@ -420,7 +426,7 @@ With **ActiveJob**:
 
 ```ruby
 class Book < ActiveRecord::Base
-  include MeiliSearch
+  include MeiliSearch::Rails
 
   meilisearch enqueue: :trigger_job do
     attribute :title, :author, :description
@@ -436,7 +442,7 @@ class MyActiveJob < ApplicationJob
     if remove
       # The record has likely already been removed from your database so we cannot
       # use ActiveRecord#find to load it.
-      # We access the underlying MeiliSearch index object.
+      # We access the underlying Meilisearch index object.
       Book.index.delete_document(id)
     else
       # The record should be present.
@@ -450,7 +456,7 @@ With [**Sidekiq**](https://github.com/mperham/sidekiq):
 
 ```ruby
 class Book < ActiveRecord::Base
-  include MeiliSearch
+  include MeiliSearch::Rails
 
   meilisearch enqueue: :trigger_sidekiq_worker do
     attribute :title, :author, :description
@@ -466,7 +472,7 @@ class MySidekiqWorker
     if remove
       # The record has likely already been removed from your database so we cannot
       # use ActiveRecord#find to load it.
-      # We access the underlying MeiliSearch index object.
+      # We access the underlying Meilisearch index object.
       Book.index.delete_document(id)
     else
       # The record should be present.
@@ -480,7 +486,7 @@ With [**DelayedJob**](https://github.com/collectiveidea/delayed_job):
 
 ```ruby
 class Book < ActiveRecord::Base
-  include MeiliSearch
+  include MeiliSearch::Rails
 
   meilisearch enqueue: :trigger_delayed_job do
     attribute :title, :author, :description
@@ -504,7 +510,7 @@ Extend a change to a related record.
 
 ```ruby
 class Author < ActiveRecord::Base
-  include MeiliSearch
+  include MeiliSearch::Rails
 
   has_many :books
   # If your association uses belongs_to
@@ -514,7 +520,7 @@ class Author < ActiveRecord::Base
 end
 
 class Book < ActiveRecord::Base
-  include MeiliSearch
+  include MeiliSearch::Rails
 
   belongs_to :author
   after_touch :index!
@@ -533,7 +539,7 @@ With **Sequel**, you can use the `touch` plugin to propagate changes.
 ```ruby
 # app/models/author.rb
 class Author < Sequel::Model
-  include MeiliSearch
+  include MeiliSearch::Rails
 
   one_to_many :books
 
@@ -555,7 +561,7 @@ end
 
 # app/models/book.rb
 class Book < Sequel::Model
-  include MeiliSearch
+  include MeiliSearch::Rails
 
   many_to_one :author
   after_touch :index!
@@ -578,7 +584,7 @@ You can strip all HTML tags from your attributes with the `sanitize` option.
 
 ```ruby
 class Book < ActiveRecord::Base
-  include MeiliSearch
+  include MeiliSearch::Rails
 
   meilisearch sanitize: true do
   end
@@ -591,7 +597,7 @@ You can force the UTF-8 encoding of all your attributes using the `force_utf8_en
 
 ```ruby
 class Book < ActiveRecord::Base
-  include MeiliSearch
+  include MeiliSearch::Rails
 
   meilisearch force_utf8_encoding: true do
   end
@@ -637,13 +643,13 @@ index = Book.index
 
 ### Development & testing
 
-#### Exceptions
+#### Exceptions <!-- omit in toc -->
 
-You can disable exceptions that could be raised while trying to reach MeiliSearch's API by using the `raise_on_failure` option:
+You can disable exceptions that could be raised while trying to reach Meilisearch's API by using the `raise_on_failure` option:
 
 ```ruby
 class Book < ActiveRecord::Base
-  include MeiliSearch
+  include MeiliSearch::Rails
 
   # Only raise exceptions in development environment.
   meilisearch raise_on_failure: Rails.env.development? do
@@ -651,29 +657,29 @@ class Book < ActiveRecord::Base
 end
 ```
 
-#### Testing
+#### Testing <!-- omit in toc -->
 
-##### Synchronous testing
+##### Synchronous testing <!-- omit in toc -->
 
 You can force indexing and removing to be synchronous by setting the following option:
 
 ```ruby
 class Book < ActiveRecord::Base
-  include MeiliSearch
+  include MeiliSearch::Rails
 
   meilisearch synchronous: true do
   end
 end
 ```
-🚨 This is only recommended for testing purposes, the gem will call the `wait_for_pending_update` method that will stop your code execution until the asynchronous task has been processed by MeilSearch.
+🚨 This is only recommended for testing purposes, the gem will call the `wait_for_task` method that will stop your code execution until the asynchronous task has been processed by MeilSearch.
 
-##### Disable auto-indexing & auto-removal
+##### Disable auto-indexing & auto-removal <!-- omit in toc -->
 
 You can disable auto-indexing and auto-removing setting the following options:
 
 ```ruby
 class Book < ActiveRecord::Base
-  include MeiliSearch
+  include MeiliSearch::Rails
 
   meilisearch auto_index: false, auto_remove: false do
   end
@@ -701,4 +707,4 @@ The provided features and the code base is inspired by [algoliasearch-rails](htt
 
 <hr>
 
-**MeiliSearch** provides and maintains many **SDKs and Integration tools** like this one. We want to provide everyone with an **amazing search experience for any kind of project**. If you want to contribute, make suggestions, or just know what's going on right now, visit us in the [integration-guides](https://github.com/meilisearch/integration-guides) repository.
+**Meilisearch** provides and maintains many **SDKs and Integration tools** like this one. We want to provide everyone with an **amazing search experience for any kind of project**. If you want to contribute, make suggestions, or just know what's going on right now, visit us in the [integration-guides](https://github.com/meilisearch/integration-guides) repository.

data/Rakefile

@@ -2,16 +2,17 @@ require 'rubygems'
 require 'rake'
 
 require 'rdoc/task'
+
 Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+  version = File.exist?('VERSION') ? File.read('VERSION') : ''
 
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "MeiliSearch Rails #{version}"
+  rdoc.title = "Meilisearch Rails #{version}"
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-require "rspec/core/rake_task"
+require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/lib/meilisearch/rails/configuration.rb

@@ -0,0 +1,23 @@
+module MeiliSearch
+  module Rails
+    module Configuration
+      def configuration
+        raise NotConfigured if @_config.blank?
+
+        @_config
+      end
+
+      def configuration=(configuration)
+        @_config = configuration
+      end
+
+      def client
+        ::MeiliSearch::Client.new(
+          configuration[:meilisearch_host] || 'http://localhost:7700',
+          configuration[:meilisearch_api_key],
+          configuration.slice(:timeout, :max_retries)
+        )
+      end
+    end
+  end
+end

data/lib/meilisearch/rails/errors.rb

@@ -0,0 +1,14 @@
+module MeiliSearch
+  module Rails
+    class NoBlockGiven < StandardError; end
+
+    class BadConfiguration < StandardError; end
+
+    class NotConfigured < StandardError
+      def message
+        'Please configure Meilisearch. Set MeiliSearch::Rails.configuration = ' \
+          "{meilisearch_host: 'YOUR_MEILISEARCH_HOST', meilisearch_api_key: 'YOUR_API_KEY'}"
+      end
+    end
+  end
+end

data/lib/meilisearch/rails/ms_job.rb

@@ -0,0 +1,11 @@
+module MeiliSearch
+  module Rails
+    class MSJob < ::ActiveJob::Base
+      queue_as :meilisearch
+
+      def perform(record, method)
+        record.send(method)
+      end
+    end
+  end
+end

data/lib/meilisearch/rails/pagination/kaminari.rb

@@ -0,0 +1,48 @@
+unless defined? Kaminari
+  raise(MeiliSearch::BadConfiguration,
+        "Meilisearch: Please add 'kaminari' to your Gemfile to use kaminari pagination backend")
+end
+
+require 'kaminari/models/array_extension'
+
+module MeiliSearch
+  module Rails
+    module Pagination
+      class Kaminari < ::Kaminari::PaginatableArray
+        def initialize(array, options)
+          if RUBY_VERSION >= '3'
+            super(array, **options)
+          else
+            super(array, options)
+          end
+        end
+
+        def limit(_num)
+          # noop
+          self
+        end
+
+        def offset(_num)
+          # noop
+          self
+        end
+
+        class << self
+          def create(results, total_hits, options = {})
+            offset = ((options[:page] - 1) * options[:per_page])
+            array = new results, limit: options[:per_page], offset: offset, total_count: total_hits
+
+            if array.empty? && !results.empty?
+              # since Kaminari 0.16.0, you need to pad the results with nil values so it matches the offset param
+              # otherwise you'll get an empty array: https://github.com/amatsuda/kaminari/commit/29fdcfa8865f2021f710adaedb41b7a7b081e34d
+              results = ([nil] * offset) + results
+              array = new results, offset: offset, limit: options[:per_page], total_count: total_hits
+            end
+
+            array
+          end
+        end
+      end
+    end
+  end
+end