meilisearch 0.29.0 → 0.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07ebab8519a40f392916e9b9f52a48002121c781dd8a2c7ab666e4c39adb0f9e
-  data.tar.gz: 30087e85e8b2dad33b89d8006c3730c5493f9177ffb33db589fe779ac2dc3adf
+  metadata.gz: 5efbe9d158037686df9b8bb37bf42e99646abeaae9bb8134a795507c84887c5d
+  data.tar.gz: 7552001f2cb4030e09588d0601e49ae0d82c5858a31ea491740374251bbf5fd8
 SHA512:
-  metadata.gz: 5b36ec117ea1fef77e1c862b2cb877a5d29e52f7924a7aa1a8215c5e613b6e3952182d4de979ad79aa69823655f2cbb43c1e11c392185fe65864566b5f269292
-  data.tar.gz: e4303f28920e02647de29c739f37217e8980e80d7e7266ec4c562d7f4dab3007eb18a32094e8e03c3f28649c9ca7a8a0b045bc5485cbf3d6cf93ea6123262cd0
+  metadata.gz: ea80d3871ada8d4dcf224893f38ad7a972500df85aabd9100c0772bc9e9aaf3fec9bafa408628357e9d802bfa445307307905b04d4edc656cb8c9808ea307382
+  data.tar.gz: 742c90c3cbc9d931bf30b7d2d533e1dc577404b55ae4a7f2646a88e2b5a2388eda1f70db742ac3acf44721f22a137c1f1c93adab4fb7287475350850c9fe1e9f

data/LICENSE

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

