5.x.new

.travis.yml

@@ -13,7 +13,6 @@ branches:
     - master
     - travis
     - 5.x
-    - 2.x
 
 matrix:
   include:
@@ -31,14 +30,14 @@ matrix:
 
     - rvm: 2.4.0
       jdk: oraclejdk8
-      env: TEST_SUITE=integration SERVER=start TEST_CLUSTER_LOGS=/tmp/log TEST_BUILD_REF=origin/master TEST_CLUSTER_COMMAND=/tmp/elasticsearch-6.0.0-beta1-SNAPSHOT/bin/elasticsearch
+      env: TEST_SUITE=integration SERVER=start TEST_CLUSTER_LOGS=/tmp/log TEST_BUILD_REF=origin/5.5 TEST_CLUSTER_COMMAND=/tmp/elasticsearch-5.5.3/bin/elasticsearch
 
 before_install:
   - gem update --system
   - gem --version
   - gem install bundler -v 1.14.3
   - bundle version
-  - curl -sS https://snapshots.elastic.co/downloads/elasticsearch/elasticsearch-6.0.0-beta1-SNAPSHOT.tar.gz | tar xz -C /tmp
+  - curl -sS https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-5.5.3.tar.gz | tar xz -C /tmp
   - rake setup
   - rake elasticsearch:update
 

CHANGELOG.md

@@ -1,22 +1,52 @@
-## DSL:0.1.5
-
-* Added support for the ["Exists" Query](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-exists-query.html)
-* Added missing `like` and `unlike` options to the ["More Like This" Query](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html)
-* Added missing `time_zone` option to the ["Query String" Query](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html)
-* Added missing `inner_hits` option to the [Nested Query](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-nested-query.html)
-* Allow calling the `filter` method for the [Bool Query](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-bool-query.html) multiple times
-* Added missing `minimum_should_match`, `prefix_length`, `max_expansions`, `fuzzy_rewrite`, `analyzer`, `lenient`, `zero_terms_query` and `cutoff_frequency` options to the [Match Query](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query.html)
-* Added missing `minimum_should_match` and `boost` options to the [Bool Query](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-bool-query.html)
-* Refactored the [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations.html) collection into its own `AggregationsCollection` class
-
-## EXT:0.0.23
-
-* Fixed removing the data directory for Elasticsearch 5 and 6 in the test cluster
-* Added, that Elasticsearch process is properly killed when determining version
-* Updated the test cluster class to be compatible Elasticsearch 6.x
-* Added `the max_local_storage_nodes` setting to the start command arguments for Elasticsearch 5.x
-* Improved the documentation and error messsages for the test cluster
-* Updated the "Reindex" extension for Elasticsearch 5.x
+## 5.0.4
+
+### Client
+
+* Fixed incorrect test behaviour when the `QUIET` environment variable is set
+* Fixed double logging of failed responses
+* Swallow logging of exceptions when the `ignore` is specified
+* Fixed the bug with `nil` value of `retry_on_status`
+
+### API
+
+* Added the "Field Capabilities" API
+* Changed, that the YAML test content is not printed unless `DEBUG` is set
+* Fixed the failing unit tests for "Scroll" APIs
+* Added missing parameters to the "Search" API
+* Added missing parameters to the "Multi Search" API
+* Added missing parameters to the "Indices Clear Cache" API
+* Added missing arguments to the "Exists" API
+* Fixes for the "Scroll" API
+* Improved the YAML test runner
+
+## 5.0.3
+
+### Client
+
+* Added proper handling of headers in client options to the Manticore adapter
+
+## 5.0.2
+
+### Client
+
+* Added default value 'application/json' for the 'Content-Type' header
+
+## 5.0.0
+
+### API
+
+* Updated the parameters for Elasticsearch 5.x APIs
+* Added Elasticsearch 5.x APIs
+
+## 2.0.0
+
+* Added deprecation notices to API methods and parameters not supported on Elasticsearch 2.x
+
+## 1.1.0
+
+### API
+
+* Added deprecation notices to API methods and arguments not supported on Elasticsearch 1.x
 
 ## DSL:0.1.4
 

