meilisearch 0.11.1 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53ba8f68eca0a4b76da0d0a967c2ee67757496072a13acb79d82de18f29c2fc4
-  data.tar.gz: 0ec5a423d738a7274cf85362d87919994fe137aac50768e0fe6efc22d3d4a9f7
+  metadata.gz: a1861bef27e914a71fc706d4b0758a585842cc33421fa8a7ecacb0a45f146903
+  data.tar.gz: 33b66d0151cc205fd7d964b78608cd5f6641f2d9740d3b28d3fd2f52ee36d98c
 SHA512:
-  metadata.gz: 5ac3a7446b8b86e952337866228149ca7ab2767c56bcba623e86e53c25ae934bf39bd238640945799d2ec9a6ea4928fa672da9f69b7e3ecb9a3c12ebb603e485
-  data.tar.gz: fc6d734865d2e23827143e15acf9738091753be549899c3e10230adff950fedba1881e1915b30ac8de78d910a243156fb19b2852f21d3a5e93480337af188f37
+  metadata.gz: 7600f98e465ddf28304b52f5ee12c199d7f6486b2230b2e1bea3d988bc41b3936875fbbf6f5a03ee5a6ac416d40e5dcddd8abc906415b6be44f67ba52c79a56d
+  data.tar.gz: d3e8eecfdd30d26a7bbb2dac5c7e216406093782015d232765315897a24744c02e2fac8113c169e4dfc7f5bd2cbe2cdbd3042c5fcb1aaab3e1d5212626b485ee

data/lib/meilisearch/client.rb

@@ -23,6 +23,15 @@ module MeiliSearch
       index_object(res['uid'])
     end
 
+    def get_or_create_index(index_uid, options = {})
+      begin
+        create_index(index_uid, options)
+      rescue ApiError => e
+        raise e unless e.code == 'index_already_exists'
+      end
+      index_object(index_uid)
+    end
+
     def delete_index(index_uid)
       index_object(index_uid).delete
     end
@@ -30,8 +39,6 @@ module MeiliSearch
     # Usage:
     # client.index('indexUID')
     def index(index_uid)
-      raise IndexUidError if index_uid.nil?
-
       index_object(index_uid)
     end
     alias get_index index
@@ -56,24 +63,12 @@ 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'
-    end
-
-    def pretty_sysinfo
-      http_get '/sys-info/pretty'
-    end
-
     def stats
       http_get '/stats'
     end

data/lib/meilisearch/error.rb

@@ -1,45 +1,60 @@
 # frozen_string_literal: true
 
 module MeiliSearch
-  class MeiliSearchError < StandardError; end
-  class IndexUidError < MeiliSearchError; end
-  class MeiliSearchTimeoutError < MeiliSearchError
-    attr_reader :message
+  class ApiError < StandardError
+    # :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
 
-    def initialize
-      @message = "MeiliSearchTimeoutError: update wasn't processed in the expected time"
+    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
+    alias link ms_link
+
+    def initialize(http_code, http_message, http_body)
+      get_meilisearch_error_info(http_body) unless http_body.nil? || http_body.empty?
+      @http_code = http_code
+      @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}. See #{ms_link}."
+      super(details)
+    end
+
+    def get_meilisearch_error_info(http_body)
+      @http_body = JSON.parse(http_body)
+      @ms_code = @http_body['errorCode']
+      @ms_message = @http_body['message']
+      @ms_type = @http_body['errorType']
+      @ms_link = @http_body['errorLink']
     end
 
-    def to_s
-      "#{@message}."
+    def details
+      "MeiliSearch::ApiError - code: #{@ms_code} - type: #{ms_type} - message: #{@ms_message} - link: #{ms_link}"
     end
   end
 
-  class HTTPError < MeiliSearchError
-    attr_reader :status
+  class CommunicationError < StandardError
     attr_reader :message