@@ -33,7 +33,6 @@
 ## Table of Contents <!-- omit in TOC -->
 
 - [📖 Documentation](#-documentation)
-- [⚡ Supercharge your Meilisearch experience](#-supercharge-your-meilisearch-experience)
 - [🔧 Installation](#-installation)
 - [🚀 Getting started](#-getting-started)
 - [🤖 Compatibility with Meilisearch](#-compatibility-with-meilisearch)
@@ -47,10 +46,6 @@ This readme contains all the documentation you need to start using this Meilisea
 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://www.meilisearch.com/docs/).
 
 
-## ⚡ Supercharge your Meilisearch experience
-
-Say goodbye to server deployment and manual updates with [Meilisearch Cloud](https://www.meilisearch.com/cloud?utm_campaign=oss&utm_source=github&utm_medium=meilisearch-ruby). Get started with a 14-day free trial! No credit card required.
-
 ## 🔧 Installation
 
 We officially support any version of Ruby that is still receiving at least [security maintenance](https://www.ruby-lang.org/en/downloads/branches/). You may, however, be fine with any Ruby version above 3.0.
@@ -70,19 +65,9 @@ gem 'meilisearch'
 
 ### Run Meilisearch <!-- omit in toc -->
 
-There are many easy ways to [download and run a Meilisearch instance](https://www.meilisearch.com/docs/learn/getting_started/quick_start#setup-and-installation).
-
-For example, using the `curl` command in your [Terminal](https://itconnect.uw.edu/learn/workshops/online-tutorials/what-is-a-terminal/):
-
-```sh
-# Install Meilisearch
-curl -L https://install.meilisearch.com | sh
-
-# Launch Meilisearch
-./meilisearch --master-key=masterKey
-```
+⚡️ **Launch, scale, and streamline in minutes with Meilisearch Cloud**—no maintenance, no commitment, cancel anytime. [Try it free now](https://cloud.meilisearch.com/login?utm_campaign=oss&utm_source=github&utm_medium=meilisearch-ruby).
 
-NB: you can also download Meilisearch from **Homebrew** or **APT** or even run it using **Docker**.
+🪨  Prefer to self-host? [Download and deploy](https://www.meilisearch.com/docs/learn/self_hosted/getting_started_with_self_hosted_meilisearch?utm_campaign=oss&utm_source=github&utm_medium=meilisearch-ruby) our fast, open-source search engine on your own infrastructure.
 
 ## 🚀 Getting started
 
@@ -91,7 +76,7 @@ NB: you can also download Meilisearch from **Homebrew** or **APT** or even run i
 ```ruby
 require 'meilisearch'
 
-client = MeiliSearch::Client.new('http://127.0.0.1:7700', 'masterKey')
+client = Meilisearch::Client.new('http://127.0.0.1:7700', 'masterKey')
 
 # An index is where the documents are stored.
 index = client.index('movies')

data/lib/meilisearch/client.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-module MeiliSearch
+module Meilisearch
   class Client < HTTPRequest
-    include MeiliSearch::TenantToken
-    include MeiliSearch::MultiSearch
+    include Meilisearch::TenantToken
+    include Meilisearch::MultiSearch
 
     ### INDEXES
 
@@ -157,6 +157,16 @@ module MeiliSearch
       task_endpoint.wait_for_task(task_uid, timeout_in_ms, interval_in_ms)
     end
 
+    ### BATCHES
+
+    def batches(options = {})
+      http_get '/batches', options
+    end
+
+    def batch(batch_uid)
+      http_get "/batches/#{batch_uid}"
+    end
+
     private
 
     def index_object(uid, primary_key = nil)

data/lib/meilisearch/error.rb

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 
-module MeiliSearch
+module Meilisearch
   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
-    # :ms_code      # The error code given by the MeiliSearch API
-    # :ms_type      # The error type given by the MeiliSearch API
-    # :ms_link      # The documentation link given by the MeiliSearch API
-    # :ms_message   # The error message given by the MeiliSearch API
+    # :http_body    # The response body received from the Meilisearch API
+    # :ms_code      # The error code given by the Meilisearch API
+    # :ms_type      # The error type given by the Meilisearch API
+    # :ms_link      # The documentation link given by the Meilisearch API
+    # :ms_message   # The error message given by the Meilisearch API
     # :message      # The detailed error message of this error class
 
     attr_reader :http_code, :http_message, :http_body, :ms_code, :ms_type, :ms_link, :ms_message, :message
@@ -26,7 +26,7 @@ module MeiliSearch
       @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_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)
@@ -41,14 +41,14 @@ module MeiliSearch
         {}
       end
     rescue JSON::ParserError
-      # We might receive a JSON::ParserError when, for example, MeiliSearch is running behind
+      # 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
       { 'message' => "The server has not returned a valid JSON HTTP body: #{http_body}" }
     end
 
     def details
-      "MeiliSearch::ApiError - code: #{@ms_code} - type: #{ms_type} - message: #{@ms_message} - link: #{ms_link}"
+      "Meilisearch::ApiError - code: #{@ms_code} - type: #{ms_type} - message: #{@ms_message} - link: #{ms_link}"
     end
   end
 
@@ -56,7 +56,7 @@ module MeiliSearch
     attr_reader :message
 
     def initialize(message)
-      @message = "An error occurred while trying to connect to the MeiliSearch instance: #{message}"
+      @message = "An error occurred while trying to connect to the Meilisearch instance: #{message}"
       super(@message)
     end
   end
@@ -80,8 +80,8 @@ module MeiliSearch
   end
 
   module TenantToken
-    class ExpireOrInvalidSignature < MeiliSearch::Error; end
-    class InvalidApiKey < MeiliSearch::Error; end
-    class InvalidSearchRules < MeiliSearch::Error; end
+    class ExpireOrInvalidSignature < Meilisearch::Error; end
+    class InvalidApiKey < Meilisearch::Error; end
+    class InvalidSearchRules < Meilisearch::Error; end
   end
 end

data/lib/meilisearch/http_request.rb

@@ -3,7 +3,7 @@
 require 'httparty'
 require 'meilisearch/error'
 
-module MeiliSearch
+module Meilisearch
   class HTTPRequest
     include HTTParty
 
@@ -93,7 +93,7 @@ module MeiliSearch
         'Authorization' => ("Bearer #{@api_key}" unless @api_key.nil?),
         'User-Agent' => [
           @options.fetch(:client_agents, []),
-          MeiliSearch.qualified_version
+          Meilisearch.qualified_version
         ].flatten.join(';')
       }.compact
     end

data/lib/meilisearch/index.rb

@@ -2,7 +2,7 @@
 
 require 'meilisearch/http_request'
 
-module MeiliSearch
+module Meilisearch
   class Index < HTTPRequest
     attr_reader :uid, :primary_key, :created_at, :updated_at
 
@@ -185,6 +185,18 @@ module MeiliSearch
       update_documents_in_batches(documents, batch_size, primary_key).each(&:await)
     end
 
+    # Update documents by function
+    #
+    # options - A Hash containing the function string and related options
+    #   context:
+    #   filter:
+    #   function:
+    def update_documents_by_function(options)
+      response = http_post "/indexes/#{@uid}/documents/edit", options
+
+      Models::Task.new(response, task_endpoint)
+    end
+
     # Public: Delete documents from an index
     #
     # options: A Hash or an Array containing documents_ids or a hash with filter:.
@@ -221,7 +233,7 @@ module MeiliSearch
 
     def delete_document(document_id)
       if document_id.nil? || document_id.to_s.empty?
-        raise MeiliSearch::InvalidDocumentId, 'document_id cannot be empty or nil'
+        raise Meilisearch::InvalidDocumentId, 'document_id cannot be empty or nil'
       end
 
       encode_document = URI.encode_www_form_component(document_id)
@@ -617,5 +629,65 @@ module MeiliSearch
     def reset_search_cutoff_ms
       http_delete("/indexes/#{@uid}/settings/search-cutoff-ms")
     end
+
+    ### SETTINGS - LOCALIZED ATTRIBUTES
+
+    def localized_attributes
+      http_get("/indexes/#{@uid}/settings/localized-attributes")
+    end
+
+    def update_localized_attributes(new_localized_attributes)
+      new_localized_attributes = Utils.transform_attributes(new_localized_attributes)
+
+      http_put("/indexes/#{@uid}/settings/localized-attributes", new_localized_attributes)
+    end
+
+    def reset_localized_attributes
+      http_delete("/indexes/#{@uid}/settings/localized-attributes")
+    end
+
+    ### SETTINGS - FACET SEARCH
+
+    def facet_search_setting
+      http_get("/indexes/#{@uid}/settings/facet-search")
+    end
+
+    def update_facet_search_setting(new_facet_search_setting)
+      http_put("/indexes/#{@uid}/settings/facet-search", new_facet_search_setting)
+    end
+
+    def reset_facet_search_setting
+      http_delete("/indexes/#{@uid}/settings/facet-search")
+    end
+
+    ### SETTINGS - PREFIX SEARCH
+
+    def prefix_search
+      http_get("/indexes/#{@uid}/settings/prefix-search")
+    end
+
+    def update_prefix_search(new_prefix_search_setting)
+      http_put("/indexes/#{@uid}/settings/prefix-search", new_prefix_search_setting)
+    end
+
+    def reset_prefix_search
+      http_delete("/indexes/#{@uid}/settings/prefix-search")
+    end
+
+    ### SETTINGS - EMBEDDERS
+
+    def embedders
+      http_get("/indexes/#{@uid}/settings/embedders")
+    end
+
+    def update_embedders(new_embedders)
+      new_embedders = Utils.transform_attributes(new_embedders)
+
+      http_patch("/indexes/#{@uid}/settings/embedders", new_embedders)
+    end
+
+    def reset_embedders
+      http_delete("/indexes/#{@uid}/settings/embedders")
+    end
   end
 end

data/lib/meilisearch/models/task.rb

@@ -2,7 +2,7 @@
 
 require 'forwardable'
 
-module MeiliSearch
+module Meilisearch
   module Models
     class Task
       extend Forwardable
@@ -88,7 +88,7 @@ module MeiliSearch
         self.metadata = with || @task_endpoint.task(uid)
 
         self
-      rescue MeiliSearch::ApiError => e
+      rescue Meilisearch::ApiError => e
         raise e unless e.http_code == 404
 
         @deleted = true

data/lib/meilisearch/multi_search.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module MeiliSearch
+module Meilisearch
   module MultiSearch
     def multi_search(data)
       body = Utils.transform_attributes(data)

data/lib/meilisearch/task.rb

@@ -3,12 +3,12 @@
 require 'meilisearch/http_request'
 require 'timeout'
 
-module MeiliSearch
+module Meilisearch
   class Task < HTTPRequest
     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
+      :before_finished_at, :after_finished_at, :reverse
     ].freeze
     ALLOWED_CANCELATION_PARAMS = (ALLOWED_PARAMS - [:limit, :from]).freeze
 
@@ -46,7 +46,7 @@ module MeiliSearch
         end
       end
     rescue Timeout::Error
-      raise MeiliSearch::TimeoutError
+      raise Meilisearch::TimeoutError
     end
 
     private

data/lib/meilisearch/tenant_token.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module MeiliSearch
+module Meilisearch
   module TenantToken
     HEADER = {
       typ: 'JWT',

data/lib/meilisearch/utils.rb

@@ -2,7 +2,7 @@
 
 require 'logger'
 
-module MeiliSearch
+module Meilisearch
   module Utils
     SNAKE_CASE = /[^a-zA-Z0-9]+(.)/
 
@@ -57,10 +57,10 @@ module MeiliSearch
 
       def version_error_handler(method_name)
         yield if block_given?
-      rescue MeiliSearch::ApiError => e
+      rescue Meilisearch::ApiError => e
         message = message_builder(e.http_message, method_name)
 
-        raise MeiliSearch::ApiError.new(e.http_code, message, e.http_body)
+        raise Meilisearch::ApiError.new(e.http_code, message, e.http_body)
       rescue StandardError => e
         raise e.class, message_builder(e.message, method_name)
       end

data/lib/meilisearch/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-module MeiliSearch
-  VERSION = '0.29.0'
+module Meilisearch
+  VERSION = '0.30.0'
 
   def self.qualified_version
     "Meilisearch Ruby (v#{VERSION})"

data/lib/meilisearch.rb

@@ -12,5 +12,40 @@ require 'meilisearch/task'
 require 'meilisearch/client'
 require 'meilisearch/index'
 
+module Meilisearch
+end
+
+# Softly deprecate the old spelling of the top level module
+# from MeiliSearch to Meilisearch
 module MeiliSearch
+  class << self
+    def const_missing(const_name)
+      _warn_about_deprecation
+
+      Meilisearch.const_get(const_name)
+    end
+
+    def method_missing(method_name, *args, **kwargs)
+      _warn_about_deprecation
+
+      Meilisearch.send(method_name, *args, **kwargs)
+    end
+
+    def respond_to_missing?(method_name, *)
+      Meilisearch.respond_to?(method_name) || super
+    end
+
+    private
+
+    def _warn_about_deprecation
+      return if @warned
+
+      Meilisearch::Utils.logger.warn <<~RENAMED_MODULE_WARNING
+        [meilisearch-ruby] The top-level module of Meilisearch has been renamed.
+        [meilisearch-ruby] Please update "MeiliSearch" to "Meilisearch".
+      RENAMED_MODULE_WARNING
+
+      @warned = true
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: meilisearch
 version: !ruby/object:Gem::Version
-  version: 0.29.0
+  version: 0.30.0
 platform: ruby
 authors:
 - Meili
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-10-28 00:00:00.000000000 Z
+date: 2025-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty