Explicitly tell when a body should be transformed

...or not before the request. By exposing the
request options as a Hash param of http_request.

Reason:
- Currently, we transform the HTTP request body into JSON before each request.
- Now, we may have body of different String types (JSON, NDJSON, CSV) that shouldn't be transformed into JSON.
- Thus, we're exposing a flag to tell when a body should be transformed or not into JSON.
- I've decided to use a flag over a complex rules that could check the content along with headers because ideally, the body transformation should be responsibility of a level above that knows about the content.

Other benefit:
- Improve options' organization and its default values, as they were spread around.
- In the future: this could be even extracted into another class, maybe as Value Object

- Note: RuboCop is complaining about "too many optional params" in http_post

Author: thicolares

lib/meilisearch/http_request.rb

@@ -12,32 +12,30 @@ class HTTPRequest
     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
-      @headers_no_body = {
-        'X-Meili-API-Key' => api_key
-      }.compact
+      @options = merge_options({
+                                 timeout: 1,
+                                 max_retries: 0,
+                                 headers: build_default_options_headers(api_key),
+                                 transform_body?: true
+                               }, options)
     end
 
     def http_get(relative_path = '', query_params = {})
       send_request(
         proc { |path, config| self.class.get(path, config) },
         relative_path,
         query_params: query_params,
-        headers: @headers_no_body
+        options: remove_options_header(@options, 'Content-Type')
       )
     end
 
-    def http_post(relative_path = '', body = nil, query_params = nil)
+    def http_post(relative_path = '', body = nil, query_params = nil, options = {})
       send_request(
         proc { |path, config| self.class.post(path, config) },
         relative_path,
         query_params: query_params,
         body: body,
-        headers: @headers
+        options: merge_options(@options, options)
       )
     end
 
@@ -47,24 +45,49 @@ def http_put(relative_path = '', body = nil, query_params = nil)
         relative_path,
         query_params: query_params,
         body: body,
-        headers: @headers
+        options: @options
       )
     end
 
     def http_delete(relative_path = '')
       send_request(
         proc { |path, config| self.class.delete(path, config) },
         relative_path,
-        headers: @headers_no_body
+        options: remove_options_header(@options, 'Content-Type')
       )
     end
 
     private
 
+    def build_default_options_headers(api_key = nil)
+      {
+        'Content-Type' => 'application/json',
+        'X-Meili-API-Key' => api_key
+      }.compact
+    end
+
+    def merge_options(defaults, added = {})
+      merged = defaults.merge(added)
+      merged[:headers].merge(added[:headers]) if added.key?(:headers)
+      merged
+    end
+
+    def remove_options_header(options, key)
+      new_options = clone_options(options)
+      new_options[:headers].tap { |headers| headers.delete(key) }
+      new_options
+    end
+
+    def clone_options(options)
+      cloned_options = options.clone
+      cloned_options[:headers] = options[:headers].clone
+      cloned_options
+    end
+
     SNAKE_CASE = /[^a-zA-Z0-9]+(.)/.freeze
 
-    def send_request(http_method, relative_path, query_params: nil, body: nil, headers: nil)
-      config = http_config(query_params, body, headers)
+    def send_request(http_method, relative_path, query_params: nil, body: nil, options: {})
+      config = http_config(query_params, body, options)
       begin
         response = http_method.call(@base_url + relative_path, config)
       rescue Errno::ECONNREFUSED => e
@@ -73,14 +96,14 @@ def send_request(http_method, relative_path, query_params: nil, body: nil, heade
       validate(response)
     end
 
-    def http_config(query_params, body, headers)
+    def http_config(query_params, body, options)
       body = transform_attributes(body).to_json
       {
-        headers: headers,
+        headers: options[:headers],
         query: query_params,
         body: body,
-        timeout: @options[:timeout] || 1,
-        max_retries: @options[:max_retries] || 0
+        timeout: options[:timeout],
+        max_retries: options[:max_retries]
       }.compact
     end
 

spec/meilisearch/index/base_spec.rb

@@ -72,7 +72,15 @@
     options = { timeout: 2, max_retries: 1 }
     new_client = MeiliSearch::Client.new(URL, MASTER_KEY, options)
     index = new_client.create_index('options')
-    expect(index.options).to eq({ timeout: 2, max_retries: 1 })
+    expect(index.options).to eq({
+                                  headers: {
+                                    'Content-Type' => 'application/json',
+                                    'X-Meili-API-Key' => MASTER_KEY
+                                  },
+                                  max_retries: 1,
+                                  timeout: 2,
+                                  transform_body?: true
+                                })
     expect(MeiliSearch::Index).to receive(:get).with(
       "#{URL}/indexes/options",
       {