mixpannenkoek 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6086d33df79e9b37754ec4834a758f08f84097ab
-  data.tar.gz: 5b14c50436929af2868ca126a10cab450175ef0e
+  metadata.gz: a7399793b312fda362a710cab02c13c0061f3181
+  data.tar.gz: 3d4990a74dc58c7d011c83d7d9f0794ceb0eba76
 SHA512:
-  metadata.gz: 4cf1c431e9737f3235f9aba98c9fb976357e220bb40eded73654f5365bc6102776af5bb5297b62baa70a37ab19df9309d612d1f0f8660ceb1a30fe1e09d4b736
-  data.tar.gz: f267b2d654372851d60d078da1da63c39cb4c0802e54331ae7afcf1045192af733f3a8cdab8cb3d5786d98dd80565c05e70e29cfdd416a0d38edbff034c908bc
+  metadata.gz: ebed70b8633f90ef5976f67defa8d8351e47e5ac9690fafd1ec192f0d55151c25f212aa0235d604892a3e419d7b090dcc39f3026d4f1d5a890fe20ecca329634
+  data.tar.gz: a93ba52c09f8f521558305c7432f5115bc253f43d9f25933eeb6422c0df350984a5ced58048153356829fa565bf937fb77c291e75ddea36733c7c6e5451095f1

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Derek Kraan
+Copyright (c) 2014 Springest BV
 
 MIT License
 

data/README.md

@@ -1,6 +1,6 @@
 # Mixpannenkoek
 
-TODO: Write a gem description
+This gem implements a fluent query interface for mixpanel_client.
 
 ## Installation
 
@@ -18,7 +18,47 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Begin by configuring a model.
+
+```ruby
+class ConversionFunnel < Mixpannenkoek::Base
+  set_api_key 'MY_API_KEY'
+  set_api_secret 'MY_API_SECRET'
+  set_endpoint 'funnels'
+  
+  default_scope { set(funnel_id: 123456) }
+end
+```
+
+Build up a query with `where`, `group`, and `set`.
+
+```ruby
+ConversionFunnel.where(date: 31.days.ago..1.day.ago)
+
+ConversionFunnel.where(date: 31.days.ago..1.day.ago).where(user_id: 123).set(interval: 50).group('traffic_source')
+```
+
+Operate on the query results fluently
+
+```ruby
+ConversionFunnel.where(date: 31.days.ago..1.day.ago).map { |date,data| data['steps'].last['count'] }
+#=> [1, 4, 2]
+```
+
+Organize your query models with default scopes. Default scopes are heritable, so they will be automatically be applied to subclasses.
+```ruby
+class ConversionFunnel < Mixpannenkoek::Base
+  default_scope { set(interval: 50) }
+  default_scope { where(user_type: 'visitor') }
+end
+
+# default scopes are heritable
+# (GroupedConversionFunnel will get the default scopes
+# of ConversionFunnel, in addition to its own)
+class GroupedConversionFunnel < ConversionFunnel
+  default_scope { group('traffic_source') }
+end
+```
 
 ## Contributing
 

data/lib/mixpannenkoek/base.rb

@@ -1,3 +1,5 @@
+require 'mixpannenkoek/class_inheritable_attribute'
+
 module Mixpannenkoek
   class Base
     extend ::Mixpannenkoek::ClassInheritableAttribute

data/lib/mixpannenkoek/query.rb

@@ -2,13 +2,6 @@ require 'rubygems'
 require 'mixpanel_client'
 
 module Mixpannenkoek
-  class Benchmark
-    def self.ms(&block)
-      return block.call unless defined?(::Benchmark)
-      ::Benchmark.ms(&block)
-    end
-  end
-
   class Query
     class MissingRange < Exception; end
     class MissingConfiguration < Exception; end
@@ -114,11 +107,16 @@ module Mixpannenkoek
 
     def response_data
       check_parameters
-      time = Benchmark.ms do
+      log do
         @mixpanel_request ||= mixpanel_client.request(*request_parameters)
       end
-      Rails.logger.info "  Mixpanel (#{time.round(1)}ms) #{request_parameters.inspect}" if defined? Rails
       @mixpanel_request
     end
