opensearch-ruby 1.0.0 → 3.1.0

data/lib/opensearch/dsl/search/filters/has_parent.rb

@@ -0,0 +1,97 @@
+# 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 DSL
+    module Search
+      module Filters
+        # A filter which returns children documents for parent documents matching a query or a filter
+        #
+        # @example Return comments for articles about Ruby
+        #
+        #     search do
+        #       query do
+        #         filtered do
+        #           filter do
+        #             has_parent do
+        #               type 'article'
+        #               query do
+        #                 match title: 'Ruby'
+        #               end
+        #             end
+        #           end
+        #         end
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/query-dsl-has-parent-filter.html
+        #
+        class HasParent
+          include BaseComponent
+
+          option_method :parent_type
+          option_method :score_mode
+          option_method :inner_hits
+
+          # DSL method for building the `query` part of the query definition
+          #
+          # @return [self]
+          #
+          def query(*args, &block)
+            @query = block ? @query = OpenSearch::DSL::Search::Query.new(*args, &block) : args.first
+            self
+          end
+
+          # DSL method for building the `filter` part of the query definition
+          #
+          # @return [self]
+          #
+          def filter(*args, &block)
+            @filter = block ? OpenSearch::DSL::Search::Filter.new(*args, &block) : args.first
+            self
+          end
+
+          # Converts the query definition to a Hash
+          #
+          # @return [Hash]
+          #
+          def to_hash
+            hash = super
+            if @query
+              _query = @query.respond_to?(:to_hash) ? @query.to_hash : @query
+              hash[name].update(query: _query)
+            end
+            if @filter
+              _filter = @filter.respond_to?(:to_hash) ? @filter.to_hash : @filter
+              hash[name].update(filter: _filter)
+            end
+            hash
+          end
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/filters/ids.rb

@@ -0,0 +1,56 @@
+# 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 DSL
+    module Search
+      module Filters
+        # A filter which returns documents matching the specified IDs
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         filtered do
+        #           filter do
+        #             ids values: [1, 2, 3]
+        #           end
+        #         end
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/query-dsl-ids-filter.html
+        #
+        class Ids
+          include BaseComponent
+
+          option_method :type
+          option_method :values
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/filters/indices.rb

@@ -0,0 +1,101 @@
+# 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 DSL
+    module Search
+      module Filters
+        # A filter which executes a custom filter only for documents in specified indices,
+        # and optionally another filter for documents in other indices
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         filtered do
+        #           filter do
+        #             indices do
+        #               indices ['audio', 'video']
+        #
+        #               filter do
+        #                 terms tags: ['music']
+        #               end
+        #
+        #               no_match_filter do
+        #                 terms tags: ['music', 'audio', 'video']
+        #               end
+        #             end
+        #           end
+        #         end
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/query-dsl-indices-filter.html
+        #
+        class Indices
+          include BaseComponent
+
+          option_method :indices
+
+          # DSL method for building the `filter` part of the query definition
+          #
+          # @return [self]
+          #
+          def filter(*args, &block)
+            @filter = block ? Filter.new(*args, &block) : args.first
+            self
+          end
+
+          # DSL method for building the `no_match_filter` part of the query definition
+          #
+          # @return [self]
+          #
+          def no_match_filter(*args, &block)
+            @no_match_filter = block ? Filter.new(*args, &block) : args.first
+            self
+          end
+
+          # Converts the query definition to a Hash
+          #
+          # @return [Hash]
+          #
+          def to_hash
+            hash = super
+            if @filter
+              _filter = @filter.respond_to?(:to_hash) ? @filter.to_hash : @filter
+              hash[name].update(filter: _filter)
+            end
+            if @no_match_filter
+              _no_match_filter = @no_match_filter.respond_to?(:to_hash) ? @no_match_filter.to_hash : @no_match_filter
+              hash[name].update(no_match_filter: _no_match_filter)
+            end
+            hash
+          end
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/filters/limit.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.
+
+module OpenSearch
+  module DSL
+    module Search
+      module Filters
+        # A filter which limits the number of documents to evaluate
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         filtered do
+        #           filter do
+        #             limit value: 100
+        #           end
+        #         end
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/query-dsl-limit-filter.html
+        #
+        class Limit
+          include BaseComponent
+
+          option_method :value
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/filters/match_all.rb

