meilisearch 0.18.0 → 0.18.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df541b398ac4b031ec615d5e20c6a19cd7c370cdeaf83dcf63d789374827f012
-  data.tar.gz: 9277554fe2d6f388491d506cbfda456e71a1cc90b1945d933cfa72a2147ee52c
+  metadata.gz: f9ffb59831da7243cc87f65a0cd0a0d11d311e4691fd1177779fae006f4a750d
+  data.tar.gz: 04cd78aa37677107d08a355daa016d72d8be0d2980d1da27f1e5102dde45c661
 SHA512:
-  metadata.gz: bc0446c08444d6bf48d796c62c9b92e5f008835463b08c916e52f0ac9ce81156bcb835cd645fd78c31b98907a06230cf60fe2dbcfdcf0102b9c3fe8f9dfc2732
-  data.tar.gz: ac4f2136062699556c365e296db97fe54c6085a228c2b6831b963a72557918c100b83f7e5241183b5d9d173927e127b1e2ad402045dc64ec71056c7b57663fb2
+  metadata.gz: 1b7cc2bcb9f6c228397ca5cceaa9ad76c0fb3e522f29ea2231ac9a304c762fdc1cc2eda55deaeead572d5b8ab0468681db57b8fe6b28ee078a96324894a54a1c
+  data.tar.gz: 551fc3177689b479102a2f23329ca7243ae768ba13d7ddeea48e09f531c8305fcd43207e5f20e9b3d28bf5e0c88d7e6ae5247ea115213abc890264369785fbfd

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

@@ -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> |
@@ -20,18 +20,18 @@
   <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,7 +91,7 @@ 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.
+# If the index 'movies' does not exist, Meilisearch creates it when you first add the documents.
 index.add_documents(documents) # => { "uid": 0 }
 ```
 
@@ -102,7 +102,7 @@ With the `uid`, you can check the status (`enqueued`, `processing`, `succeeded`
 #### 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 [tasks](https://docs.meilisearch.com/reference/api/tasks.html#get-task)).
+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.25.0 of MeiliSearch](https://github.com/meilisearch/MeiliSearch/releases/tag/v0.25.0).
+This package only guarantees the compatibility with the [version v0.27.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.27.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

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

@@ -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,12 @@ 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
 
@@ -53,9 +64,12 @@ module MeiliSearch
       send_request(
         proc { |path, config| self.class.patch(path, config) },
         relative_path,
-        query_params: query_params,
-        body: body,
-        options: @options
+        config: {
+          query_params: query_params,
+          body: body,
+          headers: @headers,
+          options: @options
+        }
       )
     end
 
@@ -63,53 +77,45 @@ 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)
-      header = {
-        'Content-Type' => 'application/json'
-      }
-      header = header.merge('Authorization' => "Bearer #{api_key}") unless api_key.nil?
-      header
-    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
+    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_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
+      rescue Errno::ECONNREFUSED, Errno::EPIPE => e
         raise CommunicationError, e.message
+      rescue Net::ReadTimeout, Net::OpenTimeout => e
+        raise TimeoutError, 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

@@ -81,7 +81,7 @@ module MeiliSearch
     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

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.18.0'
+  VERSION = '0.18.3'
+
+  def self.qualified_version
+    "Meilisearch Ruby (v#{VERSION})"
+  end
 end

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.0
+  version: 0.18.3
 platform: ruby
 authors:
 - Meili
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-12 00:00:00.000000000 Z
+date: 2022-05-09 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: []
@@ -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