blackbeard 0.0.4.0 → 0.0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a8e907aad46889da2e0abfab0cd85fdc87c93a4e
-  data.tar.gz: 125429d019e4e2e4767f18e2428faac8db1bff8b
+  metadata.gz: 07e955101ffdd9c1bfe155e1916ebfc0a9911f4d
+  data.tar.gz: eaab8a527217bc44eaadf13665a230cd46e8ae65
 SHA512:
-  metadata.gz: 94047af0590aa7109951b25870f1c46f1b12d9231c09af49f141c025c03dcca9468a1b48d75878e1154ed867cc9dc768175011af0d9d42725251757976478527
-  data.tar.gz: 7c407ffcffb34c88a29552e85a44a488bf377a7b21bc3f89f3d8d5c7213e3b888fcc5dad59ad8e1293e07a88b088694a824970c8f74a004eb82f5d2660c7631b
+  metadata.gz: d16393da029f3e584a1b632332582b20645dd1857b7b845012546bd0b939a99251969c6ec5e658fb425e61cb5cdf4ad2588461883a5128541f0a18ea66ca54d8
+  data.tar.gz: 5f5154181ac58db415657199eddb3f6e19ff236e999bf21bd74fc597903ab63350f783face5647bd534b5dd1b6c8580ffbe439616a5b812fc77320af3325e838

data/README.md

@@ -109,7 +109,7 @@ $pirate.context(user).add_metric(:referral)
 
 If a context does not exist, `$pirate` will silently ignore all actions. This is useful for dealing with bots.
 
-If the user is unidentied set user to nil or false. If your app can return a Guest object for unidentied users, see the guest configuration setting.
+If the user is unidentified set user to nil or false. If your app can return a Guest object for unidentified users, see the guest configuration setting.
 
 ### Collecting Metrics
 
@@ -215,33 +215,61 @@ if $pirate.context(user).feature_active?(:friend_feed){ ... }
 
 ### Defining groups
 
+Group definitions are part of the configuration and should be defined
+in an initializer.
+
 ```ruby
-$pirate.define_group(:admin) do |user, context|
-  user.admin? # true, false
-end
+$pirate = Blackbeard.pirate do |config|
+  config.define_group(:admin) do |user, controller|
+    user && user.admin? # true, false
+  end
 
-$pirate.define_group(:seo_traffic) do |user, context|
-  context.session.refer =~ /google.com/ # remember to store refer in sessions
-end
+  config.define_group(:seo_traffic) do |user, controller|
+    controller && controller.session.refer =~ /google.com/ # remember to store refer in sessions
+  end
 
-$pirate.define_group(:seo_traffic) do |user, context|
-  context.session.refer =~ /google.com/ # remember to store refer in sessions
-end
+  config.define_group(:seo_traffic) do |user, controller|
+    controller && controller.session.refer =~ /google.com/ # remember to store refer in sessions
+  end
 
-$pirate.define_group(:purchasers) do |user, context|
-  user.purchases.any?
+  config.define_group(:purchasers) do |user, controller|
+    users && user.purchases.any?
+  end
 end
 ```
+The user will be nil for non-logged in visitors.  The controller
+will be nil if not defined by the context (e.g. outside a web context).
 
