blackbeard 0.0.3.1 → 0.0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: be704d408f74d3fed4eceb91f873c087967ed947
-  data.tar.gz: 33e1a39fe2efeea751f99b9e769e00c72b19e99e
+  metadata.gz: a8e907aad46889da2e0abfab0cd85fdc87c93a4e
+  data.tar.gz: 125429d019e4e2e4767f18e2428faac8db1bff8b
 SHA512:
-  metadata.gz: 33d585c054f11b46334cfdbd98907d0b659decd5b4df3d06172b6c44c365ad97500461be00f7d10324ca9499f7620786271a5b22745fca72f39fb6758dbd55f5
-  data.tar.gz: d932724e9091f21dd1c16557cd821ac9a3c7b380391b362d0582a1cf80166381fae3cb07816dbe15f5e2fb5cff8169ede3087ae5b8d0ce9d8568dd5a56ea0271
+  metadata.gz: 94047af0590aa7109951b25870f1c46f1b12d9231c09af49f141c025c03dcca9468a1b48d75878e1154ed867cc9dc768175011af0d9d42725251757976478527
+  data.tar.gz: 7c407ffcffb34c88a29552e85a44a488bf377a7b21bc3f89f3d8d5c7213e3b888fcc5dad59ad8e1293e07a88b088694a824970c8f74a004eb82f5d2660c7631b

data/README.md

@@ -135,20 +135,20 @@ $pirate.add_total(:revenue, +119.95)              # can also accept floats
 
 ### Chaining Metrics
 
-Context methods that inrement metrics always return the context, so you can chain them together.
+Context methods that increment metrics always return the context, so you can chain them together.
 
 ```ruby
 $pirate.set_context(user)
 $pirate.add_total(:like, +1).add_unique(:likers)
-
 $pirate.context(user).add_total(:like, +1).add_unique(:likers)
 ```
 
 
-### Defining Tests (changes or features)
+### Defining AB Tests
 
-Features are defined in your views, controller or anywhere in your app via the global $pirate.  There is no configuration necessary (but see the gotcha below).
+AB tests are defined in your views, controller or anywhere in your app via the global $pirate.  There is no configuration necessary (but see the gotcha below).
 
+**_Note that ab_tests are implmented, but experiments to control them is not. AB tests and experiments are in active development._**
 
 In a view:
 
@@ -162,7 +162,7 @@ In a controller:
 @onboarding_path = $pirate.ab_test(:new_onboarding, :control => '/onboarding', :welcome_flow => '/welcome') %>
 ```
 
-You can call the feature multiple times with different variations:
+You can call the test multiple times with different variations:
 
 ```ruby
 @button_bg_color = $pirate.ab_test(:button_color, :control => "#FFF", :black => "#000")
@@ -183,13 +183,7 @@ if $pirate.ab_test(:join_form) == :long_version do
 end
 ```
 
-If you're simply rolling out a feature or want a feature flipper, you can:
-
-```ruby
-if $pirate.active?(:friend_feed){ ... }  # shorthand for test(:friend_feed) == :active
-```
-
-GOTCHA #1:  It's good to avoid elsif and case statements when testing for features. Blackbeard learns about the features and their variations dynamically. If you're not passing in your variations as a hash, but only using conditionals, you can ensure all your variations are available with:
+GOTCHA #1:  It's good to avoid elsif and case statements. Blackbeard learns about the tests and their variations dynamically. If you're not passing in your variations as a hash, but only using conditionals, you can ensure all your variations are available with:
 
 ```ruby
 $pirate.test(:friend_feed).add_variations(:variation_one, :variation_two, ...)
@@ -197,14 +191,26 @@ $pirate.test(:friend_feed).add_variations(:variation_one, :variation_two, ...)
 
 Look at the dashboard to see which variations are registered.
 
