meilisearch 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b06c291f3bf2609f0044199d4c35418052ab7cddb3d41216b7ba908bbfe6f61
-  data.tar.gz: 7fd8ddd39e24e14e5dcb39d3187df368f7cb88d5b46f4ce824e4b90d2670225a
+  metadata.gz: 99ae25bab6782e438028c54d10a2966072afb86200f4ac70133a438272be9c65
+  data.tar.gz: 13a067ebb2af22906feb52df27b1f4a572bc72bc5fe5cbfc3a95a8ae7262c26c
 SHA512:
-  metadata.gz: 21248cb8c60cc8875e4280eb8223ad7e48483c9a97d552a4d4a08aa887da54039d6532fd7fe8981199b8d232a25439b8a009250e7f4fe76db0d3b81e8c043885
-  data.tar.gz: 7d1ce9c9a6d956b5609aa0366435ed8d130b15e7e857aabf127263ce24f76ab5a80a9ee1d7af49153b5c7b21742dbec4ae827a33781c79a7db7e98984f5ead99
+  metadata.gz: 1e161040182a153380376f5e05a3485c7203408171413537d02a9effeb8f121661c21da6d26da7644c30f6a246628eace816107b0b58f76f2acfa6c75dbd2795
+  data.tar.gz: 28e13d37c04b1ac39424e60a9107215afe9379d3a56a7c10bdde5cdd183843f93b4c069c5fa5bc770e531f5cc528d3d6b8426a9de5f52f62376c68e697dcc78a

data/lib/meilisearch/client/indexes.rb

@@ -12,16 +12,14 @@ module MeiliSearch
       end
 
       # Usage:
-      # create_index('name')
-      # create_index(name: 'name')
-      # create_index(name: 'name', uid: 'uid')
-      # create_index(name: 'name', schema: {...})
-      # create_index(name: 'name', uid: 'uid', schema: {...})
+      # create_index('indexUID')
+      # create_index(uid: 'indexUID')
+      # create_index(uid: 'indexUID', primaryKey: 'id')
       def create_index(attributes)
         body = if attributes.is_a?(Hash)
                  attributes
                else
-                 { name: attributes }
+                 { uid: attributes }
                end
         res = http_post '/indexes', body
         index_object(res['uid'])
@@ -32,13 +30,11 @@ module MeiliSearch
       end
 
       # Usage:
-      # index('uid')
-      # index(uid: 'uid')
-      # index(name: 'name') => WARNING: the name of an index is not guaranteed to be unique. This method will return the first occurrence. We recommend using the index uid instead.
-      # index(uid: 'uid', name: 'name') => only the uid field will be taken into account.
-      def index(identifier)
-        uid = index_uid(identifier)
-        raise IndexIdentifierError if uid.nil?
+      # index('indexUID')
+      # index(uid: 'indexUID')
+      def index(attribute)
+        uid = attribute.is_a?(Hash) ? attribute[:uid] : attribute
+        raise IndexUidError if uid.nil?
 
         index_object(uid)
       end
@@ -49,23 +45,6 @@ module MeiliSearch
       def index_object(uid)
         Index.new(uid, @base_url, @api_key)
       end
-
-      def index_uid(identifier)
-        if identifier.is_a?(Hash)
-          identifier[:uid] || index_uid_from_name(identifier)
-        else
-          identifier
-        end
-      end
-
-      def index_uid_from_name(identifier)
-        index = indexes.find { |i| i['name'] == identifier[:name] }
-        if index.nil?
-          nil
-        else
-          index['uid']
-        end
-      end
     end
   end
 end

data/lib/meilisearch/client/keys.rb

@@ -6,22 +6,7 @@ module MeiliSearch
       def keys
         http_get '/keys'
       end
-
-      def key(key)
-        http_get "/keys/#{key}"
-      end
-
-      def create_key(options = {})
-        http_post '/keys', options
-      end
-
-      def update_key(key, options = {})
-        http_put "/keys/#{key}", options
-      end
-
-      def delete_key(key)
-        http_delete "/keys/#{key}"
-      end
+      alias get_keys keys
     end
   end
 end

