elasticsearch-api 6.8.3 → 7.0.0.pre

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

@@ -1,96 +0,0 @@
-# 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#status' do
-
-  let(:expected_args) do
-    [
-        'GET',
-        url,
-        params,
-        body,
-        nil
-    ]
-  end
-
-  let(:url) do
-    '_status'
-  end
-
-  let(:body) do
-    nil
-  end
-
-  let(:params) do
-    {}
-  end
-
-  it 'performs the request' do
-    expect(client_double.indices.status).to eq({})
-  end
-
-  context 'when an index is specified' do
-
-    let(:url) do
-      'foo/_status'
-    end
-
-    it 'performs the request' do
-      expect(client_double.indices.status(index: 'foo')).to eq({})
-    end
-  end
-
-  context 'when multiple indicies are specified as a list' do
-
-    let(:url) do
-      'foo,bar/_status'
-    end
-
-    it 'performs the request' do
-      expect(client_double.indices.status(index: ['foo', 'bar'])).to eq({})
-    end
-  end
-
-  context 'when multiple indicies are specified as a string' do
-
-
-    let(:url) do
-      'foo,bar/_status'
-    end
-
-    it 'performs the request' do
-      expect(client_double.indices.status(index: 'foo,bar')).to eq({})
-    end
-  end
-
-  context 'when parameters are specified' do
-
-    let(:params) do
-      { recovery: true }
-    end
-
-    let(:url) do
-      'foo/_status'
-    end
-
-    it 'performs the request' do
-      expect(client_double.indices.status(index: 'foo', recovery: true)).to eq({})
-    end
-  end
-
-  context 'when a \'not found\' exception is raised' do
-
-    let(:client) do
-      Class.new { include Elasticsearch::API }.new.tap do |_client|
-        expect(_client).to receive(:perform_request).and_raise(NotFound)
-      end
-    end
-
-    it 'does not raise the exception' do
-      expect(client.indices.status(index: 'foo', ignore: 404)).to eq(false)
-    end
-  end
-end

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

@@ -1,21 +0,0 @@
-# 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/mlt_spec.rb

@@ -1,134 +0,0 @@
-# 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

@@ -1,53 +0,0 @@
-# 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/put_template_spec.rb

@@ -1,21 +0,0 @@
-# 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

@@ -1,113 +0,0 @@
-# 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/search_exists_spec.rb

@@ -1,67 +0,0 @@
-# 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