-    attr_reader :http_body
-    attr_reader :http_body_message
-    attr_reader :details
-
-    alias code         status
-    alias body         http_body
-    alias body_message http_body_message
-
-    def initialize(status, message, http_body, details = nil)
-      @status = status
-      unless http_body.nil? || http_body.empty?
-        @http_body = JSON.parse(http_body)
-        @http_body_message = @http_body['message']
-      end
-      @message = message.capitalize
-      @message = "#{@message} - #{@http_body_message.capitalize}" unless @http_body_message.nil?
-      @details = details
+
+    def initialize(message)
+      @message = "An error occurred while trying to connect to the MeiliSearch instance: #{message}"
+      super(@message)
     end
+  end
 
-    def to_s
-      final_message = @details.nil? ? @message : "#{@message}. #{@details}"
-      "#{@status}: #{final_message}."
+  class TimeoutError < StandardError
+    attr_reader :message
+
+    def initialize
+      @message = 'The update was not processed in the expected time'
+      super(@message)
     end
   end
 end

data/lib/meilisearch/http_request.rb

@@ -7,66 +7,74 @@ 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
       }.compact
     end
 
-    def http_get(path = '', query_params = {})
-      response = self.class.get(
-        @base_url + path,
-        query: query_params,
-        headers: @headers,
-        timeout: 1
+    def http_get(relative_path = '', query_params = {})
+      send_request(
+        proc { |path, config| self.class.get(path, config) },
+        relative_path,
+        query_params
       )
-      validate(response)
     end
 
-    def http_post(path = '', body = nil, query_params = nil)
-      body = body.to_json unless body.nil?
-      response = self.class.post(
-        @base_url + path,
-        {
-          body: body,
-          query: query_params,
-          headers: @headers,
-          timeout: 1
-        }.compact
+    def http_post(relative_path = '', body = nil, query_params = nil)
+      send_request(
+        proc { |path, config| self.class.post(path, config) },
+        relative_path,
+        query_params,
+        body
       )
-      validate(response)
     end
 
-    def http_put(path = '', body = nil, query_params = nil)
-      body = body.to_json unless body.nil?
-      response = self.class.put(
-        @base_url + path,
-        {
-          body: body,
-          query: query_params,
-          headers: @headers,
-          timeout: 1
-        }.compact
+    def http_put(relative_path = '', body = nil, query_params = nil)
+      send_request(
+        proc { |path, config| self.class.put(path, config) },
+        relative_path,
+        query_params,
+        body
       )
-      validate(response)
     end
 
-    def http_delete(path = '')
-      response = self.class.delete(
-        @base_url + path,
-        headers: @headers,
-        timeout: 1
+    def http_delete(relative_path = '')
+      send_request(
+        proc { |path, config| self.class.delete(path, config) },
+        relative_path
       )
-      validate(response)
     end
 
     private
 
+    def send_request(http_method, relative_path, query_params = nil, body = nil)
+      config = http_config(query_params, body)
+      begin
+        response = http_method.call(@base_url + relative_path, config)
+      rescue Errno::ECONNREFUSED => e
+        raise CommunicationError, e.message
+      end
+      validate(response)
+    end
+
+    def http_config(query_params, body)
+      body = body.to_json unless body.nil?
+      {
+        headers: @headers,
+        query: query_params,
+        body: body,
+        timeout: @options[:timeout] || 1,
+        max_retries: @options[:max_retries] || 0
+      }.compact
+    end
+
     def validate(response)
-      raise HTTPError.new(response.code, response.message, response.body) unless response.success?
+      raise ApiError.new(response.code, response.message, response.body) unless response.success?
 
       response.parsed_response
     end

data/lib/meilisearch/index.rb

@@ -81,16 +81,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
@@ -113,7 +105,7 @@ module MeiliSearch
         end
       end
     rescue Timeout::Error
-      raise MeiliSearch::MeiliSearchTimeoutError
+      raise MeiliSearch::TimeoutError
     end
 
     ### STATS
@@ -244,17 +236,6 @@ module MeiliSearch
       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

data/lib/meilisearch/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: meilisearch
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: 0.14.0
 platform: ruby
 authors:
 - Meili
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-23 00:00:00.000000000 Z
+date: 2020-11-04 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