opensearch-api 1.0.0

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

data/spec/opensearch/api/actions/cluster/put_settings_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#put_settings' do
+
+  let(:expected_args) do
+    [
+        'PUT',
+        '_cluster/settings',
+        {},
+        {},
+        {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.cluster.put_settings(body: {})).to eq({})
+  end
+end

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

data/spec/opensearch/api/actions/cluster/reroute_spec.rb

@@ -0,0 +1,61 @@
+# 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#reroute' do
+
+  let(:expected_args) do
+    [
+        'POST',
+        '_cluster/reroute',
+        {},
+        {},
+        {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.cluster.reroute).to eq({})
+  end
+
+  context 'when a body is specified' do
+
+    let(:expected_args) do
+      [
+          'POST',
+          '_cluster/reroute',
+          {},
+          { commands: [ move: { index: 'myindex', shard: 0 }] },
+          {}
+      ]
+    end
+
+    it 'performs the request' do
+      expect(client_double.cluster.reroute(body: { commands: [ move: { index: 'myindex', shard: 0 }] })).to eq({})
+    end
+  end
+end

data/spec/opensearch/api/actions/cluster/state_spec.rb

@@ -0,0 +1,61 @@
+# 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#state' do
+
+  let(:expected_args) do
+    [
+        'GET',
+        '_cluster/state',
+        {},
+        nil,
+        {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.cluster.state).to eq({})
+  end
+
+  context 'when a metric is specified' do
+
+    let(:expected_args) do
+      [
+          'GET',
+          '_cluster/state/foo,bar',
+          {},
+          nil,
+          {}
+      ]
+    end
+
+    it 'performs the request' do
+      expect(client_double.cluster.state(metric: ['foo', 'bar'])).to eq({})
+    end
+  end
+end

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

data/spec/opensearch/api/actions/count_spec.rb

@@ -0,0 +1,78 @@
+# 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#count' do
+
+  let(:expected_args) do
+    [
+      'POST',
+      '_count',
+      {},
+      nil,
+      {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.count).to eq({})
+  end
+
+  context 'when an index and type are specified' do
+
+    let(:expected_args) do
+      [
+        'POST',
+        'foo,bar/t1,t2/_count',
+        {},
+        nil,
+        {}
+      ]
+    end
+
+    it 'performs the request' do
+      expect(client_double.count(index: ['foo','bar'], type: ['t1','t2'])).to eq({})
+    end
+  end
+
+  context 'when there is a query provided' do
+
+    let(:expected_args) do
+      [
+        'POST',
+        '_count',
+        {},
+        { match: { foo: 'bar' } },
+        {}
+      ]
+    end
+
+    it 'performs the request' do
+      expect(client_double.count(body: { match: { foo: 'bar' } })).to eq({})
+    end
+  end
+end

data/spec/opensearch/api/actions/create_document_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#create_document' do
+
+  let(:expected_args) do
+    [
+        'PUT',
+        'foo/bar/123',
+        { op_type: 'create' },
+        { foo: 'bar' },
+        {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.create(index: 'foo', type: 'bar', id: '123', body: { foo: 'bar'})).to eq({})
+  end
+
+  context 'when the request needs to be URL-escaped' do
+
+    let(:expected_args) do
+      [
+          'PUT',
+          'foo/bar%2Fbam/123',
+          { op_type: 'create' },
+          {},
+          {}
+      ]
+    end
+
+    it 'performs the request' do
+      expect(client_double.create(index: 'foo', type: 'bar/bam', id: '123', body: {})).to eq({})
+    end
+  end
+
+  context 'when an id is provided as an integer' do
+
+    let(:expected_args) do
+      [
+          'PUT',
+          'foo/bar/1',
+          { op_type: 'create' },
+          { foo: 'bar' },
+          {}
+      ]
+    end
+
+    it 'updates the arguments with the `op_type`' do
+      expect(client_double.create(index: 'foo', type: 'bar', id: 1, body: { foo: 'bar' })).to eq({})
+    end
+  end
+
+  context 'when an id is not provided' do
+
+    let(:expected_args) do
+      [
+          'POST',
+          'foo/bar',
+          { },
+          { foo: 'bar' },
+          {}
+      ]
+    end
+
+    it 'updates the arguments with the `op_type`' do
+      expect(client_double.create(index: 'foo', type: 'bar', body: { foo: 'bar' })).to eq({})
+    end
+  end
+end

data/spec/opensearch/api/actions/dangling_indices/delete_dangling_indices_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 'dangling_indices#delete_dangling_index' do
+  let(:expected_args) do
+    [
+      'DELETE',
+      '_dangling/foo',
+      {},
+      nil,
+      {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(
+      client_double.dangling_indices.delete_dangling_index(index_uuid: 'foo')
+    ).to eq({})
+  end
+
+  context 'when no index_uuid is specified' do
+    let(:client) do
+      Class.new { include OpenSearch::API }.new
+    end
+
+    it 'raises the exception' do
+      expect do
+        client.dangling_indices.delete_dangling_index
+      end.to raise_exception(ArgumentError)
+    end
+  end
+end

data/spec/opensearch/api/actions/dangling_indices/import_dangling_indices_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 'dangling_indices#import_dangling_index' do
+  let(:expected_args) do
+    [
+      'POST',
+      '_dangling/foo',
+      {},
+      nil,
+      {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(
+      client_double.dangling_indices.import_dangling_index(index_uuid: 'foo')
+    ).to eq({})
+  end
+
+  context 'when no index_uuid is specified' do
+    let(:client) do
+      Class.new { include OpenSearch::API }.new
+    end
+
+    it 'raises the exception' do
+      expect do
+        client.dangling_indices.delete_dangling_index
+      end.to raise_exception(ArgumentError)
+    end
+  end
+end

data/spec/opensearch/api/actions/dangling_indices/list_dangling_indices_spec.rb

@@ -0,0 +1,45 @@
+# 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 'dangling_indices#list_dangling_index' do
+  let(:expected_args) do
+    [
+      'GET',
+      '_dangling',
+      {},
+      nil,
+      {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(
+      client_double.dangling_indices.list_dangling_indices
+    ).to eq({})
+  end
+end