Support avg, cardinality, min, max and sum metric aggregates (#877)

JP Rosevear · Andrew Kane
1 parent ff4c8042
Showing 2 changed files with 53 additions and 3 deletions Show diff stats
lib/searchkick/query.rb
test/aggs_test.rb
@@ -2,6 +2,8 @@ module Searchkick
   class Query
     extend Forwardable
+    @@metric_aggs = [:avg, :cardinality, :max, :min, :sum]
+
     attr_reader :klass, :term, :options
     attr_accessor :body
@@ -643,10 +645,10 @@ module Searchkick
               interval: interval
             }
           }
-        elsif agg_options[:cardinality]
+        elsif metric = @@metric_aggs.find { |k| agg_options.has_key?(k) }
           payload[:aggs][field] = {
-            cardinality: {
-              field: agg_options[:cardinality][:field] || field
+            metric => {
+              field: agg_options[metric][:field] || field
             }
           }
         else
@@ -116,6 +116,20 @@ class AggsTest &lt; Minitest::Test
     assert_equal 4, products.aggs["products_per_year"]["buckets"].size
   end
+  def test_aggs_avg
+    products =
+      Product.search("*", {
+        aggs: {
+          avg_price: {
+            avg: {
+              field: :price
+            }
+          }
+        }
+      })
+    assert_equal 16.5, products.aggs["avg_price"]["value"]
+  end
+
   def test_aggs_cardinality
     products =
       Product.search("*", {
@@ -130,6 +144,40 @@ class AggsTest &lt; Minitest::Test
     assert_equal 3, products.aggs["total_stores"]["value"]
   end
+  def test_aggs_min_max
+    products =
+      Product.search("*", {
+        aggs: {
+          min_price: {
+            min: {
+              field: :price
+            }
+          },
+          max_price: {
+            max: {
+              field: :price
+            }
+          }
+        }
+      })
+    assert_equal 5, products.aggs["min_price"]["value"]
+    assert_equal 25, products.aggs["max_price"]["value"]
+  end
+
+  def test_aggs_sum
+    products =
+      Product.search("*", {
+        aggs: {
+          sum_price: {
+            sum: {
+              field: :price
+            }
+          }
+        }
+      })
+    assert_equal 66, products.aggs["sum_price"]["value"]
+  end
+
   protected
   def buckets_as_hash(agg)
	@@ -116,6 +116,20 @@ class AggsTest < Minitest::Test		@@ -116,6 +116,20 @@ class AggsTest < Minitest::Test
116	assert_equal 4, products.aggs["products_per_year"]["buckets"].size	116	assert_equal 4, products.aggs["products_per_year"]["buckets"].size
117	end	117	end
118		118
		119	+ def test_aggs_avg
		120	+ products =
		121	+ Product.search("*", {
		122	+ aggs: {
		123	+ avg_price: {
		124	+ avg: {
		125	+ field: :price
		126	+ }
		127	+ }
		128	+ }
		129	+ })
		130	+ assert_equal 16.5, products.aggs["avg_price"]["value"]
		131	+ end
		132	+
119	def test_aggs_cardinality	133	def test_aggs_cardinality
120	products =	134	products =
121	Product.search("*", {	135	Product.search("*", {
	@@ -130,6 +144,40 @@ class AggsTest < Minitest::Test		@@ -130,6 +144,40 @@ class AggsTest < Minitest::Test
130	assert_equal 3, products.aggs["total_stores"]["value"]	144	assert_equal 3, products.aggs["total_stores"]["value"]
131	end	145	end
132		146
		147	+ def test_aggs_min_max
		148	+ products =
		149	+ Product.search("*", {
		150	+ aggs: {
		151	+ min_price: {
		152	+ min: {
		153	+ field: :price
		154	+ }
		155	+ },
		156	+ max_price: {
		157	+ max: {
		158	+ field: :price
		159	+ }
		160	+ }
		161	+ }
		162	+ })
		163	+ assert_equal 5, products.aggs["min_price"]["value"]
		164	+ assert_equal 25, products.aggs["max_price"]["value"]
		165	+ end
		166	+
		167	+ def test_aggs_sum
		168	+ products =
		169	+ Product.search("*", {
		170	+ aggs: {
		171	+ sum_price: {
		172	+ sum: {
		173	+ field: :price
		174	+ }
		175	+ }
		176	+ }
		177	+ })
		178	+ assert_equal 66, products.aggs["sum_price"]["value"]
		179	+ end
		180	+
133	protected	181	protected
134		182
135	def buckets_as_hash(agg)	183	def buckets_as_hash(agg)