opensearch-api 1.0.0

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

@@ -0,0 +1,89 @@
+# 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#delete_by_query' do
+
+  let(:expected_args) do
+    [
+      'POST',
+      'foo/_delete_by_query',
+      {},
+      { term: {} },
+      {}
+    ]
+  end
+
+  it 'requires the :index argument' do
+    expect {
+      Class.new { include OpenSearch::API }.new.delete_by_query(body: {})
+    }.to raise_exception(ArgumentError)
+  end
+
+  it 'performs the request' do
+    expect(client_double.delete_by_query(index: 'foo', body: { term: {} })).to eq({})
+  end
+
+  context 'when the type argument is provided' do
+
+    let(:expected_args) do
+      [
+        'POST',
+        'foo/tweet,post/_delete_by_query',
+        {},
+        { term: {} },
+        {}
+      ]
+    end
+
+    it 'performs the request' do
+      expect(client_double.delete_by_query(index: 'foo', type: ['tweet', 'post'], body: { term: {} })).to eq({})
+    end
+  end
+
+  context 'when a query is provided' do
+    let(:expected_args) do
+      [
+        'POST',
+        'foo/_delete_by_query',
+        { q: 'foo:bar' },
+        { query: 'query' },
+        {}
+      ]
+    end
+
+    it 'performs the request' do
+      expect(
+        client_double.delete_by_query(
+          index: 'foo',
+          q: 'foo:bar',
+          body: { query: 'query' }
+        )
+      ).to eq({})
+    end
+  end
+end

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

@@ -0,0 +1,121 @@
+# 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#delete' do
+
+  let(:expected_args) do
+    [
+        'DELETE',
+        'foo/bar/1',
+        params,
+        nil,
+        {}
+    ]
+  end
+
+  let(:params) do
+    {}
+  end
+
+  let(:client) do
+    Class.new { include OpenSearch::API }.new
+  end
+
+  it 'requires the :index argument' do
+    expect {
+      client.delete(type: 'bar', id: '1')
+    }.to raise_exception(ArgumentError)
+  end
+
+  it 'requires the :id argument' do
+    expect {
+      client.delete(index: 'foo', type: 'bar')
+    }.to raise_exception(ArgumentError)
+  end
+
+  it 'performs the request' do
+    expect(client_double.delete(index: 'foo', type: 'bar', id: '1')).to eq({})
+  end
+
+  context 'when url params are provided' do
+
+    let(:params) do
+      { routing: 'abc123' }
+    end
+
+    it 'performs the request' do
+      expect(client_double.delete(index: 'foo', type: 'bar', id: '1', routing: 'abc123')).to eq({})
+    end
+  end
+
+  context 'when invalid url params are provided' do
+
+    it 'raises an ArgumentError' do
+      expect {
+        client.delete(index: 'foo', type: 'bar', id: '1', qwertypoiuy: 'asdflkjhg')
+      }.to raise_exception(ArgumentError)
+    end
+  end
+
+  context 'when the url params need to be escaped' do
+
+    let(:expected_args) do
+      [
+          'DELETE',
+          'foo%5Ebar/bar%2Fbam/1',
+          params,
+          nil,
+          {}
+      ]
+    end
+
+    it 'escapes the url params' do
+      expect(client_double.delete(index: 'foo^bar', type: 'bar/bam', id: 1)).to eq({})
+    end
+  end
+
+  context 'when the index is not found' do
+
+    before do
+      expect(client).to receive(:perform_request).and_raise(NotFound)
+    end
+
+    it 'raises the exception' do
+      expect {
+        client.delete(index: 'foo', type: 'bar', id: 'XXX')
+      }.to raise_exception(NotFound)
+    end
+
+    context 'when the :ignore option is provided' do
+
+      it 'does not raise the NotFound exception' do
+        expect(client.delete(index: 'foo', type: 'bar', id: 1, ignore: 404)).to eq(false)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+# 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#delete_script' do
+  context 'when lang parameter is not provided' do
+
+    let(:expected_args) do
+      [
+          'DELETE',
+          '_scripts/foo',
+          {},
+          nil,
+          {}
+      ]
+    end
+
+    it 'performs the request' do
+      expect(client_double.delete_script(id: 'foo')).to eq({})
+    end
+  end
+end

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

@@ -0,0 +1,136 @@
+# 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#exists' do
+
+  let(:expected_args) do
+    [
+        'HEAD',
+        url,
+        params,
+        nil,
+        {}
+    ]
+  end
+
+  let(:params) do
+    {}
+  end
+
+  let(:url) do
+    'foo/bar/1'
+  end
+
+  let(:client) do
+    Class.new { include OpenSearch::API }.new
+  end
+
+  it 'requires the :index argument' do
+    expect {
+      client.exists(type: 'bar', id: '1')
+    }.to raise_exception(ArgumentError)
+  end
+
+  it 'requires the :id argument' do
+    expect {
+      client.exists(index: 'foo', type: 'bar')
+    }.to raise_exception(ArgumentError)
+  end
+
+  context 'when the type parameter is not provided' do
+
+    let(:url) do
+      'foo/_doc/1'
+    end
+
+    it 'performs the request' do
+      expect(client_double.exists(index: 'foo', id: '1')).to eq(true)
+    end
+  end
+
+  it 'is aliased to a predicated method' do
+    expect(client_double.exists?(index: 'foo', type: 'bar', id: '1')).to eq(true)
+  end
+
+  context 'when URL parameters are provided' do
+
+    let(:params) do
+      { routing: 'abc123' }
+    end
+
+    it 'passes the parameters' do
+      expect(client_double.exists(index: 'foo', type: 'bar', id: '1', routing: 'abc123')).to eq(true)
+    end
+  end
+
+  context 'when the request needs to be URL-escaped' do
+
+    let(:url) do
+      'foo/bar%2Fbam/1'
+    end
+
+    it 'URL-escapes the characters' do
+      expect(client_double.exists(index: 'foo', type: 'bar/bam', id: '1')).to eq(true)
+    end
+  end
+
+  context 'when the response is 404' do
+
+    before do
+      expect(response_double).to receive(:status).and_return(404)
+    end
+
+    it 'returns false' do
+      expect(client_double.exists(index: 'foo', type: 'bar', id: '1')).to eq(false)
+    end
+  end
+
+  context 'when the response is 404 NotFound' do
+
+    before do
+      expect(response_double).to receive(:status).and_raise(StandardError.new('404 NotFound'))
+    end
+
+    it 'returns false' do
+      expect(client_double.exists(index: 'foo', type: 'bar', id: '1')).to eq(false)
+    end
+  end
+
+  context 'when there are other errors' do
+
+    before do
+      expect(response_double).to receive(:status).and_raise(StandardError)
+    end
+
+    it 'raises the error' do
+      expect {
+        client_double.exists(index: 'foo', type: 'bar', id: '1')
+      }.to raise_exception(StandardError)
+    end
+  end
+end

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

@@ -0,0 +1,108 @@
+# 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#explain' do
+  let(:expected_args) do
+    [
+      method,
+      url,
+      params,
+      body,
+      {}
+    ]
+  end
+
+  let(:method) { 'POST' }
+
+  let(:params) do
+    {}
+  end
+
+  let(:body) do
+    {}
+  end
+
+  let(:url) do
+    'foo/bar/1/_explain'
+  end
+
+  let(:client) do
+    Class.new { include OpenSearch::API }.new
+  end
+
+  it 'requires the :index argument' do
+    expect {
+      client.explain(type: 'bar', id: '1')
+    }.to raise_exception(ArgumentError)
+  end
+
+  it 'requires the :id argument' do
+    expect {
+      client.explain(index: 'foo', type: 'bar')
+    }.to raise_exception(ArgumentError)
+  end
+  
+  it 'performs the request' do
+    expect(client_double.explain(index: 'foo', type: 'bar', id: 1, body: {})).to eq({})
+  end
+
+  context 'when a query is provided' do
+    let(:method) { 'GET' }
+    let(:params) do
+      { q: 'abc123' }
+    end
+
+    let(:body) do
+      nil
+    end
+
+    it 'passes the query' do
+      expect(client_double.explain(index: 'foo', type: 'bar', id: '1', q: 'abc123')).to eq({})
+    end
+  end
+
+  context 'when a query definition is provided' do
+    let(:body) do
+      { query: { match: {} } }
+    end
+
+    it 'passes the query definition' do
+      expect(client_double.explain(index: 'foo', type: 'bar', id: '1', body: { query: { match: {} } })).to eq({})
+    end
+  end
+
+  context 'when the request needs to be URL-escaped' do
+    let(:url) do
+      'foo%5Ebar/bar%2Fbam/1/_explain'
+    end
+
+    it 'URL-escapes the parts' do
+      expect(client_double.explain(index: 'foo^bar', type: 'bar/bam', id: '1', body: { })).to eq({})
+    end
+  end
+end

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

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

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