meilisearch 0.18.3 → 0.19.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9ffb59831da7243cc87f65a0cd0a0d11d311e4691fd1177779fae006f4a750d
-  data.tar.gz: 04cd78aa37677107d08a355daa016d72d8be0d2980d1da27f1e5102dde45c661
+  metadata.gz: 67fd01c01f58eb04e3d5e8d33c12f66a6ed9601d743444d8ade60f93cd05e322
+  data.tar.gz: aa37afae83757583053e1fdd821ef8e87f0e518edbfe1c52c2abba3d27610b4a
 SHA512:
-  metadata.gz: 1b7cc2bcb9f6c228397ca5cceaa9ad76c0fb3e522f29ea2231ac9a304c762fdc1cc2eda55deaeead572d5b8ab0468681db57b8fe6b28ee078a96324894a54a1c
-  data.tar.gz: 551fc3177689b479102a2f23329ca7243ae768ba13d7ddeea48e09f531c8305fcd43207e5f20e9b3d28bf5e0c88d7e6ae5247ea115213abc890264369785fbfd
+  metadata.gz: 04b69743166d96c14954eb5a06ad77f1d8edd9b7e6884f8fc19f2235ee88897adc570cb68cc39357bedb993eaad0312979f746bf3773bbf54a130bb347b9fa25
+  data.tar.gz: 242457a2a1aacebcc754a7380976e289f9691bbf8c2d08a3395f70e2608ae4516286329316c28de0ec2fd342499d93b6384f1f14c04e98c21672f402a79de4c5

data/README.md

@@ -187,8 +187,7 @@ JSON output:
       ]
     }
   ],
-  "nbHits": 1,
-  "exhaustiveNbHits": false,
+  "estimatedTotalHits": 1,
   "query": "wonder",
   "limit": 20,
   "offset": 0,
@@ -198,7 +197,7 @@ JSON output:
 
 ## 🤖 Compatibility with Meilisearch
 
-This package only guarantees the compatibility with the [version v0.27.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.27.0).
+This package only guarantees the compatibility with the [version v0.28.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.28.0).
 
 ## 💡 Learn More
 

data/lib/meilisearch/client.rb

@@ -6,14 +6,20 @@ module MeiliSearch
 
     ### INDEXES
 
-    def raw_indexes
-      http_get('/indexes')
+    def raw_indexes(options = {})
+      body = Utils.transform_attributes(options.transform_keys(&:to_sym).slice(:limit, :offset))
+
+      http_get('/indexes', body)
     end
 
-    def indexes
-      raw_indexes.map do |index_hash|
+    def indexes(options = {})
+      response = raw_indexes(options)
+
+      response['results'].map! do |index_hash|
         index_object(index_hash['uid'], index_hash['primaryKey'])
       end
+
+      response
     end
 
     # Usage:
@@ -29,7 +35,7 @@ module MeiliSearch
     # Waits for the task to be achieved, be careful when using it.
     def create_index!(index_uid, options = {})
       task = create_index(index_uid, options)
-      wait_for_task(task['uid'])
+      wait_for_task(task['taskUid'])
     end
 
     def delete_index(index_uid)
@@ -52,12 +58,14 @@ module MeiliSearch
 
     ### KEYS
 
-    def keys
-      http_get '/keys'
+    def keys(limit: nil, offset: nil)
+      body = { limit: limit, offset: offset }.compact
+
+      http_get '/keys', body
     end
 
-    def key(key_uid)
-      http_get "/keys/#{key_uid}"
+    def key(uid_or_key)
+      http_get "/keys/#{uid_or_key}"
     end
 
     def create_key(key_options)
@@ -66,14 +74,15 @@ module MeiliSearch
       http_post '/keys', body
     end
 
-    def update_key(key_uid, key_options)
+    def update_key(uid_or_key, key_options)
       body = Utils.transform_attributes(key_options)
+      body = body.slice('description', 'name')
 
-      http_patch "/keys/#{key_uid}", body
+      http_patch "/keys/#{uid_or_key}", body
     end
 
-    def delete_key(key_uid)
-      http_delete "/keys/#{key_uid}"
+    def delete_key(uid_or_key)
+      http_delete "/keys/#{uid_or_key}"
     end
 
     ### HEALTH
@@ -105,15 +114,10 @@ module MeiliSearch
       http_post '/dumps'
     end
 
