opensearch-ruby 2.0.3 → 3.4.0

data/lib/opensearch/dsl/search/aggregations/geo_bounds.rb

@@ -0,0 +1,68 @@
+# 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
+    module Search
+      module Aggregations
+        # An aggregation which will calculate the smallest bounding box required to encapsulate
+        # all of the documents matching the query
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         filtered do
+        #           filter do
+        #             geo_bounding_box :location do
+        #               top_left     "40.8,-74.1"
+        #               bottom_right "40.4,-73.9"
+        #             end
+        #           end
+        #         end
+        #       end
+        #
+        #       aggregation :new_york do
+        #         geohash_grid field: 'location'
+        #       end
+        #
+        #       aggregation :map_zoom do
+        #         geo_bounds field: 'location'
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/guide/current/geo-bounds-agg.html
+        #
+        class GeoBounds
+          include BaseComponent
+
+          option_method :field
+          option_method :wrap_longitude
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/aggregations/geo_distance.rb

@@ -0,0 +1,63 @@
+# 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
+    module Search
+      module Aggregations
+        # A multi-bucket aggregation which will return document counts for distance perimeters,
+        # defined as ranges
+        #
+        # @example
+        #
+        #     search do
+        #       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 } ]
+        #         end
+        #       end
+        #     end
+        #
+        # See the integration test for a full example.
+        #
+        # @see http://opensearch.org/guide/en/opensearch/guide/current/geo-distance-agg.html
+        #
+        class GeoDistance
+          include BaseAggregationComponent
+
+          option_method :field
+          option_method :origin
+          option_method :ranges
+          option_method :unit
+          option_method :distance_type
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/aggregations/geohash_grid.rb

@@ -0,0 +1,59 @@
+# 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
+    module Search
+      module Aggregations
+        # A multi-bucket aggregation which will return document counts for geohash grid cells
+        #
+        # @example
+        #
+        #     search do
+        #       aggregation :venue_distributions do
+        #         geohash_grid do
+        #           field     :location
+        #           precision 5
+        #         end
+        #       end
+        #     end
+        #
+        # See the integration test for a full example.
+        #
+        # @see http://opensearch.org/guide/en/opensearch/guide/current/geohash-grid-agg.html
+        #
+        class GeohashGrid
+          include BaseAggregationComponent
+
+          option_method :field
+          option_method :precision
+          option_method :size
+          option_method :shard_size
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/aggregations/global.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.
+
+module OpenSearch
+  module DSL
+    module Search
+      module Aggregations
+        # Defines a single bucket of all the documents matching a query
+        #
+        # @example
+        #
+        #     search do
+        #       aggregation :all_documents do
+        #         global do
+        #           aggregation :avg_clicks do
+        #             avg field: 'clicks'
+        #           end
+        #         end
+        #       end
+        #     end
+        #
+        #
+        class Global
+          include BaseAggregationComponent
+        end
+      end
+    end
+  end
+end

data/{spec/integration/security_disabled/client_integration_spec.rb → lib/opensearch/dsl/search/aggregations/histogram.rb}

@@ -23,37 +23,37 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-require 'spec_helper'
-require 'logger'
 
-context 'OpenSearch client ' do
-  let(:logger) { Logger.new($stderr) }
+module OpenSearch
+  module DSL
+    module Search
+      module Aggregations
+        # A multi-bucket aggregation which returns document counts for a defined numerical interval
+        #
+        # @example
+        #
+        #    search do
+        #      aggregation :age do
+        #        histogram do
+        #          field   'age'
+        #          interval 5
+        #        end
+        #      end
+        #    end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/search-aggregations-bucket-histogram-aggregation.html
+        #
+        class Histogram
+          include BaseAggregationComponent
 
-  let(:client) do
-    OpenSearch::Client.new(
-      host: OPENSEARCH_URL,
-      logger: logger
-    )
-  end
-
-  context 'Integrates with opensearch API' do
-    it 'should perform the API methods' do
-      expect do
-        # Index a document
-        client.index(index: 'test-index', id: '1', body: { title: 'Test' })
-
-        # Refresh the index
-        client.indices.refresh(index: 'test-index')
-
-        # Search
-        response = client.search(index: 'test-index', body: { query: { match: { title: 'test' } } })
-
-        expect(response['hits']['total']['value']).to eq 1
-        expect(response['hits']['hits'][0]['_source']['title']).to eq 'Test'
-
-        # Delete the index
-        client.indices.delete(index: 'test-index')
-      end.not_to raise_error
+          option_method :field
+          option_method :interval
+          option_method :min_doc_count
+          option_method :extended_bounds
+          option_method :order
+          option_method :keyed
+        end
+      end
     end
   end
 end

data/lib/opensearch/dsl/search/aggregations/ip_range.rb

@@ -0,0 +1,55 @@
+# 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
+    module Search
+      module Aggregations
+        # A multi-bucket aggregation which returns document counts for defined IP ranges
+        #
+        # @example
+        #
+        #     search do
+        #       aggregation :ips do
+        #         ip_range do
+        #           field 'ip'
+        #           ranges [ { mask: '10.0.0.0/25' }, { mask: '10.0.0.127/25' } ]
+        #         end
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/search-aggregations-bucket-iprange-aggregation.html
+        #
+        class IpRange
+          include BaseAggregationComponent
+
+          option_method :field
+          option_method :ranges
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/aggregations/max.rb

@@ -0,0 +1,49 @@
+# 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
+    module Search
+      module Aggregations
+        # A single-value metric aggregation which returns the maximum value from numeric values
+        #
+        # @example
+        #
+        #     search do
+        #       aggregation :max_clicks do
+        #         max field: 'clicks'
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/search-aggregations-metrics-max-aggregation.html
+        #
+        class Max
+          include BaseComponent
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/aggregations/min.rb

@@ -0,0 +1,49 @@
+# 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
+    module Search
+      module Aggregations
+        # A single-value metric aggregation which returns the minimum value from numeric values
+        #
+        # @example
+        #
+        #     search do
+        #       aggregation :min_clicks do
+        #         min field: 'clicks'
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/search-aggregations-metrics-min-aggregation.html
+        #
+        class Min
+          include BaseComponent
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/aggregations/missing.rb

@@ -0,0 +1,59 @@
+# 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
+    module Search
+      module Aggregations
+        # A single bucket aggregation that creates a bucket of all documents
+        # which are missing a value for the field
+        #
+        # @example Passing the options as a Hash
+        #
+        #     aggregation :articles_without_tags do
+        #       missing field: 'tags'
+        #     end
+        #
+        # @example Passing the options as a block
+        #
+        #     search do
+        #       aggregation :articles_without_tags do
+        #         missing do
+        #           field 'tags'
+        #         end
+        #       end
+        #     end
+        #
+        #
+        class Missing
+          include BaseAggregationComponent
+
+          option_method :field
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/aggregations/nested.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.
+
+module OpenSearch
+  module DSL
+    module Search
+      module Aggregations
+        # A single-bucket aggregation which allows to aggregate on nested fields
+        #
+        # @example
+        #
+        #    search do
+        #      aggregation :offers do
+        #        nested do
+        #          path 'offers'
+        #          aggregation :min_price do
+        #            min field: 'offers.price'
+        #          end
+        #        end
+        #      end
+        #    end
+        #
+        # See the integration test for a full example.
+        #
+        #
+        class Nested
+          include BaseAggregationComponent
+
+          option_method :path
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/aggregations/percentile_ranks.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.
+
+module OpenSearch
+  module DSL
+    module Search
+      module Aggregations
+        # A multi-value metrics aggregation which calculates percentile ranks on numeric values
+        #
+        # @example
+        #
+        #     search do
+        #       aggregation :load_time_outliers do
+        #         percentile_ranks do
+        #           field 'load_time'
+        #           values [ 15, 30 ]
+        #         end
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/search-aggregations-metrics-percentile-rank-aggregation.html
+        #
+        class PercentileRanks
+          include BaseComponent
+
+          option_method :field
+          option_method :values
+          option_method :script
+          option_method :params
+          option_method :compression
+        end
+      end
+    end
+  end
+end