meilisearch 0.18.1 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6309d55fa663d9fd8126c1bbf290313ddab29e0e8e72ee690b0abe49887d6097
-  data.tar.gz: 2386993d60f7fa52c38e10d58e191a0f0797a3672de31a36b5c1013440285584
+  metadata.gz: c9f1a9263f33fa8d970a5e29e89ce13b213deaaa187c557e6122e2960973e22b
+  data.tar.gz: 5aeed7da3ed485ee621db8ea182574e50681cd1efe8a5d58430cce271c17e304
 SHA512:
-  metadata.gz: d50aa62ffebcd4d707fc55471e8738d9dd53433c77af3f1bb08e3681395ee19eb35513bc14a1e769bf223a9e16622805dc1010d06b4b84c2252237d1eb5a8b97
-  data.tar.gz: fff2a910e52b6c137037c3b011ddba3b0d11d28fd2427c1b4d45e925e2b28711c4e0fca269309de9b97dd99df980e4ed067b322c7148c0fde68a14ce4fe7d388
+  metadata.gz: 976733a7fa10473cc9cc2a972d70b50e70c4911fcf210d256f8407042040ef2314d3ae180d9946d6b7e68fb2ea24a219b3748bb9f4b88f0e8a725951a5718e92
+  data.tar.gz: ca1bbd991097e90eebfcc0aa08ecb71e7234453dfb9ab4d67dd6d30036af39992e769674e9fe2f98758cc77e7597f4637071170811ea4b9bb1ba9db5e68871fa

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019-2021 Meili
+Copyright (c) 2019-2022 Meili SAS
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

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.25.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.25.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

@@ -1,19 +1,25 @@
 # frozen_string_literal: true
 
-require 'meilisearch/http_request'
-
 module MeiliSearch
   class Client < HTTPRequest
+    include MeiliSearch::TenantToken
+
     ### 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/error.rb

@@ -57,9 +57,15 @@ module MeiliSearch
   class TimeoutError < StandardError
     attr_reader :message
 
-    def initialize
-      @message = 'The update was not processed in the expected time'
+    def initialize(message = nil)
+      @message = "The request was not processed in the expected time. #{message}"
       super(@message)
     end
   end
+
+  module TenantToken
+    class ExpireOrInvalidSignature < StandardError; end
+    class InvalidApiKey < StandardError; end
+    class InvalidSearchRules < StandardError; end
+  end
 end

data/lib/meilisearch/http_request.rb

@@ -103,8 +103,10 @@ module MeiliSearch
 
       begin
         response = http_method.call(@base_url + relative_path, config)
-      rescue Errno::ECONNREFUSED => e
+      rescue Errno::ECONNREFUSED, Errno::EPIPE => e
         raise CommunicationError, e.message
+      rescue Net::ReadTimeout, Net::OpenTimeout => e
+        raise TimeoutError, e.message
       end
 
       validate(response)

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
@@ -199,7 +204,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 +241,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 +257,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 +273,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 +290,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 +306,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 +322,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 +338,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 +354,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,7 +370,7 @@ 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
 

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

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module MeiliSearch
+  module TenantToken
+    HEADER = {
+      typ: 'JWT',
+      alg: 'HS256'
+    }.freeze
+
+    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, api_key_uid)
+
+      combine(unsigned_data, to_base64(sign_data(signature, unsigned_data)))
+    end
+
+    private
+
+    def build_payload(expiration, rules, api_key_uid)
+      payload = {
+        searchRules: rules,
+        apiKeyUid: api_key_uid,
+        exp: expiration
+      }
+
+      combine(encode(HEADER), encode(payload))
+    end
+
+    def validate_expires_at!(expires_at)
+      return unless expires_at
+      return expires_at.to_i if expires_at.utc? && expires_at > Time.now.utc
+
+      raise
+    rescue StandardError
+      raise ExpireOrInvalidSignature
+    end
+
+    def validate_search_rules!(data)
+      return data if data
+
+      raise InvalidSearchRules
+    end
+
+    def retrieve_valid_key!(*keys)
+      key = keys.compact.find { |k| !k.empty? }
+
+      raise InvalidApiKey if key.nil?
+
+      key
+    end
+
+    def sign_data(key, msg)
+      OpenSSL::HMAC.digest('SHA256', key, msg)
+    end
+
+    def to_base64(data)
+      Base64.urlsafe_encode64(data, padding: false)
+    end
+
+    def encode(data)
+      to_base64(JSON.generate(data))
+    end
+
+    def combine(*parts)
+      parts.join('.')
+    end
+  end
+end

data/lib/meilisearch/version.rb

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

data/lib/meilisearch.rb

@@ -2,6 +2,8 @@
 
 require 'meilisearch/version'
 require 'meilisearch/utils'
+require 'meilisearch/http_request'
+require 'meilisearch/tenant_token'
 require 'meilisearch/task'
 require 'meilisearch/client'
 require 'meilisearch/index'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: meilisearch
 version: !ruby/object:Gem::Version
-  version: 0.18.1
+  version: 0.19.0
 platform: ruby
 authors:
 - Meili
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-01 00:00:00.000000000 Z
+date: 2022-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -44,6 +44,7 @@ files:
 - lib/meilisearch/http_request.rb
 - lib/meilisearch/index.rb
 - lib/meilisearch/task.rb
+- lib/meilisearch/tenant_token.rb
 - lib/meilisearch/utils.rb
 - lib/meilisearch/version.rb
 homepage: https://github.com/meilisearch/meilisearch-ruby