+
+    def log(&block)
+      return block.call unless defined?(::Benchmark)
+      time = ::Benchmark.ms(&block)
+      Rails.logger.info "  Mixpanel (#{time.round(1)}ms) #{request_parameters.inspect}" if defined? Rails
+    end
   end
 end

data/lib/mixpannenkoek/version.rb

@@ -1,3 +1,3 @@
 module Mixpannenkoek
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/fixtures/funnel_response_data.json

@@ -1,29 +1,29 @@
-{"Signup flow": {"data": {"2010-05-24": {"analysis": {"completion": 0.064679359580052493,
-                                               "starting_amount": 762,
-                                               "steps": 3,
-                                               "worst": 2},
-                                  "steps": [{"count": 762,
-                                             "goal": "pages",
-                                             "overall_conv_ratio": 1.0,
-                                             "step_conv_ratio": 1.0},
-                                            {"count": 69,
-                                             "goal": "View signup",
-                                             "overall_conv_ratio": 0.09055118110236221,
-                                             "step_conv_ratio": 0.09055118110236221},
-                                            {"count": 10,
-                                             "goal": "View docs",
-                                             "overall_conv_ratio": 0.064679359580052493,
-                                             "step_conv_ratio": 0.7142857142857143}]},
-                   "2010-05-31": {"analysis": {"completion": 0.12362030905077263,
-                                               "starting_amount": 906,
-                                               "steps": 2,
-                                               "worst": 2},
-                                  "steps": [{"count": 906,
-                                             "goal": "homepage",
-                                             "overall_conv_ratio": 1.0,
-                                             "step_conv_ratio": 1.0},
-                                            {"count": 112,
-                                             "goal": "View signup",
-                                             "overall_conv_ratio": 0.12362030905077263,
-                                             "step_conv_ratio": 0.12362030905077263}]}},
-          "meta": {"dates": ["2010-05-24", "2010-05-31"]}}}
+{"data": {"2010-05-24": {"analysis": {"completion": 0.064679359580052493,
+  "starting_amount": 762,
+  "steps": 3,
+  "worst": 2},
+"steps": [{"count": 762,
+  "goal": "pages",
+  "overall_conv_ratio": 1.0,
+  "step_conv_ratio": 1.0},
+{"count": 69,
+  "goal": "View signup",
+  "overall_conv_ratio": 0.09055118110236221,
+  "step_conv_ratio": 0.09055118110236221},
+{"count": 10,
+  "goal": "View docs",
+  "overall_conv_ratio": 0.064679359580052493,
+  "step_conv_ratio": 0.7142857142857143}]},
+  "2010-05-31": {"analysis": {"completion": 0.12362030905077263,
+    "starting_amount": 906,
+    "steps": 2,
+    "worst": 2},
+  "steps": [{"count": 906,
+    "goal": "homepage",
+    "overall_conv_ratio": 1.0,
+    "step_conv_ratio": 1.0},
+  {"count": 112,
+    "goal": "View signup",
+    "overall_conv_ratio": 0.12362030905077263,
+    "step_conv_ratio": 0.12362030905077263}]}},
+    "meta": {"dates": ["2010-05-24", "2010-05-31"]}}

data/spec/lib/mixpannenkoek/query_spec.rb

@@ -96,24 +96,25 @@ describe Mixpannenkoek::Base do
     end
   end
 
-  describe '#to_hash' do
-    subject { Mixpannenkoek::TestQuery.where(date: date_range).to_hash }
+  describe '#results' do
+    subject { Mixpannenkoek::TestQuery.where(date: date_range).results }
 
     let(:response_data) { JSON.parse(File.open("#{File.dirname(__FILE__)}/../../fixtures/funnel_response_data.json").read) }
     before { Mixpanel::Client.any_instance.stub(:request).and_return(response_data) }
 
-    it 'returns the response data' do
-      expect(subject).to eq response_data
+    it 'returns a Mixpannenkoek::Results::Base object' do
+      expect(subject).to be_a Mixpannenkoek::Results::Base
     end
   end
 
   describe '#method_missing' do
