algolia 2.0.0.pre.beta.3 → 2.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47d18253040f91e77f82a815e90b4064c88aac2ddbacbe4c26b1dea81304d847
-  data.tar.gz: 530b601d76e6de0b4f252dc13bcce01f7446428f839cd22fb4b286a1b5a17f73
+  metadata.gz: e2ba367e6308158bc455c60a0d0a5c16fbb1ed4565aaa3a6b8d4cca3e16f0c0d
+  data.tar.gz: af53995633ba454c929265d5d81d311c67a99fcdd76e8eeec51f98aa8e89f778
 SHA512:
-  metadata.gz: 04c63a1fb49fcd66817e0b43f66c16b3cbe8bd044ca513409047f8709ab8cc757deb30cedaeafcddf831f98179efa9c21fdcbf4bb09a1641b9b5b7aa96d6fc8c
-  data.tar.gz: e552093cc4ab5827c8ab87e448856bfdbd68f113b8e321e928e66ceb03f8ecf96531aad902d256a6372336c9efeedd166e85165d63a0c83f0795de942a0b4eb7
+  metadata.gz: 896b3821ad99f02449f652090c6b4249a932d454bd03e58879c2fad030d6179480b208c36bd07003dd3c58f96cd7630e28aa1afa026cc83f907a3bcf015f2f02
+  data.tar.gz: bdc286d0c8df062b33fc6d25fd6d3d4348dc82cce74703d26a12d8374a91c5e378e3d7f03ff2d617a76beab88828a8004d3457997394df2a9832277ca308f411

data/.dockerignore

@@ -0,0 +1,38 @@
+# rspec failure tracking
+.rspec_status
+
+## MAC OS
+.DS_Store
+.idea/
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+.rvmrc
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+## PROJECT::SPECIFIC
+spec/integration_spec_conf.rb
+data.sqlite3
+
+debug.log

data/.gitignore

@@ -35,4 +35,6 @@ pkg
 Gemfile.lock
 spec/integration_spec_conf.rb
 data.sqlite3
+
 debug.log
+.ruby-version

data/CHANGELOG.md

@@ -0,0 +1,28 @@
+# ChangeLog
+
+## [Unreleased](https://github.com/algolia/algoliasearch-client-ruby/compare/2.0.4...master)
+
+## [2.0.4](https://github.com/algolia/algoliasearch-client-ruby/compare/2.0.3...2.0.4) (2021-01-05)
+
+### Fix
+- `app_api_key`: send opts with waitable method
+
+## [2.0.3](https://github.com/algolia/algoliasearch-client-ruby/compare/2.0.2...2.0.3) (2020-11-24)
+
+### Chore
+- Containerize the repo
+
+## [2.0.2](https://github.com/algolia/algoliasearch-client-ruby/compare/2.0.1...2.0.2) (2020-11-09)
+
+### Fix
+- Don't mutate index name on stripping
+
+## [2.0.1](https://github.com/algolia/algoliasearch-client-ruby/compare/2.0.0...2.0.1) (2020-11-02)
+
+### Fix
+- Simplify merge of headers in `Transport` class
+- `deserialize_settings` function to take into account `symbolize_keys` parameter
+
+## [2.0.0](https://github.com/algolia/algoliasearch-client-ruby/releases/tag/2.0.0) (2020-10-27)
+
+* Initial release of v2

data/CONTRIBUTING.MD

