mountain-goat 0.0.17 → 0.0.18

data/README.md

@@ -2,88 +2,122 @@
 
 Embed a high-quality analytics platform in your application in minutes.  Gain important A/B test business insights, and view the results and analytics in real time.
 
+Add simple hooks in your code to display a/b metrics
+
+     <%= metric_variant(:homescreen_text, :user_signup, "Welcome here") %>
+  
+This creates a database entry to a/b test "homescreen_text" against a goal "user signup".  Visit "http://yourdomain.com/mg" and you can add / adjust options (variants) for this text.  When a user converts on this goal, you run the following code.
+  
+     def create
+       record_conversion(:user_signup)
+       ...
+     end
+
+This will track a conversion not only for the goal, but for the variant of "homescreen_text" (and any other associated metrics) that the user was served when he came to the home-page.
+
+The best part?  The mountain-goat admin console is located on your server and you can view and analyze your data in real time.
+
+ - See which metric variants are working and not working ("Cowabunga!" did 120% better than "Enter here", but 10% worse than "Do it rockapella!")
+ - Visually analyze the your metric variants; change them on the fly, adding new ones.
+ - Watch goal conversions in real-time with live-action console (grab the popcorn and watch how your users "sign up" and "view items" and ...)
+ - You can do more than change text, "switch variants" let you enter arbitrary ruby code, change the control of your site ("Do my users have to sign-in before commenting?  Let's test!")
+ - Track goals with meta data (record_conversion(:user_signup, :referrer => request.env['HTTP_REFERER']))
+   * Mountain goat tracks as much arbitrary meta data as you want
+   * You are presented with charts for each goal, broken down by meta
+   * See what referrers are driving goals, or which of your blog posts are drawing an audience
+ - Much, much more, e.g. deliver views of this data to your consumers, streamline your site, customize it by user, it's all up to you. 
+
 ## Install
 
 ### Mountain Goat gem
 
-    gem install mountain-goat
-	
-	#Note, you'll need to install the proper migrations (currently in the migrations folder, task coming shortly)
+     gem install mountain-goat
+
+### Mountain Goat configration
+    
+Next run generator to create config file and necessary database migration (optionally pass in --password=my_mg_password)
+     
+     ./script/generate mg
+    
+This will generate
+
+     /config/mountain-goat.yml (for storing a password to access mountain-goat)
+     /db/migrate/xxx_create_mountain_goat_tables.rb (necessary databae migrations to store mg data)
 
 ## Usage
 
-	Mountain Goat hinges around three core concepts:
-	
-	  *) Conversions are what you want  E.g. "user purchases coffee"
-	  *) Metrics are how you draw people to convert  E.g. "a banner on the store-front"
-	  *) Metric variants are A/B tests for metrics  E.g. "free coffee" "chuck norris is inside"
+Mountain Goat hinges around three core concepts:
 	
-	After you set up your database with some mountain-goat tables, the code will handle populating these tables for you.  In your code, you can start A/B testing immediately.
+- Conversions are what you want  E.g. "user purchases coffee"
+- Metrics are how you draw people to convert  E.g. "a banner on the store-front"
+- Metric variants are A/B tests for metrics  E.g. "free coffee" "chuck norris is inside"
 	
-	<h2><%= metric_variant(:banner_on_store_front, :user_purchases_coffee, "Now arsenic and gluten-free") %></h2>
+After you set up your database with some mountain-goat tables, the code will handle populating these tables for you.  In your code, you can start A/B testing immediately.
 	
-	The metric_variant function (or mv for short) takes three parameters:
+     <h2><%= metric_variant(:banner_on_store_front, :user_purchases_coffee, "Now arsenic and gluten-free") %></h2>
 	
-	mv(metric_name, convert_name, default)
+The metric_variant function (or, mv for short) takes three parameters:
 	
-	This will automatically create a metric and conversion and populate a metric variant with the default value.  Easy, eh?
+     mv(metric_name, convert_name, default)
 	
-	From here, you can go into the mountain-goat admin center and add new metric variants to fit your need.
+This will automatically create a metric and conversion and populate a metric variant with the default value.  Easy, eh?
 	
