meilisearch 0.20.0 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a40fa643cb41246f5e77e635458aa3e516b76806e63f10e41d49eae41a2fd357
-  data.tar.gz: deb1618089a993f0f34e79b836ebc650db402253939c95ad1c15cb222d15a33d
+  metadata.gz: 012ab51bfcb13141e38b43587639b9f0c87c15b390025008b19edb78d3c6f8cd
+  data.tar.gz: 101f00e8a3507911aa17481466ffcffbd1c586c455eb8a15eac85ccf4d8e0b8f
 SHA512:
-  metadata.gz: a3e5ff462a29b80b1b8a36060301d42064563a9211109465bbc58b004bc7c5125c851ef9e22afb5c36c9c9197e1fa09ff30a3de8e90a57a9e9edfeb85a58723d
-  data.tar.gz: 287b3057c280021c31ff7e40ef91f8fc4c8733f52ae728ecc421b0b5ebfb0781ea02591804ef052da89cf37c006d6c0a03b20afc65b249ad4264ad9c59b750a3
+  metadata.gz: 87837129a31b9e962957f148525877ffddcdfb4e4e2e36b43cfdeb5f66e0f0e1e95ee8cef3650433156f59c9a70c6d6dccff8110f333214cd9983a996895cd0e
+  data.tar.gz: c3960dc5623ec4629324b113210596744a482c5411046b9e1ea62c5906f2aae600c2c8bdf9aceb3306b6b2a97dce5eddfc4844307feb96a74e4d74b5bbbf0ba9

data/README.md

