Apply changes after the review (#285)

* Apply changes after the review

* Fix linter errors

Author: curquiza

lib/meilisearch/client.rb

@@ -113,11 +113,11 @@ def dump_status(dump_uid)
     ### TASKS
 
     def tasks
-      task_endpoint.global_tasks
+      task_endpoint.task_list
     end
 
     def task(task_uid)
-      task_endpoint.global_task(task_uid)
+      task_endpoint.task(task_uid)
     end
 
     def wait_for_task(task_uid, timeout_in_ms = 5000, interval_in_ms = 50)
@@ -131,7 +131,7 @@ def index_object(uid, primary_key = nil)
     end
 
     def task_endpoint
-      Task.new(@base_url, @api_key, @options)
+      @task_endpoint ||= Task.new(@base_url, @api_key, @options)
     end
   end
 end

lib/meilisearch/index.rb

@@ -7,7 +7,6 @@ class Index < HTTPRequest
     attr_reader :uid, :primary_key, :created_at, :updated_at
 
     def initialize(index_uid, url, api_key = nil, primary_key = nil, options = {})
-      @url = url
       @uid = index_uid
       @primary_key = primary_key
       super(url, api_key, options)
@@ -195,7 +194,7 @@ def search(query, options = {})
     ### TASKS
 
     def task_endpoint
-      Task.new(@url, @api_key, @options)
+      @task_endpoint ||= Task.new(@base_url, @api_key, @options)
     end
     private :task_endpoint
 

lib/meilisearch/task.rb

@@ -5,11 +5,11 @@
 
 module MeiliSearch
   class Task < HTTPRequest
-    def global_tasks
+    def task_list
       http_get '/tasks/'
     end
 
-    def global_task(task_uid)
+    def task(task_uid)
       http_get "/tasks/#{task_uid}"
     end
 
@@ -24,7 +24,7 @@ def index_task(index_uid, task_uid)
     def wait_for_task(task_uid, timeout_in_ms = 5000, interval_in_ms = 50)
       Timeout.timeout(timeout_in_ms.to_f / 1000) do
         loop do
-          task = global_task(task_uid)
+          task = task(task_uid)
           return task if achieved_task?(task)
 
           sleep interval_in_ms.to_f / 1000

spec/meilisearch/client/indexes_spec.rb

@@ -5,21 +5,25 @@
     context 'without a primary key' do
       it 'creates an index' do
         task = client.create_index('new_index')
+
         expect(task['type']).to eq('indexCreation')
-        client.wait_for_task(task['uid'])
 
+        client.wait_for_task(task['uid'])
         index = client.fetch_index('new_index')
+
         expect(index).to be_a(MeiliSearch::Index)
         expect(index.uid).to eq('new_index')
         expect(index.primary_key).to be_nil
       end
 
       it 'creates an index synchronously' do
         task = client.create_index!('new_index')
+
         expect(task['type']).to eq('indexCreation')
         expect(task['status']).to eq('succeeded')
 
         index = client.fetch_index('new_index')
+
         expect(index).to be_a(MeiliSearch::Index)
         expect(index.uid).to eq('new_index')
         expect(index.primary_key).to be_nil
@@ -29,10 +33,12 @@
     context 'with a primary key' do
       it 'creates an index' do
         task = client.create_index('new_index', primaryKey: 'primary_key')
+
         expect(task['type']).to eq('indexCreation')
-        client.wait_for_task(task['uid'])
 
+        client.wait_for_task(task['uid'])
         index = client.fetch_index('new_index')
+
         expect(index).to be_a(MeiliSearch::Index)
         expect(index.uid).to eq('new_index')
         expect(index.primary_key).to eq('primary_key')
@@ -41,10 +47,12 @@
 
       it 'creates an index synchronously' do
         task = client.create_index!('new_index', primaryKey: 'primary_key')
+
         expect(task['type']).to eq('indexCreation')
         expect(task['status']).to eq('succeeded')
 
         index = client.fetch_index('new_index')
+
         expect(index).to be_a(MeiliSearch::Index)
         expect(index.uid).to eq('new_index')
         expect(index.primary_key).to eq('primary_key')
@@ -72,10 +80,12 @@
             primaryKey: 'primary_key',
             uid: 'not_primary_key'
           )
+
           expect(task['type']).to eq('indexCreation')
-          client.wait_for_task(task['uid'])
 