-	The other important code you'll need to implement is when a goal is achieved.
+From here, you can go into the mountain-goat admin center and add new metric variants to fit your need.  The other important code you'll need to implement is when a goal is achieved.
 	
-	def purchase #coffees_controller.rb
-	  record_conversion(:user_purchases_coffee)
-	  ...
-	end
+     def purchase #coffees_controller.rb
+       record_conversion(:user_purchases_coffee)
+       ...
+     end
 	
-	This will go in and record a conversion ("rally") for a user purchasing coffee.  Further, it will track a hit for any metric-variants served to that user that relate to this goal.  For example "Chuck Norris works here" might get a point.
+This will go in and record a conversion ("rally") for a user purchasing coffee.  Further, it will track a hit for any metric-variants served to that user that relate to this goal.  For example "Chuck Norris works here" might get a point.
 	
 ## Mountain Goat admin suite
 
-    Navigate to /mg in your application to reach the mountain-goat admin center.  Here, you can analyze / adjust your A/B tests.
+Navigate to /mg in your application to reach the mountain-goat admin center.  Here, you can analyze / adjust your A/B tests.
     
-    The front page gives you a breakdown of each of your Goals, and the efficacy of each metric and metric-variant.  Select a given metric to drill into its variants.  Once you are in a specific metric, you'll be able to add new metric-variants and see what works best for your clients.
+The front page gives you a breakdown of each of your Goals, and the efficacy of each metric and metric-variant.  Select a given metric to drill into its variants.  Once you are in a specific metric, you'll be able to add new metric-variants and see what works best for your clients.
     
 ## Advanced Features
 
-    ### Meta data
+### Meta data
     
-    You can track meta-data with any conversion.  E.g.
+You can track meta-data with any conversion.  E.g.
     
-    rc(:user_visit, :referring_domain => request.env['HTTP_REFERER'], :user_id => session[:user_id])
+     rc(:user_visit, :referring_domain => request.env['HTTP_REFERER'], :user_id => session[:user_id])
     
-    These will be stored with the rally for the conversion and can get used for complex analytics down the line.  (see Converts.meta)
+These will be stored with the rally for the conversion and can get used for complex analytics down the line.  (see Converts.meta)
     
-    ### Switch variants
+### Switch variants
     
-    Instead of just serving text, you can also serve flow control in Mountain Goat, like so:
+Instead of just serving text, you can also serve flow control in Mountain Goat, like so:
     
-    sv(:user_discount, :purchase_coffee) do |variant|
-      variant.ten_percent do
-        discount = 0.10
-      end
+      sv(:user_discount, :purchase_coffee) do |variant|
       
-      variant.big_winner do
-        discount = 0.90
-      end
+        variant.ten_percent do # "ten_percent" is the variant-name
+          discount = 0.10
+        end
+      
+        variant.big_winner do
+          discount = 0.90
+        end
       
-      variant.whomp_whomp do
-        discount = 0.0
+        variant.whomp_whomp(0.5) do #reduce priority to 0.5 (default 1.0)
+          discount = 0.0
+        end
       end
-    end
 
-    Mountain goat will automatically break those down into three cases (:ten_percent, :big_winner, :whomp_whomp) and serve them out at random to the user.
+Mountain goat will automatically break those down into three cases (:ten_percent, :big_winner, :whomp_whomp) and serve them out at random to the user (with whomp_whomp half as likely to be served as the others).
     
-    ### Priorities
+### Priorities
     
-    You may want to test certain items with a lower serve rate (bold new slogans).  You can assign priorities to any metric variant.  The change of a given metric variant being shown is
+You may want to test certain items with a lower serve rate (bold new slogans).  You can assign priorities to any metric variant.  The change of a given metric variant being shown is
     
-    my priority / sum(all priorities for this metric)    
+     my priority / sum(all priorities for this metric)    
     
 ## TODO
- - work on getting migrations better
+ - Better documentation (rdocs)
+ - Add namespacing to avoid conflicts
 
 ## Copyright
 
-Copyright (c) 2011 Geoffrey Hayes, drawn.to. See LICENSE for details.
+Copyright (c) 2011 Geoffrey Hayes, drawn.to. Contact me, Geoff, <geoff@drawn.to> with any questions / ideas / enhacements.  See LICENSE for details.

