opensearch-api 1.0.0

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

data/spec/opensearch/api/actions/render_search_template_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#render_search_template' do
+  context 'when no id is specified' do
+    let(:expected_args) do
+      [
+        'POST',
+        '_render/template',
+        {},
+        { foo: 'bar' },
+        {}
+      ]
+    end
+
+    it 'performs the request' do
+      expect(client_double.render_search_template(body: { foo: 'bar' })).to eq({})
+    end
+  end
+
+  context 'when id is specified' do
+    let(:expected_args) do
+      [
+        'POST',
+        '_render/template/foo',
+        {},
+        { foo: 'bar' },
+        {}
+      ]
+    end
+
+    it 'performs the request' do
+      expect(client_double.render_search_template(id: 'foo', body: { foo: 'bar' })).to eq({})
+    end
+  end
+end

data/spec/opensearch/api/actions/scroll_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#scroll' do
+  context 'with scroll_id as a param' do
+    let(:expected_args) do
+      [
+        'GET',
+        '_search/scroll/cXVlcn...',
+        {},
+        nil,
+        {}
+      ]
+    end
+
+    it 'performs the request' do
+      expect(client_double.scroll(scroll_id: 'cXVlcn...')).to eq({})
+    end
+  end
+
+  context 'with scroll_id in the body' do
+    let(:expected_args) do
+      [
+        'POST',
+        '_search/scroll',
+        {},
+        { scroll_id: 'cXVlcn...' },
+        {}
+      ]
+    end
+
+    it 'performs the request' do
+      expect(client_double.scroll(body: { scroll_id: 'cXVlcn...' })).to eq({})
+    end
+  end
+end

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

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

