Merge branch 'main' into add-add-document-methods-by-its-type

thicolares · thicolares · commit ca5d7c57a138 · 2021-11-21T14:41:35.000-05:00
# Conflicts:
#	.rubocop_todo.yml
#	lib/meilisearch/http_request.rb
#	spec/meilisearch/index/documents_spec.rb
diff --git a/.github/release-draft-template.yml b/.github/release-draft-template.yml
@@ -8,11 +8,15 @@ version-resolver:
       - 'breaking-change'
   default: patch
 categories:
-  - title: 'Breaking changes ⚠️'
+  - title: '⚠️ Breaking changes'
     label: 'breaking-change'
+  - title: '🚀 Enhancements'
+    label: 'enhancement'
+  - title: '🐛 Bug Fixes'
+    label: 'bug'
+  - title: '🔒 Security'
+    label: 'security'
 template: |
-  ## Changes
-
   $CHANGES
 
   Thanks again to $CONTRIBUTORS! 🎉
@@ -27,3 +31,5 @@ replacers:
     replace: ''
   - search: '/(?:and )?@meili-bot,?/g'
     replace: ''
+  - search: '/(?:and )?@meili-bors(?:\[bot\])?,?/g'
+    replace: ''
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -20,3 +20,6 @@ Style/SymbolArray:
 
 Style/WordArray:
   EnforcedStyle: brackets
+
+Style/Documentation:
+  Enabled: false
diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml
@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2021-10-27 18:13:40 UTC using RuboCop version 1.22.1.
+# on 2021-11-18 03:06:45 UTC using RuboCop version 1.23.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -16,39 +16,24 @@ Gemspec/DateAssignment:
 
 # Offense count: 1
 # Cop supports --auto-correct.
-Layout/HeredocIndentation:
+# Configuration parameters: Include.
+# Include: **/*.gemspec
+Gemspec/RequireMFA:
   Exclude:
-    - 'spec/meilisearch/index/documents_spec.rb'
+    - 'meilisearch.gemspec'
 
 # Offense count: 32
 # Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
 # IgnoredMethods: refine
 Metrics/BlockLength:
-  Max: 498
+  Max: 512
 
-# Offense count: 2
+# Offense count: 1
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
-  Max: 289
-
-# Offense count: 1
-# Configuration parameters: Max, CountKeywordArgs.
-Metrics/ParameterLists:
-  MaxOptionalParameters: 4
+  Max: 271
 
 # Offense count: 2
 Naming/AccessorMethodName:
   Exclude:
     - 'lib/meilisearch/index.rb'
-
-# Offense count: 7
-# Configuration parameters: AllowedConstants.
-Style/Documentation:
-  Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'
-    - 'lib/meilisearch.rb'
-    - 'lib/meilisearch/client.rb'
-    - 'lib/meilisearch/error.rb'
-    - 'lib/meilisearch/http_request.rb'
-    - 'lib/meilisearch/index.rb'
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -4,7 +4,6 @@ First of all, thank you for contributing to MeiliSearch! The goal of this docume
 
 <!-- MarkdownTOC autolink="true" style="ordered" indent="   " -->
 
