opensearch-ruby 1.0.0 → 3.1.0

data/lib/opensearch/dsl/search/queries/span_multi.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 a multi-term query as a span query
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         span_multi match: { prefix: { name: 'jo' } }
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/query-dsl-span-multi-term-query.html
+        # @see https://lucene.apache.org/core/5_0_0/core/org/apache/lucene/search/spans/package-summary.html
+        #
+        class SpanMulti
+          include BaseComponent
+
+          option_method :match
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/queries/span_near.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 Queries
+        # A query which returns documents matching spans near each other
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         span_near clauses: [ { span_term: { title: 'disaster' } }, { span_term: { title: 'health' } } ],
+        #                   slop: 10
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/query-dsl-span-near-query.html
+        # @see https://lucene.apache.org/core/5_0_0/core/org/apache/lucene/search/spans/package-summary.html
+        #
+        class SpanNear
+          include BaseComponent
+
+          option_method :span_near
+          option_method :slop
+          option_method :in_order
+          option_method :collect_payloads
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+# 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 discards matching documents which overlap with another query
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         span_not include: { span_term: { title: 'disaster' } },
+        #                  exclude: { span_term: { title: 'health' } }
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/query-dsl-span-not-query.html
+        # @see https://lucene.apache.org/core/5_0_0/core/org/apache/lucene/search/spans/package-summary.html
+        #
+        class SpanNot
+          include BaseComponent
+
+          option_method :include
+          option_method :exclude
+          option_method :pre
+          option_method :post
+          option_method :dist
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/queries/span_or.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 union of provided queries
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         span_or clauses: [ { span_term: { title: 'disaster' } }, { span_term: { title: 'health' } } ]
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/query-dsl-span-or-query.html
+        # @see https://lucene.apache.org/core/5_0_0/core/org/apache/lucene/search/spans/package-summary.html
+        #
+        class SpanOr
+          include BaseComponent
+
+          option_method :clauses
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+# 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 having a span containing a term
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         span_term title: 'disaster'
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/query-dsl-span-term-query.html
+        # @see https://lucene.apache.org/core/5_0_0/core/org/apache/lucene/search/spans/package-summary.html
+        #
+        class SpanTerm
+          include BaseComponent
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/queries/template.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 Queries
+        # A query which allows to use Mustache templates for query definitions
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         template do
+        #           query  match: { content: '{query_string}' }
+        #           params query_string: 'twitter'
+        #         end
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/query-dsl-template-query.html
+        #
+        class Template
+          include BaseComponent
+
+          option_method :query
+          option_method :params
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+# 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 term
+        #
+        # @note The specified term is *not analyzed* (lowercased, stemmed, etc)
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         term category: 'Opinion'
+        #       end
+        #     end
+        #
+        #
+        class Term
+          include BaseComponent
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# 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 terms
+        #
+        # @note The specified terms are *not analyzed* (lowercased, stemmed, etc)
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         terms categories: ['World', 'Opinion']
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/query-dsl-common-terms-query.html
+        #
+        class Terms
+          include BaseComponent
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/queries/top_children.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 filter which returns parent documents for children documents matching a query
+        #
+        # @example Return articles with comments mentioning 'twitter', summing the score
+        #
+        #     search do
+        #       query do
+        #         top_children do
+        #           type  'comment'
+        #           query match: { body: 'twitter' }
+        #           score 'sum'
+        #         end
+        #       end
+        #     end
+        #
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/query-dsl-top-children-query.html
+        #
+        class TopChildren
+          include BaseComponent
+
+          option_method :type
+          option_method :score
+          option_method :factor
+          option_method :incremental_factor
+          option_method :_scope
+
+          # 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/wildcard.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 matching a wildcard expression
+        #
+        # @note The expression is *not analyzed* (lowercased, stemmed, etc)
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #        wildcard title: 'tw*'
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/query-dsl-wildcard-query.html
+        #
+        class Wildcard
+          include BaseComponent
+
+          option_method :value
+          option_method :boost
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/query.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
+      # Contains the classes for OpenSearch queries
+      #
+      module Queries; end
+
+      # Wraps the `query` part of a search definition
+      #
+      #
+      class Query
+        def initialize(*_args, &block)
+          @block = block
+        end
+
+        # 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 Queries.const_defined? klass
+          @value = Queries.const_get(klass).new(*args, &block)
+        end
+
+        def respond_to_missing?(method_name, include_private = false)
+          Queries.const_defined?(Utils.__camelize(method_name)) || super
+        end
+
+        # Evaluates any block passed to the query
+        #
+        # @return [self]
+        #
+        def call
+          if @block
+            @block.arity < 1 ? instance_eval(&@block) : @block.call(self)
+          end
+          self
+        end
+
+        # Converts the query definition to a Hash
+        #
+        # @return [Hash]
+        #
+        def to_hash(_options = {})
+          call
+          if @value
+            @value.to_hash
+          else
+            {}
+          end
+        end
+      end
+    end
+  end
+end