data/lib/mountain-goat/controllers/mountain_goat/mountain_goat_controller.rb

@@ -26,6 +26,7 @@ class MountainGoatController < ActionController::Base
   
   def verify_access
     return if session.has_key?(:mg_access) && session[:mg_access] == true
+    store_location
     redirect_to '/mg/login' and return
   end
   

data/lib/mountain-goat/controllers/mountain_goat/mountain_goat_rallies_controller.rb

@@ -15,4 +15,24 @@ class MountainGoatRalliesController < MountainGoatController
       format.html { }
     end
   end
+  
+  def new_rallies
+    recent_rally = params[:recent_rally].to_i
+    convert = Convert.find(params[:convert_id].to_i) unless params[:convert_id].blank?
+    
+    if convert
+      @rallies = convert.rallies.find(:all, :conditions => [ 'id > ?', recent_rally ], :order => "created_at DESC" )
+    else
+      @rallies = Rally.find(:all, :conditions => [ 'id > ?', recent_rally ], :order => "created_at DESC" )
+    end
+    
+    if @rallies.count > 0
+      render :json => { :success => true,
+                      :result => render_to_string(:partial => 'mountain_goat_rallies/rallies', :locals => { :rallies => @rallies } ),
+                      :recent_rally_id => @rallies.first.id }
+    else
+      render :json => { :success => false }
+    end
+    
+  end
 end

data/lib/mountain-goat/metric_tracking.rb

@@ -17,6 +17,7 @@ module MetricTracking
     map.resources :mountain_goat_converts, :has_many => [ :mountain_goat_metrics, :mountain_goat_rallies ]
     map.resources :mountain_goat_metrics, :has_many => :mountain_goat_metric_variants
     map.resources :mountain_goat_rallies
+    map.new_rallies '/mg/rallies/new', :controller => :mountain_goat_rallies, :action => :new_rallies 
     map.fresh_metrics '/fresh-metrics', :controller => :mountain_goat_metrics, :action => :fresh_metrics
     map.connect '/mg/public/:file', :controller => :mountain_goat, :action => :fetch
   end

data/lib/mountain-goat/public/mg.js

@@ -11,5 +11,38 @@
 				$($(this).data('slider')).slideUp();
 			}
 		}).change();
+		
+		if ($('.recent-rally[data-reload="true"]').size() > 0) {
+			setTimeout(function() { reloadRallies(); }, 3000);
+		}
+		
+		$('.reload').click(function() { reloadRallies(); });
+		
+		var reloadRallies = function() {
+			var rally_id = parseInt($('.recent-rally').data('rally-id'));
+			var convert_id = $('.recent-rally').data('convert-id');
+			if (rally_id) {
+				$.ajax({
+						url: '/mg/rallies/new',
+						data: { 'recent_rally': rally_id, 'convert_id': convert_id },
+						success: function(json) {
+							if (!json.success) {
+								console.log('No new events');
+							} else {
+								$('.recent-rally').data('rally-id', json.recent_rally_id);
+								$('.rally-list').prepend($(json.result));
+								
+								$('.rally-list li:gt(100)').remove(); //only show 100 elements
+							}
+							
+							if ($('.recent-rally[data-reload="true"]').size() > 0) {
+								setTimeout(function() { reloadRallies(); }, 3000);
+							}
+						}
+				});	
+			}
+		};
 	});
+	
+	
 })();

data/lib/mountain-goat/version.rb

@@ -1,3 +1,3 @@
 class MountainGoat
-  VERSION = "0.0.17"
+  VERSION = "0.0.18"
 end

data/lib/mountain-goat/views/mountain_goat/mountain_goat_rallies/.tmp__rallies.html.erb.83814~

@@ -0,0 +1,9 @@
+<%# locals => rally %>
+
+<li><%= rally.convert.name %> at <%= rally.created_at.to_s %>
+	(
+		<% rally.all_metas.each do |k,v| %>
+			<%= k %>: <%= v %>
+		<% end %>
+	)
+</li>

data/lib/mountain-goat/views/mountain_goat/mountain_goat_rallies/.tmp__rally.html.erb.62757~

