meilisearch 0.13.2 → 0.15.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a404b36eefbf9a36bae33b1d5b93254f7b88c7a99eac6ad958f746f914dac1e
-  data.tar.gz: bdd20fa28ebd8ccad0decd303c3e18eb59cb2d6176719235f82cc994ff75d75b
+  metadata.gz: f1a2bd63d9c8d081f0c4f9402f754fcd710b57a1e362aec937976b97bc2a7d32
+  data.tar.gz: c438bda2666f88704c58b0ced8c55803211848bd7a26ccf0059db36b29a860b7
 SHA512:
-  metadata.gz: 1bef203c596fea8974c0d45b9ebe1ad4b7d6239db39d57dabba57f25956a684d068e6297d5d7bb6115030be11d61b7fa461877d53c8e6d52e4926166a37b5290
-  data.tar.gz: 0540e59b6bafdd7c1c34c8afbfc0ccf930c0dfb020f69dfda9e9df7674c81e8da9fadbd0c3aebbe28ad19370cfe17bf4f0fffc378a479b95df18e9343b086861
+  metadata.gz: 31339aea14f0be79d11aaac5b9c4b278a6a87201c291ba50608888339dff7e94730d9d2f6201967fac7ea7a6ce9e05da7418f964481c37bb00f875a22d1dd51e
+  data.tar.gz: 78c68477abafc1b5391fb4b5f527d71acf6b3fa3daf0d71855d595bcbc023338c152af37744b5f7c74126cc8d684b5ac0548a08a7021dc830f078ec734f8919f

data/lib/meilisearch/client.rb

@@ -10,26 +10,24 @@ module MeiliSearch
       http_get '/indexes'
     end
 
-    def show_index(index_uid)
-      index_object(index_uid).show
-    end
-
     # Usage:
     # client.create_index('indexUID')
     # client.create_index('indexUID', primaryKey: 'id')
     def create_index(index_uid, options = {})
       body = options.merge(uid: index_uid)
-      res = http_post '/indexes', body
-      index_object(res['uid'])
+      index_hash = http_post '/indexes', body
+      index_object(index_hash['uid'], index_hash['primaryKey'])
     end
 
     def get_or_create_index(index_uid, options = {})
       begin
-        create_index(index_uid, options)
+        index_instance = fetch_index(index_uid)
       rescue ApiError => e
-        raise e unless e.code == 'index_already_exists'
+        raise e unless e.code == 'index_not_found'
+
+        index_instance = create_index(index_uid, options)
       end
-      index_object(index_uid)
+      index_instance
     end
 
     def delete_index(index_uid)
@@ -41,7 +39,10 @@ module MeiliSearch
     def index(index_uid)
       index_object(index_uid)
     end
-    alias get_index index
+
+    def fetch_index(index_uid)
+      index_object(index_uid).fetch_info
+    end
 
     ### KEYS
 
@@ -63,10 +64,6 @@ module MeiliSearch
       http_get '/health'
     end
 
-    def update_health(bool)
-      http_put '/health', health: bool
-    end
-
     ### STATS
 
     def version
@@ -77,10 +74,21 @@ module MeiliSearch
       http_get '/stats'
     end
 
+    ### DUMPS
+
+    def create_dump
+      http_post '/dumps'
+    end
+
+    def dump_status(dump_uid)
+      http_get "/dumps/#{dump_uid}/status"
+    end
+    alias get_dump_status dump_status
+
     private
 
-    def index_object(uid)
-      Index.new(uid, @base_url, @api_key)
+    def index_object(uid, primary_key = nil)
+      Index.new(uid, @base_url, @api_key, primary_key)
     end
   end
 end

data/lib/meilisearch/error.rb

@@ -2,14 +2,16 @@
 
 module MeiliSearch
   class ApiError < StandardError
-    attr_reader :http_code    # e.g. 400, 404...
-    attr_reader :http_message # e.g. Bad Request, Not Found...
-    attr_reader :http_body    # The response body received from the MeiliSearch API
-    attr_reader :ms_code      # The error code given by the MeiliSearch API
-    attr_reader :ms_type      # The error type given by the MeiliSearch API
-    attr_reader :ms_link      # The documentation link given by the MeiliSearch API
-    attr_reader :ms_message   # The error message given by the MeiliSearch API
-    attr_reader :message      # The detailed error message of this error class
+    # :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
+    # :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
 
     alias code ms_code
     alias type ms_type

data/lib/meilisearch/http_request.rb

@@ -7,9 +7,10 @@ module MeiliSearch
   class HTTPRequest
     include HTTParty
 
-    def initialize(url, api_key = nil)
+    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
@@ -62,12 +63,13 @@ module MeiliSearch
     end
 
     def http_config(query_params, body)
-      body = body.to_json unless body.nil?
+      body = body.to_json
       {
         headers: @headers,
         query: query_params,
         body: body,
-        timeout: 1
+        timeout: @options[:timeout] || 1,
+        max_retries: @options[:max_retries] || 0
       }.compact
     end
 

data/lib/meilisearch/index.rb

@@ -5,20 +5,24 @@ require 'timeout'
 
 module MeiliSearch
   class Index < HTTPRequest
-    attr_reader :uid
+    attr_reader :uid, :primary_key
 
-    def initialize(index_uid, url, api_key = nil)
+    def initialize(index_uid, url, api_key = nil, primary_key = nil)
       @uid = index_uid
+      @primary_key = primary_key
       super(url, api_key)
     end
 
-    def show
-      http_get "/indexes/#{@uid}"
+    def fetch_info
+      index_hash = http_get "/indexes/#{@uid}"
+      @primary_key = index_hash['primaryKey']
+      self
     end
-    alias show_index show
 
     def update(body)