-- [Hacktoberfest](#hacktoberfest)
 - [Assumptions](#assumptions)
 - [How to Contribute](#how-to-contribute)
 - [Development Workflow](#development-workflow)
@@ -13,16 +12,6 @@ First of all, thank you for contributing to MeiliSearch! The goal of this docume
 
 <!-- /MarkdownTOC -->
 
-## Hacktoberfest
-
-It's [Hacktoberfest month](https://blog.meilisearch.com/contribute-hacktoberfest-2021/)! 🥳
-
-🚀 If your PR gets accepted it will count into your participation to Hacktoberfest!
-
-✅ To be accepted it has either to have been merged, approved or tagged with the `hacktoberfest-accepted` label.
-
-🧐 Don't forget to check the [quality standards](https://hacktoberfest.digitalocean.com/resources/qualitystandards)! Low-quality PRs might get marked as `spam` or `invalid`, and will not count toward your participation in Hacktoberfest.
-
 ## Assumptions
 
 1. **You're familiar with [GitHub](https://github.com) and the [Pull Request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests)(PR) workflow.**
@@ -151,7 +140,7 @@ Some notes on GitHub PRs:
 
 - [Convert your PR as a draft](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/changing-the-stage-of-a-pull-request) if your changes are a work in progress: no one will review it until you pass your PR as ready for review.<br>
   The draft PR can be very useful if you want to show that you are working on something and make your work visible.
-- The branch related to the PR must be **up-to-date with `main`** before merging. Fortunately, this project [integrates a bot](https://github.com/meilisearch/integration-guides/blob/main/guides/bors.md) to automatically enforce this requirement without the PR author having to do it manually.
+- The branch related to the PR must be **up-to-date with `main`** before merging. Fortunately, this project [integrates a bot](https://github.com/meilisearch/integration-guides/blob/main/resources/bors.md) to automatically enforce this requirement without the PR author having to do it manually.
 - All PRs must be reviewed and approved by at least one maintainer.
 - The PR title should be accurate and descriptive of the changes. The title of the PR will be indeed automatically added to the next [release changelogs](https://github.com/meilisearch/meilisearch-ruby/releases/).
 
@@ -162,24 +151,24 @@ MeiliSearch tools follow the [Semantic Versioning Convention](https://semver.org
 ### Automation to Rebase and Merge the PRs <!-- omit in toc -->
 
 This project integrates a bot that helps us manage pull requests merging.<br>
-_[Read more about this](https://github.com/meilisearch/integration-guides/blob/main/guides/bors.md)._
+_[Read more about this](https://github.com/meilisearch/integration-guides/blob/main/resources/bors.md)._
 
 ### Automated Changelogs <!-- omit in toc -->
 
 This project integrates a tool to create automated changelogs.<br>
-_[Read more about this](https://github.com/meilisearch/integration-guides/blob/main/guides/release-drafter.md)._
+_[Read more about this](https://github.com/meilisearch/integration-guides/blob/main/resources/release-drafter.md)._
 
 ### How to Publish the Release <!-- omit in toc -->
 
-⚠️ Before doing anything, make sure you got through the guide about [Releasing an Integration](https://github.com/meilisearch/integration-guides/blob/main/guides/integration-release.md).
+⚠️ Before doing anything, make sure you got through the guide about [Releasing an Integration](https://github.com/meilisearch/integration-guides/blob/main/resources/integration-release.md).
 
 Make a PR modifying the file [`lib/meilisearch/version.rb`](/lib/meilisearch/version.rb) with the right version.
 
 ```ruby
 VERSION = 'X.X.X'
 ```
 
-Once the changes are merged on `main`, you can publish the current draft release via the [GitHub interface](https://github.com/meilisearch/meilisearch-ruby/releases).
+Once the changes are merged on `main`, you can publish the current draft release via the [GitHub interface](https://github.com/meilisearch/meilisearch-ruby/releases): on this page, click on `Edit` (related to the draft release) > update the description (be sure you apply [these recommandations](https://github.com/meilisearch/integration-guides/blob/main/resources/integration-release.md#writting-the-release-description)) > when you are ready, click on `Publish release`.
 
 GitHub Actions will be triggered and push the package to [RubyGems](https://rubygems.org/gems/meilisearch).
 
diff --git a/Gemfile b/Gemfile
@@ -14,5 +14,5 @@ group :development, :test do
 end
 
 group :development do
-  gem 'rubocop', '~> 1.22.1', require: false
+  gem 'rubocop', '~> 1.23.0', require: false
 end
diff --git a/README.md b/README.md
@@ -198,7 +198,7 @@ JSON output:
 
 ## 🤖 Compatibility with MeiliSearch
 
-This package only guarantees the compatibility with the [version v0.23.0 of MeiliSearch](https://github.com/meilisearch/MeiliSearch/releases/tag/v0.23.0).
+This package only guarantees the compatibility with the [version v0.24.0 of MeiliSearch](https://github.com/meilisearch/MeiliSearch/releases/tag/v0.24.0).
 
 ## 💡 Learn More
 
diff --git a/lib/meilisearch.rb b/lib/meilisearch.rb
@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'meilisearch/version'
+require 'meilisearch/utils'
 require 'meilisearch/client'
 require 'meilisearch/index'
 
diff --git a/lib/meilisearch/client.rb b/lib/meilisearch/client.rb
@@ -20,7 +20,8 @@ def indexes
     # client.create_index('indexUID')
     # client.create_index('indexUID', primaryKey: 'id')
     def create_index(index_uid, options = {})
-      body = options.merge(uid: index_uid)
+      body = Utils.transform_attributes(options.merge(uid: index_uid))
+
       index_hash = http_post '/indexes', body
       index_object(index_hash['uid'], index_hash['primaryKey'])
     end
diff --git a/lib/meilisearch/error.rb b/lib/meilisearch/error.rb
@@ -29,10 +29,10 @@ def initialize(http_code, http_message, http_body)
 
     def get_meilisearch_error_info(http_body)
       @http_body = JSON.parse(http_body)
-      @ms_code = @http_body['errorCode']
+      @ms_code = @http_body['code']
       @ms_message = @http_body['message']
-      @ms_type = @http_body['errorType']
-      @ms_link = @http_body['errorLink']
+      @ms_type = @http_body['type']
+      @ms_link = @http_body['link']
     rescue JSON::ParserError
       # We might receive a JSON::ParserError when, for example, MeiliSearch is running behind
       # some proxy (ELB or Nginx, for example), and the request timeouts, returning us
diff --git a/lib/meilisearch/http_request.rb b/lib/meilisearch/http_request.rb
@@ -85,8 +85,6 @@ def clone_options(options)
       cloned_options
     end
 
-    SNAKE_CASE = /[^a-zA-Z0-9]+(.)/.freeze
-
     def send_request(http_method, relative_path, query_params: nil, body: nil, options: {})
       config = http_config(query_params, body, options)
       begin
@@ -98,7 +96,7 @@ def send_request(http_method, relative_path, query_params: nil, body: nil, optio
     end
 
     def http_config(query_params, body, options)
-      body = transform_attributes(body).to_json if options[:transform_body?] == true
+      body = body.to_json if options[:transform_body?] == true
       {
         headers: options[:headers],
         query: query_params,
@@ -108,25 +106,6 @@ def http_config(query_params, body, options)
       }.compact
     end
 
-    def transform_attributes(body)
-      case body
-      when Array
-        body.map { |item| transform_attributes(item) }
-      when Hash
-        parse(body)
-      else
-        body
-      end
-    end
-
-    def parse(body)
-      body
-        .transform_keys(&:to_s)
-        .transform_keys do |key|
-          key.include?('_') ? key.downcase.gsub(SNAKE_CASE, &:upcase).gsub('_', '') : key
-        end
-    end
-
     def validate(response)
       raise ApiError.new(response.code, response.message, response.body) unless response.success?
 
diff --git a/lib/meilisearch/index.rb b/lib/meilisearch/index.rb
@@ -31,8 +31,9 @@ def fetch_raw_info
     end
 
     def update(body)
-      index_hash = http_put indexes_path(id: @uid), body
+      index_hash = http_put indexes_path(id: @uid), Utils.transform_attributes(body)
       set_base_properties index_hash
+
       self
     end
 
@@ -65,7 +66,7 @@ def document(document_id)
     alias get_one_document document
 
     def documents(options = {})
-      http_get "/indexes/#{@uid}/documents", options
+      http_get "/indexes/#{@uid}/documents", Utils.transform_attributes(options)
     end
     alias get_documents documents
 
@@ -189,8 +190,9 @@ def delete_all_documents!
     ### SEARCH
 
     def search(query, options = {})
-      parsed_options = options.compact
-      http_post "/indexes/#{@uid}/search", { q: query.to_s }.merge(parsed_options)
+      parsed_options = Utils.transform_attributes({ q: query.to_s }.merge(options.compact))
+
+      http_post "/indexes/#{@uid}/search", parsed_options
     end
 
     ### UPDATES
@@ -250,7 +252,7 @@ def settings
     alias get_settings settings
 
     def update_settings(settings)
-      http_post "/indexes/#{@uid}/settings", settings
+      http_post "/indexes/#{@uid}/settings", Utils.transform_attributes(settings)
     end
     alias settings= update_settings
 
diff --git a/lib/meilisearch/utils.rb b/lib/meilisearch/utils.rb
@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module MeiliSearch
+  module Utils
+    SNAKE_CASE = /[^a-zA-Z0-9]+(.)/.freeze
+
+    def self.transform_attributes(body)
+      case body
+      when Array
+        body.map { |item| transform_attributes(item) }
+      when Hash
+        parse(body)
+      else
+        body
+      end
+    end
+
+    def self.parse(body)
+      body
+        .transform_keys(&:to_s)
+        .transform_keys do |key|
+          key.include?('_') ? key.downcase.gsub(SNAKE_CASE, &:upcase).gsub('_', '') : key
+        end
+    end
+
+    private_class_method :parse
+  end
+end
diff --git a/lib/meilisearch/version.rb b/lib/meilisearch/version.rb
@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MeiliSearch
-  VERSION = '0.16.1'
+  VERSION = '0.17.2'
 end
diff --git a/meilisearch.gemspec b/meilisearch.gemspec
@@ -19,7 +19,8 @@ Gem::Specification.new do |s|
     'lib/meilisearch/http_request.rb',
     'lib/meilisearch/client.rb',
     'lib/meilisearch/index.rb',
-    'lib/meilisearch/version.rb'
+    'lib/meilisearch/version.rb',
+    'lib/meilisearch/utils.rb'
   ]
 
   s.required_ruby_version = '>= 2.6.0'
diff --git a/spec/meilisearch/client/dumps_spec.rb b/spec/meilisearch/client/dumps_spec.rb
@@ -20,7 +20,7 @@
   it 'fails to get dump status without uid' do
     expect do
       client.dump_status('uid_not_exists')
-    end.to raise_meilisearch_api_error_with(404, 'not_found', 'invalid_request_error')
+    end.to raise_meilisearch_api_error_with(404, 'dump_not_found', 'invalid_request')
   end
 
   it 'works with method aliases' do
diff --git a/spec/meilisearch/client/indexes_spec.rb b/spec/meilisearch/client/indexes_spec.rb
@@ -56,15 +56,15 @@
 
         expect do
           client.create_index('existing_index')
-        end.to raise_meilisearch_api_error_with(400, 'index_already_exists', 'invalid_request_error')
+        end.to raise_meilisearch_api_error_with(409, 'index_already_exists', 'invalid_request')
       end
     end
 
     context 'when the uid format is invalid' do
       it 'raises an error' do
         expect do
           client.create_index('two words')
-        end.to raise_meilisearch_api_error_with(400, 'invalid_index_uid', 'invalid_request_error')
+        end.to raise_meilisearch_api_error_with(400, 'invalid_index_uid', 'invalid_request')
       end
     end
   end
diff --git a/spec/meilisearch/client/keys_spec.rb b/spec/meilisearch/client/keys_spec.rb
@@ -15,22 +15,22 @@
     new_client = MeiliSearch::Client.new(URL, public_key)
     expect do
       new_client.index(random_uid).settings
-    end.to raise_meilisearch_api_error_with(403, 'invalid_token', 'authentication_error')
+    end.to raise_meilisearch_api_error_with(403, 'invalid_api_key', 'auth')
   end
 
   it 'fails to get keys if private key used' do
     private_key = client.keys['private']
     new_client = MeiliSearch::Client.new(URL, private_key)
     expect do
       new_client.keys
-    end.to raise_meilisearch_api_error_with(403, 'invalid_token', 'authentication_error')
+    end.to raise_meilisearch_api_error_with(403, 'invalid_api_key', 'auth')
   end
 
   it 'fails to search if no key used' do
     new_client = MeiliSearch::Client.new(URL)
     expect do
       new_client.index(random_uid).settings
-    end.to raise_meilisearch_api_error_with(401, 'missing_authorization_header', 'authentication_error')
+    end.to raise_meilisearch_api_error_with(401, 'missing_authorization_header', 'auth')
   end
 
   it 'succeeds to search when using public key' do
diff --git a/spec/meilisearch/index/base_spec.rb b/spec/meilisearch/index/base_spec.rb
diff --git a/spec/meilisearch/index/documents_spec.rb b/spec/meilisearch/index/documents_spec.rb
diff --git a/spec/meilisearch/index/settings_spec.rb b/spec/meilisearch/index/settings_spec.rb
diff --git a/spec/support/exceptions_helpers.rb b/spec/support/exceptions_helpers.rb