-Features do not turn on automatically. When you first deploy the feature will be set to `:inactive` or `:control`, `:off`, or `:default` if any of those variations are defined.
+Test do not turn on automatically. When you first deploy the test will be set to `:inactive` or `:control`, `:off`, or `:default` if any of those variations are defined.
 
 GOTCHA #2:  If you do not define the :inactive, :control, :off or :default variations, the result will be nil. This is the desired behavior but it may be confusing.
 
 ```ruby
 $pirate.ab_test(:new_onboarding, :one => 'one', :two => 'two') # is the same as the next line
-$pirate.ab_test(:new_onboarding, :inactive => nil, :one => 'one', :two => 'two') # nil when feature is inactive
-$pirate.ab_test(:new_onboarding, :default => 'one', :two => 'two') # => 'one' when feature is inactive
+$pirate.ab_test(:new_onboarding, :inactive => nil, :one => 'one', :two => 'two') # nil when test is inactive
+$pirate.ab_test(:new_onboarding, :default => 'one', :two => 'two') # => 'one' when test is inactive
+```
+
+### Features
+
+Features are very similar to AB Tests but they are only active or inactive. You can control how they are rolled out to groups and even individuals in the dashboard.
+
+```ruby
+# With the context set
+if $pirate.feature_active?(:friend_feed){ ... }
+
+# Or outside a web request
+if $pirate.context(user).feature_active?(:friend_feed){ ... }
 ```
 
 ### Defining groups
@@ -214,10 +220,6 @@ $pirate.define_group(:admin) do |user, context|
   user.admin? # true, false
 end
 
-$pirate.define_group(:medalist) do |user, context|
-  user.engagement_level # nil, :bronze, :silver, :gold
-end
-
 $pirate.define_group(:seo_traffic) do |user, context|
   context.session.refer =~ /google.com/ # remember to store refer in sessions
 end
