ruby-druid 0.10.2 → 0.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a0c3c8d5446273522ee0ed61a17e920480a81fc1
-  data.tar.gz: 9ab5eda36c0f96eb50a6abe2f43b18b2c31fc324
+SHA256:
+  metadata.gz: 0f5eb5f76213ef418c72e7a23982396bd2191bfcb1c8e45f246c956d2c31736a
+  data.tar.gz: 6d2e0f22836c012242e177d283a6ec846a21bb102c20f5d81680fb9888ea7be7
 SHA512:
-  metadata.gz: 24308e3e10381ac3d3b3c2f0671877b9accde3773e892bfc06f88860ca3043c3868531cd20c450bd11bb7c6ea40f83f43aa59e04bdd6c70926a39c513a956257
-  data.tar.gz: 4e77ad95ba2633f2145328982a2bf5df29b00d785b0ad70c489e48ed2af15637d0a9577c0fa32872d172cf3de6d1a6f3e790f30f17d4f71a88936ce198fa637b
+  metadata.gz: 4da2d77ab40643ed4050ae3536880a38e3d03215c46fee9e67851d04c2618b3f3cc17ada6d8f77d67b13bcac847a3a3bcc0114708eaf3029fda7105060e2d694
+  data.tar.gz: e2c000c181b04bc74bb4a949bbb2dfba189771fd6c2fb4abd1f98bc45cfb588f4e47818ec1aa2b6938154ba9a7c85ded82ab7f8092e0788baf802511aa9c86b1

data/README.md

@@ -92,6 +92,16 @@ Druid::Query::Builder.new.js_aggregation(:aggregate, [:x, :y],
 )
 ```
 
+#### filtered aggregation
+
+A filtered aggregator wraps any given aggregator, but only aggregates the values for which the given dimension filter matches.
+
+```ruby
+Druid::Query::Builder.new.filtered_aggregation(:aggregate1, :aggregate_1_name, :longSum) do
+  dimension1.neq 1 & dimension2.neq 2
+end
+```
+
 ### Post Aggregations
 
 A simple syntax for post aggregations with +,-,/,* can be used like:

data/lib/druid/aggregation.rb

@@ -59,6 +59,34 @@ module Druid
     attr_accessor :byRow
     validates :byRow, allow_nil: true, inclusion: { in: [true, false] }
 
+    class FilterValidator < ActiveModel::EachValidator
+      TYPES = %w[filtered].freeze
+      def validate_each(record, attribute, value)
+        if TYPES.include?(record.type)
+          record.errors.add(attribute, 'may not be blank') if value.blank?
+        else
+          record.errors.add(attribute, "is not supported by type=#{record.type}") if value
+        end
+      end
+    end
+
+    attr_accessor :filter
+    validates :filter, filter: true
+
+    class AggregatorValidator < ActiveModel::EachValidator
+      TYPES = %w[filtered].freeze
+      def validate_each(record, attribute, value)
+        if TYPES.include?(record.type)
+          record.errors.add(attribute, 'may not be blank') if value.blank?
+        else
+          record.errors.add(attribute, "is not supported by type=#{record.type}") if value
+        end
+      end
+    end
+
+    attr_accessor :aggregator
+    validates :aggregator, aggregator: true
+
     def as_json(options = {})
       super(options.merge(except: %w(errors validation_context)))
     end

data/lib/druid/filter.rb

@@ -166,6 +166,14 @@ module Druid
       CircFilter.new(@dimension, bounds)
     end
 
+    def bound(params)
+      BoundFilter.new(@dimension, params)
+    end
+
+    def search(params)
+      SearchFilter.new(@dimension, params)
+    end
+
     def eq(value)
       case value
       when ::Array
@@ -299,7 +307,35 @@ module Druid
       @bound = {
         type: 'radius',
         coords: bounds.first,
-        radius: bounds.last,
+        radius: bounds.last
+      }
+    end
+  end
+
+  class BoundFilter < Filter
+    include BooleanOperators
+
+    def initialize(dimension, params)
+      super()
+      @type = 'bound'
+      @dimension = dimension
+      @ordering = params[:ordering]
+      @upper = params[:upper]
+      @upperStrict = params[:upperStrict]
+    end
+  end
+
+  class SearchFilter < Filter
+    include BooleanOperators
+
+    def initialize(dimension, params)
+      super()
+      @type = 'search'
+      @dimension = dimension
+      @query = {
+        type: 'contains',
+        value: params[:value],
+        caseSensitive: params[:case_sensitive] || false
       }
     end
   end

data/lib/druid/query.rb

@@ -451,6 +451,19 @@ module Druid
         self
       end
 
+      def filtered_aggregation(metric, name, aggregation_type, &filter)
+        @query.aggregations << Aggregation.new(
+          type: 'filtered',
+          filter: Filter.new.instance_exec(&filter),
+          aggregator: Aggregation.new(
+            type: aggregation_type.to_s.camelize(:lower),
+            name: name,
+            fieldName: metric
+          )
+        ) unless @query.contains_aggregation?(name)
+        self
+      end
+
       ## post aggregations
 
       def postagg(type = :long_sum, &block)

data/lib/druid/version.rb

@@ -1,3 +1,3 @@
 module Druid
-  VERSION = '0.10.2'
+  VERSION = '0.11.1'
 end

data/ruby-druid.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "multi_json", "~> 1.0"
   spec.add_dependency "rest-client", ">= 1.8", "< 3.0"
   spec.add_dependency "zk", "~> 1.9"
-  spec.add_development_dependency "bundler", ">= 1.3.0", "< 2.0"
+  spec.add_development_dependency "bundler", ">= 1.3.0", "< 2.2"
   spec.add_development_dependency "rake", "~> 11.2"
   spec.add_development_dependency "rspec", "~> 3.4"
   spec.add_development_dependency "webmock", "~> 2.1"

data/spec/lib/query_spec.rb

@@ -209,6 +209,32 @@ describe Druid::Query do
     end
   end
 
+  describe '#filtered_aggregation' do
+    it 'builds filtered aggregations' do
+      @query.filtered_aggregation(:a, :a_filtered, :longSum) do
+        b.eq(2) & c.neq(3)
+      end
+      expect(JSON.parse(@query.query.to_json)['aggregations']).to eq [
+        {
+          'type' => 'filtered',
+          'filter' => {
+            'type' => 'and',
+            'fields' => [
+              { 'dimension' => 'b', 'type' => 'selector', 'value' => 2 },
+              {
+                'type' => 'not',
+                'field' => {
+                  'dimension' => 'c', 'type' => 'selector', 'value' => 3
+                }
+              }
+            ]
+          },
+          'aggregator' => { 'type' => 'longSum', 'name' => 'a_filtered', 'fieldName' => 'a' }
+        }
+      ]
+    end
+  end
+
   it 'appends long_sum properties from aggregations on calling long_sum again' do
     @query.long_sum(:a, :b, :c)
     @query.double_sum(:x,:y)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-druid
 version: !ruby/object:Gem::Version
-  version: 0.10.2
+  version: 0.11.1
 platform: ruby
 authors:
 - Ruby Druid Community
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-09-19 00:00:00.000000000 Z
+date: 2020-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -109,7 +109,7 @@ dependencies:
         version: 1.3.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -119,7 +119,7 @@ dependencies:
         version: 1.3.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -165,7 +165,7 @@ dependencies:
 description: |2
       ruby-druid is a Ruby client for Druid. It includes a Squeel-like query DSL
       and generates a JSON query that can be sent to Druid directly.
-email: 
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -195,7 +195,7 @@ homepage: https://github.com/ruby-druid/ruby-druid
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -210,14 +210,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.1
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: A Ruby client for Druid
 test_files:
 - spec/spec_helper.rb
-- spec/lib/query_spec.rb
-- spec/lib/data_source_spec.rb
 - spec/lib/client_spec.rb
 - spec/lib/zk_spec.rb
+- spec/lib/data_source_spec.rb
+- spec/lib/query_spec.rb