opensearch-ruby 2.1.0 → 3.0.0

data/lib/opensearch/dsl/search/queries/filtered.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 Queries
+        # A query which allows to combine a query with a filter
+        #
+        # @note It's possible and common to define just the `filter` part of the search definition,
+        #       for a structured search use case.
+        #
+        # @example Find documents about Twitter published last month
+        #
+        #     search do
+        #       query do
+        #         filtered do
+        #           query do
+        #             multi_match do
+        #               query 'twitter'
+        #               fields [ :title, :abstract, :content ]
+        #             end
+        #           end
+        #           filter do
+        #             range :published_on do
+        #               gte 'now-1M/M'
+        #             end
+        #           end
+        #         end
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/query-dsl-filtered-query.html
+        #
+        class Filtered
+          include BaseComponent
+
+          option_method :strategy
+
+          # DSL method for building the `query` part of the query definition
+          #
+          # @return [self]
+          #
+          def query(*args, &block)
+            @query = block ? @query = 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 ? 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/queries/function_score.rb

@@ -0,0 +1,122 @@
+# 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 Queries
+        # A query which allows to modify the score of documents matching the query,
+        # either via built-in functions or a custom script
+        #
+        # @example Find documents with specific amenities, boosting documents within a certain
+        #          price range and geogprahical location
+        #
+        #     search do
+        #       query do
+        #         function_score do
+        #           filter do
+        #             terms amenities: ['wifi', 'pets']
+        #           end
+        #           functions << { gauss: { price:    { origin: 100, scale: 200 } } }
+        #           functions << { gauss: { location: { origin: '50.090223,14.399590', scale: '5km' } } }
+        #         end
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/guide/current/function-score-query.html
+        #
+        class FunctionScore
+          include BaseComponent
+
+          option_method :script_score
+          option_method :boost
+          option_method :max_boost
+          option_method :score_mode
+          option_method :boost_mode
+
+          def initialize(*args, &block)
+            super
+            @functions = []
+          end
+
+          # DSL method for building the `query` part of the query definition
+          #
+          # @return [self]
+          #
+          def query(*args, &block)
+            @query = block ? @query = 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 ? Filter.new(*args, &block) : args.first
+            self
+          end
+
+          # DSL method for building the `functions` part of the query definition
+          #
+          # @return [Array]
+          #
+          def functions(value = nil)
+            if value
+              @functions = value
+            else
+              @functions
+            end
+          end
+
+          # Set the `functions` part of the query definition
+          #
+          # @return [Array]
+          #
+          attr_writer :functions
+
+          # 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[name].update(functions: @functions) unless @functions.empty?
+            hash
+          end
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/queries/fuzzy.rb

@@ -0,0 +1,69 @@
+# 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 Queries
+        # A query which uses a Levenshtein distance on string fields and plus-minus margin on numerical
+        # fields to match documents
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         fuzzy :name do
+        #           value 'Eyjafjallajökull'
+        #         end
+        #       end
+        #     end
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         fuzzy :published_on do
+        #           value '2014-01-01'
+        #           fuzziness '7d'
+        #         end
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/query-dsl-fuzzy-query.html
+        #
+        class Fuzzy
+          include BaseComponent
+
+          option_method :value
+          option_method :boost
+          option_method :fuzziness
+          option_method :prefix_length
+          option_method :max_expansions
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/queries/fuzzy_like_this.rb

@@ -0,0 +1,61 @@
+# 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 Queries
+        # A query which returns documents which are similar to the specified text
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         fuzzy_like_this do
+        #           like_text 'Eyjafjallajökull'
+        #           fields [:title, :abstract, :content]
+        #         end
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/query-dsl-flt-query.html
+        #
+        class FuzzyLikeThis
+          include BaseComponent
+
+          option_method :fields
+          option_method :like_text
+          option_method :fuzziness
+          option_method :analyzer
+          option_method :max_query_terms
+          option_method :prefix_length
+          option_method :boost
+          option_method :ignore_tf
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/queries/fuzzy_like_this_field.rb

@@ -0,0 +1,60 @@
+# 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 Queries
+        # A query which returns documents which are similar to the specified text,
+        # executed on a single field
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         fuzzy_like_this_field :content do
+        #           like_text 'Eyjafjallajökull'
+        #         end
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/query-dsl-flt-field-query.html
+        #
+        class FuzzyLikeThisField
+          include BaseComponent
+
+          option_method :like_text
+          option_method :fuzziness
+          option_method :analyzer
+          option_method :max_query_terms
+          option_method :prefix_length
+          option_method :boost
+          option_method :ignore_tf
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/queries/geo_shape.rb

@@ -0,0 +1,54 @@
+# 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 Queries
+        # A query which returns documents which fall into a specified geographical shape
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         geo_shape :location do
+        #           shape type: 'envelope',
+        #                 coordinates: [[14.2162566185,49.9415476869], [14.7149200439,50.1815123678]]
+        #         end
+        #       end
+        #     end
+        #
+        #
+        class GeoShape
+          include BaseComponent
+
+          option_method :shape
+          option_method :indexed_shape
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/queries/has_child.rb

@@ -0,0 +1,82 @@
+# 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 Queries
+        # A query which returns parent documents for children documents matching a query
+        #
+        # @example Return articles where John has commented
+        #
+        #     search do
+        #       query do
+        #         has_child do
+        #           type 'comment'
+        #           query do
+        #             match author: 'John'
+        #           end
+        #         end
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/query-dsl-has-child-query.html
+        #
+        class HasChild
+          include BaseComponent
+
+          option_method :type
+          option_method :score_mode
+          option_method :min_children
+          option_method :max_children
+          option_method :inner_hits
+
+          # DSL method for building the `query` part of the query definition
+          #
+          # @return [self]
+          #
+          def query(*args, &block)
+            @query = block ? @query = Query.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
+            hash
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,82 @@
+# 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 Queries
+        # A query which returns children documents for parent documents matching a query
+        #
+        # @example Return comments for articles about Ruby
+        #
+        #     search do
+        #       query do
+        #         has_parent do
+        #           type 'article'
+        #           query do
+        #             match title: 'Ruby'
+        #           end
+        #         end
+        #       end
+        #     end
+        #
+        # @example
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/query-dsl-has-parent-query.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 = Query.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
+            hash
+          end
+        end
+      end
+    end
+  end
+end

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