opensearch-dsl 0.1.0

data/test/integration/search_filters_test.rb

@@ -0,0 +1,290 @@
+# 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.
+
+# encoding: UTF-8
+
+require 'test_helper'
+
+module OpenSearch
+  module Test
+    class FiltersIntegrationTest < ::OpenSearch::Test::IntegrationTestCase
+      include OpenSearch::DSL::Search
+
+      context "Filters integration" do
+        setup do
+          @client.indices.create index: 'test'
+          @client.index index: 'test', id: 1,
+                        body: { name: 'Original',
+                                color: 'red',
+                                size: 'xxl',
+                                category: 'unisex',
+                                manufacturer: 'a' }
+
+          @client.index index: 'test', id: 2,
+                        body: { name: 'Original',
+                                color: 'red',
+                                size: 'xl',
+                                category: 'unisex',
+                                manufacturer: 'a' }
+
+          @client.index index: 'test', id: 3,
+                        body: { name: 'Original',
+                                color: 'red',
+                                size: 'l',
+                                category: 'unisex',
+                                manufacturer: 'a' }
+
+          @client.index index: 'test', id: 4,
+                        body: { name: 'Western',
+                                color: 'red',
+                                size: 'm',
+                                category: 'men',
+                                manufacturer: 'c' }
+
+          @client.index index: 'test', id: 5,
+                        body: { name: 'Modern',
+                                color: 'grey',
+                                size: 'l',
+                                category: 'men',
+                                manufacturer: 'b' }
+
+          @client.index index: 'test', id: 6,
+                        body: { name: 'Modern',
+                                color: 'grey',
+                                size: 's',
+                                category: 'men',
+                                manufacturer: 'b' }
+
+          @client.index index: 'test', id: 7,
+                        body: { name: 'Modern',
+                                color: 'grey',
+                                size: 's',
+                                category: 'women',
+                                manufacturer: 'b' }
+
+          @client.indices.refresh index: 'test'
+        end
+
+        context "term filter" do
+          should "return matching documents" do
+            response = @client.search index: 'test', body: search {
+              query do
+                bool do
+                  filter do
+                    term color: 'red'
+                  end
+                end
+              end
+            }.to_hash
+
+            assert_equal 4, response['hits']['total']['value']
+            assert response['hits']['hits'].all? { |h| h['_source']['color'] == 'red'  }, response.inspect
+          end
+        end
+
+        context "terms filter" do
+          should "return matching documents" do
+            response = @client.search index: 'test', body: search {
+              query do
+                bool do
+                  filter do
+                    terms color: ['red', 'grey', 'gold']
+                  end
+                end
+              end
+            }.to_hash
+
+            assert_equal 7, response['hits']['total']['value']
+          end
+        end
+
+        context "bool filter" do
+          should "return correct documents" do
+            response = @client.search index: 'test', body: search {
+              query do
+                bool do
+                  filter do
+                    bool do
+                      must do
+                        term size:  'l'
+                      end
+
+                      should do
+                        term color: 'red'
+                      end
+
+                      should do
+                        term category: 'men'
+                      end
+
+                      must_not do
+                        term manufacturer: 'b'
+                      end
+                    end
+                  end
+                end
+              end
+            }.to_hash
+
+            assert_equal 1,   response['hits']['hits'].size
+            assert_equal '3', response['hits']['hits'][0]['_id'].to_s
+          end
+        end
+
+        context "geographical filters" do
+          setup do
+            @client.indices.create index: 'places', body: {
+                mappings: {
+                    properties: {
+                        location: {
+                            type: 'geo_point'
+                        }
+                    }
+                }
+            }
+            @client.index index: 'places', id: 1,
+                          body: { name: 'Vyšehrad',
+                                  location: '50.064399, 14.420018'}
+
+            @client.index index: 'places', id: 2,
+                          body: { name: 'Karlštejn',
+                                  location: '49.939518, 14.188046'}
+
+            @client.indices.refresh index: 'places'
+          end
+
+          should "find documents within the bounding box" do
+            response = @client.search index: 'places', body: search {
+              query do
+                bool do
+                  filter do
+                    geo_bounding_box :location do
+                      top_right   "50.1815123678,14.7149200439"
+                      bottom_left "49.9415476869,14.2162566185"
+                    end
+                  end
+                end
+              end
+            }.to_hash
+
+            assert_equal 1, response['hits']['hits'].size
+            assert_equal 'Vyšehrad', response['hits']['hits'][0]['_source']['name']
+          end
+
+          should "find documents within the distance specified with a hash" do
+            response = @client.search index: 'places', body: search {
+              query do
+                bool do
+                  filter do
+                    geo_distance location: '50.090223,14.399590', distance: '5km'
+                  end
+                end
+              end
+            }.to_hash
+
+            assert_equal 1, response['hits']['hits'].size
+            assert_equal 'Vyšehrad', response['hits']['hits'][0]['_source']['name']
+          end
+
+          should "find documents within the distance specified with a block" do
+            response = @client.search index: 'places', body: search {
+              query do
+                bool do
+                  filter do
+                    geo_distance :location do
+                      lat '50.090223'
+                      lon '14.399590'
+                      distance '5km'
+                    end
+                  end
+                end
+              end
+            }.to_hash
+
+            assert_equal 1, response['hits']['hits'].size
+            assert_equal 'Vyšehrad', response['hits']['hits'][0]['_source']['name']
+          end
+
+          should "find documents within the geographical distance range" do
+            response = @client.search index: 'places', body: search {
+              query do
+                bool do
+                  filter do
+                    geo_distance location: { lat: '50.090223', lon: '14.399590' },
+                                       distance: '50km'
+                  end
+                end
+              end
+              aggregation :distance_ranges do
+                geo_distance do
+                  field  :location
+                  origin '50.090223,14.399590'
+                  unit   'km'
+                  ranges [ { from: 10, to: 50 } ]
+
+                  aggregation :results do
+                    top_hits _source: { include: 'name' }
+                  end
+                end
+              end
+            }.to_hash
+
+            assert_equal 2, response['hits']['hits'].size
+
+            bucket = response['aggregations']['distance_ranges']['buckets'][0]
+
+            assert_equal 1, bucket['doc_count']
+            assert_equal 1, bucket['results']['hits']['hits'].size
+            assert_equal 'Karlštejn', bucket['results']['hits']['hits'][0]['_source']['name']
+          end
+
+          should "find documents within the polygon" do
+            response = @client.search index: 'places', body: search {
+              query do
+                bool do
+                  filter do
+                    geo_polygon :location do
+                      points [
+                       [14.2244355,49.9419006],
+                       [14.2244355,50.1774301],
+                       [14.7067869,50.1774301],
+                       [14.7067869,49.9419006],
+                       [14.2244355,49.9419006]
+                      ]
+                    end
+                  end
+                end
+              end
+            }.to_hash
+
+            assert_equal 1, response['hits']['hits'].size
+            assert_equal 'Vyšehrad', response['hits']['hits'][0]['_source']['name']
+          end
+        end
+      end
+    end
+  end
+end

data/test/integration/search_options_test.rb

@@ -0,0 +1,54 @@
+# 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 SearchOptionsIntegrationTest < ::OpenSearch::Test::IntegrationTestCase
+      include OpenSearch::DSL::Search
+
+      context "Search options" do
+        setup do
+          @client.indices.create index: 'test'
+          @client.index index: 'test', id: '1', body: { title: 'Test' }
+          @client.index index: 'test', id: '2', body: { title: 'Rest' }
+          @client.indices.refresh index: 'test'
+        end
+
+        should "explain the match" do
+          response = @client.search index: 'test', body: search {
+            query   { match title: 'test' }
+            explain true
+          }.to_hash
+
+          assert_equal 1, response['hits']['total']['value']
+          assert_not_nil  response['hits']['hits'][0]['_explanation']
+        end
+      end
+    end
+  end
+end

data/test/integration/search_query_test.rb

@@ -0,0 +1,99 @@
+# 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 QueryIntegrationTest < ::OpenSearch::Test::IntegrationTestCase
+      include OpenSearch::DSL::Search
+
+      context "Queries integration" do
+        setup do
+          @client.indices.create index: 'test'
+          @client.index index: 'test', id: '1', body: { title: 'Test', tags: ['one'] }
+          @client.index index: 'test', id: '2', body: { title: 'Rest', tags: ['one', 'two'] }
+          @client.indices.refresh index: 'test'
+        end
+
+        context "for match query" do
+          should "find the document" do
+            response = @client.search index: 'test', body: search { query { match title: 'test' } }.to_hash
+
+            assert_equal 1, response['hits']['total']['value']
+          end
+        end
+
+        context "for match_phrase_prefix query" do
+          should "find the document" do
+            response = @client.search index: 'test', body: search { query { match_phrase_prefix title: 'te' } }.to_hash
+
+            assert_equal 1, response['hits']['total']['value']
+          end
+        end
+
+        context "for query_string query" do
+          should "find the document" do
+            response = @client.search index: 'test', body: search { query { query_string { query 'te*' } } }.to_hash
+
+            assert_equal 1, response['hits']['total']['value']
+          end
+        end
+
+        context "for the bool query" do
+          should "find the document" do
+            response = @client.search index: 'test', body: search {
+                query do
+                  bool do
+                    must   { terms tags: ['one'] }
+                    should { match title: 'Test' }
+                  end
+                end
+              }.to_hash
+
+            assert_equal 2, response['hits']['total']['value']
+            assert_equal 'Test', response['hits']['hits'][0]['_source']['title']
+          end
+
+          should "find the document with a filter" do
+            response = @client.search index: 'test', body: search {
+                query do
+                  bool do
+                    filter  { terms tags: ['one'] }
+                    filter  { terms tags: ['two'] }
+                  end
+                end
+              }.to_hash
+
+            assert_equal 1, response['hits']['total']['value']
+            assert_equal 'Rest', response['hits']['hits'][0]['_source']['title']
+          end
+        end
+
+      end
+    end
+  end
+end

