meilisearch 0.25.1 → 0.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64423a34ad9823417a67cf271103db76b41c3895470dbd13a1c90d986792d439
-  data.tar.gz: 1bc5ba4774f7704cc6aefed0458dab6de7f4a4c0b4e45c9bb762b4843fc7c5ed
+  metadata.gz: 41cfeec247ef2cdaef19f6ddade5d32b7dcc80cbc69fe500c9310f7dab87e5a4
+  data.tar.gz: af889a896d762a38fbb1af56aba3b462cf73f35e4fe97048ef09bbaad44ffa53
 SHA512:
-  metadata.gz: 37800a57fffe10aa250adf14af4b34855af7281c4adc7b4c0b62b573ad87ff365095493be04b56c2451de79aac20533625738bee98f70c5c124302bfe6172096
-  data.tar.gz: b15bb586f86ba17e6b7546b246380458c1573c3c2c038e00610e2e83b1ad08dbf06293cdb1180cf309ee4317f0441f0df5edc08273d3f1ffe3b363e8acc09fe1
+  metadata.gz: 6ce24688fe857e840d07efda981cc00d0f8a60982aea1d487646b21a82117693eaa61fbe9dc778512b00b7d2363001c68dca0387f7b7a550a00eee022133c046
+  data.tar.gz: fda38ae00c08ba533e76dc0ce9a101331b23fb47e6c9554478a6027f1524b92141c6ecc764dce974402e66db67b9e6d85a96ff74893eb3419d0a9f02865b1cec

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019-2022 Meili SAS
+Copyright (c) 2019-2024 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

