vanity 1.3.0 → 1.4.0.beta

data/test/metric/base_test.rb

@@ -0,0 +1,293 @@
+require "test/test_helper"
+
+
+context "Metric via playground" do
+
+  test "knows all loaded metrics" do
+    metric "Yawns/sec", "Cheers/sec"
+    assert Vanity.playground.metrics.keys.include?(:yawns_sec)
+    assert Vanity.playground.metrics.keys.include?(:cheers_sec)
+  end
+
+  test "loads metric definitions" do
+    File.open "tmp/experiments/metrics/yawns_sec.rb", "w" do |f|
+      f.write <<-RUBY
+        metric "Yawns/sec" do
+          def xmts
+            "x"
+          end
+        end
+      RUBY
+    end
+    assert_equal "x", Vanity.playground.metric(:yawns_sec).xmts
+  end
+
+  test "bubbles up loaded metrics" do
+    File.open "tmp/experiments/metrics/yawns_sec.rb", "w" do |f|
+      f.write "fail 'yawn!'"
+    end
+    assert_raises NameError do
+      Vanity.playground.metric(:yawns_sec)
+    end
+  end
+
+  test "map identifier from file name" do
+    File.open "tmp/experiments/metrics/yawns_sec.rb", "w" do |f|
+      f.write <<-RUBY
+        metric "yawns/hour" do
+        end
+      RUBY
+    end
+    assert Vanity.playground.metric(:yawns_sec)
+  end
+
+  test "fails tracking unknown metric" do
+    assert_raises NameError do
+      Vanity.playground.track! :yawns_sec
+    end
+  end
+
+  test "reloading metrics" do
+    metric "Yawns/sec", "Cheers/sec"
+    Vanity.playground.metric(:yawns_sec)
+    Vanity.playground.metric(:cheers_sec)
+    assert_equal 2, Vanity.playground.metrics.size
+    metrics = Vanity.playground.metrics.values
+    Vanity.playground.reload!
+    assert_equal 0, Vanity.playground.metrics.size
+    assert_not_equal metrics, Vanity.playground.metrics.values
+  end
+
+  test "ignores undefined metrics in database" do
+    metric "Yawns/sec"
+    Vanity.playground.reload!
+    assert Vanity.playground.metrics.empty?
+  end
+
+end
+
+
+context "Metric tracking" do
+  test "disabled when metrics are disabled" do
+    not_collecting!
+    metric "Yawns/sec", "Cheers/sec"
+    Vanity.playground.track! :yawns_sec
+    Vanity.playground.track! :cheers_sec
+  end
+
+  test "can count" do
+    metric "Yawns/sec", "Cheers/sec"
+    4.times { Vanity.playground.track! :yawns_sec }
+    2.times { Vanity.playground.track! :cheers_sec }
+    yawns = Vanity.playground.metric(:yawns_sec).values(today, today).first
+    cheers = Vanity.playground.metric(:cheers_sec).values(today, today).first
+    assert yawns = 2 * cheers
+  end
+
+  test "can tell the time" do
+    metric "Yawns/sec"
+    Timecop.freeze(today - 4) { 4.times { Vanity.playground.track! :yawns_sec } }
+    Timecop.freeze(today - 2) { 2.times { Vanity.playground.track! :yawns_sec } }
+    1.times { Vanity.playground.track! :yawns_sec }
+    boredom = Vanity.playground.metric(:yawns_sec).values(today - 5, today)
+    assert_equal [0,4,0,2,0,1], boredom
+  end
+
+  test "with no value" do
+    metric "Yawns/sec", "Cheers/sec", "Looks"
+    Vanity.playground.track! :yawns_sec, 0
+    Vanity.playground.track! :cheers_sec
+    assert_equal 0, Vanity.playground.metric(:yawns_sec).values(today, today).sum
+    assert_equal 1, Vanity.playground.metric(:cheers_sec).values(today, today).sum
+  end
+
+  test "with count" do
+    metric "Yawns/sec"
+    Timecop.freeze(today - 4) { Vanity.playground.track! :yawns_sec, 4 }
+    Timecop.freeze(today - 2) { Vanity.playground.track! :yawns_sec, 2 }
+    Vanity.playground.track! :yawns_sec
+    boredom = Vanity.playground.metric(:yawns_sec).values(today - 5, today)
+    assert_equal [0,4,0,2,0,1], boredom
+  end
+
+  test "runs hook" do
+    metric "Many Happy Returns"
+    total = 0
+    Vanity.playground.metric(:many_happy_returns).hook do |metric_id, timestamp, count|
+      assert_equal :many_happy_returns, metric_id
+      assert_in_delta Time.now.to_i, timestamp.to_i, 1
+      total += count
+    end
+    Vanity.playground.track! :many_happy_returns, 6
+    assert_equal 6, total
+  end
+
+  test "doesn't runs hook when metrics disabled" do
+    not_collecting!
+    metric "Many Happy Returns"
+    total = 0
+    Vanity.playground.metric(:many_happy_returns).hook do |metric_id, timestamp, count|
+      total += count
+    end
+    Vanity.playground.track! :many_happy_returns, 6
+    assert_equal 0, total
+  end
+
+  test "runs multiple hooks" do
+    metric "Many Happy Returns"
+    returns = 0
+    Vanity.playground.metric(:many_happy_returns).hook { returns += 1 }
+    Vanity.playground.metric(:many_happy_returns).hook { returns += 1 }
+    Vanity.playground.metric(:many_happy_returns).hook { returns += 1 }
+    Vanity.playground.track! :many_happy_returns
+    assert_equal 3, returns
+  end
+
+  test "destroy wipes metrics" do
+    metric "Many Happy Returns"
+    Vanity.playground.track! :many_happy_returns, 3
+    assert_equal [3], Vanity.playground.metric(:many_happy_returns).values(today, today)
+    Vanity.playground.metric(:many_happy_returns).destroy!
+    assert_equal [0], Vanity.playground.metric(:many_happy_returns).values(today, today)
+  end
+end
+
+
+context "Metric name" do
+  test "can be whatever" do
+    File.open "tmp/experiments/metrics/yawns_sec.rb", "w" do |f|
+      f.write <<-RUBY
+        metric "Yawns per second" do
+        end
+      RUBY
+    end
+    assert_equal "Yawns per second", Vanity.playground.metric(:yawns_sec).name
+  end
+end  
+
+
+context "Metric description" do
+  test "metric with description" do
+    File.open "tmp/experiments/metrics/yawns_sec.rb", "w" do |f|
+      f.write <<-RUBY
+        metric "Yawns/sec" do
+          description "Am I that boring?"
+        end
+      RUBY
+    end
+    assert_equal "Am I that boring?", Vanity::Metric.description(Vanity.playground.metric(:yawns_sec))
+  end
+
+  test "metric without description" do
+    File.open "tmp/experiments/metrics/yawns_sec.rb", "w" do |f|
+      f.write <<-RUBY
+        metric "Yawns/sec" do
+        end
+      RUBY
+    end
+    assert_nil Vanity::Metric.description(Vanity.playground.metric(:yawns_sec))
+  end
+
+  test "metric with no method description" do
+    metric = Object.new
+    assert_nil Vanity::Metric.description(metric)
+  end
+end
+
+
+context "Metric bounds" do
+  test "metric with bounds" do
+    File.open "tmp/experiments/metrics/sky_is_limit.rb", "w" do |f|
+      f.write <<-RUBY
+        metric "Sky is limit" do
+          def bounds
+            [6,12]
+          end
+        end
+      RUBY
+    end
+    assert_equal [6,12], Vanity::Metric.bounds(Vanity.playground.metric(:sky_is_limit))
+  end
+
+  test "metric without bounds" do
+    metric "Sky is limit"
+    assert_equal [nil, nil], Vanity::Metric.bounds(Vanity.playground.metric(:sky_is_limit))
+  end
+
+  test "metric with no method bounds" do
+    metric = Object.new
+    assert_equal [nil, nil], Vanity::Metric.bounds(metric)
+  end
+end
+
+
+context "Metric last_update_at" do
+  test "for new metric" do
+    metric "Coolness"
+    metric = Vanity.playground.metric(:coolness)
+    assert_nil metric.last_update_at
+  end
+
+  test "with data point" do
+    metric "Coolness"
+    metric = Vanity.playground.metric(:coolness)
+    metric.track!
+    Timecop.freeze Time.now + 1.day do
+      metric.track!
+    end
+    assert_in_delta metric.last_update_at.to_i, (Time.now + 1.day).to_i, 1
+  end
+end 
+
+
+context "Metric data" do
+  test "explicit dates" do
+    metric "Yawns/sec"
+    Timecop.freeze(today - 4) { Vanity.playground.track! :yawns_sec, 4 }
+    Timecop.freeze(today - 2) { Vanity.playground.track! :yawns_sec, 2 }
+    Vanity.playground.track! :yawns_sec
+    boredom = Vanity::Metric.data(Vanity.playground.metric(:yawns_sec), Date.today - 5, Date.today)
+    assert_equal [[today - 5, 0], [today - 4, 4], [today - 3, 0], [today - 2, 2], [today - 1, 0], [today, 1]], boredom
+  end
+
+  test "start date only" do
+    metric "Yawns/sec"
+    Timecop.freeze(today - 4) { Vanity.playground.track! :yawns_sec, 4 }
+    Timecop.freeze(today - 2) { Vanity.playground.track! :yawns_sec, 2 }
+    Vanity.playground.track! :yawns_sec
+    boredom = Vanity::Metric.data(Vanity.playground.metric(:yawns_sec), Date.today - 4)
+    assert_equal [[today - 4, 4], [today - 3, 0], [today - 2, 2], [today - 1, 0], [today, 1]], boredom
+  end
+
+  test "start date and duration" do
+    metric "Yawns/sec"
+    Timecop.freeze(today - 4) { Vanity.playground.track! :yawns_sec, 4 }
+    Timecop.freeze(today - 2) { Vanity.playground.track! :yawns_sec, 2 }
+    Vanity.playground.track! :yawns_sec
+    boredom = Vanity::Metric.data(Vanity.playground.metric(:yawns_sec), 5)
+    assert_equal [[today - 4, 4], [today - 3, 0], [today - 2, 2], [today - 1, 0], [today, 1]], boredom
+  end
+
+  test "no data" do
+    metric "Yawns/sec"
+    boredom = Vanity::Metric.data(Vanity.playground.metric(:yawns_sec))
+    assert_equal 90, boredom.size
+    assert_equal [today - 89, 0], boredom.first
+    assert_equal [today, 0], boredom.last
+  end
+
+  test "using custom values method" do
+    File.open "tmp/experiments/metrics/hours_in_day.rb", "w" do |f|
+      f.write <<-RUBY
+        metric "Hours in day" do
+          def values(from, to)
+            (from..to).map { |d| 24 }
+          end
+        end
+      RUBY
+    end
+    data = Vanity::Metric.data(Vanity.playground.metric(:hours_in_day))
+    assert_equal [24] * 90, data.map(&:last)
+  end
+
+end

data/test/metric/google_analytics_test.rb

@@ -0,0 +1,104 @@
+require "test/test_helper"
+
+
+context "Google Analytics" do
+
+  setup do
+    File.open "tmp/experiments/metrics/ga.rb", "w" do |f|
+      f.write <<-RUBY
+        metric "GA" do
+          google_analytics "UA2"
+        end
+      RUBY
+    end
+  end
+
+  GA_RESULT = Struct.new(:date, :pageviews, :visits)
+  GA_PROFILE = Struct.new(:web_property_id)
+
+  test "fail if Garb not available" do
+    File.open "tmp/experiments/metrics/ga.rb", "w" do |f|
+      f.write <<-RUBY
+        metric "GA" do
+          expects(:require).raises LoadError
+          google_analytics "UA2"
+        end
+      RUBY
+    end
+    assert_raise LoadError do
+      Vanity.playground.metrics
+    end
+  end
+
+  test "constructs a report" do
+    Vanity.playground.metrics
+    assert metric(:ga).report
+  end
+
+  test "default to pageviews metric" do
+    Vanity.playground.metrics
+    assert_equal [:pageviews], metric(:ga).report.metrics.elements
+  end
+
+  test "apply data dimension and sort" do
+    Vanity.playground.metrics
+    assert_equal [:date], metric(:ga).report.dimensions.elements
+    assert_equal [:date], metric(:ga).report.sort.elements
+  end
+
+  test "accept other metrics" do
+    File.open "tmp/experiments/metrics/ga.rb", "w" do |f|
+      f.write <<-RUBY
+        metric "GA" do
+          google_analytics "UA2", :visitors
+        end
+      RUBY
+    end
+    Vanity.playground.metrics
+    assert_equal [:visitors], metric(:ga).report.metrics.elements
+  end
+
+  test "does not support hooks" do
+    Vanity.playground.metrics
+    assert_raises RuntimeError do
+      metric(:ga).hook
+    end
+  end
+
+  test "should find matching profile" do
+    Vanity.playground.metrics
+    Garb::Profile.expects(:all).returns(Array.new(3) { |i| GA_PROFILE.new("UA#{i + 1}") })
+    metric(:ga).report.stubs(:send_request_for_body).returns(nil)
+    Garb::ReportResponse.stubs(:new).returns(mock(:results=>[]))
+    metric(:ga).values(Date.parse("2010-02-10"), Date.parse("2010-02-12"))
+    assert_equal "UA2", metric(:ga).report.profile.web_property_id
+  end
+
+  test "should map results from report" do
+    Vanity.playground.metrics
+    today = Date.today
+    response = mock(:results=>Array.new(3) { |i| GA_RESULT.new("2010021#{i}", i + 1) })
+    Garb::Profile.stubs(:all).returns([])
+    Garb::ReportResponse.expects(:new).returns(response)
+    metric(:ga).report.stubs(:send_request_for_body).returns(nil)
+    assert_equal [1,2,3], metric(:ga).values(Date.parse("2010-02-10"), Date.parse("2010-02-12"))
+  end
+
+  test "mapping GA metrics to single value" do
+    File.open "tmp/experiments/metrics/ga.rb", "w" do |f|
+      f.write <<-RUBY
+        metric "GA" do
+          google_analytics "UA2", :mapper=>lambda { |e| e.pageviews * e.visits }
+        end
+      RUBY
+    end
+    Vanity.playground.metrics
+    today = Date.today
+    response = mock(:results=>Array.new(3) { |i| GA_RESULT.new("2010021#{i}", i + 1, i + 1) })
+    Garb::Profile.stubs(:all).returns([])
+    Garb::ReportResponse.expects(:new).returns(response)
+    metric(:ga).report.stubs(:send_request_for_body).returns(nil)
+    assert_equal [1,4,9], metric(:ga).values(Date.parse("2010-02-10"), Date.parse("2010-02-12"))
+  end
+
+end