-    def dump_status(dump_uid)
-      http_get "/dumps/#{dump_uid}/status"
-    end
-    alias get_dump_status dump_status
-
     ### TASKS
 
-    def tasks
-      task_endpoint.task_list
+    def tasks(options = {})
+      task_endpoint.task_list(options)
     end
 
     def task(task_uid)

data/lib/meilisearch/http_request.rb

@@ -90,7 +90,10 @@ module MeiliSearch
       {
         'Content-Type' => 'application/json',
         'Authorization' => ("Bearer #{@api_key}" unless @api_key.nil?),
-        'User-Agent' => MeiliSearch.qualified_version
+        'User-Agent' => [
+          @options.fetch(:client_agents, []),
+          MeiliSearch.qualified_version
+        ].flatten.join(';')
       }.compact
     end
 

data/lib/meilisearch/index.rb

@@ -30,7 +30,7 @@ module MeiliSearch
     end
 
     def update(body)
-      http_put indexes_path(id: @uid), Utils.transform_attributes(body)
+      http_patch indexes_path(id: @uid), Utils.transform_attributes(body)
     end
 
     alias update_index update
@@ -54,15 +54,20 @@ module MeiliSearch
 
     ### DOCUMENTS
 
-    def document(document_id)
+    def document(document_id, fields: nil)
       encode_document = URI.encode_www_form_component(document_id)
-      http_get "/indexes/#{@uid}/documents/#{encode_document}"
+      body = { fields: fields&.join(',') }.compact
+
+      http_get("/indexes/#{@uid}/documents/#{encode_document}", body)
     end
     alias get_document document
     alias get_one_document document
 
     def documents(options = {})
-      http_get "/indexes/#{@uid}/documents", Utils.transform_attributes(options)
+      body = Utils.transform_attributes(options.transform_keys(&:to_sym).slice(:limit, :offset, :fields))
+      body = body.transform_values { |v| v.respond_to?(:join) ? v.join(',') : v }
+
+      http_get "/indexes/#{@uid}/documents", body
     end
     alias get_documents documents
 
@@ -75,7 +80,7 @@ module MeiliSearch
 
     def add_documents!(documents, primary_key = nil)
       task = add_documents(documents, primary_key)
-      wait_for_task(task['uid'])
+      wait_for_task(task['taskUid'])
     end
     alias replace_documents! add_documents!
     alias add_or_replace_documents! add_documents!
@@ -109,7 +114,7 @@ module MeiliSearch
 
     def update_documents!(documents, primary_key = nil)
       task = update_documents(documents, primary_key)
-      wait_for_task(task['uid'])
+      wait_for_task(task['taskUid'])
     end
     alias add_or_update_documents! update_documents!
 
@@ -125,7 +130,7 @@ module MeiliSearch
       tasks = add_documents_in_batches(documents, batch_size, primary_key)
       responses = []
       tasks.each do |task_obj|
-        responses.append(wait_for_task(task_obj['uid']))
+        responses.append(wait_for_task(task_obj['taskUid']))
       end
       responses
     end
@@ -142,7 +147,7 @@ module MeiliSearch
       tasks = update_documents_in_batches(documents, batch_size, primary_key)
       responses = []
       tasks.each do |task_obj|
-        responses.append(wait_for_task(task_obj['uid']))
+        responses.append(wait_for_task(task_obj['taskUid']))
       end
       responses
     end
@@ -158,7 +163,7 @@ module MeiliSearch
 
     def delete_documents!(documents_ids)
       task = delete_documents(documents_ids)
-      wait_for_task(task['uid'])
+      wait_for_task(task['taskUid'])
     end
     alias delete_multiple_documents! delete_documents!
 
@@ -170,7 +175,7 @@ module MeiliSearch
 
     def delete_document!(document_id)
       task = delete_document(document_id)
-      wait_for_task(task['uid'])
+      wait_for_task(task['taskUid'])
     end
     alias delete_one_document! delete_document!
 
@@ -180,7 +185,7 @@ module MeiliSearch
 
     def delete_all_documents!
       task = delete_all_documents
-      wait_for_task(task['uid'])
+      wait_for_task(task['taskUid'])
     end
 
     ### SEARCH
