opensearch-api 1.0.0 → 2.0.0

data/lib/opensearch/api/actions/indices/exists_type.rb

@@ -1,79 +0,0 @@
-# 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.
-
-module OpenSearch
-  module API
-    module Indices
-      module Actions
-        # Returns information about whether a particular document type exists. (DEPRECATED)
-        #
-        # @option arguments [List] :index A comma-separated list of index names; use `_all` to check the types across all indices
-        # @option arguments [List] :type A comma-separated list of document types to check
-        # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
-        # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
-        # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
-        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
-        # @option arguments [Hash] :headers Custom HTTP headers
-        #
-        #
-        def exists_type(arguments = {})
-          raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
-          raise ArgumentError, "Required argument 'type' missing" unless arguments[:type]
-
-          headers = arguments.delete(:headers) || {}
-
-          arguments = arguments.clone
-
-          _index = arguments.delete(:index)
-
-          _type = arguments.delete(:type)
-
-          method = OpenSearch::API::HTTP_HEAD
-          path   = "#{Utils.__listify(_index)}/_mapping/#{Utils.__listify(_type)}"
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-
-          body = nil
-
-          Utils.__rescue_from_not_found do
-            perform_request(method, path, params, body, headers).status == 200 ? true : false
-          end
-        end
-
-        alias_method :exists_type?, :exists_type
-
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:exists_type, [
-          :ignore_unavailable,
-          :allow_no_indices,
-          :expand_wildcards,
-          :local
-        ].freeze)
-      end
-    end
-  end
-end

data/lib/opensearch/api/actions/indices/flush_synced.rb

@@ -1,79 +0,0 @@
-# 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.
-
-module OpenSearch
-  module API
-    module Indices
-      module Actions
-        # Performs a synced flush operation on one or more indices. Synced flush is deprecated and will be removed in 8.0. Use flush instead
-        #
-        # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string for all indices
-        # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
-        # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
-        # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, none, all)
-        # @option arguments [Hash] :headers Custom HTTP headers
-        #
-        # *Deprecation notice*:
-        # Synced flush is deprecated and will be removed in 8.0. Use flush instead.
-        # Deprecated since version 7.6.0
-        #
-        #
-        #
-        def flush_synced(arguments = {})
-          headers = arguments.delete(:headers) || {}
-
-          arguments = arguments.clone
-
-          _index = arguments.delete(:index)
-
-          method = OpenSearch::API::HTTP_POST
-          path   = if _index
-                     "#{Utils.__listify(_index)}/_flush/synced"
-                   else
-                     "_flush/synced"
-                   end
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-
-          body = nil
-          if Array(arguments[:ignore]).include?(404)
-            Utils.__rescue_from_not_found { perform_request(method, path, params, body, headers).body }
-          else
-            perform_request(method, path, params, body, headers).body
-          end
-        end
-
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:flush_synced, [
-          :ignore_unavailable,
-          :allow_no_indices,
-          :expand_wildcards
-        ].freeze)
-      end
-    end
-  end
-end

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

@@ -1,117 +0,0 @@
-# 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#exists_type' do
-
-  let(:expected_args) do
-    [
-        'HEAD',
-        url,
-        params,
-        nil,
-        {}
-    ]
-  end
-
-  let(:params) do
-    {}
-  end
-
-  let(:url) do
-    'foo/_mapping/bar'
-  end
-
-  it 'performs the request' do
-    expect(client_double.indices.exists_type(index: 'foo', type: 'bar')).to eq(true)
-  end
-
-  it 'aliased to a predicate method' do
-    expect(client_double.indices.exists_type?(index: 'foo', type: 'bar')).to eq(true)
-  end
-
-  context 'when multiple indices are specified' do
-
-    let(:url) do
-      'foo,bar/_mapping/bam'
-    end
-
-    it 'performs the request' do
-      expect(client_double.indices.exists_type(index: ['foo','bar'], type: 'bam')).to eq(true)
-    end
-  end
-
-  context 'when the path needs to be URL-escaped' do
-
-    let(:url) do
-      'foo%5Ebar/_mapping/bar%2Fbam'
-    end
-
-    it 'performs the request' do
-      expect(client_double.indices.exists_type(index: 'foo^bar', type: 'bar/bam')).to eq(true)
-    end
-  end
-
-  context 'when 404 response is received' do
-
-    let(:response_double) do
-      double('response', status: 404, body: {}, headers: {})
-    end
-
-    it 'returns false' do
-      expect(client_double.indices.exists_type(index: 'foo', type: 'bar')).to eq(false)
-    end
-  end
-
-  context 'when a \'not found\' exception is raised' do
-
-    let(:client) do
-      Class.new { include OpenSearch::API }.new.tap do |_client|
-        expect(_client).to receive(:perform_request).with(*expected_args).and_raise(StandardError.new('404 Not Found'))
-      end
-    end
-
-    it 'returns false' do
-      expect(client.indices.exists_type(index: 'foo', type: 'bar')).to eq(false)
-    end
-  end
-
-  context 'when a generic exception is raised' do
-
-    let(:client) do
-      Class.new { include OpenSearch::API }.new.tap do |_client|
-        expect(_client).to receive(:perform_request).with(*expected_args).and_raise(StandardError.new)
-      end
-    end
-
-    it 'raises the exception' do
-      expect {
-        client.indices.exists_type(index: 'foo', type: 'bar')
-      }.to raise_exception(StandardError)
-    end
-  end
-end

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

@@ -1,99 +0,0 @@
-# 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#flush_synced' do
-
-  let(:expected_args) do
-    [
-        'POST',
-        url,
-        params,
-        nil,
-        {}
-    ]
-  end
-
-  let(:params) do
-    {}
-  end
-
-  let(:url) do
-    'foo/_flush/synced'
-  end
-
-  it 'performs the request' do
-    expect(client_double.indices.flush_synced(index: 'foo')).to eq({})
-  end
-
-  context 'when a \'not found\' exception is raised' do
-
-    let(:client) do
-      Class.new { include OpenSearch::API }.new.tap do |_client|
-        expect(_client).to receive(:perform_request).with(*expected_args).and_raise(NotFound)
-      end
-    end
-
-    it 'raises the exception' do
-      expect {
-        client.indices.flush_synced(index: 'foo')
-      }.to raise_exception(NotFound)
-    end
-  end
-
-  context 'when a \'not found\' exception is raised' do
-
-    let(:client) do
-      Class.new { include OpenSearch::API }.new.tap do |_client|
-        expect(_client).to receive(:perform_request).with(*expected_args).and_raise(NotFound)
-      end
-    end
-
-    it 'raises the exception' do
-      expect {
-        client.indices.flush_synced(index: 'foo')
-      }.to raise_exception(NotFound)
-    end
-  end
-
-  context 'when the ignore parameter is specified' do
-
-    let(:client) do
-      Class.new { include OpenSearch::API }.new.tap do |_client|
-        expect(_client).to receive(:perform_request).with(*expected_args).and_raise(StandardError.new('404 Not Found'))
-      end
-    end
-
-    let(:params) do
-      { ignore: 404 }
-    end
-
-    it 'does not raise the exception' do
-      expect(client.indices.flush_synced(index: 'foo', ignore: 404)).to eq(false)
-    end
-  end
-end