Merge #266

266: Move out params parsing of the HttpRequest class r=curquiza a=brunoocasali

This way we would gain more control about when parsing something or not that even could be
a query_params situation or a body situation.

Fixes #265

Co-authored-by: Bruno Casali <[email protected]>

Author: meili-bors[bot]

.rubocop.yml

@@ -20,3 +20,6 @@ Style/SymbolArray:
 
 Style/WordArray:
   EnforcedStyle: brackets
+
+Style/Documentation:
+  Enabled: false

.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2021-10-12 19:14:29 UTC using RuboCop version 1.20.0.
+# on 2021-11-18 03:06:45 UTC using RuboCop version 1.23.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -14,30 +14,26 @@ Gemspec/DateAssignment:
   Exclude:
     - 'meilisearch.gemspec'
 
-# Offense count: 35
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: Include.
+# Include: **/*.gemspec
+Gemspec/RequireMFA:
+  Exclude:
+    - 'meilisearch.gemspec'
+
+# Offense count: 32
 # Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
 # IgnoredMethods: refine
 Metrics/BlockLength:
-  Max: 500
+  Max: 512
 
 # Offense count: 1
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
-  Max: 300
+  Max: 271
 
-# Offense count: 1
+# Offense count: 2
 Naming/AccessorMethodName:
   Exclude:
     - 'lib/meilisearch/index.rb'
-
-# Offense count: 7
-# Configuration parameters: AllowedConstants.
-Style/Documentation:
-  Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'
-    - 'lib/meilisearch.rb'
-    - 'lib/meilisearch/client.rb'
-    - 'lib/meilisearch/error.rb'
-    - 'lib/meilisearch/http_request.rb'
-    - 'lib/meilisearch/index.rb'

lib/meilisearch.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'meilisearch/version'
+require 'meilisearch/utils'
 require 'meilisearch/client'
 require 'meilisearch/index'
 

lib/meilisearch/client.rb

@@ -20,7 +20,8 @@ def indexes
     # client.create_index('indexUID')
     # client.create_index('indexUID', primaryKey: 'id')
     def create_index(index_uid, options = {})
-      body = options.merge(uid: index_uid)
+      body = Utils.transform_attributes(options.merge(uid: index_uid))
+
       index_hash = http_post '/indexes', body
       index_object(index_hash['uid'], index_hash['primaryKey'])
     end

lib/meilisearch/http_request.rb

@@ -61,8 +61,6 @@ def http_delete(relative_path = '')
 
     private
 
-    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)
       begin
@@ -74,35 +72,15 @@ def send_request(http_method, relative_path, query_params: nil, body: nil, heade
     end
 
     def http_config(query_params, body, headers)
-      body = transform_attributes(body).to_json
       {
         headers: headers,
         query: query_params,
-        body: body,
+        body: body.to_json,
         timeout: @options[:timeout] || 1,
         max_retries: @options[:max_retries] || 0
       }.compact
     end
 
-    def transform_attributes(body)
-      case body
-      when Array
-        body.map { |item| transform_attributes(item) }
-      when Hash
-        parse(body)
-      else
-        body
-      end
-    end
-
-    def parse(body)
-      body
-        .transform_keys(&:to_s)
-        .transform_keys do |key|
-          key.include?('_') ? key.downcase.gsub(SNAKE_CASE, &:upcase).gsub('_', '') : key
-        end
-    end
-
     def validate(response)
       raise ApiError.new(response.code, response.message, response.body) unless response.success?
 

lib/meilisearch/index.rb

@@ -31,8 +31,9 @@ def fetch_raw_info
     end
 
     def update(body)
-      index_hash = http_put indexes_path(id: @uid), body
+      index_hash = http_put indexes_path(id: @uid), Utils.transform_attributes(body)
       set_base_properties index_hash
+
       self
     end
 
@@ -65,7 +66,7 @@ def document(document_id)
     alias get_one_document document
 
     def documents(options = {})
-      http_get "/indexes/#{@uid}/documents", options
+      http_get "/indexes/#{@uid}/documents", Utils.transform_attributes(options)
     end
     alias get_documents documents
 
@@ -168,8 +169,9 @@ def delete_all_documents!
     ### SEARCH
 
     def search(query, options = {})
-      parsed_options = options.compact
-      http_post "/indexes/#{@uid}/search", { q: query.to_s }.merge(parsed_options)
+      parsed_options = Utils.transform_attributes({ q: query.to_s }.merge(options.compact))
+
+      http_post "/indexes/#{@uid}/search", parsed_options
     end
 
     ### UPDATES
@@ -229,7 +231,7 @@ def settings
     alias get_settings settings
 
     def update_settings(settings)
-      http_post "/indexes/#{@uid}/settings", settings
+      http_post "/indexes/#{@uid}/settings", Utils.transform_attributes(settings)
     end
     alias settings= update_settings
 

lib/meilisearch/utils.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module MeiliSearch
+  module Utils
+    SNAKE_CASE = /[^a-zA-Z0-9]+(.)/.freeze
+
+    def self.transform_attributes(body)
+      case body
+      when Array
+        body.map { |item| transform_attributes(item) }
+      when Hash
+        parse(body)
+      else
+        body
+      end
+    end
+
+    def self.parse(body)
+      body
+        .transform_keys(&:to_s)
+        .transform_keys do |key|
+          key.include?('_') ? key.downcase.gsub(SNAKE_CASE, &:upcase).gsub('_', '') : key
+        end
+    end
+
+    private_class_method :parse
+  end
+end

spec/meilisearch/index/base_spec.rb

@@ -126,4 +126,16 @@
     expect(index.method(:update) == index.method(:update_index)).to be_truthy
     expect(index.method(:delete) == index.method(:delete_index)).to be_truthy
   end
+
+  context 'with snake_case options' do
+    it 'does the request with camelCase attributes' do
+      index = client.create_index('uid')
+      index.update(primary_key: 'new_primary_key')
+
+      expect(index).to be_a(MeiliSearch::Index)
+      expect(index.uid).to eq('uid')
+      expect(index.primary_key).to eq('new_primary_key')
+      expect(index.fetch_primary_key).to eq('new_primary_key')
+    end
+  end
 end

spec/meilisearch/index/documents_spec.rb

@@ -25,6 +25,17 @@
         expect(index.documents.count).to eq(documents.count)
       end
 
+      it 'keeps the structure of the original documents' do
+        docs = [
+          { object_id: 123, my_title: 'Pride and Prejudice', 'my-comment': 'A great book' }
+        ]
+
+        response = index.add_documents(docs)
+        index.wait_for_pending_update(response['updateId'])
+
+        expect(index.documents.first.keys).to eq(docs.first.keys.map(&:to_s))
+      end
+
       it 'adds documents in a batch (as a array of documents)' do
         response = index.add_documents_in_batches(documents, 5)
         expect(response).to be_a(Array)

spec/meilisearch/index/settings_spec.rb

@@ -89,6 +89,23 @@
       expect(settings['stopWords']).to be_empty
       expect(settings['synonyms']).to be_empty
     end
+
+    context 'with snake_case options' do
+      it 'does the request with camelCase attributes' do
+        response = index.update_settings(
+          ranking_rules: ['typo'],
+          distinct_ATTribute: 'title',
+          stopWords: ['a']
+        )
+
+        index.wait_for_pending_update(response['updateId'])
+        settings = index.settings
+
+        expect(settings['rankingRules']).to eq(['typo'])
+        expect(settings['distinctAttribute']).to eq('title')
+        expect(settings['stopWords']).to eq(['a'])
+      end
+    end
   end
 
   context 'On ranking-rules sub-routes' do