Rakefile

@@ -172,6 +172,7 @@ namespace :test do
 
   desc "Run unit tests in all subprojects"
   task :unit do
+    Rake::Task['test:ci_reporter'].invoke if ENV['CI']
     puts "Ruby [#{RUBY_VERSION}]" if defined? RUBY_VERSION
     subprojects.each do |project|
       puts '-'*80

elasticsearch-api/lib/elasticsearch/api/actions/indices/flush.rb

@@ -12,14 +12,15 @@ module Actions
         #
         # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string for all indices
         # @option arguments [Boolean] :force Whether a flush should be forced even if it is not necessarily needed ie.
+        #                                    if no changes will be committed to the index. (Internal)
         # @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] :wait_if_ongoing If set to true the flush operation will block until the flush can be executed if another flush operation is already executing. The default is true. If set to false the flush will be skipped iff if another flush operation is already running.
         # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when
         #                                                 unavailable (missing, closed, etc)
-        # @option arguments [Boolean] :wait_if_ongoing If set to true the flush operation will block until the flush can be executed if another flush operation is already executing. If set to false the flush will be skipped if another flush operation is already running. (Default: true)
         #
         # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-flush/
         #
@@ -29,7 +30,8 @@ def flush(arguments={})
             :wait_if_ongoing,
             :ignore_unavailable,
             :allow_no_indices,
-            :expand_wildcards ]
+            :expand_wildcards
+          ]
 
           method = HTTP_POST
           path   = Utils.__pathify Utils.__listify(arguments[:index]), '_flush'

elasticsearch-api/lib/elasticsearch/api/actions/percolate.rb

@@ -7,48 +7,11 @@ module Actions
       # Percolator allows you to register queries and then evaluate a document against them:
       # the IDs of matching queries are returned in the response.
       #
-      # @example Register queries named "alert-1" and "alert-2" for the "my-index" index
+      # @deprecated The `_percolate` API has been deprecated in favour of a special field mapping and the
+      #             `percolate` query;
+      #             see https://www.elastic.co/guide/en/elasticsearch/reference/5.5/breaking_50_percolator.html
       #
-      #     client.index index: 'my-index',
-      #                  type: '.percolator',
-      #                  id: 'alert-1',
-      #                  body: { query: { query_string: { query: 'foo' } } }
-      #
-      #     client.index index: 'my-index',
-      #                  type: '.percolator',
-      #                  id: 'alert-2',
-      #                  body: { query: { query_string: { query: 'bar' } } }
-      #
-      # @example Evaluate a custom document (passed as `:doc`) against the queries
-      #
-      #     client.percolate index: 'my-index', type: 'my-type', body: { doc: { title: "Foo" } }
-      #     # => {..., matches: [ {_index: 'my-index', _id: 'alert-1'} ]}
-      #
-      #     client.percolate index: 'my-index', type: 'my-type', body: { doc: { title: "Foo Bar" } }
-      #     # => {..., matches: [ {_index: 'my-index', _id: 'alert-2'}, {_index: 'my-index', _id: 'alert-1'} ] }
-      #
-      # @example Evaluate an existing document against the queries
-      #
-      #     client.index index: 'my-index', type: 'my-type', id: 123, body: { title: "Foo Bar" }
-      #
-      #     client.percolate index: 'my-index', type: 'my-type', id: '123'
-      #     # => { ..., matches: [ {_index: 'my-index', _id: 'alert-2'}, { _index: 'my-index', _id: 'alert-1'} ] }
-      #
-      # @example Register a query with custom `priority` property
-      #
-      #     client.index index: 'my-index',
-      #                  type: '.percolator',
-      #                  id: 'alert-high-1',
-      #                  body: { query: { query_string: { query: 'foo' } },
-      #                          priority: 'high' }
-      #
-      # @example Evaluate a document against "high priority" percolator queries
-      #
-      #     client.percolate index: 'my-index', type: 'my-type', body: {
-      #         doc:    { title: "Foo" },
-      #         filter: { term: { priority: 'high' } }
-      #       }
-      #     # => {..., matches: [ {_index: 'my-index', _id: 'alert-high-1'} ]}
+      # See full example for Elasticsearch 5.x and higher in <https://github.com/elastic/elasticsearch-ruby/blob/master/examples/percolator/percolator_alerts.rb>
       #
       # @option arguments [String] :index The index of the document being percolated. (*Required*)
       # @option arguments [String] :type The type of the document being percolated. (*Required*)
