Merge branch 'main' into change-indexes-method

Author: nagaroni

.code-samples.meilisearch.yaml

@@ -8,9 +8,9 @@ get_one_index_1: |-
 list_all_indexes_1: |-
   client.indexes
 create_an_index_1: |-
-  client.create_index('movies', primaryKey: 'movie_id')
+  client.create_index('movies', primary_key: 'movie_id')
 update_an_index_1: |-
-  client.index('movies').update(primaryKey: 'movie_id')
+  client.index('movies').update(primary_key: 'movie_id')
 delete_an_index_1: |-
   client.delete_index('movies')
 get_one_document_1: |-
@@ -53,7 +53,7 @@ get_settings_1: |-
   client.index('movies').settings
 update_settings_1: |-
   client.index('movies').update_settings({
-    rankingRules: [
+    ranking_rules: [
       'words',
       'typo',
       'proximity',
@@ -63,24 +63,24 @@ update_settings_1: |-
       'release_date:desc',
       'rank:desc'
     ],
-    distinctAttribute: 'movie_id',
-    searchableAttributes: [
+    distinct_attribute: 'movie_id',
+    searchable_attributes: [
       'title',
       'description',
       'genre'
     ],
-    displayedAttributes: [
+    displayed_attributes: [
       'title',
       'description',
       'genre',
       'release_date'
     ],
-    stopWords: [
+    stop_words: [
       'the',
       'a',
       'an'
     ],
-    sortableAttributes: [
+    sortable_attributes: [
       'title',
       'release_date'
     ],
@@ -123,11 +123,11 @@ update_ranking_rules_1: |-
 reset_ranking_rules_1: |-
   client.index('movies').reset_ranking_rules
 get_distinct_attribute_1: |-
-  client.index('movies').distinct_attribute
+  client.index('shoes').distinct_attribute
 update_distinct_attribute_1: |-
-  client.index('movies').update_distinct_attribute('movie_id')
+  client.index('shoes').update_distinct_attribute('skuid')
 reset_distinct_attribute_1: |-
-  client.index('movies').reset_distinct_attribute
+  client.index('shoes').reset_distinct_attribute
 get_searchable_attributes_1: |-
   client.index('movies').searchable_attributes
 update_searchable_attributes_1: |-
@@ -176,7 +176,7 @@ field_properties_guide_searchable_1: |-
   ])
 field_properties_guide_displayed_1: |-
   client.index('movies').update_settings({
-    displayedAttributes: [
+    displayed_attributes: [
       'title',
       'description',
       'genre',
@@ -207,16 +207,16 @@ search_parameter_guide_limit_1: |-
   })
 search_parameter_guide_retrieve_1: |-
   client.index('movies').search('shifu', {
-    attributesToRetrieve: ['overview', 'title']
+    attributes_to_retrieve: ['overview', 'title']
   })
 search_parameter_guide_crop_1: |-
   client.index('movies').search('shifu', {
-    attributesToCrop: ['overview'],
+    attributes_to_crop: ['overview'],
     cropLength: 10
   })
 search_parameter_guide_highlight_1: |-
   client.index('movies').search('winter feast', {
-    attributesToHighlight: ['overview']
+    attributes_to_highlight: ['overview']
   })
 search_parameter_guide_matches_1: |-
   client.index('movies').search('winter feast', {
@@ -239,15 +239,15 @@ settings_guide_synonyms_1: |-
   })
 settings_guide_stop_words_1: |-
   client.index('movies').update_settings({
-    stopWords: [
+    stop_words: [
       'the',
       'a',
       'an'
     ]
   })
 settings_guide_ranking_rules_1: |-
   client.index('movies').update_settings({
-    rankingRules: [
+    ranking_rules: [
       'words',
       'typo',
       'proximity',
@@ -262,15 +262,15 @@ settings_guide_distinct_1: |-
   client.index('jackets').update_distinct_attribute('product_id')
 settings_guide_searchable_1: |-
   client.index('movies').update_settings({
-    searchableAttributes: [
+    searchable_attributes: [
       'title',
       'description',
       'genre'
     ]
   })
 settings_guide_displayed_1: |-
   client.index('movies').update_settings({
-    displayedAttributes: [
+    displayed_attributes: [
       'title',
       'description',
       'genre',
@@ -332,7 +332,7 @@ faceted_search_filter_1: |-
   })
 faceted_search_facets_distribution_1: |-
   client.index('movies').search('Batman', {
-    facetsDistribution: ['genres']
+    facets_distribution: ['genres']
   })
 faceted_search_walkthrough_filterable_attributes_1: |-
   client.index('movies').update_filterable_attributes([
@@ -347,7 +347,7 @@ faceted_search_walkthrough_filter_1: |-
   })
 faceted_search_walkthrough_facets_distribution_1: |-
   client.index('movies').search('Batman', {
-    facetsDistribution: ['genres']
+    facets_distribution: ['genres']
   })
 post_dump_1: |-
   client.create_dump

.gitignore

@@ -45,5 +45,6 @@
 # lock
 Gemfile.lock
 
-# VScode
+# Local editor configurations
 .vscode/
+.idea/

.rubocop_todo.yml

@@ -23,7 +23,7 @@ Metrics/BlockLength:
 # Offense count: 1
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
-  Max: 256
+  Max: 260
 
 # Offense count: 1
 Naming/AccessorMethodName:

CONTRIBUTING.md

@@ -53,8 +53,8 @@ Each PR should pass the tests to be accepted.
 
 ```bash
 # Tests
-docker pull getmeili/meilisearch:latest # Fetch the latest version of MeiliSearch image from Docker Hub
-docker run -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey --no-analytics=true
+curl -L https://install.meilisearch.com | sh # download MeiliSearch
+./meilisearch --master-key=masterKey --no-analytics=true # run MeiliSearch
 bundle exec rspec
 ```
 

README.md

@@ -59,14 +59,17 @@ gem 'meilisearch'
 
 There are many easy ways to [download and run a MeiliSearch instance](https://docs.meilisearch.com/reference/features/installation.html#download-and-launch).
 
-For example, if you use Docker:
+For example, using the `curl` command in your [Terminal](https://itconnect.uw.edu/learn/workshops/online-tutorials/web-publishing/what-is-a-terminal/):
 
-```bash
-docker pull getmeili/meilisearch:latest # Fetch the latest version of MeiliSearch image from Docker Hub
-docker run -it --rm -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey
+```sh
+#Install MeiliSearch
+curl -L https://install.meilisearch.com | sh
+
+# Launch MeiliSearch
+./meilisearch --master-key=masterKey
 ```
 
-NB: you can also download MeiliSearch from **Homebrew** or **APT**.
+NB: you can also download MeiliSearch from **Homebrew** or **APT** or even run it using **Docker**.
 
 ## 🚀 Getting Started
 
@@ -124,7 +127,7 @@ All the supported options are described in the [search parameters](https://docs.
 ```ruby
 index.search(
   'wonder',
-  attributesToHighlight: ['*']
+  attributes_to_highlight: ['*']
 )
 ```
 

lib/meilisearch/error.rb

@@ -33,6 +33,11 @@ def get_meilisearch_error_info(http_body)
       @ms_message = @http_body['message']
       @ms_type = @http_body['errorType']
       @ms_link = @http_body['errorLink']
+    rescue JSON::ParserError
+      # We might receive a JSON::ParserError when, for example, MeiliSearch is running behind
+      # some proxy (ELB or Nginx, for example), and the request timeouts, returning us
+      # a raw HTML body instead of a JSON as we were expecting
+      @ms_message = "The server has not returned a valid JSON HTTP body: #{http_body}"
     end
 
     def details

lib/meilisearch/http_request.rb

@@ -54,6 +54,8 @@ 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)
       config = http_config(query_params, body)
       begin
@@ -65,7 +67,8 @@ def send_request(http_method, relative_path, query_params = nil, body = nil)
     end
 
     def http_config(query_params, body)
-      body = body.to_json
+      body = transform_attributes(body).to_json
+
       {
         headers: @headers,
         query: query_params,
@@ -75,6 +78,25 @@ def http_config(query_params, body)
       }.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

@@ -5,7 +5,7 @@
 
 module MeiliSearch
   class Index < HTTPRequest
-    attr_reader :uid, :primary_key
+    attr_reader :uid, :primary_key, :created_at, :updated_at
 
     def initialize(index_uid, url, api_key = nil, primary_key = nil, options = {})
       @uid = index_uid
@@ -16,12 +16,16 @@ def initialize(index_uid, url, api_key = nil, primary_key = nil, options = {})
     def fetch_info
       index_hash = http_get "/indexes/#{@uid}"
       @primary_key = index_hash['primaryKey']
+      @created_at = Time.parse(index_hash['createdAt'])
+      @updated_at = Time.parse(index_hash['updatedAt'])
       self
     end
 
     def update(body)
       index_hash = http_put "/indexes/#{@uid}", body
       @primary_key = index_hash['primaryKey']
+      @created_at = Time.parse(index_hash['createdAt'])
+      @updated_at = Time.parse(index_hash['updatedAt'])
       self
     end
     alias update_index update

spec/meilisearch/client/dumps_spec.rb

@@ -1,34 +1,29 @@
 # frozen_string_literal: true
 
 RSpec.describe 'MeiliSearch::Client - Dumps' do
-  before(:all) do
-    @client = MeiliSearch::Client.new(URL, MASTER_KEY)
-    clear_all_indexes(@client)
-  end
-
   it 'creates a new dump' do
-    response = @client.create_dump
+    response = client.create_dump
     expect(response).to be_a(Hash)
     expect(response['uid']).to_not be_nil
     expect(response['status']).to_not be_nil
     expect(response['status']).to eq('in_progress')
-    wait_for_dump_creation(@client, response['uid'])
+    wait_for_dump_creation(client, response['uid'])
   end
 
   it 'gets dump status' do
-    dump = @client.create_dump
-    response = @client.dump_status(dump['uid'])
+    dump = client.create_dump
+    response = client.dump_status(dump['uid'])
     expect(response['status']).to_not be_nil
-    wait_for_dump_creation(@client, dump['uid'])
+    wait_for_dump_creation(client, dump['uid'])
   end
 
   it 'fails to get dump status without uid' do
     expect do
-      @client.dump_status('uid_not_exists')
+      client.dump_status('uid_not_exists')
     end.to raise_meilisearch_api_error_with(404, 'not_found', 'invalid_request_error')
   end
 
   it 'works with method aliases' do
-    expect(@client.method(:dump_status) == @client.method(:get_dump_status)).to be_truthy
+    expect(client.method(:dump_status) == client.method(:get_dump_status)).to be_truthy
   end
 end