blackbeard 0.0.2.0 → 0.0.3.1

data/dashboard/views/metrics/show.erb

@@ -0,0 +1,73 @@
+<div class="page-header">
+  <h1><span id="editable-name"><%= @metric.name %></span> <small><%= @metric.type %></small></h1>
+<p id="editable-description"><%= @metric.description %></p>
+</div>
+<form id="add_group" action="<%= url("/metrics/#{@metric.type}/#{@metric.type_id}/groups") %>" method="post"><input id="add_group_input" type="hidden" name="group_id"></form>
+<ul class="nav nav-tabs">
+  <% if @group.nil? %><li class="active"><% else %><li><% end %><a href="?">All</a></li>
+  <% @metric.groups.each do |group| %>
+    <% if @group == group %><li class="active"><% else %><li><% end %><a href="?group_id=<%= group.id %>"><%= group.name %></a></li>
+  <% end %>
+  <% if @metric.addable_groups.any? %>
+  <li class="dropdown">
+     <a id="drop5" role="button" data-toggle="dropdown" href="#">Segment by Group <b class="caret"></b></a>
+        <ul id="menu2" class="dropdown-menu" role="menu" aria-labelledby="drop5">
+          <% @metric.addable_groups.each do |group| %>
+          <li role="presentation" data-group-id="<%= group.id %>" data-group-name="<%= group.name %>" class="add-group"><a role="menuitem" tabindex="-1" href="#"><%= group.name %></a></li>
+          <% end %>
+        </ul>
+  </li>
+  <% end %>
+</ul>
+
+<!--Load the AJAX API-->
+<script src="<%= url('javascripts/jquery-1.10.2.min.js') %>"></script>
+<script src="<%= url('javascripts/bootstrap.min.js') %>"></script>
+<script src="<%= url('bootstrap3-editable/js/bootstrap-editable.min.js') %>"></script>
+<script type="text/javascript" src="https://www.google.com/jsapi"></script>
+<script type="text/javascript">
+  $('ul.nav-tabs').on("click", ".add-group", function (e) {
+    e.preventDefault();
+    var groupId = $(this).data("group-id");
+    var groupName = $(this).data("group-name");
+
+    if(confirm("Start collecting data by group "+groupName+"?")) {
+      $('#add_group_input').val(groupId);
+      $('#add_group').submit();
+    }
+  });
+
+    //turn to inline mode
+  $.fn.editable.defaults.send = 'always';
+  $.fn.editable.defaults.params = function(params) {
+        var obj = {};
+        obj[params.name] = params.value;
+        return obj;
+  }
+
+  $(document).ready(function() {
+    $('#editable-name').editable({
+      placement: 'right',
+      type: 'text',
+      url: '<%= url("metrics/#{@metric.type}/#{@metric.type_id}") %>',
+      name: 'name',
+      title: 'Edit metric name',
+      validate: function(value) {
+         if($.trim(value) == '') {
+          return 'This field is required';
+        }
+      }
+    });
+    $('#editable-description').editable({
+      placement: 'bottom',
+      type: 'textarea',
+      url: '<%= url("metrics/#{@metric.type}/#{@metric.type_id}") %>',
+      name: 'description',
+      title: 'Edit metric description'
+    });
+  });
+</script>
+<%= partial :'metrics/metric_data', :locals => {:metric_data => @metric.metric_data(@group) } %>
+
+
+

data/dashboard/views/tests/index.erb

@@ -0,0 +1,21 @@
+<div class="page-header">
+  <h1>Tests</h1>
+  <p>Tests are elements or features that you can change or turn off.</p>
+</div>
+
+<% if @tests.any? %>
+<div class="panel panel-primary">
+  <div class="panel-heading">
+    <h3 class="panel-title">Active Tests</h3>
+  </div>
+  <ul class="list-group">
+  <% @tests.each do |test| %>
+  <li class="list-group-item"><a href="<%= url("tests/#{test.id}") %>"><%= test.name %></a></li>
+  <% end %>
+  </ul>
+</div>
+<% else %>
+  <div class="alert alert-danger">
+    <strong>No tests!</strong> Something may be wrong or you may just need to define some tests.
+  </div>
+<% end %>

