opensearch-api 1.0.0

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

@@ -0,0 +1,51 @@
+# 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#shrink' do
+
+  let(:expected_args) do
+    [
+        'PUT',
+        'foo/_shrink/bar',
+        {},
+        nil,
+        {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.indices.shrink(index: 'foo', target: 'bar')).to eq({})
+  end
+
+  it 'does not mutate the arguments' do
+    arguments = { index: 'foo', target: 'bar' }
+    client_double.indices.shrink(arguments)
+    expect(arguments[:index]).to eq('foo')
+    expect(arguments[:target]).to eq('bar')
+  end
+end

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

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

@@ -0,0 +1,133 @@
+# 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',
+        url,
+        params,
+        body,
+        {}
+    ]
+  end
+
+  let(:url) do
+    '_stats'
+  end
+
+  let(:body) do
+    nil
+  end
+
+  let(:params) do
+    {}
+  end
+
+  it 'performs the request' do
+    expect(client_double.indices.stats).to eq({})
+  end
+
+  context 'when an index is specified' do
+
+    let(:url) do
+      'foo/_stats'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.stats(index: 'foo')).to eq({})
+    end
+  end
+
+  context 'when multiple indicies are specified as a list' do
+
+    let(:url) do
+      'foo,bar/_stats'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.stats(index: ['foo', 'bar'])).to eq({})
+    end
+  end
+
+  context 'when multiple indicies are specified as a string' do
+
+    let(:url) do
+      'foo,bar/_stats'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.stats(index: 'foo,bar')).to eq({})
+    end
+  end
+
+  context 'when parameters are specified' do
+    let(:params) do
+      { expand_wildcards: true }
+    end
+
+    let(:url) do
+      'foo/_stats'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.stats(index: 'foo', expand_wildcards: true)).to eq({})
+    end
+  end
+
+  context 'when the fields parameter is specified as a list' do
+
+    let(:params) do
+      { fields: 'foo,bar' }
+    end
+
+    let(:url) do
+      'foo/_stats/fielddata'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.stats(index: 'foo', fielddata: true, fields: [ 'foo', 'bar'])).to eq({})
+    end
+  end
+
+  context 'when the groups parameter is specified as a list' do
+
+    let(:params) do
+      { groups: 'groupA,groupB' }
+    end
+
+    let(:url) do
+      '_stats/search'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.stats(search: true, groups: [ 'groupA', 'groupB'])).to eq({})
+    end
+  end
+end

data/spec/opensearch/api/actions/indices/update_aliases_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.cluster#update_aliases' do
+
+  let(:expected_args) do
+    [
+        'POST',
+        '_aliases',
+        params,
+        body,
+        {}
+    ]
+  end
+
+  let(:body) do
+    { actions: [] }
+  end
+
+  let(:params) do
+    {}
+  end
+
+  it 'performs the request' do
+    expect(client_double.indices.update_aliases(body: { actions: [] })).to eq({})
+  end
+
+  context 'when a body is not specified' do
+
+    let(:client) do
+      Class.new { include OpenSearch::API }.new
+    end
+
+    it 'raises an exception' do
+      expect {
+        client.indices.update_aliases
+      }.to raise_exception(ArgumentError)
+    end
+  end
+
+  context 'when parameters are specified' do
+
+    let(:params) do
+      { timeout: '1s' }
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.update_aliases(timeout: '1s', body: { actions: [] })).to eq({})
+    end
+  end
+end

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

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

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

data/spec/opensearch/api/actions/ingest/delete_pipeline_spec.rb

@@ -0,0 +1,69 @@
+# 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.ingest#delete_pipeline' do
+
+  let(:expected_args) do
+    [
+        'DELETE',
+        url,
+        {},
+        nil,
+        {}
+    ]
+  end
+
+  let(:url) do
+    '_ingest/pipeline/foo'
+  end
+
+  let(:client) do
+    Class.new { include OpenSearch::API }.new
+  end
+
+  it 'requires the :id argument' do
+    expect {
+      client.ingest.delete_pipeline
+    }.to raise_exception(ArgumentError)
+  end
+
+  it 'performs the request' do
+    expect(client_double.ingest.delete_pipeline(id: 'foo')).to eq({})
+  end
+
+  context 'when the path must be URL-escaped' do
+
+    let(:url) do
+      '_ingest/pipeline/foo%5Ebar'
+    end
+
+    it 'performs the request' do
+      expect(client_double.ingest.delete_pipeline(id: 'foo^bar')).to eq({})
+    end
+  end
+end

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

data/spec/opensearch/api/actions/ingest/get_pipeline_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.ingest#get_pipeline' do
+
+  let(:expected_args) do
+    [
+        'GET',
+        url,
+        {},
+        nil,
+        {}
+    ]
+  end
+
+  let(:url) do
+    '_ingest/pipeline/foo'
+  end
+
+  it 'performs the request' do
+    expect(client_double.ingest.get_pipeline(id: 'foo')).to eq({})
+  end
+
+  context 'when the path must be URL-escaped' do
+
+    let(:url) do
+      '_ingest/pipeline/foo%5Ebar'
+    end
+
+    it 'performs the request' do
+      expect(client_double.ingest.get_pipeline(id: 'foo^bar')).to eq({})
+    end
+  end
+end