meilisearch 0.17.1 → 0.18.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d989f446194c8260cc87880abfaaf641d0e4b88ae80300d7f9d99fd4c6edfd2e
-  data.tar.gz: cbec6b1faeab1d84990b7b1390eb386e536bbaa2442231593d1377b5a5ba0da4
+  metadata.gz: 6309d55fa663d9fd8126c1bbf290313ddab29e0e8e72ee690b0abe49887d6097
+  data.tar.gz: 2386993d60f7fa52c38e10d58e191a0f0797a3672de31a36b5c1013440285584
 SHA512:
-  metadata.gz: 328b4fcec0d6ca099c34ee40340a5a191cec576cbef198a4b0a18fd0afaa1c77708146531204347e67a0037599a35b7caa514940674f28e5a8b06ecaba7ba55c
-  data.tar.gz: db01b2e587efc423138437505840b73879d26a0a5d340eb3f1ea56753b8e2f7eaba6f13b22e1a464c8bfec9728b1af42e0c164a735e624844a1a81a99504bd5f
+  metadata.gz: d50aa62ffebcd4d707fc55471e8738d9dd53433c77af3f1bb08e3681395ee19eb35513bc14a1e769bf223a9e16622805dc1010d06b4b84c2252237d1eb5a8b97
+  data.tar.gz: fff2a910e52b6c137037c3b011ddba3b0d11d28fd2427c1b4d45e925e2b28711c4e0fca269309de9b97dd99df980e4ed067b322c7148c0fde68a14ce4fe7d388

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019-2021 Meili
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,222 @@
+<p align="center">
+  <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>
+
+<h4 align="center">
+  <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> |
+  <a href="https://www.meilisearch.com">Website</a> |
+  <a href="https://docs.meilisearch.com/faq">FAQ</a>
+</h4>
+
+<p align="center">
+  <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://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>
+
+**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)
+
+## Table of Contents <!-- omit in toc -->
+
+- [📖 Documentation](#-documentation)
+- [🔧 Installation](#-installation)
+- [🚀 Getting Started](#-getting-started)
+- [🤖 Compatibility with Meilisearch](#-compatibility-with-meilisearch)
+- [💡 Learn More](#-learn-more)
+- [⚙️ Development Workflow and Contributing](#️-development-workflow-and-contributing)
+
+## 📖 Documentation
+
+See our [Documentation](https://docs.meilisearch.com/learn/tutorials/getting_started.html) or our [API References](https://docs.meilisearch.com/reference/api/).
+
+## 🔧 Installation
+
+This package requires Ruby version 2.6.0 or later.
+
+With `gem` in command line:
+```bash
+gem install meilisearch
+```
+
+In your `Gemfile` with [bundler](https://bundler.io/):
+```ruby
+source 'https://rubygems.org'
+
+gem 'meilisearch'
+```
+
+### 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).
+
+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
+curl -L https://install.meilisearch.com | sh
+
+# Launch Meilisearch
+./meilisearch --master-key=masterKey
+```
+
+NB: you can also download Meilisearch from **Homebrew** or **APT** or even run it using **Docker**.
+
+## 🚀 Getting Started
+
+#### Add documents <!-- omit in toc -->
+
+```ruby
+require 'meilisearch'
+
+client = MeiliSearch::Client.new('http://127.0.0.1:7700', 'masterKey')
+
+# An index is where the documents are stored.
+index = client.index('movies')
+
+documents = [
+  { id: 1, title: 'Carol', genres: ['Romance', 'Drama'] },
+  { id: 2, title: 'Wonder Woman', genres: ['Action', 'Adventure'] },
+  { id: 3, title: 'Life of Pi', genres: ['Adventure', 'Drama'] },
+  { id: 4, title: 'Mad Max: Fury Road', genres: ['Adventure', 'Science Fiction'] },
+  { 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) # => { "uid": 0 }
+```
+
+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:
+puts index.search('carlo')
+```
+Output:
+
+```ruby
+{
+  "hits" => [{
+    "id" => 1,
+    "title" => "Carol"
+  }],
+  "offset" => 0,
+  "limit" => 20,
+  "processingTimeMs" => 1,
+  "query" => "carlo"
+}
+```
+
+#### Custom search <!-- omit in toc -->
+
+All the supported options are described in the [search parameters](https://docs.meilisearch.com/reference/features/search_parameters.html) section of the documentation.
+
+```ruby
+index.search(
+  'wonder',
+  attributes_to_highlight: ['*']
+)
+```
+
+JSON output:
+
+```json
+{
+    "hits": [
+        {
+            "id": 2,
+            "title": "Wonder Woman",
+            "_formatted": {
+                "id": 2,
+                "title": "<em>Wonder</em> Woman"
+            }
+        }
+    ],
+    "offset": 0,
+    "limit": 20,
+    "processingTimeMs": 0,
+    "query": "wonder"
+}
+```
+
+#### Custom Search With Filters <!-- omit in toc -->
+
+If you want to enable filtering, you must add your attributes to the `filterableAttributes` index setting.
+
+```ruby
+index.update_filterable_attributes([
+  'id',
+  'genres'
+])
+```
+
+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 [tasks](https://docs.meilisearch.com/reference/api/tasks.html#get-task)).
+
+Then, you can perform the search:
+
+```ruby
+index.search('wonder', { filter: ['id > 1 AND genres = Action'] })
+```
+
+JSON output:
+
+```json
+{
+  "hits": [
+    {
+      "id": 2,
+      "title": "Wonder Woman",
+      "genres": [
+        "Action",
+        "Adventure"
+      ]
+    }
+  ],
+  "nbHits": 1,
+  "exhaustiveNbHits": false,
+  "query": "wonder",
+  "limit": 20,
+  "offset": 0,
+  "processingTimeMs": 0
+}
+```
+
+## 🤖 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).
+
+## 💡 Learn More
+
+The following sections may interest you:
+
+- **Manipulate documents**: see the [API references](https://docs.meilisearch.com/reference/api/documents.html) or read more about [documents](https://docs.meilisearch.com/learn/core_concepts/documents.html).
+- **Search**: see the [API references](https://docs.meilisearch.com/reference/api/search.html) or follow our guide on [search parameters](https://docs.meilisearch.com/reference/features/search_parameters.html).
+- **Manage the indexes**: see the [API references](https://docs.meilisearch.com/reference/api/indexes.html) or read more about [indexes](https://docs.meilisearch.com/learn/core_concepts/indexes.html).
+- **Configure the index settings**: see the [API references](https://docs.meilisearch.com/reference/api/settings.html) or follow our guide on [settings parameters](https://docs.meilisearch.com/reference/features/settings.html).
+
+📖 Also, check out the [Wiki](https://github.com/meilisearch/meilisearch-ruby/wiki) of this repository to know what this SDK provdes!
+
+## ⚙️ Development Workflow and Contributing
+
+Any new contribution is more than welcome in this project!
+
+If you want to know more about the development workflow or want to contribute, please visit our [contributing guidelines](/CONTRIBUTING.md) for detailed instructions!
+
+<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.

data/lib/meilisearch/client.rb

@@ -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/http_request.rb

@@ -7,37 +7,43 @@ 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 = options
-      @headers = {
-        'Content-Type' => 'application/json',
-        'X-Meili-API-Key' => api_key
-      }.compact
-      @headers_no_body = {
-        'X-Meili-API-Key' => api_key
-      }.compact
+      @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,
-        headers: @headers_no_body
+        config: {
+          query_params: query_params,
+          headers: remove_headers(@headers.dup, 'Content-Type'),
+          options: @options
+        }
       )
     end
 
-    def http_post(relative_path = '', body = nil, query_params = nil)
+    def http_post(relative_path = '', body = nil, query_params = nil, options = {})
       send_request(
         proc { |path, config| self.class.post(path, config) },
         relative_path,
-        query_params: query_params,
-        body: body,
-        headers: @headers
+        config: {
+          query_params: query_params,
+          body: body,
+          headers: @headers.dup.merge(options[:headers] || {}),
+          options: @options.merge(options)
+        }
       )
     end
 
@@ -45,9 +51,25 @@ module MeiliSearch
       send_request(
         proc { |path, config| self.class.put(path, config) },
         relative_path,
-        query_params: query_params,
-        body: body,
-        headers: @headers
+        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
 
@@ -55,29 +77,47 @@ module MeiliSearch
       send_request(
         proc { |path, config| self.class.delete(path, config) },
         relative_path,
-        headers: @headers_no_body
+        config: {
+          headers: remove_headers(@headers.dup, 'Content-Type'),
+          options: @options
+        }
       )
     end
 
     private
 
-    def send_request(http_method, relative_path, query_params: nil, body: nil, headers: nil)
-      config = http_config(query_params, body, headers)
+    def build_default_options_headers
+      {
+        'Content-Type' => 'application/json',
+        'Authorization' => ("Bearer #{@api_key}" unless @api_key.nil?),
+        'User-Agent' => MeiliSearch.qualified_version
+      }.compact
+    end
+
+    def remove_headers(data, *keys)
+      data.delete_if { |k| keys.include?(k) }
+    end
+
+    def send_request(http_method, relative_path, config: {})
+      config = http_config(config[:query_params], config[:body], config[:options], config[:headers])
+
       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, headers)
+    def http_config(query_params, body, options, headers)
+      body = body.to_json if options[:convert_body?] == true
       {
         headers: headers,
         query: query_params,
-        body: body.to_json,
-        timeout: @options[:timeout] || 1,
-        max_retries: @options[:max_retries] || 0
+        body: body,
+        timeout: options[:timeout],
+        max_retries: options[:max_retries]
       }.compact
     end
 

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,12 +74,33 @@ 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 = { convert_body?: false }
+      http_post "/indexes/#{@uid}/documents", documents, { primaryKey: primary_key }.compact, options
+    end
+    alias replace_documents_json add_documents_json
+    alias add_or_replace_documents_json add_documents_json
+
+    def add_documents_ndjson(documents, primary_key = nil)
+      options = { headers: { 'Content-Type' => 'application/x-ndjson' }, convert_body?: false }
+      http_post "/indexes/#{@uid}/documents", documents, { primaryKey: primary_key }.compact, options
+    end
+    alias replace_documents_ndjson add_documents_ndjson
+    alias add_or_replace_documents_ndjson add_documents_ndjson
+
+    def add_documents_csv(documents, primary_key = nil)
+      options = { headers: { 'Content-Type' => 'text/csv' }, convert_body?: false }
+      http_post "/indexes/#{@uid}/documents", documents, { primaryKey: primary_key }.compact, options
+    end
+    alias replace_documents_csv add_documents_csv
+    alias add_or_replace_documents_csv add_documents_csv
+
     def update_documents(documents, primary_key = nil)
       documents = [documents] if documents.is_a?(Hash)
       http_put "/indexes/#{@uid}/documents", documents, { primaryKey: primary_key }.compact
@@ -91,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
@@ -140,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!
 
@@ -152,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!
 
@@ -162,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
@@ -174,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
@@ -215,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/utils.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module MeiliSearch
+  module Utils
+    SNAKE_CASE = /[^a-zA-Z0-9]+(.)/.freeze
+
+    def self.transform_attributes(body)
+      case body
+      when Array
+        body.map { |item| transform_attributes(item) }
+      when Hash
+        parse(body)
+      else
+        body
+      end
+    end
+
+    def self.parse(body)
+      body
+        .transform_keys(&:to_s)
+        .transform_keys do |key|
+          key.include?('_') ? key.downcase.gsub(SNAKE_CASE, &:upcase).gsub('_', '') : key
+        end
+    end
+
+    private_class_method :parse
+  end
+end

data/lib/meilisearch/version.rb

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

data/lib/meilisearch.rb

@@ -2,6 +2,7 @@
 
 require 'meilisearch/version'
 require 'meilisearch/utils'
+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.1
+  version: 0.18.1
 platform: ruby
 authors:
 - Meili
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-18 00:00:00.000000000 Z
+date: 2022-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -30,17 +30,21 @@ 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: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- README.md
 - lib/meilisearch.rb
 - lib/meilisearch/client.rb
 - lib/meilisearch/error.rb
 - lib/meilisearch/http_request.rb
 - lib/meilisearch/index.rb
+- lib/meilisearch/task.rb
+- lib/meilisearch/utils.rb
 - lib/meilisearch/version.rb
 homepage: https://github.com/meilisearch/meilisearch-ruby
 licenses: