opensearch-ruby 2.0.3 → 3.4.0

data/.gitignore

@@ -1,21 +0,0 @@
-# Licensed to Elasticsearch B.V under one or more agreements.
-# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
-# See the LICENSE file in the project root for more information
-
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp

data/Rakefile

@@ -1,69 +0,0 @@
-# SPDX-License-Identifier: Apache-2.0
-#
-# The OpenSearch Contributors require contributions made to
-# this file be licensed under the Apache-2.0 license or a
-# compatible open source license.
-#
-# Modifications Copyright OpenSearch Contributors. See
-# GitHub history for details.
-#
-# 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 'bundler/gem_tasks'
-
-task(:default) { system 'rake --tasks' }
-
-desc 'Run unit tests'
-task test: 'test:spec'
-
-# ----- Test tasks ------------------------------------------------------------
-require 'rspec/core/rake_task'
-
-namespace :test do
-  RSpec::Core::RakeTask.new(:integration) do |t|
-    t.pattern = 'spec/integration/security_disabled/**{,/*/**}/*_spec.rb'
-  end
-
-  RSpec::Core::RakeTask.new(:unit) do |t|
-    t.pattern = 'spec/unit/**{,/*/**}/*_spec.rb'
-  end
-
-  desc 'Run unit and integration tests'
-  task :all do
-    Rake::Task['test:unit'].invoke
-    Rake::Task['test:integration'].invoke
-  end
-end
-
-namespace :test_security do
-  RSpec::Core::RakeTask.new(:integration) do |t|
-    t.pattern = 'spec/integration/security_enabled/**{,/*/**}/*_spec.rb'
-  end
-
-  desc 'Run security integration tests'
-  task :all do
-    Rake::Task['test_security:integration'].invoke
-  end
-end
-
-# ----- Documentation tasks ---------------------------------------------------
-
-require 'yard'
-YARD::Rake::YardocTask.new(:doc) do |t|
-  t.options = %w| --embed-mixins --markup=markdown |
-end

data/opensearch.gemspec

@@ -1,81 +0,0 @@
-# SPDX-License-Identifier: Apache-2.0
-#
-# The OpenSearch Contributors require contributions made to
-# this file be licensed under the Apache-2.0 license or a
-# compatible open source license.
-#
-# Modifications Copyright OpenSearch Contributors. See
-# GitHub history for details.
-#
-# 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.
-
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'opensearch/version'
-
-signing_key_path = File.expand_path("../gem-private_key.pem")
-
-Gem::Specification.new do |s|
-  s.name          = 'opensearch-ruby'
-  s.version       = OpenSearch::VERSION
-  s.authors       = ['Jayesh Hathila', 'Vamshi Vijay Nakkirtha', 'Vijayan Balasubramanian' , 'Yuvraj Jaiswal']
-  s.email         = ['jayehh@amazon.com', 'vamshin@amazon.com', 'balasvij@amazon.com', 'jaiyuvra@amazon.com']
-  s.summary       = 'Ruby integrations for OpenSearch'
-  s.homepage      = 'https://opensearch.org/docs/latest'
-  s.license       = 'Apache-2.0'
-  s.metadata = {
-    'homepage_uri' => 'https://opensearch.org/docs/latest/',
-    'source_code_uri' => 'https://github.com/opensearch-project/opensearch-ruby/tree/main',
-    'bug_tracker_uri' => 'https://github.com/opensearch-project/opensearch-ruby/issues'
-  }
-  s.files         = `git ls-files`.split($/)
-  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  s.executables   << 'opensearch_ruby_console'
-  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
-
-  if $PROGRAM_NAME.end_with?("gem") && ARGV == ["build", __FILE__] && File.exist?(signing_key_path)
-    s.signing_key = signing_key_path
-    s.cert_chain  = ['../certs/opensearch-rubygems.pem']
-  end
-
-  s.require_paths = ['lib']
-  s.bindir = 'bin'
-
-  s.extra_rdoc_files  = [ 'README.md', 'LICENSE' ]
-  s.rdoc_options      = [ '--charset=UTF-8' ]
-
-  s.required_ruby_version = '>= 2.4'
-
-  s.add_dependency 'opensearch-transport', '~> 2.0.0'
-  s.add_dependency 'opensearch-api',       '2.0.2'
-
-  s.add_development_dependency 'bundler'
-  s.add_development_dependency 'byebug' unless defined?(JRUBY_VERSION) || defined?(Rubinius)
-  s.add_development_dependency 'pry'
-  s.add_development_dependency 'rake', '~> 13'
-  s.add_development_dependency 'require-prof' unless defined?(JRUBY_VERSION) || defined?(Rubinius)
-  s.add_development_dependency 'rspec'
-  s.add_development_dependency 'ruby-prof' unless defined?(JRUBY_VERSION) || defined?(Rubinius)
-  s.add_development_dependency 'simplecov'
-  s.add_development_dependency 'webmock'
-  s.add_development_dependency 'yard'
-
-  s.description = <<-DESC.gsub(/^    /, '')
-    Ruby integrations for OpenSearch (client, API, etc.)
-  DESC
-end

data/spec/integration/security_enabled/client_integration_spec.rb

@@ -1,43 +0,0 @@
-# SPDX-License-Identifier: Apache-2.0
-#
-# The OpenSearch Contributors require contributions made to
-# this file be licensed under the Apache-2.0 license or a
-# compatible open source license.
-#
-# Modifications Copyright OpenSearch Contributors. See
-# GitHub history for details.
-require 'spec_helper'
-require 'logger'
-
-context 'OpenSearch client with security plugin enabled' do
-  let(:logger) { Logger.new($stderr) }
-
-  let(:client) do
-    OpenSearch::Client.new(
-      host: OPENSEARCH_URL,
-      logger: logger,
-      transport_options: { ssl: { verify: false } }
-    )
-  end
-
-  context 'Integrates with opensearch 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
-end

data/spec/unit/opensearch_product_validation_spec.rb

@@ -1,198 +0,0 @@
-# SPDX-License-Identifier: Apache-2.0
-#
-# The OpenSearch Contributors require contributions made to
-# this file be licensed under the Apache-2.0 license or a
-# compatible open source license.
-#
-# Modifications Copyright OpenSearch Contributors. See
-# GitHub history for details.
-#
-# 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 'webmock/rspec'
-
-describe 'OpenSearch: Validation' do
-  let(:host) { 'http://localhost:9200' }
-  let(:verify_request_stub) do
-    stub_request(:get, host)
-      .to_return(status: status, body: body, headers: headers)
-  end
-  let(:count_request_stub) do
-    stub_request(:post, "#{host}/_count")
-      .to_return(status: 200, body: nil, headers: {})
-  end
-  let(:status) { 200 }
-  let(:body) { {}.to_json }
-  let(:client) { OpenSearch::Client.new }
-  let(:headers) do
-    { 'content-type' => 'json' }
-  end
-
-  def error_requests_and_expectations(message = OpenSearch::NOT_SUPPORTED_WARNING)
-    expect { client.count }.to raise_error OpenSearch::UnsupportedProductError, message
-    assert_requested :get, host
-    assert_not_requested :post, "#{host}/_count"
-    expect { client.cluster.health }.to raise_error OpenSearch::UnsupportedProductError, message
-    expect(client.instance_variable_get('@verified')).to be false
-    expect { client.cluster.health }.to raise_error OpenSearch::UnsupportedProductError, message
-  end
-
-  def valid_requests_and_expectations
-    expect(client.instance_variable_get('@verified')).to be false
-    assert_not_requested :get, host
-
-    client.count
-    expect(client.instance_variable_get('@verified'))
-    assert_requested :get, host
-    assert_requested :post, "#{host}/_count"
-  end
-
-  context 'When OpenSearch replies with status 401' do
-    let(:status) { 401 }
-    let(:body) { {}.to_json }
-
-    it 'Verifies the request but shows a warning' do
-      stderr      = $stderr
-      fake_stderr = StringIO.new
-      $stderr     = fake_stderr
-
-      verify_request_stub
-      count_request_stub
-
-      valid_requests_and_expectations
-
-      fake_stderr.rewind
-      expect(fake_stderr.string).to eq("#{OpenSearch::SECURITY_PRIVILEGES_VALIDATION_WARNING}\n")
-    ensure
-      $stderr = stderr
-    end
-  end
-
-  context 'When OpenSearch replies with status 403' do
-    let(:status) { 403 }
-    let(:body) { {}.to_json }
-
-    it 'Verifies the request but shows a warning' do
-      stderr      = $stderr
-      fake_stderr = StringIO.new
-      $stderr     = fake_stderr
-
-      verify_request_stub
-      count_request_stub
-
-      valid_requests_and_expectations
-
-      fake_stderr.rewind
-      expect(fake_stderr.string).to eq("#{OpenSearch::SECURITY_PRIVILEGES_VALIDATION_WARNING}\n")
-    ensure
-      $stderr = stderr
-    end
-  end
-
-  context 'When the OpenSearch version is 2.0.0' do
-    context 'With a valid OpenSearch response' do
-      let(:body) { { 'version' => { 'number' => '2.0.0', 'distribution' => 'opensearch' } }.to_json }
-      let(:headers) do
-        {
-          'content-type' => 'json'
-        }
-      end
-
-      it 'Makes requests and passes validation' do
-        verify_request_stub
-        count_request_stub
-
-        valid_requests_and_expectations
-      end
-    end
-
-    context 'When the distribution is not present' do
-      let(:body) { { 'version' => { 'number' => '2.0.0' } }.to_json }
-      it 'Fails validation' do
-        verify_request_stub
-
-        expect(client.instance_variable_get('@verified')).to be false
-        assert_not_requested :get, host
-
-        error_requests_and_expectations
-      end
-    end
-  end
-
-
-  context 'When the Elasticsearch version is >= 6.0' do
-    context 'With a valid Elasticsearch response' do
-      let(:body) { { 'version' => { 'number' => '6.0.0' } }.to_json }
-      let(:headers) do
-        {
-          'content-type' => 'json'
-        }
-      end
-
-      it 'Makes requests and passes validation' do
-        verify_request_stub
-        count_request_stub
-
-        valid_requests_and_expectations
-      end
-    end
-
-  end
-
-  context 'When the Elasticsearch version is >= 8.0.0' do
-    context 'With a valid Elasticsearch response' do
-      let(:body) { { 'version' => { 'number' => '8.0.0' } }.to_json }
-      let(:headers) do
-        {
-          'content-type' => 'json'
-        }
-      end
-
-      it 'Fails validation' do
-        verify_request_stub
-        count_request_stub
-
-        error_requests_and_expectations
-      end
-    end
-  end
-
-  context 'When there is no version data' do
-    let(:body) { {}.to_json }
-    it 'Raises an exception and client doesnae work' do
-      verify_request_stub
-      error_requests_and_expectations
-    end
-  end
-
-  context 'When doing a yaml content-type request' do
-    let(:client) do
-      OpenSearch::Client.new(transport_options: {headers: { accept: 'application/yaml', content_type: 'application/yaml' }})
-    end
-
-    let(:headers) { { 'content-type' => 'application/yaml'} }
-    let(:body) { "---\nversion:\n  number: \"2.0.0\"\n  distribution: \"opensearch\"\n" }
-
-    it 'validates' do
-      verify_request_stub
-      count_request_stub
-      valid_requests_and_expectations
-    end
-  end
-end