data/test/integration/search_size_from_test.rb

@@ -0,0 +1,71 @@
+# 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 SizeIntegrationTest < ::OpenSearch::Test::IntegrationTestCase
+      include OpenSearch::DSL::Search
+
+        context "Search results pagination" do
+          setup do
+            @client.indices.create index: 'test', body: {
+              mappings: { properties: { title: { type: 'text', fields: { keyword: { type: 'keyword' } } } } } }
+
+            25.times { |i| @client.index index: 'test', id: i, body: { title: "Test #{sprintf('%03d', i)}" } }
+
+            @client.indices.refresh index: 'test'
+          end
+
+          should "find the correct number of documents" do
+            response = @client.search index: 'test', body: search {
+              query { match title: 'test' }
+              size 15
+            }.to_hash
+
+            assert_equal 25, response['hits']['total']['value']
+            assert_equal 15, response['hits']['hits'].size
+          end
+
+          should "move the offset" do
+            response = @client.search index: 'test', body: search {
+              query { match(:title) { query 'test' } }
+              size 5
+              from 5
+              sort { by 'title.keyword' }
+            }.to_hash
+
+            assert_equal 25, response['hits']['total']['value']
+            assert_equal 5,  response['hits']['hits'].size
+            assert_equal 'Test 005', response['hits']['hits'][0]['_source']['title']
+            assert_equal 'Test 009', response['hits']['hits'][4]['_source']['title']
+          end
+        end
+
+    end
+  end
+end

data/test/integration/search_sort_test.rb

@@ -0,0 +1,58 @@
+# 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 SortingIntegrationTest < ::OpenSearch::Test::IntegrationTestCase
+      include OpenSearch::DSL::Search
+
+      context "Sorting integration" do
+        setup do
+          @client.indices.create index: 'test'
+          @client.index index: 'test', id: '1', body: { tags: ['one'], clicks: 15 }
+          @client.index index: 'test', id: '2', body: { tags: ['one', 'two'], clicks: 5 }
+          @client.index index: 'test', id: '3', body: { tags: ['one', 'three'], clicks: 20 }
+          @client.indices.refresh index: 'test'
+        end
+
+        context "sorting by clicks" do
+          should "return documents in order" do
+            response = @client.search index: 'test', body: search {
+              sort do
+                by :clicks, order: 'desc'
+              end
+            }.to_hash
+
+            assert_same_elements ['3', '1', '2'], response['hits']['hits'].map { |d| d['_id'] }
+          end
+        end
+
+      end
+    end
+  end
+end

data/test/integration/search_suggest_test.rb

@@ -0,0 +1,103 @@
+# 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.
+
+# encoding: UTF-8
+
+require 'test_helper'
+
+module OpenSearch
+  module Test
+    class SuggestIntegrationTest < ::OpenSearch::Test::IntegrationTestCase
+      include OpenSearch::DSL::Search
+
+      context "Suggest integration" do
+        setup do
+          @client.indices.create index: 'test', body: {
+              mappings: {
+                  properties: {
+                      title: {type: 'text'},
+                      suggest: {
+                          type: 'object',
+                          properties: {
+                              title: {type: 'completion'},
+                              payload: {type: 'object', enabled: false}
+                          }
+                      }
+                  }
+              }
+          }
+
+          @client.index index: 'test', id: '1', body: {
+            title: 'One',
+            suggest: {
+              title: { input: ['one', 'uno', 'jedna'] },
+              payload: { id: '1' }
+            }
+          }
+          @client.index index: 'test', id: '2', body: {
+            title: 'Two',
+            suggest: {
+              title: { input: ['two', 'due', 'dvě'] },
+              payload: { id: '2' }
+            }
+          }
+          @client.index index: 'test', id: '3', body: {
+            title: 'Three',
+            suggest: {
+              title: { input: ['three', 'tres', 'tři'] },
+              payload: { id: '3' }
+            }
+          }
+          @client.indices.refresh index: 'test'
+        end
+
+        should "return suggestions" do
+          s = search do
+            suggest :title, text: 't', completion: { field: 'suggest.title' }
+          end
+
+          response = @client.search index: 'test', body: s.to_hash
+
+          assert_equal 2, response['suggest']['title'][0]['options'].size
+
+          assert_same_elements %w[2 3], response['suggest']['title'][0]['options'].map { |d| d['_source']['suggest']['payload']['id'] }
+        end
+
+        should "return a single suggestion" do
+          s = search do
+            suggest :title, text: 'th', completion: { field: 'suggest.title' }
+          end
+
+          response = @client.search index: 'test', body: s.to_hash
+
+          assert_equal 1, response['suggest']['title'][0]['options'].size
+
+          assert_same_elements %w[3], response['suggest']['title'][0]['options'].map { |d| d['_source']['suggest']['payload']['id'] }
+        end
+      end
+    end
+  end
+end