elasticsearch-api 6.3.0 → 6.8.3

data/spec/elasticsearch/api/actions/put_template_spec.rb

@@ -0,0 +1,21 @@
+# Licensed to Elasticsearch B.V under one or more agreements.
+# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
+# See the LICENSE file in the project root for more information
+
+require 'spec_helper'
+
+describe 'client#put_template' do
+
+  let(:expected_args) do
+    [
+        'POST',
+        '_scripts/foo',
+        { },
+        { }
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.put_template(id: 'foo', body: { })).to eq({})
+  end
+end

data/spec/elasticsearch/api/actions/rank_eval_spec.rb

@@ -0,0 +1,113 @@
+# Licensed to Elasticsearch B.V under one or more agreements.
+# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
+# See the LICENSE file in the project root for more information
+
+require 'spec_helper'
+
+describe 'client#rank_eval' do
+
+  let(:expected_args) do
+    [
+        'GET',
+        url,
+        params,
+        body
+    ]
+  end
+
+  let(:params) do
+    {}
+  end
+
+  let(:body) do
+    {}
+  end
+
+  let(:url) do
+    '_rank_eval'
+  end
+
+  context 'when there is no body specified' do
+
+    let(:client) do
+      Class.new { include Elasticsearch::API }.new
+    end
+
+    it 'raises an exception' do
+      expect {
+        client.rank_eval(index: 'my_index')
+      }.to raise_exception(ArgumentError)
+    end
+  end
+
+  context 'when an index is specified' do
+
+    let(:url) do
+      'my_index/_rank_eval'
+    end
+
+    it 'performs the request' do
+      expect(client.rank_eval(index: 'my_index', body: {})).to eq({})
+    end
+  end
+
+  context 'when params are provided' do
+
+    let(:params) do
+      {
+          ignore_unavailable: true,
+          allow_no_indices: false,
+          expand_wildcards: 'open'
+      }
+    end
+
+    it 'performs the request' do
+      expect(client_double.rank_eval(body: {},
+                                     ignore_unavailable: true,
+                                     allow_no_indices: false,
+                                     expand_wildcards: 'open')).to eq({})
+    end
+  end
+
+  context 'when a body is specified' do
+
+    let(:body) do
+      {
+          "requests": [
+              {
+                  "id": "JFK query",
+                  "request": { "query": { "match_all": {}}},
+                  "ratings": []
+              }],
+          "metric": {
+              "expected_reciprocal_rank": {
+                  "maximum_relevance": 3,
+                  "k": 20
+              }
+          }
+      }
+    end
+
+    let(:url) do
+      'my_index/_rank_eval'
+    end
+
+    it 'performs the request' do
+      expect(client_double.rank_eval(index: 'my_index',
+                                         body: {
+                                             "requests": [
+                                                 {
+                                                     "id": "JFK query",
+                                                     "request": { "query": { "match_all": {}}},
+                                                     "ratings": []
+                                                 }],
+                                             "metric": {
+                                                 "expected_reciprocal_rank": {
+                                                     "maximum_relevance": 3,
+                                                     "k": 20
+                                                 }
+                                             }
+                                         })).to eq({})
+    end
+  end
+end

data/spec/elasticsearch/api/actions/reindex_spec.rb

@@ -1,3 +1,7 @@
+# Licensed to Elasticsearch B.V under one or more agreements.
+# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
+# See the LICENSE file in the project root for more information
+
 require 'spec_helper'
 
 describe 'client#reindex' do

data/spec/elasticsearch/api/actions/remote/info_spec.rb

@@ -0,0 +1,22 @@
+# Licensed to Elasticsearch B.V under one or more agreements.
+# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
+# See the LICENSE file in the project root for more information
+
+require 'spec_helper'
+
+describe 'client.remote#info' do
+
+  let(:expected_args) do
+    [
+        'GET',
+        '_remote/info',
+        {},
+        nil,
+        nil
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.remote.info).to eq({})
+  end
+end

data/spec/elasticsearch/api/actions/render_search_template_spec.rb

@@ -1,3 +1,7 @@
+# Licensed to Elasticsearch B.V under one or more agreements.
+# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
+# See the LICENSE file in the project root for more information
+
 require 'spec_helper'
 
 describe 'client#render_search_template' do

