elasticsearch-api 6.0.0 → 6.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 63bde47c1cc7d46fc4c79164a9a42e04e400b335
-  data.tar.gz: 6c4edd90ed5a8ab829f86e29118cf886d188a0ca
+  metadata.gz: ba7cd7dc9a07db583b12281c41cf5d612ed43f02
+  data.tar.gz: 2fedb5c237669e77184ab1e7bff1df3cb324614e
 SHA512:
-  metadata.gz: a77fa034cc384ac7ed0b930584f6e7f744fe5e67a8a762a3a0984f7ee5229afad99f108815527ffa5d933e9031903382086bfe9d7abb59fd50e100c5295705c5
-  data.tar.gz: 35a7de732e056b4be4517785557d9ed527c57987dc46ff3e765891d36d9eedcb949a38107d17acc735e89565cfb58db59f98975468317b6f2e55f2d6c05c9632
+  metadata.gz: e963573fb73b41056f6fe8af032d5fa2b0f6818a5ea1f0f7ebb80a03e78745d946897b0cb3ca103763f2fcb53817d92e55f30b5abef01899f87a1bbd8392447f
+  data.tar.gz: 5dde0d7b48b370a27d7c25aa418d1d00ac982fb6242c594aa7fad6665f7b020539cb0cfcd5dfb0970f39b7638ac9cc404ac2c69da634da144b78a1365bd988bd

data/README.md

@@ -11,7 +11,7 @@ the [Elasticsearch](http://elasticsearch.org) REST API.
 It does not provide an Elasticsearch client; see the
 [`elasticsearch-transport`](https://github.com/elasticsearch/elasticsearch-ruby/tree/master/elasticsearch-transport) library.
 
-The library is compatible with Ruby 1.8.7 and higher.
+The library is compatible with Ruby 1.9 and higher.
 
 It is compatible with Elasticsearch's API versions from 0.90 till current,
 just use a release matching major version of Elasticsearch.
@@ -22,6 +22,7 @@ just use a release matching major version of Elasticsearch.
 | 1.x           | → | 1.x           |
 | 2.x           | → | 2.x           |
 | 5.x           | → | 5.x           |
+| 6.x           | → | 6.x           |
 | master        | → | master        |
 
 ## Installation

data/elasticsearch-api.gemspec

@@ -20,6 +20,8 @@ Gem::Specification.new do |s|
   s.extra_rdoc_files  = [ "README.md", "LICENSE.txt" ]
   s.rdoc_options      = [ "--charset=UTF-8" ]
 
+  s.required_ruby_version = '>= 1.9'
+
   s.add_dependency "multi_json"
 
   s.add_development_dependency "bundler", "> 1"

data/lib/elasticsearch/api/actions/cluster/remote_info.rb

@@ -0,0 +1,22 @@
+module Elasticsearch
+  module API
+    module Cluster
+      module Actions
+
+        # Returns the configured remote cluster information
+        #
+        #
+        # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-remote-info.html
+        #
+        def remote_info(arguments={})
+          method = Elasticsearch::API::HTTP_GET
+          path   = "_remote/info"
+          params = {}
+          body   = nil
+
+          perform_request(method, path, params, body).body
+        end
+      end
+    end
+  end
+end

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

@@ -2,33 +2,40 @@ module Elasticsearch
   module API
     module Actions
 
-      # Create a document.
+      # Create a new document.
       #
-      # Enforce the _create_ operation when indexing a document --
-      # the operation will return an error when the document already exists.
+      # The API will create new document, if it doesn't exist yet -- in that case, it will return
+      # a `409` error (`version_conflict_engine_exception`).
       #
-      # @example Create a document
+      # You can leave out the `:id` parameter for the ID to be generated automatically
+      #
+      # @example Create a document with an ID
       #
       #     client.create index: 'myindex',
-      #                   type: 'mytype',
-      #                   id: '1',
-      #                   body: {
-      #                    title: 'Test 1',
-      #                    tags: ['y', 'z'],
-      #                    published: true,
-      #                    published_at: Time.now.utc.iso8601,
-      #                    counter: 1
-      #                   }
+      #                  type: 'doc',
+      #                  id: '1',
+      #                  body: {
+      #                   title: 'Test 1'
+      #                 }
       #
-      # @option (see Actions#index)
+      # @example Create a document with an auto-generated ID
       #
-      # (The `:op_type` argument is ignored.)
+      #     client.create index: 'myindex',
+      #                  type: 'doc',
+      #                  body: {
+      #                   title: 'Test 1'
+      #                 }
+      #
+      # @option (see Actions#index)
       #
-      # @see http://elasticsearch.org/guide/reference/api/index_/
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html#_automatic_id_generation
       #
       def create(arguments={})
-        raise ArgumentError, "Required argument 'id' missing"  unless arguments[:id]
-        index arguments.update :op_type => 'create'
+        if arguments[:id]
+          index arguments.update :op_type => 'create'
+        else
+          index arguments
+        end
       end
     end
   end

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

@@ -68,7 +68,7 @@ module Elasticsearch
       # @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/index_/
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html
       #
       def index(arguments={})
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]

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

@@ -7,48 +7,11 @@ module Elasticsearch
       # 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 Elasticsearch
       # @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]
 

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

@@ -16,13 +16,13 @@ module Elasticsearch
       #                            scroll: '5m',
       #                            body: { query: { match: { title: 'test' } }, sort: '_id' }
       #
-      #     result = client.scroll scroll: '5m', scroll_id: result['_scroll_id']
+      #     result = client.scroll scroll: '5m', body: { scroll_id: result['_scroll_id'] }
       #
       # @example Call the `scroll` API until all the documents are returned
       #
       #     # Index 1,000 documents
       #     client.indices.delete index: 'test'
-      #     1_000.times do |i| client.index index: 'test', type: 'test', id: i+1, body: {title: "Test #{i}"} end
+      #     1_000.times do |i| client.index index: 'test', type: 'test', id: i+1, body: {title: "Test #{i+1}"} end
       #     client.indices.refresh index: 'test'
       #
       #     # Open the "view" of the index by passing the `scroll` parameter
@@ -34,7 +34,7 @@ module Elasticsearch
       #     puts r['hits']['hits'].map { |d| d['_source']['title'] }.inspect
       #
       #     # Call the `scroll` API until empty results are returned
-      #     while r = client.scroll(scroll_id: r['_scroll_id'], scroll: '5m') and not r['hits']['hits'].empty? do
+      #     while r = client.scroll(body: { scroll_id: r['_scroll_id'] }, scroll: '5m') and not r['hits']['hits'].empty? do
       #       puts "--- BATCH #{defined?($i) ? $i += 1 : $i = 1} -------------------------------------------------"
       #       puts r['hits']['hits'].map { |d| d['_source']['title'] }.inspect
       #       puts

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

@@ -20,7 +20,7 @@ module Elasticsearch
       # @example Add a tag to document `tags` property using a `script`
       #
       #     client.update index: 'myindex', type: 'mytype', id: '1',
-      #                   body: { script: 'ctx._source.tags += tag', params: { tag: 'x' } }
+      #                    body: { script: { source: 'ctx._source.tags.add(params.tag)', params: { tag: 'x' } } }
       #
       # @example Increment a document counter by 1 _or_ initialize it, when the document does not exist
       #
@@ -30,7 +30,7 @@ module Elasticsearch
       # @example Delete a document if it's tagged "to-delete"
       #
       #     client.update index: 'myindex', type: 'mytype', id: '1',
-      #                   body: { script: 'ctx._source.tags.contains(tag) ? ctx.op = "delete" : ctx.op = "none"',
+      #                   body: { script: 'ctx._source.tags.contains(params.tag) ? ctx.op = "delete" : ctx.op = "none"',
       #                           params: { tag: 'to-delete' } }
       #
       # @option arguments [String] :id Document ID (*Required*)

data/lib/elasticsearch/api/utils.rb

@@ -35,11 +35,12 @@ module Elasticsearch
       def __listify(*list)
         options = list.last.is_a?(Hash) ? list.pop : {}
 
-        Array(list).flatten.
-          map { |e| e.respond_to?(:split) ? e.split(',') : e }.
+        escape = options[:escape]
+        Array(list).
+          flat_map { |e| e.respond_to?(:split) ? e.split(',') : e }.
           flatten.
           compact.
-          map { |e| options[:escape] == false ? e : __escape(e) }.
+          map { |e| escape == false ? e : __escape(e) }.
           join(',')
       end
 
@@ -58,7 +59,7 @@ module Elasticsearch
       def __pathify(*segments)
         Array(segments).flatten.
           compact.
-          reject { |s| s.to_s =~ /^\s*$/ }.
+          reject { |s| s.to_s.strip.empty? }.
           join('/').
           squeeze('/')
       end
@@ -186,8 +187,12 @@ module Elasticsearch
         return parts
       end
 
-      # Calls given block, rescuing from any exceptions. Returns `false`
-      # if exception contains NotFound/404 in its class name or message, else re-raises exception.
+      # Calls the given block, rescuing from `StandardError`.
+      #
+      # Primary use case is the `:ignore` parameter for API calls.
+      #
+      # Returns `false` if exception contains NotFound in its class name or message,
+      # else re-raises the exception.
       #
       # @yield [block] A block of code to be executed with exception handling.
       #
@@ -195,8 +200,8 @@ module Elasticsearch
       #
       def __rescue_from_not_found(&block)
         yield
-      rescue Exception => e
-        if e.class.to_s =~ /NotFound/ || e.message =~ /Not\s*Found|404/i
+      rescue StandardError => e
+        if e.class.to_s =~ /NotFound/ || e.message =~ /Not\s*Found/i
           false
         else
           raise e
@@ -235,10 +240,12 @@ module Elasticsearch
         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 +256,12 @@ module Elasticsearch
           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
 

data/lib/elasticsearch/api/version.rb

@@ -1,5 +1,5 @@
 module Elasticsearch
   module API
-    VERSION = "6.0.0"
+    VERSION = "6.0.1"
   end
 end

data/test/unit/cluster/remote_info_test.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+
+module Elasticsearch
+  module Test
+    class ClusterRemoteInfoTest < ::Test::Unit::TestCase
+
+      context "Cluster: Remote info" 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 '_remote/info', url
+            assert_equal Hash.new, params
+            assert_nil   body
+            true
+          end.returns(FakeResponse.new)
+
+          subject.cluster.remote_info
+        end
+
+      end
+
+    end
+  end
+end

data/test/unit/create_document_test.rb

@@ -7,12 +7,6 @@ module Elasticsearch
       context "Creating a document with the #create method" do
         subject { FakeClient.new }
 
-        should "require the ID" do
-          assert_raise ArgumentError do
-            subject.create :index => 'foo', :type => 'bar', :id => nil, :body => {:foo => 'bar'}
-          end
-        end
-
         should "perform the create request with a specific ID" do
           subject.expects(:perform_request).with do |method, url, params, body|
             assert_equal 'PUT', method
@@ -34,6 +28,27 @@ module Elasticsearch
 
           subject.create :index => 'foo', :type => 'bar/bam', :id => '123', :body => {}
         end
+
+        should "update the arguments with `op_type` when the `:id` argument is present" do
+          subject.expects(:perform_request).with do |method, url, params, body|
+            assert_equal 'foo/bar/1', url
+            assert_not_nil params[:op_type]
+            true
+          end.returns(FakeResponse.new)
+
+          subject.create :index => 'foo', :type => 'bar', :id => 1, :body => { :foo => 'bar' }
+        end
+
+        should "pass the arguments when the `:id` argument is missing" do
+          subject.expects(:perform_request).with do |method, url, params, body|
+            assert_equal 'foo/bar', url
+            assert_nil params[:op_type]
+            assert_nil params[:id]
+            true
+          end.returns(FakeResponse.new)
+
+          subject.create :index => 'foo', :type => 'bar', :body => { :foo => 'bar' }
+        end
       end
 
     end

data/test/unit/utils_test.rb

@@ -233,16 +233,13 @@ module Elasticsearch
           end
 
           should "return false if exception message contains 'Not Found'" do
-            assert_equal( false, __rescue_from_not_found { raise Exception.new "Not Found" })
-          end
-
-          should "return false if exception message contains '404'" do
-            assert_equal( false, __rescue_from_not_found { raise Exception.new "404" })
+            assert_equal( false, __rescue_from_not_found { raise StandardError.new "Not Found" })
+            assert_equal( false, __rescue_from_not_found { raise StandardError.new "NotFound" })
           end
 
           should "raise exception if exception class name and message do not contain NotFound/404" do
-            assert_raise Exception do
-              __rescue_from_not_found { raise Exception.new "Any other exception" }
+            assert_raise StandardError do
+              __rescue_from_not_found { raise StandardError.new "Any other exception" }
             end
           end
 
@@ -253,8 +250,8 @@ module Elasticsearch
             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 +262,9 @@ module Elasticsearch
             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 +275,9 @@ module Elasticsearch
             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,7 +288,7 @@ module Elasticsearch
             arguments = { :moo => 'bam', :baz => 'qux' }
             unsupported_params = [:foo]
 
-            STDERR.expects(:puts).never
+            Kernel.expects(:warn).never
 
             __report_unsupported_parameters(arguments, unsupported_params)
           end
@@ -299,7 +296,7 @@ module Elasticsearch
 
         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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-api
 version: !ruby/object:Gem::Version
-  version: 6.0.0
+  version: 6.0.1
 platform: ruby
 authors:
 - Karel Minarik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-14 00:00:00.000000000 Z
+date: 2018-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -380,6 +380,7 @@ files:
 - lib/elasticsearch/api/actions/cluster/health.rb
 - lib/elasticsearch/api/actions/cluster/pending_tasks.rb
 - lib/elasticsearch/api/actions/cluster/put_settings.rb
+- lib/elasticsearch/api/actions/cluster/remote_info.rb
 - lib/elasticsearch/api/actions/cluster/reroute.rb
 - lib/elasticsearch/api/actions/cluster/state.rb
 - lib/elasticsearch/api/actions/cluster/stats.rb
@@ -531,6 +532,7 @@ files:
 - test/unit/cluster/health_test.rb
 - test/unit/cluster/pending_tasks_test.rb
 - test/unit/cluster/put_settings_test.rb
+- test/unit/cluster/remote_info_test.rb
 - test/unit/cluster/reroute_test.rb
 - test/unit/cluster/state_test.rb
 - test/unit/cluster/stats_test.rb
@@ -662,7 +664,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -670,7 +672,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Ruby API for Elasticsearch.
@@ -708,6 +710,7 @@ test_files:
 - test/unit/cluster/health_test.rb
 - test/unit/cluster/pending_tasks_test.rb
 - test/unit/cluster/put_settings_test.rb
+- test/unit/cluster/remote_info_test.rb
 - test/unit/cluster/reroute_test.rb
 - test/unit/cluster/state_test.rb
 - test/unit/cluster/stats_test.rb