elasticsearch-api 6.0.1 → 7.0.0

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

@@ -0,0 +1,145 @@
+# 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 Elasticsearch::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: { foo: 'bar' })).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: { foo: 'bar' })).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
+
+    let(:body) do
+      nil
+    end
+
+    it 'passes the URL params' do
+      expect(client_double.index(index: 'foo', type: 'bar', op_type: 'create')).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')).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
+
+    let(:body) do
+      nil
+    end
+
+    it 'URL-escapes the parts' do
+      expect(client_double.index(index: 'foo', type: 'bar/bam', id: '123')).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/elasticsearch/api/actions/indices/analyze_spec.rb

@@ -0,0 +1,73 @@
+# 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
+    [
+        'GET',
+        url,
+        params,
+        body,
+        nil
+    ]
+  end
+
+  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
+
+    let(:params) do
+      { index: 'foo' }
+    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
+
+    it 'performs the request' do
+      expect(client_double.indices.analyze(body: 'foo')).to eq({})
+    end
+  end
+end

data/spec/elasticsearch/api/actions/indices/clear_cache_spec.rb

@@ -0,0 +1,84 @@
+# 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#clear_cache' do
+
+  let(:expected_args) do
+    [
+        'POST',
+        url,
+        params,
+        nil,
+        nil
+    ]
+  end
+
+  let(:url) do
+    '_cache/clear'
+  end
+
+  let(:params) do
+    {}
+  end
+
+  it 'performs the request' do
+    expect(client_double.indices.clear_cache).to eq({})
+  end
+
+  context 'when an index is specified' do
+
+    let(:url) do
+      'foo/_cache/clear'
+    end
+
+    let(:params) do
+      { index: 'foo' }
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.clear_cache(index: 'foo')).to eq({})
+    end
+  end
+
+  context 'when params are specified' do
+
+    let(:params) do
+      { fielddata: true }
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.clear_cache(fielddata: true)).to eq({})
+    end
+  end
+
+  context 'when the path must be URL-escaped' do
+
+    let(:url) do
+      'foo%5Ebar/_cache/clear'
+    end
+
+    let(:params) do
+      { index: 'foo^bar' }
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.clear_cache(index: 'foo^bar')).to eq({})
+    end
+  end
+end

data/spec/elasticsearch/api/actions/indices/close_spec.rb

@@ -0,0 +1,85 @@
+# 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#close' do
+
+  let(:expected_args) do
+    [
+        'POST',
+        url,
+        params,
+        nil,
+        nil
+    ]
+  end
+
+  let(:params) do
+    {}
+  end
+
+  context 'when there is no index specified' do
+
+    let(:client) do
+      Class.new { include Elasticsearch::API }.new
+    end
+
+    it 'raises an exception' do
+      expect {
+        client.indices.close
+      }.to raise_exception(ArgumentError)
+    end
+  end
+
+  context 'when an index is specified' do
+
+    let(:url) do
+      'foo/_close'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.close(index: 'foo')).to eq({})
+    end
+  end
+
+  context 'when params are specified' do
+
+    let(:params) do
+      { timeout: '1s' }
+    end
+
+    let(:url) do
+      'foo/_close'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.close(index: 'foo', timeout: '1s')).to eq({})
+    end
+  end
+
+  context 'when the path must be URL-escaped' do
+
+    let(:url) do
+      'foo%5Ebar/_close'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.close(index: 'foo^bar')).to eq({})
+    end
+  end
+end

data/spec/elasticsearch/api/actions/indices/create_spec.rb

@@ -0,0 +1,85 @@
+# 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#create' do
+
+  let(:expected_args) do
+    [
+        'PUT',
+        url,
+        params,
+        nil,
+        nil
+    ]
+  end
+
+  let(:params) do
+    {}
+  end
+
+  context 'when there is no index specified' do
+
+    let(:client) do
+      Class.new { include Elasticsearch::API }.new
+    end
+
+    it 'raises an exception' do
+      expect {
+        client.indices.create
+      }.to raise_exception(ArgumentError)
+    end
+  end
+
+  context 'when an index is specified' do
+
+    let(:url) do
+      'foo'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.create(index: 'foo')).to eq({})
+    end
+  end
+
+  context 'when params are specified' do
+
+    let(:params) do
+      { timeout: '1s' }
+    end
+
+    let(:url) do
+      'foo'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.create(index: 'foo', timeout: '1s')).to eq({})
+    end
+  end
+
+  context 'when the path must be URL-escaped' do
+
+    let(:url) do
+      'foo%5Ebar'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.create(index: 'foo^bar')).to eq({})
+    end
+  end
+end

data/spec/elasticsearch/api/actions/indices/delete_alias_spec.rb

@@ -0,0 +1,83 @@
+# 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#delete_alias' do
+
+  let(:expected_args) do
+    [
+        'DELETE',
+        url,
+        params,
+        nil,
+        nil
+    ]
+  end
+
+  let(:params) do
+    {}
+  end
+
+  context 'when there is no index specified' do
+
+    let(:client) do
+      Class.new { include Elasticsearch::API }.new
+    end
+
+    it 'raises an exception' do
+      expect {
+        client.indices.delete_alias(name: 'foo')
+      }.to raise_exception(ArgumentError)
+    end
+  end
+
+  context 'when there is no name specified' do
+
+    let(:client) do
+      Class.new { include Elasticsearch::API }.new
+    end
+
+    it 'raises an exception' do
+      expect {
+        client.indices.delete_alias(index: 'foo')
+      }.to raise_exception(ArgumentError)
+    end
+  end
+
+  context 'when an index and name are specified' do
+
+    let(:url) do
+      'foo/_alias/bar'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.delete_alias(index: 'foo', name: 'bar')).to eq({})
+    end
+  end
+
+  context 'when the path must be URL-escaped' do
+
+    let(:url) do
+      'foo%5Ebar/_alias/bar%2Fbam'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.delete_alias(index: 'foo^bar', name: 'bar/bam')).to eq({})
+    end
+  end
+end

data/spec/elasticsearch/api/actions/indices/delete_spec.rb

@@ -0,0 +1,108 @@
+# 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#delete' do
+
+  let(:expected_args) do
+    [
+        'DELETE',
+        url,
+        params,
+        nil,
+        nil
+    ]
+  end
+
+  let(:params) do
+    {}
+  end
+
+  let(:url) do
+    'foo'
+  end
+
+  it 'performs the request' do
+    expect(client_double.indices.delete(index: 'foo')).to eq({})
+  end
+
+  context 'when more than one index is specified' do
+
+    let(:url) do
+      'foo,bar'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.delete(index: ['foo', 'bar'])).to eq({})
+    end
+  end
+
+  context 'when params are specified' do
+
+    let(:params) do
+      { timeout: '1s' }
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.delete(index: 'foo', timeout: '1s')).to eq({})
+    end
+  end
+
+  context 'when the path must be URL-escaped' do
+
+    let(:url) do
+      'foo%5Ebar'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.delete(index: 'foo^bar')).to eq({})
+    end
+  end
+
+  context 'when a NotFound exception is raised by the request' do
+
+    let(:client) do
+      Class.new { include Elasticsearch::API }.new
+    end
+
+    before do
+      expect(client).to receive(:perform_request).and_raise(NotFound)
+    end
+
+    it 'raises the exception' do
+      expect {
+        client.indices.delete(index: 'foo')
+      }.to raise_exception(NotFound)
+    end
+  end
+
+  context 'when the ignore parameter is specified' do
+
+    let(:client) do
+      Class.new { include Elasticsearch::API }.new
+    end
+
+    before do
+      expect(client).to receive(:perform_request).and_raise(NotFound)
+    end
+
+    it 'ignores the code' do
+      expect(client.indices.delete(index: 'foo', ignore: 404)).to eq(false)
+    end
+  end
+end