@@ -231,6 +233,16 @@ $pirate.define_group(:purchasers) do |user, context|
 end
 ```
 
+If your group is segments, include a list possible segments.
+
+```ruby
+$pirate.define_group(:medalist, [:bronze, :silver, :gold]) do |user, context|
+  user.engagement_level # nil, :bronze, :silver, :gold
+end
+```
+
+If your group definition block returns an uninitialized segment, it wil be initialized automatically.
+
 ## Contributing
 
 1. Fork it
@@ -238,4 +250,3 @@ end
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
-

data/dashboard/public/stylesheets/application.css

@@ -26,3 +26,7 @@ body {
 .editable-click:hover {
   background-color: #EEE;
 }
+
+.editable-empty {
+  color: #999;
+}

data/dashboard/routes/features.rb

@@ -0,0 +1,31 @@
+module Blackbeard
+  module DashboardRoutes
+    class Features < Base
+
+      get '/features' do
+        @features = Feature.all
+        erb 'features/index'.to_sym
+      end
+
+      get "/features/:id" do
+        @feature = Feature.find(params[:id]) or pass
+        @groups = Group.all
+        erb 'features/show'.to_sym
+      end
+
+      post "/features/:id" do
+        @feature = Feature.find(params[:id]) or pass
+        @feature.update_attributes(params)
+        "OK"
+      end
+
+      post "/features/:id/groups/:group_id" do
+        @feature = Feature.find(params[:id]) or pass
+        @feature.set_segments_for(params[:group_id], params[:segments])
+        @feature.save
+        "OK"
+      end
+
+    end
+  end
+end

data/dashboard/routes/groups.rb

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

data/dashboard/routes/metrics.rb

@@ -7,21 +7,21 @@ module Blackbeard
       end
 
       get "/metrics/:type/:type_id" do
-        @metric = Metric.new(params[:type], params[:type_id])
-        @group = Group.new(params[:group_id]) if params[:group_id]
+        @metric = Metric.find(params[:type], params[:type_id]) or pass
+        @group = Group.find(params[:group_id]) if params[:group_id]
         erb 'metrics/show'.to_sym
       end
 
       post "/metrics/:type/:type_id" do
-        @metric = Metric.new(params[:type], params[:type_id])
+        @metric = Metric.find(params[:type], params[:type_id]) or pass
         @metric.update_attributes(params)
         "OK"
       end
 
       post "/metrics/:type/:type_id/groups" do
-        @metric = Metric.new(params[:type], params[:type_id])
-        @group = Group.new(params[:group_id])
-        @metric.add_group(@group)
+        @metric = Metric.find(params[:type], params[:type_id]) or pass
+        @group = Group.find(params[:group_id])
+        @metric.add_group(@group) if @group
         redirect url("metrics/#{@metric.type}/#{@metric.type_id}?group_id=#{@group.id}")
       end
 

data/dashboard/routes/tests.rb

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

data/dashboard/views/features/index.erb

@@ -0,0 +1,21 @@
+<div class="page-header">
+  <h1>Features</h1>
+  <p>Features are large pieces of functionality where you want to control their availability either for the purpose of testing or rolling out.</p>
+</div>
+
+<% if @features.any? %>
+<div class="panel panel-primary">
+  <div class="panel-heading">
+    <h3 class="panel-title">Known Features</h3>
+  </div>
+  <ul class="list-group">
+  <% @features.each do |feature| %>
+  <li class="list-group-item"><a href="<%= url("features/#{feature.id}") %>"><%= feature.name %></a></li>
+  <% end %>
+  </ul>
+</div>
+<% else %>
+  <div class="alert alert-danger">
+    <strong>No features!</strong> Something may be wrong or you may just need to define some features.
+  </div>
+<% end %>

data/dashboard/views/features/show.erb

@@ -0,0 +1,163 @@
+<div class="page-header">
+  <div id="status-buttons-group" class="btn-group pull-right" data-current-status="<%= @feature.status %>">
+    <button type="button" class="btn" value="active" data-selected-class="btn-success">Active</button>
+    <button type="button" class="btn" value="rollout" data-selected-class="btn-warning">Roll Out</button>
+    <button type="button" class="btn" value="inactive" data-selected-class="btn-danger">Inactive</button>
+  </div>
+  <h1><span id="editable-name"><%= @feature.name %></span> <small>Feature</small></h1>
+  <p id="editable-description"><%= @feature.description %></p>
+</div>
+
+<div id="active" class="feature-status-panel hidden">
+  <p>This feature is <em>active</em> for all users.</p>
+</div>
+
+<div id="inactive" class="feature-status-panel hidden">
+  <p>This feature is <em>inactive</em> for all users.</p>
+</div>
+
+<div id="rollout" class="feature-status-panel hidden">
+  <div class="panel panel-primary">
+    <div class="panel-heading">
+      <h3 class="panel-title">Rollout Options</h3>
+    </div>
+    <div class="panel-body">
+    <p>Activate feature for all visitors:</p>
+    <div class="progress" id="editable-visitors-rate">
+      <div class="progress-bar progress-bar-warning" role="progressbar" aria-valuenow="0" aria-valuemin="0" aria-valuemax="100" style="width: 0%; overflow: visible;">
+      </div>
+    </div>
+    <p>Activate feature for logged in users:</p>
+    <div class="progress" id="editable-users-rate">
+      <div class="progress-bar progress-bar-warning" role="progressbar" aria-valuenow="0" aria-valuemin="0" aria-valuemax="100" style="width: 0%; overflow: visible;">
+      </div>
+    </div>
+    <p>Activate feature for group segments:</p>
+    <table class="table">
+    <thead>
+      <tr>
+        <th>Group</th>
+        <th>Active Segments</th>
+      </tr>
+    </thead>
+    <% @groups.each do |group| %>
+      <tr>
+        <td><%= group.name %></td>
+        <td><a href="#" id="editable-group-segments-<%= group.id %>"></a></td>
+      </tr>
+    <% end if @groups.any? %>
+    </table>
+    </div>
+    <div class="panel-footer">Note: 100% of visitors is the same as active. 50% of visitors &amp; 100% of logged in users will be more than 50% of all traffic.</div>
+  </div>
+</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;
+  }
+
+  $("#status-buttons-group").on("click", ":button", function (e) {
+    e.preventDefault();
+    var status = $(this).val();
+    $('#status-buttons-group').data("current-status", status);
+    $.post( "<%= url("features/#{@feature.id}") %>", { status: status } , updateButtonStates);
+  });
+
+  function updateButtonStates(){
+    var v = $('#status-buttons-group').data("current-status");
+    $( "#status-buttons-group :button" ).removeClass();
+    $( "#status-buttons-group :button" ).addClass("btn");
+    var selectedClass = $( "#status-buttons-group :button[value='"+v+"']" ).data("selected-class");
+    $( "#status-buttons-group :button[value='"+v+"']" ).addClass( selectedClass );
+    $( ".feature-status-panel" ).addClass("hidden");
+    $( "#"+v ).removeClass("hidden");
+  }
+
+  $(document).ready(updateButtonStates);
+
+  $(document).ready(function() {
+  <% @groups.each do |group| %>
+    $('#editable-group-segments-<%= group.id %>').editable({
+        type: 'checklist',
+        emptytext: 'No segments active',
+        title: "Select segments",
+        url: '<%= url("features/#{@feature.id}/groups/#{group.id}")%>',
+        name: 'segments',
+        value: [<%= @feature.segments_for(group.id).map{|s| "'#{s}'"}.join(',') %>],
+        source: [<%= group.segments.map{|s| "{value: '#{s}', text: '#{s}'}"}.join(',') %>]
+    });
+    <% end %>
+
+    $('#editable-users-rate').editable({
+      type: 'number',
+      value: <%= @feature.users_rate %>,
+      display: function(value, sourceData) {
+        var color = "#fff";
+        if (value < 10) {
+          color = "#000";
+        }
+        $(".progress-bar", this).attr("aria-valuenow", value).html(value + "% of users").width(value+'%').css('color', color);
+      },
+      url: '<%= url("features/#{@feature.id}") %>',
+      name: 'users_rate',
+      title: '% of logged in users',
+      validate: function(value) {
+         if($.trim(value) == '') {
+          return 'This field is required';
+        }
+      }
+    });
+
+
+    $('#editable-visitors-rate').editable({
+      type: 'number',
+      value: <%= @feature.visitors_rate %>,
+      display: function(value, sourceData) {
+        var color = "#fff";
+        if (value < 10) {
+          color = "#000";
+        }
+        $(".progress-bar", this).attr("aria-valuenow", value).html(value + "% of visitors").width(value+'%').css('color', color);
+      },
+      url: '<%= url("features/#{@feature.id}") %>',
+      name: 'visitors_rate',
+      title: '% of all visitors',
+      validate: function(value) {
+         if($.trim(value) == '') {
+          return 'This field is required';
+        }
+      }
+    });
+
+
+    $('#editable-name').editable({
+      placement: 'right',
+      type: 'text',
+      url: '<%= url("features/#{@feature.id}") %>',
+      name: 'name',
+      title: 'Edit feature name',
+      validate: function(value) {
+         if($.trim(value) == '') {
+          return 'This field is required';
+        }
+      }
+    });
+    $('#editable-description').editable({
+      placement: 'bottom',
+      emptytext: 'Give this feature a description',
+      type: 'textarea',
+      url: '<%= url("features/#{@feature.id}") %>',
+      name: 'description',
+      title: 'Edit feature description'
+    });
+  });
+</script>

data/dashboard/views/groups/show.erb

@@ -1,5 +1,5 @@
 <div class="page-header">
-  <h1><span id="editable-name"><%= @group.name %></span></h1>
+  <h1><span id="editable-name"><%= @group.name %></span> <small>Group</small></h1>
   <p id="editable-description"><%= @group.description %></p>
 </div>
 

data/dashboard/views/layout.erb

@@ -33,9 +33,10 @@
         </div>
         <div class="navbar-collapse collapse">
           <ul class="nav navbar-nav">
+            <li><a href="<%= url('features') %>">Features</a></li>
             <li><a href="<%= url('groups') %>">Groups</a></li>
             <li><a href="<%= url('metrics') %>">Metrics</a></li>
-            <li><a href="<%= url('tests') %>">Tests</a></li>
+            <!-- li><a href="<%= url('tests') %>">Tests</a></li -->
           </ul>
         </div><!--/.nav-collapse -->
       </div>

data/lib/blackbeard.rb

@@ -2,15 +2,26 @@ require "blackbeard/configuration"
 require "blackbeard/pirate"
 
 module Blackbeard
-  extend self
-  attr_accessor :config
+  class << self
 
-  def self.pirate
-    @config ||= Configuration.new
-    yield(config)
-    Blackbeard::Pirate.new
-  end
+    def configure!
+      @config = Configuration.new
+      yield config
+    end
+
+    def config
+      @config ||= Configuration.new
+    end
 
+    def configure
+      yield config
+    end
+
+    def pirate
+      yield(config) if block_given?
+      Blackbeard::Pirate.new
+    end
+  end
 end
 
 Blackbeard.pirate {}