@@ -30,7 +30,7 @@
 
 **Meilisearch** is an open-source search engine. [Learn more about Meilisearch.](https://github.com/meilisearch/meilisearch)
 
-## Table of Contents <!-- omit in toc -->
+## Table of Contents <!-- omit in TOC -->
 
 - [📖 Documentation](#-documentation)
 - [⚡ Supercharge your Meilisearch experience](#-supercharge-your-meilisearch-experience)
@@ -53,7 +53,7 @@ Say goodbye to server deployment and manual updates with [Meilisearch Cloud](htt
 
 ## 🔧 Installation
 
-This package requires Ruby version 2.6.0 or later.
+This package requires Ruby version 3.0.0 or later.
 
 With `gem` in command line:
 ```bash

data/lib/meilisearch/client.rb

@@ -121,6 +121,12 @@ module MeiliSearch
       http_post '/dumps'
     end
 
+    ### SNAPSHOTS
+
+    def create_snapshot
+      http_post '/snapshots'
+    end
+
     ### TASKS
 
     def cancel_tasks(options = {})

data/lib/meilisearch/error.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
 module MeiliSearch
-  class ApiError < StandardError
+  class Error < StandardError
+  end
+
+  class ApiError < Error
     # :http_code    # e.g. 400, 404...
     # :http_message # e.g. Bad Request, Not Found...
     # :http_body    # The response body received from the MeiliSearch API
@@ -18,26 +21,30 @@ module MeiliSearch
     alias link ms_link
 
     def initialize(http_code, http_message, http_body)
-      get_meilisearch_error_info(http_body) unless http_body.nil? || http_body.empty?
       @http_code = http_code
       @http_message = http_message
-      @ms_message ||= 'MeiliSearch API has not returned any error message'
-      @ms_link ||= '<no documentation link found>'
+      @http_body = parse_body(http_body)
+      @ms_code = @http_body['code']
+      @ms_type = @http_body['type']
+      @ms_message = @http_body.fetch('message', 'MeiliSearch API has not returned any error message')
+      @ms_link = @http_body.fetch('link', '<no documentation link found>')
       @message = "#{http_code} #{http_message} - #{@ms_message}. See #{ms_link}."
       super(details)
     end
 
-    def get_meilisearch_error_info(http_body)
-      @http_body = JSON.parse(http_body)
-      @ms_code = @http_body['code']
-      @ms_message = @http_body['message']
-      @ms_type = @http_body['type']
-      @ms_link = @http_body['link']
+    def parse_body(http_body)
+      if http_body.respond_to?(:to_hash)
+        http_body.to_hash
+      elsif http_body.respond_to?(:to_str)
+        JSON.parse(http_body.to_str)
+      else
+        {}
+      end
     rescue JSON::ParserError
       # We might receive a JSON::ParserError when, for example, MeiliSearch is running behind
       # some proxy (ELB or Nginx, for example), and the request timeouts, returning us
       # a raw HTML body instead of a JSON as we were expecting
-      @ms_message = "The server has not returned a valid JSON HTTP body: #{http_body}"
+      { 'message' => "The server has not returned a valid JSON HTTP body: #{http_body}" }
     end
 
     def details
@@ -45,7 +52,7 @@ module MeiliSearch
     end
   end
 
-  class CommunicationError < StandardError
+  class CommunicationError < Error
     attr_reader :message
 
     def initialize(message)
@@ -54,7 +61,7 @@ module MeiliSearch
     end
   end
 
-  class TimeoutError < StandardError
+  class TimeoutError < Error
     attr_reader :message
 
     def initialize(message = nil)
@@ -64,8 +71,8 @@ module MeiliSearch
   end
 
   module TenantToken
-    class ExpireOrInvalidSignature < StandardError; end
-    class InvalidApiKey < StandardError; end
-    class InvalidSearchRules < StandardError; end
+    class ExpireOrInvalidSignature < MeiliSearch::Error; end
+    class InvalidApiKey < MeiliSearch::Error; end
+    class InvalidSearchRules < MeiliSearch::Error; end
   end
 end

data/lib/meilisearch/index.rb

@@ -234,6 +234,15 @@ module MeiliSearch
       response
     end
 
+    ### FACET SEARCH
+
+    def facet_search(name, query = '', **options)
+      options.merge!(facet_name: name, facet_query: query)
+      options = Utils.transform_attributes(options)
+
+      http_post("/indexes/#{@uid}/facet-search", options)
+    end
+
     ### TASKS
 
     def task_endpoint
@@ -461,5 +470,63 @@ module MeiliSearch
     def reset_faceting
       http_delete("/indexes/#{@uid}/settings/faceting")
     end
+
+    ### SETTINGS - DICTIONARY
+
+    def dictionary
+      http_get("/indexes/#{@uid}/settings/dictionary")
+    end
+
+    def update_dictionary(dictionary_attributes)
+      attributes = Utils.transform_attributes(dictionary_attributes)
+      http_put("/indexes/#{@uid}/settings/dictionary", attributes)
+    end
+
+    def reset_dictionary
+      http_delete("/indexes/#{@uid}/settings/dictionary")
+    end
+    ### SETTINGS - SEPARATOR TOKENS
+
+    def separator_tokens
+      http_get("/indexes/#{@uid}/settings/separator-tokens")
+    end
+
+    def update_separator_tokens(separator_tokens_attributes)
+      attributes = Utils.transform_attributes(separator_tokens_attributes)
+      http_put("/indexes/#{@uid}/settings/separator-tokens", attributes)
+    end
+
+    def reset_separator_tokens
+      http_delete("/indexes/#{@uid}/settings/separator-tokens")
+    end
+
+    ### SETTINGS - NON SEPARATOR TOKENS
+
+    def non_separator_tokens
+      http_get("/indexes/#{@uid}/settings/non-separator-tokens")
+    end
+
+    def update_non_separator_tokens(non_separator_tokens_attributes)
+      attributes = Utils.transform_attributes(non_separator_tokens_attributes)
+      http_put("/indexes/#{@uid}/settings/non-separator-tokens", attributes)
+    end
+
+    def reset_non_separator_tokens
+      http_delete("/indexes/#{@uid}/settings/non-separator-tokens")
+    end
+
+    ### SETTINGS - PROXIMITY PRECISION
+
+    def proximity_precision
+      http_get("/indexes/#{@uid}/settings/proximity-precision")
+    end
+
+    def update_proximity_precision(proximity_precision_attribute)
+      http_put("/indexes/#{@uid}/settings/proximity-precision", proximity_precision_attribute)
+    end
+
+    def reset_proximity_precision
+      http_delete("/indexes/#{@uid}/settings/proximity-precision")
+    end
   end
 end

data/lib/meilisearch/utils.rb

@@ -2,7 +2,7 @@
 
 module MeiliSearch
   module Utils
-    SNAKE_CASE = /[^a-zA-Z0-9]+(.)/.freeze
+    SNAKE_CASE = /[^a-zA-Z0-9]+(.)/
 
     def self.transform_attributes(body)
       case body

data/lib/meilisearch/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module MeiliSearch
-  VERSION = '0.25.1'
+  VERSION = '0.27.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.25.1
+  version: 0.27.0
 platform: ruby
 authors:
 - Meili
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-14 00:00:00.000000000 Z
+date: 2024-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -51,7 +51,8 @@ files:
 homepage: https://github.com/meilisearch/meilisearch-ruby
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -60,14 +61,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
+rubygems_version: 3.2.33
 signing_key: 
 specification_version: 4
 summary: An easy-to-use ruby client for Meilisearch API