Rename test_client to simply client

Author: jmks

spec/meilisearch/client/dumps_spec.rb

@@ -1,34 +1,29 @@
 # frozen_string_literal: true
 
 RSpec.describe 'MeiliSearch::Client - Dumps' do
-  before(:all) do
-    @client = MeiliSearch::Client.new(URL, MASTER_KEY)
-    clear_all_indexes(@client)
-  end
-
   it 'creates a new dump' do
-    response = @client.create_dump
+    response = client.create_dump
     expect(response).to be_a(Hash)
     expect(response['uid']).to_not be_nil
     expect(response['status']).to_not be_nil
     expect(response['status']).to eq('in_progress')
-    wait_for_dump_creation(@client, response['uid'])
+    wait_for_dump_creation(client, response['uid'])
   end
 
   it 'gets dump status' do
-    dump = @client.create_dump
-    response = @client.dump_status(dump['uid'])
+    dump = client.create_dump
+    response = client.dump_status(dump['uid'])
     expect(response['status']).to_not be_nil
-    wait_for_dump_creation(@client, dump['uid'])
+    wait_for_dump_creation(client, dump['uid'])
   end
 
   it 'fails to get dump status without uid' do
     expect do
-      @client.dump_status('uid_not_exists')
+      client.dump_status('uid_not_exists')
     end.to raise_meilisearch_api_error_with(404, 'not_found', 'invalid_request_error')
   end
 
   it 'works with method aliases' do
-    expect(@client.method(:dump_status) == @client.method(:get_dump_status)).to be_truthy
+    expect(client.method(:dump_status) == client.method(:get_dump_status)).to be_truthy
   end
 end

spec/meilisearch/client/indexes_spec.rb

@@ -2,23 +2,23 @@
 
 RSpec.describe 'MeiliSearch::Client - Indexes' do
   it 'creates an index without primary-key' do
-    index = test_client.create_index('index')
+    index = client.create_index('index')
     expect(index).to be_a(MeiliSearch::Index)
     expect(index.uid).to eq('index')
     expect(index.primary_key).to be_nil
     expect(index.fetch_primary_key).to be_nil
   end
 
   it 'creates an index with primary-key' do
-    index = test_client.create_index('index', primaryKey: 'primary_key')
+    index = client.create_index('index', primaryKey: 'primary_key')
     expect(index).to be_a(MeiliSearch::Index)
     expect(index.uid).to eq('index')
     expect(index.primary_key).to eq('primary_key')
     expect(index.fetch_primary_key).to eq('primary_key')
   end
 
   it 'creates an index with uid in options - should not take it into account' do
-    index = test_client.create_index('index', primaryKey: 'primary_key', uid: 'wrong')
+    index = client.create_index('index', primaryKey: 'primary_key', uid: 'wrong')
     expect(index).to be_a(MeiliSearch::Index)
     expect(index.uid).to eq('index')
     expect(index.primary_key).to eq('primary_key')
@@ -27,64 +27,64 @@
 
   it 'creates an new index with get_or_create_index method' do
     expect do
-      index = test_client.get_or_create_index('index')
+      index = client.get_or_create_index('index')
 
       expect(index).to be_a(MeiliSearch::Index)
       expect(index.uid).to eq('index')
       expect(index.primary_key).to be_nil
-    end.to(change { test_client.indexes.length }.by(1))
+    end.to(change { client.indexes.length }.by(1))
 
-    fetched_index = test_client.fetch_index('index')
+    fetched_index = client.fetch_index('index')
     expect(fetched_index.uid).to eq('index')
     expect(fetched_index.primary_key).to be_nil
   end
 
   it 'creates an new index with get_or_create_index method and a primary-key' do
     expect do
-      index = test_client.get_or_create_index('index', primaryKey: 'title')
+      index = client.get_or_create_index('index', primaryKey: 'title')
 
       expect(index).to be_a(MeiliSearch::Index)
       expect(index.uid).to eq('index')
       expect(index.primary_key).to eq('title')
-    end.to(change { test_client.indexes.length }.by(1))
+    end.to(change { client.indexes.length }.by(1))
 
-    fetched_index = test_client.fetch_index('index')
+    fetched_index = client.fetch_index('index')
     expect(fetched_index.uid).to eq('index')
     expect(fetched_index.primary_key).to eq('title')
   end
 
   it 'get an already existing index with get_or_create_index method' do
-    test_client.create_index(test_uid)
+    client.create_index(test_uid)
 
     expect do
-      index = test_client.get_or_create_index(test_uid)
+      index = client.get_or_create_index(test_uid)
 
       expect(index).to be_a(MeiliSearch::Index)
       expect(index.uid).to eq(test_uid)
       expect(index.primary_key).to be_nil
-    end.not_to(change { test_client.indexes.length })
+    end.not_to(change { client.indexes.length })
   end
 
   it 'fails to create an index with an uid already taken' do
-    test_client.create_index(test_uid)
+    client.create_index(test_uid)
 
     expect do
-      test_client.create_index(test_uid)
+      client.create_index(test_uid)
     end.to raise_meilisearch_api_error_with(400, 'index_already_exists', 'invalid_request_error')
   end
 
   it 'fails to create an index with bad UID format' do
     expect do
-      test_client.create_index('two words')
+      client.create_index('two words')
     end.to raise_meilisearch_api_error_with(400, 'invalid_index_uid', 'invalid_request_error')
   end
 
   it 'gets list of indexes' do
-    test_client.create_index('first_index')
-    test_client.create_index('second_index')
-    test_client.create_index('third_index')
+    client.create_index('first_index')
+    client.create_index('second_index')
+    client.create_index('third_index')
 
-    indexes = test_client.indexes
+    indexes = client.indexes
 
     expect(indexes).to be_a(Array)
     expect(indexes.length).to eq(3)
@@ -93,9 +93,9 @@
   end
 
   it 'fetch a specific index' do
-    test_client.create_index('specific_index', primaryKey: 'primary_key')
+    client.create_index('specific_index', primaryKey: 'primary_key')
 
-    response = test_client.fetch_index('specific_index')
+    response = client.fetch_index('specific_index')
 
     expect(response).to be_a(MeiliSearch::Index)
     expect(response.uid).to eq('specific_index')
@@ -104,9 +104,9 @@
   end
 
   it 'returns an index object based on uid' do
-    test_client.create_index('index_with_pk', primaryKey: 'primary_key')
+    client.create_index('index_with_pk', primaryKey: 'primary_key')
 
-    index = test_client.index('index_with_pk')
+    index = client.index('index_with_pk')
 
     expect(index).to be_a(MeiliSearch::Index)
     expect(index.uid).to eq('index_with_pk')
@@ -117,21 +117,21 @@
 
   it 'deletes index' do
     expect do
-      test_client.create_index('index')
-    end.to(change { test_client.indexes.length }.by(1))
+      client.create_index('index')
+    end.to(change { client.indexes.length }.by(1))
 
     expect do
-      expect(test_client.delete_index('index')).to be_nil
-    end.to(change { test_client.indexes.length }.by(-1))
+      expect(client.delete_index('index')).to be_nil
+    end.to(change { client.indexes.length }.by(-1))
   end
 
   context 'with snake_case options' do
     it 'creates an index without errors' do
       uid = SecureRandom.uuid
 
       expect do
-        @client.create_index(uid, primary_key: @primary_key)
-        @client.fetch_index(uid)
+        client.create_index(uid, primary_key: @primary_key)
+        client.fetch_index(uid)
       end.to_not raise_error
     end
   end

spec/meilisearch/client/keys_spec.rb

@@ -2,7 +2,7 @@
 
 RSpec.describe 'MeiliSearch::Client - Keys' do
   it 'gets the list of keys' do
-    response = test_client.keys
+    response = client.keys
     expect(response).to be_a(Hash)
     expect(response.count).to eq(2)
     expect(response.keys).to contain_exactly('private', 'public')
@@ -11,15 +11,15 @@
   end
 
   it 'fails to get settings if public key used' do
