opensearch-dsl 0.1.0

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

@@ -0,0 +1,119 @@
+# 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::Cardinality 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(cardinality: {})
+    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[:cardinality][:foo][:field]).to eq('bar')
+      end
+    end
+
+    describe '#precision_threshold' do
+
+      before do
+        search.precision_threshold('bar')
+      end
+
+      it 'applies the option' do
+        expect(search.to_hash[:cardinality][:foo][:precision_threshold]).to eq('bar')
+      end
+    end
+
+    describe '#rehash' do
+
+      before do
+        search.rehash('skip')
+      end
+
+      it 'applies the option' do
+        expect(search.to_hash[:cardinality][:foo][:rehash]).to eq('skip')
+      end
+    end
+
+    describe '#script' do
+
+      before do
+        search.script('bar')
+      end
+
+      it 'applies the option' do
+        expect(search.to_hash[:cardinality][:foo][:script]).to eq('bar')
+      end
+    end
+
+    describe '#params' do
+
+      before do
+        search.params('bar')
+      end
+
+      it 'applies the option' do
+        expect(search.to_hash[:cardinality][:foo][:params]).to eq('bar')
+      end
+    end
+  end
+
+  describe '#initialize' do
+
+    context 'when a block is provided' do
+
+      let(:search) do
+        described_class.new(:foo) do
+          field 'bar'
+        end
+      end
+
+      it 'executes the block' do
+        expect(search.to_hash).to eq({ cardinality: { foo: { field: 'bar' } } })
+      end
+    end
+  end
+end

data/spec/opensearch/dsl/search/aggregations/children_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::Aggregations::Children 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(children: {})
+    end
+  end
+
+  context 'when options methods are called' do
+
+    let(:search) do
+      described_class.new(:foo)
+    end
+
+    describe '#type' do
+
+      before do
+        search.type('bar')
+      end
+
+      it 'applies the option' do
+        expect(search.to_hash[:children][:foo][:type]).to eq('bar')
+      end
+    end
+  end
+
+  describe '#initialize' do
+
+    context 'when a block is provided' do
+
+      let(:search) do
+        described_class.new(:foo) do
+          type 'bar'
+        end
+      end
+
+      it 'executes the block' do
+        expect(search.to_hash).to eq({ children: { foo: { type: 'bar' } } })
+      end
+    end
+  end
+end

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

@@ -0,0 +1,108 @@
+# 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::Composite 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(composite: {})
+    end
+  end
+
+  context 'when options methods are called' do
+
+    let(:search) do
+      described_class.new(:foo)
+    end
+
+    describe '#size' do
+
+      before do
+        search.size(2_000)
+      end
+
+      it 'applies the option' do
+        expect(search.to_hash[:composite][:foo][:size]).to eq(2_000)
+      end
+    end
+
+    describe '#sources' do
+
+      before do
+        search.sources('bar')
+      end
+
+      it 'applies the option' do
+        expect(search.to_hash[:composite][:foo][:sources]).to eq('bar')
+      end
+    end
+
+    describe '#after' do
+      context 'when after is not given' do
+        before do
+          search.size(2_000)
+        end
+
+        it 'applies the option' do
+          expect(search.to_hash[:composite][:foo].keys).not_to include(:after)
+        end
+      end
+
+      context 'when after is given' do
+        before do
+          search.after('fake_after_key')
+        end
+
+        it 'applies the option' do
+          expect(search.to_hash[:composite][:foo][:after]).to eq('fake_after_key')
+        end
+      end
+    end
+  end
+
+  describe '#initialize' do
+
+    context 'when a block is provided' do
+
+      let(:search) do
+        described_class.new(:foo) do
+          size 2_000
+        end
+      end
+
+      it 'executes the block' do
+        expect(search.to_hash).to eq({ composite: { foo: { size: 2_000 } } })
+      end
+    end
+  end
+end

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

