opensearch-api 1.0.0

data/spec/opensearch/api/actions/indices/disk_usage_spec.rb

@@ -0,0 +1,57 @@
+# 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'
+
+describe 'client.indices#disk_usage' do
+  let(:expected_args) do
+    [
+      'POST',
+      "#{index}/_disk_usage",
+      {},
+      nil,
+      {}
+    ]
+  end
+
+  let(:index) { 'foo' }
+
+  it 'performs the request' do
+    expect(client_double.indices.disk_usage(index: index)).to eq({})
+  end
+
+  context 'when there is no index specified' do
+    let(:client) do
+      Class.new { include OpenSearch::API }.new
+    end
+
+    it 'raises an exception' do
+      expect do
+        client.indices.disk_usage
+      end.to raise_exception(ArgumentError)
+    end
+  end
+end

data/spec/opensearch/api/actions/indices/exists_alias_spec.rb

@@ -0,0 +1,117 @@
+# 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'
+
+describe 'client.indices#exists_alias' do
+
+  let(:expected_args) do
+    [
+        'HEAD',
+        url,
+        params,
+        nil,
+        {}
+    ]
+  end
+
+  let(:params) do
+    {}
+  end
+
+  let(:url) do
+    '_alias/foo'
+  end
+
+  it 'performs the request' do
+    expect(client_double.indices.exists_alias(name: 'foo')).to eq(true)
+  end
+
+  it 'aliased to a predicate method' do
+    expect(client_double.indices.exists_alias?(name: 'foo')).to eq(true)
+  end
+
+  context 'when multiple indices are specified' do
+
+    let(:url) do
+      'foo,bar/_alias/bam'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.exists_alias(index: ['foo','bar'], name: 'bam')).to eq(true)
+    end
+  end
+
+  context 'when the path needs to be URL-escaped' do
+
+    let(:url) do
+      'foo%5Ebar/_alias/bar%2Fbam'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.exists_alias(index: 'foo^bar', name: 'bar/bam')).to eq(true)
+    end
+  end
+
+  context 'when 404 response is received' do
+
+    let(:response_double) do
+      double('response', status: 404, body: {}, headers: {})
+    end
+
+    it 'returns false' do
+      expect(client_double.indices.exists_alias(name: 'foo')).to eq(false)
+    end
+  end
+
+  context 'when a \'not found\' exception is raised' do
+
+    let(:client) do
+      Class.new { include OpenSearch::API }.new.tap do |_client|
+        expect(_client).to receive(:perform_request).with(*expected_args).and_raise(StandardError.new('404 Not Found'))
+      end
+    end
+
+    it 'returns false' do
+      expect(client.indices.exists_alias(name: 'foo')).to eq(false)
+    end
+  end
+
+  context 'when a generic exception is raised' do
+
+    let(:client) do
+      Class.new { include OpenSearch::API }.new.tap do |_client|
+        expect(_client).to receive(:perform_request).with(*expected_args).and_raise(StandardError.new)
+      end
+    end
+
+    it 'raises the exception' do
+      expect {
+        client.indices.exists_alias(name: 'foo')
+      }.to raise_exception(StandardError)
+    end
+  end
+end

data/spec/opensearch/api/actions/indices/exists_spec.rb

