elasticsearch-api/spec/unit/actions/get_document_spec.rb

# 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,
        {},
        { defined_params: { id: '1', index: 'foo' }, endpoint: 'get' }
    ]
  end

  let(:params) do
    { }
  end

  let(:url) do
    'foo/_doc/1'
  end

  let(:client) do
    Class.new { include Elasticsearch::API }.new
  end

  it 'requires the :index argument' do
    expect {
      client.get(id: '1')
    }.to raise_exception(ArgumentError)
  end

  it 'requires the :id argument' do
    expect {
      client.get(index: 'foo')
    }.to raise_exception(ArgumentError)
  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', id: '1', routing: 'abc123')).to be_a Elasticsearch::API::Response
    end
  end

  context 'when the request needs to be URL-escaped' do
    let(:url) do
      'foo%5Ebar/_doc/1'
    end

    let(:expected_args) do
      [
        'GET',
        url,
        params,
        nil,
        {},
        { defined_params: { id: '1', index: 'foo^bar' }, endpoint: 'get' }
      ]
    end

    it 'URL-escapes the parts' do
      expect(client_double.get(index: 'foo^bar', id: '1')).to be_a Elasticsearch::API::Response
    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