Merge branch 'main' into add-docker-composer-for-local-development

Author: thicolares

.code-samples.meilisearch.yaml

@@ -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: |-

README.md

@@ -152,6 +152,50 @@ JSON output:
 }
 ```
 
+#### Custom Search With Filters <!-- omit in toc -->
+
+If you want to enable filtering, you must add your attributes to the `filterableAttributes` index setting.
+
+```ruby
+index.update_filterable_attributes([
+  'id',
+  'genres'
+])
+```
+
+You only need to perform this operation once.
+
+Note that MeiliSearch will rebuild your index whenever you update `filterableAttributes`. Depending on the size of your dataset, this might take time. You can track the process using the [update status](https://docs.meilisearch.com/reference/api/updates.html#get-an-update-status).
+
+Then, you can perform the search:
+
+```ruby
+index.search('wonder', { filter: ['id > 1 AND genres = Action'] })
+```
+
+JSON output:
+
+```json
+{
+  "hits": [
+    {
+      "id": 2,
+      "title": "Wonder Woman",
+      "genres": [
+        "Action",
+        "Adventure"
+      ]
+    }
+  ],
+  "nbHits": 1,
+  "exhaustiveNbHits": false,
+  "query": "wonder",
+  "limit": 20,
+  "offset": 0,
+  "processingTimeMs": 0
+}
+```
+
 ## 🤖 Compatibility with MeiliSearch
 
 This package only guarantees the compatibility with the [version v0.23.0 of MeiliSearch](https://github.com/meilisearch/MeiliSearch/releases/tag/v0.23.0).

lib/meilisearch/client.rb

@@ -6,8 +6,14 @@ module MeiliSearch
   class Client < HTTPRequest
     ### INDEXES
 
+    def raw_indexes
+      http_get('/indexes')
+    end
+
     def indexes
-      http_get '/indexes'
+      raw_indexes.map do |index_hash|
+        index_object(index_hash['uid'], index_hash['primaryKey'])
+      end
     end
 
     # Usage:

lib/meilisearch/http_request.rb

@@ -17,47 +17,54 @@ def initialize(url, api_key = nil, options = {})
         'Content-Type' => 'application/json',
         'X-Meili-API-Key' => api_key
       }.compact
+      @headers_no_body = {
+        'X-Meili-API-Key' => api_key
+      }.compact
     end
 
     def http_get(relative_path = '', query_params = {})
       send_request(
         proc { |path, config| self.class.get(path, config) },
         relative_path,
-        query_params
+        query_params: query_params,
+        headers: @headers_no_body
       )
     end
 
     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
+        query_params: query_params,
+        body: body,
+        headers: @headers
       )
     end
 
     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
+        query_params: query_params,
+        body: body,
+        headers: @headers
       )
     end
 
     def http_delete(relative_path = '')
       send_request(
         proc { |path, config| self.class.delete(path, config) },
-        relative_path
+        relative_path,
+        headers: @headers_no_body
       )
     end
 
     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)
+    def send_request(http_method, relative_path, query_params: nil, body: nil, headers: nil)
+      config = http_config(query_params, body, headers)
       begin
         response = http_method.call(@base_url + relative_path, config)
       rescue Errno::ECONNREFUSED => e
@@ -66,11 +73,10 @@ def send_request(http_method, relative_path, query_params = nil, body = nil)
       validate(response)
     end
 
-    def http_config(query_params, body)
+    def http_config(query_params, body, headers)
       body = transform_attributes(body).to_json
-
       {
-        headers: @headers,
+        headers: headers,
         query: query_params,
         body: body,
         timeout: @options[:timeout] || 1,

spec/meilisearch/client/indexes_spec.rb

@@ -79,10 +79,18 @@
     end.to raise_meilisearch_api_error_with(400, 'invalid_index_uid', 'invalid_request_error')
   end
 
-  it 'gets list of indexes' do
+  it 'gets list of indexes as MeiliSearch::Index' do
+    client.create_index('index')
+
+    response = client.indexes.first
+
+    expect(response).to be_a(MeiliSearch::Index)
+  end
+
+  it 'gets list of raw indexes' do
     ['first_index', 'second_index', 'third_index'].each { |name| client.create_index(name) }
 
-    indexes = client.indexes
+    indexes = client.raw_indexes
 
     expect(indexes).to be_a(Array)
     expect(indexes.length).to eq(3)

spec/meilisearch/index/base_spec.rb

@@ -62,7 +62,7 @@
     expect(MeiliSearch::Index).to receive(:get).with(
       "#{URL}/indexes/options",
       {
-        headers: { 'Content-Type' => 'application/json', 'X-Meili-API-Key' => MASTER_KEY },
+        headers: { 'X-Meili-API-Key' => MASTER_KEY },
         body: 'null',
         query: {},
         max_retries: 1,

spec/support/indexes_helpers.rb

@@ -3,7 +3,7 @@
 module IndexesHelpers
   def clear_all_indexes(client)
     indexes = client.indexes
-    uids = indexes.map { |index| index['uid'] }
+    uids = indexes.map(&:uid)
     uids.each do |uid|
       client.delete_index(uid)
     end