-    public_key = test_client.keys['public']
+    public_key = client.keys['public']
     new_client = MeiliSearch::Client.new(URL, public_key)
     expect do
       new_client.index(test_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 = test_client.keys['private']
+    private_key = client.keys['private']
     new_client = MeiliSearch::Client.new(URL, private_key)
     expect do
       new_client.keys
@@ -34,8 +34,8 @@
   end
 
   it 'succeeds to search when using public key' do
-    public_key = test_client.keys['public']
-    index = test_client.create_index(test_uid)
+    public_key = client.keys['public']
+    index = client.create_index(test_uid)
     response = index.add_documents(title: 'Test')
     index.wait_for_pending_update(response['updateId'])
 
@@ -45,14 +45,14 @@
   end
 
   it 'succeeds to get settings when using private key' do
-    test_client.create_index(test_uid)
-    private_key = test_client.keys['private']
+    client.create_index(test_uid)
+    private_key = client.keys['private']
     new_client = MeiliSearch::Client.new(URL, private_key)
     response = new_client.index(test_uid).settings
     expect(response).to have_key('rankingRules')
   end
 
   it 'works with method aliases' do
-    expect(test_client.method(:keys) == test_client.method(:get_keys)).to be_truthy
+    expect(client.method(:keys) == client.method(:get_keys)).to be_truthy
   end
 end

spec/meilisearch/client/stats_spec.rb

@@ -1,20 +1,16 @@
 # frozen_string_literal: true
 
 RSpec.describe 'MeiliSearch::Client - Stats' do
-  before(:all) do
-    @client = MeiliSearch::Client.new(URL, MASTER_KEY)
-  end
-
   it 'gets version' do
-    response = @client.version
+    response = client.version
     expect(response).to be_a(Hash)
     expect(response).to have_key('commitSha')
     expect(response).to have_key('commitDate')
     expect(response).to have_key('pkgVersion')
   end
 
   it 'gets stats' do
-    response = @client.stats
+    response = client.stats
     expect(response).to have_key('databaseSize')
   end
 end

spec/meilisearch/index/base_spec.rb

@@ -2,32 +2,32 @@
 
 RSpec.describe MeiliSearch::Index do
   it 'fetch the info of the index' do
-    index = test_client.create_index('new_index')
+    index = client.create_index('new_index')
     index.fetch_info
     expect(index).to be_a(MeiliSearch::Index)
     expect(index.uid).to eq('new_index')
     expect(index.primary_key).to be_nil
   end
 
   it 'get primary-key of index if null' do
-    index = test_client.create_index('index_without_primary_key')
+    index = client.create_index('index_without_primary_key')
     expect(index.primary_key).to be_nil
     expect(index.fetch_primary_key).to be_nil
   end
 
   it 'get primary-key of index if it exists' do
-    index = test_client.create_index('index_with_prirmary_key', primaryKey: 'primary_key')
+    index = client.create_index('index_with_prirmary_key', primaryKey: 'primary_key')
     expect(index.primary_key).to eq('primary_key')
     expect(index.fetch_primary_key).to eq('primary_key')
   end
 
   it 'get uid of index' do
-    index = test_client.create_index('uid')
+    index = client.create_index('uid')
     expect(index.uid).to eq('uid')
   end
 
   it 'updates primary-key of index if not defined before' do
-    index = test_client.create_index('uid')
+    index = client.create_index('uid')
     index.update(primaryKey: 'new_primary_key')
     expect(index).to be_a(MeiliSearch::Index)
     expect(index.uid).to eq('uid')
@@ -36,7 +36,7 @@
   end
 
   it 'returns error if trying to update primary-key if it is already defined' do
-    index = test_client.create_index('uid', primaryKey: 'primary_key')
+    index = client.create_index('uid', primaryKey: 'primary_key')
     expect do
       index.update(primaryKey: 'new_primary_key')
     end.to raise_meilisearch_api_error_with(
@@ -65,13 +65,13 @@
   end
 
   it 'deletes index' do
-    index = test_client.create_index('uid')
+    index = client.create_index('uid')
     expect(index.delete).to be_nil
     expect { index.fetch_info }.to raise_index_not_found_meilisearch_api_error
   end
 
   it 'fails to manipulate index object after deletion' do
-    index = test_client.create_index('uid')
+    index = client.create_index('uid')
     expect(index.delete).to be_nil
 
     expect { index.fetch_primary_key }.to raise_index_not_found_meilisearch_api_error
@@ -81,7 +81,7 @@
   end
 
   it 'works with method aliases' do
-    index = test_client.create_index('uid', primaryKey: 'primary_key')
+    index = client.create_index('uid', primaryKey: 'primary_key')
 
     expect(index.method(:fetch_primary_key) == index.method(:get_primary_key)).to be_truthy
     expect(index.method(:update) == index.method(:update_index)).to be_truthy

spec/meilisearch/index/documents_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 RSpec.describe 'MeiliSearch::Index - Documents' do
-  let(:index) { test_client.create_index(test_uid) }
+  let(:index) { client.create_index(test_uid) }
 
   context 'All basic tests with primary-key inference' do
     let(:documents) do
@@ -71,13 +71,13 @@
       end
 
       it 'create the index during document addition' do
-        new_index = test_client.index('newIndex')
+        new_index = client.index('newIndex')
         response = new_index.add_documents(documents)
         expect(response).to be_a(Hash)
         expect(response).to have_key('updateId')
         new_index.wait_for_pending_update(response['updateId'])
-        expect(test_client.index('newIndex').fetch_primary_key).to eq('objectId')
-        expect(test_client.index('newIndex').documents.count).to eq(documents.count)
+        expect(client.index('newIndex').fetch_primary_key).to eq('objectId')
+        expect(client.index('newIndex').documents.count).to eq(documents.count)
       end
 
       it 'adds only one document to index (as an hash of one document)' do

spec/meilisearch/index/search/attributes_to_crop_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 RSpec.describe 'MeiliSearch::Index - Cropped search' do
-  let(:index) { test_client.create_index('books') }
+  let(:index) { client.create_index('books') }
   let(:document) do
     {
       objectId: 42,

spec/meilisearch/index/search/multi_params_spec.rb

@@ -82,7 +82,7 @@
 
   context 'with snake_case options' do
     it 'does a custom search with attributes in a unusual formatting' do
-      response = @index.search(
+      response = index.search(
         'prince',
         {
           aTTributes_TO_Crop: ['title'],