opensearch-dsl 0.1.0

data/spec/opensearch/dsl/search/aggregations/terms_spec.rb

@@ -0,0 +1,174 @@
+# 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::Terms 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(terms: {})
+    end
+  end
+
+  context 'when options methods are called' do
+
+    let(:search) do
+      described_class.new(:foo)
+    end
+
+    describe '#field' do
+
+      before do
+        search.field('bar')
+      end
+
+      it 'applies the option' do
+        expect(search.to_hash[:terms][:foo][:field]).to eq('bar')
+      end
+    end
+
+    describe '#size' do
+
+      before do
+        search.size('bar')
+      end
+
+      it 'applies the option' do
+        expect(search.to_hash[:terms][:foo][:size]).to eq('bar')
+      end
+    end
+
+    describe '#shard_size' do
+
+      before do
+        search.shard_size('bar')
+      end
+
+      it 'applies the option' do
+        expect(search.to_hash[:terms][:foo][:shard_size]).to eq('bar')
+      end
+    end
+
+    describe '#order' do
+
+      before do
+        search.shard_size('bar')
+      end
+
+      it 'applies the option' do
+        expect(search.to_hash[:terms][:foo][:shard_size]).to eq('bar')
+      end
+    end
+
+    describe '#min_doc_count' do
+
+      before do
+        search.min_doc_count('bar')
+      end
+
+      it 'applies the option' do
+        expect(search.to_hash[:terms][:foo][:min_doc_count]).to eq('bar')
+      end
+    end
+
+    describe '#shard_min_doc_count' do
+
+      before do
+        search.shard_min_doc_count('bar')
+      end
+
+      it 'applies the option' do
+        expect(search.to_hash[:terms][:foo][:shard_min_doc_count]).to eq('bar')
+      end
+    end
+
+    describe '#include' do
+
+      before do
+        search.include('bar')
+      end
+
+      it 'applies the option' do
+        expect(search.to_hash[:terms][:foo][:include]).to eq('bar')
+      end
+    end
+
+    describe '#exclude' do
+
+      before do
+        search.exclude('bar')
+      end
+
+      it 'applies the option' do
+        expect(search.to_hash[:terms][:foo][:exclude]).to eq('bar')
+      end
+    end
+
+    describe '#script' do
+
+      before do
+        search.script('bar')
+      end
+
+      it 'applies the option' do
+        expect(search.to_hash[:terms][:foo][:script]).to eq('bar')
+      end
+    end
+  end
+
+  describe '#initialize' do
+
+    context 'when a hash is provided' do
+
+      let(:search) do
+        described_class.new(field: 'test')
+      end
+
+      it 'sets the value' do
+        expect(search.to_hash).to eq(terms: { field: 'test' })
+      end
+    end
+
+    context 'when a block is provided' do
+
+      let(:search) do
+        described_class.new do
+          field 'bar'
+        end
+      end
+
+      it 'executes the block' do
+        expect(search.to_hash).to eq(terms: { field: 'bar' })
+      end
+    end
+  end
+end

data/spec/opensearch/dsl/search/aggregations/top_hits_spec.rb

@@ -0,0 +1,97 @@
+# 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::TopHits 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(top_hits: {})
+    end
+  end
+
+  context 'when options methods are called' do
+
+    let(:search) do
+      described_class.new(:foo)
+    end
+
+    describe '#from' do
+
+      before do
+        search.from('bar')
+      end
+
+      it 'applies the option' do
+        expect(search.to_hash[:top_hits][:foo][:from]).to eq('bar')
+      end
+    end
+
+    describe '#size' do
+
+      before do
+        search.size('bar')
+      end
+
+      it 'applies the option' do
+        expect(search.to_hash[:top_hits][:foo][:size]).to eq('bar')
+      end
+    end
+
+    describe '#sort' do
+
+      before do
+        search.sort('bar')
+      end
+
+      it 'applies the option' do
+        expect(search.to_hash[:top_hits][:foo][:sort]).to eq('bar')
+      end
+    end
+  end
+
+  describe '#initialize' do
+
+    context 'when a block is provided' do
+
+      let(:search) do
+        described_class.new do
+          from 'bar'
+        end
+      end
+
+      it 'executes the block' do
+        expect(search.to_hash).to eq(top_hits: { from: 'bar' })
+      end
+    end
+  end
+end

data/spec/opensearch/dsl/search/aggregations/value_count_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::ValueCount 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(value_count: {})
+    end
+  end
+
+  context '#initialize' do
+
+    let(:search) do
+      described_class.new(foo: 'bar')
+    end
+
+    it 'sets the value' do
+      expect(search.to_hash).to eq(value_count: { foo: 'bar' })
+    end
+  end
+end

data/spec/opensearch/dsl/search/filters/and_spec.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.
+
+require 'spec_helper'
+
+describe OpenSearch::DSL::Search::Filters::And 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(and: {})
+    end
+  end
+
+  context 'when enumerable methods are called' do
+
+    before do
+      search << { term: { foo: 'bar' } }
+      search << { term: { moo: 'mam' } }
+    end
+
+    it 'behaves like an enumerable' do
+      expect(search.size).to eq(2)
+      expect(search[0][:term][:foo]).to eq('bar')
+      expect(search.any? { |d| d[:term] == { foo: 'bar' } }).to be(true)
+    end
+  end
+
+  describe '#initialize' do
+
+    context 'when a hash is provided' do
+
+      let(:search) do
+        described_class.new(filters: [ { term: { foo: 'bar' } } ])
+      end
+
+      it 'applies the hash' do
+        expect(search.to_hash).to eq(and: { filters: [ { term: { foo: 'bar' } } ] })
+      end
+    end
+
+    context 'when a block is provided' do
+
+      let(:search) do
+        described_class.new do
+          term foo: 'bar'
+          term moo: 'mam'
+        end
+      end
+
+      it 'executes the block' do
+        expect(search.to_hash).to eq(and: [ { term: { foo: 'bar' } }, { term: { moo: 'mam' } } ])
+      end
+    end
+  end
+end

data/spec/opensearch/dsl/search/filters/bool_spec.rb

