opensearch-api 1.0.0

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

@@ -0,0 +1,110 @@
+# 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#get_source' do
+
+  let(:expected_args) do
+    [
+        'GET',
+        url,
+        params,
+        nil,
+        {}
+    ]
+  end
+
+  let(:params) do
+    { }
+  end
+
+  let(:url) do
+    'foo/bar/1/_source'
+  end
+
+  let(:client) do
+    Class.new { include OpenSearch::API }.new
+  end
+
+  it 'requires the :index argument' do
+    expect {
+      client.get_source(type: 'bar', id: '1')
+    }.to raise_exception(ArgumentError)
+  end
+
+  it 'requires the :id argument' do
+    expect {
+      client.get_source(index: 'foo', type: 'bar')
+    }.to raise_exception(ArgumentError)
+  end
+
+  context 'when the type parameter is not provided' do
+
+    let(:url) do
+      'foo/_source/1'
+    end
+
+    it 'performs the request' do
+      expect(client_double.get_source(index: 'foo', id: '1')).to eq({})
+    end
+  end
+
+  context 'when URL parameters are provided' do
+
+    let(:params) do
+      { routing: 'abc123' }
+    end
+
+    it 'Passes the URL params' do
+      expect(client_double.get_source(index: 'foo', type: 'bar', id: '1', routing: 'abc123')).to eq({})
+    end
+  end
+
+  context 'when the request needs to be URL-escaped' do
+
+    let(:url) do
+      'foo%5Ebar/bar%2Fbam/1/_source'
+    end
+
+    it 'URL-escapes the parts' do
+      expect(client_double.get_source(index: 'foo^bar', type: 'bar/bam', id: '1')).to eq({})
+    end
+  end
+
+  context 'when the request raises a NotFound error' do
+
+    before do
+      expect(client).to receive(:perform_request).and_raise(NotFound)
+    end
+
+    it 'raises the error' do
+      expect {
+        client.get_source(index: 'foo', id: '1')
+      }.to raise_exception(NotFound)
+    end
+  end
+end

data/spec/opensearch/api/actions/get_document_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#get' do
+
+  let(:expected_args) do
+    [
+        'GET',
+        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.get(type: 'bar', id: '1')
+    }.to raise_exception(ArgumentError)
+  end
+
+  it 'requires the :id argument' do
+    expect {
+      client.get(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.get(index: 'foo', id: '1')).to eq({})
+    end
+  end
+
+  context 'when URL parameters are provided' do
+
+    let(:params) do
+      { routing: 'abc123' }
+    end
+
+    it 'Passes the URL params' do
+      expect(client_double.get(index: 'foo', type: 'bar', id: '1', routing: 'abc123')).to eq({})
+    end
+  end
+
+  context 'when invalid URL parameters are provided' do
+
+    it 'Passes the URL params' do
+      expect {
+        client.get(index: 'foo', type: 'bar', id: '1', qwert: 'abc123')
+      }.to raise_exception(ArgumentError)
+    end
+  end
+
+  context 'when the request needs to be URL-escaped' do
+
+    let(:url) do
+      'foo%5Ebar/bar%2Fbam/1'
+    end
+
+    it 'URL-escapes the parts' do
+      expect(client_double.get(index: 'foo^bar', type: 'bar/bam', id: '1')).to eq({})
+    end
+  end
+
+  context 'when the request raises a NotFound error' do
+
+    before do
+      expect(client).to receive(:perform_request).and_raise(NotFound)
+    end
+
+    it 'raises an exception' do
+      expect {
+        client.get(index: 'foo', id: '1')
+      }.to raise_exception(NotFound)
+    end
+
+    context 'when the ignore option is provided' do
+
+      context 'when the response is 404' do
+
+        let(:params) do
+          { ignore: 404 }
+        end
+
+        it 'returns false' do
+          expect(client.get(index: 'foo', type: 'bar', id: '1', ignore: 404)).to eq(false)
+        end
+      end
+    end
+  end
+end

data/spec/opensearch/api/actions/get_script_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#get_script' do
+
+  let(:expected_args) do
+    [
+        'GET',
+        url,
+        params,
+        nil,
+        {}
+    ]
+  end
+
+  let(:params) do
+    { }
+  end
+
+  let(:url) do
+    '_scripts/foo'
+  end
+
+  context 'when the `lang` parameter is specificed' do
+
+    let(:params) do
+      { master_timeout: '1s' }
+    end
+
+    it 'performs the request' do
+      expect(client_double.get_script(master_timeout: '1s', id: 'foo')).to eq({})
+    end
+  end
+end

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

@@ -0,0 +1,98 @@
+# 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'
+require 'hashie'
+
+describe 'Hashie' do
+
+  let(:json) do
+    <<-JSON
+            {
+              "took": 14,
+              "timed_out": false,
+              "_shards": {
+                "total": 1,
+                "successful": 1,
+                "failed": 0
+              },
+              "hits": {
+                "total": 5,
+                "max_score": 0.51104903,
+                "hits": [
+                  {
+                    "_index": "myindex",
+                    "_type": "mytype",
+                    "_id": "1",
+                    "_score": 0.51104903,
+                    "_source": {
+                      "title": "Test 1",
+                      "tags": [
+                        "y",
+                        "z"
+                      ],
+                      "published": true,
+                      "published_at": "2013-06-22T21:13:00Z",
+                      "counter": 1
+                    }
+                  }
+                ]
+              },
+              "facets": {
+                "tags": {
+                  "_type": "terms",
+                  "missing": 0,
+                  "total": 10,
+                  "other": 0,
+                  "terms": [
+                    {
+                      "term": "z",
+                      "count": 4
+                    },
+                    {
+                      "term": "y",
+                      "count": 3
+                    },
+                    {
+                      "term": "x",
+                      "count": 3
+                    }
+                  ]
+                }
+              }
+            }
+    JSON
+  end
+
+  let(:response) do
+    Hashie::Mash.new MultiJson.load(json)
+  end
+
+  it 'wraps the response' do
+    expect(response.hits.hits.first._source.title).to eq('Test 1')
+    expect(response.facets.tags.terms.first.term).to eq('z')
+  end
+end

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

@@ -0,0 +1,146 @@
+# 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#index' do
+
+  let(:expected_args) do
+    [
+        request_type,
+        url,
+        params,
+        body,
+        {}
+    ]
+  end
+
+  let(:request_type) do
+    'POST'
+  end
+
+  let(:params) do
+    { }
+  end
+
+  let(:url) do
+    'foo/bar'
+  end
+
+  let(:body) do
+    { foo: 'bar' }
+  end
+
+  let(:client) do
+    Class.new { include OpenSearch::API }.new
+  end
+
+  it 'requires the :index argument' do
+    expect {
+      client.index(type: 'bar')
+    }.to raise_exception(ArgumentError)
+  end
+
+  it 'performs the request' do
+    expect(client_double.index(index: 'foo', type: 'bar', body: body)).to eq({})
+  end
+
+  context 'when a specific id is provided' do
+
+    let(:request_type) do
+      'PUT'
+    end
+
+    let(:url) do
+      'foo/bar/1'
+    end
+
+    it 'performs the request' do
+      expect(client_double.index(index: 'foo', type: 'bar', id: '1', body: body)).to eq({})
+    end
+  end
+
+  context 'when URL parameters are provided' do
+
+    let(:request_type) do
+      'POST'
+    end
+
+    let(:url) do
+      'foo/bar'
+    end
+
+    let(:params) do
+      { op_type: 'create' }
+    end
+
+    it 'passes the URL params' do
+      expect(client_double.index(index: 'foo', type: 'bar', op_type: 'create', body: body)).to eq({})
+    end
+
+    context 'when a specific id is provided' do
+
+      let(:request_type) do
+        'PUT'
+      end
+
+      let(:url) do
+        'foo/bar/1'
+      end
+
+      let(:params) do
+        { op_type: 'create' }
+      end
+
+      it 'passes the URL params' do
+        expect(client_double.index(index: 'foo', type: 'bar', id: '1', op_type: 'create', body: body)).to eq({})
+      end
+    end
+  end
+
+  context 'when the request needs to be URL-escaped' do
+    let(:request_type) do
+      'PUT'
+    end
+
+    let(:url) do
+      'foo/bar%2Fbam/123'
+    end
+
+    it 'URL-escapes the parts' do
+      expect(client_double.index(index: 'foo', type: 'bar/bam', id: '123', body: body)).to eq({})
+    end
+  end
+
+  context 'when an invalid URL parameter is provided' do
+
+    it 'raises and ArgumentError' do
+      expect {
+        client.index(index: 'foo', type: 'bar', id: '1', qwerty: 'yuiop')
+      }.to raise_exception(ArgumentError)
+    end
+  end
+end

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

@@ -0,0 +1,72 @@
+# 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.indices#add_block' do
+  let(:expected_args) do
+    [
+      'PUT',
+      url,
+      {},
+      nil,
+      {}
+    ]
+  end
+  let(:url) { "#{index}/_block/#{block}"}
+  let(:index) { 'test_index' }
+  let(:block) { 'test_block' }
+
+  it 'performs the request' do
+    expect(
+      client_double.indices.add_block(index: index, block: block)
+    ).to eq({})
+  end
+
+  context 'when an index is not specified' do
+    let(:client) do
+      Class.new { include OpenSearch::API }.new
+    end
+
+    it 'raises an argument error' do
+      expect do
+        client.indices.add_block(block: block)
+      end.to raise_exception(ArgumentError)
+    end
+  end
+
+  context 'when a block is not specified' do
+    let(:client) do
+      Class.new { include OpenSearch::API }.new
+    end
+
+    it 'raises an argument error' do
+      expect do
+        client.indices.add_block(index: index)
+      end.to raise_exception(ArgumentError)
+    end
+  end
+end

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

@@ -0,0 +1,77 @@
+# 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.indices#analyze' do
+  let(:expected_args) do
+    [
+      method,
+      url,
+      params,
+      body,
+      {}
+    ]
+  end
+  let(:method) { 'GET' }
+
+  let(:body) do
+    nil
+  end
+
+  let(:url) do
+    '_analyze'
+  end
+
+  let(:params) do
+    {}
+  end
+
+  it 'performs the request' do
+    expect(client_double.indices.analyze).to eq({})
+  end
+
+  context 'when an index is specified' do
+    let(:url) do
+      'foo/_analyze'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.analyze(index: 'foo')).to eq({})
+    end
+  end
+
+  context 'when a body is specified' do
+    let(:body) do
+      'foo'
+    end
+    let(:method) { 'POST' }
+
+    it 'performs the request' do
+      expect(client_double.indices.analyze(body: 'foo')).to eq({})
+    end
+  end
+end