-If your group is segments, include a list possible segments.
+If your group is segmented (doesn't return true or false), include a list possible segments.
 
 ```ruby
-$pirate.define_group(:medalist, [:bronze, :silver, :gold]) do |user, context|
-  user.engagement_level # nil, :bronze, :silver, :gold
+$pirate = Blackbeard.pirate do |config|
+  ...
+  config.define_group(:medalist, [:bronze, :silver, :gold]) do |user, context|
+    user.engagement_level # nil, :bronze, :silver, :gold
+  end
 end
 ```
 
-If your group definition block returns an uninitialized segment, it wil be initialized automatically.
+If your group definition block returns an uninitialized segment, it wil
+be initialized automatically.
+
+### Defining Cohorts
+
+Groups and cohorts in the dictionary sense are identical.  For our purposes,
+cohorts are participants that experienced something at the same time.  A participant
+can only be in one cohort at a time, but can switch cohorts.
+
+This will add the current user/visitor and current timestamp to the cohort.
+
+```ruby
+  $pirate.add_to_cohort(:joined_at) # returns false if already in cohort, otherwise true
+  $pirate.add_to_cohort!(:bought_at) # always returns true. If user is already in a cohort, the timestamp is updated.
+  $pirate.add_to_cohort(:joined_at, user.created_at) # You can optional pass in the timestamp
+```
+
+You'll can add cohorts to metrics compare how members who joined one day against
+members who joined another day.
 
 ## Contributing
 

data/TODO.md

@@ -48,9 +48,11 @@ $pirate.funnel(:checkout, 'Confirm')          # User reached step 3 of funnel (C
 ```
 
 
+```ruby
 $pirate.define_group(:achieve_pirate_style) do |user, context|
   $pirate.metric(:pirate_style).achieved?
 end
+```
 
 
-http://blog.sourcing.io/structuring-sinatra?utm_content=buffer1955d&utm_medium=social&utm_source=twitter.com&utm_campaign=buffer
+[Structuring Sinatra applications](http://blog.sourcing.io/structuring-sinatra)

data/dashboard/routes/cohorts.rb

@@ -0,0 +1,25 @@
+module Blackbeard
+  module DashboardRoutes
+    class Cohorts < Base
+      get '/cohorts' do
+        @cohorts = Cohort.all
+        erb 'cohorts/index'.to_sym
+      end
+
+      get '/cohorts/:id' do
+        ensure_cohort
+        erb 'cohorts/show'.to_sym
+      end
+
+      post "/cohorts/:id" do
+        ensure_cohort.update_attributes(params)
+        "OK"
+      end
+
+      def ensure_cohort
+        @cohort = Cohort.find(params[:id]) or pass
+      end
+
+    end
+  end
+end

data/dashboard/routes/features.rb

@@ -8,24 +8,27 @@ module Blackbeard
       end
 
       get "/features/:id" do
-        @feature = Feature.find(params[:id]) or pass
+        ensure_feature
         @groups = Group.all
         erb 'features/show'.to_sym
       end
 
       post "/features/:id" do
-        @feature = Feature.find(params[:id]) or pass
-        @feature.update_attributes(params)
+        ensure_feature.update_attributes(params)
         "OK"
       end
 
       post "/features/:id/groups/:group_id" do
-        @feature = Feature.find(params[:id]) or pass
+        ensure_feature
         @feature.set_segments_for(params[:group_id], params[:segments])
         @feature.save
         "OK"
       end
 
+      def ensure_feature
+        @feature = Feature.find(params[:id]) or pass
+      end
+
     end
   end
 end

data/dashboard/routes/groups.rb

@@ -7,16 +7,19 @@ module Blackbeard
       end
 
       get '/groups/:id' do
-        @group = Group.find(params[:id]) or pass
+        ensure_group
         erb 'groups/show'.to_sym
       end
 
       post "/groups/:id" do
-        @group = Group.find(params[:id]) or pass
-        @group.update_attributes(params)
+        ensure_group.update_attributes(params)
         "OK"
       end
 
+      def ensure_group
+        @group = Group.find(params[:id]) or pass
+      end
+
     end
   end
 end

data/dashboard/routes/metrics.rb

@@ -7,24 +7,44 @@ module Blackbeard
       end
 
       get "/metrics/:type/:type_id" do
-        @metric = Metric.find(params[:type], params[:type_id]) or pass
-        @group = Group.find(params[:group_id]) if params[:group_id]
+        ensure_metric; find_group; find_cohort; ensure_charts
         erb 'metrics/show'.to_sym
       end
 
       post "/metrics/:type/:type_id" do
-        @metric = Metric.find(params[:type], params[:type_id]) or pass
+        ensure_metric
         @metric.update_attributes(params)
         "OK"
       end
 
       post "/metrics/:type/:type_id/groups" do
-        @metric = Metric.find(params[:type], params[:type_id]) or pass
-        @group = Group.find(params[:group_id])
+        ensure_metric; find_group
         @metric.add_group(@group) if @group
         redirect url("metrics/#{@metric.type}/#{@metric.type_id}?group_id=#{@group.id}")
       end
 
+      post "/metrics/:type/:type_id/cohorts" do
+        ensure_metric; find_cohort
+        @metric.add_cohort(@cohort) if @cohort
+        redirect url("metrics/#{@metric.type}/#{@metric.type_id}?cohort_id=#{@cohort.id}")
+      end
+
+      def ensure_metric
+        @metric = Metric.find(params[:type], params[:type_id]) or pass
+      end
+
+      def find_group
+        @group = Group.find(params[:group_id]) if params[:group_id]
+      end
+
+      def find_cohort
+        @cohort = Cohort.find(params[:cohort_id]) if params[:cohort_id]
+      end
+
+      def ensure_charts
+        @charts = []
+      end
+
     end
   end
 end

data/dashboard/routes/tests.rb

@@ -8,16 +8,19 @@ module Blackbeard
       end
 
       get "/tests/:id" do
-        @test = Test.find(params[:id]) or pass
+        ensure_test
         erb 'tests/show'.to_sym
       end
 
       post "/tests/:id" do
-        @test = Test.find(params[:id]) or pass
-        @test.update_attributes(params)
+        ensure_test.update_attributes(params)
         "OK"
       end
 
+      def ensure_test
+        @test = Test.find(params[:id]) or pass
+      end
+
     end
   end
 end

data/dashboard/views/cohorts/index.erb

@@ -0,0 +1,22 @@
+<div class="page-header">
+  <h1>Cohorts</h1>
+  <p>Are groupings of visitors that experience a certain event at the same time.</p>
+</div>
+
+<% if @cohorts.any? %>
+<div class="panel panel-primary">
+  <div class="panel-heading">
+    <h3 class="panel-title">Active Cohorts</h3>
+  </div>
+  <ul class="list-group">
+  <% @cohorts.each do |cohort| %>
+  <li class="list-group-item"><a href="<%= url("cohorts/#{cohort.id}") %>"><%= cohort.name %></a></li>
+  <% end %>
+  </ul>
+</div>
+
+<% else %>
+  <div class="alert alert-danger">
+    <strong>No cohorts!</strong> Something may be wrong or you may just need to define some cohorts.
+  </div>
+<% end %>

data/dashboard/views/cohorts/show.erb

@@ -0,0 +1,41 @@
+<div class="page-header">
+  <h1><span id="editable-name"><%= @cohort.name %></span> <small>Group</small></h1>
+  <p id="editable-description"><%= @cohort.description %></p>
+</div>
+
+<!--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("groups/#{@cohort.id}") %>',
+      name: 'name',
+      title: 'Edit cohort name',
+      validate: function(value) {
+         if($.trim(value) == '') {
+          return 'This field is required';
+        }
+      }
+    });
+    $('#editable-description').editable({
+      placement: 'bottom',
+      type: 'textarea',
+      url: '<%= url("metrics/#{@cohort.id}") %>',
+      name: 'description',
+      title: 'Edit cohort description'
+    });
+  });
+</script>
+<%= partial :'shared/charts', :locals => {:charts => [@cohort.recent_hours_chart, @cohort.recent_days_chart]} %>

data/dashboard/views/groups/show.erb

@@ -50,9 +50,9 @@
     $('#editable-description').editable({
       placement: 'bottom',
       type: 'textarea',
-      url: '<%= url("metrics/#{@group.id}") %>',
+      url: '<%= url("groups/#{@group.id}") %>',
       name: 'description',
-      title: 'Edit metric description'
+      title: 'Edit group description'
     });
   });
 </script>

data/dashboard/views/layout.erb

@@ -33,6 +33,7 @@
         </div>
         <div class="navbar-collapse collapse">
           <ul class="nav navbar-nav">
+            <li><a href="<%= url('cohorts') %>">Cohorts</a></li>
             <li><a href="<%= url('features') %>">Features</a></li>
             <li><a href="<%= url('groups') %>">Groups</a></li>
             <li><a href="<%= url('metrics') %>">Metrics</a></li>

data/dashboard/views/metrics/show.erb

@@ -3,21 +3,38 @@
 <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>
+<form id="add_cohort" action="<%= url("/metrics/#{@metric.type}/#{@metric.type_id}/cohorts") %>" method="post"><input id="add_cohort_input" type="hidden" name="cohort_id"></form>
 <ul class="nav nav-tabs">
-  <% if @group.nil? %><li class="active"><% else %><li><% end %><a href="?">All</a></li>
+  <% if @group.nil? && @cohort.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? %>
+  <% @metric.cohorts.each do |cohort| %>
+    <% if @cohort == cohort %><li class="active"><% else %><li><% end %><a href="?cohort_id=<%= cohort.id %>"><%= cohort.name %></a></li>
+  <% end %>
+
   <li class="dropdown">
-     <a id="drop5" role="button" data-toggle="dropdown" href="#">Segment by Group <b class="caret"></b></a>
+     <a id="drop5" role="button" data-toggle="dropdown" href="#">Add <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>
+          <% if @metric.addable_groups.any? %>
+            <li role="presentation" class="dropdown-header">Group Metrics</li>
+            <% @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 %>
+          <% else %>
+            <li role="presentation" class="dropdown-header">No Group Metrics</li>
+          <% end %>
+          <li role="presentation" class="divider"></li>
+          <% if @metric.addable_cohorts.any? %>
+            <li role="presentation" class="dropdown-header">Cohort Metrics</li>
+            <% @metric.addable_cohorts.each do |cohort| %>
+            <li role="presentation" data-cohort-id="<%= cohort.id %>" data-cohort-name="<%= cohort.name %>" class="add-cohort"><a role="menuitem" tabindex="-1" href="#"><%= cohort.name %></a></li>
+            <% end %>
+          <% else %>
+            <li role="presentation" class="dropdown-header">No Cohort Metrics</li>
           <% end %>
         </ul>
   </li>
-  <% end %>
 </ul>
 
 <!--Load the AJAX API-->
@@ -37,6 +54,19 @@
     }
   });
 
+  $('ul.nav-tabs').on("click", ".add-cohort", function (e) {
+    e.preventDefault();
+    var cohortId = $(this).data("cohort-id");
+    var cohortName = $(this).data("cohort-name");
+
+    if(confirm("Start collecting data by cohort "+cohortName+"?")) {
+      $('#add_cohort_input').val(cohortId);
+      $('#add_cohort').submit();
+    }
+  });
+
+
+
     //turn to inline mode
   $.fn.editable.defaults.send = 'always';
   $.fn.editable.defaults.params = function(params) {
@@ -67,7 +97,4 @@
     });
   });
 </script>
-<%= partial :'metrics/metric_data', :locals => {:metric_data => @metric.metric_data(@group) } %>
-
-
-
+<%= partial :'shared/charts', :locals => {:charts => @charts } %>

data/dashboard/views/shared/_charts.erb

@@ -0,0 +1,20 @@
+<script type="text/javascript" src="https://www.google.com/jsapi"></script>
+<script type="text/javascript">
+  // Load the Visualization API and the piechart package.
+  google.load('visualization', '1.0', {'packages':['corechart']});
+</script>
+
+<% charts.each do |chart| %>
+  <div id="<%= chart.dom_id %>"></div>
+  <script type="text/javascript">
+    // Set a callback to run when the Google Visualization API is loaded.
+    google.setOnLoadCallback(
+      function(){
+        var data = new google.visualization.DataTable(jQuery.parseJSON('<%= chart.data.to_json %>'));
+        var options = jQuery.parseJSON('<%= chart.options.to_json %>');
+        var div = document.getElementById('<%= chart.dom_id %>');
+        new google.visualization.LineChart(div).draw(data, options);
+    });
+
+  </script>
+<% end %>