-      http_put "/indexes/#{@uid}", body
+      index_hash = http_put "/indexes/#{@uid}", body
+      @primary_key = index_hash['primaryKey']
+      self
     end
     alias update_index update
 
@@ -27,10 +31,10 @@ module MeiliSearch
     end
     alias delete_index delete
 
-    def primary_key
-      show['primaryKey']
+    def fetch_primary_key
+      fetch_info.primary_key
     end
-    alias get_primary_key primary_key
+    alias get_primary_key fetch_primary_key
 
     ### DOCUMENTS
 
@@ -53,12 +57,25 @@ module MeiliSearch
     alias replace_documents add_documents
     alias add_or_replace_documents add_documents
 
+    def add_documents!(documents, primary_key = nil)
+      update = add_documents(documents, primary_key)
+      wait_for_pending_update(update['updateId'])
+    end
+    alias replace_documents! add_documents!
+    alias add_or_replace_documents! add_documents!
+
     def update_documents(documents, primary_key = nil)
       documents = [documents] if documents.is_a?(Hash)
       http_put "/indexes/#{@uid}/documents", documents, { primaryKey: primary_key }.compact
     end
     alias add_or_update_documents update_documents
 
+    def update_documents!(documents, primary_key = nil)
+      update = update_documents(documents, primary_key)
+      wait_for_pending_update(update['updateId'])
+    end
+    alias add_or_update_documents! update_documents!
+
     def delete_documents(documents_ids)
       if documents_ids.is_a?(Array)
         http_post "/indexes/#{@uid}/documents/delete-batch", documents_ids
@@ -68,16 +85,33 @@ module MeiliSearch
     end
     alias delete_multiple_documents delete_documents
 
+    def delete_documents!(documents_ids)
+      update = delete_documents(documents_ids)
+      wait_for_pending_update(update['updateId'])
+    end
+    alias delete_multiple_documents! delete_documents!
+
     def delete_document(document_id)
       encode_document = URI.encode_www_form_component(document_id)
       http_delete "/indexes/#{@uid}/documents/#{encode_document}"
     end
     alias delete_one_document delete_document
 
+    def delete_document!(document_id)
+      update = delete_document(document_id)
+      wait_for_pending_update(update['updateId'])
+    end
+    alias delete_one_document! delete_document!
+
     def delete_all_documents
       http_delete "/indexes/#{@uid}/documents"
     end
 
+    def delete_all_documents!
+      update = delete_all_documents
+      wait_for_pending_update(update['updateId'])
+    end
+
     ### SEARCH
 
     def search(query, options = {})
@@ -140,6 +174,7 @@ module MeiliSearch
     def update_settings(settings)
       http_post "/indexes/#{@uid}/settings", settings
     end
+    alias settings= update_settings
 
     def reset_settings
       http_delete "/indexes/#{@uid}/settings"
@@ -155,6 +190,7 @@ module MeiliSearch
     def update_ranking_rules(ranking_rules)
       http_post "/indexes/#{@uid}/settings/ranking-rules", ranking_rules
     end
+    alias ranking_rules= update_ranking_rules
 
     def reset_ranking_rules
       http_delete "/indexes/#{@uid}/settings/ranking-rules"
@@ -170,6 +206,7 @@ module MeiliSearch
     def update_synonyms(synonyms)
       http_post "/indexes/#{@uid}/settings/synonyms", synonyms
     end
+    alias synonyms= update_synonyms
 
     def reset_synonyms
       http_delete "/indexes/#{@uid}/settings/synonyms"
@@ -186,6 +223,7 @@ module MeiliSearch
       body = stop_words.is_a?(Array) ? stop_words : [stop_words]
       http_post "/indexes/#{@uid}/settings/stop-words", body
     end
+    alias stop_words= update_stop_words
 
     def reset_stop_words
       http_delete "/indexes/#{@uid}/settings/stop-words"
@@ -201,6 +239,7 @@ module MeiliSearch
     def update_distinct_attribute(distinct_attribute)
       http_post "/indexes/#{@uid}/settings/distinct-attribute", distinct_attribute
     end
+    alias distinct_attribute= update_distinct_attribute
 
     def reset_distinct_attribute
       http_delete "/indexes/#{@uid}/settings/distinct-attribute"
@@ -216,6 +255,7 @@ module MeiliSearch
     def update_searchable_attributes(searchable_attributes)
       http_post "/indexes/#{@uid}/settings/searchable-attributes", searchable_attributes
     end
+    alias searchable_attributes= update_searchable_attributes
 
     def reset_searchable_attributes
       http_delete "/indexes/#{@uid}/settings/searchable-attributes"
@@ -231,6 +271,7 @@ module MeiliSearch
     def update_displayed_attributes(displayed_attributes)
       http_post "/indexes/#{@uid}/settings/displayed-attributes", displayed_attributes
     end
+    alias displayed_attributes= update_displayed_attributes
 
     def reset_displayed_attributes
       http_delete "/indexes/#{@uid}/settings/displayed-attributes"
@@ -246,6 +287,7 @@ module MeiliSearch
     def update_attributes_for_faceting(attributes_for_faceting)
       http_post "/indexes/#{@uid}/settings/attributes-for-faceting", attributes_for_faceting
     end
+    alias attributes_for_faceting= update_attributes_for_faceting
 
     def reset_attributes_for_faceting
       http_delete "/indexes/#{@uid}/settings/attributes-for-faceting"

data/lib/meilisearch/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: meilisearch
 version: !ruby/object:Gem::Version
-  version: 0.13.2
+  version: 0.15.2
 platform: ruby
 authors:
 - Meili
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-01 00:00:00.000000000 Z
+date: 2021-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -54,14 +54,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: An easy-to-use ruby client for Meilisearch API