opensearch-ruby 2.1.0 → 3.0.0

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

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