data/lib/meilisearch/error.rb

@@ -2,7 +2,7 @@
 
 module MeiliSearch
   class MeiliSearchError < StandardError; end
-  class IndexIdentifierError < MeiliSearchError; end
+  class IndexUidError < MeiliSearchError; end
 
   class HTTPError < MeiliSearchError
     attr_reader :status

data/lib/meilisearch/http_request.rb

@@ -26,38 +26,38 @@ module MeiliSearch
       validate(response)
     end
 
-    def http_post(path = '', body = nil)
-      response = if body.nil?
-                   self.class.post(
-                     @base_url + path,
-                     headers: @headers,
-                     timeout: 1
-                   )
-                 else
-                   self.class.post(
-                     @base_url + path,
-                     body: body.to_json,
-                     headers: @headers,
-                     timeout: 1
-                   )
-                 end
+    def http_post(path = '', body = nil, params = nil)
+      body = body.to_json unless body.nil?
+      params = {
+        body: body,
+        query: params,
+        headers: @headers,
+        timeout: 1
+      }.compact
+      response = self.class.post(
+        @base_url + path,
+        params
+      )
       validate(response)
     end
 
-    def http_put(path = '', body = {})
+    def http_put(path = '', body = nil, params = nil)
+      body = body.to_json unless body.nil?
       response = self.class.put(
         @base_url + path,
-        body: body.to_json,
+        body: body,
+        query: params,
         headers: @headers,
         timeout: 1
       )
       validate(response)
     end
 
-    def http_patch(path = '', body = {})
+    def http_patch(path = '', body = nil)
+      body = body.to_json unless body.nil?
       response = self.class.patch(
         @base_url + path,
-        body: body.to_json,
+        body: body,
         headers: @headers,
         timeout: 1
       )

data/lib/meilisearch/index.rb

@@ -28,15 +28,9 @@ module MeiliSearch
       super(url, api_key)
     end
 
-    def name
-      index_name_from_uid
-    end
-    alias get_name name
-
-    private
-
-    def index_name_from_uid
-      show['name']
+    def primary_key
+      show['primaryKey']
     end
+    alias get_primary_key primary_key
   end
 end

data/lib/meilisearch/index/base.rb

@@ -8,24 +8,10 @@ module MeiliSearch
       end
       alias show_index show
 
-      def schema
-        http_get "/indexes/#{@uid}/schema"
-      rescue HTTPError => e
-        raise if e.body_message != 'missing index schema'
-
-        nil
-      end
-      alias get_schema schema
-
-      def update_name(new_index_name)
-        http_put "/indexes/#{@uid}", name: new_index_name
-      end
-      alias update_index_name update_name
-
-      def update_schema(new_schema)
-        http_put "/indexes/#{@uid}/schema", new_schema
+      def update(body)
+        http_put "/indexes/#{@uid}", body
       end
-      alias update_index_schema update_schema
+      alias update_index update
 
       def delete
         http_delete "/indexes/#{@uid}"

data/lib/meilisearch/index/documents.rb

@@ -15,27 +15,22 @@ module MeiliSearch
       end
       alias get_documents documents
 
-      def add_documents(documents)
+      def add_documents(documents, primary_key = nil)
         documents = [documents] if documents.is_a?(Hash)
-        http_post "/indexes/#{@uid}/documents", documents
+        http_post "/indexes/#{@uid}/documents", documents, primaryKey: primary_key
       end
       alias replace_documents add_documents
       alias add_or_replace_documents add_documents
 
-      def update_documents(documents)
+      def update_documents(documents, primary_key = nil)
         documents = [documents] if documents.is_a?(Hash)
-        http_put "/indexes/#{@uid}/documents", documents
+        http_put "/indexes/#{@uid}/documents", documents, primaryKey: primary_key
       end
       alias add_or_update_documents update_documents
 