@@ -188,7 +193,10 @@ module MeiliSearch
     def search(query, options = {})
       parsed_options = Utils.transform_attributes({ q: query.to_s }.merge(options.compact))
 
-      http_post "/indexes/#{@uid}/search", parsed_options
+      response = http_post "/indexes/#{@uid}/search", parsed_options
+      response['nbHits'] ||= response['estimatedTotalHits']
+
+      response
     end
 
     ### TASKS
@@ -199,7 +207,7 @@ module MeiliSearch
     private :task_endpoint
 
     def task(task_uid)
-      task_endpoint.index_task(@uid, task_uid)
+      task_endpoint.index_task(task_uid)
     end
 
     def tasks
@@ -236,7 +244,7 @@ module MeiliSearch
     alias get_settings settings
 
     def update_settings(settings)
-      http_post "/indexes/#{@uid}/settings", Utils.transform_attributes(settings)
+      http_patch "/indexes/#{@uid}/settings", Utils.transform_attributes(settings)
     end
     alias settings= update_settings
 
@@ -252,7 +260,7 @@ module MeiliSearch
     alias get_ranking_rules ranking_rules
 
     def update_ranking_rules(ranking_rules)
-      http_post "/indexes/#{@uid}/settings/ranking-rules", ranking_rules
+      http_put "/indexes/#{@uid}/settings/ranking-rules", ranking_rules
     end
     alias ranking_rules= update_ranking_rules
 
@@ -268,7 +276,7 @@ module MeiliSearch
     alias get_synonyms synonyms
 
     def update_synonyms(synonyms)
-      http_post "/indexes/#{@uid}/settings/synonyms", synonyms
+      http_put "/indexes/#{@uid}/settings/synonyms", synonyms
     end
     alias synonyms= update_synonyms
 
@@ -285,7 +293,7 @@ module MeiliSearch
 
     def update_stop_words(stop_words)
       body = stop_words.nil? || stop_words.is_a?(Array) ? stop_words : [stop_words]
-      http_post "/indexes/#{@uid}/settings/stop-words", body
+      http_put "/indexes/#{@uid}/settings/stop-words", body
     end
     alias stop_words= update_stop_words
 
@@ -301,7 +309,7 @@ module MeiliSearch
     alias get_distinct_attribute distinct_attribute
 
     def update_distinct_attribute(distinct_attribute)
-      http_post "/indexes/#{@uid}/settings/distinct-attribute", distinct_attribute
+      http_put "/indexes/#{@uid}/settings/distinct-attribute", distinct_attribute
     end
     alias distinct_attribute= update_distinct_attribute
 
@@ -317,7 +325,7 @@ module MeiliSearch
     alias get_searchable_attributes searchable_attributes
 
     def update_searchable_attributes(searchable_attributes)
-      http_post "/indexes/#{@uid}/settings/searchable-attributes", searchable_attributes
+      http_put "/indexes/#{@uid}/settings/searchable-attributes", searchable_attributes
     end
     alias searchable_attributes= update_searchable_attributes
 
@@ -333,7 +341,7 @@ module MeiliSearch
     alias get_displayed_attributes displayed_attributes
 
     def update_displayed_attributes(displayed_attributes)
-      http_post "/indexes/#{@uid}/settings/displayed-attributes", displayed_attributes
+      http_put "/indexes/#{@uid}/settings/displayed-attributes", displayed_attributes
     end
     alias displayed_attributes= update_displayed_attributes
 
@@ -349,7 +357,7 @@ module MeiliSearch
     alias get_filterable_attributes filterable_attributes
 
     def update_filterable_attributes(filterable_attributes)
-      http_post "/indexes/#{@uid}/settings/filterable-attributes", filterable_attributes
+      http_put "/indexes/#{@uid}/settings/filterable-attributes", filterable_attributes
     end
     alias filterable_attributes= update_filterable_attributes
 
@@ -365,12 +373,58 @@ module MeiliSearch
     alias get_sortable_attributes sortable_attributes
 
     def update_sortable_attributes(sortable_attributes)
-      http_post "/indexes/#{@uid}/settings/sortable-attributes", sortable_attributes
+      http_put "/indexes/#{@uid}/settings/sortable-attributes", sortable_attributes
     end
     alias sortable_attributes= update_sortable_attributes
 
     def reset_sortable_attributes
       http_delete "/indexes/#{@uid}/settings/sortable-attributes"
     end
+
+    ### SETTINGS - PAGINATION
+
+    def pagination
+      http_get("/indexes/#{@uid}/settings/pagination")
+    end
+    alias get_pagination pagination
+
+    def update_pagination(pagination)
+      http_patch "/indexes/#{@uid}/settings/pagination", pagination
+    end
+    alias pagination= update_sortable_attributes
+
+    def reset_pagination
+      http_delete "/indexes/#{@uid}/settings/pagination"
+    end
+
+    def typo_tolerance
+      http_get("/indexes/#{@uid}/settings/typo-tolerance")
+    end
+    alias get_typo_tolerance typo_tolerance
+
+    def update_typo_tolerance(typo_tolerance_attributes)
+      attributes = Utils.transform_attributes(typo_tolerance_attributes)
+      http_patch("/indexes/#{@uid}/settings/typo-tolerance", attributes)
+    end
+    alias typo_tolerance= update_typo_tolerance
+
+    def reset_typo_tolerance
+      http_delete("/indexes/#{@uid}/settings/typo-tolerance")
+    end
+
+    def faceting
+      http_get("/indexes/#{@uid}/settings/faceting")
+    end
+    alias get_faceting faceting
+
+    def update_faceting(faceting_attributes)
+      attributes = Utils.transform_attributes(faceting_attributes)
+      http_patch("/indexes/#{@uid}/settings/faceting", attributes)
+    end
+    alias faceting= update_faceting
+
+    def reset_faceting
+      http_delete("/indexes/#{@uid}/settings/faceting")
+    end
   end
 end

data/lib/meilisearch/task.rb

@@ -5,8 +5,13 @@ require 'timeout'
 
 module MeiliSearch
   class Task < HTTPRequest
-    def task_list
-      http_get '/tasks/'
+    ALLOWED_PARAMS = [:limit, :from, :index_uid, :type, :status].freeze
+
+    def task_list(options = {})
+      body = Utils.transform_attributes(options.transform_keys(&:to_sym).slice(*ALLOWED_PARAMS))
+      body = body.transform_values { |v| v.respond_to?(:join) ? v.join(',') : v }
+
+      http_get '/tasks/', body
     end
 
     def task(task_uid)
@@ -14,11 +19,11 @@ module MeiliSearch
     end
 
     def index_tasks(index_uid)
-      http_get "/indexes/#{index_uid}/tasks"
+      http_get '/tasks', { indexUid: [index_uid].flatten.join(',') }
     end
 
-    def index_task(index_uid, task_uid)
-      http_get "/indexes/#{index_uid}/tasks/#{task_uid}"
+    def index_task(task_uid)
+      http_get "/tasks/#{task_uid}"
     end
 
     def wait_for_task(task_uid, timeout_in_ms = 5000, interval_in_ms = 50)

data/lib/meilisearch/tenant_token.rb

@@ -7,21 +7,21 @@ module MeiliSearch
       alg: 'HS256'
     }.freeze
 
-    def generate_tenant_token(search_rules, api_key: nil, expires_at: nil)
+    def generate_tenant_token(api_key_uid, search_rules, api_key: nil, expires_at: nil)
       signature = retrieve_valid_key!(api_key, @api_key)
       expiration = validate_expires_at!(expires_at)
       rules = validate_search_rules!(search_rules)
-      unsigned_data = build_payload(expiration, rules, signature)
+      unsigned_data = build_payload(expiration, rules, api_key_uid)
 
       combine(unsigned_data, to_base64(sign_data(signature, unsigned_data)))
     end
 
     private
 
-    def build_payload(expiration, rules, signature)
+    def build_payload(expiration, rules, api_key_uid)
       payload = {
         searchRules: rules,
-        apiKeyPrefix: signature[0..7],
+        apiKeyUid: api_key_uid,
         exp: expiration
       }
 

data/lib/meilisearch/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module MeiliSearch
-  VERSION = '0.18.3'
+  VERSION = '0.19.2'
 
   def self.qualified_version
     "Meilisearch Ruby (v#{VERSION})"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: meilisearch
 version: !ruby/object:Gem::Version
-  version: 0.18.3
+  version: 0.19.2
 platform: ruby
 authors:
 - Meili
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-09 00:00:00.000000000 Z
+date: 2022-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty