keen 0.8.1 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bfa6893d4994089e26e547221cd8471568335ec6
-  data.tar.gz: c353a3635a5656b6b9e0a4840d1bd88de8beac21
+  metadata.gz: be248e41731a4f4e86d99397bc780980e468e643
+  data.tar.gz: 5f673b82043892b20214caa66c872266916a6df9
 SHA512:
-  metadata.gz: 75adf0c282766b84c1d7be3fc5dab6567951b36f0d63456c12406a7845ccc401f1fb258b93de6e6e150c4fea2c5349bf50eee4719e8f7eeab40979a7b9cd86db
-  data.tar.gz: d9ed4ec4656056f296bdacab25b8ab980164330f62477c0333a1a3d4c7a0874665cde88e0c9e172cae11c0e1d4b0df323b0a9a5626f657e92681a7577320af70
+  metadata.gz: ebe7cd7ba80d155daf102d4e77ec18b595cec2640d58c87aa94b05f7c2fe566bd62e61b391a4a8beffb259f5b8fa3b1bab84de0aa4080ccbf38da4afebd21573
+  data.tar.gz: 5ae089f9bc5ac3993962398c0e31f0e715f00c418f313af7990e614d8bcff61da5230f2c544997d56914af3ede4cc4c155a1e8e94c2493221a894f4fd273a316

data/.travis.yml

@@ -6,7 +6,6 @@ rvm:
   - 1.9.3
   - 2.0.0
   - jruby-19mode
-  - rbx
 
 env:
   - PATTERN=keen

data/README.md

@@ -83,6 +83,8 @@ Next, run an instance of EventMachine. If you're using an EventMachine-based web
 thin or goliath you're already doing this. Otherwise, you'll need to start an EventMachine loop manually as follows:
 
 ```ruby
+require 'em-http-request'
+
 Thread.new { EventMachine.run }
 ```
 
@@ -116,6 +118,8 @@ Keen.sum("purchases", :target_property => "price")  # => 10000
 Keen.minimum("purchases", :target_property => "price")  # => 20
 Keen.maximum("purchases", :target_property => "price")  # => 100
 Keen.average("purchases", :target_property => "price")  # => 60
+Keen.median("purchases", :target_property => "price")  # => 60
+Keen.percentile("purchases", :target_property => "price", :percentile => 90)  # => 100
 
 Keen.sum("purchases", :target_property => "price", :group_by => "item.id")  # => [{ "item.id": 123, "result": 240 }, { ... }]
 
@@ -283,6 +287,10 @@ EventMachine itself won't do this because it runs in a different thread. Here's
 
 ### Changelog
 
+##### 0.8.2
++ Add support for `median` and `percentile` analysis
++ Support arrays for extraction `property_names` option
+
 ##### 0.8.1
 + Add support for asynchronous batch publishing
 

data/lib/keen.rb

@@ -44,7 +44,7 @@ module Keen
     def_delegators :default_client,
                    :count, :count_unique, :minimum, :maximum,
                    :sum, :average, :select_unique, :funnel, :extraction,
-                   :multi_analysis
+                   :multi_analysis, :median, :percentile
 
     def_delegators :default_client,
                    :delete

data/lib/keen/client.rb

@@ -101,6 +101,8 @@ module Keen
       preprocess_encodables(params)
       preprocess_timeframe(params)
       preprocess_group_by(params)
+      preprocess_percentile(params)
+      preprocess_property_names(params)
 
       query_params = ""
       params.each do |param, value|
@@ -133,6 +135,19 @@ module Keen
       end
     end
 
+    def preprocess_percentile(params)
+      if params.key?(:percentile)
+        params[:percentile] = params[:percentile].to_s
+      end
+    end
+
+    def preprocess_property_names(params)
+      property_names = params[:property_names]
+      if property_names.is_a?(Array)
+        params[:property_names] = MultiJson.encode(property_names)
+      end
+    end
+
     def method_missing(_method, *args, &block)
       if config = CONFIG[_method.to_sym]
         if config.is_a?(Proc)

data/lib/keen/client/querying_methods.rb

@@ -97,6 +97,39 @@ module Keen
         query(__method__, event_collection, params)
       end
 
+      # Runs a median query.
+      # See detailed documentation here:
+      # https://keen.io/docs/api/reference/#median-resource
+      #
+      # @param event_collection
+      # @param params [Hash] (optional)
+      #   target_property (required)
+      #   group_by (optional)
+      #   timeframe (optional)
+      #   interval (optional)
+      #   filters (optional) [Array]
+      #   timezone (optional)
+      def median(event_collection, params)
+        query(__method__, event_collection, params)
+      end
+
+      # Runs a percentile query.
+      # See detailed documentation here:
+      # https://keen.io/docs/api/reference/#percentile-resource
+      #
+      # @param event_collection
+      # @param params [Hash] (optional)
+      #   target_property (required)
+      #   percentile (required)
+      #   group_by (optional)
+      #   timeframe (optional)
+      #   interval (optional)
+      #   filters (optional) [Array]
+      #   timezone (optional)
+      def percentile(event_collection, params)
+        query(__method__, event_collection, params)
+      end
+
       # Runs a select_unique query.
       # See detailed documentation here:
       # https://keen.io/docs/api/reference/#select-unique-resource
