elasticsearch-api 6.3.0 → 6.8.3

data/spec/elasticsearch/api/actions/indices/update_aliases_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.cluster#update_aliases' do

data/spec/elasticsearch/api/actions/indices/upgrade_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.cluster#upgrade' do

data/spec/elasticsearch/api/actions/indices/validate_query_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.cluster#validate_query' do

data/spec/elasticsearch/api/actions/info_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#info' do

data/spec/elasticsearch/api/actions/ingest/delete_pipeline_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.ingest#delete_pipeline' do

data/spec/elasticsearch/api/actions/ingest/get_pipeline_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.ingest#get_pipeline' do

data/spec/elasticsearch/api/actions/ingest/put_pipeline_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.ingest#put_pipeline' do

data/spec/elasticsearch/api/actions/ingest/simulate_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.ingest#simulate' do

data/spec/elasticsearch/api/actions/json_builders_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 'JSON builders' do

data/spec/elasticsearch/api/actions/list_benchmarks_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#list_benchmarks' do
+
+  let(:expected_args) do
+    [
+        'GET',
+        '_bench',
+        { },
+        nil
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.list_benchmarks).to eq({})
+  end
+end

data/spec/elasticsearch/api/actions/mget_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#mget' do

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

@@ -0,0 +1,134 @@
+# 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 documents similar to the specified one.
+      #
+      # Performs a `more_like_this` query with the specified document as the input.
+      #
+      # @example Search for similar documents using the `title` property of document `myindex/mytype/1`
+      #
+      #     # First, let's setup a synonym-aware analyzer ("quick" <=> "fast")
+      #     client.indices.create index: 'myindex', body: {
+      #       settings: {
+      #         analysis: {
+      #           filter: {
+      #             synonyms: {
+      #               type: 'synonym',
+      #               synonyms: [ "quick,fast" ]
+      #             }
+      #           },
+      #           analyzer: {
+      #             title_synonym: {
+      #               type: 'custom',
+      #               tokenizer: 'whitespace',
+      #               filter: ['lowercase', 'stop', 'snowball', 'synonyms']
+      #             }
+      #           }
+      #         }
+      #       },
+      #       mappings: {
+      #         mytype: {
+      #           properties: {
+      #             title: {
+      #               type: 'string',
+      #               analyzer: 'title_synonym'
+      #             }
+      #           }
+      #         }
+      #       }
+      #     }
+      #
+      #     # Index three documents
+      #     client.index index: 'myindex', type: 'mytype', id: 1, body: { title: 'Quick Brown Fox'   }
+      #     client.index index: 'myindex', type: 'mytype', id: 2, body: { title: 'Slow Black Dog'    }
+      #     client.index index: 'myindex', type: 'mytype', id: 3, body: { title: 'Fast White Rabbit' }
+      #     client.indices.refresh index: 'myindex'
+      #
+      #     client.mlt index: 'myindex', type: 'mytype', id: 1, mlt_fields: 'title', min_doc_freq: 1, min_term_freq: 1
+      #     # => { ... {"title"=>"Fast White Rabbit"}}]}}
+      #
+      # @option arguments [String] :id The document ID (*Required*)
+      # @option arguments [String] :index The name of the index (*Required*)
+      # @option arguments [String] :type The type of the document (use `_all` to fetch
+      #                                  the first document matching the ID across all types) (*Required*)
+      # @option arguments [Hash] :body A specific search request definition
+      # @option arguments [Number] :boost_terms The boost factor
+      # @option arguments [Number] :max_doc_freq The word occurrence frequency as count: words with higher occurrence
+      #                                          in the corpus will be ignored
+      # @option arguments [Number] :max_query_terms The maximum query terms to be included in the generated query
+      # @option arguments [Number] :max_word_len The minimum length of the word: longer words will be ignored
+      # @option arguments [Number] :min_doc_freq The word occurrence frequency as count: words with lower occurrence
+      #                                          in the corpus will be ignored
+      # @option arguments [Number] :min_term_freq The term frequency as percent: terms with lower occurence
+      #                                           in the source document will be ignored
+      # @option arguments [Number] :min_word_len The minimum length of the word: shorter words will be ignored
+      # @option arguments [List] :mlt_fields Specific fields to perform the query against
+      # @option arguments [Number] :percent_terms_to_match How many terms have to match in order to consider
+      #                                                    the document a match (default: 0.3)
+      # @option arguments [String] :routing Specific routing value
+      # @option arguments [Number] :search_from The offset from which to return results
+      # @option arguments [List] :search_indices A comma-separated list of indices to perform the query against
+      #                                          (default: the index containing the document)
+      # @option arguments [String] :search_query_hint The search query hint
+      # @option arguments [String] :search_scroll A scroll search request definition
+      # @option arguments [Number] :search_size The number of documents to return (default: 10)
+      # @option arguments [String] :search_source A specific search request definition (instead of using the request body)
+      # @option arguments [String] :search_type Specific search type (eg. `dfs_then_fetch`, `count`, etc)
+      # @option arguments [List] :search_types A comma-separated list of types to perform the query against
+      #                                        (default: the same type as the document)
+      # @option arguments [List] :stop_words A list of stop words to be ignored
+      #
+      # @see http://elasticsearch.org/guide/reference/api/more-like-this/
+      #
+      def mlt(arguments={})
+        raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+        raise ArgumentError, "Required argument 'type' missing"  unless arguments[:type]
+        raise ArgumentError, "Required argument 'id' missing"    unless arguments[:id]
+        method = HTTP_GET
+        path   = Utils.__pathify Utils.__escape(arguments[:index]),
+                                 Utils.__escape(arguments[:type]),
+                                 Utils.__escape(arguments[:id]),
+                                 '_mlt'
+
+        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+
+        [:mlt_fields, :search_indices, :search_types, :stop_words].each do |name|
+          params[name] = Utils.__listify(params[name]) if params[name]
+        end
+
+        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(:mlt, [
+          :boost_terms,
+          :max_doc_freq,
+          :max_query_terms,
+          :max_word_len,
+          :min_doc_freq,
+          :min_term_freq,
+          :min_word_len,
+          :mlt_fields,
+          :percent_terms_to_match,
+          :routing,
+          :search_from,
+          :search_indices,
+          :search_query_hint,
+          :search_scroll,
+          :search_size,
+          :search_source,
+          :search_type,
+          :search_types,
+          :stop_words ].freeze)
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+# 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#mpercolate' do
+
+  let(:expected_args) do
+    [
+        'GET',
+        '_mpercolate',
+        params,
+        body
+    ]
+  end
+
+  let(:body) do
+    nil
+  end
+
+  let(:params) do
+    {}
+  end
+
+  context 'when a body is provided as a document' do
+
+    let(:body) do
+      "{\"percolate\":{\"index\":\"my-index\",\"type\":\"my-type\"}}\n{\"doc\":{\"message\":\"foo bar\"}}\n" +
+          "{\"percolate\":{\"index\":\"my-other-index\",\"type\":\"my-other-type\",\"id\":\"1\"}}\n{}\n"
+    end
+
+    it 'performs the request' do
+      expect(client_double.mpercolate(body: [
+          { percolate: { index: "my-index", type: "my-type" } },
+          { doc: { message: "foo bar" } },
+          { percolate: { index: "my-other-index", type: "my-other-type", id: "1" } },
+          { }
+      ])).to eq({})
+    end
+  end
+
+  context 'when a body is provided as a string' do
+
+    let(:body) do
+      %Q|{"foo":"bar"}\n{"moo":"lam"}|
+    end
+
+    it 'performs the request' do
+      expect(client_double.mpercolate(body: %Q|{"foo":"bar"}\n{"moo":"lam"}|)).to eq({})
+    end
+  end
+end

