elasticsearch-api 5.0.3 → 5.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b3188226786b2679f216c0d53b42b50161807487
-  data.tar.gz: 180c234ec4778735f237338399e752110f74f3e8
+  metadata.gz: 2cb2788ca6e0c1ccc1b739be6fb09f755491fb3c
+  data.tar.gz: 3385a2f367ed82e6c039187c6c02c87ff726f2ad
 SHA512:
-  metadata.gz: ddbb45d5e61db1ada854c55d12466acc53ead1908e3f89fe4df5e7c30a9c9c0b7cfc3fda09f8531c8863d1715ae6e66b777ee10bc72dfe8e6a91bf9143a05643
-  data.tar.gz: 9aec54b25b788267b607af4b31bd94bf95ab499d88bd933290d951d555db9b1a49b922b6672a1fe7fde392225ff3cd6688ae556587907da4baf4da00a64ede3e
+  metadata.gz: 9cce9772d2b00e7e3075eb9147875db1ed873e8243cd8daf7cb5075ef9576bdff6f9da9d2fd906b6d5d3da353d812f9a15c6c7e7a9c8e17897b56719316b2882
+  data.tar.gz: db7a3603ce3702d8cac834774917f1d0b3ddb6960d955ffa50ef584293cc59bc826a6e8f374a5cb15baa38b0bb874acd0edbe2438078137e00f129773f5c59e6

data/lib/elasticsearch/api/actions/clear_scroll.rb

@@ -12,19 +12,10 @@ module Elasticsearch
       def clear_scroll(arguments={})
         raise ArgumentError, "Required argument 'scroll_id' missing" unless arguments[:scroll_id]
 
-        scroll_id = arguments[:body] || arguments.delete(:scroll_id)
-
-        scroll_ids = case scroll_id
-          when Array
-            scroll_id.join(',')
-          else
-            scroll_id
-        end
-
         method = HTTP_DELETE
-        path   = Utils.__pathify '_search/scroll'
+        path   = Utils.__pathify '_search/scroll', Utils.__listify(arguments.delete(:scroll_id))
         params = {}
-        body   = scroll_ids
+        body   = arguments[:body]
 
         perform_request(method, path, params, body).body
       end

data/lib/elasticsearch/api/actions/exists.rb

@@ -10,13 +10,19 @@ module Elasticsearch
       #
       # @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 (default: `_all`)
+      # @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 [List] :stored_fields A comma-separated list of stored fields to return in the response
       # @option arguments [String] :parent The ID of the parent document
-      # @option arguments [String] :preference Specify the node or shard the operation should be performed on
-      #                                        (default: random)
+      # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
       # @option arguments [Boolean] :realtime Specify whether to perform the operation in realtime or search mode
       # @option arguments [Boolean] :refresh Refresh the shard containing the document before performing the operation
       # @option arguments [String] :routing Specific routing value
+      # @option arguments [List] :_source True or false to return the _source field or not, or a list of fields to return
+      # @option arguments [List] :_source_exclude A list of fields to exclude from the returned _source field
+      # @option arguments [List] :_source_include A list of fields to extract and return from the _source field
+      # @option arguments [Number] :version Explicit version number for concurrency control
+      # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte, force)
+
       #
       # @see http://elasticsearch.org/guide/reference/api/get/
       #
@@ -26,11 +32,17 @@ module Elasticsearch
         arguments[:type] ||= UNDERSCORE_ALL
 
         valid_params = [
+          :stored_fields,
           :parent,
           :preference,
           :realtime,
           :refresh,
-          :routing ]
+          :routing,
+          :_source,
+          :_source_exclude,
+          :_source_include,
+          :version,
+          :version_type ]
 
         method = HTTP_HEAD
         path   = Utils.__pathify Utils.__escape(arguments[:index]),

data/lib/elasticsearch/api/actions/field_caps.rb

@@ -0,0 +1,38 @@
+module Elasticsearch
+  module API
+    module Actions
+
+      # Return the capabilities of fields among multiple indices
+      #
+      # @example
+      #     client.field_caps fields: '*'
+      #     # => { "fields" => "t"=>{"text"=>{"type"=>"text", "searchable"=>true, "aggregatable"=>false}} ...
+      #
+      # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
+      # @option arguments [Hash] :body Field json objects containing an array of field names
+      # @option arguments [List] :fields A comma-separated list of field names (*Required*)
+      # @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. (This includes `_all` string or when no indices have been specified)
+      # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, none, all)
+      #
+      # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-caps.html
+      #
+      def field_caps(arguments={})
+        raise ArgumentError, "Required argument 'fields' missing" unless arguments[:fields]
+
+        valid_params = [
+          :fields,
+          :ignore_unavailable,
+          :allow_no_indices,
+          :expand_wildcards ]
+
+        method = HTTP_GET
+        path   = Utils.__pathify Utils.__listify(arguments[:index]), '_field_caps'
+        params = Utils.__validate_and_extract_params arguments, valid_params
+        body   = arguments[:body]
+
+        perform_request(method, path, params, body).body
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/indices/clear_cache.rb

@@ -23,27 +23,17 @@ module Elasticsearch
         #     client.indices.clear_cache field_data: true, fields: 'created_at', filter_cache: false, id_cache: false
         #
         # @option arguments [List] :index A comma-separated list of index name to limit the operation
-        # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into
-        #                                               no concrete indices. (This includes `_all` string or when no
-        #                                               indices have been specified)
-        # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that
-        #                                              are open, closed or both. (options: open, closed)
         # @option arguments [Boolean] :field_data Clear field data
         # @option arguments [Boolean] :fielddata Clear field data
-        # @option arguments [List] :fields A comma-separated list of fields to clear when using the
-        #                                  `field_data` parameter(default: all)
-        # @option arguments [Boolean] :filter Clear filter caches
-        # @option arguments [Boolean] :filter_cache Clear filter caches
-        # @option arguments [List] :filter_keys A comma-separated list of keys to clear when using the
-        #                                          `filter_cache` parameter (default: all)
-        # @option arguments [Boolean] :id Clear ID caches for parent/child
-        # @option arguments [Boolean] :id_cache Clear ID caches for parent/child
-        # @option arguments [String] :ignore_indices When performed on multiple indices, allows to ignore
-        #                                            `missing` ones (options: none, missing) @until 1.0
-        # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when
-        #                                                 unavailable (missing, closed, etc)
+        # @option arguments [List] :fields A comma-separated list of fields to clear when using the `field_data` parameter (default: all)
+        # @option arguments [Boolean] :query Clear query caches
+        # @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. (This includes `_all` string or when no indices have been specified)
+        # @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 [List] :index A comma-separated list of index name to limit the operation
         # @option arguments [Boolean] :recycler Clear the recycler cache
+        # @option arguments [Boolean] :request_cache Clear request cache
+        # @option arguments [Boolean] :request Clear request cache
         #
         # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-clearcache.html
         #
@@ -52,16 +42,14 @@ module Elasticsearch
             :field_data,
             :fielddata,
             :fields,
-            :filter,
-            :filter_cache,
-            :filter_keys,
-            :id,
-            :id_cache,
-            :ignore_indices,
+            :query,
             :ignore_unavailable,
             :allow_no_indices,
             :expand_wildcards,
-            :recycler ]
+            :index,
+            :recycler,
+            :request_cache,
+            :request ]
 
           method = HTTP_POST
           path   = Utils.__pathify Utils.__listify(arguments[:index]), '_cache/clear'

data/lib/elasticsearch/api/actions/msearch.rb

@@ -28,16 +28,20 @@ module Elasticsearch
       #
       # @option arguments [List] :index A comma-separated list of index names to use as default
       # @option arguments [List] :type A comma-separated list of document types to use as default
-      # @option arguments [Array<Hash>] :body An array of request definitions, each definition is a Hash;
-      #                                       pass the search definition as a `:search` argument
-      # @option arguments [String] :search_type Search operation type (options: query_then_fetch, query_and_fetch,
-      #                                         dfs_query_then_fetch, dfs_query_and_fetch, count, scan)
+      # @option arguments [Hash] :body The request definitions (metadata-search request definition pairs), separated by newlines (*Required*)
+      # @option arguments [String] :search_type Search operation type (options: query_then_fetch, query_and_fetch, dfs_query_then_fetch, dfs_query_and_fetch)
+      # @option arguments [Number] :max_concurrent_searches Controls the maximum number of concurrent searches the multi search api will execute
+      # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
       #
-      # @see http://www.elasticsearch.org/guide/reference/api/multi-search/
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-multi-search.html
       #
       def msearch(arguments={})
         raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
-        valid_params = [ :search_type ]
+
+         valid_params = [
+          :search_type,
+          :max_concurrent_searches,
+          :typed_keys ]
 
         method = HTTP_GET
         path   = Utils.__pathify( Utils.__listify(arguments[:index]), Utils.__listify(arguments[:type]), '_msearch' )

data/lib/elasticsearch/api/actions/scroll.rb

@@ -46,8 +46,7 @@ module Elasticsearch
       #                                      should be maintained for scrolled search
       #
       # @see http://www.elasticsearch.org/guide/en/elasticsearch/guide/current/scan-scroll.html#scan-scroll
-      # @see http://www.elasticsearch.org/guide/reference/api/search/scroll/
-      # @see http://www.elasticsearch.org/guide/reference/api/search/search-type/
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-scroll.html
       #
       def scroll(arguments={})
         method = HTTP_GET
