opensearch-dsl 0.1.0

data/lib/opensearch/dsl/search.rb

@@ -0,0 +1,288 @@
+# 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
+
+    # Provides DSL methods for building the search definition
+    # (queries, filters, aggregations, sorting, etc)
+    #
+    module Search
+
+      # Initialize a new Search object
+      #
+      # @example Building a search definition declaratively
+      #
+      #     definition = search do
+      #       query do
+      #         match title: 'test'
+      #       end
+      #     end
+      #     definition.to_hash
+      #     => {:query=>{:match=>{:title=>"test"}}}
+      #
+      # @example Using the class imperatively
+      #
+      #     definition = Search.new
+      #     query = Queries::Match.new title: 'test'
+      #     definition.query query
+      #     definition.to_hash
+      #     # => {:query=>{:match=>{:title=>"test"}}}
+      #
+      #
+      def search(*args, &block)
+        Search.new(*args, &block)
+      end
+
+      extend self
+
+      # Wraps the whole search definition (queries, filters, aggregations, sorting, etc)
+      #
+      class Search
+        attr_reader :aggregations
+
+        def initialize(*args, &block)
+          @options = Options.new *args
+          block.arity < 1 ? self.instance_eval(&block) : block.call(self) if block
+        end
+
+        # DSL method for building or accessing the `query` part of a search definition
+        #
+        # @return [self, {Query}]
+        #
+        def query(*args, &block)
+          case
+            when block
+              @query = Query.new(*args, &block)
+              self
+            when !args.empty?
+              @query = args.first
+              self
+            else
+              @query
+          end
+        end
+
+        # Set the query part of a search definition
+        #
+        def query=(value)
+          query value
+        end
+
+        # DSL method for building the `filter` part of a search definition
+        #
+        # @return [self]
+        #
+        def filter(*args, &block)
+          case
+            when block
+              @filter = Filter.new(*args, &block)
+              self
+            when !args.empty?
+              @filter = args.first
+              self
+            else
+              @filter
+          end
+        end
+
+        # Set the filter part of a search definition
+        #
+        def filter=(value)
+          filter value
+        end
+
+        # DSL method for building the `post_filter` part of a search definition
+        #
+        # @return [self]
+        #
+        def post_filter(*args, &block)
+          case
+            when block
+              @post_filter = Filter.new(*args, &block)
+              self
+            when !args.empty?
+              @post_filter = args.first
+              self
+            else
+              @post_filter
+          end
+        end
+
+        # Set the post_filter part of a search definition
+        #
+        def post_filter=(value)
+          post_filter value
+        end
+
+        # DSL method for building the `aggregations` part of a search definition
+        #
+        # @return [self]
+        #
+        def aggregation(*args, &block)
+          @aggregations ||= AggregationsCollection.new
+
+          if block
+            @aggregations.update args.first => Aggregation.new(*args, &block)
+          else
+            name = args.shift
+            @aggregations.update name => args.shift
+          end
+          self
+        end
+
+        # Set the aggregations part of a search definition
+        #
+        def aggregations=(value)
+          @aggregations = value
+        end
+
+        # DSL method for building the `highlight` part of a search definition
+        #
+        # @return [self]
+        #
+        def highlight(*args, &block)
+          if !args.empty? || block
+            @highlight = Highlight.new(*args, &block)
+            self
+          else
+            @highlight
+          end
+        end
+
+        # DSL method for building the `sort` part of a search definition
+        #
+        # @return [self]
+        #
+        def sort(*args, &block)
+          if !args.empty? || block
+            @sort = Sort.new(*args, &block)
+            self
+          else
+            @sort
+          end
+        end
+
+        # Set the sort part of a search definition
+        #
+        def sort=(value)
+          @sort = value
+        end
+
+        # DSL method for building the `stored_fields` part of a search definition
+        #
+        # @return [self]
+        #
+        def stored_fields(value=nil)
+          if value
+            @stored_fields = value
+            self
+          else
+            @stored_fields
+          end
+        end; alias_method :stored_fields=, :stored_fields
+
+        # DSL method for building the `size` part of a search definition
+        #
+        # @return [self]
+        #
+        def size(value=nil)
+          if value
+            @size = value
+            self
+          else
+            @size
+          end
+        end; alias_method :size=, :size
+
+        # DSL method for building the `from` part of a search definition
+        #
+        # @return [self]
+        #
+        def from(value=nil)
+          if value
+            @from = value
+            self
+          else
+            @from
+          end
+        end; alias_method :from=, :from
+
+        # DSL method for building the `suggest` part of a search definition
+        #
+        # @return [self]
+        #
+        def suggest(*args, &block)
+          if !args.empty? || block
+            @suggest ||= {}
+            key, options = args
+            @suggest.update key => Suggest.new(key, options, &block)
+            self
+          else
+            @suggest
+          end
+        end
+
+        # Set the suggest part of a search definition
+        #
+        def suggest=(value)
+          @suggest = value
+        end
+
+        # Delegates to the methods provided by the {Options} class
+        #
+        def method_missing(name, *args, &block)
+          if @options.respond_to? name
+            @options.__send__ name, *args, &block
+            self
+          else
+            super
+          end
+        end
+
+        # Converts the search definition to a Hash
+        #
+        # @return [Hash]
+        #
+        def to_hash
+          hash = {}
+          hash.update(query: @query.to_hash)   if @query
+          hash.update(filter: @filter.to_hash) if @filter
+          hash.update(post_filter: @post_filter.to_hash) if @post_filter
+          hash.update(aggregations: @aggregations.reduce({}) { |sum,item| sum.update item.first => item.last.to_hash }) if @aggregations
+          hash.update(sort: @sort.to_hash) if @sort
+          hash.update(size: @size) if @size
+          hash.update(stored_fields: @stored_fields) if @stored_fields
+          hash.update(from: @from) if @from
+          hash.update(suggest: @suggest.reduce({}) { |sum,item| sum.update item.last.to_hash }) if @suggest
+          hash.update(highlight: @highlight.to_hash) if @highlight
+          hash.update(@options) unless @options.empty?
+          hash
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/utils.rb