@@ -0,0 +1,9 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+<html>
+	<head>
+		<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+		<title>Untitled Document</title>
+	</head>
+	<body>
+	</body>
+</html>

data/lib/mountain-goat/views/mountain_goat/mountain_goat_rallies/.tmp_index.html.erb.1823~

@@ -0,0 +1,22 @@
+
+
+<div id="container-main" class="mt-rallies">
+	<div class="mountain-goat-panel">
+		<h1>Rallies <% if @convert %>for <%=h @convert.name %><% else %>for all Goals<% end %></h1>
+	
+		<% if @rallies.count > 0 %>
+			<ul>
+				<% @rallies.each do |rally| %>
+					<li><%= rally.convert.name %> at <%= rally.created_at.to_s %></li>
+					(
+						<% rally.all_metas.each do |k,v| %>
+							<%= k %>: <%= v %>
+						<% end %>
+					)
+				<% end %>
+			</ul>
+		<% else %>
+			<h2>No rallies for yet this goal.</h2>
+		<% end %>
+	</div>
+</div>

data/lib/mountain-goat/views/mountain_goat/mountain_goat_rallies/_rallies.html.erb

@@ -0,0 +1,5 @@
+<%# locals => rallies %>
+
+<% rallies.each do |rally| %>
+	<%= render :partial => 'mountain_goat_rallies/rally', :locals => { :rally => rally } %>
+<% end %>

data/lib/mountain-goat/views/mountain_goat/mountain_goat_rallies/_rally.html.erb

@@ -0,0 +1,9 @@
+<%# locals => rally %>
+
+<li><%= rally.convert.name %> at <%= rally.created_at.to_s %>
+	(
+		<% rally.all_metas.each do |k,v| %>
+			<%= k %>: <%= v %>
+		<% end %>
+	)
+</li>

data/lib/mountain-goat/views/mountain_goat/mountain_goat_rallies/index.html.erb

@@ -4,15 +4,13 @@
 	<div class="mountain-goat-panel">
 		<h1>Rallies <% if @convert %>for <%=h @convert.name %><% else %>for all Goals<% end %></h1>
 	
+		<div class="recent-rally" data-reload="true" data-rally-id="<%= @rallies.first.id %>" data-convert-id="<%= @convert ? @convert.id : '' %>"></div>
+		<a href="javascript:void(0)" class="reload">Reload</a>
+		
 		<% if @rallies.count > 0 %>
-			<ul>
+			<ul class="rally-list">
 				<% @rallies.each do |rally| %>
-					<li><%= rally.convert.name %> at <%= rally.created_at.to_s %></li>
-					(
-						<% rally.all_metas.each do |k,v| %>
-							<%= k %>: <%= v %>
-						<% end %>
-					)
+					<%= render 'rally', :rally => rally %>
 				<% end %>
 			</ul>
 		<% else %>

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mountain-goat
 version: !ruby/object:Gem::Version 
-  hash: 61
+  hash: 59
   prerelease: 
   segments: 
   - 0
   - 0
-  - 17
-  version: 0.0.17
+  - 18
+  version: 0.0.18
 platform: ruby
 authors: 
 - Geoffrey Hayes
@@ -118,6 +118,11 @@ files:
 - lib/mountain-goat/views/mountain_goat/mountain_goat_metrics/index.html.erb
 - lib/mountain-goat/views/mountain_goat/mountain_goat_metrics/new.html.erb
 - lib/mountain-goat/views/mountain_goat/mountain_goat_metrics/show.html.erb
+- lib/mountain-goat/views/mountain_goat/mountain_goat_rallies/.tmp__rallies.html.erb.83814~
+- lib/mountain-goat/views/mountain_goat/mountain_goat_rallies/.tmp__rally.html.erb.62757~
+- lib/mountain-goat/views/mountain_goat/mountain_goat_rallies/.tmp_index.html.erb.1823~
+- lib/mountain-goat/views/mountain_goat/mountain_goat_rallies/_rallies.html.erb
+- lib/mountain-goat/views/mountain_goat/mountain_goat_rallies/_rally.html.erb
 - lib/mountain-goat/views/mountain_goat/mountain_goat_rallies/index.html.erb
 - mountain-goat.gemspec
 - test/fixtures/ci_metas.yml