meilisearch 0.15.3 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e48c328b5e42361ede3a76e638721b8a2117b8fc6d6128c3709083fe9dae9f76
-  data.tar.gz: 733ed1fbfded2147c3e440978b7f3bad5a212b54928eb0b41694a474ebafefcd
+  metadata.gz: c6e2e138205c88de9e5a82459a9a9648c1170380eb977ca839b8ed25aa238a8f
+  data.tar.gz: 642d60688d0000f6ae2d6f2ea64de47236eff9af6b34d71ec5bde38a2e76cc83
 SHA512:
-  metadata.gz: efd4e7d40c5c1d676b2f4b2bd8ef4f80b980453d92ab5d894baf92142ba4a62153ad5654bdef24f45cf5877421be558299fcc7013b5127e173ff81b4b598d6ab
-  data.tar.gz: 6360ee85bd1a6163ddc7baad68f185dbc82ad340ff1b4c6b5cf7f7767a4ec162cab4bb37f5c0742e4285115460526909681b27475bf94c40939198ef6c723ecc
+  metadata.gz: 76f796decd057670599f0cbd8e3c921f73457717b0e49e4a58ee9a7faabbefeae5819ba701c59aff27b4bd22fe449d60623b68e7be47e99d70379caa140097c1
+  data.tar.gz: 43734101c23e8fd5ab2fcf1b8044b5005b4e809f9947e16519e0f099e82491e75cce33499329faffb73fec91a589bf5de776566498b2c53054c793cbee7f0891

data/lib/meilisearch/client.rb

@@ -6,8 +6,14 @@ module MeiliSearch
   class Client < HTTPRequest
     ### INDEXES
 
+    def raw_indexes
+      http_get('/indexes')
+    end
+
     def indexes
-      http_get '/indexes'
+      raw_indexes.map do |index_hash|
+        index_object(index_hash['uid'], index_hash['primaryKey'])
+      end
     end
 
     # Usage:
@@ -34,6 +40,17 @@ module MeiliSearch
       index_object(index_uid).delete
     end
 
+    # Usage:
+    # client.delete_index_if_exists('indexUID')
+    def delete_index_if_exists(index_uid)
+      index_object(index_uid).delete
+      true
+    rescue ApiError => e
+      raise e if e.code != 'index_not_found'
+
+      false
+    end
+
     # Usage:
     # client.index('indexUID')
     def index(index_uid)
@@ -44,6 +61,10 @@ module MeiliSearch
       index_object(index_uid).fetch_info
     end
 
+    def fetch_raw_index(index_uid)
+      index_object(index_uid).fetch_raw_info
+    end
+
     ### KEYS
 
     def keys
@@ -88,7 +109,7 @@ module MeiliSearch
     private
 
     def index_object(uid, primary_key = nil)
-      Index.new(uid, @base_url, @api_key, primary_key)
+      Index.new(uid, @base_url, @api_key, primary_key, @options)
     end
   end
 end

data/lib/meilisearch/error.rb

@@ -29,10 +29,15 @@ module MeiliSearch
 
     def get_meilisearch_error_info(http_body)
       @http_body = JSON.parse(http_body)
-      @ms_code = @http_body['errorCode']
+      @ms_code = @http_body['code']
       @ms_message = @http_body['message']
-      @ms_type = @http_body['errorType']
-      @ms_link = @http_body['errorLink']
+      @ms_type = @http_body['type']
+      @ms_link = @http_body['link']
+    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}"
     end
 
     def details

data/lib/meilisearch/http_request.rb

@@ -7,6 +7,8 @@ module MeiliSearch
   class HTTPRequest
     include HTTParty
 
+    attr_reader :options
+
     def initialize(url, api_key = nil, options = {})
       @base_url = url
       @api_key = api_key
@@ -15,13 +17,17 @@ module MeiliSearch
         'Content-Type' => 'application/json',
         'X-Meili-API-Key' => api_key
       }.compact
+      @headers_no_body = {
+        'X-Meili-API-Key' => api_key
+      }.compact
     end
 
     def http_get(relative_path = '', query_params = {})
       send_request(
         proc { |path, config| self.class.get(path, config) },
         relative_path,
-        query_params
+        query_params: query_params,
+        headers: @headers_no_body
       )
     end
 
@@ -29,8 +35,9 @@ module MeiliSearch
       send_request(
         proc { |path, config| self.class.post(path, config) },
         relative_path,
-        query_params,
-        body
+        query_params: query_params,
+        body: body,
+        headers: @headers
       )
     end
 
