opensearch-ruby 2.1.0 → 3.0.0

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

@@ -0,0 +1,61 @@
+# 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 statistical information on numeric values
+        #
+        # @example Passing the options as a Hash
+        #
+        #     search do
+        #       aggregation :clicks_stats do
+        #         stats field: 'clicks'
+        #       end
+        #     end
+        #
+        # @example Passing the options as a block
+        #
+        #     search do
+        #       aggregation :clicks_stats do
+        #         stats do
+        #           field 'clicks'
+        #         end
+        #       end
+        #     end
+        #
+        #
+        class Stats
+          include BaseComponent
+
+          option_method :field
+          option_method :script
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/aggregations/sum.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 sum of numeric values
+        #
+        # @example
+        #
+        #     search do
+        #       aggregation :sum_clicks do
+        #         sum field: 'clicks'
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/search-aggregations-metrics-sum-aggregation.html
+        #
+        class Sum
+          include BaseComponent
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,66 @@
+# 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 the collection of terms and their document counts
+        #
+        # @example Passing the options as a Hash
+        #
+        #     aggregation :tags do
+        #       terms field: 'tags'
+        #     end
+        #
+        # @example Passing the options as a block
+        #
+        #     search do
+        #       aggregation :tags do
+        #         terms do
+        #           field 'tags'
+        #         end
+        #       end
+        #     end
+        #
+        #
+        class Terms
+          include BaseAggregationComponent
+
+          option_method :field
+          option_method :size
+          option_method :shard_size
+          option_method :order
+          option_method :min_doc_count
+          option_method :shard_min_doc_count
+          option_method :script
+          option_method :include
+          option_method :exclude
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/aggregations/top_hits.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 metric aggregator which returns the most relevant documents per bucket
+        #
+        # @example
+        #
+        #     search do
+        #       aggregation :tags do
+        #         terms do
+        #           field 'tags'
+        #
+        #           aggregation :top_hits do
+        #             top_hits sort: [ clicks: { order: 'desc' } ], _source: { include: 'title' }
+        #           end
+        #         end
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/search-aggregations-metrics-top-hits-aggregation.html
+        #
+        class TopHits
+          include BaseComponent
+
+          option_method :from
+          option_method :size
+          option_method :sort
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/aggregations/value_count.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 number of values for the aggregation scope
+        #
+        # @example
+        #
+        #     search do
+        #       aggregation :value_count do
+        #         value_count field: 'clicks'
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/search-aggregations-metrics-valuecount-aggregation.html
+        #
+        class ValueCount
+          include BaseComponent
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,83 @@
+# 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 containing common functionality for aggregation DSL classes
+      #
+      module BaseAggregationComponent
+        def self.included(base)
+          base.__send__ :include, BaseComponent
+          base.__send__ :include, InstanceMethods
+        end
+
+        module InstanceMethods
+          attr_reader :aggregations
+
+          # 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
+
+          # Adds a nested aggregation into the aggregation definition
+          #
+          # @return [self]
+          #
+          def aggregation(*args, &block)
+            @aggregations ||= AggregationsCollection.new
+            @aggregations.update args.first => Aggregation.new(*args, &block)
+            self
+          end
+
+          # Convert the aggregations to a Hash
+          #
+          # A default implementation, DSL classes can overload it.
+          #
+          # @return [Hash]
+          #
+          def to_hash(_options = {})
+            call
+
+            @hash = { name => @args } unless @hash && @hash[name] && !@hash[name].empty?
+
+            @hash[:aggregations] = @aggregations.to_hash if @aggregations
+            @hash
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,191 @@
+# 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 containing common functionality for DSL classes
+      #
+      module BaseComponent
+        def self.included(base)
+          base.__send__ :extend,  ClassMethods
+          base.__send__ :include, InstanceMethods
+
+          base.instance_eval do
+            #   Defines an "inner" method for DSL classes
+            #
+            #     @example Define a method `bar` for the MyQuery class which updates the query definition
+            #
+            #         class MyQuery
+            #           include BaseComponent
+            #
+            #           option_method :bar
+            #         end
+            #
+            #         q = MyQuery.new :foo do
+            #           bar 'TEST'
+            #         end
+            #
+            #         q.to_hash
+            #         # => {:myquery=>{:foo=>{:bar=>"TEST"}}}
+            #
+            #     @example Define a method `bar` with custom logic for updating the Hash with query definition
+            #
+            #         class MyCustomQuery
+            #           include BaseComponent
+            #
+            #           option_method :bar, lambda { |*args| @hash[self.name.to_sym][@args].update custom: args.pop }
+            #         end
+            #
+            #         q = MyCustomQuery.new :foo do
+            #           bar 'TEST'
+            #         end
+            #
+            #         q.to_hash
+            #       # => {:mycustomquery=>{:foo=>{:custom=>"TEST"}}}
+            #
+            def option_method(name, block = nil)
+              option_methods << name
+              if block
+                __send__ :define_method, name, &block
+              else
+                __send__ :define_method, name do |*args|
+                  # 1. Component has empty @args (ie. no user supplied name or @hash value)
+                  if @args.respond_to?(:to_hash) && @args&.empty?
+                    @hash[self.name.to_sym].update name.to_sym => args.first
+                  # 2. Component user-supplied name or @hash value passed in @args
+                  else
+                    @hash[self.name.to_sym] = { @args => {} } unless @hash[self.name.to_sym][@args]
+                    @hash[self.name.to_sym][@args].update name.to_sym => args.first
+                  end
+                end
+              end
+            end
+          end
+        end
+
+        def initialize(*args, &block)
+          @hash    = { name => {} }
+          @args    = args.first || {}
+          @options = args.size > 1 ? args.last : {}
+          @block   = block
+        end
+
+        module ClassMethods
+          # Get or set the name for the DSL class
+          #
+          # @example Set the index name for the `Article` model and re-evaluate it on each call
+          #
+          #     class MyQuery
+          #       include BaseComponent
+          #       name :my_special_query
+          #     end
+          #
+          #     MyQuery.name
+          #     # => :my_special_query
+          #
+          def name(value = nil)
+            if value
+              @name = value.to_sym
+            else
+              @name ||= begin
+                value = to_s.split('::').last
+                value.gsub!(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
+                value.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
+                value.tr!('-', '_')
+                value.downcase!
+                value.to_sym
+              end
+            end
+          end
+
+          # Set the name for the DSL class
+          #
+          def name=(value)
+            @name = value.to_sym
+          end
+
+          def option_methods
+            @option_methods ||= []
+          end
+        end
+
+        module InstanceMethods
+          # Return the name for instance of the DSL class
+          #
+          # @return [String]
+          #
+          def name
+            self.class.name
+          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
+
+          # Return true when the component definition is empty
+          #
+          def empty?
+            to_hash[name].respond_to?(:empty?) && to_hash[name].empty?
+          end
+
+          # Convert the query definition to a Hash
+          #
+          # A default implementation, DSL classes can overload it.
+          #
+          # @return [Hash]
+          #
+          def to_hash(_options = {})
+            # 1. Create hash from the block
+            if @block
+              @hash = @args && !@args.empty? ? { name => { @args => {} } } : { name => {} }
+              call
+              @hash[name.to_sym].update @options unless @options.empty?
+              @hash
+              # 2. Hash created with option methods
+            elsif @hash[name.to_sym] && !@args.is_a?(Hash) && @hash[name.to_sym][@args]
+              @hash[name.to_sym].update @options unless @options.empty?
+              @hash
+              # 3. Hash passsed as @args
+            elsif @hash[name.to_sym] && @args.respond_to?(:to_hash) && !@args.empty?
+              { name => @args.to_hash }
+              # 4. Hash already built
+            else
+              @hash
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,124 @@
+# 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 containing common functionality for a "compound" (wrapping) filters, such as `and`, `or`, `not`
+      #
+      module BaseCompoundFilterComponent
+        include Enumerable
+
+        def initialize(*args, &block)
+          super
+          @value = []
+        end
+
+        def self.included(base)
+          base.__send__ :include, InstanceMethods
+          base.__send__ :include, EnumerableMethods
+          base.__send__ :include, MethodDelegation
+        end
+
+        # Common functionality for the compound filter components
+        #
+        module InstanceMethods
+          # 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
+
+          # Convert the component to a Hash
+          #
+          # A default implementation, DSL classes can overload it.
+          #
+          # @return [Hash]
+          #
+          def to_hash(options = {})
+            if @value.empty? && !@block
+              @hash = super
+            elsif @block
+              call
+              @hash = { name.to_sym => @value.map(&:to_hash) }
+            else
+              @hash = { name.to_sym => @value }
+            end
+            @hash
+          end
+        end
+
+        # Implements the {Enumerable} methods
+        #
+        module EnumerableMethods
+          def each(&block)
+            @value.each(&block)
+          end
+
+          def slice(*args)
+            @value.slice(*args)
+          end; alias [] slice
+
+          def size
+            @value.size
+          end
+
+          def <<(value)
+            @value << value
+          end
+
+          def empty?
+            @value.empty?
+          end
+        end
+
+        module MethodDelegation
+          # 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
+        end
+      end
+    end
+  end
+end