opensearch-api 1.0.0

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

@@ -0,0 +1,89 @@
+# 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#clear_cache' do
+
+  let(:expected_args) do
+    [
+        'POST',
+        url,
+        params,
+        nil,
+        {}
+    ]
+  end
+
+  let(:url) do
+    '_cache/clear'
+  end
+
+  let(:params) do
+    {}
+  end
+
+  it 'performs the request' do
+    expect(client_double.indices.clear_cache).to eq({})
+  end
+
+  context 'when an index is specified' do
+
+    let(:url) do
+      'foo/_cache/clear'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.clear_cache(index: 'foo')).to eq({})
+    end
+  end
+
+  context 'when params are specified' do
+
+    let(:params) do
+      { fielddata: true }
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.clear_cache(fielddata: true)).to eq({})
+    end
+  end
+
+  context 'when the path must be URL-escaped' do
+
+    let(:url) do
+      'foo%5Ebar/_cache/clear'
+    end
+
+    let(:params) do
+      { }
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.clear_cache(index: 'foo^bar')).to eq({})
+    end
+  end
+end

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

@@ -0,0 +1,131 @@
+# 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#clone' do
+
+  let(:expected_args) do
+    [
+        'PUT',
+        url,
+        params,
+        body,
+        {}
+    ]
+  end
+
+  let(:params) do
+    {}
+  end
+
+  let(:body) do
+    nil
+  end
+
+  let(:url) do
+    'my_source_index/_clone/my_target_index'
+  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.clone(target: 'my_target_index')
+      }.to raise_exception(ArgumentError)
+    end
+  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.clone(index: 'my_source_index')
+      }.to raise_exception(ArgumentError)
+    end
+  end
+
+  context 'when an index and target are specified' do
+
+    it 'performs the request' do
+      expect(client_double.indices.clone(index: 'my_source_index', target: 'my_target_index')).to eq({})
+    end
+  end
+
+  context 'when params are provided' do
+
+    let(:params) do
+      {
+          timeout: '1s',
+          master_timeout: '10s',
+          wait_for_active_shards: 1
+      }
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.clone(index: 'my_source_index',
+                                         target: 'my_target_index',
+                                         timeout: '1s',
+                                         master_timeout: '10s',
+                                         wait_for_active_shards: 1)).to eq({})
+    end
+  end
+
+  context 'when a body is specified' do
+
+    let(:body) do
+      {
+          settings: {
+              'index.number_of_shards' => 5
+          },
+          aliases: {
+              my_search_indices: {}
+          }
+      }
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.clone(index: 'my_source_index',
+                                         target: 'my_target_index',
+                                         body: {
+                                             settings: {
+                                                 'index.number_of_shards' => 5
+                                             },
+                                             aliases: {
+                                                 my_search_indices: {}
+                                             }
+                                         })).to eq({})
+    end
+  end
+end

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

@@ -0,0 +1,94 @@
+# 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#close' do
+
+  let(:expected_args) do
+    [
+        'POST',
+        url,
+        params,
+        nil,
+        {}
+    ]
+  end
+
+  let(:params) do
+    {}
+  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.close
+      }.to raise_exception(ArgumentError)
+    end
+  end
+
+  context 'when an index is specified' do
+
+    let(:url) do
+      'foo/_close'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.close(index: 'foo')).to eq({})
+    end
+  end
+
+  context 'when params are specified' do
+
+    let(:params) do
+      { timeout: '1s' }
+    end
+
+    let(:url) do
+      'foo/_close'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.close(index: 'foo', timeout: '1s')).to eq({})
+    end
+  end
+
+  context 'when the path must be URL-escaped' do
+
+    let(:url) do
+      'foo%5Ebar/_close'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.close(index: 'foo^bar')).to eq({})
+    end
+  end
+end

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

@@ -0,0 +1,94 @@
+# 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#create' do
+
+  let(:expected_args) do
+    [
+        'PUT',
+        url,
+        params,
+        nil,
+        {}
+    ]
+  end
+
+  let(:params) do
+    {}
+  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.create
+      }.to raise_exception(ArgumentError)
+    end
+  end
+
+  context 'when an index is specified' do
+
+    let(:url) do
+      'foo'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.create(index: 'foo')).to eq({})
+    end
+  end
+
+  context 'when params are specified' do
+
+    let(:params) do
+      { timeout: '1s' }
+    end
+
+    let(:url) do
+      'foo'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.create(index: 'foo', timeout: '1s')).to eq({})
+    end
+  end
+
+  context 'when the path must be URL-escaped' do
+
+    let(:url) do
+      'foo%5Ebar'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.create(index: 'foo^bar')).to eq({})
+    end
+  end
+end

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

