opensearch-api 1.0.0

data/spec/opensearch/api/actions/ingest/put_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#put_pipeline' do
+
+  let(:expected_args) do
+    [
+        'PUT',
+        url,
+        {},
+        {},
+        {}
+    ]
+  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.put_pipeline
+    }.to raise_exception(ArgumentError)
+  end
+
+  it 'performs the request' do
+    expect(client_double.ingest.put_pipeline(id: 'foo', body: {})).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.put_pipeline(id: 'foo^bar', body: {})).to eq({})
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+# 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#simulate' do
+  let(:expected_args) do
+    [
+      method,
+      url,
+      {},
+      {},
+      {}
+    ]
+  end
+  let(:method) { 'POST' }
+
+  let(:url) do
+    '_ingest/pipeline/_simulate'
+  end
+
+  it 'performs the request' do
+    expect(client_double.ingest.simulate(body: {})).to eq({})
+  end
+
+  context 'when a pipeline id is provided' do
+    let(:url) do
+      '_ingest/pipeline/foo/_simulate'
+    end
+
+    it 'performs the request' do
+      expect(client_double.ingest.simulate(id: 'foo', body: {})).to eq({})
+    end
+  end
+end

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

@@ -0,0 +1,93 @@
+# 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 'JSON builders' do
+  context 'JBuilder' do
+    let(:expected_args) do
+      [
+        'POST',
+        '_search',
+        {},
+        body,
+        {}
+      ]
+    end
+
+    let(:json) do
+      Jbuilder.encode do |json|
+        json.query do
+          json.match do
+            json.title do
+              json.query 'test'
+            end
+          end
+        end
+      end
+    end
+
+    let(:body) do
+      json
+    end
+
+    it 'properly builds the json' do
+      expect(client_double.search(body: json)).to eq({})
+    end
+  end
+
+  context 'Jsonify' do
+    let(:expected_args) do
+      [
+        'POST',
+        '_search',
+        {},
+        body,
+        {}
+      ]
+    end
+
+    let(:json) do
+      Jsonify::Builder.compile do |json|
+        json.query do
+          json.match do
+            json.title do
+              json.query 'test'
+            end
+          end
+        end
+      end
+    end
+
+    let(:body) do
+      json
+    end
+
+    it 'properly builds the json' do
+      expect(client_double.search(body: json)).to eq({})
+    end
+  end
+end

data/spec/opensearch/api/actions/mget_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#mget' do
+  let(:expected_args) do
+    [
+      'POST',
+      url,
+      params,
+      body,
+      {}
+    ]
+  end
+
+  let(:body) do
+    { docs: [] }
+  end
+
+  let(:url) do
+    '_mget'
+  end
+
+  let(:params) do
+    {}
+  end
+
+  it 'performs the request' do
+    expect(client_double.mget(body: { :docs => [] })).to eq({})
+  end
+
+  context 'when an index is specified' do
+
+    let(:url) do
+      'foo/_mget'
+    end
+
+    it 'performs the request' do
+      expect(client_double.mget(index: 'foo', body: { :docs => [] })).to eq({})
+    end
+  end
+
+  context 'when a type is specified' do
+
+    let(:url) do
+      'foo/bar/_mget'
+    end
+
+    let(:body) do
+      { ids: [ '1', '2' ]}
+    end
+
+    it 'performs the request' do
+      expect(client_double.mget(index: 'foo', type: 'bar', body: { :ids => [ '1', '2'] })).to eq({})
+    end
+  end
+
+  context 'when url parameters are provided' do
+
+    let(:params) do
+      { refresh: true }
+    end
+
+    let(:body) do
+      {}
+    end
+
+    it 'performs the request' do
+      expect(client_double.mget(body: {}, refresh: true)).to eq({})
+    end
+  end
+
+  context 'when the request needs to be URL-escaped' do
+
+    let(:url) do
+      'foo%5Ebar/bar%2Fbam/_mget'
+    end
+
+    let(:body) do
+      { ids: [ '1', '2' ]}
+    end
+
+    it 'performs the request' do
+      expect(client_double.mget(index: 'foo^bar', type: 'bar/bam', body: { :ids => [ '1', '2'] })).to eq({})
+    end
+  end
+end

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

@@ -0,0 +1,160 @@
+# 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#msearch' do
+  let(:expected_args) do
+    [
+      'POST',
+      url,
+      params,
+      body,
+      headers
+    ]
+  end
+
+  let(:body) do
+    nil
+  end
+
+  let(:url) do
+    '_msearch'
+  end
+
+  let(:params) do
+    {}
+  end
+
+  let(:headers) do
+    { 'Content-Type' => 'application/x-ndjson' }
+  end
+
+  let(:client) do
+    Class.new { include OpenSearch::API }.new
+  end
+
+  it 'requires the :body argument' do
+    expect do
+      client.msearch
+    end.to raise_exception(ArgumentError)
+  end
+
+  context 'when the body is an object' do
+    let(:body) do
+      <<-PAYLOAD.gsub(/^\s+/, '')
+            {"index":"foo"}
+            {"query":{"match_all":{}}}
+            {"index":"bar"}
+            {"query":{"match":{"foo":"bar"}}}
+            {"search_type":"count"}
+            {"facets":{"tags":{}}}
+      PAYLOAD
+    end
+
+    it 'performs the request' do
+      expect(
+        client_double.msearch(
+          body: [
+            { index: 'foo', search: { query: { match_all: {}  } } },
+            { index: 'bar', search: { query: { match: { foo: 'bar' } } } },
+            { search_type: 'count', search: { facets: { tags: {} } } }
+          ]
+        )
+      )
+    end
+  end
+
+  context 'when the body is a string' do
+    let(:body) do
+      %Q|{"foo":"bar"}\n{"moo":"lam"}|
+    end
+
+    it 'performs the request' do
+      expect(client_double.msearch(body: %Q|{"foo":"bar"}\n{"moo":"lam"}|)).to eq({})
+    end
+  end
+
+  context 'when an index is specified' do
+    let(:url) do
+      'foo/_msearch'
+    end
+
+    let(:body) do
+      ''
+    end
+
+    it 'performs the request' do
+      expect(client_double.msearch(index: 'foo', body: []))
+    end
+  end
+
+  context 'when multiple indices are specified' do
+    let(:url) do
+      'foo,bar/_msearch'
+    end
+
+    let(:body) do
+      ''
+    end
+
+    it 'performs the request' do
+      expect(client_double.msearch(index: ['foo', 'bar'], body: []))
+    end
+  end
+
+  context 'when the request needs to be URL-escaped' do
+    let(:url) do
+      'foo%5Ebar/_msearch'
+    end
+
+    let(:body) do
+      ''
+    end
+
+    it 'performs the request' do
+      expect(client_double.msearch(index: 'foo^bar', body: [])).to eq({})
+    end
+  end
+
+  context 'when the URL params need to be URL-encoded' do
+    let(:url) do
+      '_msearch'
+    end
+
+    let(:body) do
+      ''
+    end
+
+    let(:params) do
+      { search_type: 'scroll' }
+    end
+
+    it 'performs the request' do
+      expect(client_double.msearch(body: [], search_type: 'scroll')).to eq({})
+    end
+  end
+end

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

@@ -0,0 +1,102 @@
+# 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#msearch_template' do
+  let(:expected_args) do
+    [
+      'POST',
+      url,
+      params,
+      body,
+      headers
+    ]
+  end
+
+  let(:body) do
+    nil
+  end
+
+  let(:params) do
+    {}
+  end
+
+  let(:headers) do
+    { 'Content-Type' => 'application/x-ndjson' }
+  end
+
+  let(:url) do
+    '_msearch/template'
+  end
+
+  context 'when a body is provided as a document' do
+
+    let(:body) do
+      <<-PAYLOAD.gsub(/^\s+/, '')
+            {"index":"foo"}
+            {"inline":{"query":{"match":{"foo":"{{q}}"}}},"params":{"q":"foo"}}
+            {"index":"bar"}
+            {"id":"query_foo","params":{"q":"foo"}}
+      PAYLOAD
+    end
+
+    it 'performs the request' do
+      expect(client_double.msearch_template(body: [
+          { index: 'foo' },
+          { inline: { query: { match: { foo: '{{q}}' } } }, params: { q: 'foo' } },
+          { index: 'bar' },
+          { id: 'query_foo', params: { q: 'foo' } }
+      ])).to eq({})
+    end
+  end
+
+  context 'when a body is provided as a string' do
+
+    let(:body) do
+      %Q|{"foo":"bar"}\n{"moo":"lam"}|
+    end
+
+    it 'performs the request' do
+      expect(client_double.msearch_template(body: %Q|{"foo":"bar"}\n{"moo":"lam"}|)).to eq({})
+    end
+  end
+
+  context 'when an index is provided' do
+
+    let(:url) do
+      'foo/_msearch/template'
+    end
+
+    let(:body) do
+      ''
+    end
+
+    it 'performs the request' do
+      expect(client_double.msearch_template(index: 'foo', body: []))
+    end
+  end
+end

data/spec/opensearch/api/actions/mtermvectors_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#mtermvectors' do
+  let(:expected_args) do
+    [
+      method,
+      'my-index/my-type/_mtermvectors',
+      {},
+      body,
+      {}
+    ]
+  end
+  let(:method) { 'POST' }
+
+  let(:body) do
+    { ids: [1, 2, 3] }
+  end
+
+  it 'performs the request' do
+    expect(client_double.mtermvectors(index: 'my-index', type: 'my-type', body: { ids: [1, 2, 3] })).to eq({})
+  end
+
+  context 'when a list of ids is passed instead of a body' do
+    let(:method) { 'GET' }
+    it 'performs the request' do
+      expect(client_double.mtermvectors(index: 'my-index', type: 'my-type', ids: [1, 2, 3])).to eq({})
+    end
+  end
+end