meilisearch 0.12.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17248185a6d2ba10e2e5fac61b6d9d07a0cac218a2accc4cd5b3bd130517f837
-  data.tar.gz: dd20f35451242677ec05ac52d95cbc14915dea6676562ef23c58a58655db24ad
+  metadata.gz: e60c9c4ac5631947edf24d990c37fd06e09bbbb59b6eabd554fcacc7d8f231ed
+  data.tar.gz: 5373d86aacf0791fa30f068d97ba9f5b857fa75930c3580ddd20449cd2db8e7b
 SHA512:
-  metadata.gz: f0c0c7a6726257c62e14108f33df551cd5ec3d7c5f4b6f8eb3fa975988da3915d7b3167e0074c3e21134f49d1a40d84a55e4145ae7b4ffac45cd1daa8954e00d
-  data.tar.gz: 3cb711d0577b92fe428b90ec16d2cbc7fb593aba63f014206c17a88bca2ba4de0fdd58b51e2b014640ae7118996142b9edc4c4d4d00250fc8a6893df117e3527
+  metadata.gz: d7496a3f2ea08ed35ff277c0176c52fe8120290678a1594bd49637e96b03e825aad11bfd55370040fd3563577fea9fbc6a3a7df335bb400a78d2a46707072ff2
+  data.tar.gz: db46abc6f60ec202641480eb0ac2232b2892ea966590d955735f4ab7a5ce98cc52493c87da7bb1ccc5d4399f95b0b4c7639619ad0a30ed4caa4f21e3af7aabf3

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,32 +64,31 @@ module MeiliSearch
       http_get '/health'
     end
 
-    def update_health(bool)
-      http_put '/health', health: bool
-    end
-
     ### STATS
 
     def version
       http_get '/version'
     end
 
-    def sysinfo
-      http_get '/sys-info'
+    def stats
+      http_get '/stats'
     end
 
-    def pretty_sysinfo
-      http_get '/sys-info/pretty'
+    ### DUMPS
+
+    def create_dump
+      http_post '/dumps'
     end
 
-    def stats
-      http_get '/stats'
+    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
@@ -21,7 +23,7 @@ module MeiliSearch
       @http_message = http_message
       @ms_message ||= 'MeiliSearch API has not returned any error message'
       @ms_link ||= '<no documentation link found>'
-      @message = "#{http_code} #{http_message} - #{@ms_message.capitalize}. See #{ms_link}."
+      @message = "#{http_code} #{http_message} - #{@ms_message}. See #{ms_link}."
       super(details)
     end
 

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
@@ -67,7 +68,8 @@ module MeiliSearch
         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
 
@@ -81,16 +85,8 @@ module MeiliSearch
     ### SEARCH
 
     def search(query, options = {})
-      parsed_options = options.transform_keys(&:to_sym).map do |k, v|
-        if [:facetFilters, :facetsDistribution].include?(k)
-          [k, v.inspect]
-        elsif v.is_a?(Array)
-          [k, v.join(',')]
-        else
-          [k, v]
-        end
-      end.to_h
-      http_get "/indexes/#{@uid}/search", { q: query }.merge(parsed_options)
+      parsed_options = options.compact
+      http_post "/indexes/#{@uid}/search", { q: query }.merge(parsed_options)
     end
 
     ### UPDATES
@@ -148,6 +144,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"
@@ -163,6 +160,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"
@@ -178,6 +176,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"
@@ -194,6 +193,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"
@@ -209,6 +209,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"
@@ -224,6 +225,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"
@@ -239,22 +241,12 @@ 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"
     end
 
-    ### SETTINGS - ACCEPT NEW FIELS VALUE
-
-    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
-
     ### SETTINGS - ATTRIBUTES FOR FACETING
 
     def attributes_for_faceting
@@ -265,6 +257,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.12.0'
+  VERSION = '0.15.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: meilisearch
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Meili
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-09 00:00:00.000000000 Z
+date: 2020-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -61,7 +61,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: An easy-to-use ruby client for Meilisearch API