opensearch-ruby 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87b12f335bb618b7804ea4458f75b3a3486277d996dbb3bb51dbca8cc9dfe427
-  data.tar.gz: 969a386faae41efeddc3d7d667d8a1479ce49355b3fd56bb8bad1a43981045e8
+  metadata.gz: 0d4f98e77ae003dc420b5f08f9fd84c48686595334234292db7892190c53ef86
+  data.tar.gz: e5007d84daddd7a74e236e9c129bd2affbf69fa3865a0a474f0d762c474adff0
 SHA512:
-  metadata.gz: c984cce0c114bf7def5aac8a59c5c0f3f7f799011ce2e7c8b2d40ab9f090be182dd5b26948a47955a46d9c5052b21da4f338ca9871a3b1e62ebf3a70b298ec78
-  data.tar.gz: b415ab64f55bc9d722476a1fbc2e0687f4c188e45a658b124ccce049e3508247eb7b517977f42427834e966e4c89c86adf97d3863eb2d676230b19fbc624d037
+  metadata.gz: a20c390852f61417b2ae5c25e8e01445410ee43614848d409d40d6c85968d947500c313bd7c66fa19b0694dae475273a54e4d133ec5aea01a1068f22d70f0157
+  data.tar.gz: 5f983a021750df743ea48b178f39f1e55ebbe79f66f82f0d9f0ce24d743e32ecb69a3170c0ba8a4d34f7a9994eccdd2271f2c61944dc32961f9434af80a80d25

data/README.md

@@ -20,6 +20,8 @@ The OpenSearch client for Ruby is compatible with Ruby 1.9 and higher.
 
 The client's API is compatible with OpenSearch's API versions from 1.0.0 till current.
 
+See [COMPATIBILITY](../COMPATIBILITY.md) for more details.
+
 ## Installation
 
 Install the package from [Rubygems](https://rubygems.org):

data/Rakefile

@@ -35,13 +35,8 @@ task test: 'test:spec'
 require 'rspec/core/rake_task'
 
 namespace :test do
-  desc 'Wait for OpenSearch to be in a green state'
-  task :wait_for_green do
-    sh '../scripts/wait-cluster.sh'
-  end
-
   RSpec::Core::RakeTask.new(:integration) do |t|
-    t.pattern = 'spec/integration/**{,/*/**}/*_spec.rb'
+    t.pattern = 'spec/integration/security_disabled/**{,/*/**}/*_spec.rb'
   end
 
   RSpec::Core::RakeTask.new(:unit) do |t|
@@ -55,6 +50,17 @@ namespace :test do
   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'

data/lib/opensearch/version.rb

@@ -25,5 +25,5 @@
 # under the License.
 
 module OpenSearch
-  VERSION = '1.0.0'.freeze
+  VERSION = '2.0.0'.freeze
 end

data/opensearch.gemspec

@@ -61,8 +61,8 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '>= 2.4'
 
-  s.add_dependency 'opensearch-transport', '1.0.0'
-  s.add_dependency 'opensearch-api',       '1.0.0'
+  s.add_dependency 'opensearch-transport', '2.0.0'
+  s.add_dependency 'opensearch-api',       '2.0.0'
 
   s.add_development_dependency 'bundler'
   s.add_development_dependency 'byebug' unless defined?(JRUBY_VERSION) || defined?(Rubinius)

data/spec/integration/{client_integration_spec.rb → security_disabled/client_integration_spec.rb}

@@ -26,7 +26,7 @@
 require 'spec_helper'
 require 'logger'
 
-context 'OpenSearch client' do
+context 'OpenSearch client ' do
   let(:logger) { Logger.new($stderr) }
 
   let(:client) do

data/spec/integration/{validation_integration_spec.rb → security_disabled/validation_integration_spec.rb}

@@ -27,7 +27,7 @@ require 'spec_helper'
 require 'logger'
 
 describe 'OpenSearch validation integration' do
-  it 'Validates for OpenSearch 1.0.0-SNAPSHOT' do
+  it 'Validates for OpenSearch' do
     client = OpenSearch::Client.new(
       host: OPENSEARCH_URL,
       logger: Logger.new($stderr)

data/spec/integration/security_enabled/client_integration_spec.rb

@@ -0,0 +1,43 @@
+# 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/integration/security_enabled/validation_integration_spec.rb

@@ -0,0 +1,40 @@
+# 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 'logger'
+
+describe 'OpenSearch validation integration with security plugin enabled' do
+  it 'Validates for OpenSearch' do
+    client = OpenSearch::Client.new(
+      host: OPENSEARCH_URL,
+      logger: Logger.new($stderr),
+      transport_options: { ssl: { verify: false } }
+    )
+    expect(client.instance_variable_get('@verified')).to be false
+    client.count
+    expect(client.instance_variable_get('@verified')).to be true
+  end
+end

data/spec/unit/opensearch_product_validation_spec.rb

@@ -84,7 +84,7 @@ describe 'OpenSearch: Validation' do
     end
   end
 
-  context 'When Elasticsearch replies with status 403' do
+  context 'When OpenSearch replies with status 403' do
     let(:status) { 403 }
     let(:body) { {}.to_json }
 
@@ -105,9 +105,9 @@ describe 'OpenSearch: Validation' do
     end
   end
 
-  context 'When the OpenSearch version is 1.0.0-SNAPSHOT' do
+  context 'When the OpenSearch version is 2.0.0' do
     context 'With a valid OpenSearch response' do
-      let(:body) { { 'version' => { 'number' => '1.0.0-SNAPSHOT', 'distribution' => 'opensearch' } }.to_json }
+      let(:body) { { 'version' => { 'number' => '2.0.0', 'distribution' => 'opensearch' } }.to_json }
       let(:headers) do
         {
           'content-type' => 'json'
@@ -123,7 +123,7 @@ describe 'OpenSearch: Validation' do
     end
 
     context 'When the distribution is not present' do
-      let(:body) { { 'version' => { 'number' => '1.0.0-SNAPSHOT' } }.to_json }
+      let(:body) { { 'version' => { 'number' => '2.0.0' } }.to_json }
       it 'Fails validation' do
         verify_request_stub
 
@@ -187,7 +187,7 @@ describe 'OpenSearch: Validation' do
     end
 
     let(:headers) { { 'content-type' => 'application/yaml'} }
-    let(:body) { "---\nversion:\n  number: \"1.0.0-SNAPSHOT\"\n  distribution: \"opensearch\"\n" }
+    let(:body) { "---\nversion:\n  number: \"2.0.0\"\n  distribution: \"opensearch\"\n" }
 
     it 'validates' do
       verify_request_stub

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opensearch-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Jayesh Hathila
@@ -33,7 +33,7 @@ cert_chain:
   yXikuH6LEVykA8pgOcB9gKsB2/zMd2ZlSj2monM8Qw9EfB14ZSDTYS8VYuwWCeF0
   eFmXXk0ufQFKl1Yll7quHkmQ0PzKkvXTpONBT6qPkXE=
   -----END CERTIFICATE-----
-date: 2021-12-06 00:00:00.000000000 Z
+date: 2022-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opensearch-transport
@@ -41,28 +41,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: opensearch-api
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -228,8 +228,10 @@ files:
 - lib/opensearch.rb
 - lib/opensearch/version.rb
 - opensearch.gemspec
-- spec/integration/client_integration_spec.rb
-- spec/integration/validation_integration_spec.rb
+- spec/integration/security_disabled/client_integration_spec.rb
+- spec/integration/security_disabled/validation_integration_spec.rb
+- spec/integration/security_enabled/client_integration_spec.rb
+- spec/integration/security_enabled/validation_integration_spec.rb
 - spec/spec_helper.rb
 - spec/unit/opensearch_product_validation_spec.rb
 - spec/unit/wrapper_gem_spec.rb
@@ -261,8 +263,10 @@ signing_key:
 specification_version: 4
 summary: Ruby integrations for OpenSearch
 test_files:
-- spec/integration/client_integration_spec.rb
-- spec/integration/validation_integration_spec.rb
+- spec/integration/security_disabled/client_integration_spec.rb
+- spec/integration/security_disabled/validation_integration_spec.rb
+- spec/integration/security_enabled/client_integration_spec.rb
+- spec/integration/security_enabled/validation_integration_spec.rb
 - spec/spec_helper.rb
 - spec/unit/opensearch_product_validation_spec.rb
 - spec/unit/wrapper_gem_spec.rb