@@ -38,22 +45,26 @@ module MeiliSearch
       send_request(
         proc { |path, config| self.class.put(path, config) },
         relative_path,
-        query_params,
-        body
+        query_params: query_params,
+        body: body,
+        headers: @headers
       )
     end
 
     def http_delete(relative_path = '')
       send_request(
         proc { |path, config| self.class.delete(path, config) },
-        relative_path
+        relative_path,
+        headers: @headers_no_body
       )
     end
 
     private
 
-    def send_request(http_method, relative_path, query_params = nil, body = nil)
-      config = http_config(query_params, body)
+    SNAKE_CASE = /[^a-zA-Z0-9]+(.)/.freeze
+
+    def send_request(http_method, relative_path, query_params: nil, body: nil, headers: nil)
+      config = http_config(query_params, body, headers)
       begin
         response = http_method.call(@base_url + relative_path, config)
       rescue Errno::ECONNREFUSED => e
@@ -62,10 +73,10 @@ module MeiliSearch
       validate(response)
     end
 
-    def http_config(query_params, body)
-      body = body.to_json
+    def http_config(query_params, body, headers)
+      body = transform_attributes(body).to_json
       {
-        headers: @headers,
+        headers: headers,
         query: query_params,
         body: body,
         timeout: @options[:timeout] || 1,
@@ -73,6 +84,25 @@ module MeiliSearch
       }.compact
     end
 
+    def transform_attributes(body)
+      case body
+      when Array
+        body.map { |item| transform_attributes(item) }
+      when Hash
+        parse(body)
+      else
+        body
+      end
+    end
+
+    def parse(body)
+      body
+        .transform_keys(&:to_s)
+        .transform_keys do |key|
+          key.include?('_') ? key.downcase.gsub(SNAKE_CASE, &:upcase).gsub('_', '') : key
+        end
+    end
+
     def validate(response)
       raise ApiError.new(response.code, response.message, response.body) unless response.success?
 

data/lib/meilisearch/index.rb

@@ -5,36 +5,55 @@ require 'timeout'
 
 module MeiliSearch
   class Index < HTTPRequest
-    attr_reader :uid, :primary_key
+    attr_reader :uid, :primary_key, :created_at, :updated_at
 
-    def initialize(index_uid, url, api_key = nil, primary_key = nil)
+    def initialize(index_uid, url, api_key = nil, primary_key = nil, options = {})
       @uid = index_uid
       @primary_key = primary_key
-      super(url, api_key)
+      super(url, api_key, options)
     end
 
     def fetch_info
-      index_hash = http_get "/indexes/#{@uid}"
-      @primary_key = index_hash['primaryKey']
+      index_hash = http_get indexes_path(id: @uid)
+      set_base_properties index_hash
       self
     end
 
+    def fetch_primary_key
+      fetch_info.primary_key
+    end
+    alias get_primary_key fetch_primary_key
+
+    def fetch_raw_info
+      index_hash = http_get indexes_path(id: @uid)
+      set_base_properties index_hash
+      index_hash
+    end
+
     def update(body)
-      index_hash = http_put "/indexes/#{@uid}", body
-      @primary_key = index_hash['primaryKey']
+      index_hash = http_put indexes_path(id: @uid), body
+      set_base_properties index_hash
       self
     end
+
     alias update_index update
 
     def delete
-      http_delete "/indexes/#{@uid}"
+      http_delete indexes_path(id: @uid)
     end
     alias delete_index delete
 
-    def fetch_primary_key
-      fetch_info.primary_key
+    def indexes_path(id: nil)
+      "/indexes/#{id}"
     end
-    alias get_primary_key fetch_primary_key
+    private :indexes_path
+
+    def set_base_properties(index_hash)
+      @primary_key = index_hash['primaryKey']
+      @created_at = Time.parse(index_hash['createdAt'])
+      @updated_at = Time.parse(index_hash['updatedAt'])
+    end
+    private :set_base_properties
 
     ### DOCUMENTS
 
@@ -76,6 +95,40 @@ module MeiliSearch
     end
     alias add_or_update_documents! update_documents!
 