@@ -161,14 +194,15 @@ module Keen
       private
 
       def query(query_name, event_collection, params)
+        query_params = clone_params(params)
         ensure_project_id!
         ensure_read_key!
 
         if event_collection
-          params[:event_collection] = event_collection.to_s
+          query_params[:event_collection] = event_collection.to_s
         end
 
-        query_params = preprocess_params(params)
+        query_params = preprocess_params(query_params)
 
         begin
           response = Keen::HTTP::Sync.new(self.api_url, self.proxy_url).get(
@@ -182,6 +216,10 @@ module Keen
         process_response(response.code, response_body)["result"]
       end
 
+      def clone_params(params)
+        params.dup
+      end
+
       def api_query_resource_path(analysis_type)
         "/#{self.api_version}/projects/#{self.project_id}/queries/#{analysis_type}"
       end

data/lib/keen/version.rb

@@ -1,3 +1,3 @@
 module Keen
-  VERSION = "0.8.1"
+  VERSION = "0.8.2"
 end

data/spec/integration/api_spec.rb

@@ -188,6 +188,15 @@ describe "Keen IO API" do
       Keen.average(event_collection, :target_property => "price").should == 15
     end
 
+    it "should return a valid median" do
+      Keen.median(event_collection, :target_property => "price").should == 10
+    end
+
+    it "should return a valid percentile" do
+      Keen.percentile(event_collection, :target_property => "price", :percentile => 50).should == 10
+      Keen.percentile(event_collection, :target_property => "price", :percentile => 100).should == 20
+    end
+
     it "should return a valid select_unique" do
       results = Keen.select_unique(event_collection, :target_property => "price")
       results.sort.should == [10, 20].sort
@@ -197,6 +206,24 @@ describe "Keen IO API" do
       results = Keen.extraction(event_collection)
       results.length.should == 2
       results.all? { |result| result["keen"] }.should be_true
+      results.map { |result| result["price"] }.sort.should == [10, 20]
+      results.map { |result| result["username"] }.sort.should == ["bob", "ted"]
+    end
+
+    it "should return a valid extraction of one property name" do
+      results = Keen.extraction(event_collection, :property_names => "price")
+      results.length.should == 2
+      results.any? { |result| result["keen"] }.should be_false
+      results.map { |result| result["price"] }.sort.should == [10, 20]
+      results.map { |result| result["username"] }.sort.should == [nil, nil]
+    end
+
+    it "should return a valid extraction of more than one property name" do
+      results = Keen.extraction(event_collection, :property_names => ["price", "username"])
+      results.length.should == 2
+      results.any? { |result| result["keen"] }.should be_false
+      results.map { |result| result["price"] }.sort.should == [10, 20]
+      results.map { |result| result["username"] }.sort.should == ["bob", "ted"]
     end
 
     it "should return a valid funnel" do

data/spec/keen/client/querying_methods_spec.rb

@@ -17,7 +17,7 @@ describe Keen::Client do
   describe "querying names" do
     let(:params) { { :event_collection => "signups" } }
 
-    ["minimum", "maximum", "sum", "average", "count", "count_unique", "select_unique", "extraction", "multi_analysis"].each do |query_name|
+    ["minimum", "maximum", "sum", "average", "count", "count_unique", "select_unique", "extraction", "multi_analysis", "median", "percentile"].each do |query_name|
       it "should call keen query passing the query name" do
         client.should_receive(:query).with(query_name.to_sym, event_collection, params)
         client.send(query_name, event_collection, params)
@@ -75,17 +75,27 @@ describe Keen::Client do
         filter_str = CGI.escape(MultiJson.encode(filters))
         test_query("&filters=#{filter_str}", :filters => filters)
       end
-      
+
       it "should encode a single group by property" do
         test_query("&group_by=one%20foo", :group_by => "one foo")
       end
-      
+
       it "should encode multi-group by properly" do
         group_by = ["one", "two"]
         group_by_str = CGI.escape(MultiJson.encode(group_by))
         test_query("&group_by=#{group_by_str}", :group_by => group_by)
       end
 
+      it "should encode an array of property names property" do
+        property_names = ["one", "two"]
+        property_names_str = CGI.escape(MultiJson.encode(property_names))
+        test_query("&property_names=#{property_names_str}", :property_names => property_names)
+      end
+
+      it "should encode a percentile decimal properly" do
+        test_query("&percentile=99.99", :percentile => 99.99)
+      end
+
       it "should encode absolute timeframes properly" do
         timeframe = {
           :start => "2012-08-13T19:00Z+00:00",
@@ -119,6 +129,17 @@ describe Keen::Client do
         }.to raise_error(Keen::AuthenticationError)
         expect_keen_get(url, "sync", read_key)
       end
+
+      it "should not change the extra params" do
+        timeframe = {
+          :start => "2012-08-13T19:00Z+00:00",
+          :end => "2012-08-13T19:00Z+00:00",
+        }
+        timeframe_str =  CGI.escape(MultiJson.encode(timeframe))
+
+        test_query("&timeframe=#{timeframe_str}", options = {:timeframe => timeframe})
+        options.should eq({:timeframe => timeframe})
+      end
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: keen
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.8.2
 platform: ruby
 authors:
 - Kyle Wild
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-04 00:00:00.000000000 Z
+date: 2014-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json