meilisearch 0.14.0 → 0.15.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1861bef27e914a71fc706d4b0758a585842cc33421fa8a7ecacb0a45f146903
-  data.tar.gz: 33b66d0151cc205fd7d964b78608cd5f6641f2d9740d3b28d3fd2f52ee36d98c
+  metadata.gz: 03f23776fd7b1baeabbfcc33fcd848f8bd89f56655579756d9e2c06492f8d824
+  data.tar.gz: d5137b74a7def336e41e746d56f714847be1f73185c5f05abf70a03310cc79b4
 SHA512:
-  metadata.gz: 7600f98e465ddf28304b52f5ee12c199d7f6486b2230b2e1bea3d988bc41b3936875fbbf6f5a03ee5a6ac416d40e5dcddd8abc906415b6be44f67ba52c79a56d
-  data.tar.gz: d3e8eecfdd30d26a7bbb2dac5c7e216406093782015d232765315897a24744c02e2fac8113c169e4dfc7f5bd2cbe2cdbd3042c5fcb1aaab3e1d5212626b485ee
+  metadata.gz: c2c1fee375d80f6e0c372438b3fbb4c76b4c504f0c7ddf1d12d810e89f93f8173e838b1d6d8cf1d57ba02f75277f784660379c8961ccb47884eb2e37d7a43f06
+  data.tar.gz: ab566b980a0ab15a5ffef99fb47520f667783c098e3ea81fa35784a12d1806846b18a80f42116f0605e2770655a62f35b97e8881983b08ff865de28fcde89c7a

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
 
@@ -73,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, @options)
     end
   end
 end

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
@@ -63,7 +65,7 @@ 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,

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, options = {})
       @uid = index_uid
-      super(url, api_key)
+      @primary_key = primary_key
+      super(url, api_key, options)
     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,21 +85,38 @@ 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 = {})
       parsed_options = options.compact
-      http_post "/indexes/#{@uid}/search", { q: query }.merge(parsed_options)
+      http_post "/indexes/#{@uid}/search", { q: query.to_s }.merge(parsed_options)
     end
 
     ### UPDATES
@@ -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.14.0'
+  VERSION = '0.15.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: meilisearch
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.4
 platform: ruby
 authors:
 - Meili
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-04 00:00:00.000000000 Z
+date: 2021-06-11 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.1.4
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: An easy-to-use ruby client for Meilisearch API