@@ -0,0 +1,92 @@
+# 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#delete_alias' do
+
+  let(:expected_args) do
+    [
+        'DELETE',
+        url,
+        params,
+        nil,
+        {}
+    ]
+  end
+
+  let(:params) do
+    {}
+  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.delete_alias(name: 'foo')
+      }.to raise_exception(ArgumentError)
+    end
+  end
+
+  context 'when there is no name specified' do
+
+    let(:client) do
+      Class.new { include OpenSearch::API }.new
+    end
+
+    it 'raises an exception' do
+      expect {
+        client.indices.delete_alias(index: 'foo')
+      }.to raise_exception(ArgumentError)
+    end
+  end
+
+  context 'when an index and name are specified' do
+
+    let(:url) do
+      'foo/_aliases/bar'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.delete_alias(index: 'foo', name: 'bar')).to eq({})
+    end
+  end
+
+  context 'when the path must be URL-escaped' do
+
+    let(:url) do
+      'foo%5Ebar/_aliases/bar%2Fbam'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.delete_alias(index: 'foo^bar', name: 'bar/bam')).to eq({})
+    end
+  end
+end

data/spec/opensearch/api/actions/indices/delete_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#delete' do
+
+  let(:expected_args) do
+    [
+        'DELETE',
+        url,
+        params,
+        nil,
+        {}
+    ]
+  end
+
+  let(:params) do
+    {}
+  end
+
+  let(:url) do
+    'foo'
+  end
+
+  it 'performs the request' do
+    expect(client_double.indices.delete(index: 'foo')).to eq({})
+  end
+
+  context 'when more than one index is specified' do
+
+    let(:url) do
+      'foo,bar'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.delete(index: ['foo', 'bar'])).to eq({})
+    end
+  end
+
+  context 'when params are specified' do
+
+    let(:params) do
+      { timeout: '1s' }
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.delete(index: 'foo', timeout: '1s')).to eq({})
+    end
+  end
+
+  context 'when the path must be URL-escaped' do
+
+    let(:url) do
+      'foo%5Ebar'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.delete(index: 'foo^bar')).to eq({})
+    end
+  end
+
+  context 'when a NotFound exception is raised by the request' do
+
+    let(:client) do
+      Class.new { include OpenSearch::API }.new
+    end
+
+    before do
+      expect(client).to receive(:perform_request).and_raise(NotFound)
+    end
+
+    it 'raises the exception' do
+      expect {
+        client.indices.delete(index: 'foo')
+      }.to raise_exception(NotFound)
+    end
+  end
+
+  context 'when the ignore parameter is specified' do
+
+    let(:client) do
+      Class.new { include OpenSearch::API }.new
+    end
+
+    before do
+      expect(client).to receive(:perform_request).and_raise(NotFound)
+    end
+
+    it 'ignores the code' do
+      expect(client.indices.delete(index: 'foo', ignore: 404)).to eq(false)
+    end
+  end
+end

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

@@ -0,0 +1,95 @@
+# 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#delete_template' do
+
+  let(:expected_args) do
+    [
+        'DELETE',
+        url,
+        params,
+        nil,
+        {}
+    ]
+  end
+
+  let(:params) do
+    {}
+  end
+
+  let(:url) do
+    '_template/foo'
+  end
+
+  it 'performs the request' do
+    expect(client_double.indices.delete_template(name: 'foo')).to eq({})
+  end
+
+  context 'when the path needs to be URL-escaped' do
+
+    let(:url) do
+      '_template/foo%5Ebar'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.delete_template(name: 'foo^bar')).to eq({})
+    end
+  end
+
+  context 'when a NotFound exception is raised by the request' do
+
+    let(:client) do
+      Class.new { include OpenSearch::API }.new
+    end
+
+    before do
+      expect(client).to receive(:perform_request).and_raise(NotFound)
+    end
+
+    it 'raises the exception' do
+      expect {
+        client.indices.delete_template(name: 'foo')
+      }.to raise_exception(NotFound)
+    end
+  end
+
+  context 'when the ignore parameter is specified' do
+
+    let(:client) do
+      Class.new { include OpenSearch::API }.new
+    end
+
+    before do
+      expect(client).to receive(:perform_request).and_raise(NotFound)
+    end
+
+    it 'ignores the code' do
+      expect(client.indices.delete_template(name: 'foo', ignore: 404)).to eq(false)
+    end
+  end
+end