opensearch-dsl 0.1.0

data/spec/spec_helper.rb

@@ -0,0 +1,33 @@
+# 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'
+require 'opensearch-dsl'
+
+RSpec.configure do |config|
+  config.formatter = 'documentation'
+  config.color = true
+end

data/test/integration/search_aggregation_children_test.rb

@@ -0,0 +1,91 @@
+# 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 'test_helper'
+
+module OpenSearch
+  module Test
+    class ChildrenAggregationIntegrationTest < ::OpenSearch::Test::IntegrationTestCase
+      include OpenSearch::DSL::Search
+
+      context "A children aggregation" do
+
+        setup do
+          @client.indices.create index: 'articles-and-comments', body: {
+              mappings: {
+                  properties: {
+                      title: {type: 'text'},
+                      category: {type: 'keyword'},
+                      join_field: {type: 'join', relations: {article: 'comment'}},
+                      author: {type: 'keyword'}
+                  }
+              }
+          }
+
+          @client.index index: 'articles-and-comments', id: 1,
+                        body: { title: 'A', category: 'one', join_field: 'article' }
+          @client.index index: 'articles-and-comments', id: 2,
+                        body: { title: 'B', category: 'one', join_field: 'article' }
+          @client.index index: 'articles-and-comments', id: 3,
+                        body: { title: 'C', category: 'two', join_field: 'article' }
+
+          @client.index index: 'articles-and-comments', routing: '1',
+                        body: { author: 'John', join_field: { name: 'comment', parent: 1 } }
+          @client.index index: 'articles-and-comments', routing: '1',
+                        body: { author: 'Mary', join_field: { name: 'comment', parent: 1 } }
+          @client.index index: 'articles-and-comments', routing: '2',
+                        body: { author: 'John', join_field: { name: 'comment', parent: 2 } }
+          @client.index index: 'articles-and-comments', routing: '2',
+                        body: { author: 'Dave', join_field: { name: 'comment', parent: 2 } }
+          @client.index index: 'articles-and-comments', routing: '3',
+                        body: { author: 'Ruth', join_field: { name: 'comment', parent: 3 } }
+          @client.indices.refresh index: 'articles-and-comments'
+        end
+
+        should "return the top commenters per article category" do
+          response = @client.search index: 'articles-and-comments', size: 0, body: search {
+            aggregation :top_categories do
+              terms field: 'category' do
+                aggregation :comments do
+                  children type: 'comment' do
+                    aggregation :top_authors do
+                      terms field: 'author'
+                    end
+                  end
+                end
+              end
+            end
+          }.to_hash
+
+          assert_equal 'one',  response['aggregations']['top_categories']['buckets'][0]['key']
+          assert_equal 3,      response['aggregations']['top_categories']['buckets'][0]['comments']['top_authors']['buckets'].size
+          assert_equal 'John', response['aggregations']['top_categories']['buckets'][0]['comments']['top_authors']['buckets'][0]['key']
+
+        end
+      end
+    end
+  end
+end

data/test/integration/search_aggregation_geo_test.rb