@@ -0,0 +1,117 @@
+# 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'
+
+describe 'client.indices#exists' do
+
+  let(:expected_args) do
+    [
+        'HEAD',
+        url,
+        params,
+        nil,
+        {}
+    ]
+  end
+
+  let(:params) do
+    {}
+  end
+
+  let(:url) do
+    'foo'
+  end
+
+  it 'performs the request' do
+    expect(client_double.indices.exists(index: 'foo')).to eq(true)
+  end
+
+  it 'aliased to a predicate method' do
+    expect(client_double.indices.exists?(index: 'foo')).to eq(true)
+  end
+
+  context 'when multiple indices are specified' do
+
+    let(:url) do
+      'foo,bar'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.exists(index: ['foo','bar'])).to eq(true)
+    end
+  end
+
+  context 'when the path needs to be URL-escaped' do
+
+    let(:url) do
+      'foo%5Ebar'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.exists(index: 'foo^bar')).to eq(true)
+    end
+  end
+
+  context 'when 404 response is received' do
+
+    let(:response_double) do
+      double('response', status: 404, body: {}, headers: {})
+    end
+
+    it 'returns false' do
+      expect(client_double.indices.exists(index: 'foo')).to eq(false)
+    end
+  end
+
+  context 'when a \'not found\' exception is raised' do
+
+    let(:client) do
+      Class.new { include OpenSearch::API }.new.tap do |_client|
+        expect(_client).to receive(:perform_request).with(*expected_args).and_raise(StandardError.new('404 Not Found'))
+      end
+    end
+
+    it 'returns false' do
+      expect(client.indices.exists(index: 'foo')).to eq(false)
+    end
+  end
+
+  context 'when a generic exception is raised' do
+
+    let(:client) do
+      Class.new { include OpenSearch::API }.new.tap do |_client|
+        expect(_client).to receive(:perform_request).with(*expected_args).and_raise(StandardError.new)
+      end
+    end
+
+    it 'raises the exception' do
+      expect {
+        client.indices.exists(index: 'foo')
+      }.to raise_exception(StandardError)
+    end
+  end
+end

data/spec/opensearch/api/actions/indices/exists_template_spec.rb

@@ -0,0 +1,102 @@
+# 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'
+
+describe 'client.indices#exists_template' do
+
+  let(:expected_args) do
+    [
+        'HEAD',
+        url,
+        params,
+        nil,
+        {}
+    ]
+  end
+
+  let(:params) do
+    {}
+  end
+
+  let(:url) do
+    '_template/foo'
+  end
+
+  it 'performs the request' do
+    expect(client_double.indices.exists_template(name: 'foo')).to eq(true)
+  end
+
+  context 'when the path needs to be URL-escaped' do
+
+    let(:url) do
+      '_template/bar%2Fbam'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.exists_template(name: 'bar/bam')).to eq(true)
+    end
+  end
+
+  context 'when 404 response is received' do
+
+    let(:response_double) do
+      double('response', status: 404, body: {}, headers: {})
+    end
+
+    it 'returns false' do
+      expect(client_double.indices.exists_template(name: 'foo')).to eq(false)
+    end
+  end
+
+  context 'when a \'not found\' exception is raised' do
+
+    let(:client) do
+      Class.new { include OpenSearch::API }.new.tap do |_client|
+        expect(_client).to receive(:perform_request).with(*expected_args).and_raise(StandardError.new('404 Not Found'))
+      end
+    end
+
+    it 'returns false' do
+      expect(client.indices.exists_template(name: 'foo')).to eq(false)
+    end
+  end
+
+  context 'when a generic exception is raised' do
+
+    let(:client) do
+      Class.new { include OpenSearch::API }.new.tap do |_client|
+        expect(_client).to receive(:perform_request).with(*expected_args).and_raise(StandardError.new)
+      end
+    end
+
+    it 'raises the exception' do
+      expect {
+        client.indices.exists_template(name: 'foo')
+      }.to raise_exception(StandardError)
+    end
+  end
+end

data/spec/opensearch/api/actions/indices/exists_type_spec.rb