@@ -0,0 +1,198 @@
+# 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::DateHistogram 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(date_histogram: {})
+    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[:date_histogram][:foo][:field]).to eq('bar')
+      end
+    end
+
+    describe '#interval' do
+
+      before do
+        search.interval('bar')
+      end
+
+      it 'applies the option' do
+        expect(search.to_hash[:date_histogram][:foo][:interval]).to eq('bar')
+      end
+    end
+
+    describe '#pre_zone' do
+
+      before do
+        search.pre_zone('bar')
+      end
+
+      it 'applies the option' do
+        expect(search.to_hash[:date_histogram][:foo][:pre_zone]).to eq('bar')
+      end
+    end
+
+    describe '#post_zone' do
+
+      before do
+        search.post_zone('bar')
+      end
+
+      it 'applies the option' do
+        expect(search.to_hash[:date_histogram][:foo][:post_zone]).to eq('bar')
+      end
+    end
+
+    describe '#time_zone' do
+
+      before do
+        search.time_zone('bar')
+      end
+
+      it 'applies the option' do
+        expect(search.to_hash[:date_histogram][:foo][:time_zone]).to eq('bar')
+      end
+    end
+
+    describe '#pre_zone_adjust_large_interval' do
+
+      before do
+        search.pre_zone_adjust_large_interval('bar')
+      end
+
+      it 'applies the option' do
+        expect(search.to_hash[:date_histogram][:foo][:pre_zone_adjust_large_interval]).to eq('bar')
+      end
+    end
+
+    describe '#pre_offest' do
+
+      before do
+        search.pre_offset('bar')
+      end
+
+      it 'applies the option' do
+        expect(search.to_hash[:date_histogram][:foo][:pre_offset]).to eq('bar')
+      end
+    end
+
+    describe '#post_offset' do
+
+      before do
+        search.post_offset('bar')
+      end
+
+      it 'applies the option' do
+        expect(search.to_hash[:date_histogram][:foo][:post_offset]).to eq('bar')
+      end
+    end
+
+    describe '#format' do
+
+      before do
+        search.format('bar')
+      end
+
+      it 'applies the option' do
+        expect(search.to_hash[:date_histogram][:foo][:format]).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[:date_histogram][:foo][:min_doc_count]).to eq('bar')
+      end
+    end
+
+    describe '#extended_bounds' do
+
+      before do
+        search.extended_bounds('bar')
+      end
+
+      it 'applies the option' do
+        expect(search.to_hash[:date_histogram][:foo][:extended_bounds]).to eq('bar')
+      end
+    end
+
+    describe '#order' do
+
+      before do
+        search.order('bar')
+      end
+
+      it 'applies the option' do
+        expect(search.to_hash[:date_histogram][:foo][:order]).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'
+          interval 'day'
+          format   'yyyy-MM-dd'
+        end
+      end
+
+      it 'executes the block' do
+        expect(search.to_hash).to eq(date_histogram: { field: 'bar', interval: 'day', format: 'yyyy-MM-dd' })
+      end
+    end
+  end
+end

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

@@ -0,0 +1,98 @@
+# 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::DateRange 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(date_range: {})
+    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[:date_range][:foo][:field]).to eq('bar')
+      end
+    end
+
+    describe '#format' do
+
+      before do
+        search.format('bar')
+      end
+
+      it 'applies the option' do
+        expect(search.to_hash[:date_range][:foo][:format]).to eq('bar')
+      end
+    end
+
+    describe '#ranges' do
+
+      before do
+        search.ranges('bar')
+      end
+
+      it 'applies the option' do
+        expect(search.to_hash[:date_range][:foo][:ranges]).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'
+          ranges [ {to: 'foo'}, {from: 'bar'} ]
+        end
+      end
+
+      it 'executes the block' do
+        expect(search.to_hash).to eq(date_range: { field: 'bar', ranges: [ {to: 'foo'}, {from: 'bar'} ] })
+      end
+    end
+  end
+end

data/spec/opensearch/dsl/search/aggregations/extended_stats_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::ExtendedStats 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(extended_stats: {})
+    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(extended_stats: { foo: 'bar' })
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+# 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::Filter 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(filter: {})
+    end
+  end
+
+  context 'when another aggregation is nested' do
+
+    let(:search) do
+      described_class.new(terms: { foo: 'bar' }) do
+        aggregation :sum_clicks do
+          sum moo: 'bam'
+        end
+      end
+    end
+
+    it 'nests the aggregation in the hash' do
+      expect(search.to_hash).to eq(filter: { terms: { foo: 'bar' } },
+                                   aggregations: { sum_clicks: { sum: { moo: 'bam' } } })
+    end
+  end
+end