orchestrate 0.11.2 → 0.11.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ce3fe8f2f327ee80634c2a1cf9ee17a468db30eb
-  data.tar.gz: 671ec20412081c443941b6f4ab07e26ba2086d12
+  metadata.gz: 3b27b7b75267567dba9d38ac452324aab237059a
+  data.tar.gz: 332d9bb074378805436b10eadefc6e3db031f030
 SHA512:
-  metadata.gz: 6f1b8460ad20f8b779e738374b5276c4ee0af7e415826d8a57a37769313430f565c436c2f48a0a00ead3794a20aa5a1b8307dd566de772efd0d48afa62e0ebc7
-  data.tar.gz: 39d65b0dba9b87decc41f1e9107b6bc352935ce81fb38873c8ed8aced33aa8170754fca34a2421eb3be7caabca0cb4d87c72eb3a96e7363bf4875b076ce6bf43
+  metadata.gz: 3a133d87db07278ee15a52cfbd9dedb271da759e0122bc857c60ae7ab2ad59017f95721b5e2a751b7ecfeaf38860ba335cd57e4984450604e1f8018eff8e9128
+  data.tar.gz: 9e1fc2be1075499e59283723db17b41b7c845c10f19a9d2dbb3c3ee203fc509d909bbb173651b9419cc6367a2ef6d968d50d256afb5c56c8cb56ff3c3d7f8245

data/README.md

@@ -428,6 +428,9 @@ end
 
 ## Release Notes
 
+### April 30, 2015: release 0.11.3
+  - Implement `Orchestrate::Search::TopValuesBuilder` to construct top values aggregates.
+
 ### March 27, 2015: release 0.11.2
   - Implement `Orchestrate::Search::QueryBuilder#kinds` to search events as well as KV items.
   - Implement `Orchestrate::Search::QueryBuilder#types` to search specific types of events.

data/lib/orchestrate/client.rb

@@ -438,6 +438,7 @@ module Orchestrate
       headers = options.fetch(:headers, {})
       headers['User-Agent'] = "ruby/orchestrate/#{Orchestrate::VERSION}"
       headers['Accept'] = 'application/json' if method == :get
+      headers['Connection'] = 'close' if method == :head
 
       http_response = http.send(method) do |request|
         request.url path, query_string
@@ -445,7 +446,7 @@ module Orchestrate
           headers['Content-Type'] = 'application/json'
           request.body = body.to_json
         elsif [:patch].include?(method)
-          request.body = body.to_json    
+          request.body = body.to_json
         end
         headers.each {|header, value| request[header] = value }
       end

data/lib/orchestrate/search/aggregate_builder.rb

@@ -1,15 +1,24 @@
 module Orchestrate::Search
+  module QueryBuilderDelegator
+    extend Forwardable
+    def_delegators :@builder, :options, :order, :limit, :offset, :aggregate, :find, :collection
+  end
+
+  module AggregateBuilderDelegator
+    extend Forwardable
+    def_delegators :@builder, :top_values, :stats, :range, :distance, :time_series
+  end
+
   # Aggregate Builder object for constructing aggregate params included in a search
   class AggregateBuilder
+    include QueryBuilderDelegator
 
-    # @return [QueryBuilder] 
+    # @return [QueryBuilder]
     attr_reader :builder
 
     # @return [Array] Aggregate param arguments
     attr_reader :aggregates
 
-    extend Forwardable
-
     # Initialize a new AggregateBuilder object
     # @param builder [Orchestrate::Search::SearchBuilder] The Search Builder object
     def initialize(builder)
@@ -17,14 +26,6 @@ module Orchestrate::Search
       @aggregates = []
     end
 
-    def_delegator :@builder, :options
-    def_delegator :@builder, :order
-    def_delegator :@builder, :limit
-    def_delegator :@builder, :offset
-    def_delegator :@builder, :aggregate
-    def_delegator :@builder, :find
-    def_delegator :@builder, :collection
-
     # @return Pretty-Printed string representation of the AggregateBuilder object
     def to_s
       "#<Orchestrate::Search::AggregateBuilder collection=#{collection.name} query=#{builder.query} aggregate=#{to_param}>"
@@ -38,6 +39,16 @@ module Orchestrate::Search
 
     # @!group Aggregate Functions
 
+    # @param field_name [#to_s]
+    # @param offset [Integer, nil]
+    # @param limit [Integer, nil]
+    # @return [AggregateBuilder]
+    def top_values(field_name, offset = nil, limit = nil)
+      top_values = TopValuesBuilder.new(self, "#{field_name}", offset, limit)
+      aggregates << top_values
+      top_values
+    end
+
     # @param field_name [#to_s]
     # @return [AggregateBuilder]
     def stats(field_name)