@@ -57,7 +56,7 @@ module Elasticsearch
           :scroll_id ]
 
         params = Utils.__validate_and_extract_params arguments, valid_params
-        body   = arguments[:body] || params.delete(:scroll_id)
+        body   = arguments[:body]
 
         perform_request(method, path, params, body).body
       end

data/lib/elasticsearch/api/actions/search.rb

@@ -113,7 +113,9 @@ module Elasticsearch
       # @option arguments [Text] :suggest_text The source text for which the suggestions should be returned
       # @option arguments [Number] :terminate_after The maximum number of documents to collect for each shard
       # @option arguments [Time] :timeout Explicit operation timeout
+      # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
       # @option arguments [Boolean] :version Specify whether to return document version as part of a hit
+      # @option arguments [Number] :batched_reduce_size The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large.
       #
       # @return [Hash]
       #
@@ -161,7 +163,9 @@ module Elasticsearch
           :suggest_text,
           :terminate_after,
           :timeout,
-          :version ]
+          :typed_keys,
+          :version,
+          :batched_reduce_size ]
 
         method = HTTP_GET
         path   = Utils.__pathify( Utils.__listify(arguments[:index]), Utils.__listify(arguments[:type]), UNDERSCORE_SEARCH )

data/lib/elasticsearch/api/version.rb

@@ -1,5 +1,5 @@
 module Elasticsearch
   module API
-    VERSION = "5.0.3"
+    VERSION = "5.0.4"
   end
 end

data/test/integration/yaml_test_runner.rb

@@ -80,6 +80,7 @@ tracer.formatter = proc { |severity, datetime, progname, msg| "#{msg}\n" }
 #
 url = ENV.fetch('TEST_CLUSTER_URL', "http://localhost:#{ENV['TEST_CLUSTER_PORT'] || 9250}")
 $client ||= Elasticsearch::Client.new url: url
+$helper_client ||= Elasticsearch::Client.new url: url
 
 $client.transport.logger = logger unless ENV['QUIET'] || ENV['CI']
 # $client.transport.tracer = tracer if ENV['CI']
@@ -294,20 +295,20 @@ suites.each do |suite|
     # --- Register context setup -------------------------------------------
     #
     setup do
-      $client.indices.delete index: '_all', ignore: 404
-      $client.indices.delete_template name: '*', ignore: 404
-      $client.snapshot.delete repository: 'test_repo_create_1',  snapshot: 'test_snapshot', ignore: 404
-      $client.snapshot.delete repository: 'test_repo_restore_1', snapshot: 'test_snapshot', ignore: 404
-      $client.snapshot.delete repository: 'test_cat_snapshots_1', snapshot: 'snap1', ignore: 404
-      $client.snapshot.delete repository: 'test_cat_snapshots_1', snapshot: 'snap2', ignore: 404
-      $client.snapshot.delete_repository repository: 'test_repo_create_1', ignore: 404
-      $client.snapshot.delete_repository repository: 'test_repo_restore_1', ignore: 404
-      $client.snapshot.delete_repository repository: 'test_repo_get_1', ignore: 404
-      $client.snapshot.delete_repository repository: 'test_repo_get_2', ignore: 404
-      $client.snapshot.delete_repository repository: 'test_repo_status_1', ignore: 404
-      $client.snapshot.delete_repository repository: 'test_cat_repo_1', ignore: 404
-      $client.snapshot.delete_repository repository: 'test_cat_repo_2', ignore: 404
-      $client.snapshot.delete_repository repository: 'test_cat_snapshots_1', ignore: 404
+      $helper_client.indices.delete index: '_all', 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
+      $helper_client.snapshot.delete repository: 'test_cat_snapshots_1', snapshot: 'snap2', ignore: 404
+      $helper_client.snapshot.delete_repository repository: 'test_repo_create_1', ignore: 404
+      $helper_client.snapshot.delete_repository repository: 'test_repo_restore_1', ignore: 404
+      $helper_client.snapshot.delete_repository repository: 'test_repo_get_1', ignore: 404
+      $helper_client.snapshot.delete_repository repository: 'test_repo_get_2', ignore: 404
+      $helper_client.snapshot.delete_repository repository: 'test_repo_status_1', ignore: 404
+      $helper_client.snapshot.delete_repository repository: 'test_cat_repo_1', ignore: 404
+      $helper_client.snapshot.delete_repository repository: 'test_cat_repo_2', ignore: 404
+      $helper_client.snapshot.delete_repository repository: 'test_cat_snapshots_1', ignore: 404
       # FIXME: This shouldn't be needed -------------
       %w[
         test_cat_repo_1_loc
@@ -326,7 +327,7 @@ suites.each do |suite|
     # --- Register context teardown ----------------------------------------
     #
     teardown do
-      $client.indices.delete index: '_all', ignore: 404
+      $helper_client.indices.delete index: '_all', ignore: 404
     end
 
     files = Dir[suite.join('*.{yml,yaml}')]
@@ -401,7 +402,7 @@ suites.each do |suite|
               ref = ENV['TEST_BUILD_REF'].to_s.gsub(/origin\//, '') || 'master'
               $stderr.puts "https://github.com/elasticsearch/elasticsearch/blob/#{ref}/rest-api-spec/test/" \
                           + file.gsub(PATH.to_s, ''), ""
-              $stderr.puts YAML.dump(test)
+              $stderr.puts YAML.dump(test) if ENV['DEBUG']
             end
             actions.each do |action|
               $stderr.puts "ACTION: #{action.inspect}" if ENV['DEBUG']

data/test/unit/clear_scroll_test.rb

@@ -10,9 +10,9 @@ module Elasticsearch
         should "perform correct request" do
           subject.expects(:perform_request).with do |method, url, params, body|
             assert_equal 'DELETE', method
-            assert_equal '_search/scroll', url
-            assert_equal Hash.new, params
-            assert_equal 'abc123', body
+            assert_equal '_search/scroll/abc123', url
+            assert_equal nil, params[:scroll_id]
+            assert_equal nil, body
             true
           end.returns(FakeResponse.new)
 
@@ -22,9 +22,9 @@ module Elasticsearch
         should "listify scroll IDs" do
           subject.expects(:perform_request).with do |method, url, params, body|
             assert_equal 'DELETE', method
-            assert_equal '_search/scroll', url
-            assert_equal Hash.new, params
-            assert_equal 'abc123,def456', body
+            assert_equal '_search/scroll/abc123,def456', url
+            assert_equal nil, params[:scroll_id]
+            assert_equal nil, body
             true
           end.returns(FakeResponse.new)
 

data/test/unit/field_caps_test.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+
+module Elasticsearch
+  module Test
+    class FieldCapsTest < ::Test::Unit::TestCase
+
+      context "Field caps" do
+        subject { FakeClient.new }
+
+        should "perform correct request" do
+          subject.expects(:perform_request).with do |method, url, params, body|
+            assert_equal 'GET', method
+            assert_equal 'foo/_field_caps', url
+            assert_equal 'bar', params[:fields]
+            assert_equal nil, body
+            true
+          end.returns(FakeResponse.new)
+
+          subject.field_caps index: 'foo', fields: 'bar'
+        end
+
+      end
+
+    end
+  end
+end

data/test/unit/scroll_test.rb

@@ -11,7 +11,8 @@ module Elasticsearch
           subject.expects(:perform_request).with do |method, url, params, body|
             assert_equal 'GET', method
             assert_equal '_search/scroll', url
-            assert_equal 'cXVlcn...', body
+            assert_equal 'cXVlcn...', params[:scroll_id]
+            assert_equal nil, body
             true
           end.returns(FakeResponse.new)
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-api
 version: !ruby/object:Gem::Version
-  version: 5.0.3
+  version: 5.0.4
 platform: ruby
 authors:
 - Karel Minarik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-07 00:00:00.000000000 Z
+date: 2017-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -332,8 +332,23 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: |
-  Ruby API for Elasticsearch. See the `elasticsearch` gem for full integration.
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: 'Ruby API for Elasticsearch. See the `elasticsearch` gem for full integration.
+
+'
 email:
 - karel.minarik@elasticsearch.org
 executables: []
@@ -391,6 +406,7 @@ files:
 - lib/elasticsearch/api/actions/delete_template.rb
 - lib/elasticsearch/api/actions/exists.rb
 - lib/elasticsearch/api/actions/explain.rb
+- lib/elasticsearch/api/actions/field_caps.rb
 - lib/elasticsearch/api/actions/field_stats.rb
 - lib/elasticsearch/api/actions/get.rb
 - lib/elasticsearch/api/actions/get_script.rb
@@ -537,6 +553,7 @@ files:
 - test/unit/delete_template_test.rb
 - test/unit/exists_document_test.rb
 - test/unit/explain_document_test.rb
+- test/unit/field_caps_test.rb
 - test/unit/field_stats_test.rb
 - test/unit/get_document_source_test.rb
 - test/unit/get_document_test.rb
@@ -660,7 +677,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: Ruby API for Elasticsearch.
@@ -710,6 +727,7 @@ test_files:
 - test/unit/delete_template_test.rb
 - test/unit/exists_document_test.rb
 - test/unit/explain_document_test.rb
+- test/unit/field_caps_test.rb
 - test/unit/field_stats_test.rb
 - test/unit/get_document_source_test.rb
 - test/unit/get_document_test.rb