+          client.wait_for_task(task['uid'])
           index = client.fetch_index('new_index')
+
           expect(index).to be_a(MeiliSearch::Index)
           expect(index.uid).to eq('new_index')
           expect(index.primary_key).to eq('primary_key')
@@ -86,13 +96,14 @@
 
     context 'when an index with a given uid already exists' do
       it 'returns a failing task' do
-        task1 = client.create_index!('existing_index')
-        task2 = client.create_index!('existing_index')
-        expect(task1['type']).to eq('indexCreation')
-        expect(task2['type']).to eq('indexCreation')
-        expect(task1['status']).to eq('succeeded')
-        expect(task2['status']).to eq('failed')
-        expect(task2['error']['code']).to eq('index_already_exists')
+        initial_task = client.create_index!('existing_index')
+        last_task = client.create_index!('existing_index')
+
+        expect(initial_task['type']).to eq('indexCreation')
+        expect(last_task['type']).to eq('indexCreation')
+        expect(initial_task['status']).to eq('succeeded')
+        expect(last_task['status']).to eq('failed')
+        expect(last_task['error']['code']).to eq('index_already_exists')
       end
     end
 
@@ -108,7 +119,9 @@
   describe '#indexes' do
     it 'returns MeiliSearch::Index objects' do
       client.create_index!('index')
+
       index = client.indexes.first
+
       expect(index).to be_a(MeiliSearch::Index)
     end
 
@@ -162,7 +175,6 @@
   describe '#fetch_raw_index' do
     it 'fetch a specific index raw Hash response based on uid' do
       client.create_index!('specific_index_fetch_raw', primaryKey: 'primary_key')
-
       index = client.fetch_index('specific_index_fetch_raw')
       raw_response = index.fetch_raw_info
 
@@ -179,7 +191,6 @@
   describe '#index' do
     it 'returns an index object with the provided uid' do
       client.create_index!('existing_index', primaryKey: 'primary_key')
-
       # this index is in memory, without metadata from server
       index = client.index('existing_index')
 
@@ -197,9 +208,10 @@
     context 'when the index exists' do
       it 'deletes the index' do
         client.create_index!('existing_index')
-
         task = client.delete_index('existing_index')
+
         expect(task['type']).to eq('indexDeletion')
+
         achieved_task = client.wait_for_task(task['uid'])
 
         expect(achieved_task['status']).to eq('succeeded')

spec/meilisearch/client/keys_spec.rb

@@ -1,26 +1,29 @@
 # frozen_string_literal: true
 
 RSpec.describe 'MeiliSearch::Client - Keys' do
-  context 'Test the default key roles' do
-    let(:public_key) { client.keys['results'].filter { |k| k['description'].start_with? 'Default Search API Key' }.first }
-    let(:private_key) { client.keys['results'].filter { |k| k['description'].start_with? 'Default Admin API Key' }.first }
+  context 'When a client uses default key roles' do
+    let(:search_key) { client.keys['results'].find { |k| k['description'].start_with? 'Default Search' } }
+    let(:admin_key) { client.keys['results'].find { |k| k['description'].start_with? 'Default Admin' } }
 
     it 'fails to get settings if public key used' do
-      new_client = MeiliSearch::Client.new(URL, public_key['key'])
+      new_client = MeiliSearch::Client.new(URL, search_key['key'])
+
       expect do
         new_client.index(random_uid).settings
       end.to raise_meilisearch_api_error_with(403, 'invalid_api_key', 'auth')
     end
 
     it 'fails to get keys if private key used' do
-      new_client = MeiliSearch::Client.new(URL, private_key['key'])
+      new_client = MeiliSearch::Client.new(URL, admin_key['key'])
+
       expect do
         new_client.keys
       end.to raise_meilisearch_api_error_with(403, 'invalid_api_key', 'auth')
     end
 
-    it 'fails to search if no key used' do
+    it 'fails to get settings if no key is used' do
       new_client = MeiliSearch::Client.new(URL)
+
       expect do
         new_client.index(random_uid).settings
       end.to raise_meilisearch_api_error_with(401, 'missing_authorization_header', 'auth')
@@ -30,36 +33,50 @@
       uid = random_uid
       index = client.index(uid)
       index.add_documents!(title: 'Test')
