elasticsearch 5.0.3 → 7.17.1

data/lib/elasticsearch.rb

@@ -1,12 +1,116 @@
-require "elasticsearch/version"
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
 
+require 'elasticsearch/version'
 require 'elasticsearch/transport'
 require 'elasticsearch/api'
 
 module Elasticsearch
-  module Transport
-    class Client
-      include Elasticsearch::API
+  SECURITY_PRIVILEGES_VALIDATION_WARNING = 'The client is unable to verify that the server is Elasticsearch due to security privileges on the server side. Some functionality may not be compatible if the server is running an unsupported product.'.freeze
+  NOT_ELASTICSEARCH_WARNING = 'The client noticed that the server is not Elasticsearch and we do not support this unknown product.'.freeze
+  NOT_SUPPORTED_ELASTICSEARCH_WARNING = 'The client noticed that the server is not a supported distribution of Elasticsearch.'.freeze
+  YOU_KNOW_FOR_SEARCH = 'You Know, for Search'.freeze
+
+  class Client
+    include Elasticsearch::API
+    attr_accessor :transport
+
+    # See Elasticsearch::Transport::Client for initializer parameters
+    def initialize(arguments = {}, &block)
+      @verified = false
+      @transport = Elasticsearch::Transport::Client.new(arguments, &block)
+    end
+
+    def method_missing(name, *args, &block)
+      if name == :perform_request
+        verify_elasticsearch unless @verified
+        @transport.perform_request(*args, &block)
+      else
+        super
+      end
+    end
+
+    private
+
+    def verify_elasticsearch
+      begin
+        response = elasticsearch_validation_request
+      rescue Elasticsearch::Transport::Transport::Errors::Unauthorized,
+             Elasticsearch::Transport::Transport::Errors::Forbidden,
+             Elasticsearch::Transport::Transport::Errors::RequestEntityTooLarge
+        @verified = true
+        warn(SECURITY_PRIVILEGES_VALIDATION_WARNING)
+        return
+      end
+
+      body = if response.headers['content-type'] == 'application/yaml'
+               require 'yaml'
+               YAML.safe_load(response.body)
+             else
+               response.body
+             end
+      version = body.dig('version', 'number')
+      verify_with_version_or_header(body, version, response.headers)
+    end
+
+    def verify_with_version_or_header(body, version, headers)
+      raise Elasticsearch::UnsupportedProductError if version.nil? || version < '6.0.0'
+
+      if version == '7.x-SNAPSHOT' || Gem::Version.new(version) >= Gem::Version.new('7.14-SNAPSHOT')
+        raise Elasticsearch::UnsupportedProductError unless headers['x-elastic-product'] == 'Elasticsearch'
+
+        @verified = true
+      elsif Gem::Version.new(version) > Gem::Version.new('6.0.0') &&
+            Gem::Version.new(version) < Gem::Version.new('7.0.0')
+        raise Elasticsearch::UnsupportedProductError unless
+          body['tagline'] == YOU_KNOW_FOR_SEARCH
+
+        @verified = true
+      elsif Gem::Version.new(version) >= Gem::Version.new('7.0.0') &&
+            Gem::Version.new(version) < Gem::Version.new('7.14-SNAPSHOT')
+        raise Elasticsearch::UnsupportedProductError unless body['tagline'] == YOU_KNOW_FOR_SEARCH
+        raise Elasticsearch::UnsupportedProductError.new(NOT_SUPPORTED_ELASTICSEARCH_WARNING) unless body.dig('version', 'build_flavor') == 'default'
+
+        @verified = true
+      end
+    end
+
+    def elasticsearch_validation_request
+      @transport.perform_request('GET', '/')
+    end
+  end
+
+  class UnsupportedProductError < StandardError
+    def initialize(message = NOT_ELASTICSEARCH_WARNING)
+      super(message)
     end
   end
 end
+
+module Elastic
+  # If the version is X.X.X.pre/alpha/beta, use X.X.Xp for the meta-header:
+  def self.client_meta_version
+    regexp = /^([0-9]+\.[0-9]+\.[0-9]+)\.?([a-z0-9.-]+)?$/
+    match = Elasticsearch::VERSION.match(regexp)
+    return "#{match[1]}p" if match[2]
+
+    Elasticsearch::VERSION
+  end
+
+  # Constant for elasticsearch-transport meta-header
+  ELASTICSEARCH_SERVICE_VERSION = [:es, client_meta_version].freeze
+end

data/spec/integration/characters_escaping_spec.rb

@@ -0,0 +1,94 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+ELASTICSEARCH_URL = ENV['TEST_ES_SERVER'] || "http://localhost:#{(ENV['PORT'] || 9200)}"
+raise URI::InvalidURIError unless ELASTICSEARCH_URL =~ /\A#{URI::DEFAULT_PARSER.make_regexp}\z/
+
+require 'spec_helper'
+
+context 'Elasticsearch client' do
+  let(:client) do
+    Elasticsearch::Client.new(host: ELASTICSEARCH_URL, user: 'elastic', password: 'changeme')
+  end
+  let(:index) { 'tvs' }
+
+  after do
+    client.indices.delete(index: index)
+  end
+
+  context 'escaping spaces in ids' do
+    it 'escapes spaces for id when using index' do
+      response = client.index(index: index, id: 'a test 1', body: { name: 'A test 1' }, refresh: true)
+      expect(response['_id']).to eq 'a test 1'
+
+      response = client.search(index: index)
+      expect(response['hits']['hits'].first['_id']).to eq 'a test 1'
+
+      # Raises exception, _id is unrecognized
+      expect do
+        client.index(index: index, _id: 'a test 2', body: { name: 'A test 2' })
+      end.to raise_exception ArgumentError
+
+      # Raises exception, id is a query parameter
+      expect do
+        client.index(index: index, body: { name: 'A test 3', _id: 'a test 3' })
+      end.to raise_exception Elasticsearch::Transport::Transport::Errors::BadRequest
+    end
+
+    it 'escapes spaces for id when using create' do
+      # Works with create
+      response = client.create(index: index, id: 'a test 4', body: { name: 'A test 4' })
+      expect(response['_id']).to eq 'a test 4'
+    end
+
+    it 'escapes spaces for id when using bulk' do
+      body = [
+        { create: { _index: index, _id: 'a test 5', data: { name: 'A test 5' } } }
+      ]
+      expect(client.bulk(body: body, refresh: true))
+
+      response = client.search(index: index)
+      expect(
+        response['hits']['hits'].select { |a| a['_id'] == 'a test 5' }.size
+      ).to eq 1
+    end
+  end
+
+  context 'it doesnae escape plus signs in id' do
+    it 'escapes spaces for id when using index' do
+      response = client.index(index: index, id: 'a+test+1', body: { name: 'A test 1' })
+      expect(response['_id']).to eq 'a+test+1'
+    end
+
+    it 'escapes spaces for id when using create' do
+      # Works with create
+      response = client.create(index: index, id: 'a+test+2', body: { name: 'A test 2' })
+      expect(response['_id']).to eq 'a+test+2'
+    end
+
+    it 'escapes spaces for id when using bulk' do
+      body = [
+        { create: { _index: index, _id: 'a+test+3', data: { name: 'A test 3' } } }
+      ]
+      expect(client.bulk(body: body, refresh: true))
+
+      response = client.search(index: index)
+      expect(
+        response['hits']['hits'].select { |a| a['_id'] == 'a+test+3' }.size
+      ).to eq 1
+    end
+  end
+end

data/spec/integration/client_integration_spec.rb

@@ -0,0 +1,57 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+require 'spec_helper'
+require 'logger'
+
+context 'Elasticsearch client' do
+  let(:logger) { Logger.new($stderr) }
+
+  let(:client) do
+    Elasticsearch::Client.new(
+      host: ELASTICSEARCH_URL,
+      logger: logger
+    )
+  end
+
+  context 'Integrates with elasticsearch API' do
+    it 'should perform the API methods' do
+      expect do
+        # Index a document
+        client.index(index: 'test-index', id: '1', body: { title: 'Test' })
+
+        # Refresh the index
+        client.indices.refresh(index: 'test-index')
+
+        # Search
+        response = client.search(index: 'test-index', body: { query: { match: { title: 'test' } } })
+
+        expect(response['hits']['total']['value']).to eq 1
+        expect(response['hits']['hits'][0]['_source']['title']).to eq 'Test'
+
+        # Delete the index
+        client.indices.delete(index: 'test-index')
+      end.not_to raise_error
+    end
+  end
+
+  context 'Reports the right meta header' do
+    it 'Reports es service name and gem version' do
+      headers = client.transport.transport.connections.first.connection.headers
+      expect(headers['x-elastic-client-meta']).to match Elastic.client_meta_version
+    end
+  end
+end

data/spec/integration/validation_integration_spec.rb

@@ -0,0 +1,30 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+require 'spec_helper'
+require 'logger'
+
+describe 'Elasticsearch validation integration' do
+  it 'Validates for Elasticsearch > 7.14' do
+    client = Elasticsearch::Client.new(
+      host: ELASTICSEARCH_URL,
+      logger: Logger.new($stderr)
+    )
+    expect(client.instance_variable_get('@verified')).to be false
+    client.count
+    expect(client.instance_variable_get('@verified')).to be true
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+require 'elasticsearch'
+require 'rspec'
+
+ELASTICSEARCH_URL = ENV['TEST_ES_SERVER'] || "http://localhost:#{(ENV['PORT'] || 9200)}"
+raise URI::InvalidURIError unless ELASTICSEARCH_URL =~ /\A#{URI::DEFAULT_PARSER.make_regexp}\z/
+
+RSpec.configure do |config|
+  config.formatter = :documentation
+end