opensearch-dsl 0.1.0

data/lib/opensearch/dsl/search/queries/term.rb

@@ -0,0 +1,52 @@
+# 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 Queries
+
+        # A query which returns documents matching the specified term
+        #
+        # @note The specified term is *not analyzed* (lowercased, stemmed, etc)
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         term category: 'Opinion'
+        #       end
+        #     end
+        #
+        #
+        class Term
+          include BaseComponent
+        end
+
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/queries/terms.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 Queries
+
+        # A query which returns documents matching the specified terms
+        #
+        # @note The specified terms are *not analyzed* (lowercased, stemmed, etc)
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         terms categories: ['World', 'Opinion']
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/query-dsl-common-terms-query.html
+        #
+        class Terms
+          include BaseComponent
+        end
+
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/queries/top_children.rb

@@ -0,0 +1,84 @@
+# 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 Queries
+
+        # A filter which returns parent documents for children documents matching a query
+        #
+        # @example Return articles with comments mentioning 'twitter', summing the score
+        #
+        #     search do
+        #       query do
+        #         top_children do
+        #           type  'comment'
+        #           query match: { body: 'twitter' }
+        #           score 'sum'
+        #         end
+        #       end
+        #     end
+        #
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/query-dsl-top-children-query.html
+        #
+        class TopChildren
+          include BaseComponent
+
+          option_method :type
+          option_method :score
+          option_method :factor
+          option_method :incremental_factor
+          option_method :_scope
+
+          # DSL method for building the `query` part of the query definition
+          #
+          # @return [self]
+          #
+          def query(*args, &block)
+            @query = block ? @query = Query.new(*args, &block) : args.first
+            self
+          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[self.name].update(query: _query)
+            end
+            hash
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/queries/wildcard.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 Queries
+
+        # A query which returns documents matching a wildcard expression
+        #
+        # @note The expression is *not analyzed* (lowercased, stemmed, etc)
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #        wildcard title: 'tw*'
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/query-dsl-wildcard-query.html
+        #
+        class Wildcard
+          include BaseComponent
+
+          option_method :value
+          option_method :boost
+        end
+
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/query.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
+
+      # Contains the classes for OpenSearch queries
+      #
+      module Queries;end
+
+      # Wraps the `query` part of a search definition
+      #
+      #
+      class Query
+        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)
+          if Queries.const_defined? klass
+            @value = Queries.const_get(klass).new *args, &block
+          else
+            raise NoMethodError, "undefined method '#{name}' for #{self}"
+          end
+        end
+
+        # Evaluates any block passed to the query
+        #
+        # @return [self]
+        #
+        def call
+          @block.arity < 1 ? self.instance_eval(&@block) : @block.call(self) if @block
+          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/sort.rb

@@ -0,0 +1,84 @@
+# 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 `sort` part of a search definition
+      #
+      #
+      class Sort
+        include BaseComponent
+
+        def initialize(*args, &block)
+          @value ||= []
+          super
+        end
+
+        # DSL method to specify sorting item
+        #
+        # @example
+        #
+        #     search do
+        #       sort do
+        #         by :category
+        #         by :clicks, order: 'desc'
+        #       end
+        #     end
+        #
+        def by(name, direction=nil)
+          @value << ( direction ? { name => direction } : name )
+          self
+        end
+
+        # Convert the definition to a Hash
+        #
+        # @return [Hash]
+        #
+        def to_hash
+          if @block
+            call unless @block_called
+            @block_called = true
+          else
+            @value << @args if @args && !@args.empty? && ! @value.include?(@args)
+          end
+
+          @hash = @value.flatten
+          @hash
+        end
+
+        # Return whether the definition is empty
+        #
+        # @return [Boolean]
+        #
+        def empty?
+          to_hash.empty?
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/suggest.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
+
+      # Wraps the `suggest` part of a search definition
+      #
+      #
+      class Suggest
+        include BaseComponent
+
+        def initialize(key, options={}, &block)
+          @key     = key
+          @options = options
+          @block   = block
+        end
+
+        # Convert the definition to a Hash
+        #
+        # @return [Hash]
+        #
+        def to_hash
+          { @key => @options }
+        end
+      end
+    end
+  end
+end