@@ -0,0 +1,117 @@
+# 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'
+
+describe 'client.indices#exists_type' do
+
+  let(:expected_args) do
+    [
+        'HEAD',
+        url,
+        params,
+        nil,
+        {}
+    ]
+  end
+
+  let(:params) do
+    {}
+  end
+
+  let(:url) do
+    'foo/_mapping/bar'
+  end
+
+  it 'performs the request' do
+    expect(client_double.indices.exists_type(index: 'foo', type: 'bar')).to eq(true)
+  end
+
+  it 'aliased to a predicate method' do
+    expect(client_double.indices.exists_type?(index: 'foo', type: 'bar')).to eq(true)
+  end
+
+  context 'when multiple indices are specified' do
+
+    let(:url) do
+      'foo,bar/_mapping/bam'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.exists_type(index: ['foo','bar'], type: 'bam')).to eq(true)
+    end
+  end
+
+  context 'when the path needs to be URL-escaped' do
+
+    let(:url) do
+      'foo%5Ebar/_mapping/bar%2Fbam'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.exists_type(index: 'foo^bar', type: 'bar/bam')).to eq(true)
+    end
+  end
+
+  context 'when 404 response is received' do
+
+    let(:response_double) do
+      double('response', status: 404, body: {}, headers: {})
+    end
+
+    it 'returns false' do
+      expect(client_double.indices.exists_type(index: 'foo', type: 'bar')).to eq(false)
+    end
+  end
+
+  context 'when a \'not found\' exception is raised' do
+
+    let(:client) do
+      Class.new { include OpenSearch::API }.new.tap do |_client|
+        expect(_client).to receive(:perform_request).with(*expected_args).and_raise(StandardError.new('404 Not Found'))
+      end
+    end
+
+    it 'returns false' do
+      expect(client.indices.exists_type(index: 'foo', type: 'bar')).to eq(false)
+    end
+  end
+
+  context 'when a generic exception is raised' do
+
+    let(:client) do
+      Class.new { include OpenSearch::API }.new.tap do |_client|
+        expect(_client).to receive(:perform_request).with(*expected_args).and_raise(StandardError.new)
+      end
+    end
+
+    it 'raises the exception' do
+      expect {
+        client.indices.exists_type(index: 'foo', type: 'bar')
+      }.to raise_exception(StandardError)
+    end
+  end
+end

data/spec/opensearch/api/actions/indices/field_usage_stats_spec.rb

@@ -0,0 +1,55 @@
+# 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'
+
+describe 'client.indices#field_usage_stats' do
+  let(:expected_args) do
+    [
+      'GET',
+      'foo/_field_usage_stats',
+      {},
+      nil,
+      {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.indices.field_usage_stats(index: 'foo')).to eq({})
+  end
+
+  context 'when there is no index specified' do
+    let(:client) do
+      Class.new { include OpenSearch::API }.new
+    end
+
+    it 'raises an exception' do
+      expect {
+        client.indices.field_usage_stats
+      }.to raise_exception(ArgumentError)
+    end
+  end
+end

data/spec/opensearch/api/actions/indices/flush_spec.rb

@@ -0,0 +1,100 @@
+# 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'
+
+describe 'client.indices#flush' do
+
+  let(:expected_args) do
+    [
+        'POST',
+        url,
+        params,
+        nil,
+        {}
+    ]
+  end
+
+  let(:params) do
+    {}
+  end
+
+  let(:url) do
+    '_flush'
+  end
+
+  it 'performs the request' do
+    expect(client_double.indices.flush).to eq({})
+  end
+
+  context 'when an index is specified' do
+
+    let(:url) do
+      'foo/_flush'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.flush(index: 'foo')).to eq({})
+    end
+  end
+
+  context 'when multiple indices are specified' do
+
+    let(:url) do
+      'foo,bar/_flush'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.flush(index: ['foo','bar'])).to eq({})
+    end
+  end
+
+  context 'when the path needs to be URL-escaped' do
+
+    let(:url) do
+      'foo%5Ebar/_flush'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.flush(index: 'foo^bar')).to eq({})
+    end
+  end
+
+  context 'when URL parameters are specified' do
+
+    let(:url) do
+      'foo/_flush'
+    end
+
+    let(:params) do
+      { ignore_unavailable: true }
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.flush(index: 'foo', ignore_unavailable: true)).to eq({})
+    end
+  end
+end