elasticsearch-api 6.2.0 → 6.8.0

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

@@ -1,117 +1,130 @@
-require 'spec_helper'
-
-describe 'client#mlt' do
-
-  let(:expected_args) do
-    [
-        'GET',
-        url,
-        params,
-        body
-    ]
-  end
-
-  let(:body) do
-    nil
-  end
-
-  let(:params) do
-    {}
-  end
-
-  let(:client) do
-    Class.new { include Elasticsearch::API }.new
-  end
-
-  it 'requires the :index argument' do
-    expect {
-      client.mlt(type: 'bar', id: '1')
-    }.to raise_exception(ArgumentError)
-  end
-
-  it 'requires the :id argument' do
-    expect {
-      client.mlt(index: 'foo', type: 'bar')
-    }.to raise_exception(ArgumentError)
-  end
-
-  it 'requires the :type argument' do
-    expect {
-      client.mlt(index: 'foo', id: '1')
-    }.to raise_exception(ArgumentError)
-  end
-
-  context 'when an index is specified' do
-
-    let(:url) do
-      'foo/bar/1/_mlt'
-    end
-
-    it 'performs the request' do
-      expect(client_double.mlt(index: 'foo', type: 'bar', id: '1')).to eq({})
-    end
-  end
-
-  context 'when url parameters are provided' do
-
-    let(:url) do
-      'foo/bar/1/_mlt'
-    end
-
-    let(:params) do
-      { max_doc_freq: 1 }
-    end
-
-    it 'performs the request' do
-      expect(client_double.mlt(index: 'foo', type: 'bar', id: '1', max_doc_freq: 1)).to eq({})
-    end
-  end
-
-  context 'when url parameters as lists are provided' do
-
-    let(:url) do
-      'foo/bar/1/_mlt'
-    end
-
-    let(:params) do
-      { mlt_fields: 'foo,bar',
-        search_indices: 'A,B',
-        search_types: 'X,Y',
-        stop_words: 'lam,bam' }
-    end
-
-    it 'performs the request' do
-      expect(client_double.mlt( index: 'foo', type: 'bar', id: '1',
-                                mlt_fields: ['foo', 'bar'],
-                                search_indices: ['A', 'B'],
-                                search_types: ['X', 'Y'],
-                                stop_words: ['lam','bam'])).to eq({})
-    end
-  end
-
-  context 'when the request needs to be URL-escaped' do
-
-    let(:url) do
-      'foo%5Ebar/bar%2Fbam/1/_mlt'
-    end
-
-    it 'performs the request' do
-      expect(client_double.mlt(index: 'foo^bar', type: 'bar/bam', id: '1')).to eq({})
-    end
-  end
-
-  context 'when a search criteria is provided' do
-
-    let(:url) do
-      'foo/bar/1/_mlt'
-    end
-
-    let(:body) do
-      { query: {} }
-    end
-
-    it 'passes the search definition in the body' do
-      expect(client_double.mlt(index: 'foo', type: 'bar', id: '1', body: { query: {} })).to eq({})
+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/search_exists_spec.rb

@@ -1,17 +1,63 @@
-require 'spec_helper'
+module Elasticsearch
+  module API
+    module Actions
 
-describe 'client#search_exists' do
+      # 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]
 
-  let(:expected_args) do
-    [
-        'POST',
-        '_search/exists',
-        { q: 'foo' },
-        nil
-    ]
-  end
+        perform_request(method, path, params, body).body
+      end
 
-  it 'performs the request' do
-    expect(client_double.search_exists(q: 'foo')).to eq({})
+      # 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_spec.rb

@@ -113,19 +113,4 @@ describe 'client#search' do
       }.to raise_exception(ArgumentError)
     end
   end
-
-  context 'when the request field params are not URL-encoded' do
-
-    let(:params) do
-      { fields: 'foo^bar'}
-    end
-
-    let(:url) do
-      'foo/bar/_search'
-    end
-
-    it 'does not encode the field params' do
-      expect(client_double.search(index: 'foo', type: 'bar', fields: 'foo^bar'))
-    end
-  end
 end

data/test/integration/yaml_test_runner.rb

@@ -143,7 +143,7 @@ module Elasticsearch
 
       def symbolize_keys(object)
         if object.is_a? Hash
-          object.reduce({}) { |memo,(k,v)| memo[k.to_sym] = symbolize_keys(v); memo }
+          object.reduce({}) { |memo,(k,v)| memo[k.to_s.to_sym] = symbolize_keys(v); memo }
         else
           object
         end
@@ -297,9 +297,7 @@ suites.each do |suite|
     #
     setup do
       $helper_client.indices.delete index: '_all', ignore: 404
-      $helper_client.indices.delete_template name: 'test_2', ignore: 404
-      $helper_client.indices.delete_template name: 'test', ignore: 404
-      $helper_client.indices.delete_template name: 'index_template', ignore: 404
+      $helper_client.indices.delete_template name: '*', ignore: 404
       $helper_client.snapshot.delete repository: 'test_repo_create_1',  snapshot: 'test_snapshot', ignore: 404
       $helper_client.snapshot.delete repository: 'test_repo_restore_1', snapshot: 'test_snapshot', ignore: 404
       $helper_client.snapshot.delete repository: 'test_cat_snapshots_1', snapshot: 'snap1', ignore: 404

