opensearch-api 1.0.0

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

@@ -0,0 +1,99 @@
+# 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_synced' do
+
+  let(:expected_args) do
+    [
+        'POST',
+        url,
+        params,
+        nil,
+        {}
+    ]
+  end
+
+  let(:params) do
+    {}
+  end
+
+  let(:url) do
+    'foo/_flush/synced'
+  end
+
+  it 'performs the request' do
+    expect(client_double.indices.flush_synced(index: 'foo')).to eq({})
+  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(NotFound)
+      end
+    end
+
+    it 'raises the exception' do
+      expect {
+        client.indices.flush_synced(index: 'foo')
+      }.to raise_exception(NotFound)
+    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(NotFound)
+      end
+    end
+
+    it 'raises the exception' do
+      expect {
+        client.indices.flush_synced(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.tap do |_client|
+        expect(_client).to receive(:perform_request).with(*expected_args).and_raise(StandardError.new('404 Not Found'))
+      end
+    end
+
+    let(:params) do
+      { ignore: 404 }
+    end
+
+    it 'does not raise the exception' do
+      expect(client.indices.flush_synced(index: 'foo', ignore: 404)).to eq(false)
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# 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.cluster#forcemerge' do
+
+  let(:expected_args) do
+    [
+        'POST',
+        '_forcemerge',
+        {},
+        nil,
+        {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.indices.forcemerge).to eq({})
+  end
+end

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

@@ -0,0 +1,70 @@
+# 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.cluster#get_alias' do
+
+  let(:expected_args) do
+    [
+        'GET',
+        url,
+        {},
+        nil,
+        {}
+    ]
+  end
+
+  let(:url) do
+    '_alias/foo'
+  end
+
+  it 'performs the request' do
+    expect(client_double.indices.get_alias(name: 'foo')).to eq({})
+  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.get_alias(index: ['foo','bar'], name: 'bam')).to eq({})
+    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.get_alias(index: 'foo^bar', name: 'bar/bam')).to eq({})
+    end
+  end
+end

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

@@ -0,0 +1,70 @@
+# 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.cluster#get_field_mapping' do
+
+  let(:expected_args) do
+    [
+        'GET',
+        url,
+        {},
+        nil,
+        {}
+    ]
+  end
+
+  let(:url) do
+    '_mapping/field/foo'
+  end
+
+  it 'performs the request' do
+    expect(client_double.indices.get_field_mapping(field: 'foo')).to eq({})
+  end
+
+  context 'when an index is specified' do
+
+    let(:url) do
+      'foo/_mapping/field/bam'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.get_field_mapping(index: 'foo', field: 'bam')).to eq({})
+    end
+  end
+
+  context 'when a type is specified' do
+
+    let(:url) do
+      'foo/_mapping/bar/field/bam'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.get_field_mapping(index: 'foo', type: 'bar', field: 'bam')).to eq({})
+    end
+  end
+end

data/spec/opensearch/api/actions/indices/get_mapping_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.cluster#get_mapping' do
+
+  let(:expected_args) do
+    [
+        'GET',
+        url,
+        {},
+        nil,
+        {}
+    ]
+  end
+
+  let(:url) do
+    '_mapping'
+  end
+
+  it 'performs the request' do
+    expect(client_double.indices.get_mapping).to eq({})
+  end
+
+  context 'when an index is specified' do
+
+    let(:url) do
+      'foo/_mapping'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.get_mapping(index: 'foo')).to eq({})
+    end
+  end
+
+  context 'when an index and type are specified' do
+
+    let(:url) do
+      'foo/_mapping/bar'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.get_mapping(index: 'foo', type: 'bar')).to eq({})
+    end
+  end
+
+  context 'when multiple indices and types are specified' do
+
+    let(:url) do
+      'foo,bar/_mapping/bam,baz'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.get_mapping(index: ['foo', 'bar'], type: ['bam', 'baz'])).to eq({})
+    end
+  end
+
+  context 'when the path must be URL-escaped' do
+
+    let(:url) do
+      'foo%5Ebar/_mapping/bar%2Fbam'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.get_mapping(index: 'foo^bar', type: 'bar/bam')).to eq({})
+    end
+  end
+end

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

@@ -0,0 +1,81 @@
+# 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.cluster#get_settings' do
+
+  let(:expected_args) do
+    [
+        'GET',
+        url,
+        {},
+        nil,
+        {}
+    ]
+  end
+
+  let(:url) do
+    '_settings'
+  end
+
+  it 'performs the request' do
+    expect(client_double.indices.get_settings).to eq({})
+  end
+
+  context 'when an index is specified' do
+
+    let(:url) do
+      'foo/_settings'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.get_settings(index: 'foo')).to eq({})
+    end
+  end
+
+  context 'when a name is specified' do
+
+    let(:url) do
+      'foo/_settings/foo.bar'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.get_settings(index: 'foo', name: 'foo.bar')).to eq({})
+    end
+  end
+
+  context 'when the path must be URL-escaped' do
+
+    let(:url) do
+      'foo%5Ebar/_settings'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.get_settings(index: 'foo^bar')).to eq({})
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+# 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#get' do
+
+  let(:expected_args) do
+    [
+        'GET',
+        url,
+        params,
+        nil,
+        {}
+    ]
+  end
+
+  let(:params) do
+    {}
+  end
+
+  let(:url) do
+    'foo'
+  end
+
+  it 'performs the request' do
+    expect(client_double.indices.get(index: 'foo')).to eq({})
+  end
+
+  context 'when parameters are specified' do
+
+    let(:params) do
+      { ignore_unavailable: 1 }
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.get(index: 'foo', ignore_unavailable: 1)).to eq({})
+    end
+  end
+end

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

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

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

@@ -0,0 +1,98 @@
+# 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.cluster#put_alias' do
+
+  let(:expected_args) do
+    [
+        'PUT',
+        url,
+        {},
+        body,
+        {}
+    ]
+  end
+
+  let(:url) do
+    'foo/_aliases/bar'
+  end
+
+  let(:body) do
+    nil
+  end
+
+  it 'performs the request' do
+    expect(client_double.indices.put_alias(index: 'foo', name: 'bar')).to eq({})
+  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.put_alias(name: 'foo')
+      }.to raise_exception(ArgumentError)
+    end
+  end
+
+  context 'when a body is specified' do
+
+    let(:body) do
+      { filter: 'foo' }
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.put_alias(index: 'foo', name: 'bar', body: { filter: 'foo' })).to eq({})
+    end
+  end
+
+  context 'when multiple indices are specified' do
+
+    let(:url) do
+      'foo,bar/_aliases/bam'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.put_alias(index: ['foo','bar'], name: 'bam')).to eq({})
+    end
+  end
+
+  context 'when the path needs to be URL-escaped' do
+
+    let(:url) do
+      'foo%5Ebar/_aliases/bar%2Fbam'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.put_alias(index: 'foo^bar', name: 'bar/bam')).to eq({})
+    end
+  end
+end