data/dashboard/views/tests/show.erb

@@ -0,0 +1,58 @@
+<div class="page-header">
+  <h1><span id="editable-name"><%= @test.name %></span></h1>
+  <p id="editable-description"><%= @test.description %></p>
+</div>
+
+<% if @test.variations.any? %>
+<div class="panel panel-primary">
+  <div class="panel-heading">
+    <h3 class="panel-title">Known Variations</h3>
+  </div>
+  <ul class="list-group">
+  <% @test.variations.each do |variant| %>
+  <li class="list-group-item"><%= variant %></li>
+  <% end %>
+  </ul>
+</div>
+
+<% else %>
+  <div class="alert alert-danger">
+    <strong>No variations!</strong> Something may be wrong or maybe this test not been called yet.
+  </div>
+<% end %>
+
+<!--Load the AJAX API-->
+<script src="<%= url('javascripts/jquery-1.10.2.min.js') %>"></script>
+<script src="<%= url('javascripts/bootstrap.min.js') %>"></script>
+<script src="<%= url('bootstrap3-editable/js/bootstrap-editable.min.js') %>"></script>
+<script type="text/javascript">
+  //turn to inline mode
+  $.fn.editable.defaults.send = 'always';
+  $.fn.editable.defaults.params = function(params) {
+        var obj = {};
+        obj[params.name] = params.value;
+        return obj;
+  }
+
+  $(document).ready(function() {
+    $('#editable-name').editable({
+      placement: 'right',
+      type: 'text',
+      url: '<%= url("tests/#{@test.id}") %>',
+      name: 'name',
+      title: 'Edit test name',
+      validate: function(value) {
+         if($.trim(value) == '') {
+          return 'This field is required';
+        }
+      }
+    });
+    $('#editable-description').editable({
+      placement: 'bottom',
+      type: 'textarea',
+      url: '<%= url("tests/#{@test.id}") %>',
+      name: 'description',
+      title: 'Edit test description'
+    });
+  });
+</script>

data/lib/blackbeard/configuration.rb

@@ -1,13 +1,16 @@
 require 'tzinfo'
 require "blackbeard/redis_store"
+require "blackbeard/group"
 
 module Blackbeard
   class Configuration
-    attr_accessor :timezone, :namespace, :redis
+    attr_accessor :timezone, :namespace, :redis, :guest_method
+    attr_reader :group_definitions
 
     def initialize
       @timezone = 'America/Los_Angeles'
       @namespace = 'Blackbeard'
+      @group_definitions = {}
       @redis = nil
     end
 
@@ -19,5 +22,9 @@ module Blackbeard
       @tz ||= TZInfo::Timezone.get(@timezone)
     end
 
+    def define_group(id, &block)
+      @group_definitions[id.to_sym] = block
+      Group.new(id)
+    end
   end
 end

data/lib/blackbeard/configuration_methods.rb

@@ -0,0 +1,24 @@
+module Blackbeard
+  module ConfigurationMethods
+    def self.included(base)
+      base.extend(self)
+    end
+
+    def config
+      Blackbeard.config
+    end
+
+    def db
+      config.db
+    end
+
+    def tz
+      config.tz
+    end
+
+    def guest_method
+      config.guest_method
+    end
+
+  end
+end

data/lib/blackbeard/context.rb

@@ -1,47 +1,59 @@
+require 'blackbeard/selected_variation'
+
 module Blackbeard
   class Context
+    include ConfigurationMethods
+    attr_reader :controller, :user
 
-    def initialize(pirate, options)
+    def initialize(pirate, user, controller = nil)
       @pirate = pirate
-      @user_id = options[:user_id]
-      @bot = options[:bot] || false
-      @cookies = options[:cookies] || {}
-      raise NonIdentifyingContextError unless @cookies || @user_id
+      @controller = controller
+      @user = user
+
+      if (@user == false) || (@user && guest_method && @user.send(guest_method) == false)
+        @user = nil
+      end
     end
 
-    def add_total(name, amount = 1)
-      @pirate.total_metric(name.to_s).add(unique_identifier, amount) unless bot?
+    def add_total(id, amount = 1)
+      @pirate.metric(:total, id.to_s).add(self, amount)
       self
     end
 
-    def add_unique(name)
-      @pirate.unique_metric(name.to_s).add(unique_identifier) unless bot?
+    def add_unique(id)
+      @pirate.metric(:unique, id.to_s).add(self, 1)
       self
     end
 
-    def feature(name, options = {})
-      variations = options.keys
-      variation_to_show = @pirate.feature(name.to_s).select_variation(variations, unique_identifier)
-      options[:variation_to_show]
+    def ab_test(id, options = nil)
+      test = @pirate.test(id.to_s)
+      if options.is_a? Hash
+        test.add_variations(options.keys)
+        variation = test.select_variation
+        options[variation.to_sym]
+      else
+        variation = test.select_variation
+        SelectedVariation.new(test, variation)
+      end
     end
 
-    def bot?
-      @bot
+    def active?(id)
+      ab_test(id) == :active
     end
 
     def unique_identifier
-      @user_id.nil? ? "b#{blackbeard_visitor_id}" : "a#{@user_id}"
+      @user.nil? ? "b#{blackbeard_visitor_id}" : "a#{@user.id}"
     end
 
 private
 
-    def blackbeard_visitor_id(cookies)
-      @cookies[:bbd] ||= generate_blackbeard_visitor_id(cookies)
+    def blackbeard_visitor_id
+      controller.request.cookies[:bbd] ||= generate_blackbeard_visitor_id
     end
 
-    def generate_blackbeard_visitor_id(cookies)
-      id = Blackbeard.db.increment("visitor_id")
-      @cookies[:bbd] = { :value => id, :expires => Time.now + 31536000 }
+    def generate_blackbeard_visitor_id
+      id = db.increment("visitor_id")
+      controller.request.cookies[:bbd] = { :value => id, :expires => Time.now + 31536000 }
       id
     end
 

data/lib/blackbeard/dashboard.rb

@@ -1,30 +1,26 @@
+$LOAD_PATH << File.expand_path('../../../dashboard', __FILE__)
+
 require 'sinatra/base'
 require 'blackbeard'
-require 'blackbeard/dashboard/helpers'
+require 'blackbeard/dashboard_helpers'
+require 'routes/base'
+require 'routes/home'
+require 'routes/groups'
+require 'routes/metrics'
+require 'routes/tests'
 
 module Blackbeard
   class Dashboard < Sinatra::Base
-    set :root, File.expand_path(File.dirname(__FILE__) + "/dashboard")
-    set :public_folder, Proc.new { "#{root}/public" }
-    set :views, Proc.new { "#{root}/views" }
-    set :raise_errors, true
-    set :show_exceptions, false
-
-    helpers Blackbeard::DashboardHelpers
-
-    get '/' do
-      redirect url('/metrics')
-    end
-
-    get '/metrics' do
-      @metrics = Blackbeard::Metric.all
-      erb 'metrics/index'.to_sym
-    end
-
-    get "/metrics/:type/:name" do
-      @metric = Blackbeard::Metric.new_from_type_name(params[:type], params[:name])
-      erb 'metrics/show'.to_sym
+    configure do
+      set :public_folder, Proc.new { "#{root}/public" }
     end
 
+    use DashboardRoutes::Home
+    use DashboardRoutes::Metrics
+    use DashboardRoutes::Tests
+    use DashboardRoutes::Groups
   end
 end
+
+
+

data/lib/blackbeard/dashboard_helpers.rb

@@ -0,0 +1,29 @@
+module Blackbeard
+  module DashboardHelpers
+    def url(path = '')
+      env['SCRIPT_NAME'].to_s + '/' + path
+    end
+
+    def js_date(date)
+      "new Date(#{ date.year }, #{ date.month - 1}, #{ date.day } )"
+    end
+
+    def js_hour(hour)
+      "new Date(#{ hour.year}, #{hour.month - 1 }, #{hour.day}, #{hour.hour})"
+    end
+
+    def js_metric_date(segments, d)
+      row = [js_date(d.date)]
+      segments.each{|s| row.push d.result[s].to_f }
+      "[" + row.join(',') + "]"
+    end
+
+    def js_metric_hour(segments, h)
+      row = [js_hour(h.hour)]
+      segments.each{|s| row.push h.result[s].to_f }
+      "[" + row.join(',') + "]"
+    end
+
+  end
+end
+

