orchestrate 0.11.0 → 0.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 052b46ffb077d9256c3626b2d2fe1d6618c0f3c9
-  data.tar.gz: 34375247e7fc3ce08d2f836df6e0df7f778273f7
+  metadata.gz: 4d0d0f4b8f59826a8f9dbba17f58a94d74a56051
+  data.tar.gz: 43ad3fb8c92dddd44e4f4757b94b57c48a142f06
 SHA512:
-  metadata.gz: 99d0edff2baf770cf3c2173c9245bb42957dee1a92c1d4abca2c24bc8b510569bf6bda09159c2761bbd64d9631cdfd1d2273166597dccb11a12f85c1a110fb3d
-  data.tar.gz: 6afa7091564272f7f22d0b4d173b03cd76815a63992876aaccadd3b1c08ab11a38a6c20e884e2feafcf8e339651f0bf0b623339927de6a7e6b1e8c5fd27f39a3
+  metadata.gz: 7e114a8889c720f8cb505c39fa32e5526f7ad8e47f60cb6acbacd9175e963692c1d2f19cf07388c5482d2098e67e6a44d21b0fc78afe8adb18e22b1d1e342b03
+  data.tar.gz: bd4bb4b0a7720b99a906247f6e8eb7d8ec1dfd7516cc7996418e6a09912f0ab435c9e66f6a683967f0ee0b9f553142f6fd8b028876c3ce83e9c50f50b5090960

data/README.md

@@ -127,6 +127,7 @@ cafes.near(:location, 12, 19, 4, 'mi').aggregate  # Start the near search query
 # Accepted intervals are: year, quarter, month, week, day, and hour
 comments.search("*").aggregate  # Start the near search query and aggregate param builder
   .time_series("posted", "day") # get count of comments posted by day
+  .time_zone("+1100")           # set a specific time zone
   .find                         # return SearchResults object to execute our query
   .each_aggregate               # return enumerator for iterating over each aggregate result
 
@@ -279,6 +280,21 @@ response = client.search(:comments, query, options)
 response.aggregates     # return aggregate results
 
 
+# Time-Series Aggregate with Time Zone
+
+options = {
+  # get count of comments posted by day
+  aggregate: "value.posted:time_series:day:+1100"
+}
+
+query = "*"
+
+response = client.search(:comments, query, options)
+
+response.aggregates     # return aggregate results
+
+
+
 # Multiple Aggregate Functions
 options = {
   # multiple aggregate params are separated by commas
@@ -396,7 +412,10 @@ end
 
 ## Release Notes
 
-### January 7, 2014: release 0.11.0
+### February 17, 2015: release 0.11.1
+  - Implement `Search::TimeSeriesBuilder#time_zone` to designate time zone when calculating time series bucket boundaries.
+
+### January 7, 2015: release 0.11.0
   - **BACKWARDS-INCOMPATIBLE** `Orchestrate::Collection` searches require `#find` method at the end of the method call/chain. Example: `users.search('foo').find`.
   - Implement `Orchestrate::Search` module, refactor functionality of prior `Orchestrate::Collection::SearchResults`.
   - Implement results enumeration & request firing functionality in prior `Orchestrate::Collection::SearchResults` to `Orchestrate::Search::Results`
@@ -474,4 +493,4 @@ end
 ### May 21, 2014: release 0.5.0
   Initial Port from @jimcar
   - Uses Faraday HTTP Library as backend, with examples of alternate adapters
-  - Cleanup client method signatures
+  - Cleanup client method signatures

data/lib/orchestrate/search/aggregate_builder.rb

@@ -220,6 +220,7 @@ module Orchestrate::Search
       @builder = builder
       @field_name = field_name
       @interval = nil
+      @time_zone = nil
     end
 
     def_delegator :@builder, :options
@@ -236,13 +237,17 @@ module Orchestrate::Search
 
     # @return Pretty-Printed string representation of the TimeSeriesBuilder object
     def to_s
-      "#<Orchestrate::Search::TimeSeriesBuilder collection=#{collection.name} field_name=#{field_name} interval=#{interval}>"
+      "#<Orchestrate::Search::TimeSeriesBuilder collection=#{collection.name} field_name=#{field_name} interval=#{interval} time_zone=#{@time_zone}>"
     end
     alias :inspect :to_s
 
     # @return [#to_s] constructed aggregate string clause
     def to_param
-      "#{field_name}:time_series:#{interval}"
+      if @time_zone.nil?
+        "#{field_name}:time_series:#{interval}"
+      else
+        "#{field_name}:time_series:#{interval}:#{@time_zone}"
+      end
     end
 
     # Set time series interval to year
@@ -286,5 +291,13 @@ module Orchestrate::Search
       @interval = 'hour'
       self
     end
+
+    # Use the designated time zone (e.g., "-0500" or "+0430") when calculating bucket boundaries
+    # @param zone [String]
+    # @return [RangeBuilder]
+    def time_zone(zone)
+      @time_zone = zone
+      self
+    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.0"
+  VERSION = "0.11.1"
 end

data/test/orchestrate/collection_aggregates_test.rb

@@ -49,6 +49,17 @@ class CollectionAggregates < MiniTest::Unit::TestCase
         "count" => 17
       }]
     }]
+    @time_series_with_time_zone = [{
+      "aggregate_kind" => "time_series",
+      "field_name" => "value.bar",
+      "interval" => "day",
+      "time_zone" => "+1100",
+      "value_count" => 100,
+      "buckets" => [{
+        "bucket" => "2014-11-01",
+        "count" => 17
+      }]
+    }]
     @limit = 100
     @total = 110
 
@@ -67,6 +78,9 @@ class CollectionAggregates < MiniTest::Unit::TestCase
       when 'bar:time_series:day'
         { "results" => 100.times.map{|i| @make_listing.call(i)}, "count" => 100, "total_count" => @total,
           "aggregates" => @time_series }
+      when 'bar:time_series:day:+1100'
+        { "results" => 100.times.map{|i| @make_listing.call(i)}, "count" => 100, "total_count" => @total,
+          "aggregates" => @time_series_with_time_zone }
       else
         raise ArgumentError.new("unexpected aggregate: #{aggregate}")
       end
@@ -107,6 +121,12 @@ class CollectionAggregates < MiniTest::Unit::TestCase
     assert_equal @time_series, results.aggregates
   end
 
+  def test_basic_time_series_aggregate_with_time_zone
+    results = @items.search("foo").aggregate.time_series("bar").day.time_zone("+1100").find
+    results.each_aggregate
+    assert_equal @time_series_with_time_zone, results.aggregates
+  end
+
   def test_each_aggregate_enum
     results = @items.search("foo").aggregate.time_series("bar").day.find
     enum = results.each_aggregate

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: orchestrate
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.11.1
 platform: ruby
 authors:
 - Matthew Lyon
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-08 00:00:00.000000000 Z
+date: 2015-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday