Use Meilisearch in specs & test deprecation

Author: ellnix

spec/meilisearch/client/dumps_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-RSpec.describe 'MeiliSearch::Client - Dumps' do
+RSpec.describe 'Meilisearch::Client - Dumps' do
   it 'creates a new dump' do
     expect(client.create_dump.await).to be_succeeded
   end

spec/meilisearch/client/errors_spec.rb

@@ -1,44 +1,44 @@
 # frozen_string_literal: true
 
-RSpec.describe 'MeiliSearch::Client - Errors' do
-  describe 'MeiliSearch::Error' do
+RSpec.describe 'Meilisearch::Client - Errors' do
+  describe 'Meilisearch::Error' do
     it 'catches all other errors' do
-      expect(MeiliSearch::TimeoutError.ancestors).to include(MeiliSearch::Error)
-      expect(MeiliSearch::CommunicationError.ancestors).to include(MeiliSearch::Error)
-      expect(MeiliSearch::ApiError.ancestors).to include(MeiliSearch::Error)
-      expect(MeiliSearch::TenantToken::InvalidApiKey.ancestors).to include(MeiliSearch::Error)
-      expect(MeiliSearch::TenantToken::InvalidSearchRules.ancestors).to include(MeiliSearch::Error)
-      expect(MeiliSearch::TenantToken::ExpireOrInvalidSignature.ancestors).to include(MeiliSearch::Error)
+      expect(Meilisearch::TimeoutError.ancestors).to include(Meilisearch::Error)
+      expect(Meilisearch::CommunicationError.ancestors).to include(Meilisearch::Error)
+      expect(Meilisearch::ApiError.ancestors).to include(Meilisearch::Error)
+      expect(Meilisearch::TenantToken::InvalidApiKey.ancestors).to include(Meilisearch::Error)
+      expect(Meilisearch::TenantToken::InvalidSearchRules.ancestors).to include(Meilisearch::Error)
+      expect(Meilisearch::TenantToken::ExpireOrInvalidSignature.ancestors).to include(Meilisearch::Error)
     end
   end
 
   context 'when request takes to long to answer' do
-    it 'raises MeiliSearch::TimeoutError' do
-      timed_client = MeiliSearch::Client.new(URL, MASTER_KEY, { timeout: 0.000001 })
+    it 'raises Meilisearch::TimeoutError' do
+      timed_client = Meilisearch::Client.new(URL, MASTER_KEY, { timeout: 0.000001 })
 
       expect do
         timed_client.version
-      end.to raise_error(MeiliSearch::TimeoutError)
+      end.to raise_error(Meilisearch::TimeoutError)
     end
   end
 
   context 'when body is too large' do
     let(:index) { client.index('movies') }
 
-    it 'raises MeiliSearch::CommunicationError' do
+    it 'raises Meilisearch::CommunicationError' do
       allow(index.class).to receive(:post).and_raise(Errno::EPIPE)
 
       expect do
         index.add_documents([{ id: 1, text: 'my_text' }])
-      end.to raise_error(MeiliSearch::CommunicationError)
+      end.to raise_error(Meilisearch::CommunicationError)
     end
   end
 
   context 'when document id is invalid' do
-    it 'raises MeiliSearch::InvalidDocumentId' do
+    it 'raises Meilisearch::InvalidDocumentId' do
       expect do
         client.index('movies').delete_document(nil)
-      end.to raise_error(MeiliSearch::InvalidDocumentId)
+      end.to raise_error(Meilisearch::InvalidDocumentId)
     end
   end
 end

spec/meilisearch/client/health_spec.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-RSpec.describe 'MeiliSearch::Client - Health' do
-  let(:client)       { MeiliSearch::Client.new(URL, MASTER_KEY) }
-  let(:wrong_client) { MeiliSearch::Client.new('bad_url') }
+RSpec.describe 'Meilisearch::Client - Health' do
+  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
     expect(client.healthy?).to be true

spec/meilisearch/client/indexes_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-RSpec.describe 'MeiliSearch::Client - Indexes' do
+RSpec.describe 'Meilisearch::Client - Indexes' do
   describe '#create_index' do
     context 'without a primary key' do
       it 'creates an index' do
@@ -9,14 +9,14 @@
         task.await
 
         index = client.fetch_index('books')
-        expect(index).to be_a(MeiliSearch::Index)
+        expect(index).to be_a(Meilisearch::Index)
         expect(index.uid).to eq('books')
         expect(index.primary_key).to be_nil
       end
 
       context 'synchronously' do
         context 'using ! method' do
-          before { allow(MeiliSearch::Utils).to receive(:soft_deprecate).and_return(nil) }
+          before { allow(Meilisearch::Utils).to receive(:soft_deprecate).and_return(nil) }
 
           it 'creates an index' do
             task = client.create_index!('books')
@@ -26,14 +26,14 @@
 
             index = client.fetch_index('books')
 
-            expect(index).to be_a(MeiliSearch::Index)
+            expect(index).to be_a(Meilisearch::Index)
             expect(index.uid).to eq('books')
             expect(index.primary_key).to be_nil
           end
 
           it 'warns about deprecation' do
             client.create_index!('books')
-            expect(MeiliSearch::Utils)
+            expect(Meilisearch::Utils)
               .to have_received(:soft_deprecate)
               .with('Client#create_index!', a_string_including('books'))
           end
@@ -48,7 +48,7 @@
 
             index = client.fetch_index('books')
 
-            expect(index).to be_a(MeiliSearch::Index)
+            expect(index).to be_a(Meilisearch::Index)
             expect(index.uid).to eq('books')
             expect(index.primary_key).to be_nil
           end
@@ -64,7 +64,7 @@
         task.await
 
         index = client.fetch_index('books')
-        expect(index).to be_a(MeiliSearch::Index)
+        expect(index).to be_a(Meilisearch::Index)
         expect(index.uid).to eq('books')
         expect(index.primary_key).to eq('reference_code')
         expect(index.fetch_primary_key).to eq('reference_code')
@@ -78,7 +78,7 @@
 
         index = client.fetch_index('books')
 
-        expect(index).to be_a(MeiliSearch::Index)
+        expect(index).to be_a(Meilisearch::Index)
         expect(index.uid).to eq('books')
         expect(index.primary_key).to eq('reference_code')
         expect(index.fetch_primary_key).to eq('reference_code')
@@ -91,7 +91,7 @@
           task.await
 
           index = client.fetch_index('books')
-          expect(index).to be_a(MeiliSearch::Index)
+          expect(index).to be_a(Meilisearch::Index)
           expect(index.uid).to eq('books')
           expect(index.primary_key).to eq('reference_code')
           expect(index.fetch_primary_key).to eq('reference_code')
@@ -110,7 +110,7 @@
           task.await
 
           index = client.fetch_index('books')
-          expect(index).to be_a(MeiliSearch::Index)
+          expect(index).to be_a(Meilisearch::Index)
           expect(index.uid).to eq('books')
           expect(index.primary_key).to eq('reference_code')
           expect(index.fetch_primary_key).to eq('reference_code')
@@ -141,12 +141,12 @@
   end
 
   describe '#indexes' do
-    it 'returns MeiliSearch::Index objects' do
+    it 'returns Meilisearch::Index objects' do
       client.create_index('books').await
 
       index = client.indexes['results'].first
 
-      expect(index).to be_a(MeiliSearch::Index)
+      expect(index).to be_a(Meilisearch::Index)
     end
 
     it 'gets a list of indexes' do
@@ -201,7 +201,7 @@
 
       fetched_index = client.fetch_index('books')
 
-      expect(fetched_index).to be_a(MeiliSearch::Index)
+      expect(fetched_index).to be_a(Meilisearch::Index)
       expect(fetched_index.uid).to eq('books')
       expect(fetched_index.primary_key).to eq('reference_code')
       expect(fetched_index.fetch_primary_key).to eq('reference_code')
@@ -230,7 +230,7 @@
       # this index is in memory, without metadata from server
       index = client.index('books')
 
-      expect(index).to be_a(MeiliSearch::Index)
+      expect(index).to be_a(Meilisearch::Index)
       expect(index.uid).to eq('books')
       expect(index.primary_key).to be_nil
 

spec/meilisearch/client/keys_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-RSpec.describe 'MeiliSearch::Client - Keys' do
+RSpec.describe 'Meilisearch::Client - Keys' do
   context 'When managing keys' do
     let(:uuid_v4) { 'c483e150-cff1-4a45-ac26-bb8eb8e01d36' }
     let(:delete_docs_key_options) do
@@ -113,7 +113,7 @@
 
       expect do
         client.key(new_key['key'])
-      end.to raise_error(MeiliSearch::ApiError)
+      end.to raise_error(Meilisearch::ApiError)
     end
   end
 end

spec/meilisearch/client/multi_search_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-RSpec.describe 'MeiliSearch::Client - Multiple Index Search' do
+RSpec.describe 'Meilisearch::Client - Multiple Index Search' do
   before do
     client.create_index('books')
     client.create_index('movies').await

spec/meilisearch/client/requests_spec.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-RSpec.describe 'MeiliSearch::Client requests' do
+RSpec.describe 'Meilisearch::Client requests' do
   let(:key) { SecureRandom.uuid }
 
   before do
-    expect(MeiliSearch::Client).to receive(:post)
+    expect(Meilisearch::Client).to receive(:post)
       .with(kind_of(String), hash_including(body: "{\"primaryKey\":\"#{key}\",\"uid\":\"#{key}\"}"))
       .and_call_original
   end

spec/meilisearch/client/snapshots_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-RSpec.describe 'MeiliSearch::Client - Snapshots' do
+RSpec.describe 'Meilisearch::Client - Snapshots' do
   it 'creates a new snapshot' do
     response = client.create_snapshot
     expect(response).to be_a(Hash)

spec/meilisearch/client/stats_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-RSpec.describe 'MeiliSearch::Client - Stats' do
+RSpec.describe 'Meilisearch::Client - Stats' do
   it 'gets version' do
     response = client.version
     expect(response).to be_a(Hash)

spec/meilisearch/client/tasks_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-RSpec.describe 'MeiliSearch::Tasks' do
+RSpec.describe 'Meilisearch::Tasks' do
   include_context 'search books with genre'
 
   let(:enqueued_task_keys) { ['uid', 'indexUid', 'status', 'type', 'enqueuedAt'] }
@@ -66,7 +66,7 @@
   end
 
   it 'ensures supports to all available filters' do
-    allow(MeiliSearch::Utils).to receive(:transform_attributes).and_call_original
+    allow(Meilisearch::Utils).to receive(:transform_attributes).and_call_original
 
     client.tasks(
       canceled_by: [1, 2], uids: [2], foo: 'bar',
@@ -75,7 +75,7 @@
       before_finished_at: '2022-01-20', after_finished_at: '2022-01-20'
     )
 
-    expect(MeiliSearch::Utils).to have_received(:transform_attributes)
+    expect(Meilisearch::Utils).to have_received(:transform_attributes)
       .with(
         canceled_by: [1, 2], uids: [2],
         before_enqueued_at: '2022-01-20', after_enqueued_at: '2022-01-20',
@@ -102,12 +102,12 @@
       expect(status['status']).not_to eq('enqueued')
     end
 
-    it 'waits for task with custom timeout_in_ms and raises MeiliSearchTimeoutError' do
+    it 'waits for task with custom timeout_in_ms and raises MeilisearchTimeoutError' do
       index.add_documents(documents)
       task = index.add_documents(documents)
       expect do
         index.wait_for_task(task['taskUid'], 1)
-      end.to raise_error(MeiliSearch::TimeoutError)
+      end.to raise_error(Meilisearch::TimeoutError)
     end
 
     it 'waits for task with custom interval_in_ms and raises Timeout::Error' do
@@ -139,12 +139,12 @@
       expect(status['status']).not_to eq('enqueued')
     end
 
-    it 'waits for task with custom timeout_in_ms and raises MeiliSearchTimeoutError' do
+    it 'waits for task with custom timeout_in_ms and raises MeilisearchTimeoutError' do
       index.add_documents(documents)
       task = index.add_documents(documents)
       expect do
         client.wait_for_task(task['taskUid'], 1)
-      end.to raise_error(MeiliSearch::TimeoutError)
+      end.to raise_error(Meilisearch::TimeoutError)
     end
 
     it 'waits for task with custom interval_in_ms and raises Timeout::Error' do
@@ -160,7 +160,7 @@
 
   describe '#client.cancel_tasks' do
     it 'ensures supports to all available filters' do
-      allow(MeiliSearch::Utils).to receive(:transform_attributes).and_call_original
+      allow(Meilisearch::Utils).to receive(:transform_attributes).and_call_original
 
       client.cancel_tasks(
         canceled_by: [1, 2], uids: [2], foo: 'bar',
@@ -169,7 +169,7 @@
         before_finished_at: '2022-01-20', after_finished_at: '2022-01-20'
       )
 
-      expect(MeiliSearch::Utils).to have_received(:transform_attributes)
+      expect(Meilisearch::Utils).to have_received(:transform_attributes)
         .with(
           canceled_by: [1, 2], uids: [2],
           before_enqueued_at: '2022-01-20', after_enqueued_at: '2022-01-20',
@@ -192,7 +192,7 @@
     it 'ensures supports to all available filters' do
       date = DateTime.new(2022, 1, 20)
 
-      allow(MeiliSearch::Utils).to receive(:transform_attributes).and_call_original
+      allow(Meilisearch::Utils).to receive(:transform_attributes).and_call_original
 
       client.delete_tasks(
         canceled_by: [1, 2], uids: [2], foo: 'bar',
@@ -201,7 +201,7 @@
         before_finished_at: date, after_finished_at: date
       )
 
-      expect(MeiliSearch::Utils).to have_received(:transform_attributes)
+      expect(Meilisearch::Utils).to have_received(:transform_attributes)
         .with(
           canceled_by: [1, 2], uids: [2],
           before_enqueued_at: date, after_enqueued_at: date,