Merge #425

425: Changes related to the next Meilisearch release (v1.1.0) r=bidoubiwa a=meili-bot

Related to this issue: meilisearch/integration-guides#251

This PR:
- gathers the changes related to the next Meilisearch release (v1.1.0) so that this package is ready when the official release is out.
- should pass the tests against the [latest pre-release of Meilisearch](https://github.com/meilisearch/meilisearch/releases).
- might eventually contain test failures until the Meilisearch v1.1.0 is out.

⚠️ This PR should NOT be merged until the next release of Meilisearch (v1.1.0) is out.

_This PR is auto-generated for the [pre-release week](https://github.com/meilisearch/integration-guides/blob/main/resources/pre-release-week.md) purpose._


Co-authored-by: meili-bot <[email protected]>
Co-authored-by: Bruno Casali <[email protected]>

Author: 3 people

.rubocop_todo.yml

@@ -1,29 +1,29 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2022-07-27 15:08:15 UTC using RuboCop version 1.32.0.
+# on 2023-03-30 12:31:09 UTC using RuboCop version 1.48.1.
 # 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
 # versions of RuboCop, may require this file to be generated again.
 
 # Offense count: 1
 # This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: Include.
+# Configuration parameters: Severity, Include.
 # Include: **/*.gemspec
 Gemspec/RequireMFA:
   Exclude:
     - 'meilisearch.gemspec'
 
-# Offense count: 46
-# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
-# IgnoredMethods: refine
+# Offense count: 45
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+# AllowedMethods: refine
 Metrics/BlockLength:
-  Max: 626
+  Max: 624
 
 # Offense count: 2
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
-  Max: 317
+  Max: 318
 
 # Offense count: 1
 # Configuration parameters: Max, CountKeywordArgs.

lib/meilisearch.rb

@@ -3,6 +3,7 @@
 require 'meilisearch/version'
 require 'meilisearch/utils'
 require 'meilisearch/http_request'
+require 'meilisearch/multi_search'
 require 'meilisearch/tenant_token'
 require 'meilisearch/task'
 require 'meilisearch/client'

lib/meilisearch/client.rb

@@ -3,6 +3,7 @@
 module MeiliSearch
   class Client < HTTPRequest
     include MeiliSearch::TenantToken
+    include MeiliSearch::MultiSearch
 
     ### INDEXES
 

lib/meilisearch/index.rb

@@ -96,9 +96,13 @@ def add_documents_ndjson(documents, primary_key = nil)
     alias replace_documents_ndjson add_documents_ndjson
     alias add_or_replace_documents_ndjson add_documents_ndjson
 
-    def add_documents_csv(documents, primary_key = nil)
+    def add_documents_csv(documents, primary_key = nil, delimiter = nil)
       options = { headers: { 'Content-Type' => 'text/csv' }, convert_body?: false }
-      http_post "/indexes/#{@uid}/documents", documents, { primaryKey: primary_key }.compact, options
+
+      http_post "/indexes/#{@uid}/documents", documents, {
+        primaryKey: primary_key,
+        csvDelimiter: delimiter
+      }.compact, options
     end
     alias replace_documents_csv add_documents_csv
     alias add_or_replace_documents_csv add_documents_csv

lib/meilisearch/multi_search.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module MeiliSearch
+  module MultiSearch
+    def multi_search(data)
+      body = Utils.transform_attributes(data)
+
+      http_post '/multi-search', queries: body
+    end
+  end
+end

spec/meilisearch/client/multi_search_spec.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+RSpec.describe 'MeiliSearch::Client - Multiple Index Search' do
+  before do
+    client.create_index('books')
+    task = client.create_index('movies')
+    client.wait_for_task(task['taskUid'])
+  end
+
+  it 'does a custom search with two different indexes' do
+    response = client.multi_search([
+                                     { index_uid: 'books', q: 'prince' },
+                                     { index_uid: 'movies', q: 'prince' }
+                                   ])
+
+    expect(response['results'].count).to eq(2)
+    expect(response['results'][0]['estimatedTotalHits']).to eq(0)
+    expect(response['results'][1]['estimatedTotalHits']).to eq(0)
+  end
+end

spec/meilisearch/index/documents_spec.rb

@@ -78,6 +78,23 @@
         expect(index.documents['results'].count).to eq(3)
       end
 
+      it 'adds CSV documents (as an array of documents with a different separator)' do
+        documents = <<~CSV
+          "objectRef:number"|"title:string"|"comment:string"
+          "1239"|"Pride and Prejudice"|"A great book"
+          "4569"|"Le Petit Prince"|"A french book"
+          "49"|"Harry Potter and the Half-Blood Prince"|"The best book"
+        CSV
+
+        response = index.add_documents_csv(documents, 'objectRef', '|')
+        index.wait_for_task(response['taskUid'])
+
+        expect(index.documents['results'].count).to eq(3)
+        expect(index.documents['results'][1]['objectRef']).to eq(4569)
+        expect(index.documents['results'][1]['title']).to eq('Le Petit Prince')
+        expect(index.documents['results'][1]['comment']).to eq('A french book')
+      end
+
       it 'adds documents in a batch (as a array of documents)' do
         task = index.add_documents_in_batches(documents, 5)
         expect(task).to be_a(Array)

spec/meilisearch/index/search/facets_distribution_spec.rb

@@ -12,7 +12,8 @@
     response = index.search('prinec', facets: ['genre', 'author'])
     expect(response.keys).to contain_exactly(
       *DEFAULT_SEARCH_RESPONSE_KEYS,
-      'facetDistribution'
+      'facetDistribution',
+      'facetStats'
     )
     expect(response['estimatedTotalHits']).to eq(2)
     expect(response['facetDistribution'].keys).to contain_exactly('genre', 'author')
@@ -27,7 +28,8 @@
     response = index.search('', facets: ['genre', 'author'])
     expect(response.keys).to contain_exactly(
       *DEFAULT_SEARCH_RESPONSE_KEYS,
-      'facetDistribution'
+      'facetDistribution',
+      'facetStats'
     )
     expect(response['estimatedTotalHits']).to eq(documents.count)
     expect(response['facetDistribution'].keys).to contain_exactly('genre', 'author')
@@ -42,7 +44,8 @@
     response = index.search('', facets: ['year'])
     expect(response.keys).to contain_exactly(
       *DEFAULT_SEARCH_RESPONSE_KEYS,
-      'facetDistribution'
+      'facetDistribution',
+      'facetStats'
     )
     expect(response['estimatedTotalHits']).to eq(documents.count)
     expect(response['facetDistribution'].keys).to contain_exactly('year')

spec/meilisearch/index/search/multi_params_spec.rb

@@ -66,9 +66,11 @@
     response = index.update_filterable_attributes(['genre'])
     index.wait_for_task(response['taskUid'])
     response = index.search('prinec', facets: ['genre'], limit: 1)
+
     expect(response.keys).to contain_exactly(
       *DEFAULT_SEARCH_RESPONSE_KEYS,
-      'facetDistribution'
+      'facetDistribution',
+      'facetStats'
     )
     expect(response['estimatedTotalHits']).to eq(2)
     expect(response['hits'].count).to eq(1)

spec/meilisearch/utils_spec.rb

@@ -20,4 +20,30 @@
       expect(data).to eq({ 'date' => '2012-12-21T19:05:00+00:00' })
     end
   end
+
+  describe '.transform_attributes' do
+    it 'transforms snake_case into camelCased keys' do
+      data = described_class.transform_attributes({
+                                                    index_name: 'books',
+                                                    my_UID: '123'
+                                                  })
+
+      expect(data).to eq({ 'indexName' => 'books', 'myUid' => '123' })
+    end
+
+    it 'transforms snake_case into camel cased keys from array' do
+      data = described_class
+             .transform_attributes([
+                                     { index_uid: 'books', q: 'prince' },
+                                     { index_uid: 'movies', q: 'prince' }
+                                   ])
+
+      expect(data).to eq(
+        [
+          { 'indexUid' => 'books', 'q' => 'prince' },
+          { 'indexUid' => 'movies', 'q' => 'prince' }
+        ]
+      )
+    end
+  end
 end