elasticsearch 7.1.0 → 8.10.0

data/spec/unit/opaque_id_spec.rb

@@ -0,0 +1,48 @@
+# 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 'ostruct'
+
+describe Elasticsearch::Client do
+  let(:transport) { client.instance_variable_get('@transport') }
+  let(:client) { described_class.new.tap { |cl| cl.instance_variable_set('@verified', true) } }
+
+  before do
+    allow(transport).to receive(:perform_request) { OpenStruct.new(body: '') }
+  end
+
+  context 'when x-opaque-id is set' do
+    it 'uses x-opaque-id on a request' do
+      client.search(opaque_id: '12345')
+      expect(transport).to have_received(:perform_request)
+        .with('GET', '_search', {}, nil, { 'X-Opaque-Id' => '12345' })
+    end
+  end
+
+  context 'when an x-opaque-id prefix is set on initialization' do
+    let(:prefix) { 'elastic_cloud' }
+    let(:client) do
+      described_class.new(opaque_id_prefix: prefix).tap { |cl| cl.instance_variable_set('@verified', true) }
+    end
+
+    it 'uses x-opaque-id on a request' do
+      expect { client.search(opaque_id: '12345') }.not_to raise_error
+      expect(transport).to have_received(:perform_request)
+        .with('GET', '_search', {}, nil, { 'X-Opaque-Id' => 'elastic_cloud12345' })
+    end
+  end
+end

data/spec/unit/user_agent_spec.rb

@@ -0,0 +1,69 @@
+# 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'
+
+describe Elasticsearch::Client do
+  let(:user_agent) {
+    "elasticsearch-ruby/#{Elasticsearch::VERSION}; elastic-transport-ruby/#{Elastic::Transport::VERSION}; RUBY_VERSION: #{RUBY_VERSION}; #{RbConfig::CONFIG['host_os'].split('_').first[/[a-z]+/i].downcase} #{RbConfig::CONFIG['target_cpu']}"
+  }
+
+  context 'when no user-agent is set on initialization' do
+    let(:client) { described_class.new }
+
+    it 'has the expected header' do
+      expect(client.transport.options[:transport_options][:headers][:user_agent]).to eq user_agent
+    end
+  end
+
+  context 'when a header is specified on initialization' do
+    let(:client) do
+      described_class.new(
+        transport_options: { headers: { 'X-Test-Header' => 'Test' } }
+      )
+    end
+
+    it 'has the expected header' do
+      expect(client.transport.options[:transport_options][:headers][:user_agent]).to eq user_agent
+      expect(client.transport.options[:transport_options][:headers]['X-Test-Header']).to eq 'Test'
+    end
+  end
+
+  context 'when other transport_options are specified on initialization' do
+    let(:client) do
+      described_class.new(
+        transport_options: { params:  { format: 'yaml' } }
+      )
+    end
+
+    it 'has the expected header' do
+      expect(client.transport.options[:transport_options][:headers][:user_agent]).to eq user_agent
+      expect(client.transport.options[:transport_options][:params][:format]).to eq 'yaml'
+    end
+  end
+
+  context 'when :user_agent is specified on initialization' do
+    let(:client) do
+      described_class.new(
+        transport_options: { headers: { user_agent: 'TestApp' } }
+      )
+    end
+
+    it 'has the expected header' do
+      expect(client.transport.options[:transport_options][:headers][:user_agent]).to eq 'TestApp'
+    end
+  end
+end

data/{test/unit/wrapper_gem_test.rb → spec/unit/wrapper_gem_spec.rb}

@@ -6,7 +6,7 @@
 # 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
+#   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
@@ -15,29 +15,19 @@
 # specific language governing permissions and limitations
 # under the License.
 
-require 'test_helper'
+require 'spec_helper'
 
-module Elasticsearch
-  module Test
-    class WrapperGemTest < Minitest::Test
-
-      context "Wrapper gem" do
-
-        should "require all neccessary subgems" do
-          assert defined? Elasticsearch::Client
-          assert defined? Elasticsearch::API
-        end
-
-        should "mix the API into the client" do
-          client = Elasticsearch::Client.new
-
-          assert_respond_to client, :search
-          assert_respond_to client, :cluster
-          assert_respond_to client, :indices
-        end
+describe 'Elasticsearch: wrapper gem' do
+  it 'requires all neccessary subgems' do
+    expect(defined? Elasticsearch::Client)
+    expect(defined? Elasticsearch::API)
+  end
 
-      end
+  it 'mixes the API into the client' do
+    client = Elasticsearch::Client.new
 
-    end
+    expect(client).to respond_to(:search)
+    expect(client).to respond_to(:cluster)
+    expect(client).to respond_to(:indices)
   end
 end

metadata

@@ -1,43 +1,45 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch
 version: !ruby/object:Gem::Version
-  version: 7.1.0
+  version: 8.10.0
 platform: ruby
 authors:
 - Karel Minarik
+- Emily Stolfo
+- Fernando Briano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-22 00:00:00.000000000 Z
+date: 2023-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: elasticsearch-transport
+  name: elastic-transport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 7.1.0
+        version: '8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 7.1.0
+        version: '8'
 - !ruby/object:Gem::Dependency
   name: elasticsearch-api
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 7.1.0
+        version: 8.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 7.1.0
+        version: 8.10.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -53,77 +55,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '11.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '11.1'
-- !ruby/object:Gem::Dependency
-  name: elasticsearch-extensions
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: ansi
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: shoulda-context
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: mocha
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: yard
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -151,7 +83,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -165,7 +97,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest-reporters
+  name: require-prof
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -179,7 +111,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: ruby-prof
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -193,7 +125,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: require-prof
+  name: ruby-prof
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -221,7 +153,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov-rcov
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -235,7 +167,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: cane
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -248,25 +180,11 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !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 integrations for Elasticsearch (client, API, etc.)
 
   '
 email:
-- karel.minarik@elasticsearch.org
+- clients-team@elastic.co
 executables:
 - elastic_ruby_console
 extensions: []
@@ -283,14 +201,30 @@ files:
 - elasticsearch.gemspec
 - lib/elasticsearch-ruby.rb
 - lib/elasticsearch.rb
+- lib/elasticsearch/helpers/bulk_helper.rb
+- lib/elasticsearch/helpers/scroll_helper.rb
 - lib/elasticsearch/version.rb
-- test/integration/client_integration_test.rb
-- test/test_helper.rb
-- test/unit/wrapper_gem_test.rb
-homepage: http://github.com/elasticsearch/elasticsearch-ruby
+- spec/integration/characters_escaping_spec.rb
+- spec/integration/client_integration_spec.rb
+- spec/integration/helpers/bulk_helper_spec.rb
+- spec/integration/helpers/scroll_helper_spec.rb
+- spec/spec_helper.rb
+- spec/unit/api_key_spec.rb
+- spec/unit/cloud_credentials_spec.rb
+- spec/unit/custom_transport_implementation_spec.rb
+- spec/unit/elasticsearch_product_validation_spec.rb
+- spec/unit/headers_spec.rb
+- spec/unit/opaque_id_spec.rb
+- spec/unit/user_agent_spec.rb
+- spec/unit/wrapper_gem_spec.rb
+homepage: https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/index.html
 licenses:
 - Apache-2.0
-metadata: {}
+metadata:
+  homepage_uri: https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/index.html
+  changelog_uri: https://github.com/elastic/elasticsearch-ruby/blob/main/CHANGELOG.md
+  source_code_uri: https://github.com/elastic/elasticsearch-ruby/tree/main
+  bug_tracker_uri: https://github.com/elastic/elasticsearch-ruby/issues
 post_install_message: 
 rdoc_options:
 - "--charset=UTF-8"
@@ -300,18 +234,28 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '1.9'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: Ruby integrations for Elasticsearch
 test_files:
-- test/integration/client_integration_test.rb
-- test/test_helper.rb
-- test/unit/wrapper_gem_test.rb
+- spec/integration/characters_escaping_spec.rb
+- spec/integration/client_integration_spec.rb
+- spec/integration/helpers/bulk_helper_spec.rb
+- spec/integration/helpers/scroll_helper_spec.rb
+- spec/spec_helper.rb
+- spec/unit/api_key_spec.rb
+- spec/unit/cloud_credentials_spec.rb
+- spec/unit/custom_transport_implementation_spec.rb
+- spec/unit/elasticsearch_product_validation_spec.rb
+- spec/unit/headers_spec.rb
+- spec/unit/opaque_id_spec.rb
+- spec/unit/user_agent_spec.rb
+- spec/unit/wrapper_gem_spec.rb

data/test/integration/client_integration_test.rb

@@ -1,76 +0,0 @@
-# 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 'test_helper'
-require 'logger'
-
-module Elasticsearch
-  module Test
-    class ClientIntegrationTest < Elasticsearch::Test::IntegrationTestCase
-      startup do
-        Elasticsearch::Extensions::Test::Cluster.start(number_of_nodes: 2) if ENV['SERVER'] and not Elasticsearch::Extensions::Test::Cluster.running?(number_of_nodes: 2)
-      end
-
-      shutdown do
-        Elasticsearch::Extensions::Test::Cluster.stop(number_of_nodes: 2) if ENV['SERVER'] and Elasticsearch::Extensions::Test::Cluster.running?(number_of_nodes: 2)
-      end
-
-      context "Elasticsearch client" do
-        setup do
-          system "curl -X DELETE http://#{TEST_HOST}:#{TEST_PORT}/_all > /dev/null 2>&1"
-
-          @logger =  Logger.new(STDERR)
-          @logger.formatter = proc do |severity, datetime, progname, msg|
-            color = case severity
-              when /INFO/ then :green
-              when /ERROR|WARN|FATAL/ then :red
-              when /DEBUG/ then :cyan
-              else :white
-            end
-            ANSI.ansi(severity[0] + ' ', color, :faint) + ANSI.ansi(msg, :white, :faint) + "\n"
-          end
-
-          @client = Elasticsearch::Client.new host: "#{TEST_HOST}:#{TEST_PORT}", logger: (ENV['QUIET'] ? nil : @logger)
-        end
-
-        should "perform the API methods" do
-          assert_nothing_raised do
-            # Index a document
-            #
-            @client.index index: 'test-index', type: 'test-type', 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' } } }
-
-            assert_equal 1,      response['hits']['total']['value']
-            assert_equal 'Test', response['hits']['hits'][0]['_source']['title']
-
-            # Delete the index
-            #
-            @client.indices.delete index: 'test-index'
-          end
-        end
-
-      end
-    end
-  end
-end

data/test/test_helper.rb

@@ -1,115 +0,0 @@
-# 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_HOSTS = if hosts = ENV['TEST_ES_SERVER'] || ENV['ELASTICSEARCH_HOSTS']
-                        hosts.split(',').map do |host|
-                          /(http\:\/\/)?(\S+)/.match(host)[2]
-                        end
-                      end.freeze
-
-TEST_HOST, TEST_PORT = ELASTICSEARCH_HOSTS.first.split(':') if ELASTICSEARCH_HOSTS
-
-RUBY_1_8 = defined?(RUBY_VERSION) && RUBY_VERSION < '1.9'
-JRUBY    = defined?(JRUBY_VERSION)
-
-if RUBY_1_8 and not ENV['BUNDLE_GEMFILE']
-  require 'rubygems'
-  gem 'test-unit'
-end
-
-if ENV['COVERAGE'] && ENV['CI'].nil? && !RUBY_1_8
-  require 'simplecov'
-  SimpleCov.start { add_filter "/test|test_/" }
-end
-
-if ENV['CI'] && !RUBY_1_8
-  require 'simplecov'
-  require 'simplecov-rcov'
-  SimpleCov.formatter = SimpleCov::Formatter::RcovFormatter
-  SimpleCov.start { add_filter "/test|test_" }
-end
-
-# Register `at_exit` handler for integration tests shutdown.
-# MUST be called before requiring `test/unit`.
-if defined?(RUBY_VERSION) && RUBY_VERSION > '1.9'
-  at_exit { Elasticsearch::Test::IntegrationTestCase.__run_at_exit_hooks }
-end
-
-require 'test/unit' if RUBY_1_8
-
-require 'minitest/autorun'
-require 'minitest/reporters'
-require 'shoulda/context'
-require 'mocha/minitest'
-
-require 'require-prof' if ENV["REQUIRE_PROF"]
-require 'elasticsearch'
-RequireProf.print_timing_infos if ENV["REQUIRE_PROF"]
-
-if defined?(RUBY_VERSION) && RUBY_VERSION > '1.9'
-  require 'elasticsearch/extensions/test/cluster'
-  require 'elasticsearch/extensions/test/startup_shutdown'
-  require 'elasticsearch/extensions/test/profiling' unless JRUBY
-end
-
-Minitest::Reporters.use! Minitest::Reporters::SpecReporter.new
-
-module Minitest
-  module Assertions
-    def assert_nothing_raised(*args)
-      begin
-        line = __LINE__
-        yield
-      rescue RuntimeError => e
-        raise MiniTest::Assertion, "Exception raised:\n<#{e.class}>", e.backtrace
-      end
-      true
-    end
-
-    def assert_not_nil(object, msg=nil)
-      msg = message(msg) { "<#{object.inspect}> expected to not be nil" }
-      assert !object.nil?, msg
-    end
-
-    def assert_block(*msgs)
-      assert yield, *msgs
-    end
-
-    alias :assert_raise :assert_raises
-  end
-end
-
-module Elasticsearch
-  module Test
-    class IntegrationTestCase < ::Minitest::Test
-      extend Elasticsearch::Extensions::Test::StartupShutdown
-
-      shutdown { Elasticsearch::Extensions::Test::Cluster.stop if ENV['SERVER'] && started? && Elasticsearch::Extensions::Test::Cluster.running? }
-      context "IntegrationTest" do; should "noop on Ruby 1.8" do; end; end if RUBY_1_8
-    end if defined?(RUBY_VERSION) && RUBY_VERSION > '1.9'
-  end
-
-  module Test
-    class ProfilingTest < ::Minitest::Test
-      extend Elasticsearch::Extensions::Test::StartupShutdown
-      extend Elasticsearch::Extensions::Test::Profiling
-
-      shutdown { Elasticsearch::Extensions::Test::Cluster.stop if ENV['SERVER'] && started? && Elasticsearch::Extensions::Test::Cluster.running? }
-      context "IntegrationTest" do; should "noop on Ruby 1.8" do; end; end if RUBY_1_8
-    end unless RUBY_1_8 || JRUBY
-  end
-end