@@ -0,0 +1,208 @@
+# 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::Filters::Bool 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(bool: {})
+    end
+  end
+
+  describe '#initialize' do
+
+    context 'when an object instance is provided' do
+
+      let(:search) do
+        described_class.new.must( OpenSearch::DSL::Search::Filters::Term.new foo: 'bar')
+      end
+
+      it 'applies the condition' do
+        expect(search.to_hash).to eq(bool: { must: [ { term: { foo: 'bar' } } ] })
+      end
+
+      context 'when the block calls multiple methods' do
+
+        let(:search) do
+          described_class.new do
+            must(OpenSearch::DSL::Search::Filters::Term.new foo: 'bar')
+            must_not(OpenSearch::DSL::Search::Filters::Term.new moo: 'bam')
+            should(OpenSearch::DSL::Search::Filters::Term.new xoo: 'bax')
+          end
+        end
+
+        it 'executes the block' do
+          expect(search.to_hash).to eq(bool:
+                                         { must:     [ { term: { foo: 'bar' } } ],
+                                           must_not: [ { term: { moo: 'bam' } } ],
+                                           should:   [ { term: { xoo: 'bax' } } ]
+                                         })
+        end
+      end
+
+      context 'when the block calls multiple conditions' do
+
+        let(:search) do
+          described_class.new do
+            must(OpenSearch::DSL::Search::Filters::Term.new foo: 'bar')
+            must(OpenSearch::DSL::Search::Filters::Term.new moo: 'bam')
+
+            should(OpenSearch::DSL::Search::Filters::Term.new xoo: 'bax')
+            should(OpenSearch::DSL::Search::Filters::Term.new zoo: 'baz')
+          end
+        end
+
+        it 'executes the block' do
+          expect(search.to_hash).to eq(bool:
+                                         { must:     [ { term: { foo: 'bar' } }, { term: { moo: 'bam' } } ],
+                                           should:   [ { term: { xoo: 'bax' } }, { term: { zoo: 'baz' } } ]
+                                         })
+        end
+      end
+    end
+
+    context 'when a hash is provided' do
+
+      let(:search) do
+        described_class.new(must: [ { term: { foo: 'bar' } } ])
+      end
+
+      it 'applies the hash' do
+        expect(search.to_hash).to eq(bool: { must: [ { term: { foo: 'bar' } } ] })
+      end
+    end
+
+    context 'when a block is provided' do
+
+      let(:search) do
+        described_class.new do
+          must { term foo: 'bar' }
+        end
+      end
+
+      it 'executes the block' do
+        expect(search.to_hash).to eq(bool: { must: [ { term: { foo: 'bar' } } ] })
+      end
+
+      context 'when the block calls multiple methods' do
+
+        let(:search) do
+          described_class.new do
+            must     { term foo: 'bar' }
+            must_not { term moo: 'bam' }
+            should   { term xoo: 'bax' }
+          end
+        end
+
+        it 'executes the block' do
+          expect(search.to_hash).to eq(bool:
+                                           { must:     [ { term: { foo: 'bar' } } ],
+                                             must_not: [ { term: { moo: 'bam' } } ],
+                                             should:   [ { term: { xoo: 'bax' } } ]
+                                           })
+        end
+      end
+
+      context 'when the block calls multiple conditions' do
+
+        let(:search) do
+          described_class.new do
+            must { term foo: 'bar' }
+            must { term moo: 'bam' }
+
+            should { term xoo: 'bax' }
+            should { term zoo: 'baz' }
+          end
+        end
+
+        it 'executes the block' do
+          expect(search.to_hash).to eq(bool:
+                                           { must:     [ { term: { foo: 'bar' } }, { term: { moo: 'bam' } } ],
+                                             should:   [ { term: { xoo: 'bax' } }, { term: { zoo: 'baz' } } ]
+                                           })
+        end
+      end
+    end
+  end
+
+  describe '#must' do
+
+    before do
+      search.must { term foo: 'bar' }
+    end
+
+    it 'applies the condition' do
+      expect(search.to_hash).to eq(bool: { must: [ { term: { foo: 'bar' } } ] })
+    end
+
+    context 'when the method is called more than once' do
+
+      before do
+        search.must { term foo: 'bar' }
+        search.must { term moo: 'bam' }
+      end
+
+      it 'applies the conditions' do
+        expect(search.to_hash).to eq(bool: { must: [ { term: { foo: 'bar' } }, { term: { moo: 'bam' } } ] })
+      end
+    end
+  end
+
+  describe '#should' do
+
+    before do
+      search.should { term xoo: 'bax' }
+    end
+
+    it 'applies the condition' do
+      expect(search.to_hash).to eq(bool: { should: [ { term: { xoo: 'bax' } } ] })
+    end
+  end
+
+  context 'when methods are chained' do
+
+    before do
+      search.must { term foo: 'bar' }
+      search.must { term foo: 'baz' }.must { term moo: 'bam' }
+      search.must_not { term foo: 'biz' }
+      search.should { term foo: 'bor' }
+    end
+
+    it 'applies all the conditions' do
+      expect(search.to_hash).to eq(bool: { must: [{ term: { foo: 'bar' } }, { term: { foo: 'baz' } },
+                                                  { term: { moo: 'bam' } }],
+                                                    must_not: [{ term: { foo: 'biz' } }],
+                                           should: [{ term: { foo: 'bor' } }] })
+    end
+  end
+end

data/spec/opensearch/dsl/search/filters/exists_spec.rb

@@ -0,0 +1,75 @@
+# 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::Filters::Exists 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(exists: {})
+    end
+  end
+
+  context 'when options methods are called' do
+
+    let(:search) do
+      described_class.new(:foo)
+    end
+
+    describe '#field' do
+
+      before do
+        search.field('bar')
+      end
+
+      it 'applies the option' do
+        expect(search.to_hash[:exists][:foo][:field]).to eq('bar')
+      end
+    end
+  end
+
+  describe '#initialize' do
+
+    context 'when a block is provided' do
+
+      let(:search) do
+        described_class.new do
+          field 'bar'
+        end
+      end
+
+      it 'executes the block' do
+        expect(search.to_hash).to eq(exists: { field: 'bar' })
+      end
+    end
+  end
+end