-    before { Mixpannenkoek::Query.any_instance.stub(:mixpanel_request).and_return({ "funnel" => { "data" => { "2014-01-01" => [{ 'count' => '1' }, { 'count' => '4' }] } } }) }
-    it 'delegates all calls to #to_hash.send(*args)' do
-      expect(Mixpannenkoek::TestQuery.where(date: date_range).keys).to eq ['funnel']
+    before { Mixpanel::Client.any_instance.stub(:request).and_return({ "data" => { "2014-01-01" => [{ 'count' => '1' }, { 'count' => '4' }] } }) }
+    it 'delegates all calls to #results.send(*args)' do
+      expect(Mixpannenkoek::TestQuery.where(date: date_range).keys).to eq ['2014-01-01']
     end
+
     it 'delegates blocks' do
-      expect(Mixpannenkoek::TestQuery.where(date: date_range)['funnel']['data'].values[0].map { |hash| hash['count'] }).to eq ['1','4']
+      expect(Mixpannenkoek::TestQuery.where(date: date_range).values[0].map { |hash| hash['count'] }).to eq ['1','4']
     end
   end
 

data/spec/lib/mixpannenkoek/results/base_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Mixpannenkoek::Results::Base do
+  let(:response_data) { JSON.parse(File.open("#{File.dirname(__FILE__)}/../../../fixtures/funnel_response_data.json").read) }
+
+  describe '#to_hash' do
+    subject { described_class.new(response_data).to_hash }
+    it 'returns the response data' do
+      expect(subject).to eq response_data
+    end
+  end
+
+  describe '#response_data' do
+    subject { described_class.new(response_data).response_data }
+    it 'returns the response data' do
+      expect(subject).to eq response_data
+    end
+  end
+
+  describe '#method_missing' do
+    subject { described_class.new(response_data) }
+    it 'delegates to to_hash' do
+      expect(subject.keys).to eq ['data', 'meta']
+    end
+  end
+end

data/spec/lib/mixpannenkoek/results/funnels_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Mixpannenkoek::Results::Funnels do
+  let(:response_data) { JSON.parse(File.open("#{File.dirname(__FILE__)}/../../../fixtures/funnel_response_data.json").read) }
+
+  describe '#to_hash' do
+    subject { described_class.new(response_data).to_hash }
+    it 'returns the response data' do
+      expect(subject).to eq response_data['data']
+    end
+  end
+
+  describe '#response_data' do
+    subject { described_class.new(response_data).response_data }
+    it 'returns the response data' do
+      expect(subject).to eq response_data
+    end
+  end
+
+  describe '#method_missing' do
+    subject { described_class.new(response_data) }
+    it 'delegates to to_hash' do
+      expect(subject.keys).to eq ['2010-05-24', '2010-05-31']
+    end
+  end
+end

data/spec/lib/mixpannenkoek/results_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Mixpannenkoek::Results do
+  describe '.new' do
+    subject { Mixpannenkoek::Results.new(endpoint,  {}) }
+
+    context 'any endpoint' do
+      let(:endpoint) { 'endpoint' }
+      it { expect(subject).to be_a Mixpannenkoek::Results::Base }
+    end
+
+    context 'funnels endoint' do
+      let(:endpoint) { 'funnels' }
+      it { expect(subject).to be_a Mixpannenkoek::Results::Funnels }
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mixpannenkoek
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Derek Kraan
@@ -92,6 +92,9 @@ files:
 - spec/lib/mixpannenkoek/base_spec.rb
 - spec/lib/mixpannenkoek/class_inheritable_attributes_spec.rb
 - spec/lib/mixpannenkoek/query_spec.rb
+- spec/lib/mixpannenkoek/results/base_spec.rb
+- spec/lib/mixpannenkoek/results/funnels_spec.rb
+- spec/lib/mixpannenkoek/results_spec.rb
 - spec/lib/mixpannenkoek_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/Springest/mixpannenkoek
@@ -123,5 +126,8 @@ test_files:
 - spec/lib/mixpannenkoek/base_spec.rb
 - spec/lib/mixpannenkoek/class_inheritable_attributes_spec.rb
 - spec/lib/mixpannenkoek/query_spec.rb
+- spec/lib/mixpannenkoek/results/base_spec.rb
+- spec/lib/mixpannenkoek/results/funnels_spec.rb
+- spec/lib/mixpannenkoek/results_spec.rb
 - spec/lib/mixpannenkoek_spec.rb
 - spec/spec_helper.rb