@@ -0,0 +1,52 @@
+# 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 DSL
+    module Search
+      module Filters
+        # A filter which matches on all documents
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         filtered do
+        #           filter do
+        #             match_all
+        #           end
+        #         end
+        #       end
+        #     end
+        #
+        #
+        class MatchAll
+          include BaseComponent
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/filters/missing.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.
+
+module OpenSearch
+  module DSL
+    module Search
+      module Filters
+        # A filter which returns documents which have a `null` value in the specified field
+        # (ie. the reverse of the `exists` filter)
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         filtered do
+        #           filter do
+        #             missing field: 'occupation'
+        #           end
+        #         end
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/query-dsl-missing-filter.html
+        #
+        class Missing
+          include BaseComponent
+
+          option_method :field
+          option_method :existence
+          option_method :null_value
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/filters/nested.rb

@@ -0,0 +1,91 @@
+# 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 DSL
+    module Search
+      module Filters
+        # A filter which executes another filter in the context of a nested document
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         filtered do
+        #           filter do
+        #             nested do
+        #               path 'comments'
+        #               filter do
+        #                 term 'comments.title' => 'Ruby'
+        #               end
+        #             end
+        #           end
+        #         end
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/query-dsl-nested-filter.html
+        #
+        class Nested
+          include BaseComponent
+
+          option_method :path
+
+          # DSL method for building the `filter` part of the query definition
+          #
+          # @return [self]
+          #
+          def filter(*args, &block)
+            @filter = block ? Filter.new(*args, &block) : args.first
+            self
+          end
+
+          def query(*args, &block)
+            @query = block ? OpenSearch::DSL::Search::Query.new(*args, &block) : args.first
+            self
+          end
+
+          # Converts the query definition to a Hash
+          #
+          # @return [Hash]
+          #
+          def to_hash
+            hash = super
+            if @filter
+              _filter = @filter.respond_to?(:to_hash) ? @filter.to_hash : @filter
+              hash[name].update(filter: _filter)
+            end
+            if @query
+              _query = @query.respond_to?(:to_hash) ? @query.to_hash : @query
+              hash[name].update(query: _query)
+            end
+            hash
+          end
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/filters/not.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.
+
+module OpenSearch
+  module DSL
+    module Search
+      module Filters
+        # A filter which takes out documents matching a filter from the results
+        #
+        # @note Since `not` is a keyword in Ruby, use the `_not` method in DSL definitions
+        #
+        # @example Pass the filter as a Hash
+        #     search do
+        #       query do
+        #         filtered do
+        #           filter do
+        #             _not term: { color: 'red' }
+        #           end
+        #         end
+        #       end
+        #     end
+        #
+        # @example Define the filter with a block
+        #
+        #     search do
+        #       query do
+        #         filtered do
+        #           filter do
+        #             _not do
+        #               term color: 'red'
+        #             end
+        #           end
+        #         end
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/query-dsl-not-filter.html
+        #
+        class Not
+          include BaseComponent
+
+          # Looks up the corresponding class for a method being invoked, and initializes it
+          #
+          # @raise [NoMethodError] When the corresponding class cannot be found
+          #
+          def method_missing(name, *args, &block)
+            klass = Utils.__camelize(name)
+            raise NoMethodError, "undefined method '#{name}' for #{self}" unless Filters.const_defined? klass
+            @value = Filters.const_get(klass).new(*args, &block)
+          end
+
+          def respond_to_missing?(method_name, include_private = false)
+            Filters.const_defined?(Utils.__camelize(method_name)) || super
+          end
+
+          # Convert the component to a Hash
+          #
+          # A default implementation, DSL classes can overload it.
+          #
+          # @return [Hash]
+          #
+          def to_hash(options = {})
+            if (!@value || @value.empty?) && !@block
+              @hash = super
+            elsif @block
+              call
+              @hash = { name.to_sym => @value.to_hash }
+            end
+            @hash
+          end
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/filters/or.rb

@@ -0,0 +1,70 @@
+# 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 DSL
+    module Search
+      module Filters
+        # A compound filter which matches documents by a union of individual filters.
+        #
+        # @note Since `or` is a keyword in Ruby, use the `_or` method in DSL definitions
+        #
+        # @example Pass the filters as a Hash
+        #     search do
+        #       query do
+        #         filtered do
+        #           filter do
+        #             _or filters: [ {term: { color: 'red' }}, {term: { size:  'xxl' }} ]
+        #           end
+        #         end
+        #       end
+        #     end
+        #
+        # @example Define the filters with a block
+        #
+        #     search do
+        #       query do
+        #         filtered do
+        #           filter do
+        #             _or do
+        #               term color: 'red'
+        #               term size:  'xxl'
+        #             end
+        #           end
+        #         end
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/query-dsl-or-filter.html
+        #
+        class Or
+          include BaseComponent
+          include BaseCompoundFilterComponent
+        end
+      end
+    end
+  end
+end