data/spec/elasticsearch/api/actions/scoll_spec.rb

@@ -1,3 +1,7 @@
+# Licensed to Elasticsearch B.V under one or more agreements.
+# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
+# See the LICENSE file in the project root for more information
+
 require 'spec_helper'
 
 describe 'client#scroll' do

data/spec/elasticsearch/api/actions/search_exists_spec.rb

@@ -0,0 +1,67 @@
+# Licensed to Elasticsearch B.V under one or more agreements.
+# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
+# See the LICENSE file in the project root for more information
+
+module Elasticsearch
+  module API
+    module Actions
+
+      # Return whether documents exists for a particular query
+      #
+      # @option arguments [List] :index A comma-separated list of indices to restrict the results
+      # @option arguments [List] :type A comma-separated list of types to restrict the results
+      # @option arguments [Hash] :body A query to restrict the results specified with the Query DSL (optional)
+      # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when
+      #                                                 unavailable (missing or closed)
+      # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves
+      #                                               into no concrete indices.
+      # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices
+      #                                              that are open, closed or both.
+      #                                              (options: open, closed, none, all)
+      # @option arguments [Number] :min_score Include only documents with a specific `_score` value in the result
+      # @option arguments [String] :preference Specify the node or shard the operation should be performed on
+      #                                        (default: random)
+      # @option arguments [String] :routing Specific routing value
+      # @option arguments [String] :q Query in the Lucene query string syntax
+      # @option arguments [String] :analyzer The analyzer to use for the query string
+      # @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be
+      #                                               analyzed (default: false)
+      # @option arguments [String] :default_operator The default operator for query string query (AND or OR)
+      #                                              (options: AND, OR)
+      # @option arguments [String] :df The field to use as default where no field prefix is given
+      #                                in the query string
+      # @option arguments [Boolean] :lenient Specify whether format-based query failures
+      #                                      (such as providing text to a numeric field) should be ignored
+      # @option arguments [Boolean] :lowercase_expanded_terms Specify whether query terms should be lowercased
+      #
+      # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/search-exists.html
+      #
+      def search_exists(arguments={})
+        method = 'POST'
+        path   = "_search/exists"
+        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+        body   = arguments[:body]
+
+        perform_request(method, path, params, body).body
+      end
+
+      # Register this action with its valid params when the module is loaded.
+      #
+      # @since 6.2.0
+      ParamsRegistry.register(:search_exists, [
+          :ignore_unavailable,
+          :allow_no_indices,
+          :expand_wildcards,
+          :min_score,
+          :preference,
+          :routing,
+          :q,
+          :analyzer,
+          :analyze_wildcard,
+          :default_operator,
+          :df,
+          :lenient,
+          :lowercase_expanded_terms ].freeze)
+    end
+  end
+end

data/spec/elasticsearch/api/actions/search_shards_spec.rb

@@ -1,3 +1,7 @@
+# Licensed to Elasticsearch B.V under one or more agreements.
+# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
+# See the LICENSE file in the project root for more information
+
 require 'spec_helper'
 
 describe 'client#search_shards' do

data/spec/elasticsearch/api/actions/search_spec.rb

@@ -1,3 +1,7 @@
+# Licensed to Elasticsearch B.V under one or more agreements.
+# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
+# See the LICENSE file in the project root for more information
+
 require 'spec_helper'
 
 describe 'client#search' do

data/spec/elasticsearch/api/actions/search_template_spec.rb

@@ -1,3 +1,7 @@
+# Licensed to Elasticsearch B.V under one or more agreements.
+# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
+# See the LICENSE file in the project root for more information
+
 require 'spec_helper'
 
 describe 'client#search_template' do

data/spec/elasticsearch/api/actions/snapshot/create_repository_spec.rb

@@ -1,3 +1,7 @@
+# Licensed to Elasticsearch B.V under one or more agreements.
+# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
+# See the LICENSE file in the project root for more information
+
 require 'spec_helper'
 
 describe 'client.snapshot#create_repository' do

data/spec/elasticsearch/api/actions/snapshot/create_spec.rb

