opensearch-ruby 2.0.3 → 3.4.0

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

@@ -0,0 +1,112 @@
+# 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 aggregations
+      #
+      module Aggregations; end
+
+      class AggregationsCollection < Hash
+        # rubocop:disable Naming/MemoizedInstanceVariableName
+        def to_hash
+          @hash ||= transform_values(&:to_hash)
+        end
+        # rubocop:enable Naming/MemoizedInstanceVariableName
+      end
+
+      # Wraps the `aggregations` part of a search definition
+      #
+      #
+      class Aggregation
+        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 Aggregations.const_defined? klass
+          @value = Aggregations.const_get(klass).new(*args, &block)
+        end
+
+        def respond_to_missing?(method_name, include_private = false)
+          Aggregations.const_defined?(Utils.__camelize(method_name)) || super
+        end
+
+        # Defines an aggregation nested in another one
+        #
+        def aggregation(*args, &block)
+          call
+          @value.__send__ :aggregation, *args, &block
+        end
+
+        # Returns the aggregations
+        #
+        def aggregations
+          call
+          @value.__send__ :aggregations
+        end
+
+        # Evaluates the block passed to initializer, ensuring it is called just once
+        #
+        # @return [self]
+        #
+        # @api private
+        #
+        def call
+          if @block && !@_block_called
+            @block.arity < 1 ? instance_eval(&@block) : @block.call(self)
+          end
+          @_block_called = true
+          self
+        end
+
+        # Converts the object to a Hash
+        #
+        # @return [Hash]
+        #
+        def to_hash(_options = {})
+          call
+
+          if @value
+            if @value.respond_to?(:to_hash)
+              @value.to_hash
+            else
+              @value
+            end
+          else
+            {}
+          end
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/aggregations/avg.rb

@@ -0,0 +1,49 @@
+# 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 Aggregations
+        # A single-value metric aggregation which returns the average of numeric values
+        #
+        # @example
+        #
+        #     search do
+        #       aggregation :avg_clicks do
+        #         avg field: 'clicks'
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/search-aggregations-metrics-avg-aggregation.html
+        #
+        class Avg
+          include BaseComponent
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/aggregations/cardinality.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 Aggregations
+        # A single-value metric aggregation which returns the approximate count of distinct values
+        #
+        # @example
+        #
+        #     search do
+        #       aggregation :authors do
+        #         cardinality do
+        #           field 'author'
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/search-aggregations-metrics-cardinality-aggregation.html
+        #
+        class Cardinality
+          include BaseComponent
+
+          option_method :field
+          option_method :precision_threshold
+          option_method :rehash
+          option_method :script
+          option_method :params
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/aggregations/children.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 Aggregations
+        # A single-bucket aggregation which allows to aggregate from buckets on parent documents
+        # to buckets on the children documents
+        #
+        # @example Return the top commenters per article category
+        #
+        #     search do
+        #       aggregation :top_categories do
+        #         terms field: 'category' do
+        #           aggregation :comments do
+        #             children type: 'comment' do
+        #               aggregation :top_authors do
+        #                 terms field: 'author'
+        #               end
+        #             end
+        #           end
+        #         end
+        #       end
+        #     end
+        #
+        #
+        # See the integration test for a full example.
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/search-aggregations-bucket-children-aggregation.html
+        #
+        class Children
+          include BaseAggregationComponent
+
+          option_method :type
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/aggregations/composite.rb

@@ -0,0 +1,68 @@
+# 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 Aggregations
+        #
+        # A multi-bucket aggregation that creates composite buckets from different sources.
+        #
+        # @example
+        #
+        #  search do
+        #    aggregation :things do
+        #      composite do
+        #        size 2000
+        #        sources [
+        #          { thing1: { terms: { field: 'thing1.field1' } } },
+        #          { thing2: { terms: { field: 'thing2.field2' } } }
+        #        ]
+        #        after after_key
+        #      end
+        #    end
+        #  end
+        #
+        #
+        class Composite
+          include BaseAggregationComponent
+
+          option_method :size
+          option_method :sources
+          option_method :after
+
+          def to_hash(_options = {})
+            super
+            # remove :after if no value is given
+            @hash[name.to_sym].delete(:after) if @hash[name.to_sym].is_a?(Hash) && @hash[name.to_sym][:after].nil?
+
+            @hash
+          end
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/aggregations/date_histogram.rb

@@ -0,0 +1,64 @@
+# 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 Aggregations
+        # A multi-bucket aggregation which returns a histogram for date fields
+        #
+        # @example
+        #
+        #     search do
+        #       aggregation :daily do
+        #         field    'published_at'
+        #         interval 'day'
+        #         format   'yyyy-MM-dd'
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/search-aggregations-bucket-datehistogram-aggregation.html
+        #
+        class DateHistogram
+          include BaseAggregationComponent
+
+          option_method :field
+          option_method :interval
+          option_method :pre_zone
+          option_method :post_zone
+          option_method :time_zone
+          option_method :pre_zone_adjust_large_interval
+          option_method :pre_offset
+          option_method :post_offset
+          option_method :format
+          option_method :min_doc_count
+          option_method :extended_bounds
+          option_method :order
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/aggregations/date_range.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 Aggregations
+        # A multi-bucket aggregation which returns document counts for custom date ranges
+        #
+        # @example
+        #
+        #     search do
+        #       aggregation :compare_to_last_year do
+        #         date_range do
+        #           field    'published_at'
+        #           ranges [
+        #             { from: 'now-1M/M', to: 'now/M' },
+        #             { from: 'now-13M/M', to: 'now-12M/M' }
+        #           ]
+        #         end
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/search-aggregations-bucket-daterange-aggregation.html
+        #
+        class DateRange
+          include BaseAggregationComponent
+
+          option_method :field
+          option_method :format
+          option_method :ranges
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/aggregations/extended_stats.rb

@@ -0,0 +1,48 @@
+# 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 Aggregations
+        # A multi-value metrics aggregation which returns the extended statistical information on numeric values
+        #
+        # @example
+        #
+        #     search do
+        #       aggregation :clicks_stats do
+        #         extended_stats field: 'clicks'
+        #       end
+        #     end
+        #
+        #
+        class ExtendedStats
+          include BaseComponent
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/aggregations/filter.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 Aggregations
+        # Defines a single bucket with documents matching the provided filter,
+        # usually to define scope for a nested aggregation
+        #
+        # @example
+        #
+        #    search do
+        #      aggregation :clicks_for_tag_one do
+        #        filter terms: { tags: ['one'] } do
+        #          aggregation :sum_clicks do
+        #            sum field: 'clicks'
+        #          end
+        #        end
+        #      end
+        #    end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/search-aggregations-bucket-filters-aggregation.html
+        #
+        class Filter
+          include BaseAggregationComponent
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/aggregations/filters.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 Aggregations
+        # A multi-bucket aggregation which defines multiple buckets matching the provided filters,
+        # usually to define scope for a nested aggregation
+        #
+        # @example
+        #
+        #    search do
+        #      aggregation :avg_clicks_per_tag_one_and_two do
+        #        filters do
+        #          filters one: { terms: { tags: ['one'] } },
+        #                  two: { terms: { tags: ['two'] } }
+        #
+        #          aggregation :avg do
+        #            avg field: 'clicks'
+        #          end
+        #        end
+        #      end
+        #    end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/search-aggregations-bucket-filters-aggregation.html
+        #
+        class Filters
+          include BaseAggregationComponent
+
+          option_method :filters
+        end
+      end
+    end
+  end
+end