@@ -72,17 +83,61 @@ module Orchestrate::Search
     # @!endgroup
   end
 
+  # Stats Builder object for constructing top-values functions to be included in the aggregate param
+  class TopValuesBuilder
+    include QueryBuilderDelegator
+    include AggregateBuilderDelegator
+
+    # @return [AggregateBuilder]
+    attr_reader :builder
+
+    # @return [#to_s] The field to operate over
+    attr_reader :field_name
+
+    # Initialize a new TopValuesBuilder object
+    # @param builder [AggregateBuilder] The Aggregate Builder object
+    # @param field_name [#to_s] The field to operate over
+    # @param offset [Integer,nil] The zero-based index of the first paged value to retrieve in this aggregation.
+    # If omitted, uses the server default value of zero.
+    # @param limit [Integer,nil] The maximum number of values to retrieve per page of results for this aggregation.
+    # If omitted, uses the server default value of ten.
+    def initialize(builder, field_name, offset=nil, limit=nil)
+      @builder = builder
+      @field_name = field_name
+      if offset.nil? ^ limit.nil?
+        raise ArgumentError, "offset and limit arguments can only be supplied together, or not at all"
+      end
+      @offset = offset
+      @limit = limit
+    end
+
+    # @return [#to_s] Pretty-Printed string representation of the TopValuesBuilder object
+    def to_s
+      "#<Orchestrate::Search::TopValuesBuilder collection=#{collection.name} field_name=#{@field_name} offset=#{@offset} limit=#{@limit}>"
+    end
+    alias :inspect :to_s
+
+    # @return [#to_s] constructed aggregate string clause
+    def to_param
+      if @offset.nil? && @limit.nil?
+        "#{@field_name}:top_values"
+      else
+        "#{@field_name}:top_values:offset:#{@offset}:limit:#{@limit}"
+      end
+    end
+  end
+
   # Stats Builder object for constructing stats functions to be included in the aggregate param
   class StatsBuilder
-    
+    include QueryBuilderDelegator
+    include AggregateBuilderDelegator
+
     # @return [AggregateBuilder]
     attr_reader :builder
 
     # @return [#to_s] The field to operate over
     attr_reader :field_name
 
-    extend Forwardable
-
     # Initialize a new RangeBuilder object
     # @param builder [AggregateBuilder] The Aggregate Builder object
     # @param field_name [#to_s]
@@ -91,18 +146,6 @@ module Orchestrate::Search
       @field_name = field_name
     end
 
-    def_delegator :@builder, :options
-    def_delegator :@builder, :order
-    def_delegator :@builder, :limit
-    def_delegator :@builder, :offset
-    def_delegator :@builder, :aggregate
-    def_delegator :@builder, :find
-    def_delegator :@builder, :stats
-    def_delegator :@builder, :range
-    def_delegator :@builder, :distance
-    def_delegator :@builder, :time_series
-    def_delegator :@builder, :collection
-
     # @return Pretty-Printed string representation of the StatsBuilder object
     def to_s
       "#<Orchestrate::Search::StatsBuilder collection=#{collection.name} field_name=#{field_name}>"
@@ -117,6 +160,8 @@ module Orchestrate::Search
 
   # Range Builder object for constructing range functions to be included in the aggregate param
   class RangeBuilder
+    include QueryBuilderDelegator
+    include AggregateBuilderDelegator
 
     # @return [AggregateBuilder]
     attr_reader :builder
@@ -125,9 +170,7 @@ module Orchestrate::Search
     attr_reader :field_name
 
     # @return [#to_s] The range sets
-    attr_reader :ranges 
-
-    extend Forwardable
+    attr_reader :ranges
 
     # Initialize a new RangeBuilder object
     # @param builder [AggregateBuilder] The Aggregate Builder object
@@ -138,18 +181,6 @@ module Orchestrate::Search
       @ranges = ''
     end
 
-    def_delegator :@builder, :options
-    def_delegator :@builder, :order
-    def_delegator :@builder, :limit
-    def_delegator :@builder, :offset
-    def_delegator :@builder, :aggregate
-    def_delegator :@builder, :find
-    def_delegator :@builder, :stats
-    def_delegator :@builder, :range
-    def_delegator :@builder, :distance
-    def_delegator :@builder, :time_series
-    def_delegator :@builder, :collection
-
     # @return Pretty-Printed string representation of the RangeBuilder object
     def to_s
       "#<Orchestrate::Search::RangeBuilder collection=#{collection.name} field_name=#{field_name} ranges=#{ranges}>"
@@ -201,6 +232,8 @@ module Orchestrate::Search
 
   # Time Series Builder object for constructing time series functions for the aggregate param
   class TimeSeriesBuilder
+    include QueryBuilderDelegator
+    include AggregateBuilderDelegator
 
     # @return [AggregateBuilder]
     attr_reader :builder
@@ -211,8 +244,6 @@ module Orchestrate::Search
     # @return [#to_s] The interval of time for the TimeSeries function
     attr_reader :interval
 
-    extend Forwardable
-
     # Initialize a new TimeSeriesBuilder object
     # @param builder [AggregateBuilder] The Aggregate Builder object
     # @param field_name [#to_s] The field to operate over
@@ -223,18 +254,6 @@ module Orchestrate::Search
       @time_zone = nil
     end
 
-    def_delegator :@builder, :options
-    def_delegator :@builder, :order
-    def_delegator :@builder, :limit
-    def_delegator :@builder, :offset
-    def_delegator :@builder, :aggregate
-    def_delegator :@builder, :find
-    def_delegator :@builder, :stats
-    def_delegator :@builder, :range
-    def_delegator :@builder, :distance
-    def_delegator :@builder, :time_series
-    def_delegator :@builder, :collection
-
     # @return Pretty-Printed string representation of the TimeSeriesBuilder object
     def to_s
       "#<Orchestrate::Search::TimeSeriesBuilder collection=#{collection.name} field_name=#{field_name} interval=#{interval} time_zone=#{@time_zone}>"
@@ -300,4 +319,4 @@ module Orchestrate::Search
       self
     end
   end
-end
+end

data/lib/orchestrate/version.rb

@@ -1,4 +1,4 @@
 module Orchestrate
   # @return [String] The version number of the Orchestrate Gem
-  VERSION = "0.11.2"
+  VERSION = "0.11.3"
 end

data/test/orchestrate/search/aggregate_builder_test.rb

@@ -0,0 +1,53 @@
+require 'test_helper'
+
+class AggregateBuilderTest < MiniTest::Unit::TestCase
+  def setup
+    collection = OpenStruct.new(name: 'users')
+    @query_builder = Orchestrate::Search::QueryBuilder.new(collection, '*')
+    @builder = Orchestrate::Search::AggregateBuilder.new(@query_builder)
+  end
+
+  def test_top_values_aggregate
+    top_values = @builder.top_values('name')
+    assert_equal 'name:top_values', top_values.to_param
+  end
+
+  def test_top_values_aggregate_with_offset_limit
+    top_values = @builder.top_values('name', 0, 10)
+    assert_equal 'name:top_values:offset:0:limit:10', top_values.to_param
+  end
+
+  def test_top_values_aggregate_with_offset
+    assert_raises(ArgumentError) do
+      @builder.top_values('name', 0)
+    end
+  end
+
+  def test_top_values_aggregate_with_limit
+    assert_raises(ArgumentError) do
+      @builder.top_values('name', nil, 10)
+    end
+  end
+
+  def test_top_values_aggregate_to_s
+    top_values = @builder.top_values('name', 3, 4)
+    assert_equal '#<Orchestrate::Search::TopValuesBuilder collection=users field_name=name offset=3 limit=4>', top_values.to_s
+  end
+
+  # TODO: abstract delegator assertions into a re-usable helper
+  def test_top_values_delegators
+    # this test asserts that the top values aggregator delegates all expected
+    # query builder and aggregate builder methods
+    builder = MiniTest::Mock.new
+    top_values = Orchestrate::Search::TopValuesBuilder.new(builder, "field_name")
+    Orchestrate::Search::QueryBuilderDelegator.public_instance_methods.each do |m|
+      builder.expect(m, true)
+      top_values.send(m)
+    end
+    Orchestrate::Search::AggregateBuilderDelegator.public_instance_methods.each do |m|
+      builder.expect(m, true)
+      top_values.send(m)
+    end
+    builder.verify
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: orchestrate
 version: !ruby/object:Gem::Version
-  version: 0.11.2
+  version: 0.11.3
 platform: ruby
 authors:
 - Matthew Lyon
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-27 00:00:00.000000000 Z
+date: 2015-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -170,6 +170,7 @@ files:
 - test/orchestrate/key_value_test.rb
 - test/orchestrate/ref_test.rb
 - test/orchestrate/relations_test.rb
+- test/orchestrate/search/aggregate_builder_test.rb
 - test/orchestrate/search/query_builder_test.rb
 - test/test_helper.rb
 homepage: https://github.com/orchestrate-io/orchestrate-ruby
@@ -218,5 +219,6 @@ test_files:
 - test/orchestrate/key_value_test.rb
 - test/orchestrate/ref_test.rb
 - test/orchestrate/relations_test.rb
+- test/orchestrate/search/aggregate_builder_test.rb
 - test/orchestrate/search/query_builder_test.rb
 - test/test_helper.rb