@@ -1,3 +1,7 @@
+# Licensed to Elasticsearch B.V under one or more agreements.
+# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
+# See the LICENSE file in the project root for more information
+
 require 'spec_helper'
 
 describe 'client.snapshot#create' do

data/spec/elasticsearch/api/actions/snapshot/delete_repository_spec.rb

@@ -1,3 +1,7 @@
+# Licensed to Elasticsearch B.V under one or more agreements.
+# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
+# See the LICENSE file in the project root for more information
+
 require 'spec_helper'
 
 describe 'client.snapshot#delete_repository' do

data/spec/elasticsearch/api/actions/snapshot/delete_spec.rb

@@ -1,3 +1,7 @@
+# Licensed to Elasticsearch B.V under one or more agreements.
+# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
+# See the LICENSE file in the project root for more information
+
 require 'spec_helper'
 
 describe 'client.snapshot#delete' do

data/spec/elasticsearch/api/actions/snapshot/get_repository_spec.rb

@@ -1,3 +1,7 @@
+# Licensed to Elasticsearch B.V under one or more agreements.
+# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
+# See the LICENSE file in the project root for more information
+
 require 'spec_helper'
 
 describe 'client.snapshot#get_repository' do

data/spec/elasticsearch/api/actions/snapshot/get_spec.rb

@@ -1,3 +1,7 @@
+# Licensed to Elasticsearch B.V under one or more agreements.
+# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
+# See the LICENSE file in the project root for more information
+
 require 'spec_helper'
 
 describe 'client.snapshot#get' do

data/spec/elasticsearch/api/actions/snapshot/restore_spec.rb

@@ -1,3 +1,7 @@
+# Licensed to Elasticsearch B.V under one or more agreements.
+# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
+# See the LICENSE file in the project root for more information
+
 require 'spec_helper'
 
 describe 'client.snapshot#restore' do

data/spec/elasticsearch/api/actions/snapshot/status_spec.rb

@@ -1,3 +1,7 @@
+# Licensed to Elasticsearch B.V under one or more agreements.
+# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
+# See the LICENSE file in the project root for more information
+
 require 'spec_helper'
 
 describe 'client.snapshot#status' do

data/spec/elasticsearch/api/actions/snapshot/verify_repository_spec.rb

@@ -1,3 +1,7 @@
+# Licensed to Elasticsearch B.V under one or more agreements.
+# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
+# See the LICENSE file in the project root for more information
+
 require 'spec_helper'
 
 describe 'client.snapshot#verify_repository' do

data/spec/elasticsearch/api/actions/suggest_spec.rb

@@ -0,0 +1,81 @@
+# Licensed to Elasticsearch B.V under one or more agreements.
+# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
+# See the LICENSE file in the project root for more information
+
+require 'spec_helper'
+
+describe 'client#suggest' do
+
+  let(:expected_args) do
+    [
+        'POST',
+        url,
+        params,
+        body
+    ]
+  end
+
+  let(:url) do
+    '_suggest'
+  end
+
+  let(:params) do
+    {}
+  end
+
+  let(:body) do
+    {}
+  end
+
+  it 'performs the request' do
+    expect(client_double.suggest(body: {})).to eq({})
+  end
+
+  context 'when an index is specified' do
+
+    let(:url) do
+      'foo/_suggest'
+    end
+
+    it 'performs the request' do
+      expect(client_double.suggest(index: 'foo', body: {}))
+    end
+  end
+
+  context 'when there are URL params specified' do
+
+    let(:url) do
+      'foo/_suggest'
+    end
+
+    let(:params) do
+      { routing: 'abc123' }
+    end
+
+    it 'performs the request' do
+      expect(client_double.suggest(index: 'foo', routing: 'abc123', body: {}))
+    end
+  end
+
+  context 'when the request must be URL-escaped' do
+
+    let(:url) do
+      'foo%5Ebar/_suggest'
+    end
+
+    it 'performs the request' do
+      expect(client_double.suggest(index: 'foo^bar', body: {}))
+    end
+  end
+
+  context 'when the request definition is specified in the body' do
+
+    let(:body) do
+      { my_suggest: { text: 'test' } }
+    end
+
+    it 'performs the request' do
+      expect(client_double.suggest(body: { my_suggest: { text: 'test' } } ))
+    end
+  end
+end