Create a handler to catch exceptions & add a msg hint

Author: brunoocasali

lib/meilisearch/utils.rb

@@ -33,6 +33,21 @@ def self.parse_query(original_options, allowed_params = [])
       end
     end
 
-    private_class_method :parse
+    def self.message_builder(current_message, method_name)
+      "#{current_message}\nHint: It might not be working because maybe you're not up " \
+        "to date with the Meilisearch version that `#{method_name}` call requires."
+    end
+
+    def self.version_error_handler(method_name)
+      yield if block_given?
+    rescue MeiliSearch::ApiError => e
+      message = message_builder(e.http_message, method_name)
+
+      raise MeiliSearch::ApiError.new(e.http_code, message, e.http_body)
+    rescue StandardError => e
+      raise e.class, message_builder(e.message, method_name)
+    end
+
+    private_class_method :parse, :message_builder
   end
 end

spec/meilisearch/utils_spec.rb

@@ -46,4 +46,30 @@
       )
     end
   end
+
+  describe '.version_error_handler' do
+    it 'spawns same error message' do
+      expect do
+        MeiliSearch::Utils.version_error_handler(:my_method) do
+          raise MeiliSearch::ApiError.new(405, 'I came from Meili server', {})
+        end
+      end.to raise_error(MeiliSearch::ApiError, /I came from Meili server/)
+    end
+
+    it 'spawns message with version hint' do
+      expect do
+        MeiliSearch::Utils.version_error_handler(:my_method) do
+          raise MeiliSearch::ApiError.new(405, 'I came from Meili server', {})
+        end
+      end.to raise_error(MeiliSearch::ApiError, /that `my_method` call requires/)
+    end
+
+    it 'adds hints to all error types' do
+      expect do
+        MeiliSearch::Utils.version_error_handler(:my_method) do
+          raise MeiliSearch::CommunicationError, 'I am an error'
+        end
+      end.to raise_error(MeiliSearch::CommunicationError, /that `my_method` call requires/)
+    end
+  end
 end