@@ -0,0 +1,111 @@
+# 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 'test_helper'
+
+module OpenSearch
+  module Test
+    class GeoAggregationIntegrationTest < ::OpenSearch::Test::IntegrationTestCase
+      include OpenSearch::DSL::Search
+
+      context "A geo aggregation" do
+
+        setup do
+          @client.indices.create index: 'venues-test', body: {
+              mappings: {
+                  properties: {
+                      location: {type: 'geo_point'}
+                  }
+              }
+          }
+          @client.index index: 'venues-test',
+                        body: { name: 'Space', location: "38.886214,1.403889" }
+          @client.index index: 'venues-test',
+                        body: { name: 'Pacha', location: "38.9184427,1.4433646" }
+          @client.index index: 'venues-test',
+                        body: { name: 'Amnesia', location: "38.948045,1.408341" }
+          @client.index index: 'venues-test',
+                        body: { name: 'Privilege', location: "38.958082,1.408288" }
+          @client.index index: 'venues-test',
+                        body: { name: 'Es Paradis', location: "38.979071,1.307394" }
+          @client.indices.refresh index: 'venues-test'
+        end
+
+        should "return the geo distances from a location" do
+          response = @client.search index: 'venues-test', size: 0, body: search {
+            aggregation :venue_distances do
+              geo_distance do
+                field  :location
+                origin '38.9126352,1.4350621'
+                unit   'km'
+                ranges [ { to: 1 }, { from: 1, to: 5 }, { from: 5, to: 10 }, { from: 10 } ]
+
+                aggregation :top_venues do
+                  top_hits _source: { include: 'name' }
+                end
+              end
+            end
+          }.to_hash
+
+          result = response['aggregations']['venue_distances']
+
+          assert_equal 4,       result['buckets'].size
+          assert_equal 1,       result['buckets'][0]['doc_count']
+          assert_equal 'Pacha', result['buckets'][0]['top_venues']['hits']['hits'][0]['_source']['name']
+
+          assert_equal 2,       result['buckets'][1]['top_venues']['hits']['total']['value']
+        end
+
+        should "return the geohash grid distribution" do
+          #
+          # See the geohash plot eg. at http://openlocation.org/geohash/geohash-js/
+          # See the locations visually eg. at http://geohash.org/sncj8h17r2
+          #
+          response = @client.search index: 'venues-test', size: 0, body: search {
+            aggregation :venue_distributions do
+              geohash_grid do
+                field     :location
+                precision 5
+
+                aggregation :top_venues do
+                  top_hits _source: { include: 'name' }
+                end
+              end
+            end
+          }.to_hash
+
+          result = response['aggregations']['venue_distributions']
+
+          assert_equal 4,       result['buckets'].size
+          assert_equal 'sncj8', result['buckets'][0]['key']
+          assert_equal 2,       result['buckets'][0]['doc_count']
+
+          assert_same_elements %w[ Privilege Amnesia ], result['buckets'][0]['top_venues']['hits']['hits'].map { |h| h['_source']['name'] }
+        end
+      end
+    end
+  end
+end

data/test/integration/search_aggregation_nested_test.rb

@@ -0,0 +1,128 @@
+# 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 'test_helper'
+
+module OpenSearch
+  module Test
+    class NestedAggregationIntegrationTest < ::OpenSearch::Test::IntegrationTestCase
+      include OpenSearch::DSL::Search
+
+      context "A nested aggregation" do
+
+        setup do
+          @client.indices.create index: 'products-test', body: {
+              mappings: {
+                  properties: {
+                      title: {type: 'text'},
+                      category: {type: 'keyword'},
+                      offers: {
+                          type: 'nested',
+                          properties: {
+                              name: {type: 'text'},
+                              price: {type: 'double'}
+                          }
+                      }
+                  }
+              }
+          }
+
+          @client.index index: 'products-test',
+                        body: { title: 'A',
+                                category: 'audio',
+                                offers: [ { name: 'A1', price: 100 }, { name: 'A2', price: 120 } ] }
+          @client.index index: 'products-test',
+                        body: { title: 'B',
+                                category: 'audio',
+                                offers: [ { name: 'B1', price: 200 }, { name: 'B2', price: 180 } ] }
+          @client.index index: 'products-test',
+                        body: { title: 'C',
+                                category: 'video',
+                                offers: [ { name: 'C1', price: 300 }, { name: 'C2', price: 350 } ] }
+          @client.indices.refresh index: 'products-test'
+        end
+
+        should "return the minimal price from offers" do
+          response = @client.search index: 'products-test', body: search {
+            query { match title: 'A' }
+
+            aggregation :offers do
+              nested do
+                path 'offers'
+                aggregation :min_price do
+                  min field: 'offers.price'
+                end
+              end
+            end
+          }.to_hash
+
+          assert_equal 100, response['aggregations']['offers']['min_price']['value'].to_i
+        end
+
+        should "return the top categories for offer price range" do
+          response = @client.search index: 'products-test', body: search {
+            query do
+              bool do
+                must do
+                  nested do
+                    path 'offers'
+                    query do
+                      bool do
+                        filter do
+                          range 'offers.price' do
+                            gte 100
+                            lte 300
+                          end
+                        end
+                      end
+                    end
+                  end
+                end
+              end
+            end
+
+            aggregation :offers do
+              nested do
+                path 'offers'
+                aggregation :top_categories do
+                  reverse_nested do
+                    aggregation :top_category_per_offer do
+                      terms field: 'category'
+                    end
+                  end
+                end
+              end
+            end
+          }.to_hash
+
+          assert_equal 2, response['aggregations']['offers']['top_categories']['top_category_per_offer']['buckets'].size
+          assert_equal 'audio', response['aggregations']['offers']['top_categories']['top_category_per_offer']['buckets'][0]['key']
+          assert_equal 'video', response['aggregations']['offers']['top_categories']['top_category_per_offer']['buckets'][1]['key']
+        end
+      end
+    end
+  end
+end

data/test/integration/search_aggregations_test.rb

@@ -0,0 +1,287 @@
+# 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 'test_helper'
+
+module OpenSearch
+  module Test
+    class AggregationsIntegrationTest < ::OpenSearch::Test::IntegrationTestCase
+      include OpenSearch::DSL::Search
+
+      context "Aggregations integration" do
+        setup do
+          @client.indices.create index: 'test', body: {
+              mappings: {
+                  properties: {
+                      tags: {type: 'keyword'}
+                  }
+              }
+          }
+          @client.index index: 'test', id: '1', body: { title: 'A', tags: %w[one], clicks: 5 }
+          @client.index index: 'test', id: '2', body: { title: 'B', tags: %w[one two], clicks: 15 }
+          @client.index index: 'test', id: '3', body: { title: 'C', tags: %w[one three], clicks: 20 }
+          @client.indices.refresh index: 'test'
+        end
+
+        context "with a terms aggregation" do
+          should "return tag counts" do
+            response = @client.search index: 'test', body: search {
+              aggregation :tags do
+                terms field: 'tags'
+              end
+            }.to_hash
+
+            assert_equal 3, response['aggregations']['tags']['buckets'].size
+            assert_equal 'one', response['aggregations']['tags']['buckets'][0]['key']
+          end
+
+          should "return approximate tag counts" do
+            response = @client.search index: 'test', body: search {
+              aggregation :tags do
+                cardinality field: 'tags'
+              end
+            }.to_hash
+
+            assert_equal 3, response['aggregations']['tags']['value']
+          end
+
+          should "return tag counts per clicks range as an inner (nested) aggregation" do
+            response = @client.search index: 'test', body: search {
+              aggregation :clicks do
+                range field: 'clicks' do
+                  key :low, to: 10
+                  key :mid, from: 10, to: 20
+
+                  aggregation :tags do
+                    terms field: 'tags'
+                  end
+                end
+              end
+            }.to_hash
+
+            assert_equal 2, response['aggregations']['clicks']['buckets'].size
+            assert_equal 1, response['aggregations']['clicks']['buckets']['low']['doc_count']
+            assert_equal 'one', response['aggregations']['clicks']['buckets']['low']['tags']['buckets'][0]['key']
+          end
+
+          should "define multiple aggregations" do
+            response = @client.search index: 'test', body: search {
+              aggregation :clicks do
+                range field: 'clicks' do
+                  key :low, to: 10
+                  key :mid, from: 10, to: 20
+
+                  aggregation :tags do
+                    terms { field 'tags' }
+                  end
+                end
+              end
+
+              aggregation :min_clicks do
+                min field: 'clicks'
+              end
+
+              aggregation :max_clicks do
+                max field: 'clicks'
+              end
+
+              aggregation :sum_clicks do
+                sum field: 'clicks'
+              end
+
+              aggregation :avg_clicks do
+                avg field: 'clicks'
+              end
+            }.to_hash
+
+            assert_equal 2, response['aggregations']['clicks']['buckets'].size
+            assert_equal 1, response['aggregations']['clicks']['buckets']['low']['doc_count']
+            assert_equal 'one', response['aggregations']['clicks']['buckets']['low']['tags']['buckets'][0]['key']
+
+            assert_equal 5,  response['aggregations']['min_clicks']['value']
+            assert_equal 20, response['aggregations']['max_clicks']['value']
+            assert_equal 40, response['aggregations']['sum_clicks']['value']
+            assert_equal 13, response['aggregations']['avg_clicks']['value'].to_i
+          end
+
+          should "define a global aggregation" do
+            response = @client.search index: 'test', body: search {
+                query do
+                  bool filter: { terms: { tags: ['two'] } }
+                end
+
+                aggregation :avg_clicks do
+                  avg field: 'clicks'
+                end
+
+                aggregation :all_documents do
+                  global do
+                    aggregation :avg_clicks do
+                      avg field: 'clicks'
+                    end
+                  end
+                end
+            }.to_hash
+
+            assert_equal 15, response['aggregations']['avg_clicks']['value'].to_i
+            assert_equal 13, response['aggregations']['all_documents']['avg_clicks']['value'].to_i
+          end
+
+          should "return statistics on clicks" do
+            response = @client.search index: 'test', body: search {
+              aggregation :stats_clicks do
+                stats field: 'clicks'
+              end
+              aggregation :value_count do
+                value_count field: 'clicks'
+              end
+            }.to_hash
+
+            assert_equal 3,  response['aggregations']['stats_clicks']['count']
+            assert_equal 5,  response['aggregations']['stats_clicks']['min']
+            assert_equal 20, response['aggregations']['stats_clicks']['max']
+            assert_equal 40, response['aggregations']['stats_clicks']['sum']
+            assert_equal 13, response['aggregations']['stats_clicks']['avg'].to_i
+            assert_equal 3,  response['aggregations']['value_count']['value']
+          end
+
+          should "return percentiles on clicks" do
+            response = @client.search index: 'test', body: search {
+              aggregation :percentiles do
+                percentiles field: 'clicks'
+              end
+            }.to_hash
+
+            assert_equal 20, response['aggregations']['percentiles']['values']['99.0'].round
+          end
+
+          should "return percentile ranks on clicks" do
+            response = @client.search index: 'test', body: search {
+              aggregation :percentiles do
+                percentile_ranks field: 'clicks', values: [5]
+              end
+            }.to_hash
+
+            assert_equal 17, response['aggregations']['percentiles']['values']['5.0'].round
+          end
+
+          should "return top hits per tag" do
+            response = @client.search index: 'test', body: search {
+              aggregation :tags do
+                terms do
+                  field 'tags'
+                  size  5
+
+                  aggregation :top_hits do
+                    top_hits sort: [ clicks: { order: 'desc' } ], _source: { include: 'title' }
+                  end
+                end
+              end
+            }.to_hash
+
+            assert_equal 3, response['aggregations']['tags']['buckets'][0]['top_hits']['hits']['hits'].size
+            assert_equal 'C', response['aggregations']['tags']['buckets'][0]['top_hits']['hits']['hits'][0]['_source']['title']
+          end
+
+          should "calculate clicks for a tag" do
+            response = @client.search index: 'test', body: search {
+              aggregation :clicks_for_one do
+                scripted_metric do
+                  init_script "state.transactions = []"
+                  map_script  "if (doc['tags'].value.contains('one')) { state.transactions.add(doc['clicks'].value) }"
+                  combine_script "double sum = 0; for (t in state.transactions) { sum += t } return sum"
+                  reduce_script "double sum = 0; for (a in states) { sum += a } return sum"
+                end
+              end
+            }.to_hash
+
+            assert_equal 40, response['aggregations']['clicks_for_one']['value']
+          end
+
+          should "limit the scope with a filter" do
+            response = @client.search index: 'test', body: search {
+              aggregation :clicks_for_one do
+                filter terms: { tags: ['one'] } do
+                  aggregation :sum_clicks do
+                    sum field: 'clicks'
+                  end
+                end
+              end
+            }.to_hash
+
+            assert_equal 40, response['aggregations']['clicks_for_one']['sum_clicks']['value']
+          end
+        end
+
+        should "return aggregations for multiple filters" do
+          response = @client.search index: 'test', body: search {
+            aggregation :avg_clicks_per_tag do
+              filters do
+                filters one: { terms: { tags: ['one'] } },
+                        two: { terms: { tags: ['two'] } }
+                aggregation :avg do
+                  avg field: 'clicks'
+                end
+              end
+            end
+          }.to_hash
+
+          assert_equal 13, response['aggregations']['avg_clicks_per_tag']['buckets']['one']['avg']['value'].to_i
+          assert_equal 15, response['aggregations']['avg_clicks_per_tag']['buckets']['two']['avg']['value'].to_i
+        end
+
+        should "return a histogram on clicks" do
+          response = @client.search index: 'test', body: search {
+            aggregation :clicks_histogram do
+              histogram do
+                field   'clicks'
+                interval 10
+              end
+            end
+          }.to_hash
+
+          assert_equal 3,  response['aggregations']['clicks_histogram']['buckets'].size
+          assert_equal 10, response['aggregations']['clicks_histogram']['buckets'][1]['key']
+          assert_equal 1,  response['aggregations']['clicks_histogram']['buckets'][1]['doc_count']
+        end
+
+        should "return a histogram with empty buckets on clicks" do
+          response = @client.search index: 'test', body: search {
+            aggregation :clicks_histogram do
+              histogram do
+                field   'clicks'
+                interval 2
+                min_doc_count 0
+              end
+            end
+          }.to_hash
+
+          assert_equal 9, response['aggregations']['clicks_histogram']['buckets'].size
+        end
+      end
+    end
+  end
+end