opensearch-api 1.0.0

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

@@ -0,0 +1,111 @@
+# 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_mapping' do
+
+  let(:expected_args) do
+    [
+        'PUT',
+        url,
+        {},
+        body,
+        {}
+    ]
+  end
+
+  let(:url) do
+    'foo/bar/_mappings'
+  end
+
+  let(:body) do
+    {}
+  end
+
+  it 'performs the request' do
+    expect(client_double.indices.put_mapping(index: 'foo', type: 'bar', body: {})).to eq({})
+  end
+
+  context 'when there is no type specified' do
+
+    let(:client) do
+      Class.new { include OpenSearch::API }.new
+    end
+
+    it 'raises an exception' do
+      expect {
+        client.indices.put_mapping(type: 'foo')
+      }.to raise_exception(ArgumentError)
+    end
+  end
+
+  context 'when there is no body specified' do
+
+    let(:client) do
+      Class.new { include OpenSearch::API }.new
+    end
+
+    it 'raises an exception' do
+      expect {
+        client.indices.put_mapping(index: 'foo', type: 'bar')
+      }.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_mapping(index: 'foo', type: 'bar', body: { filter: 'foo' })).to eq({})
+    end
+  end
+
+  context 'when multiple indices are specified' do
+
+    let(:url) do
+      'foo,bar/bam/_mappings'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.put_mapping(index: ['foo','bar'], type: 'bam', body: {})).to eq({})
+    end
+  end
+
+  context 'when the path needs to be URL-escaped' do
+
+    let(:url) do
+      'foo%5Ebar/bar%2Fbam/_mappings'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.put_mapping(index: 'foo^bar', type: 'bar/bam', body: {})).to eq({})
+    end
+  end
+end

data/spec/opensearch/api/actions/indices/put_settings_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.cluster#put_settings' do
+
+  let(:expected_args) do
+    [
+        'PUT',
+        url,
+        params,
+        body,
+        {}
+    ]
+  end
+
+  let(:url) do
+    '_settings'
+  end
+
+  let(:body) do
+    {}
+  end
+
+  let(:params) do
+    {}
+  end
+
+  it 'performs the request' do
+    expect(client_double.indices.put_settings(body: {})).to eq({})
+  end
+
+  context 'when there is no body specified' do
+
+    let(:client) do
+      Class.new { include OpenSearch::API }.new
+    end
+
+    it 'raises an exception' do
+      expect {
+        client.indices.put_settings
+      }.to raise_exception(ArgumentError)
+    end
+  end
+
+  context 'when parameters are specified' do
+
+    let(:params) do
+      { flat_settings: true }
+    end
+
+    let(:url) do
+      'foo/_settings'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.put_settings(index: 'foo', flat_settings: true, body: {})).to eq({})
+    end
+  end
+
+  context 'when an index is specified' do
+
+    let(:url) do
+      'foo/_settings'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.put_settings(index: 'foo', body: {})).to eq({})
+    end
+  end
+
+  context 'when multiple indices are specified' do
+
+    let(:url) do
+      'foo,bar/_settings'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.put_settings(index: ['foo','bar'], body: {})).to eq({})
+    end
+  end
+
+  context 'when the path needs to be URL-escaped' do
+
+    let(:url) do
+      'foo%5Ebar/_settings'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.put_settings(index: 'foo^bar', body: {})).to eq({})
+    end
+  end
+end

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

@@ -0,0 +1,116 @@
+# 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_template' do
+
+  let(:expected_args) do
+    [
+        'PUT',
+        url,
+        params,
+        body,
+        {}
+    ]
+  end
+
+  let(:url) do
+    '_template/foo'
+  end
+
+  let(:body) do
+    { template: 'bar' }
+  end
+
+  let(:params) do
+    {}
+  end
+
+  it 'performs the request' do
+    expect(client_double.indices.put_template(name: 'foo', body: { template: '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_template(body: {})
+      }.to raise_exception(ArgumentError)
+    end
+  end
+
+  context 'when there is no body specified' do
+
+    let(:client) do
+      Class.new { include OpenSearch::API }.new
+    end
+
+    it 'raises an exception' do
+      expect {
+        client.indices.put_template(name: 'foo')
+      }.to raise_exception(ArgumentError)
+    end
+  end
+
+  context 'when parameters are specified' do
+
+    let(:params) do
+      { order: 3 }
+    end
+
+    let(:url) do
+      '_template/foo'
+    end
+
+    let(:body) do
+      {}
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.put_template(name: 'foo', order: 3, body: {})).to eq({})
+    end
+  end
+
+  context 'when the path needs to be URL-escaped' do
+
+    let(:url) do
+      '_template/foo%5Ebar'
+    end
+
+    let(:body) do
+      {}
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.put_template(name: 'foo^bar', body: {})).to eq({})
+    end
+  end
+end

data/spec/opensearch/api/actions/indices/recovery_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#recovery' do
+
+  let(:expected_args) do
+    [
+        'GET',
+        'foo/_recovery',
+        {},
+        nil,
+        {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.indices.recovery(index: 'foo')).to eq({})
+  end
+end

data/spec/opensearch/api/actions/indices/refresh_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.cluster#refresh' do
+
+  let(:expected_args) do
+    [
+        'POST',
+        url,
+        params,
+        body,
+        {}
+    ]
+  end
+
+  let(:url) do
+    '_refresh'
+  end
+
+  let(:body) do
+    nil
+  end
+
+  let(:params) do
+    {}
+  end
+
+  it 'performs the request' do
+    expect(client_double.indices.refresh).to eq({})
+  end
+
+  context 'when an index is specified' do
+
+    let(:url) do
+      'foo/_refresh'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.refresh(index: 'foo')).to eq({})
+    end
+  end
+
+  context 'when multiple indicies are specified as a list' do
+
+    let(:url) do
+      'foo,bar/_refresh'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.refresh(index: ['foo', 'bar'])).to eq({})
+    end
+  end
+
+  context 'when multiple indicies are specified as a string' do
+
+    let(:url) do
+      'foo,bar/_refresh'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.refresh(index: 'foo,bar')).to eq({})
+    end
+  end
+
+  context 'when the path needs to be URL-escaped' do
+
+    let(:url) do
+      'foo%5Ebar/_refresh'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.refresh(index: 'foo^bar')).to eq({})
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+# 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#rollover' do
+
+  let(:expected_args) do
+    [
+        'POST',
+        url,
+        params,
+        body,
+        {}
+    ]
+  end
+
+  let(:url) do
+    'foo/_rollover'
+  end
+
+  let(:body) do
+    nil
+  end
+
+  let(:params) do
+    {}
+  end
+
+  it 'performs the request' do
+    expect(client_double.indices.rollover(alias: 'foo')).to eq({})
+  end
+
+  context 'when an index is specified' do
+
+    let(:url) do
+      'foo/_rollover/bar'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.rollover(alias: 'foo', new_index: 'bar')).to eq({})
+    end
+  end
+end

data/spec/opensearch/api/actions/indices/segments_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.cluster#segments' do
+
+  let(:expected_args) do
+    [
+        'GET',
+        url,
+        params,
+        body,
+        {}
+    ]
+  end
+
+  let(:url) do
+    '_segments'
+  end
+
+  let(:body) do
+    nil
+  end
+
+  let(:params) do
+    {}
+  end
+
+  it 'performs the request' do
+    expect(client_double.indices.segments).to eq({})
+  end
+
+  context 'when an index is specified' do
+
+    let(:url) do
+      'foo/_segments'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.segments(index: 'foo')).to eq({})
+    end
+  end
+
+  context 'when multiple indicies are specified as a list' do
+
+    let(:url) do
+      'foo,bar/_segments'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.segments(index: ['foo', 'bar'])).to eq({})
+    end
+  end
+
+  context 'when multiple indicies are specified as a string' do
+
+    let(:url) do
+      'foo,bar/_segments'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.segments(index: 'foo,bar')).to eq({})
+    end
+  end
+
+  context 'when the path needs to be URL-escaped' do
+
+    let(:url) do
+      'foo%5Ebar/_segments'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.segments(index: 'foo^bar')).to eq({})
+    end
+  end
+end

data/spec/opensearch/api/actions/indices/shard_stores_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#shard_stores' do
+
+  let(:expected_args) do
+    [
+        'GET',
+        '_shard_stores',
+        {},
+        nil,
+        {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.indices.shard_stores).to eq({})
+  end
+end