meilisearch 0.17.2 → 0.17.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 276a1136bc7d85d5c0eaafa7475732990502af66a37859589dea606cffde3c97
-  data.tar.gz: e45996c09a5140cf5c66c9f1e30163ca91f37e3e469c00d396c88c318b9541ca
+  metadata.gz: 3c90df98b1b08039b339c49b47bfd052639e1301e9e7e3b25989b9ce6e3d1e67
+  data.tar.gz: 3f200a9de09db7a47780b01aa20a8ce5b2b1d0d0579954cd8842cb208b06b4dc
 SHA512:
-  metadata.gz: '09377cb9cd2eba0800459c57c229db29b9d497716248141125067b97026dabce8f1a6725b0a66336b98700e6cead512c0879e3d5162f402d04fd65277e373711'
-  data.tar.gz: 62f69c26b9516074cff7e97a4dde7a45261f511d762aef0ecbd933a5810b4ed3ec4136bb6ef3a9f0b04f9d6dd22699453a823014dd203a172d83d5bbc52f7993
+  metadata.gz: b3b38312517176303e9fdc49af5c38647ea4d719d8988cb1e1fd60839e7c593226fd9369febd24a326d214dbb606acd201464fd6590f46438383cf25f3e7e934
+  data.tar.gz: 494fa30322be3d624851117e460c31046c51ea3ef4d00326f4be969a76f5f056a15147c065b1ef02a56f3a589643e137ac4af1a05a088bab606cdf6d31bc8abc

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://res.cloudinary.com/meilisearch/image/upload/v1587402338/SDKs/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://app.bors.tech/repositories/28781"><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) # => { "updateId": 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).
+
+💡 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 [update status](https://docs.meilisearch.com/reference/api/updates.html#get-an-update-status).
+
+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.24.0 of MeiliSearch](https://github.com/meilisearch/MeiliSearch/releases/tag/v0.24.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/http_request.rb

@@ -12,14 +12,12 @@ module MeiliSearch
     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 = merge_options({
+                                 timeout: 1,
+                                 max_retries: 0,
+                                 headers: build_default_options_headers(api_key),
+                                 convert_body?: true
+                               }, options)
     end
 
     def http_get(relative_path = '', query_params = {})
@@ -27,17 +25,17 @@ module MeiliSearch
         proc { |path, config| self.class.get(path, config) },
         relative_path,
         query_params: query_params,
-        headers: @headers_no_body
+        options: remove_options_header(@options, 'Content-Type')
       )
     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
+        options: merge_options(@options, options)
       )
     end
 
@@ -47,7 +45,7 @@ module MeiliSearch
         relative_path,
         query_params: query_params,
         body: body,
-        headers: @headers
+        options: @options
       )
     end
 
@@ -55,14 +53,40 @@ module MeiliSearch
       send_request(
         proc { |path, config| self.class.delete(path, config) },
         relative_path,
-        headers: @headers_no_body
+        options: remove_options_header(@options, 'Content-Type')
       )
     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(api_key = nil)
+      {
+        'Content-Type' => 'application/json',
+        'X-Meili-API-Key' => api_key
+      }.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
+    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, 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
@@ -71,13 +95,14 @@ module MeiliSearch
       validate(response)
     end
 
-    def http_config(query_params, body, headers)
+    def http_config(query_params, body, options)
+      body = body.to_json if options[:convert_body?] == true
       {
-        headers: headers,
+        headers: options[: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

@@ -84,6 +84,27 @@ module MeiliSearch
     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 }
+      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

data/lib/meilisearch/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MeiliSearch
-  VERSION = '0.17.2'
+  VERSION = '0.17.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: meilisearch
 version: !ruby/object:Gem::Version
-  version: 0.17.2
+  version: 0.17.3
 platform: ruby
 authors:
 - Meili
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-18 00:00:00.000000000 Z
+date: 2021-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -36,6 +36,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- README.md
 - lib/meilisearch.rb
 - lib/meilisearch/client.rb
 - lib/meilisearch/error.rb