@@ -24,29 +24,23 @@
 
 **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. [Learn more about Meilisearch.](https://github.com/meilisearch/meilisearch)
 
 ## Table of Contents <!-- omit in toc -->
 
-- [🎃 Hacktoberfest](#-hacktoberfest)
 - [📖 Documentation](#-documentation)
 - [🔧 Installation](#-installation)
-- [🚀 Getting Started](#-getting-started)
+- [🚀 Getting started](#-getting-started)
 - [🤖 Compatibility with Meilisearch](#-compatibility-with-meilisearch)
-- [💡 Learn More](#-learn-more)
-- [⚙️ Development Workflow and Contributing](#️-development-workflow-and-contributing)
+- [💡 Learn more](#-learn-more)
+- [⚙️ Contributing](#️-contributing)
 
-## 🎃 Hacktoberfest
-
-It’s Hacktoberfest 2022 @Meilisearch
-
-[Hacktoberfest](https://hacktoberfest.com/) is a celebration of the open-source community. This year, and for the third time in a row, Meilisearch is participating in this fantastic event.
+## 📖 Documentation
 
-You’d like to contribute? Don’t hesitate to check out our [contributing guidelines](./CONTRIBUTING.md).
+This readme contains all the documentation you need to start using this Meilisearch SDK.
 
-## 📖 Documentation
+For general information on how to use Meilisearch—such as our API reference, tutorials, guides, and in-depth articles—refer to our [main documentation website](https://docs.meilisearch.com/).
 
-See our [Documentation](https://docs.meilisearch.com/learn/tutorials/getting_started.html) or our [API References](https://docs.meilisearch.com/reference/api/).
 
 ## 🔧 Installation
 
@@ -80,7 +74,7 @@ curl -L https://install.meilisearch.com | sh
 
 NB: you can also download Meilisearch from **Homebrew** or **APT** or even run it using **Docker**.
 
-## 🚀 Getting Started
+## 🚀 Getting started
 
 #### Add documents <!-- omit in toc -->
 
@@ -206,11 +200,11 @@ JSON output:
 
 ## 🤖 Compatibility with Meilisearch
 
-This package only guarantees the compatibility with the [version v0.29.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.29.0).
+This package only guarantees the compatibility with the [version v0.30.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.30.0).
 
-## 💡 Learn More
+## 💡 Learn more
 
-The following sections may interest you:
+The following sections in our main documentation website 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).
@@ -219,7 +213,7 @@ The following sections may interest you:
 
 📖 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
+## ⚙️ Contributing
 
 Any new contribution is more than welcome in this project!
 

data/lib/meilisearch/client.rb

@@ -12,6 +12,12 @@ module MeiliSearch
       http_get('/indexes', body)
     end
 
+    def swap_indexes(*options)
+      mapped_array = options.map { |arr| { indexes: arr } }
+
+      http_post '/swap-indexes', mapped_array
+    end
+
     def indexes(options = {})
       response = raw_indexes(options)
 
@@ -116,6 +122,14 @@ module MeiliSearch
 
     ### TASKS
 
+    def cancel_tasks(options = {})
+      task_endpoint.cancel_tasks(options)
+    end
+
+    def delete_tasks(options = {})
+      task_endpoint.delete_tasks(options)
+    end
+
     def tasks(options = {})
       task_endpoint.task_list(options)
     end

data/lib/meilisearch/http_request.rb

@@ -73,11 +73,12 @@ module MeiliSearch
       )
     end
 
-    def http_delete(relative_path = '')
+    def http_delete(relative_path = '', query_params = nil)
       send_request(
         proc { |path, config| self.class.delete(path, config) },
         relative_path,
         config: {
+          query_params: query_params,
           headers: remove_headers(@headers.dup, 'Content-Type'),
           options: @options
         }

data/lib/meilisearch/index.rb

@@ -64,10 +64,7 @@ module MeiliSearch
     alias get_one_document document
 
     def documents(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
+      http_get "/indexes/#{@uid}/documents", Utils.parse_query(options, [:limit, :offset, :fields])
     end
     alias get_documents documents
 
@@ -194,7 +191,8 @@ module MeiliSearch
       parsed_options = Utils.transform_attributes({ q: query.to_s }.merge(options.compact))
 
       response = http_post "/indexes/#{@uid}/search", parsed_options
-      response['nbHits'] ||= response['estimatedTotalHits']
+
+      response['nbHits'] ||= response['estimatedTotalHits'] unless response.key?('totalPages')
 
       response
     end

data/lib/meilisearch/task.rb

@@ -5,13 +5,15 @@ require 'timeout'
 
 module MeiliSearch
   class Task < HTTPRequest
-    ALLOWED_PARAMS = [:limit, :from, :index_uid, :type, :status].freeze
+    ALLOWED_PARAMS = [
+      :limit, :from, :index_uids, :types, :statuses, :uids, :canceled_by,
+      :before_enqueued_at, :after_enqueued_at, :before_started_at, :after_started_at,
+      :before_finished_at, :after_finished_at
+    ].freeze
+    ALLOWED_CANCELATION_PARAMS = (ALLOWED_PARAMS - [:limit, :from]).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
+      http_get '/tasks/', Utils.parse_query(options, ALLOWED_PARAMS)
     end
 
     def task(task_uid)
@@ -19,13 +21,21 @@ module MeiliSearch
     end
 
     def index_tasks(index_uid)
-      http_get '/tasks', { indexUid: [index_uid].flatten.join(',') }
+      http_get '/tasks', { indexUids: [index_uid].flatten.join(',') }
     end
 
     def index_task(task_uid)
       http_get "/tasks/#{task_uid}"
     end
 
+    def cancel_tasks(options)
+      http_post '/tasks/cancel', nil, Utils.parse_query(options, ALLOWED_CANCELATION_PARAMS)
+    end
+
+    def delete_tasks(options)
+      http_delete '/tasks', Utils.parse_query(options, ALLOWED_CANCELATION_PARAMS)
+    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

data/lib/meilisearch/utils.rb

@@ -23,6 +23,16 @@ module MeiliSearch
         end
     end
 
+    def self.parse_query(original_options, allowed_params = [])
+      only_allowed_params = original_options.transform_keys(&:to_sym).slice(*allowed_params)
+
+      Utils.transform_attributes(only_allowed_params).then do |body|
+        body.transform_values do |v|
+          v.respond_to?(:join) ? v.join(',') : v.to_s
+        end
+      end
+    end
+
     private_class_method :parse
   end
 end

data/lib/meilisearch/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module MeiliSearch
-  VERSION = '0.20.0'
+  VERSION = '0.21.0'
 
   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.20.0
+  version: 0.21.0
 platform: ruby
 authors:
 - Meili
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-03 00:00:00.000000000 Z
+date: 2022-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty