opensearch-ruby 2.1.0 → 3.0.0

data/lib/opensearch/dsl/search/filter.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 filters
+      #
+      module Filters; end
+
+      # Wraps the `filter` part of a search definition, aggregation, etc
+      #
+      #
+      class Filter
+        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 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
+
+        # 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

data/lib/opensearch/dsl/search/filters/and.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 an intersection of individual filters.
+        #
+        # @note Since `and` is a keyword in Ruby, use the `_and` method in DSL definitions
+        #
+        # @example Pass the filters as a Hash
+        #     search do
+        #       query do
+        #         filtered do
+        #           filter do
+        #             _and 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
+        #             _and do
+        #               term color: 'red'
+        #               term size:  'xxl'
+        #             end
+        #           end
+        #         end
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/query-dsl-and-filter.html
+        #
+        class And
+          include BaseComponent
+          include BaseCompoundFilterComponent
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,103 @@
+# 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 based on combinations of filters
+        #
+        # @example Defining a bool filter with multiple conditions
+        #
+        #     search do
+        #       query do
+        #         filtered do
+        #           filter do
+        #             bool do
+        #               must do
+        #                 term category: 'men'
+        #               end
+        #
+        #               must do
+        #                 term size:  'xxl'
+        #               end
+        #
+        #               should do
+        #                 term color: 'red'
+        #               end
+        #
+        #               must_not do
+        #                 term manufacturer: 'evil'
+        #               end
+        #             end
+        #           end
+        #         end
+        #       end
+        #     end
+        #
+        # See the integration test for a working example.
+        #
+        #
+        class Bool
+          include BaseComponent
+
+          def must(*args, &block)
+            @hash[name][:must] ||= []
+            value = args.empty? ? Filter.new(*args, &block).to_hash : args.first.to_hash
+            @hash[name][:must].push(value).flatten! unless @hash[name][:must].include?(value)
+            self
+          end
+
+          def must_not(*args, &block)
+            @hash[name][:must_not] ||= []
+            value = args.empty? ? Filter.new(*args, &block).to_hash : args.first.to_hash
+            @hash[name][:must_not].push(value).flatten! unless @hash[name][:must_not].include?(value)
+            self
+          end
+
+          def should(*args, &block)
+            @hash[name][:should] ||= []
+            value = args.empty? ? Filter.new(*args, &block).to_hash : args.first.to_hash
+            @hash[name][:should].push(value).flatten! unless @hash[name][:should].include?(value)
+            self
+          end
+
+          def to_hash
+            @hash[name].update(@args.to_hash) if @args.respond_to?(:to_hash)
+
+            if @block
+              call
+            else
+              @hash[name] = @args unless @args.nil? || @args.empty?
+            end
+
+            @hash
+          end
+        end
+      end
+    end
+  end
+end

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

data/lib/opensearch/dsl/search/filters/geo_bounding_box.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 Filters
+        # A filter which returns documents which fall into a "box" of the specified geographical coordinates
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         filtered do
+        #           filter do
+        #             geo_bounding_box :location do
+        #               top_right   "50.1815123678,14.7149200439"
+        #               bottom_left "49.9415476869,14.2162566185"
+        #             end
+        #           end
+        #         end
+        #       end
+        #     end
+        #
+        # See the integration test for a working example.
+        #
+        # Use eg. <http://boundingbox.klokantech.com> to visually define the bounding box.
+        #
+        # @see http://opensearch.org/guide/en/opensearch/guide/current/geo-bounding-box.html
+        #
+        class GeoBoundingBox
+          include BaseComponent
+
+          option_method :top_left
+          option_method :bottom_right
+          option_method :top_right
+          option_method :bottom_left
+          option_method :top
+          option_method :left
+          option_method :bottom
+          option_method :right
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,81 @@
+# 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 fall into a specified geographical distance
+        #
+        # @example Define the filter with a hash
+        #
+        #     search do
+        #       query do
+        #         filtered do
+        #           filter do
+        #             geo_distance location: '50.090223,14.399590', distance: '5km'
+        #           end
+        #         end
+        #       end
+        #     end
+        #
+        # @example Define the filter with a block
+        #
+        #     search do
+        #       query do
+        #         filtered do
+        #           filter do
+        #             geo_distance :location do
+        #               lat '50.090223'
+        #               lon '14.399590'
+        #               distance '5km'
+        #             end
+        #           end
+        #         end
+        #       end
+        #     end
+        #
+        # See the integration test for a working example.
+        #
+        # @see http://opensearch.org/guide/en/opensearch/guide/current/geo-distance.html
+        #
+        class GeoDistance
+          include BaseComponent
+
+          option_method :distance,      ->(*args) { @hash[name.to_sym].update distance: args.pop }
+          option_method :distance_type, ->(*args) { @hash[name.to_sym].update distance_type: args.pop }
+          option_method :lat,           ->(*args) { @hash[name.to_sym][@args].update lat: args.pop }
+          option_method :lon,           ->(*args) { @hash[name.to_sym][@args].update lon: args.pop }
+
+          def initialize(*args, &block)
+            super
+            @hash[name.to_sym] = { @args => {} } unless @args.empty?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/filters/geo_distance_range.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 which fall into a specified geographical distance range
+        #
+        # @example Define the filter with a hash
+        #
+        #     search do
+        #       query do
+        #         filtered do
+        #           filter do
+        #             geo_distance location: '50.090223,14.399590', gte: '2km', lte: '5km'
+        #           end
+        #         end
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/guide/current/geo-distance.html
+        #
+        class GeoDistanceRange
+          include BaseComponent
+
+          option_method :lat
+          option_method :lon
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+# 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 fall into a specified geographical polygon
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         filtered do
+        #           filter do
+        #             geo_polygon :location do
+        #               points [
+        #                [14.2244355,49.9419006],
+        #                [14.2244355,50.1774301],
+        #                [14.7067869,50.1774301],
+        #                [14.7067869,49.9419006],
+        #                [14.2244355,49.9419006]
+        #               ]
+        #             end
+        #           end
+        #         end
+        #       end
+        #     end
+        #
+        # See the integration test for a working example.
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/query-dsl-geo-polygon-filter.html
+        #
+        class GeoPolygon
+          include BaseComponent
+
+          option_method :points
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+# 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 fall into a specified geographical shape
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         filtered do
+        #           filter do
+        #             geo_shape :location do
+        #               shape type: 'envelope',
+        #                     coordinates: [[14.2162566185,49.9415476869], [14.7149200439,50.1815123678]]
+        #             end
+        #           end
+        #         end
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/query-dsl-geo-shape-filter.html
+        #
+        class GeoShape
+          include BaseComponent
+
+          option_method :shape
+          option_method :indexed_shape
+        end
+      end
+    end
+  end
+end