@@ -75,6 +38,8 @@ module Actions
       # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-percolate.html
       #
       def percolate(arguments={})
+        Utils.__report_unsupported_method :percolate
+
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
         raise ArgumentError, "Required argument 'type' missing"  unless arguments[:type]
 

elasticsearch-api/lib/elasticsearch/api/actions/reindex.rb

@@ -43,9 +43,11 @@ module Actions
       # @option arguments [String] :consistency Explicit write consistency setting for the operation
       #                                        (Options: one, quorum, all)
       # @option arguments [Boolean] :wait_for_completion Whether the request should block and wait until
-        #                                                the operation has completed
+      #                                                  the operation has completed
       # @option arguments [Float] :requests_per_second The throttling for this request in sub-requests per second.
       #                                                0 means set no throttling (default)
+      # @option arguments [Integer] :slices The number of slices this request should be divided into.
+      #                                     Defaults to 1 meaning the request isn't sliced into sub-requests.
       #
       # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-reindex.html
       #
@@ -56,7 +58,8 @@ def reindex(arguments={})
           :timeout,
           :consistency,
           :wait_for_completion,
-          :requests_per_second ]
+          :requests_per_second,
+          :slices ]
         method = 'POST'
         path   = "_reindex"
         params = Utils.__validate_and_extract_params arguments, valid_params

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

@@ -116,8 +116,6 @@ module Actions
       # @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.
-      # @option arguments [Number] :max_concurrent_shard_requests The number of concurrent shard requests this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests. The default grows with the number of nodes in the cluster but is at most 256.
-      # @option arguments [Number] :pre_filter_shard_size A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on it's rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint. (Default: 128)
       #
       # @return [Hash]
       #
@@ -167,9 +165,7 @@ def search(arguments={})
           :timeout,
           :typed_keys,
           :version,
-          :batched_reduce_size,
-          :max_concurrent_shard_requests,
-          :pre_filter_shard_size ]
+          :batched_reduce_size ]
 
         method = HTTP_GET
         path   = Utils.__pathify( Utils.__listify(arguments[:index]), Utils.__listify(arguments[:type]), UNDERSCORE_SEARCH )

elasticsearch-api/lib/elasticsearch/api/utils.rb

@@ -235,10 +235,12 @@ def __report_unsupported_parameters(arguments, params=[])
         end
 
         unless messages.empty?
+          messages << "Suppress this warning by the `-WO` command line flag."
+
           if STDERR.tty?
-            STDERR.puts messages.map { |m| "\e[31;1m#{m}\e[0m" }.join("\n")
+            Kernel.warn messages.map { |m| "\e[31;1m#{m}\e[0m" }.join("\n")
           else
-            STDERR.puts messages.join("\n")
+            Kernel.warn messages.join("\n")
           end
         end
       end
@@ -249,12 +251,12 @@ def __report_unsupported_method(name)
           message += " in `#{source}`"
         end
 
-        message += ". This method is not supported in the version you're using: #{Elasticsearch::API::VERSION}, and will be removed in the next release."
+        message += ". This method is not supported in the version you're using: #{Elasticsearch::API::VERSION}, and will be removed in the next release. Suppress this warning by the `-WO` command line flag."
 
         if STDERR.tty?
-          STDERR.puts "\e[31;1m#{message}\e[0m"
+          Kernel.warn "\e[31;1m#{message}\e[0m"
         else
-          STDERR.puts message
+          Kernel.warn message
         end
       end
 

elasticsearch-api/lib/elasticsearch/api/version.rb

@@ -1,5 +1,5 @@
 module Elasticsearch
   module API
