Merge branch 'main' into 218-documents-in-batches

Author: FlamesRunner

.code-samples.meilisearch.yaml

@@ -381,3 +381,15 @@ reset_sortable_attributes_1: |-
   client.index('books').reset_sortable_attributes
 search_parameter_guide_sort_1: |-
   client.index('books').search('science fiction', { sort: ['price:asc'] })
+geosearch_guide_filter_settings_1: |-
+  client.index('restaurants').update_filterable_attributes(['_geo'])
+geosearch_guide_filter_usage_1: |-
+  client.index('restaurants').search('', { filter: '_geoRadius(45.4628328, 9.1076931, 2000)' })
+geosearch_guide_filter_usage_2: |-
+  client.index('restaurants').search('', { filter: '_geoRadius(45.4628328, 9.1076931, 2000) AND type = pizza' })
+geosearch_guide_sort_settings_1: |-
+  client.index('restaurants').update_sortable_attributes(['_geo'])
+geosearch_guide_sort_usage_1: |-
+  client.index('restaurants').search('', { sort: ['_geoPoint(48.8583701,2.2922926):asc'] })
+geosearch_guide_sort_usage_2: |-
+  client.index('restaurants').search('', { sort: ['_geoPoint(48.8583701,2.2922926):asc', 'rating:desc'] })

.rubocop.yml

@@ -20,9 +20,3 @@ Style/SymbolArray:
 
 Style/WordArray:
   EnforcedStyle: brackets
-
-Style/GlobalVars:
-  AllowedVariables:
-    - $URL
-    - $MASTER_KEY
-    - $DEFAULT_SEARCH_RESPONSE_KEYS

Gemfile

@@ -14,5 +14,5 @@ group :development, :test do
 end
 
 group :development do
-  gem 'rubocop', '~> 1.20.0', require: false
+  gem 'rubocop', '~> 1.22.1', require: false
 end

README.md

@@ -78,17 +78,17 @@ require 'meilisearch'
 client = MeiliSearch::Client.new('http://127.0.0.1:7700', 'masterKey')
 
 # An index is where the documents are stored.
-index = client.index('books')
+index = client.index('movies')
 
 documents = [
-  { book_id: 123,  title: 'Pride and Prejudice' },
-  { book_id: 456,  title: 'Le Petit Prince' },
-  { book_id: 1,    title: 'Alice In Wonderland' },
-  { book_id: 1344, title: 'The Hobbit' },
-  { book_id: 4,    title: 'Harry Potter and the Half-Blood Prince' },
-  { book_id: 42,   title: 'The Hitchhiker\'s Guide to the Galaxy' }
+  { id: 1, title: 'Carol', genres: ['Romance', 'Drama'] },
+  { id: 2, title: 'Wonder Woman', genres: ['Action', 'Adventure'] },
+  { id: 3, title: 'Life of Pi', genres: ['Adventure', 'Drama'] },
+  { id: 4, title: 'Mad Max: Fury Road', genres: ['Adventure', 'Science Fiction'] },
+  { id: 5, title: 'Moana', genres: ['Fantasy', 'Action']},
+  { id: 6, title: 'Philadelphia', genres: ['Drama'] },
 ]
-# If the index 'books' does not exist, MeiliSearch creates it when you first add the documents.
+# If the index 'movies' does not exist, MeiliSearch creates it when you first add the documents.
 index.add_documents(documents) # => { "updateId": 0 }
 ```
 
@@ -100,20 +100,20 @@ With the `updateId`, you can check the status (`enqueued`, `processing`, `proces
 
 ``` ruby
 # MeiliSearch is typo-tolerant:
-puts index.search('harry pottre')
+puts index.search('carlo')
 ```
 Output:
 
 ```ruby
 {
   "hits" => [{
-    "book_id" => 4,
-    "title" => "Harry Potter and the Half-Blood Prince"
+    "id" => 1,
+    "title" => "Carol"
   }],
   "offset" => 0,
   "limit" => 20,
   "processingTimeMs" => 1,
-  "query" => "harry pottre"
+  "query" => "carlo"
 }
 ```
 
@@ -123,7 +123,7 @@ All the supported options are described in the [search parameters](https://docs.
 
 ```ruby
 index.search(
-  'hob',
+  'wonder',
   attributesToHighlight: ['*']
 )
 ```
@@ -134,24 +134,24 @@ JSON output:
 {
     "hits": [
         {
-            "book_id": 1344,
-            "title": "The Hobbit",
+            "id": 2,
+            "title": "Wonder Woman",
             "_formatted": {
-                "book_id": 1344,
-                "title": "The <em>Hob</em>bit"
+                "id": 2,
+                "title": "<em>Wonder</em> Woman"
             }
         }
     ],
     "offset": 0,
     "limit": 20,
     "processingTimeMs": 0,
-    "query": "hob"
+    "query": "wonder"
 }
 ```
 
 ## 🤖 Compatibility with MeiliSearch
 
-This package only guarantees the compatibility with the [version v0.22.0 of MeiliSearch](https://github.com/meilisearch/MeiliSearch/releases/tag/v0.22.0).
+This package only guarantees the compatibility with the [version v0.23.0 of MeiliSearch](https://github.com/meilisearch/MeiliSearch/releases/tag/v0.23.0).
 
 ## 💡 Learn More
 

lib/meilisearch/client.rb

@@ -34,6 +34,17 @@ def delete_index(index_uid)
       index_object(index_uid).delete
     end
 
+    # Usage:
+    # client.delete_index_if_exists('indexUID')
+    def delete_index_if_exists(index_uid)
+      index_object(index_uid).delete
+      true
+    rescue ApiError => e
+      raise e if e.code != 'index_not_found'
+
+      false
+    end
+
     # Usage:
     # client.index('indexUID')
     def index(index_uid)

meilisearch.gemspec

@@ -23,5 +23,5 @@ Gem::Specification.new do |s|
   ]
 
   s.required_ruby_version = '>= 2.6.0'
-  s.add_dependency 'httparty', '>= 0.17.1', '< 0.20.0'
+  s.add_dependency 'httparty', '>= 0.17.1', '< 0.21.0'
 end

spec/meilisearch/client/dumps_spec.rb

@@ -2,7 +2,7 @@
 
 RSpec.describe 'MeiliSearch::Client - Dumps' do
   before(:all) do
-    @client = MeiliSearch::Client.new($URL, $MASTER_KEY)
+    @client = MeiliSearch::Client.new(URL, MASTER_KEY)
     clear_all_indexes(@client)
   end
 

spec/meilisearch/client/health_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 RSpec.describe 'MeiliSearch::Client - Health' do
-  let(:client)       { MeiliSearch::Client.new($URL, $MASTER_KEY) }
+  let(:client)       { MeiliSearch::Client.new(URL, MASTER_KEY) }
   let(:wrong_client) { MeiliSearch::Client.new('bad_url') }
 
   it 'is healthy when the url is valid' do

spec/meilisearch/client/indexes_spec.rb

@@ -2,13 +2,15 @@
 
 RSpec.describe 'MeiliSearch::Client - Indexes' do
   before(:all) do
-    @client = MeiliSearch::Client.new($URL, $MASTER_KEY)
+    @client = MeiliSearch::Client.new(URL, MASTER_KEY)
     clear_all_indexes(@client)
     @uid1 = 'uid1'
     @uid2 = 'uid2'
     @uid3 = 'uid3'
     @uid4 = 'uid4'
     @uid5 = 'uid5'
+    @uid6 = 'uid6'
+    @uid7 = 'uid7'
     @primary_key = 'objectId'
   end
 
@@ -116,4 +118,12 @@
     expect { @client.fetch_index(@uid5) }.to raise_index_not_found_meilisearch_api_error
     expect(@client.indexes.count).to eq(0)
   end
+
+  it 'deletes index if index exists' do
+    @client.create_index(@uid6)
+    expect(@client.delete_index_if_exists(@uid6)).to eq(true)
+    expect { @client.fetch_index(@uid6) }.to raise_index_not_found_meilisearch_api_error
+    expect(@client.delete_index_if_exists(@uid6)).to eq(false)
+    expect(@client.indexes.count).to eq(0)
+  end
 end

spec/meilisearch/client/keys_spec.rb

@@ -2,7 +2,7 @@
 
 RSpec.describe 'MeiliSearch::Client - Keys' do
   before(:all) do
-    @client = MeiliSearch::Client.new($URL, $MASTER_KEY)
+    @client = MeiliSearch::Client.new(URL, MASTER_KEY)
     @uid = 'uid'
     @client.create_index(@uid)
   end
@@ -20,37 +20,37 @@
 
   it 'fails to get settings if public key used' do
     public_key = @client.keys['public']
-    new_client = MeiliSearch::Client.new($URL, public_key)
+    new_client = MeiliSearch::Client.new(URL, public_key)
     expect do
       new_client.index(@uid).settings
     end.to raise_meilisearch_api_error_with(403, 'invalid_token', 'authentication_error')
   end
 
   it 'fails to get keys if private key used' do
     private_key = @client.keys['private']
-    new_client = MeiliSearch::Client.new($URL, private_key)
+    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
 
   it 'fails to search if no key used' do
-    new_client = MeiliSearch::Client.new($URL)
+    new_client = MeiliSearch::Client.new(URL)
     expect do
       new_client.index(@uid).settings
     end.to raise_meilisearch_api_error_with(401, 'missing_authorization_header', 'authentication_error')
   end
 
   it 'succeeds to search when using public key' do
     public_key = @client.keys['public']
-    new_client = MeiliSearch::Client.new($URL, public_key)
+    new_client = MeiliSearch::Client.new(URL, public_key)
     response = new_client.index(@uid).search('test')
     expect(response).to have_key('hits')
   end
 
   it 'succeeds to get settings when using private key' do
     private_key = @client.keys['private']
-    new_client = MeiliSearch::Client.new($URL, private_key)
+    new_client = MeiliSearch::Client.new(URL, private_key)
     response = new_client.index(@uid).settings
     expect(response).to have_key('rankingRules')
   end