data/spec/elasticsearch/api/actions/msearch_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#msearch' do

data/spec/elasticsearch/api/actions/msearch_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#msearch_template' do

data/spec/elasticsearch/api/actions/mtermvectors_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#mtermvectors' do

data/spec/elasticsearch/api/actions/nodes/hot_threads_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.nodes#hot_threads' do

data/spec/elasticsearch/api/actions/nodes/info_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.nodes#info' do

data/spec/elasticsearch/api/actions/nodes/reload_secure_settings_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#reload_secure_settings' do

data/spec/elasticsearch/api/actions/nodes/shutdown_spec.rb

@@ -0,0 +1,63 @@
+# 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.nodes#shutdown' do
+
+  let(:expected_args) do
+    [
+        'POST',
+        url,
+        params,
+        nil,
+        nil
+    ]
+  end
+
+  let(:url) do
+    '_cluster/nodes/_shutdown'
+  end
+
+  it 'performs the request' do
+    expect(client_double.nodes.shutdown).to eq({})
+  end
+
+  let(:params) do
+    {}
+  end
+
+  context 'when the node id is specified' do
+
+    let(:url) do
+      '_cluster/nodes/foo/_shutdown'
+    end
+
+    it 'performs the request' do
+      expect(client_double.nodes.shutdown(node_id: 'foo')).to eq({})
+    end
+  end
+
+  context 'when multiple node ids are specified as a list' do
+
+    let(:url) do
+      '_cluster/nodes/A,B,C/_shutdown'
+    end
+
+    it 'performs the request' do
+      expect(client_double.nodes.shutdown(node_id: ['A', 'B', 'C'])).to eq({})
+    end
+  end
+
+  context 'when multiple node ids are specified as a String' do
+
+    let(:url) do
+      '_cluster/nodes/A,B,C/_shutdown'
+    end
+
+    it 'performs the request' do
+      expect(client_double.nodes.shutdown(node_id: 'A,B,C')).to eq({})
+    end
+  end
+end

data/spec/elasticsearch/api/actions/nodes/stats_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.nodes#stats' do

data/spec/elasticsearch/api/actions/ping_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#ping' do

data/spec/elasticsearch/api/actions/put_script_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#put_script' do