-    VERSION = "6.0.0.pre"
+    VERSION = "5.0.4"
   end
 end

elasticsearch-api/test/unit/utils_test.rb

@@ -253,8 +253,8 @@ class UtilsTest < ::Test::Unit::TestCase
             arguments = { :foo => 'bar', :moo => 'bam', :baz => 'qux' }
             unsupported_params = [:foo, :moo]
 
-            STDERR.expects(:puts).with do |message|
-              assert_equal 2, message.split("\n").size
+            Kernel.expects(:warn).with do |message|
+              assert_equal 2, message.split("\n").reject { |l| l.include? 'Suppress this warning' }.size
               true
             end
 
@@ -265,9 +265,9 @@ class UtilsTest < ::Test::Unit::TestCase
             arguments = { :foo => 'bar', :moo => 'bam', :baz => 'qux' }
             unsupported_params = [ { :foo => { :explanation => 'NOT_SUPPORTED' } } ]
 
-            STDERR.expects(:puts).with do |message|
+            Kernel.expects(:warn).with do |message|
               assert_match /NOT_SUPPORTED/, message
-              assert_equal 1, message.split("\n").size
+              assert_equal 1, message.split("\n").reject { |l| l.include? 'Suppress this warning' }.size
               true
             end
 
@@ -278,9 +278,9 @@ class UtilsTest < ::Test::Unit::TestCase
             arguments = { :foo => 'bar', :moo => 'bam', :baz => 'qux' }
             unsupported_params = [ { :foo => { :explanation => 'NOT_SUPPORTED'} }, :moo ]
 
-            STDERR.expects(:puts).with do |message|
+            Kernel.expects(:warn).with do |message|
               assert_match /NOT_SUPPORTED/, message
-              assert_equal 2, message.split("\n").size
+              assert_equal 2, message.split("\n").reject { |l| l.include? 'Suppress this warning' }.size
               true
             end
 
@@ -291,15 +291,15 @@ class UtilsTest < ::Test::Unit::TestCase
             arguments = { :moo => 'bam', :baz => 'qux' }
             unsupported_params = [:foo]
 
-            STDERR.expects(:puts).never
+            Kernel.expects(:warn).never
 
             __report_unsupported_parameters(arguments, unsupported_params)
           end
         end
 
         context "__report_unsupported_method" do
           should "print the warning" do
-            STDERR.expects(:puts).with do |message|
+            Kernel.expects(:warn).with do |message|
               assert_match /foo/, message
               true
             end

elasticsearch-dsl/lib/elasticsearch/dsl/search/aggregation.rb

@@ -37,14 +37,14 @@ def method_missing(name, *args, &block)
         # Defines an aggregation nested in another one
         #
         def aggregation(*args, &block)
-          # call
+          #call
           @value.__send__ :aggregation, *args, &block
         end
 
         # Returns the aggregations
         #
         def aggregations
-          # call
+          #call
           @value.__send__ :aggregations
         end
 

elasticsearch-dsl/lib/elasticsearch/dsl/search/queries/exists.rb

@@ -3,18 +3,35 @@ module DSL
     module Search
       module Queries
 
-        # A filter which returns documents which have at least one non-`null` value in the specified field
-        # (ie. the reverse of the `missing` filter)
+        # Returns documents that have at least one non-null value in the field.
         #
-        # @example
+        # @example Find documents with non-empty "name" property
         #
         #     search do
         #       query do
-        #         exists field: 'occupation'
+        #         exists do
+        #           field 'name'
+        #         end
         #       end
         #     end
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/5.0/query-dsl-exists-query.html
+        # @note The "Exists" query can be used as a "Missing" query in a "Bool" query "Must Not" context.
+        #
+        # @example Find documents with an empty "name" property
+        #
+        #     search do
+        #       query do
+        #         bool do
+        #           must_not do
+        #             exists do
+        #               field 'name'
+        #             end
+        #           end
+        #         end
+        #       end
+        #     end
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/5.1/query-dsl-exists-query.html
         #
         class Exists
           include BaseComponent