data/lib/blackbeard/errors.rb

@@ -1,4 +1,4 @@
 module Blackbeard
-  class MissingContextError < StandardError; end
-  class NonIdentifyingContextError < StandardError; end
+  class GroupNotInMetric < StandardError; end
+  class StorableMasterKeyUndefined < StandardError; end
 end

data/lib/blackbeard/group.rb

@@ -0,0 +1,35 @@
+require 'blackbeard/storable'
+
+module Blackbeard
+  class Group < Storable
+    set_master_key :groups
+    string_attributes :name, :description
+    has_set :segments => :segment
+
+    def name
+      storable_attributes_hash['name'] || id
+    end
+
+    def segment_for(context)
+      return nil unless definition
+      segment = definition.call(context.user, context.controller)
+      segment_id = case segment
+      when  false
+        nil
+      when nil
+        nil
+      when true
+        self.id
+      else
+        segment.to_s
+      end
+      add_segment(segment_id) unless segment_id.nil?
+      segment_id
+    end
+
+    def definition
+      config.group_definitions[self.id.to_sym]
+    end
+
+  end
+end

data/lib/blackbeard/metric.rb

@@ -1,59 +1,61 @@
 require "blackbeard/storable"
+require 'blackbeard/metric_data/total'
+require 'blackbeard/metric_data/unique'
 
 module Blackbeard
   class Metric < Storable
+    attr_reader :type, :type_id
+    set_master_key :metrics
+    string_attributes :name, :description
+    has_many :groups => Group
 
-    def self.new_from_type_name(type, name)
-      self.const_get(type.capitalize).new(name)
-    end
-
-    def type
-      self.class.name.split("::").last.downcase
-    end
-
-    def self.master_key
-      "metrics"
+    def initialize(type, type_id)
+      @type = type
+      @type_id = type_id
+      @metric_data = {}
+      super("#{type}::#{type_id}")
     end
 
     def self.new_from_key(key)
-      if key =~ /^metrics::(.+)::(.+)$/
-        new_from_type_name($1, $2)
+      if key =~ /^#{master_key}::(.+)::(.+)$/
+        new($1,$2)
       else
         nil
       end
     end
 
-    def key
-      "metrics::#{ type }::#{ name }"
+    def recent_hours
+      metric_data.recent_hours
     end
 
-    def hours
-      hour_keys.map do |hour_key|
-        {
-          :hour => hour_key.split("::").last,
-          :result => result_for_hour_key(hour_key)
-        }
-      end
+    def recent_days
+      metric_data.recent_days
     end
 
-    def result_for_hour(time)
-      key = key_for_hour(time)
-      result_for_hour_key(key)
+    def add(context, amount)
+      uid = context.unique_identifier
+      metric_data.add(uid, amount)
+      groups.each do |group|
+        segment = group.segment_for(context)
+        metric_data(group).add(uid, amount, segment) unless segment.nil?
+      end
     end
 
-private
-
-    def hour_keys
-      db.set_members(hours_set_key)
+    def metric_data(group = nil)
+      @metric_data[group] ||= begin
+        raise GroupNotInMetric unless group.nil? || has_group?(group)
+        MetricData.const_get(type.capitalize).new(self, group)
+      end
     end
 
-    def hours_set_key
-      "#{key}::hours"
+    def name
+      storable_attributes_hash['name'] || type_id
     end
 
-    def key_for_hour(time)
-      "#{key}::#{ time.strftime("%Y%m%d%H") }"
+    def addable_groups
+      Group.all.reject{ |g| group_ids.include?(g.id) }
     end
 
+
   end
 end

data/lib/blackbeard/metric_data/base.rb

@@ -0,0 +1,101 @@
+require 'blackbeard/metric_hour'
+require 'blackbeard/metric_date'
+require 'date'
+
+module Blackbeard
+  module MetricData
+    class Base
+      include ConfigurationMethods
+      attr_reader :metric, :group
+
+      def initialize(metric, group = nil)
+        @metric = metric
+        @group = group
+      end
+
+      def recent_days(count=28, starting_on = tz.now.to_date)
+        Array(0..count-1).map do |offset|
+          date = starting_on - offset
+          result = result_for_day(date)
+          Blackbeard::MetricDate.new(date, result)
+        end
+      end
+
+      def recent_hours(count = 24, starting_at = tz.now)
+        Array(0..count-1).map do |offset|
+          hour = starting_at - (offset * 3600)
+          result = result_for_hour(hour)
+          Blackbeard::MetricHour.new(hour, result)
+        end
+      end
+
+      def hour_keys_for_day(date)
+        start_of_day = date.to_time
+        Array(0..23).map{|x| start_of_day + (3600 * x) }.map{|t| key_for_hour(t) }
+      end
+
+      def result_for_day(date)
+        key = key_for_date(date)
+        result = db.hash_get_all(key)
+        result = generate_result_for_day(date) if result.empty?
+        result.each { |k,v| result[k] = v.to_f }
+        result
+      end
+
+      def key
+        @key ||= begin
+          lookup_hash = "metric_data_keys"
+          lookup_field = "metric-#{metric.id}"
+          lookup_field += "::group-#{group.id}" if group
+          uid = db.hash_get(lookup_hash, lookup_field)
+          if uid.nil?
+            uid = db.increment("metric_data_next_uid")
+            # write and read to avoid race conditional writes
+            db.hash_key_set_if_not_exists(lookup_hash, lookup_field, uid)
+            uid = db.hash_get(lookup_hash, lookup_field)
+          end
+          "data::#{uid}"
+        end
+      end
+
+      def segments
+        if group && group.segments.any?
+          group.segments
+        else
+          [self.class::DEFAULT_SEGMENT]
+        end
+      end
+    private
+
+      def generate_result_for_day(date)
+        date_key = key_for_date(date)
+        hours_keys = hour_keys_for_day(date)
+        result = merge_results(hours_keys)
+        db.hash_multi_set(date_key, result) unless date == tz.now.to_date
+        result
+      end
+
+
+      def hour_keys
+        db.set_members(hours_set_key)
+      end
+
+      def hours_set_key
+        "#{key}::hours"
+      end
+
+      def days_set_key
+        "#{key}::days"
+      end
+
+      def key_for_date(date)
+        "#{key}::#{ date.strftime("%Y%m%d") }"
+      end
+
+      def key_for_hour(time)
+        "#{key}::#{ time.strftime("%Y%m%d%H") }"
+      end
+
+    end
+  end
+end

data/lib/blackbeard/metric_data/total.rb

@@ -0,0 +1,39 @@
+require 'blackbeard/metric_data/base'
+
+module Blackbeard
+  module MetricData
+    class Total < Base
+
+      DEFAULT_SEGMENT = 'total'
+
+      def add(uid, amount = 1, segment = DEFAULT_SEGMENT)
+        add_at(tz.now, uid, amount, segment)
+      end
+
+      def add_at(time, uid, amount = 1, segment = DEFAULT_SEGMENT)
+        key = key_for_hour(time)
+        db.set_add_member(hours_set_key, key)
+        db.hash_increment_by_float(key, segment, amount.to_f)
+        #TODO: if not today, blow away rollup keys
+      end
+
+      def result_for_hour(time)
+        key = key_for_hour(time)
+        result = db.hash_get_all(key)
+        result.each{ |k,v| result[k] = v.to_f }
+        result
+      end
+
+    private
+
+      def merge_results(keys)
+        merged_results = {}
+        keys.each do |key|
+          result = db.hash_get_all(key)
+          result.each{ |k,v| merged_results[k] ||= 0; merged_results[k] += v.to_f}
+        end
+        merged_results
+      end
+    end
+  end
+end