data/utils/thor/generate_source.rb

@@ -47,6 +47,7 @@ module Elasticsearch
         copy_file "templates/ruby/test_helper.rb", @output.join('test').join('test_helper.rb') if options[:language] == 'ruby'
 
         Dir[@input].each do |file|
+          next if File.basename(file)[0] == '_'
           @path   = Pathname(file)
           @json   = MultiJson.load( File.read(@path) )
           @spec   = @json.values.first

data/utils/thor/templates/ruby/method.erb

@@ -35,14 +35,10 @@ module Elasticsearch
       <%= '  '*(@namespace_depth+1) + "raise ArgumentError, \"Required argument 'body' missing\" unless arguments[:body]" + "\n" -%>
 <%- end -%>
 <%# Method, path, params, body  -%>
-      <%- unless @spec['url']['params'].empty? -%>
-      <%= '  '*@namespace_depth %>  valid_params = [
-      <%= '  '*(@namespace_depth+2) %><%= @spec['url']['params'].keys.map { |k| ":#{k}" }.join(",\n#{'  '*(@namespace_depth+5)}") %> ]
-      <%- end -%>
       <%= '  '*@namespace_depth %>  method = <%= @http_method %>
       <%= '  '*@namespace_depth %>  path   = "<%= @http_path %>"
       <%- unless @spec['url']['params'].empty? -%>
-      <%= '  '*@namespace_depth %>  params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, valid_params
+      <%= '  '*@namespace_depth %>  params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
       <%- else -%>
       <%= '  '*@namespace_depth %>  params = {}
       <%- end -%>
@@ -53,6 +49,12 @@ module Elasticsearch
       <%- @namespace_depth.downto(1) do |i| -%>
       <%= '  '*(i-1) %>end
       <%- end if @namespace_depth > 0 -%>
+
+      <%= '  '*@namespace_depth -%># Register this action with its valid params when the module is loaded.
+      <%= '  '*@namespace_depth -%>#
+      <%= '  '*@namespace_depth -%># @since 6.2.0
+      <%= '  '*@namespace_depth -%>ParamsRegistry.register(:<%= @method_name -%>, [
+      <%= '  '*(@namespace_depth +2) + @spec['url']['params'].keys.map { |k| ":#{k}" }.join(",\n#{'  '*(@namespace_depth+5)}") %> ].freeze)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-api
 version: !ruby/object:Gem::Version
-  version: 6.2.0
+  version: 6.8.0
 platform: ruby
 authors:
 - Karel Minarik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-13 00:00:00.000000000 Z
+date: 2019-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -334,7 +334,7 @@ dependencies:
         version: '2'
 description: 'Ruby API for Elasticsearch. See the `elasticsearch` gem for full integration.
 
-'
+  '
 email:
 - karel.minarik@elasticsearch.org
 executables: []
@@ -391,9 +391,11 @@ files:
 - lib/elasticsearch/api/actions/create.rb
 - lib/elasticsearch/api/actions/delete.rb
 - lib/elasticsearch/api/actions/delete_by_query.rb
+- lib/elasticsearch/api/actions/delete_by_query_rethrottle.rb
 - lib/elasticsearch/api/actions/delete_script.rb
 - lib/elasticsearch/api/actions/delete_template.rb
 - lib/elasticsearch/api/actions/exists.rb
+- lib/elasticsearch/api/actions/exists_source.rb
 - lib/elasticsearch/api/actions/explain.rb
 - lib/elasticsearch/api/actions/field_caps.rb
 - lib/elasticsearch/api/actions/field_stats.rb
@@ -454,6 +456,7 @@ files:
 - lib/elasticsearch/api/actions/ingest/delete_pipeline.rb
 - lib/elasticsearch/api/actions/ingest/get_pipeline.rb
 - lib/elasticsearch/api/actions/ingest/params_registry.rb
+- lib/elasticsearch/api/actions/ingest/processor_grok.rb
 - lib/elasticsearch/api/actions/ingest/put_pipeline.rb
 - lib/elasticsearch/api/actions/ingest/simulate.rb
 - lib/elasticsearch/api/actions/list_benchmarks.rb
@@ -469,14 +472,18 @@ files:
 - lib/elasticsearch/api/actions/nodes/reload_secure_settings.rb
 - lib/elasticsearch/api/actions/nodes/shutdown.rb
 - lib/elasticsearch/api/actions/nodes/stats.rb
+- lib/elasticsearch/api/actions/nodes/usage.rb
 - lib/elasticsearch/api/actions/params_registry.rb
 - lib/elasticsearch/api/actions/percolate.rb
 - lib/elasticsearch/api/actions/ping.rb
 - lib/elasticsearch/api/actions/put_script.rb
 - lib/elasticsearch/api/actions/put_template.rb
+- lib/elasticsearch/api/actions/rank_eval.rb
 - lib/elasticsearch/api/actions/reindex.rb