data/test/metric/remote_test.rb

@@ -0,0 +1,108 @@
+require "test/test_helper"
+
+
+context "Remote metrics" do
+  setup do
+    FileUtils.mkpath "tmp/config"
+    File.open "tmp/config/vanity.yml", "w" do |f|
+      f.write <<-RUBY
+        metrics:
+          sandbox: http://api.vanitydash.com/metrics/sandbox
+      RUBY
+    end
+    Dir.chdir "tmp" do
+      Vanity.playground.load!
+    end
+  end
+
+  test "load from configuration file" do
+    assert Vanity.playground.metrics[:sandbox]
+  end
+
+  test "create remote metric from configuration file" do
+    stub_request :post, /vanitydash/
+    metric(:sandbox).track!
+    assert_requested :post, /api\.vanitydash\.com/
+  end
+end
+
+
+context "Remote send" do
+  setup do
+    @metric = Vanity::Metric.new(Vanity.playground, :sandbox)
+    @metric.remote "http://api.vanitydash.com/metrics/sandbox"
+    Vanity.playground.metrics[:sandbox] = @metric
+    stub_request :post, /vanitydash/
+  end
+
+  test "remote send in sequence" do
+    Vanity.playground.track! :sandbox
+    Vanity.playground.track! :sandbox
+    assert_requested(:post, "http://api.vanitydash.com/metrics/sandbox", :times=>2)
+  end
+
+  test "remote sends url-encoded data" do
+    Vanity.playground.track! :sandbox, 12
+    assert_requested(:post, /api/) { |request| request.headers["Content-Type"] == "application/x-www-form-urlencoded" }
+  end
+
+  test "remote sends metric identifier" do
+    Vanity.playground.track! :sandbox, 12
+    assert_requested(:post, /api/) { |request| Rack::Utils.parse_query(request.body)["metric"] == "sandbox" }
+  end
+
+  test "remote sends RFC 2616 compliant time stamp" do
+    Vanity.playground.track! :sandbox, 12
+    assert_requested(:post, /api/) { |request| Time.httpdate(Rack::Utils.parse_query(request.body)["timestamp"]) }
+  end
+
+  test "remote sends array of values" do
+    Vanity.playground.track! :sandbox, [1,2,3]
+    assert_requested(:post, /api/) { |request| Rack::Utils.parse_query(request.body)["values[]"] == %w{1 2 3} }
+  end
+
+  test "remote sends default of 1" do
+    Vanity.playground.track! :sandbox
+    assert_requested(:post, /api/) { |request| Rack::Utils.parse_query(request.body)["values[]"] == "1" }
+  end
+
+  test "remote sends current identity" do
+    Vanity.context = Object.new
+    class << Vanity.context
+      def vanity_identity
+        "xkcd"
+      end
+    end
+    Vanity.playground.track! :sandbox, 12
+    assert_requested(:post, /api/) { |request| Rack::Utils.parse_query(request.body)["identity"] == "xkcd" }
+  end
+
+  test "remote sends with additional query parameters" do
+    @metric.remote "http://api.vanitydash.com/metrics/sandbox?ask=receive"
+    Vanity.playground.track! :sandbox, 12
+    assert_requested(:post, /api/) { |request| Rack::Utils.parse_query(request.body)["ask"] == "receive" }
+  end
+
+  test "remote send handles standard error" do
+    stub_request(:post, /api/).to_raise(StandardError)
+    Vanity.playground.track! :sandbox
+    stub_request(:post, /api/)
+    Vanity.playground.track! :sandbox
+    assert_requested(:post, /api/, :times=>2)
+  end
+
+  test "remote send handles timeout error" do
+    stub_request(:post, /api/).to_timeout
+    Vanity.playground.track! :sandbox
+    stub_request(:post, /api/)
+    Vanity.playground.track! :sandbox
+    assert_requested(:post, /api/, :times=>2)
+  end
+
+  test "remote does not send when metrics disabled" do
+    not_collecting!
+    Vanity.playground.track! :sandbox
+    Vanity.playground.track! :sandbox
+    assert_requested(:post, /api/, :times=>0)
+  end
+end