-      def clear_documents
-        http_delete "/indexes/#{@uid}/documents"
-      end
-      alias clear_all_documents clear_documents
-
       def delete_documents(documents_ids)
         if documents_ids.is_a?(Array)
-          http_post "/indexes/#{@uid}/documents/delete", documents_ids
+          http_post "/indexes/#{@uid}/documents/delete-batch", documents_ids
         else
           delete_document(documents_ids)
         end
@@ -47,6 +42,10 @@ module MeiliSearch
         http_delete "/indexes/#{@uid}/documents/#{encode_document}"
       end
       alias delete_one_document delete_document
+
+      def delete_all_documents
+        http_delete "/indexes/#{@uid}/documents"
+      end
     end
   end
 end

data/lib/meilisearch/index/settings.rb

@@ -3,24 +3,84 @@
 module MeiliSearch
   class Index < HTTPRequest
     module Settings
+      # General routes
       def settings
         http_get "/indexes/#{@uid}/settings"
       end
       alias get_settings settings
 
-      def add_or_replace_settings(options)
-        http_post "/indexes/#{@uid}/settings", options
+      def update_settings(settings)
+        http_post "/indexes/#{@uid}/settings", settings
       end
-      alias add_settings add_or_replace_settings
-      alias replace_settings add_or_replace_settings
 
-      def reset_all_settings
-        body = {
-          rankingOrder: nil,
-          distinctField: nil,
-          rankingRules: nil
-        }
-        http_post "/indexes/#{@uid}/settings", body
+      def reset_settings
+        http_delete "/indexes/#{@uid}/settings"
+      end
+
+      # Sub-routes ranking rules
+      def ranking_rules
+        http_get "/indexes/#{@uid}/settings/ranking-rules"
+      end
+      alias get_ranking_rules ranking_rules
+
+      def update_ranking_rules(ranking_rules)
+        http_post "/indexes/#{@uid}/settings/ranking-rules", ranking_rules
+      end
+
+      def reset_ranking_rules
+        http_delete "/indexes/#{@uid}/settings/ranking-rules"
+      end
+
+      # Sub-routes distinct attribute
+      def distinct_attribute
+        http_get "/indexes/#{@uid}/settings/distinct-attribute"
+      end
+      alias get_distinct_attribute distinct_attribute
+
+      def update_distinct_attribute(distinct_attribute)
+        http_post "/indexes/#{@uid}/settings/distinct-attribute", distinct_attribute
+      end
+
+      def reset_distinct_attribute
+        http_delete "/indexes/#{@uid}/settings/distinct-attribute"
+      end
+
+      # Sub-routes searchable attributes
+      def searchable_attributes
+        http_get "/indexes/#{@uid}/settings/searchable-attributes"
+      end
+      alias get_searchable_attributes searchable_attributes
+
+      def update_searchable_attributes(searchable_attributes)
+        http_post "/indexes/#{@uid}/settings/searchable-attributes", searchable_attributes
+      end
+
+      def reset_searchable_attributes
+        http_delete "/indexes/#{@uid}/settings/searchable-attributes"
+      end
+
+      # Sub-routes displayed attributes
+      def displayed_attributes
+        http_get "/indexes/#{@uid}/settings/displayed-attributes"
+      end
+      alias get_displayed_attributes displayed_attributes
+
+      def update_displayed_attributes(displayed_attributes)
+        http_post "/indexes/#{@uid}/settings/displayed-attributes", displayed_attributes
+      end
+
+      def reset_displayed_attributes
+        http_delete "/indexes/#{@uid}/settings/displayed-attributes"
+      end
+
+      # Sub-routes accept-new-fields
+      def accept_new_fields
+        http_get "/indexes/#{@uid}/settings/accept-new-fields"
+      end
+      alias get_accept_new_fields accept_new_fields
+
+      def update_accept_new_fields(accept_new_fields)
+        http_post "/indexes/#{@uid}/settings/accept-new-fields", accept_new_fields
       end
     end
   end