+- lib/elasticsearch/api/actions/reindex_rethrottle.rb
 - lib/elasticsearch/api/actions/remote/info.rb
 - lib/elasticsearch/api/actions/render_search_template.rb
+- lib/elasticsearch/api/actions/scripts_painless_execute.rb
 - lib/elasticsearch/api/actions/scroll.rb
 - lib/elasticsearch/api/actions/search.rb
 - lib/elasticsearch/api/actions/search_exists.rb
@@ -500,6 +507,7 @@ files:
 - lib/elasticsearch/api/actions/termvectors.rb
 - lib/elasticsearch/api/actions/update.rb
 - lib/elasticsearch/api/actions/update_by_query.rb
+- lib/elasticsearch/api/actions/update_by_query_rethrottle.rb
 - lib/elasticsearch/api/namespace/cat.rb
 - lib/elasticsearch/api/namespace/cluster.rb
 - lib/elasticsearch/api/namespace/common.rb
@@ -577,7 +585,6 @@ files:
 - spec/elasticsearch/api/actions/indices/flush_spec.rb
 - spec/elasticsearch/api/actions/indices/flush_synced_spec.rb
 - spec/elasticsearch/api/actions/indices/forcemerge_spec.rb
-- spec/elasticsearch/api/actions/indices/freeze_spec.rb
 - spec/elasticsearch/api/actions/indices/get_alias_spec.rb
 - spec/elasticsearch/api/actions/indices/get_aliases_spec.rb
 - spec/elasticsearch/api/actions/indices/get_field_mapping_spec.rb
@@ -602,9 +609,7 @@ files:
 - spec/elasticsearch/api/actions/indices/shrink_spec.rb
 - spec/elasticsearch/api/actions/indices/snapshot_index_spec.rb
 - spec/elasticsearch/api/actions/indices/split_spec.rb
-- spec/elasticsearch/api/actions/indices/stats_spec.rb
 - spec/elasticsearch/api/actions/indices/status_spec.rb
-- spec/elasticsearch/api/actions/indices/unfreeze_spec.rb
 - spec/elasticsearch/api/actions/indices/update_aliases_spec.rb
 - spec/elasticsearch/api/actions/indices/upgrade_spec.rb
 - spec/elasticsearch/api/actions/indices/validate_query_spec.rb
@@ -688,7 +693,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Ruby API for Elasticsearch.
@@ -759,7 +764,6 @@ test_files:
 - spec/elasticsearch/api/actions/indices/flush_spec.rb
 - spec/elasticsearch/api/actions/indices/flush_synced_spec.rb
 - spec/elasticsearch/api/actions/indices/forcemerge_spec.rb
-- spec/elasticsearch/api/actions/indices/freeze_spec.rb
 - spec/elasticsearch/api/actions/indices/get_alias_spec.rb
 - spec/elasticsearch/api/actions/indices/get_aliases_spec.rb
 - spec/elasticsearch/api/actions/indices/get_field_mapping_spec.rb
@@ -784,9 +788,7 @@ test_files:
 - spec/elasticsearch/api/actions/indices/shrink_spec.rb
 - spec/elasticsearch/api/actions/indices/snapshot_index_spec.rb
 - spec/elasticsearch/api/actions/indices/split_spec.rb
-- spec/elasticsearch/api/actions/indices/stats_spec.rb
 - spec/elasticsearch/api/actions/indices/status_spec.rb
-- spec/elasticsearch/api/actions/indices/unfreeze_spec.rb
 - spec/elasticsearch/api/actions/indices/update_aliases_spec.rb
 - spec/elasticsearch/api/actions/indices/upgrade_spec.rb
 - spec/elasticsearch/api/actions/indices/validate_query_spec.rb

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

@@ -1,68 +0,0 @@
-require 'spec_helper'
-
-describe 'client.indices#freeze' do
-
-  let(:expected_args) do
-    [
-        'POST',
-        url,
-        params,
-        nil,
-        nil
-    ]
-  end
-
-  let(:params) do
-    {}
-  end
-
-  context 'when there is no index specified' do
-
-    let(:client) do
-      Class.new { include Elasticsearch::API }.new
-    end
-
-    it 'raises an exception' do
-      expect {
-        client.indices.freeze
-      }.to raise_exception(ArgumentError)
-    end
-  end
-
-  context 'when an index is specified' do
-
-    let(:url) do
-      'foo/_freeze'
-    end
-
-    it 'performs the request' do
-      expect(client_double.indices.freeze(index: 'foo')).to eq({})
-    end
-  end
-
-  context 'when params are specified' do
-
-    let(:params) do
-      { timeout: '1s' }
-    end
-
-    let(:url) do
-      'foo/_freeze'
-    end
-
-    it 'performs the request' do
-      expect(client_double.indices.freeze(index: 'foo', timeout: '1s')).to eq({})
-    end
-  end
-
-  context 'when the path must be URL-escaped' do
-
-    let(:url) do
-      'foo%5Ebar/_freeze'
-    end
-
-    it 'performs the request' do
-      expect(client_double.indices.freeze(index: 'foo^bar')).to eq({})
-    end
-  end
-end