+    def add_documents_in_batches(documents, batch_size = 1000, primary_key = nil)
+      update_ids = []
+      documents.each_slice(batch_size) do |batch|
+        update_ids.append(add_documents(batch, primary_key))
+      end
+      update_ids
+    end
+
+    def add_documents_in_batches!(documents, batch_size = 1000, primary_key = nil)
+      update_ids = add_documents_in_batches(documents, batch_size, primary_key)
+      responses = []
+      update_ids.each do |update_object|
+        responses.append(wait_for_pending_update(update_object['updateId']))
+      end
+      responses
+    end
+
+    def update_documents_in_batches(documents, batch_size = 1000, primary_key = nil)
+      update_ids = []
+      documents.each_slice(batch_size) do |batch|
+        update_ids.append(update_documents(batch, primary_key))
+      end
+      update_ids
+    end
+
+    def update_documents_in_batches!(documents, batch_size = 1000, primary_key = nil)
+      update_ids = update_documents_in_batches(documents, batch_size, primary_key)
+      responses = []
+      update_ids.each do |update_object|
+        responses.append(wait_for_pending_update(update_object['updateId']))
+      end
+      responses
+    end
+
     def delete_documents(documents_ids)
       if documents_ids.is_a?(Array)
         http_post "/indexes/#{@uid}/documents/delete-batch", documents_ids
@@ -129,11 +182,15 @@ module MeiliSearch
       http_get "/indexes/#{@uid}/updates"
     end
 
+    def achieved_upate?(update)
+      update['status'] != 'enqueued' && update['status'] != 'processing'
+    end
+
     def wait_for_pending_update(update_id, timeout_in_ms = 5000, interval_in_ms = 50)
       Timeout.timeout(timeout_in_ms.to_f / 1000) do
         loop do
           get_update = get_update_status(update_id)
-          return get_update if get_update['status'] != 'enqueued'
+          return get_update if achieved_upate?(get_update)
 
           sleep interval_in_ms.to_f / 1000
         end
@@ -160,8 +217,8 @@ module MeiliSearch
       stats['lastUpdate']
     end
 
-    def fields_distribution
-      stats['fieldsDistribution']
+    def field_distribution
+      stats['fieldDistribution']
     end
 
     ### SETTINGS - GENERAL
@@ -220,7 +277,7 @@ module MeiliSearch
     alias get_stop_words stop_words
 
     def update_stop_words(stop_words)
-      body = stop_words.is_a?(Array) ? stop_words : [stop_words]
+      body = stop_words.nil? || stop_words.is_a?(Array) ? stop_words : [stop_words]
       http_post "/indexes/#{@uid}/settings/stop-words", body
     end
     alias stop_words= update_stop_words
@@ -277,20 +334,36 @@ module MeiliSearch
       http_delete "/indexes/#{@uid}/settings/displayed-attributes"
     end
 
-    ### SETTINGS - ATTRIBUTES FOR FACETING
+    ### SETTINGS - FILTERABLE ATTRIBUTES
+
+    def filterable_attributes
+      http_get "/indexes/#{@uid}/settings/filterable-attributes"
+    end
+    alias get_filterable_attributes filterable_attributes
+
+    def update_filterable_attributes(filterable_attributes)
+      http_post "/indexes/#{@uid}/settings/filterable-attributes", filterable_attributes
+    end
+    alias filterable_attributes= update_filterable_attributes
+
+    def reset_filterable_attributes
+      http_delete "/indexes/#{@uid}/settings/filterable-attributes"
+    end
+
+    ### SETTINGS - SORTABLE ATTRIBUTES
 
-    def attributes_for_faceting
-      http_get "/indexes/#{@uid}/settings/attributes-for-faceting"
+    def sortable_attributes
+      http_get "/indexes/#{@uid}/settings/sortable-attributes"
     end
-    alias get_attributes_for_faceting attributes_for_faceting
+    alias get_sortable_attributes sortable_attributes
 
-    def update_attributes_for_faceting(attributes_for_faceting)
-      http_post "/indexes/#{@uid}/settings/attributes-for-faceting", attributes_for_faceting
+    def update_sortable_attributes(sortable_attributes)
+      http_post "/indexes/#{@uid}/settings/sortable-attributes", sortable_attributes
     end
-    alias attributes_for_faceting= update_attributes_for_faceting
+    alias sortable_attributes= update_sortable_attributes
 
-    def reset_attributes_for_faceting
-      http_delete "/indexes/#{@uid}/settings/attributes-for-faceting"
+    def reset_sortable_attributes
+      http_delete "/indexes/#{@uid}/settings/sortable-attributes"
     end
   end
 end

data/lib/meilisearch/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: meilisearch
 version: !ruby/object:Gem::Version
-  version: 0.15.3
+  version: 0.17.0
 platform: ruby
 authors:
 - Meili
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-03 00:00:00.000000000 Z
+date: 2021-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -19,7 +19,7 @@ dependencies:
         version: 0.17.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.19.0
+        version: 0.21.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: 0.17.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.19.0
+        version: 0.21.0
 description: An easy-to-use ruby client for Meilisearch API. See https://github.com/meilisearch/MeiliSearch
 email: bonjour@meilisearch.com
 executables: []