Bump MeiliSearch to v0.13.0 (#74)

* Update README.md

* Remove sysinfo routes (#75)

* Remove sysinfo routes

* Remove sys info in code samples

* Update settings following the settings behavior changes on MeiliSearch (#78)

* Update settings following the settings behavior changes on MeiliSearch
* Remove acceptNewFields examples in code samples

* Use POST instead of GET in search method (#77)

Add tests for placeholder

Author: curquiza

.code-samples.meilisearch.yaml

@@ -43,15 +43,11 @@ reset_searchable_attributes_1: |-
 get_displayed_attributes_1: |-
 update_displayed_attributes_1: |-
 reset_displayed_attributes_1: |-
-get_accept_new_fields_1: |-
-update_accept_new_fields_1: |-
 get_index_stats_1: |-
 get_indexes_stats_1: |-
 get_health_1: |-
 update_health_1: |-
 get_version_1: |-
-get_pretty_sys_info_1: |-
-get_sys_info_1: |-
 distinct_attribute_guide_1: |-
 field_properties_guide_searchable_1: |-
 field_properties_guide_displayed_1: |-
@@ -74,7 +70,6 @@ settings_guide_ranking_rules_1: |-
 settings_guide_distinct_1: |-
 settings_guide_searchable_1: |-
 settings_guide_displayed_1: |-
-settings_guide_accept_new_fields_1: |-
 add_movies_json_1: |-
 documents_guide_add_movie_1: |-
 search_guide_1: |-

README.md

@@ -109,8 +109,7 @@ Output:
 ## 🤖 Compatibility with MeiliSearch
 
 This package is compatible with the following MeiliSearch versions:
-- `v0.12.X`
-- `v0.11.X`
+- `v0.13.X`
 
 ## 🎬 Examples
 

lib/meilisearch/client.rb

@@ -73,14 +73,6 @@ def version
       http_get '/version'
     end
 
-    def sysinfo
-      http_get '/sys-info'
-    end
-
-    def pretty_sysinfo
-      http_get '/sys-info/pretty'
-    end
-
     def stats
       http_get '/stats'
     end

lib/meilisearch/error.rb

@@ -21,7 +21,7 @@ def initialize(http_code, http_message, http_body)
       @http_message = http_message
       @ms_message ||= 'MeiliSearch API has not returned any error message'
       @ms_link ||= '<no documentation link found>'
-      @message = "#{http_code} #{http_message} - #{@ms_message.capitalize}. See #{ms_link}."
+      @message = "#{http_code} #{http_message} - #{@ms_message}. See #{ms_link}."
       super(details)
     end
 

lib/meilisearch/index.rb

@@ -81,16 +81,8 @@ def delete_all_documents
     ### SEARCH
 
     def search(query, options = {})
-      parsed_options = options.transform_keys(&:to_sym).map do |k, v|
-        if [:facetFilters, :facetsDistribution].include?(k)
-          [k, v.inspect]
-        elsif v.is_a?(Array)
-          [k, v.join(',')]
-        else
-          [k, v]
-        end
-      end.to_h
-      http_get "/indexes/#{@uid}/search", { q: query }.merge(parsed_options)
+      parsed_options = options.compact
+      http_post "/indexes/#{@uid}/search", { q: query }.merge(parsed_options)
     end
 
     ### UPDATES
@@ -244,17 +236,6 @@ def reset_displayed_attributes
       http_delete "/indexes/#{@uid}/settings/displayed-attributes"
     end
 
-    ### SETTINGS - ACCEPT NEW FIELS VALUE
-
-    def accept_new_fields
-      http_get "/indexes/#{@uid}/settings/accept-new-fields"
-    end
-    alias get_accept_new_fields accept_new_fields
-
-    def update_accept_new_fields(accept_new_fields)
-      http_post "/indexes/#{@uid}/settings/accept-new-fields", accept_new_fields
-    end
-
     ### SETTINGS - ATTRIBUTES FOR FACETING
 
     def attributes_for_faceting

spec/meilisearch/client/stats_spec.rb

@@ -13,28 +13,6 @@
     expect(response).to have_key('pkgVersion')
   end
 
-  it 'gets sys-info' do
-    response = @client.sysinfo
-    expect(response).to be_a(Hash)
-    expect(response).to have_key('memoryUsage')
-    expect(response).to have_key('processorUsage')
-    expect(response).to have_key('global')
-    expect(response['global']['totalMemory']).not_to be_a(String)
-    expect(response['processorUsage'].first).not_to be_a(String)
-  end
-
-  it 'gets pretty sys-info' do
-    response = @client.pretty_sysinfo
-    expect(response).to be_a(Hash)
-    expect(response).to have_key('memoryUsage')
-    expect(response).to have_key('processorUsage')
-    expect(response).to have_key('global')
-    expect(response['global']['totalMemory']).to be_a(String)
-    expect(response['global']['totalMemory']).to end_with('B')
-    expect(response['processorUsage'].first).to be_a(String)
-    expect(response['processorUsage'].first).to end_with('%')
-  end
-
   it 'gets stats' do
     response = @client.stats
     expect(response).to have_key('databaseSize')

spec/meilisearch/index/base_spec.rb

@@ -44,8 +44,11 @@
     new_primary_key = 'id_test'
     expect do
       @index2.update(primaryKey: new_primary_key)
-    end.to raise_bad_request_meilisearch_api_error
-    # temporary, will be raise a 'primary_key_already_present' code in the next MS release
+    end.to raise_meilisearch_api_error_with(
+      400,
+      'primary_key_already_present',
+      'invalid_request_error'
+    )
   end
 
   it 'deletes index' do

spec/meilisearch/index/documents_spec.rb

@@ -349,8 +349,7 @@
     it 'returns a 400' do
       expect do
         index.add_documents(documents)
-      end.to raise_bad_request_meilisearch_api_error
-      # temporary, will be return a 'missing_primary_key' code in the next MS release
+      end.to raise_missing_primary_key_meilisearch_api_error
     end
   end
 

spec/meilisearch/index/search_spec.rb

@@ -2,7 +2,7 @@
 
 RSpec.describe 'MeiliSearch::Index - Search' do
   before(:all) do
-    documents = [
+    @documents = [
       { objectId: 123,  title: 'Pride and Prejudice',                    genre: 'romance' },
       { objectId: 456,  title: 'Le Petit Prince',                        genre: 'adventure' },
       { objectId: 1,    title: 'Alice In Wonderland',                    genre: 'adventure' },
@@ -14,7 +14,7 @@
     client = MeiliSearch::Client.new($URL, $MASTER_KEY)
     clear_all_indexes(client)
     @index = client.create_index('books')
-    @index.add_documents(documents)
+    @index.add_documents(@documents)
     sleep(0.1)
   end
 
@@ -42,6 +42,21 @@
     expect(response['hits'].first).not_to have_key('_formatted')
   end
 
+  it 'does a basic search with an empty query' do
+    response = @index.search('')
+    expect(response).to be_a(Hash)
+    expect(response.keys).to contain_exactly(*default_search_response_keys)
+    expect(response['hits'].count).to eq(0)
+  end
+
+  it 'does a basic search with an nil query' do
+    response = @index.search(nil)
+    expect(response).to be_a(Hash)
+    expect(response.keys).to contain_exactly(*default_search_response_keys)
+    expect(response['hits'].count).to eq(@documents.count)
+    expect(response['hits'].first).not_to have_key('_formatted')
+  end
+
   it 'does a custom search with limit' do
     response = @index.search('the', limit: 1)
     expect(response).to be_a(Hash)
@@ -51,15 +66,30 @@
   end
 
   it 'does a custom search with highlight' do
-    response = @index.search('the', attributesToHighlight: '*')
+    response = @index.search('the', attributesToHighlight: ['*'])
     expect(response).to be_a(Hash)
     expect(response.keys).to contain_exactly(*default_search_response_keys)
     expect(response['hits'].count).to eq(3)
     expect(response['hits'].first).to have_key('_formatted')
   end
 
+  it 'does a custom search with an empty query' do
+    response = @index.search('', attributesToHighlight: ['*'])
+    expect(response).to be_a(Hash)
+    expect(response.keys).to contain_exactly(*default_search_response_keys)
+    expect(response['hits'].count).to eq(0)
+  end
+
+  it 'does a custom search with an nil query' do
+    response = @index.search(nil, attributesToHighlight: ['*'])
+    expect(response).to be_a(Hash)
+    expect(response.keys).to contain_exactly(*default_search_response_keys)
+    expect(response['hits'].count).to eq(@documents.count)
+    expect(response['hits'].first).to have_key('_formatted')
+  end
+
   it 'does a custom search with attributesToRetrieve as string' do
-    response = @index.search('the', attributesToRetrieve: 'title')
+    response = @index.search('the', attributesToRetrieve: ['title'])
     expect(response).to be_a(Hash)
     expect(response.keys).to contain_exactly(*default_search_response_keys)
     expect(response['hits'].count).to eq(3)

spec/meilisearch/index/settings_spec.rb

@@ -16,6 +16,8 @@
       'exactness'
     ]
   end
+  let(:default_searchable_attributes) { ['*'] }
+  let(:default_displayed_attributes) { ['*'] }
 
   let(:settings_keys) do
     [
@@ -25,7 +27,6 @@
       'displayedAttributes',
       'stopWords',
       'synonyms',
-      'acceptNewFields',
       'attributesForFaceting'
     ]
   end
@@ -46,11 +47,10 @@
       expect(response.keys).to contain_exactly(*settings_keys)
       expect(response['rankingRules']).to eq(default_ranking_rules)
       expect(response['distinctAttribute']).to be_nil
-      expect(response['searchableAttributes']).to eq([])
-      expect(response['displayedAttributes']).to eq([])
+      expect(response['searchableAttributes']).to eq(default_searchable_attributes)
+      expect(response['displayedAttributes']).to eq(default_displayed_attributes)
       expect(response['stopWords']).to eq([])
       expect(response['synonyms']).to eq({})
-      expect(response['acceptNewFields']).to be_truthy
     end
 
     it 'updates multiples settings at the same time' do
@@ -171,8 +171,7 @@
 
     it 'gets default values of searchable attributes' do
       response = index.searchable_attributes
-      expect(response).to be_a(Array)
-      expect(response).to be_empty
+      expect(response).to eq(default_searchable_attributes)
     end
 
     it 'updates searchable attributes' do
@@ -187,6 +186,7 @@
       expect(response).to have_key('updateId')
       sleep(0.1)
       expect(index.get_update_status(response['updateId'])['status']).to eq('processed')
+      expect(index.searchable_attributes).to eq(default_searchable_attributes)
     end
   end
 
@@ -203,8 +203,7 @@
 
     it 'gets default values of displayed attributes' do
       response = index.displayed_attributes
-      expect(response).to be_a(Array)
-      expect(response).to be_empty
+      expect(response).to eq(default_displayed_attributes)
     end
 
     it 'updates displayed attributes' do
@@ -219,62 +218,7 @@
       expect(response).to have_key('updateId')
       sleep(0.1)
       expect(index.get_update_status(response['updateId'])['status']).to eq('processed')
-    end
-  end
-
-  context 'On accept-new-fields sub-routes' do
-    before(:all) do
-      @uid = SecureRandom.hex(4)
-      @client.create_index(@uid)
-    end
-
-    after(:all) { clear_all_indexes(@client) }
-
-    let(:index) { @client.index(@uid) }
-
-    it 'gets default values of acceptNewFields' do
-      expect(index.accept_new_fields).to be_truthy
-    end
-
-    it 'adds searchable or display attributes when truthy' do
-      index.update_searchable_attributes(['title', 'description'])
-      sleep(0.1)
-      index.update_displayed_attributes(['title', 'description'])
-      sleep(0.1)
-      index.add_documents(id: 1, title: 'Test', comment: 'comment test')
-      sleep(0.1)
-      sa = index.searchable_attributes
-      da = index.displayed_attributes
-      expect(sa).to contain_exactly('id', 'title', 'description', 'comment')
-      expect(da).to contain_exactly('id', 'title', 'description', 'comment')
-      index.update_searchable_attributes([])
-      sleep(0.1)
-      index.update_displayed_attributes([])
-      sleep(0.1)
-      index.delete_all_documents
-      sleep(0.1)
-    end
-
-    it 'updates displayed attributes' do
-      response = index.update_accept_new_fields(false)
-      expect(response).to have_key('updateId')
-      sleep(0.1)
-      expect(index.accept_new_fields).to be_falsy
-    end
-
-    it 'does not add searchable or display attributes when falsy' do
-      index.update_searchable_attributes(['title', 'description'])
-      sleep(0.1)
-      index.update_displayed_attributes(['title', 'description'])
-      sleep(0.1)
-      index.update_accept_new_fields(false)
-      sleep(0.1)
-      index.add_documents(id: 1, title: 'Test', comment: 'comment test', note: 'note')
-      sleep(0.1)
-      sa = index.searchable_attributes
-      da = index.displayed_attributes
-      expect(sa).to contain_exactly('title', 'description')
-      expect(da).to contain_exactly('title', 'description')
+      expect(index.displayed_attributes).to eq(default_displayed_attributes)
     end
   end
 
@@ -447,11 +391,10 @@
       expect(response.keys).to contain_exactly(*settings_keys)
       expect(response['rankingRules']).to eq(default_ranking_rules)
       expect(response['distinctAttribute']).to be_nil
-      expect(response['searchableAttributes']).to eq(['id'])
-      expect(response['displayedAttributes']).to eq(['id'])
+      expect(response['searchableAttributes']).to eq(default_searchable_attributes)
+      expect(response['displayedAttributes']).to eq(default_displayed_attributes)
       expect(response['stopWords']).to eq([])
       expect(response['synonyms']).to eq({})
-      expect(response['acceptNewFields']).to be_truthy
     end
 
     it 'updates multiples settings at the same time' do
@@ -503,7 +446,7 @@
     it 'does not add document when there is no primary-key' do
       expect do
         index.add_documents(title: 'Test')
-      end.to raise_bad_request_meilisearch_api_error
+      end.to raise_missing_primary_key_meilisearch_api_error
     end
 
     it 'adds documents when there is a primary-key' do
@@ -522,6 +465,7 @@
       expect(response).to have_key('updateId')
       sleep(0.1)
       expect(index.get_update_status(response['updateId'])['status']).to eq('processed')
+      expect(index.searchable_attributes).to eq(['*'])
     end
   end
 
@@ -541,7 +485,6 @@
       expect(index.method(:distinct_attribute) == index.method(:get_distinct_attribute)).to be_truthy
       expect(index.method(:searchable_attributes) == index.method(:get_searchable_attributes)).to be_truthy
       expect(index.method(:displayed_attributes) == index.method(:get_displayed_attributes)).to be_truthy
-      expect(index.method(:accept_new_fields) == index.method(:get_accept_new_fields)).to be_truthy
       expect(index.method(:synonyms) == index.method(:get_synonyms)).to be_truthy
       expect(index.method(:stop_words) == index.method(:get_stop_words)).to be_truthy
       expect(index.method(:attributes_for_faceting) == index.method(:get_attributes_for_faceting)).to be_truthy