@@ -0,0 +1,184 @@
+<p align="center">
+  <a href="https://www.algolia.com">
+      <img alt="Algolia for Ruby" src="https://raw.githubusercontent.com/algolia/algoliasearch-client-common/master/banners/ruby.png" >
+    </a>
+</p>
+
+Hello and welcome to the contributing guide for algolia gem. Thanks for considering participating in our project 🙇
+
+If this guide does not contain what you are looking for and thus prevents you from contributing, don't hesitate to leave a message on the [community forum](https://discourse.algolia.com/) or to [open an issue](https://github.com/algolia/algoliasearch-client-ruby/issues).
+
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN TocDown TO UPDATE -->
+<!-- TocDown Begin -->
+* [Reporting an issue](#reporting-an-issue)
+* [The code contribution process](#the-code-contribution-process)
+* [Commit conventions](#commit-conventions)
+* [Branch organization](#branch-organization)
+* [Requirements](#requirements)
+* [Code structure](#code-structure)
+  * [The source algolia folder](#the-source-algolia-folder)
+* [Tests](#tests)
+* [Linting](#linting)
+<!-- TocDown End -->
+
+## Reporting an issue
+
+Opening an issue is very effective way to contribute because other users might also be impacted. We'll make sure to fix it quickly if it's technically feasible and doesn't have important side effects for other users.
+
+Before reporting an issue, first check that there is not an already open issue for the same topic using the [issues page](https://github.com/algolia/algoliasearch-client-ruby/issues). Don't hesitate to thumb up an issue that corresponds to the problem you have.
+
+It would be very helpful if you're able to add a test case that reproduces the issue. This could help us solve the issue faster.
+
+## The code contribution process
+
+The algolia gem is developed in Ruby ≥ 2.2.
+
+For any code contribution, you need to:
+
+- Fork and clone the project
+- Create a new branch for what you want to solve (fix/_issue-number_, feat/_name-of-the-feature_)
+- Make your changes
+- Open a pull request
+
+Depending on what you're working on, you might consider different [base branches](#branch-organization).
+
+Then:
+
+- Peer review of the pull request (by at least one of the core contributors)
+- Automatic checks ([tests](#tests), [commits](#commit-conventions), [linters](#linting))
+- When everything is green, one of the core contributors will merge your contribution 🚀
+
+## Commit conventions
+
+This project follows the [conventional changelog](https://conventionalcommits.org/) approach. This means that all commit messages should be formatted using the following scheme:
+
+```
+type(scope): description
+```
+
+In most cases, we use the following types:
+
+- `fix`: for any resolution of an issue (identified or not)
+- `feat`: for any new feature
+- `refactor`: for any code change that neither adds a feature nor fixes an issue
+- `docs`: for any documentation change or addition
+- `chore`: for anything that is not related to the library itself (doc, tooling)
+
+Even though the scope is optional, we try to fill it in as it helps us better understand the impact of a change. We either use the name of the widget/connector/component impacted or we use impact topic (e.g. `docs`, `tooling`, `deps`, `ci`).
+
+Finally, if your work is based on an issue on GitHub, please fill in the dedicated line in the PR template (read "[Closing issues using keywords](https://help.github.com/en/articles/closing-issues-using-keywords)").
+
+Some examples of valid commit messages (used as first lines):
+
+> - feat(account-client): add method XXX
+> - chore(deps): update dependency XXX to v3.0.7
+> - fix(search_user_ids): rename parameter clusterName
+> - chore: reword contributions guides
+
+## Branch organization
+
+The project is based on the classic GitHub flow:
+
+- `master` for the current version being worked on – Pull requests for bugs and feature related to the current major version should be created against this branch
+- `vX` for each major version (`X` being a number) – Pull requests for critical bug fixes should be created against this branch
+
+Most of the time, your pull requests should target the `master` branch.
+
+_Note that no new features will be developed or backported for the `vX` branches._
+
+## Requirements
+
+To run this project, you will need:
+
+- Ruby ≥ 2.2
+- [Bundler](https://bundler.io/)
+
+## 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.
+
+## Code structure
+
+Here are the main files and folders of the project
+
+```
+▸ lib/algolia/              << standalone clients and helpers classes
+▸ lib/test/                 << gathers the unit and integration tests
+  .rubocop.yml              << contains the rule used for the linter
+  algolia.gemspec           << gemspec file
+  CHANGELOG.md              << changelog file
+  CONTRIBUTING.md           << this file
+  Gemfile                   << dependencies needed to run the project locally
+  Rakefile                  << defines the different tasks to lint/test the project
+  README.md                 << the introduction of the project
+```
+
+### The lib/algolia folder
+
+```
+▸ lib/algolia/
+    ▸ config/       << the configurations associated with each clients 
+    ▸ enums/        << enumerables used accross the lib
+    ▸ http/         << the http layer logic
+    ▸ iterators/    << the iterators used for the browsing methods
+    ▸ responses/    << the waitable responses
+    ▸ transport/    << the transport layer logic
+```
+
+## Tests
+
+Our unit and integration tests are written with [Minitest](https://github.com/seattlerb/minitest), in the `test` syntax.
+
+To run all the tests at once:
+
+```sh
+bundle exec rake test:all
+```
+
+To run only the unit tests:
+
+```sh
+bundle exec rake test:unit
+```
+
+To run only the integration tests:
+
+```sh
+bundle exec rake test:integration
+```
+
+We ask that for each fix or feature submitted, you add at least one test demonstrating its behaviour. As you will need to use your own Algolia credentials to run them, we advise you to keep them short and use a small dataset, as well as using a mock requester anytime it's possible. If you encounter huge data overload because of testing, please reach out to [our support team](support@algolia.com).
+
+## Linting
+
+Linters help us maintain a consistent code base.
+
+If your editor support them, then you will see the errors directly there. You can also run them using your command line:
+
+```sh
+rake rubocop
+```
+
+However, we recommend that you use in your workflow pre-commit hooks, to avoid submitting code that might not pass the linting task setup in the CI. To use them,
+first download the gem `git-precommit`
+
+```sh
+gem install git-precommit
+```
+
+Then copy-paste the following content in a file called `pre-commit` in `.git/hooks/` 
+
+```sh
+#!/usr/bin/env sh
+
+function unstaged_changes {
+    ! git diff --quiet
+}
+
+if unstaged_changes; then
+    git stash save --keep-index "Performing partial commit against `git rev-parse HEAD`"
+fi
+
+exec time bundle exec rake precommit
+```

data/DOCKER_README.MD

@@ -0,0 +1,89 @@
+In this page you will find our recommended way of installing Docker on your machine. 
+This guide is made for OSX users.
+
+## Install docker
+
+First install Docker using [Homebrew](https://brew.sh/)
+```
+$ brew install docker
+```
+
+You can then install [Docker Desktop](https://docs.docker.com/get-docker/) if you wish, or use `docker-machine`. As we prefer the second option, we will only document this one.
+
+## Setup your docker
+
+Install `docker-machine`
+```
+$ brew install docker-machine
+```
+
+Then install [VirtualBox](https://www.virtualbox.org/) with [Homebrew Cask](https://github.com/Homebrew/homebrew-cask) to get a driver for your Docker machine
+```
+$ brew cask install virtualbox
+```
+
+You may need to enter your password and authorize the application in your `System Settings` > `Security & Privacy`.
+
+Create now a new machine, set it up as default and connect your shell to it (here we use zsh. The commands should anyway be displayed in each steps' output)
+
+```
+$ docker-machine create --driver virtualbox default
+$ docker-machine env default
+$ eval "$(docker-machine env default)"
+```
+
+Now you're all setup to use our provided Docker image!
+
+## Build the image
+
+```bash
+docker build -t algolia-ruby .
+```
+
+## Run the image
+
+You need to provide few environment variables at runtime to be able to run the [Common Test Suite](https://github.com/algolia/algoliasearch-client-specs/tree/master/common-test-suite).
+You can set them up directly in the command:
+
+```bash
+docker run -it --rm --env ALGOLIA_APP_ID=XXXXXX [...] -v $PWD:/app -w /app algolia-ruby bash
+```
+
+However, we advise you to export them in your `.bashrc` or `.zshrc`. That way, you can use [Docker's shorten syntax](https://docs.docker.com/engine/reference/commandline/run/#set-environment-variables--e---env---env-file) to set your variables.
+
+```bash
+### For external contributors, only the following env variables should be enough
+docker run -it --rm --env ALGOLIA_APPLICATION_ID_1 \
+                    --env ALGOLIA_ADMIN_KEY_1 \
+                    --env ALGOLIA_SEARCH_KEY_1 \
+-v $PWD:/app -w /app algolia-ruby bash
+
+### This is needed only to run the full test suite
+docker run -it --rm --env ALGOLIA_APPLICATION_ID_1 \
+                    --env ALGOLIA_ADMIN_KEY_1 \
+                    --env ALGOLIA_SEARCH_KEY_1 \
+                    --env ALGOLIA_APPLICATION_ID_2 \
+                    --env ALGOLIA_ADMIN_KEY_2 \
+                    --env ALGOLIA_APPLICATION_ID_MCM \
+                    --env ALGOLIA_ADMIN_KEY_MCM \
+-v $PWD:/app -w /app algolia-ruby bash
+```
+
+Once your container is running, any changes you make in your IDE are directly reflected in the container.
+
+To launch the tests, you can use one of the following commands
+```shell script
+# run only the unit tests
+bundle exec rake test:unit
+
+# run only the integration tests
+bundle exec rake test:integration
+
+# run the whole test suite
+bundle exec rake test:all
+
+# run a single test
+bundle exec rake test TEST=/full/path/to/test.rb TESTOPTS="--name=test_name"
+```
+
+Feel free to contact us if you have any questions.

data/Dockerfile

@@ -0,0 +1,7 @@
+FROM ruby:2.6.3
+
+RUN gem install bundler
+
+WORKDIR /app
+COPY . /app/
+RUN bundle install

data/README.md

@@ -6,9 +6,9 @@
   <h4 align="center">The perfect starting point to integrate <a href="https://algolia.com" target="_blank">Algolia</a> within your Ruby project</h4>
 
   <p align="center">
-    <a href="https://circleci.com/gh/algolia/algoliasearch-client-ruby/tree/release%2Fv2"><img src="https://circleci.com/gh/algolia/algoliasearch-client-ruby/tree/release%2Fv2.svg?style=shield" alt="CircleCI" /></a>
-    <a href="https://rubygems.org/gems/algoliasearch"><img src="https://badge.fury.io/rb/algoliasearch.svg" alt="Gem Version"></a>
-    <a href="https://rubygems.org/gems/algoliasearch"><img src="https://img.shields.io/badge/licence-MIT-blue.svg" alt="License"></a>
+    <a href="https://circleci.com/gh/algolia/algoliasearch-client-ruby"><img src="https://circleci.com/gh/algolia/algoliasearch-client-ruby.svg?style=shield" alt="CircleCI" /></a>
+    <a href="https://rubygems.org/gems/algolia"><img src="https://badge.fury.io/rb/algolia.svg" alt="Gem Version"></a>
+    <a href="https://rubygems.org/gems/algolia"><img src="https://img.shields.io/badge/licence-MIT-blue.svg" alt="License"></a>
   </p>
 </p>
 
@@ -18,39 +18,47 @@
   <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-client-ruby/issues" target="_blank">Report a bug</a>  •
+  <a href="https://www.algolia.com/doc/api-client/troubleshooting/faq/ruby/" target="_blank">FAQ</a>  •
   <a href="https://www.algolia.com/support" target="_blank">Support</a>
 </p>
 
 ## ✨ Features
 
 - Thin & minimal low-level HTTP client to interact with Algolia's API
-- Supports Ruby `^1.8.7`.
+- Supports Ruby `^2.2`.
 
 ## 💡 Getting Started
 
 First, install Algolia Ruby API Client via the [RubyGems](https://rubygems.org/) package manager:
 ```bash
-gem install algoliasearch
+gem install algolia
 ```
 
 Then, create objects on your index:
 
 
 ```ruby
-Algolia.init(application_id: 'YourApplicationID',
-             api_key:        'YourAPIKey')
-index = Algolia::Index.new('your_index_name')
+client = Algolia::Search::Client.create('YourApplicationID', 'YourAPIKey')
+index = client.init_index('your_index_name')
 
-index.save_objects([objectID:  1, name: 'Foo'])
+index.save_objects([objectID: 1, name: 'Foo'])
 ```
 
 Finally, you may begin searching a object using the `search` method:
 ```ruby
-objects = index.search('Fo')
+objects = index.search('Foo')
 ```
 
 For full documentation, visit the **[Algolia Ruby API Client](https://www.algolia.com/doc/api-client/getting-started/install/ruby/)**.
 
+## ❓ 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.
+
+## Upgrade from V1 to V2
+
+If you were using the v1 and wish to update to v2, please follow our [Upgrade Guide](upgrade_guide.md)
+
 ## 📄 License
 
 Algolia Ruby API Client is an open-sourced software licensed under the [MIT license](LICENSE.md).

data/SECURITY.md

@@ -0,0 +1,3 @@
+## Reporting a Vulnerability
+
+To report a security vulnerability, please use the [Algolia security email](security@algolia.com). Algolia will coordinate the fix and disclosure.

data/algolia.gemspec

@@ -12,14 +12,14 @@ Gem::Specification.new do |spec|
 
   spec.date        = Date.today
   spec.licenses    = ['MIT']
-  spec.summary     = 'A simple Ruby client for the algolia.com REST API (alpha release)'
-  spec.description = 'This is the alpha version of the upcoming v2 release of Algolia Client. Please keep on using the algoliasearch gem in the meantime.'
-  spec.homepage    = 'https://github.com/algolia/algoliasearch-client-ruby/tree/release/v2'
+  spec.summary     = 'A simple Ruby client for the algolia.com REST API'
+  spec.description = 'A simple Ruby client for the algolia.com REST API'
+  spec.homepage    = 'https://github.com/algolia/algoliasearch-client-ruby'
 
   spec.metadata = {
     'bug_tracker_uri' => 'https://github.com/algolia/algoliasearch-client-ruby/issues',
-    'documentation_uri' => 'http://www.rubydoc.info/gems/algolia',
-    'source_code_uri' => 'https://github.com/algolia/algoliasearch-client-ruby/tree/release/v2'
+    'documentation_uri' => 'https://www.algolia.com/doc/api-client/getting-started/install/ruby',
+    'source_code_uri' => 'https://github.com/algolia/algoliasearch-client-ruby'
   }
 
   # Specify which files should be added to the gem when it is released.
@@ -35,7 +35,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rubocop', '<= 0.82.0'
 
-  spec.add_dependency 'faraday', '~> 0.15'
+  spec.add_dependency 'faraday', ['>= 0.15', '< 2.0']
   spec.add_dependency 'multi_json', '~> 1.0'
   spec.add_dependency 'net-http-persistent'
 

data/lib/algolia/config/base_config.rb

@@ -34,8 +34,6 @@ module Algolia
       @connect_timeout     = opts[:connect_timeout] || Defaults::CONNECT_TIMEOUT
       @compression_type    = opts[:compression_type] || Defaults::NONE_ENCODING
       @symbolize_keys      = opts.has_key?(:symbolize_keys) ? opts[:symbolize_keys] : true
-      # used to avoid BC break on Rails integration, should not be documented
-      @use_latest_settings = opts.has_key?(:use_latest_settings) ? opts[:use_latest_settings] : true
     end
 
     def set_extra_header(key, value)

data/lib/algolia/helpers.rb

@@ -52,10 +52,8 @@ module Helpers
 
   # Support to convert old settings to their new names
   #
-  def deserialize_settings(data, use_latest_settings, symbolize_keys)
-    return data unless use_latest_settings
-
-    settings = symbolize_hash(data)
+  def deserialize_settings(data, symbolize_keys)
+    settings = data
     keys     = {
       attributesToIndex: 'searchableAttributes',
       numericAttributesToIndex: 'numericAttributesForFiltering',
@@ -63,6 +61,7 @@ module Helpers
     }
 
     keys.each do |deprecated_key, current_key|
+      deprecated_key = symbolize_keys ? deprecated_key : deprecated_key.to_s
       if settings.has_key?(deprecated_key)
         key           = symbolize_keys ? current_key.to_sym : current_key.to_s
         settings[key] = settings.delete(deprecated_key)

data/lib/algolia/search_client.rb

@@ -90,11 +90,11 @@ module Algolia
       # @return [Index] new Index instance
       #
       def init_index(index_name)
-        index_name.strip!
-        if index_name.empty?
+        stripped_index_name = index_name.strip
+        if stripped_index_name.empty?
           raise AlgoliaError, 'Please provide a valid index name'
         end
-        Index.new(index_name, @transporter, @config)
+        Index.new(stripped_index_name, @transporter, @config)
       end
 
       # List all indexes of the client
@@ -300,7 +300,7 @@ module Algolia
       # @return [AddApiKeyResponse]
       #
       def add_api_key!(acl, opts = {})
-        response = add_api_key(acl)
+        response = add_api_key(acl, opts)
 
         response.wait(opts)
       end

data/lib/algolia/search_index.rb

@@ -976,7 +976,7 @@ module Algolia
       def get_settings(opts = {})
         response = @transporter.read(:GET, path_encode('/1/indexes/%s/settings', @name) + handle_params({ getVersion: 2 }), {}, opts)
 
-        deserialize_settings(response, @config.use_latest_settings, @config.symbolize_keys)
+        deserialize_settings(response, @config.symbolize_keys)
       end
 
       # Update some index settings. Only specified settings are overridden

data/lib/algolia/transport/request_options.rb

@@ -34,7 +34,7 @@ module Algolia
       def add_headers(opts = {})
         unless opts[:headers].nil?
           opts[:headers].each do |opt, value|
-            @headers[opt.to_sym] = value
+            @headers[opt.to_s] = value
           end
           opts.delete(:headers)
         end

data/lib/algolia/transport/transport.rb

@@ -127,15 +127,12 @@ module Algolia
 
       # Generates headers from config headers and optional parameters
       #
-      # @option options [String] :headers
+      # @param request_options [RequestOptions]
       #
       # @return [Hash] merged headers
       #
       def generate_headers(request_options = {})
-        headers                                             = {}
-        extra_headers                                       = request_options.headers || {}
-        @config.headers.each { |key, val| headers[key.to_s] = val }
-        extra_headers.each { |key, val| headers[key.to_s]   = val }
+        headers = @config.headers.merge(request_options.headers)
         if request_options.compression_type == Defaults::GZIP_ENCODING
           headers['Accept-Encoding']  = Defaults::GZIP_ENCODING
         end

data/lib/algolia/version.rb

@@ -1,3 +1,3 @@
 module Algolia
-  VERSION = '2.0.0-beta.3'.freeze
+  VERSION = '2.0.4'.freeze
 end

data/test/algolia/integration/search_client_test.rb

@@ -215,6 +215,7 @@ class SearchClientTest < BaseTest
 
     def test_api_keys
       assert_equal ['search'], @api_key[:acl]
+      assert_equal 'A description', @api_key[:description]
 
       api_keys = @@search_client.list_api_keys[:keys].map do |key|
         key[:value]

data/test/algolia/unit/helpers_test.rb

@@ -18,35 +18,26 @@ class HelpersTest
         replicas: %w(index1 index2)
       }
 
-      deserialized_settings = deserialize_settings(old_settings, true, true)
+      deserialized_settings = deserialize_settings(old_settings, true)
       assert_equal new_settings, deserialized_settings
     end
 
-    def test_deserialize_settings_with_old_settings
-      old_settings = {
-        attributesToIndex: %w(attr1 attr2),
-        numericAttributesToIndex: %w(attr1 attr2),
-        slaves: %w(index1 index2)
-      }
-
-      deserialized_settings = deserialize_settings(old_settings, false, true)
-      assert_equal old_settings, deserialized_settings
-    end
-
     def test_deserialize_settings_with_string
       old_settings = {
         'attributesToIndex' => %w(attr1 attr2),
         'numericAttributesToIndex' => %w(attr1 attr2),
-        'slaves' => %w(index1 index2)
+        'slaves' => %w(index1 index2),
+        'minWordSizefor1Typo' => 1
       }
 
       new_settings = {
         'searchableAttributes' => %w(attr1 attr2),
         'numericAttributesForFiltering' => %w(attr1 attr2),
-        'replicas' => %w(index1 index2)
+        'replicas' => %w(index1 index2),
+        'minWordSizefor1Typo' => 1
       }
 
-      deserialized_settings = deserialize_settings(old_settings, true, false)
+      deserialized_settings = deserialize_settings(old_settings, false)
       assert_equal new_settings, deserialized_settings
     end
   end

data/upgrade_guide.md

@@ -229,7 +229,7 @@ client.search_user_ids('query', {clusterName: 'my-cluster', hitPerPage: 12, page
 #### `pending_mappings`
 New method to check the status of your clusters' migration or user creation.
 ```ruby
-client.pending_mapping?({ retrieveMappings: true })
+client.pending_mappings?({ retrieveMappings: true })
 ``` 
 
 #### `get_logs`

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algolia
 version: !ruby/object:Gem::Version
-  version: 2.0.0.pre.beta.3
+  version: 2.0.4
 platform: ruby
 authors:
 - Algolia
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-21 00:00:00.000000000 Z
+date: 2021-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -56,16 +56,22 @@ dependencies:
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.15'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.15'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -178,8 +184,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: This is the alpha version of the upcoming v2 release of Algolia Client.
-  Please keep on using the algoliasearch gem in the meantime.
+description: A simple Ruby client for the algolia.com REST API
 email:
 - support@algolia.com
 executables: []
@@ -187,16 +192,22 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
+- ".dockerignore"
 - ".github/ISSUE_TEMPLATE.md"
 - ".github/PULL_REQUEST_TEMPLATE.md"
 - ".gitignore"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- CONTRIBUTING.MD
+- DOCKER_README.MD
+- Dockerfile
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
+- SECURITY.md
 - Steepfile
 - algolia.gemspec
 - bin/console
@@ -271,13 +282,13 @@ files:
 - test/algolia/unit/user_agent_test.rb
 - test/test_helper.rb
 - upgrade_guide.md
-homepage: https://github.com/algolia/algoliasearch-client-ruby/tree/release/v2
+homepage: https://github.com/algolia/algoliasearch-client-ruby
 licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/algolia/algoliasearch-client-ruby/issues
-  documentation_uri: http://www.rubydoc.info/gems/algolia
-  source_code_uri: https://github.com/algolia/algoliasearch-client-ruby/tree/release/v2
+  documentation_uri: https://www.algolia.com/doc/api-client/getting-started/install/ruby
+  source_code_uri: https://github.com/algolia/algoliasearch-client-ruby
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -289,14 +300,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
-summary: A simple Ruby client for the algolia.com REST API (alpha release)
+summary: A simple Ruby client for the algolia.com REST API
 test_files:
 - test/algolia/integration/account_client_test.rb
 - test/algolia/integration/analytics_client_test.rb