meilisearch 0.17.3 → 0.18.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c90df98b1b08039b339c49b47bfd052639e1301e9e7e3b25989b9ce6e3d1e67
-  data.tar.gz: 3f200a9de09db7a47780b01aa20a8ce5b2b1d0d0579954cd8842cb208b06b4dc
+  metadata.gz: 9b69f3c0d8bf43393b59abe4e44aabf40ff673dd08bde8f6e60d1c996be8b7bf
+  data.tar.gz: d2ff90fe7e1cf738dc4e3297cf7e7215e80c7a63317d06144681fab39206d1b2
 SHA512:
-  metadata.gz: b3b38312517176303e9fdc49af5c38647ea4d719d8988cb1e1fd60839e7c593226fd9369febd24a326d214dbb606acd201464fd6590f46438383cf25f3e7e934
-  data.tar.gz: 494fa30322be3d624851117e460c31046c51ea3ef4d00326f4be969a76f5f056a15147c065b1ef02a56f3a589643e137ac4af1a05a088bab606cdf6d31bc8abc
+  metadata.gz: 59dfc2b7ced1fec8a75c32b4b02b49d42a8a63af862bcb86931692be8e9c92b89657b93958c150937ddbe295d645eff5192a181ef439885462c2f6174c1519c3
+  data.tar.gz: 71b81d762f8c609a7e2d50ac0052e6c8e0b904c28b2cb7b98f0c55934122c97c1160a4c0b4a2659adcf474a59be85ea609a75183e69550ca4971d177afb8e2b0

data/README.md

@@ -1,11 +1,11 @@
 <p align="center">
-  <img src="https://res.cloudinary.com/meilisearch/image/upload/v1587402338/SDKs/meilisearch_ruby.svg" alt="MeiliSearch-Ruby" width="200" height="200" />
+  <img src="https://raw.githubusercontent.com/meilisearch/integration-guides/main/assets/logos/meilisearch_ruby.svg" alt="Meilisearch-Ruby" width="200" height="200" />
 </p>
 
-<h1 align="center">MeiliSearch Ruby</h1>
+<h1 align="center">Meilisearch Ruby</h1>
 
 <h4 align="center">
-  <a href="https://github.com/meilisearch/MeiliSearch">MeiliSearch</a> |
+  <a href="https://github.com/meilisearch/meilisearch">Meilisearch</a> |
   <a href="https://docs.meilisearch.com">Documentation</a> |
   <a href="https://slack.meilisearch.com">Slack</a> |
   <a href="https://roadmap.meilisearch.com/tabs/1-under-consideration">Roadmap</a> |
@@ -17,21 +17,21 @@
   <a href="https://badge.fury.io/rb/meilisearch"><img src="https://badge.fury.io/rb/meilisearch.svg" alt="Latest Stable Version"></a>
   <a href="https://github.com/meilisearch/meilisearch-ruby/actions"><img src="https://github.com/meilisearch/meilisearch-ruby/workflows/Tests/badge.svg" alt="Test"></a>
   <a href="https://github.com/meilisearch/meilisearch-ruby/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-informational" alt="License"></a>
-  <a href="https://app.bors.tech/repositories/28781"><img src="https://bors.tech/images/badge_small.svg" alt="Bors enabled"></a>
+  <a href="https://ms-bors.herokuapp.com/repositories/6"><img src="https://bors.tech/images/badge_small.svg" alt="Bors enabled"></a>
 </p>
 
-<p align="center">⚡ The MeiliSearch API client written for Ruby 💎</p>
+<p align="center">⚡ The Meilisearch API client written for Ruby 💎</p>
 
-**MeiliSearch Ruby** is the MeiliSearch API client for Ruby developers.
+**Meilisearch Ruby** is the Meilisearch API client for Ruby developers.
 
-**MeiliSearch** is an open-source search engine. [Discover what MeiliSearch is!](https://github.com/meilisearch/MeiliSearch)
+**Meilisearch** is an open-source search engine. [Discover what Meilisearch is!](https://github.com/meilisearch/meilisearch)
 
 ## Table of Contents <!-- omit in toc -->
 
 - [📖 Documentation](#-documentation)
 - [🔧 Installation](#-installation)
 - [🚀 Getting Started](#-getting-started)
-- [🤖 Compatibility with MeiliSearch](#-compatibility-with-meilisearch)
+- [🤖 Compatibility with Meilisearch](#-compatibility-with-meilisearch)
 - [💡 Learn More](#-learn-more)
 - [⚙️ Development Workflow and Contributing](#️-development-workflow-and-contributing)
 
@@ -55,21 +55,21 @@ source 'https://rubygems.org'
 gem 'meilisearch'
 ```
 
-### Run MeiliSearch <!-- omit in toc -->
+### Run Meilisearch <!-- omit in toc -->
 
-There are many easy ways to [download and run a MeiliSearch instance](https://docs.meilisearch.com/reference/features/installation.html#download-and-launch).
+There are many easy ways to [download and run a Meilisearch instance](https://docs.meilisearch.com/reference/features/installation.html#download-and-launch).
 
 For example, using the `curl` command in your [Terminal](https://itconnect.uw.edu/learn/workshops/online-tutorials/web-publishing/what-is-a-terminal/):
 
 ```sh
-#Install MeiliSearch
+#Install Meilisearch
 curl -L https://install.meilisearch.com | sh
 
-# Launch MeiliSearch
+# Launch Meilisearch
 ./meilisearch --master-key=masterKey
 ```
 
-NB: you can also download MeiliSearch from **Homebrew** or **APT** or even run it using **Docker**.
+NB: you can also download Meilisearch from **Homebrew** or **APT** or even run it using **Docker**.
 
 ## 🚀 Getting Started
 
@@ -91,18 +91,18 @@ documents = [
   { id: 5, title: 'Moana', genres: ['Fantasy', 'Action']},
   { id: 6, title: 'Philadelphia', genres: ['Drama'] },
 ]
-# If the index 'movies' does not exist, MeiliSearch creates it when you first add the documents.
-index.add_documents(documents) # => { "updateId": 0 }
+# If the index 'movies' does not exist, Meilisearch creates it when you first add the documents.
+index.add_documents(documents) # => { "uid": 0 }
 ```
 
-With the `updateId`, you can check the status (`enqueued`, `processing`, `processed` or `failed`) of your documents addition using the [update endpoint](https://docs.meilisearch.com/reference/api/updates.html#get-an-update-status).
+With the `uid`, you can check the status (`enqueued`, `processing`, `succeeded` or `failed`) of your documents addition using the [task](https://docs.meilisearch.com/reference/api/tasks.html#get-task).
 
 💡 To customize the `Client`, for example, increasing the default timeout, please check out [this section](https://github.com/meilisearch/meilisearch-ruby/wiki/Client-Options) of the Wiki.
 
 #### Basic Search <!-- omit in toc -->
 
 ``` ruby
-# MeiliSearch is typo-tolerant:
+# Meilisearch is typo-tolerant:
 puts index.search('carlo')
 ```
 Output:
@@ -165,7 +165,7 @@ index.update_filterable_attributes([
 
 You only need to perform this operation once.
 
-Note that MeiliSearch will rebuild your index whenever you update `filterableAttributes`. Depending on the size of your dataset, this might take time. You can track the process using the [update status](https://docs.meilisearch.com/reference/api/updates.html#get-an-update-status).
+Note that Meilisearch will rebuild your index whenever you update `filterableAttributes`. Depending on the size of your dataset, this might take time. You can track the process using the [tasks](https://docs.meilisearch.com/reference/api/tasks.html#get-task)).
 
 Then, you can perform the search:
 
@@ -196,9 +196,9 @@ JSON output:
 }
 ```
 
-## 🤖 Compatibility with MeiliSearch
+## 🤖 Compatibility with Meilisearch
 
-This package only guarantees the compatibility with the [version v0.24.0 of MeiliSearch](https://github.com/meilisearch/MeiliSearch/releases/tag/v0.24.0).
+This package only guarantees the compatibility with the [version v0.26.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.26.0).
 
 ## 💡 Learn More
 
@@ -219,4 +219,4 @@ If you want to know more about the development workflow or want to contribute, p
 
 <hr>
 
-**MeiliSearch** provides and maintains many **SDKs and Integration tools** like this one. We want to provide everyone with an **amazing search experience for any kind of project**. If you want to contribute, make suggestions, or just know what's going on right now, visit us in the [integration-guides](https://github.com/meilisearch/integration-guides) repository.
+**Meilisearch** provides and maintains many **SDKs and Integration tools** like this one. We want to provide everyone with an **amazing search experience for any kind of project**. If you want to contribute, make suggestions, or just know what's going on right now, visit us in the [integration-guides](https://github.com/meilisearch/integration-guides) repository.

data/lib/meilisearch/client.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require 'meilisearch/http_request'
-
 module MeiliSearch
   class Client < HTTPRequest
+    include MeiliSearch::TenantToken
+
     ### INDEXES
 
     def raw_indexes
@@ -22,36 +22,20 @@ module MeiliSearch
     def create_index(index_uid, options = {})
       body = Utils.transform_attributes(options.merge(uid: index_uid))
 
-      index_hash = http_post '/indexes', body
-      index_object(index_hash['uid'], index_hash['primaryKey'])
+      http_post '/indexes', body
     end
 
-    def get_or_create_index(index_uid, options = {})
-      begin
-        index_instance = fetch_index(index_uid)
-      rescue ApiError => e
-        raise e unless e.code == 'index_not_found'
-
-        index_instance = create_index(index_uid, options)
-      end
-      index_instance
+    # Synchronous version of create_index.
+    # 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'])
     end
 
     def delete_index(index_uid)
       index_object(index_uid).delete
     end
 
-    # Usage:
-    # client.delete_index_if_exists('indexUID')
-    def delete_index_if_exists(index_uid)
-      index_object(index_uid).delete
-      true
-    rescue ApiError => e
-      raise e if e.code != 'index_not_found'
-
-      false
-    end
-
     # Usage:
     # client.index('indexUID')
     def index(index_uid)
@@ -71,7 +55,26 @@ module MeiliSearch
     def keys
       http_get '/keys'
     end
-    alias get_keys keys
+
+    def key(key_uid)
+      http_get "/keys/#{key_uid}"
+    end
+
+    def create_key(key_options)
+      body = Utils.transform_attributes(key_options)
+
+      http_post '/keys', body
+    end
+
+    def update_key(key_uid, key_options)
+      body = Utils.transform_attributes(key_options)
+
+      http_patch "/keys/#{key_uid}", body
+    end
+
+    def delete_key(key_uid)
+      http_delete "/keys/#{key_uid}"
+    end
 
     ### HEALTH
 
@@ -107,10 +110,28 @@ module MeiliSearch
     end
     alias get_dump_status dump_status
 
+    ### TASKS
+
+    def tasks
+      task_endpoint.task_list
+    end
+
+    def task(task_uid)
+      task_endpoint.task(task_uid)
+    end
+
+    def wait_for_task(task_uid, timeout_in_ms = 5000, interval_in_ms = 50)
+      task_endpoint.wait_for_task(task_uid, timeout_in_ms, interval_in_ms)
+    end
+
     private
 
     def index_object(uid, primary_key = nil)
       Index.new(uid, @base_url, @api_key, primary_key, @options)
     end
+
+    def task_endpoint
+      @task_endpoint ||= Task.new(@base_url, @api_key, @options)
+    end
   end
 end

data/lib/meilisearch/error.rb

@@ -62,4 +62,10 @@ module MeiliSearch
       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

@@ -7,25 +7,30 @@ module MeiliSearch
   class HTTPRequest
     include HTTParty
 
-    attr_reader :options
+    attr_reader :options, :headers
+
+    DEFAULT_OPTIONS = {
+      timeout: 1,
+      max_retries: 0,
+      convert_body?: true
+    }.freeze
 
     def initialize(url, api_key = nil, options = {})
       @base_url = url
       @api_key = api_key
-      @options = merge_options({
-                                 timeout: 1,
-                                 max_retries: 0,
-                                 headers: build_default_options_headers(api_key),
-                                 convert_body?: true
-                               }, options)
+      @options = DEFAULT_OPTIONS.merge(options)
+      @headers = build_default_options_headers
     end
 
     def http_get(relative_path = '', query_params = {})
       send_request(
         proc { |path, config| self.class.get(path, config) },
         relative_path,
-        query_params: query_params,
-        options: remove_options_header(@options, 'Content-Type')
+        config: {
+          query_params: query_params,
+          headers: remove_headers(@headers.dup, 'Content-Type'),
+          options: @options
+        }
       )
     end
 
@@ -33,9 +38,12 @@ module MeiliSearch
       send_request(
         proc { |path, config| self.class.post(path, config) },
         relative_path,
-        query_params: query_params,
-        body: body,
-        options: merge_options(@options, options)
+        config: {
+          query_params: query_params,
+          body: body,
+          headers: @headers.dup.merge(options[:headers] || {}),
+          options: @options.merge(options)
+        }
       )
     end
 
@@ -43,9 +51,25 @@ module MeiliSearch
       send_request(
         proc { |path, config| self.class.put(path, config) },
         relative_path,
-        query_params: query_params,
-        body: body,
-        options: @options
+        config: {
+          query_params: query_params,
+          body: body,
+          headers: @headers,
+          options: @options
+        }
+      )
+    end
+
+    def http_patch(relative_path = '', body = nil, query_params = nil)
+      send_request(
+        proc { |path, config| self.class.patch(path, config) },
+        relative_path,
+        config: {
+          query_params: query_params,
+          body: body,
+          headers: @headers,
+          options: @options
+        }
       )
     end
 
@@ -53,52 +77,43 @@ module MeiliSearch
       send_request(
         proc { |path, config| self.class.delete(path, config) },
         relative_path,
-        options: remove_options_header(@options, 'Content-Type')
+        config: {
+          headers: remove_headers(@headers.dup, 'Content-Type'),
+          options: @options
+        }
       )
     end
 
     private
 
-    def build_default_options_headers(api_key = nil)
+    def build_default_options_headers
       {
         'Content-Type' => 'application/json',
-        'X-Meili-API-Key' => api_key
+        'Authorization' => ("Bearer #{@api_key}" unless @api_key.nil?),
+        'User-Agent' => MeiliSearch.qualified_version
       }.compact
     end
 
-    def merge_options(default_options, added_options = {})
-      default_cloned_headers = default_options[:headers].clone
-      merged_options = default_options.merge(added_options)
-      merged_options[:headers] = default_cloned_headers.merge(added_options[:headers]) if added_options.key?(:headers)
-      merged_options
-    end
-
-    def remove_options_header(options, key)
-      cloned_options = clone_options(options)
-      cloned_options[:headers].tap { |headers| headers.delete(key) }
-      cloned_options
+    def remove_headers(data, *keys)
+      data.delete_if { |k| keys.include?(k) }
     end
 
-    def clone_options(options)
-      cloned_options = options.clone
-      cloned_options[:headers] = options[:headers].clone
-      cloned_options
-    end
+    def send_request(http_method, relative_path, config: {})
+      config = http_config(config[:query_params], config[:body], config[:options], config[:headers])
 
-    def send_request(http_method, relative_path, query_params: nil, body: nil, options: {})
-      config = http_config(query_params, body, options)
       begin
         response = http_method.call(@base_url + relative_path, config)
       rescue Errno::ECONNREFUSED => e
         raise CommunicationError, e.message
       end
+
       validate(response)
     end
 
-    def http_config(query_params, body, options)
+    def http_config(query_params, body, options, headers)
       body = body.to_json if options[:convert_body?] == true
       {
-        headers: options[:headers],
+        headers: headers,
         query: query_params,
         body: body,
         timeout: options[:timeout],

data/lib/meilisearch/index.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'meilisearch/http_request'
-require 'timeout'
 
 module MeiliSearch
   class Index < HTTPRequest
@@ -31,10 +30,7 @@ module MeiliSearch
     end
 
     def update(body)
-      index_hash = http_put indexes_path(id: @uid), Utils.transform_attributes(body)
-      set_base_properties index_hash
-
-      self
+      http_put indexes_path(id: @uid), Utils.transform_attributes(body)
     end
 
     alias update_index update
@@ -78,14 +74,14 @@ module MeiliSearch
     alias add_or_replace_documents add_documents
 
     def add_documents!(documents, primary_key = nil)
-      update = add_documents(documents, primary_key)
-      wait_for_pending_update(update['updateId'])
+      task = add_documents(documents, primary_key)
+      wait_for_task(task['uid'])
     end
     alias replace_documents! add_documents!
     alias add_or_replace_documents! add_documents!
 
     def add_documents_json(documents, primary_key = nil)
-      options = { headers: { 'Content-Type' => 'application/json' }, convert_body?: false }
+      options = { convert_body?: false }
       http_post "/indexes/#{@uid}/documents", documents, { primaryKey: primary_key }.compact, options
     end
     alias replace_documents_json add_documents_json
@@ -112,41 +108,41 @@ module MeiliSearch
     alias add_or_update_documents update_documents
 
     def update_documents!(documents, primary_key = nil)
-      update = update_documents(documents, primary_key)
-      wait_for_pending_update(update['updateId'])
+      task = update_documents(documents, primary_key)
+      wait_for_task(task['uid'])
     end
     alias add_or_update_documents! update_documents!
 
     def add_documents_in_batches(documents, batch_size = 1000, primary_key = nil)
-      update_ids = []
+      tasks = []
       documents.each_slice(batch_size) do |batch|
-        update_ids.append(add_documents(batch, primary_key))
+        tasks.append(add_documents(batch, primary_key))
       end
-      update_ids
+      tasks
     end
 
     def add_documents_in_batches!(documents, batch_size = 1000, primary_key = nil)
-      update_ids = add_documents_in_batches(documents, batch_size, primary_key)
+      tasks = add_documents_in_batches(documents, batch_size, primary_key)
       responses = []
-      update_ids.each do |update_object|
-        responses.append(wait_for_pending_update(update_object['updateId']))
+      tasks.each do |task_obj|
+        responses.append(wait_for_task(task_obj['uid']))
       end
       responses
     end
 
     def update_documents_in_batches(documents, batch_size = 1000, primary_key = nil)
-      update_ids = []
+      tasks = []
       documents.each_slice(batch_size) do |batch|
-        update_ids.append(update_documents(batch, primary_key))
+        tasks.append(update_documents(batch, primary_key))
       end
-      update_ids
+      tasks
     end
 
     def update_documents_in_batches!(documents, batch_size = 1000, primary_key = nil)
-      update_ids = update_documents_in_batches(documents, batch_size, primary_key)
+      tasks = update_documents_in_batches(documents, batch_size, primary_key)
       responses = []
-      update_ids.each do |update_object|
-        responses.append(wait_for_pending_update(update_object['updateId']))
+      tasks.each do |task_obj|
+        responses.append(wait_for_task(task_obj['uid']))
       end
       responses
     end
@@ -161,8 +157,8 @@ module MeiliSearch
     alias delete_multiple_documents delete_documents
 
     def delete_documents!(documents_ids)
-      update = delete_documents(documents_ids)
-      wait_for_pending_update(update['updateId'])
+      task = delete_documents(documents_ids)
+      wait_for_task(task['uid'])
     end
     alias delete_multiple_documents! delete_documents!
 
@@ -173,8 +169,8 @@ module MeiliSearch
     alias delete_one_document delete_document
 
     def delete_document!(document_id)
-      update = delete_document(document_id)
-      wait_for_pending_update(update['updateId'])
+      task = delete_document(document_id)
+      wait_for_task(task['uid'])
     end
     alias delete_one_document! delete_document!
 
@@ -183,8 +179,8 @@ module MeiliSearch
     end
 
     def delete_all_documents!
-      update = delete_all_documents
-      wait_for_pending_update(update['updateId'])
+      task = delete_all_documents
+      wait_for_task(task['uid'])
     end
 
     ### SEARCH
@@ -195,31 +191,23 @@ module MeiliSearch
       http_post "/indexes/#{@uid}/search", parsed_options
     end
 
-    ### UPDATES
+    ### TASKS
 
-    def get_update_status(update_id)
-      http_get "/indexes/#{@uid}/updates/#{update_id}"
+    def task_endpoint
+      @task_endpoint ||= Task.new(@base_url, @api_key, @options)
     end
+    private :task_endpoint
 
-    def get_all_update_status
-      http_get "/indexes/#{@uid}/updates"
+    def task(task_uid)
+      task_endpoint.index_task(@uid, task_uid)
     end
 
-    def achieved_upate?(update)
-      update['status'] != 'enqueued' && update['status'] != 'processing'
+    def tasks
+      task_endpoint.index_tasks(@uid)
     end
 
-    def wait_for_pending_update(update_id, timeout_in_ms = 5000, interval_in_ms = 50)
-      Timeout.timeout(timeout_in_ms.to_f / 1000) do
-        loop do
-          get_update = get_update_status(update_id)
-          return get_update if achieved_upate?(get_update)
-
-          sleep interval_in_ms.to_f / 1000
-        end
-      end
-    rescue Timeout::Error
-      raise MeiliSearch::TimeoutError
+    def wait_for_task(task_uid, timeout_in_ms = 5000, interval_in_ms = 50)
+      task_endpoint.wait_for_task(task_uid, timeout_in_ms, interval_in_ms)
     end
 
     ### STATS
@@ -236,10 +224,6 @@ module MeiliSearch
       stats['isIndexing']
     end
 
-    def last_update
-      stats['lastUpdate']
-    end
-
     def field_distribution
       stats['fieldDistribution']
     end

data/lib/meilisearch/task.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'meilisearch/http_request'
+require 'timeout'
+
+module MeiliSearch
+  class Task < HTTPRequest
+    def task_list
+      http_get '/tasks/'
+    end
+
+    def task(task_uid)
+      http_get "/tasks/#{task_uid}"
+    end
+
+    def index_tasks(index_uid)
+      http_get "/indexes/#{index_uid}/tasks"
+    end
+
+    def index_task(index_uid, task_uid)
+      http_get "/indexes/#{index_uid}/tasks/#{task_uid}"
+    end
+
+    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 = task(task_uid)
+          return task if achieved_task?(task)
+
+          sleep interval_in_ms.to_f / 1000
+        end
+      end
+    rescue Timeout::Error
+      raise MeiliSearch::TimeoutError
+    end
+
+    private
+
+    def achieved_task?(task)
+      task['status'] != 'enqueued' && task['status'] != 'processing'
+    end
+  end
+end

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(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)
+
+      combine(unsigned_data, to_base64(sign_data(signature, unsigned_data)))
+    end
+
+    private
+
+    def build_payload(expiration, rules, signature)
+      payload = {
+        searchRules: rules,
+        apiKeyPrefix: signature[0..7],
+        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,5 +1,9 @@
 # frozen_string_literal: true
 
 module MeiliSearch
-  VERSION = '0.17.3'
+  VERSION = '0.18.2'
+
+  def self.qualified_version
+    "Meilisearch Ruby (v#{VERSION})"
+  end
 end

data/lib/meilisearch.rb

@@ -2,6 +2,9 @@
 
 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.17.3
+  version: 0.18.2
 platform: ruby
 authors:
 - Meili
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-13 00:00:00.000000000 Z
+date: 2022-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -30,7 +30,7 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: 0.21.0
-description: An easy-to-use ruby client for Meilisearch API. See https://github.com/meilisearch/MeiliSearch
+description: An easy-to-use ruby client for Meilisearch API. See https://github.com/meilisearch/meilisearch
 email: bonjour@meilisearch.com
 executables: []
 extensions: []
@@ -43,6 +43,8 @@ files:
 - lib/meilisearch/error.rb
 - 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