@@ -0,0 +1,51 @@
+# 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
+
+    # Generic utility methods
+    #
+    module Utils
+
+      # Camelize an underscored string
+      #
+      # A lightweight version of ActiveSupport's `camelize`
+      #
+      # @example
+      #     __camelize('query_string')
+      #     # => 'QueryString'
+      #
+      # @api private
+      #
+      def __camelize(string)
+        string.to_s.split('_').map(&:capitalize).join
+      end
+
+      extend self
+    end
+  end
+end

data/lib/opensearch/dsl/version.rb

@@ -0,0 +1,31 @@
+# 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
+    VERSION = "0.1.0"
+  end
+end

data/lib/opensearch/dsl.rb

@@ -0,0 +1,72 @@
+# 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.
+
+require 'opensearch/dsl/version'
+
+require 'opensearch/dsl/utils'
+require 'opensearch/dsl/search/base_component'
+require 'opensearch/dsl/search/base_compound_filter_component'
+require 'opensearch/dsl/search/base_aggregation_component'
+require 'opensearch/dsl/search/query'
+require 'opensearch/dsl/search/filter'
+require 'opensearch/dsl/search/aggregation'
+require 'opensearch/dsl/search/highlight'
+require 'opensearch/dsl/search/sort'
+require 'opensearch/dsl/search/options'
+require 'opensearch/dsl/search/suggest'
+
+Dir[ File.expand_path('../dsl/search/queries/**/*.rb', __FILE__) ].each        { |f| require f }
+Dir[ File.expand_path('../dsl/search/filters/**/*.rb', __FILE__) ].each        { |f| require f }
+Dir[ File.expand_path('../dsl/search/aggregations/**/*.rb', __FILE__) ].each   { |f| require f }
+
+require 'opensearch/dsl/search'
+
+module OpenSearch
+
+  # The main module, which can be included into your own class or namespace,
+  # to provide the DSL methods.
+  #
+  # @example
+  #
+  #     include OpenSearch::DSL
+  #
+  #     definition = search do
+  #       query do
+  #         match title: 'test'
+  #       end
+  #     end
+  #
+  #     definition.to_hash
+  #     # => { query: { match: { title: "test"} } }
+  #
+  # @see Search
+  #
+  module DSL
+    def self.included(base)
+      base.__send__ :include, OpenSearch::DSL::Search
+    end
+  end
+end

data/lib/opensearch-dsl.rb

@@ -0,0 +1,27 @@
+# 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.
+
+require 'opensearch/dsl'

data/opensearch-dsl.gemspec

@@ -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.
+
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'opensearch/dsl/version'
+
+signing_key_path = File.expand_path("../gem-private_key.pem")
+
+Gem::Specification.new do |s|
+  s.name          = 'opensearch-dsl'
+  s.version       = OpenSearch::DSL::VERSION
+  s.authors       = ['Jayesh Hathila', 'Vamshi Vijay Nakkirtha', 'Vijayan Balasubramanian' , 'Yuvraj Jaiswal']
+  s.email         = ['jayehh@amazon.com', 'vamshin@amazon.com', 'balasvij@amazon.com', 'jaiyuvra@amazon.com']
+  s.description   = %q{A Ruby DSL builder for OpenSearch}
+  s.summary       = s.description
+  s.homepage      = 'https://opensearch.org/docs/latest/'
+  s.license       = 'Apache-2.0'
+  s.metadata = {
+    'homepage_uri' => 'https://opensearch.org/docs/latest/',
+    'source_code_uri' => 'https://github.com/opensearch-project/opensearch-ruby/tree/main/opensearch-dsl',
+    'bug_tracker_uri' => 'https://github.com/opensearch-project/opensearch-ruby/issues'
+  }
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+
+  if $PROGRAM_NAME.end_with?("gem") && ARGV == ["build", __FILE__] && File.exist?(signing_key_path)
+    s.signing_key = signing_key_path
+    s.cert_chain  = ['../certs/opensearch-rubygems.pem']
+  end
+
+  s.require_paths = ['lib']
+
+  s.extra_rdoc_files  = [ 'README.md', 'LICENSE' ]
+  s.rdoc_options      = [ '--charset=UTF-8' ]
+
+  s.required_ruby_version = '>= 2.4'
+
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'rake', '~> 13'
+
+  s.add_development_dependency 'opensearch'
+
+  s.add_development_dependency 'cane'
+  s.add_development_dependency 'minitest', '~> 5'
+  s.add_development_dependency 'minitest-reporters', '~> 1'
+  s.add_development_dependency 'mocha'
+  s.add_development_dependency 'pry'
+  s.add_development_dependency 'shoulda-context'
+  s.add_development_dependency 'simplecov', '~> 0.17', '< 0.18'
+  s.add_development_dependency 'yard'
+
+  if defined?(RUBY_VERSION) && RUBY_VERSION > '2.2'
+    s.add_development_dependency 'test-unit', '~> 2'
+  end
+end

data/spec/opensearch/dsl/search/aggregations/avg_spec.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.
+
+require 'spec_helper'
+
+describe OpenSearch::DSL::Search::Aggregations::Avg do
+
+  let(:search) do
+    described_class.new
+  end
+
+  describe '#to_hash' do
+
+    it 'can be converted to a hash' do
+      expect(search.to_hash).to eq(avg: {})
+    end
+  end
+
+  context '#initialize' do
+
+    let(:search) do
+      described_class.new(foo: 'bar')
+    end
+
+    it 'takes a hash' do
+      expect(search.to_hash).to eq(avg: { foo: 'bar' })
+    end
+  end
+end