cohortly 0.0.1

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+
+gem "rails", "3.0.4"
+gem "capybara"
+
+gem 'mongo_mapper'
+gem 'bson_ext'
+
+# To use debugger (ruby-debug for Ruby 1.8.7+, ruby-debug19 for Ruby 1.9.2+)
+# gem 'ruby-debug'
+# gem 'ruby-debug19'

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,61 @@
+= Cohortly
+
+The beginings of an engine to do basic cohort analysis on a feature basis.
+
+== Configuration
+
+=== Mongo database config
+
+Setup a cohortly.yml file in your config directory
+
+  production:
+    host: localhost
+    port: 27017
+    username: nyusername
+    password: mypassword
+    database: cohortly-production
+
+=== Application controller config
+
+Setup cohortly notifications by letting it know who your user is and his start date.  
+You also need to give cohortly the controller and action.
+
+  class ApplicationController < ActionController::Base
+    before_filter do
+      if current_user.logged_in?
+        ActiveSupport::Notifications.instrument("cohortly.event",  { 
+                :user_start_date => current_user.created_at,
+                :user_id         => current_user.id,
+                :controller => params[:controller],
+                :action => params[:action]
+               })
+      end
+    end
+  end
+
+===  Tag Config
+
+The tag config maps controllers and actions to tags that get added to the metrics that are recorded.
+
+In confg/initializers/cohortly.rb
+
+  Cohortly::TagConfig.draw_tags do
+    tag :login do
+      controller :session do
+        actions :create
+      end
+    end
+    tag :logout do
+      controller :sessions do
+        actions :destroy
+      end
+    end
+    tag :view_account do
+      controller :account do
+        actions :show
+      end
+    end
+  end
+
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,29 @@
+# encoding: UTF-8
+require 'rubygems'
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rake'
+require 'rake/rdoctask'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task :default => :test
+
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Cohortly'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/app/controllers/cohortly/cohortly_controller.rb

@@ -0,0 +1,8 @@
+class Cohortly::CohortlyController < ApplicationController
+  layout 'cohortly/application'
+  before_filter do
+    if self.respond_to? :cohortly_authenticate
+      self.cohortly_authenticate
+    end
+  end
+end

data/app/controllers/cohortly/metrics_controller.rb

@@ -0,0 +1,14 @@
+class Cohortly::MetricsController < Cohortly::CohortlyController
+  def index
+    @metric_search = Cohortly::Metric.new(params[:cohortly_metric])
+    
+    scope = Cohortly::Metric.limit(250).sort(:created_at.desc)
+    if params[:tags]
+      scope = scope.where(:tags => { :$all => params[:tags] })
+    end
+    if @metric_search.user_id
+      scope = scope.where(:user_id => @metric_search.user_id)
+    end
+    @metrics = scope.all
+  end
+end

data/app/controllers/cohortly/reports_controller.rb

@@ -0,0 +1,8 @@
+class Cohortly::ReportsController < Cohortly::CohortlyController
+  def index
+    @metric_search = Cohortly::Metric.new(params[:cohortly_metric])
+    Cohortly::Metric.cohort_chart_for_tag(params[:tags])    
+    @report = Cohortly::Report.new( Cohortly::Metric.report_table_name(params[:tags]) )  
+  end
+
+end

data/app/models/cohortly/metric.rb

@@ -0,0 +1,79 @@
+module Cohortly
+  class Metric
+    include MongoMapper::Document
+
+    key :user_start_date, Time
+    key :user_id, Integer
+    key :user_email, String
+    key :tags, Array
+    key :controller, String
+    key :action, String
+    timestamps!
+
+    ensure_index :tags
+    
+    def self.store!(args)
+      data = args[4]
+      if data[:controller] && !data[:controller]['cohortly']
+        data[:tags] = Cohortly::TagConfig.tags_for(data[:controller], data[:action])
+        data[:user_email] = data[:email] if data[:email]
+        data[:tags] += data[:add_tags] if data[:add_tags]
+        create(data)
+      end
+    end
+
+    def self.cohort_chart_for_tag(tags = nil)
+      query = {}
+      query = { :tags => { :$all => tags } } if tags
+      self.collection.map_reduce(self.month_map,
+                                 self.reduce,
+                                 { :out => self.report_table_name(tags),
+                                   :raw => true,
+                                   :query => query})  
+    end
+
+    def self.report_table_name(tags = nil)
+      "cohort_report#{ tags ? "_#{ tags.sort.join('_') }" : '' }"
+    end
+
+    def self.month_map
+      <<-JS
+        function() {
+          function get_month_date(date) {
+            var year = date.getYear() + 1900;
+            var month = date.getMonth() + 1;
+            if(month < 10) { month = '0' + month }
+            return year + '-' + month;
+          }
+          var start_date = get_month_date(this.user_start_date);
+          var happened_on = get_month_date(this.created_at);
+          var payload = {};
+          payload[happened_on] = {};
+          payload[happened_on][this.user_id] = 1;
+          emit( start_date, payload );
+        }
+      JS
+    end
+
+    def self.reduce
+      <<-JS
+        function(key, values) {
+          var result = {};
+          values.forEach(function(value) {
+            for(happened_date in value) {
+                if(!result[happened_date]) {
+                  result[happened_date] = value[happened_date];
+                } else {
+                  for(user_id in value[happened_date]) {
+                    result[happened_date][user_id] = 1;
+                  }
+                }
+            }
+          });
+          return result;
+        }
+      JS
+    end
+
+  end
+end

data/app/models/cohortly/report.rb

@@ -0,0 +1,78 @@
+module Cohortly
+  class Report
+    # this is the reduced collection
+    attr_accessor :collection
+    def initialize(collection)
+      self.collection = collection
+    end
+
+    def data
+      @data ||= (MongoMapper.database[self.collection].find().collect {|x| x}).sort_by {|x| x['_id'] }
+    end
+
+    def start_month
+      data.first['_id']
+    end
+
+    def end_month
+      time_to_month(Time.now)
+    end
+
+    def time_to_month(time)
+      time.strftime('%Y-%m')
+    end
+
+    def month_to_time(str_month)
+      year, month = str_month.split('-')
+      Time.utc(year.to_i, month.to_i)
+    end
+
+    def user_count_in_cohort(str_month)
+      Cohortly::Metric.collection.distinct(:user_id,
+                                           { :user_start_date => { :$gt => month_to_time(str_month),
+                                                                   :$lt => (month_to_time(str_month) + 1.month)}}).length
+    end
+
+    def month_cohorts
+      return [] unless data.first
+      start_time = month_to_time(start_month)
+      end_time = month_to_time(end_month)
+      cur_time = start_time
+      res = []
+      while(cur_time <= end_time) do
+        res << time_to_month(cur_time)
+        cur_time += 1.month
+      end
+      res
+    end
+
+    def month_cohorts_from(cohort_key)
+      index = month_cohorts.index(cohort_key)
+      month_cohorts[(index + 1)..-1]
+    end
+
+    def report_line(cohort_key)
+      line = data.find {|x| x['_id'] == cohort_key}
+      return [] unless line
+      month_cohorts_from(cohort_key).collect do |key|
+        if line["value"][key]
+          line["value"][key].keys.length
+        else
+          0
+        end
+      end
+    end
+
+    def percent_line(cohort_key)
+      line = report_line(cohort_key)
+      base = user_count_in_cohort(cohort_key)
+      line.collect { |x| (x/base.to_f * 100).round }.unshift base
+    end
+    
+    def report_totals
+      month_cohorts.collect do |cohort_key|
+        report_line(cohort_key)
+      end
+    end
+  end
+end

data/app/views/cohortly/metrics/_metric.html.erb

@@ -0,0 +1,8 @@
+<tr class="<%= cycle('odd', 'even') %>">
+  <td><%= metric.user_id %></td>
+  <td><%= metric.user_email %></td>
+  <td><%= metric.created_at.strftime("%m/%d/%Y %H:%M") %></td>
+  <td><%= metric.controller %></td>
+  <td><%= metric.action %></td>
+  <td><%= metric.tags.join(', ')  %></td>
+</tr>

data/app/views/cohortly/metrics/_tags.html.erb

@@ -0,0 +1,8 @@
+<div class="tags">
+  <% Cohortly::Metric.collection.distinct(:tags).each do |tag| %>
+    <span class"tag">
+      <%= check_box_tag 'tags[]', tag, params[:tags] &&
+      params[:tags].include?(tag) %><label><%= tag %></label>
+    </span>
+  <% end %>
+</div>

data/app/views/cohortly/metrics/index.html.erb

@@ -0,0 +1,22 @@
+<h2>Metrics</h2>
+
+<%= form_for(@metric_search, :url => cohortly_metrics_path, :html => {
+:method =>:get }) do |f| %>
+  <div class="field">
+    <%= f.label :user_id %>
+    <%= f.text_field :user_id %>
+  </div>
+  <%= render :partial => 'cohortly/metrics/tags' %>
+  <%= f.submit "filter" %>
+<% end %>
+<table class="hor-zebra">
+  <tr>
+    <th>User</th>
+    <th>User Email</th>
+    <th>Time</th>
+    <th>Controller</th>
+    <th>Action</th>
+    <th>Tags</th>
+  </tr>
+  <%= render :collection => @metrics, :partial => 'metric' %>
+</table>

data/app/views/cohortly/reports/index.html.erb

@@ -0,0 +1,32 @@
+<h2>Cohort Reports</h2>
+
+<%= form_for @metric_search, :url => cohortly_reports_path, :html =>
+{:method => :get} do |f| %>
+  <%= render :partial => 'cohortly/metrics/tags' %>
+  <%= f.submit 'Get Report'%>
+<% end %>
+
+
+<table class="one-column-emphasis">
+  <colgroup>
+    <col class="oce-first">
+  </colgroup>
+  <thead>
+    <tr>
+      <th>Month</th>
+      <th>N</th>
+      <% 12.times do |month| %>
+        <th>M<%= month + 1 %></th>
+      <% end %>
+    </tr>
+  </thead>
+  <% @report.month_cohorts.each do |cohort_key| %>
+    <tr class="<%= cycle('odd', 'even') %>">
+      <td><%= cohort_key %></td>
+      <% @report.percent_line(cohort_key)[0,13].each do |val| %>
+        <td style="text-align: right;"><%= val %></td>
+      <% end %>
+    </tr>
+  <% end %>
+</table>
+

data/app/views/cohortly/reports/show.html.erb

@@ -0,0 +1,22 @@
+<h1><%= params[:id] %></h1>
+
+
+
+<table>
+  <tr>
+    <th>Month</th>
+    <th>N</th>
+    <% 12.times do |month| %>
+      <th><%= (month + 1).ordinalize %> month</th>
+    <% end %>
+  </tr>
+  <% @report.month_cohorts.each do |cohort_key| %>
+    <tr class="<%= cycle('odd', 'even') %>">
+      <td><%= cohort_key %></td>
+      <% @report.percent_line(cohort_key)[0,13].each do |val| %>
+        <td style="text-align: right;"><%= val %></td>
+      <% end %>
+    </tr>
+  <% end %>
+</table>
+

data/app/views/layouts/cohortly/application.html.erb

@@ -0,0 +1,144 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Cohortly</title>
+  <%= csrf_meta_tag %>
+  <style>
+
+    body {
+      font-family: "Lucida Sans Unicode","Lucida Grande",Sans-Serif;
+      font-size: 12px;
+      margin: 0;
+      color: #666699;
+    }
+    form {
+
+    }
+    .field, .tags {
+      margin-bottom: 1em;
+    }
+    .field label {
+     display:block;
+    }
+    .header {
+      background-color: #E8EDFF;
+      height: 50px;
+    }
+    .header h1 {
+      padding-top: 12px;
+      margin: 0;
+      color: #669;
+    } 
+    .container {
+      position: relative;
+      margin:0 auto;
+      width: 960px;
+    }
+    .hor-zebra {
+      border-collapse: collapse;
+      font-family: "Lucida Sans Unicode","Lucida Grande",Sans-Serif;
+      font-size: 12px;
+      text-align: left;
+      width: 960px;
+    }
+    .hor-zebra th {
+      color: #003399;
+      font-size: 14px;
+      font-weight: normal;
+      padding: 10px 8px;
+    }
+    .hor-zebra td {
+      color: #666699;
+      padding: 8px;
+    }
+    .hor-zebra .odd {
+      background: none repeat scroll 0 0 #E8EDFF;
+    }
+
+    .one-column-emphasis {
+      border-collapse: collapse;
+      font-family: "Lucida Sans Unicode","Lucida Grande",Sans-Serif;
+      font-size: 12px;
+      text-align: left;
+      position: relative;
+      left: -4px;
+      margin-top: 20px;
+    }
+    .one-column-emphasis th {
+      color: #003399;
+      font-size: 14px;
+      font-weight: normal;
+      padding: 12px 15px;
+    }
+    .one-column-emphasis td {
+      border-top: 1px solid #E8EDFF;
+      color: #666699;
+      padding: 10px 15px;
+    }
+    .oce-first {
+      background: none repeat scroll 0 0 #D0DAFD;
+      border-left: 10px solid transparent;
+      border-right: 10px solid transparent;
+    }
+    .one-column-emphasis tr:hover td {
+      background: none repeat scroll 0 0 #EFF2FF;
+      color: #333399;
+    }
+    .navigation {
+      position: absolute;
+      bottom: -3px;
+      right: 0;
+     }
+
+
+    .navigation ul {
+       list-style: none;
+       margin: 0;
+       padding: 0;
+    }
+    
+
+    .navigation ul li {
+      display: inline;
+      margin-right: .75em;
+      background-color: #FFF;
+      color: #669;
+      border-radius: 4px; 
+   }
+
+   .navigation ul li.last {
+      margin-right: 0;
+  }
+  .navigation li {
+     padding: 5px 1em;
+   }
+   .navigation li a {
+     color: #669;
+     text-decoration: none;
+   }
+  </style>
+
+</head>
+<body>
+  <div class="header">
+  <div class="container">
+    <h1>Cohortly</h1>
+    <div class="navigation">
+      <ul>
+        <li><span><%= link_to "Metrics", cohortly_metrics_path %></span></li>
+        <li><%= link_to "Cohort Reports", cohortly_reports_path %></span></li>
+      </ul>
+    </div>
+  </div>
+  </div>
+  <div class="content">
+    <div class="container">
+      <%= yield %>
+    </div>
+  </div>
+  <div class="footer">
+    <div class="container">
+    </div>
+  </div>
+</body>
+</html>