-
-      new_client = MeiliSearch::Client.new(URL, public_key['key'])
+      new_client = MeiliSearch::Client.new(URL, search_key['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
       uid = random_uid
       client.create_index!(uid)
-      new_client = MeiliSearch::Client.new(URL, private_key['key'])
+      new_client = MeiliSearch::Client.new(URL, admin_key['key'])
       response = new_client.index(uid).settings
+
       expect(response).to have_key('rankingRules')
     end
   end
 
-  context 'Test the key managements' do
+  context 'When managing keys' do
+    let(:delete_docs_key_options) do
+      {
+        description: 'A new key to delete docs',
+        actions: ['documents.delete'],
+        indexes: ['*'],
+        expiresAt: nil
+      }
+    end
+    let(:add_docs_key_options) do
+      {
+        description: 'A new key to add docs',
+        actions: ['documents.add'],
+        indexes: ['*'],
+        expiresAt: nil
+      }
+    end
+
     it 'gets the list of the default keys' do
       results = client.keys['results']
+
       expect(results).to be_a(Array)
       expect(results.count).to be >= 2
     end
 
     it 'creates a key' do
-      key_options = {
-        description: 'A new key to add docs',
-        actions: ['documents.add'],
-        indexes: ['*'],
-        expiresAt: nil
-      }
-      new_key = client.create_key(key_options)
+      new_key = client.create_key(add_docs_key_options)
+
       expect(new_key['expiresAt']).to be_nil
       expect(new_key['key']).to be_a(String)
       expect(new_key['createdAt']).to be_a(String)
@@ -69,13 +86,8 @@
     end
 
     it 'creates a key using snake_case' do
-      key_options = {
-        description: 'A new key to add docs',
-        actions: ['documents.add'],
-        indexes: ['*'],
-        expires_at: nil
-      }
-      new_key = client.create_key(key_options)
+      new_key = client.create_key(add_docs_key_options)
+
       expect(new_key['expiresAt']).to be_nil
       expect(new_key['key']).to be_a(String)
       expect(new_key['createdAt']).to be_a(String)
@@ -85,41 +97,31 @@
     end
 
     it 'gets a key' do
-      key_options = {
-        description: 'A new key to delete docs',
-        actions: ['documents.delete'],
-        indexes: ['*'],
-        expiresAt: nil
-      }
-      new_key = client.create_key(key_options)
+      new_key = client.create_key(delete_docs_key_options)
+
       expect(client.key(new_key['key'])['description']).to eq('A new key to delete docs')
-    end
 
-    it 'update a key' do
-      key_options = {
-        description: 'A new key to delete docs',
-        actions: ['documents.delete'],
-        indexes: ['*'],
-        expiresAt: nil
-      }
-      new_key = client.create_key(key_options)
+      key = client.key(new_key['key'])
 
+      expect(key['expiresAt']).to be_nil
+      expect(key['key']).to be_a(String)
+      expect(key['createdAt']).to be_a(String)
+      expect(key['updatedAt']).to be_a(String)
+      expect(key['indexes']).to eq(['*'])
+      expect(key['description']).to eq('A new key to delete docs')
+    end
+
+    it 'updates a key' do
+      new_key = client.create_key(delete_docs_key_options)
       new_updated_key = client.update_key(new_key['key'], indexes: ['coco'])
 
       expect(new_updated_key['key']).to eq(new_key['key'])
       expect(new_updated_key['description']).to eq(new_key['description'])
       expect(new_updated_key['indexes']).to eq(['coco'])
     end
 
-    it 'update a key using snake_case' do
-      key_options = {
-        description: 'A new key to delete docs',
-        actions: ['documents.delete'],
-        indexes: ['*'],
-        expires_at: nil
-      }
-      new_key = client.create_key(key_options)
-
+    it 'updates a key using snake_case' do
+      new_key = client.create_key(delete_docs_key_options)
       new_updated_key = client.update_key(new_key['key'], indexes: ['coco'])
 
       expect(new_updated_key['key']).to eq(new_key['key'])
@@ -128,15 +130,9 @@
     end
 
     it 'deletes a key' do
-      key_options = {
-        description: 'A new key to add docs',
-        actions: ['documents.add'],
-        indexes: ['*'],
-        expiresAt: nil
-      }
-      new_key = client.create_key(key_options)
-
+      new_key = client.create_key(add_docs_key_options)
       client.delete_key(new_key['key'])
+
       expect(client.keys.filter { |k| k['key'] == new_key['key'] }).to be_empty
     end
   end