@@ -0,0 +1,143 @@
+# 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#search' do
+  let(:expected_args) do
+    [
+      method,
+      url,
+      params,
+      body,
+      {}
+    ]
+  end
+  let(:method) { 'GET' }
+
+  let(:body) do
+    nil
+  end
+
+  let(:params) do
+    {}
+  end
+
+  let(:url) do
+    '_all/foo/_search'
+  end
+
+  it 'has a default value for index' do
+    expect(client_double.search(type: 'foo'))
+  end
+
+  context 'when a request definition is specified' do
+    let(:body) do
+      { query: { match: {} } }
+    end
+    let(:method) { 'POST' }
+
+    let(:url) do
+      '_search'
+    end
+
+    it 'performs the request' do
+      expect(client_double.search(body: { query: { match: {} } }))
+    end
+  end
+
+  context 'when an index is specified' do
+
+    let(:url) do
+      'foo/_search'
+    end
+
+    it 'performs the request' do
+      expect(client_double.search(index: 'foo'))
+    end
+  end
+
+  context 'when an index and type are specified' do
+
+    let(:url) do
+      'foo/bar/_search'
+    end
+
+    it 'performs the request' do
+      expect(client_double.search(index: 'foo', type: 'bar'))
+    end
+  end
+
+  context 'when multiple indices are specified' do
+
+    let(:url) do
+      'foo,bar/_search'
+    end
+
+    it 'performs the request' do
+      expect(client_double.search(index: ['foo', 'bar']))
+    end
+  end
+
+  context 'when multiple indices and types are specified' do
+
+    let(:url) do
+      'foo,bar/lam,bam/_search'
+    end
+
+    it 'performs the request' do
+      expect(client_double.search(index: ['foo', 'bar'], type: ['lam', 'bam']))
+    end
+  end
+
+  context 'when there are URL params' do
+
+    let(:url) do
+      '_search'
+    end
+
+    let(:params) do
+      { search_type: 'count' }
+    end
+
+    it 'performs the request' do
+      expect(client_double.search(search_type: 'count'))
+    end
+  end
+
+  context 'when there are invalid URL params' do
+
+    let(:client) do
+      Class.new { include OpenSearch::API }.new
+    end
+
+    it 'raises an ArgumentError' do
+      expect{
+        client.search(search_type: 'count', qwertypoiuy: 'asdflkjhg')
+      }.to raise_exception(ArgumentError)
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# 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#search_template' do
+  let(:expected_args) do
+    [
+      'POST',
+      'foo/_search/template',
+      { },
+      { foo: 'bar' },
+      {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.search_template(index: 'foo', body: { foo: 'bar' })).to eq({})
+  end
+end

data/spec/opensearch/api/actions/shutdown/delete_node_spec.rb

@@ -0,0 +1,53 @@
+# 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.shutdown#delete_node' do
+  let(:expected_args) do
+    [
+      'DELETE',
+      '_nodes/id/shutdown',
+      {},
+      nil,
+      {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.shutdown.delete_node(node_id: 'id')).to eq({})
+  end
+
+  let(:client) do
+    Class.new { include OpenSearch::API }.new
+  end
+
+  it 'raises an error if no node_id is provided' do
+    expect {
+      client.shutdown.delete_node
+    }.to raise_exception(ArgumentError)
+  end
+end

data/spec/opensearch/api/actions/shutdown/get_node_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.shutdown#get_node' do
+  let(:expected_args) do
+    [
+      'GET',
+      url,
+      {},
+      nil,
+      {}
+    ]
+  end
+
+  context 'when id is provided' do
+    let(:url) { '_nodes/id/shutdown' }
+
+    it 'performs the request' do
+      expect(client_double.shutdown.get_node(node_id: 'id')).to eq({})
+    end
+  end
+
+  context 'when no id is provided' do
+    let(:url) { '_nodes/shutdown' }
+
+    it 'performs the request' do
+      expect(client_double.shutdown.get_node).to eq({})
+    end
+  end
+end

data/spec/opensearch/api/actions/shutdown/put_node_spec.rb

@@ -0,0 +1,59 @@
+# 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.shutdown#put_node' do
+  let(:expected_args) do
+    [
+      'PUT',
+      '_nodes/id/shutdown',
+      {},
+      {},
+      {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.shutdown.put_node(body: {}, node_id: 'id')).to eq({})
+  end
+
+  let(:client) do
+    Class.new { include OpenSearch::API }.new
+  end
+
+  it 'raises an error if no node_id is provided' do
+    expect {
+      client.shutdown.put_node(body: {})
+    }.to raise_exception(ArgumentError)
+  end
+
+  it 'raises an error if no body is provided' do
+    expect {
+      client.shutdown.put_node(node_id: 'id')
+    }.to raise_exception(ArgumentError)
+  end
+end

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

@@ -0,0 +1,76 @@
+# 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.snapshot#clone' do
+  let(:expected_args) do
+    [
+        'PUT',
+        '_snapshot/foo/bar/_clone/snapshot',
+        {},
+        {},
+        {}
+    ]
+  end
+
+  let(:client) do
+    Class.new { include OpenSearch::API }.new
+  end
+
+  it 'requires the :body argument' do
+    expect {
+      client.snapshot.clone(snapshot: 'bar')
+    }.to raise_exception(ArgumentError)
+  end
+
+  it 'requires the :repository argument' do
+    expect {
+      client.snapshot.clone(snapshot: 'foo', body: {})
+    }.to raise_exception(ArgumentError)
+  end
+
+  it 'requires the :snapshot argument' do
+    expect {
+      client.snapshot.clone(repository: 'foo', body: {})
+    }.to raise_exception(ArgumentError)
+  end
+
+  it 'requires the :target_snapshot argument' do
+    expect {
+      client.snapshot.clone(repository: 'foo', body: {}, snapshot: 'bar')
+    }.to raise_exception(ArgumentError)
+  end
+
+  it 'performs the request' do
+    expect(client_double.snapshot.clone(
+             repository: 'foo',
+             snapshot: 'bar',
+             body: {},
+             target_snapshot: 'snapshot'
+           )).to eq({})
+  end
+end