data/lib/meilisearch/index/stats.rb

@@ -4,7 +4,7 @@ module MeiliSearch
   class Index < HTTPRequest
     module Stats
       def stats
-        http_get "/stats/#{@uid}"
+        http_get "/indexes/#{@uid}/stats"
       end
 
       def number_of_documents

data/lib/meilisearch/index/stop_words.rb

@@ -4,24 +4,17 @@ module MeiliSearch
   class Index < HTTPRequest
     module StopWords
       def stop_words
-        http_get "/indexes/#{@uid}/stop-words"
+        http_get "/indexes/#{@uid}/settings/stop-words"
       end
       alias get_stop_words stop_words
 
-      def add_stop_words(stop_words)
-        if stop_words.is_a?(Array)
-          http_patch "/indexes/#{@uid}/stop-words", stop_words
-        else
-          http_patch "/indexes/#{@uid}/stop-words", [stop_words]
-        end
+      def update_stop_words(stop_words)
+        body = stop_words.is_a?(Array) ? stop_words : [stop_words]
+        http_post "/indexes/#{@uid}/settings/stop-words", body
       end
 
-      def delete_stop_words(stop_words)
-        if stop_words.is_a?(Array)
-          http_post "/indexes/#{@uid}/stop-words", stop_words
-        else
-          http_post "/indexes/#{@uid}/stop-words", [stop_words]
-        end
+      def reset_stop_words
+        http_delete "/indexes/#{@uid}/settings/stop-words"
       end
     end
   end

data/lib/meilisearch/index/synonyms.rb

@@ -3,50 +3,18 @@
 module MeiliSearch
   class Index < HTTPRequest
     module Synonyms
-      def synonyms_of(synonym)
-        encode_synonym = URI.encode_www_form_component(synonym)
-        http_get "/indexes/#{@uid}/synonyms/#{encode_synonym}"
+      def synonyms
+        http_get "/indexes/#{@uid}/settings/synonyms"
       end
-      alias get_synonyms_of_one_sequence synonyms_of
-      alias get_synonyms_of synonyms_of
+      alias get_synonyms synonyms
 
-      def all_synonyms
-        http_get "/indexes/#{@uid}/synonyms"
+      def update_synonyms(synonyms)
+        http_post "/indexes/#{@uid}/settings/synonyms", synonyms
       end
-      alias get_all_synonyms all_synonyms
-      alias get_all_sequences all_synonyms
 
-      def add_synonyms(synonyms)
-        http_post "/indexes/#{@uid}/synonyms", synonyms
+      def reset_synonyms
+        http_delete "/indexes/#{@uid}/settings/synonyms"
       end
-
-      def add_synonyms_one_way(input, synonyms)
-        add_synonyms(input: input, synonyms: synonyms)
-      end
-
-      def add_synonyms_multi_way(synonyms)
-        add_synonyms(synonyms: synonyms)
-      end
-
-      def update_synonym(synonym, new_synonyms)
-        encode_synonym = URI.encode_www_form_component(synonym)
-        http_put "/indexes/#{@uid}/synonyms/#{encode_synonym}", new_synonyms
-      end
-
-      def delete_synonym(synonym)
-        encode_synonym = URI.encode_www_form_component(synonym)
-        http_delete "/indexes/#{@uid}/synonyms/#{encode_synonym}"
-      end
-      alias delete_one_synonym delete_synonym
-
-      def batch_write_synonyms(synonyms)
-        http_post "/indexes/#{@uid}/synonyms/batch", synonyms
-      end
-
-      def clear_synonyms
-        http_delete "/indexes/#{@uid}/synonyms"
-      end
-      alias clear_all_synonyms clear_synonyms
     end
   end
 end

data/lib/meilisearch/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: meilisearch
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Meili
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-04 00:00:00.000000000 Z
+date: 2020-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty