opensearch-ruby 1.0.0 → 3.1.0

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

@@ -0,0 +1,53 @@
+# 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 where the field value a specified prefix
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         filtered do
+        #           filter do
+        #             prefix path: '/usr/local'
+        #           end
+        #         end
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/query-dsl-prefix-filter.html
+        #
+        class Prefix
+          include BaseComponent
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,77 @@
+# 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 wraps a query so it can be used as a filter
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         filtered do
+        #           filter do
+        #             query do
+        #               query_string :title do
+        #                 query 'Ruby OR Python'
+        #               end
+        #             end
+        #           end
+        #         end
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/query-dsl-query-filter.html
+        #
+        class Query
+          include BaseComponent
+
+          def initialize(*args, &block)
+            super
+            return unless block
+            @query = OpenSearch::DSL::Search::Query.new(*args, &block)
+            @block = nil
+          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)
+            end
+            hash
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+# 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 that have terms in a specified range
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         filtered do
+        #           filter do
+        #             range :age do
+        #               gte 10
+        #               lte 20
+        #             end
+        #           end
+        #         end
+        #       end
+        #     end
+        #
+        #
+        class Range
+          include BaseComponent
+
+          option_method :gte
+          option_method :gt
+          option_method :lte
+          option_method :lt
+          option_method :boost
+          option_method :time_zone
+          option_method :format
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/filters/regexp.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 matching the specified regular expression
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         filtered do
+        #           filter do
+        #             regexp :path do
+        #               value '^/usr/?.*/var'
+        #             end
+        #           end
+        #         end
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/query-dsl-regexp-filter.html
+        #
+        class Regexp
+          include BaseComponent
+
+          option_method :value
+          option_method :flags
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/filters/script.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 criteria defined with a script
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         filtered do
+        #           filter do
+        #             script script: "doc['clicks'].value % 4 == 0"
+        #           end
+        #         end
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/query-dsl-script-filter.html
+        #
+        class Script
+          include BaseComponent
+
+          option_method :script
+          option_method :params
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/filters/term.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 returns documents matching the specified terms
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         filtered do
+        #           filter do
+        #             term color: 'red'
+        #           end
+        #         end
+        #       end
+        #     end
+        #
+        # @note The specified terms are *not analyzed* (lowercased, stemmed, etc),
+        #       so they must match the indexed terms.
+        #
+        #
+        class Term
+          include BaseComponent
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/filters/terms.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 any term from the specified list of terms
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         filtered do
+        #           filter do
+        #             terms tags: ['ruby', 'development']
+        #           end
+        #         end
+        #       end
+        #     end
+        #
+        # @note The specified terms are *not analyzed* (lowercased, stemmed, etc),
+        #       so they must match the indexed terms.
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/query-dsl-terms-filter.html
+        #
+        class Terms
+          include BaseComponent
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/filters/type.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 matching the specified type
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         filtered do
+        #           filter do
+        #             type do
+        #               value 'article'
+        #             end
+        #           end
+        #         end
+        #       end
+        #     end
+        #
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/query-dsl-type-filter.html
+        #
+        class Type
+          include BaseComponent
+
+          option_method :value
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/highlight.rb

@@ -0,0 +1,117 @@
+# 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
+      # Wraps the `highlight` part of a search definition
+      #
+      #
+      class Highlight
+        include BaseComponent
+
+        def initialize(*args, &block)
+          @value = args.pop || {}
+          super
+        end
+
+        # Specify the fields to highlight
+        #
+        # @example
+        #
+        #     search do
+        #       highlight do
+        #         fields [:title, :body]
+        #         field  :comments.body if options[:comments]
+        #       end
+        #     end
+        #
+        def fields(value_or_name)
+          value = case value_or_name
+                  when Hash
+                    value_or_name
+                  when Array
+                    value_or_name.each_with_object({}) do |item, sum|
+                      sum.update item.to_sym => {}
+                    end
+                  end
+
+          (@value[:fields] ||= {}).update value
+          self
+        end
+
+        # Specify a single field to highlight
+        #
+        # @example
+        #
+        #     search do
+        #       highlight do
+        #         field :title, fragment_size: 0
+        #         field :body if options[:comments]
+        #       end
+        #     end
+        #
+        def field(name, options = {})
+          (@value[:fields] ||= {}).update name.to_sym => options
+        end
+
+        # Specify the opening tags for the highlighted snippets
+        #
+        def pre_tags(*value)
+          @value[:pre_tags] = value.flatten
+        end; alias pre_tags= pre_tags
+
+        # Specify the closing tags for the highlighted snippets
+        #
+        def post_tags(*value)
+          @value[:post_tags] = value.flatten
+        end; alias post_tags= post_tags
+
+        # Specify the `encoder` option for highlighting
+        #
+        def encoder(value)
+          @value[:encoder] = value
+        end; alias encoder= encoder
+
+        # Specify the `tags_schema` option for highlighting
+        #
+        def tags_schema(value)
+          @value[:tags_schema] = value
+        end; alias tags_schema= tags_schema
+
+        # Convert the definition to a Hash
+        #
+        # @return [Hash]
+        #
+        def to_hash
+          call
+          @hash = @value
+          @hash
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/options.rb

@@ -0,0 +1,80 @@
+# 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
+      # Wraps the "extra" options of a search definition
+      #
+      #
+      class Options
+        DSL_METHODS = %i[
+          _source
+          fields
+          script_fields
+          fielddata_fields
+          rescore
+          explain
+          version
+          indices_boost
+          track_scores
+          min_score
+          track_total_hits
+        ]
+
+        def initialize(*_args)
+          @hash = {}
+        end
+
+        # Defines a method for each valid search definition option
+        #
+        DSL_METHODS.each do |name|
+          define_method name do |*args|
+            @hash[name] = args.pop
+          end
+
+          define_method name.to_s.gsub(/^_(.*)/, '\1') do |*args|
+            @hash[name] = args.pop
+          end
+        end
+
+        # Returns true when there are no search options defined
+        #
+        def empty?
+          @hash.empty?
+        end
+
+        # Convert the definition to a Hash
+        #
+        # @return [Hash]
+        #
+        def to_hash(_options = {})
+          @hash
+        end
+      end
+    end
+  end
+end