i_wonder 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,24 @@
+Copyright 2011 OctopusApp Inc. (http://getjobber.com)
+
+NOTE: This license does not cover the highcharts.js file in the dummy 
+      application. Please read the bottom of the README for details.
+
+
+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,147 @@
+= IWonder (Not working yet.)
+
+Flexible Analytics, and Testing for every corner of your rails application. I read "The Lean Startup" and got inspired. There were a few good solutions, but none of them quite did what I was looking for. I highly recommend you check out Vanity (http://vanity.labnotes.org/) as it is a drop-in solution for many rails apps.
+
+Key Differences of IWonder:
+
+- Events get tracked by session, as well as an optional user and/or account. This allows the tracking of a users history.
+- Tests can be performed against a session (non-user), logged in user, or an entire account. For account based apps, having different versions for different users can be bad.
+- Data is collected periodically. Lots of useful scenerios for this. (info get's deleted, overwritten, etc)
+- Different reports (and some metrics) can be setup and changed without having to modify your code. 
+- Different reports can be generated without coding knowledge.
+- Each hit and visitor comes with a referrer and IP code. Because that events will be transferred to the user when they signup, you can see which campaigns are resulting in actual signups and paid conversions.
+- Because the session events get added to the user when they log in, you avoid false positives on marketing analytics from visitors returning on different devices. If your application has a mobile interface, this basically avoids all your users being logged as visitors twice.
+
+More big plans!
+
+- Long term campaign tracking interface (the events already get logged, but this will make it easier to see results)
+- E-mail open tracking (for application generated e-mails like the 'Welcome E-mail')
+- Feature request buttons. - details coming soon
+
+== Requirements
+
+* Due to performance optimization IWonder must be used with an SQL style DB currently.
+* Rails 3.1 or higher
+* Ability to run hourly rake tasks (rake cron)
+* Ability to run a background worker process (delayed_job)
+
+== Installation
+
+=== Install the Gem
+
+Add to your <code>Gemfile</code>:
+
+  gem "i_wonder"
+  
+and install:
+  
+  bundle install
+  
+=== Migrate the DB
+
+Generate the migration files and migrate your database:
+
+  rake i_wonder:install:migrations
+  rake db:migrate
+
+
+=== Create the dashboard controller
+
+Add the engine to your routes. This is where the dashboard will be hosted
+
+  Rails.application.routes.draw do
+    ...
+    mount IWonder::Engine => "/super_analytics_engine"
+  end
+
+This engine will use your standard application layout (unless you set a different layout in the configurations explained later). Whichever layout you use, you
+must include a yield in the HTML header so the CSS and Javascript can be loaded. 
+  
+  <%= yield :extra_scripts_and_styles %>
+  
+This engine also assumes that your layout will handle the flash notifications.
+
+===== Example application layout:
+
+  <html>
+    <head>
+      
+      ... your javascript/css/meta/header stuff here ...
+      
+      <%= yield :extra_scripts_and_styles %>
+    </head>
+    <body>
+      <%= notifications %>
+      <%= yield %>
+    </body>
+  </html
+
+
+=== Setting up the hourly cron task
+
+This gem hooks into the "<code>rake cron</code>" request. It can't take snapshots of your metrics any faster than this cron is run. We recommend every hour.
+This will be run automatically if you are hosted on Heroku and have the 'hourly cron' add-on enabled.
+
+
+=== Install Dependecies
+
+This Gem requires the Delayed::Job gem. Installation and configuration instructions can be found at http://github.com/tobi/delayed_job.
+
+We also require the highcharts javascript file in your applications asset path. We don't include it because of licencing reasons. It's free for testing and development. You can find it at http://www.highcharts.com/
+
+
+=== Security
+
+IWonder's controllers will run any <code>:before_filters</code> you have set in your application controller. You can easily check for a password or admin status there.
+
+=== Options & Configurations
+
+You can choose to navigate directly to the dashboard. If you want to include a link on your admin page to the i_wonder dashboard, your can access the url with <code>i_wonder.root_url</code> such as:
+
+  <%= link_to "Go to analytics >", i_wonder.root_url %>
+
+
+If you want to configure this gem, add this to an initializer.
+
+  IWonder.configuration do |c|
+    c.controllers_to_ignore = []   # These are all the controllers which don't log any events (i_wonder is also ignored)
+    c.only_log_hits_on_200 = true   # By default hits and new visitors won't be logged on anything but a 200 or 304 (not modified). Your custom events will still be recorded.
+    c.back_to_app_link = "/" # this is the link hitting the home button in IWonder will take you to.
+    c.app_name = "My App"
+  end
+
+
+== Usage
+
+=== Event tracking
+
+==== Setting session, user, and account details
+
+This gem will track the visitor with a permanent cookie (will remember them next visit). However, it can also track users and accounts. Simply call one or both of these methods anywhere in the controller. When a user get's added part way through, the :user_id will get filled in for all the previous events for that session. The :new_visitor event for the session will also be removed if the user has an earlier dated :new_visitor event on their account.
+
+  i_wonder_for_user_id(user_id)
+
+or
+  
+  i_wonder_for_account_id(account_id)
+  
+:hits and :new_visitors will be logged automatically. You can store any additional by calling <code>report!(event_sym, options = {})</code> in the controller.
+You can also log an event from a model with the same method <code>report!(event_sym, options = {})</code>, but you will need to provide the <code>:user_id</code>
+or <code>:account_id</code> in the options, if you want them recorded.
+  
+  
+== Contributing & Reporting Issues
+
+In progress...
+
+
+== Licensing
+
+This application is released under the MIT license. 
+
+However, in the dummy app for testing purposes, it contains the Highcharts javascript library (highcharts.com) which is released under the "Creative Commons Attribution-NonCommercial 3.0 License". It is free for testing and development, but not for commercial use. Please see the details at http://highcharts.com/license
+
+---
+
+
+Copyright on Updates - Copyright (c) 2011 OctopusApp Inc. ({getjobber.com}[http://getjobber.com]), released under the MIT license

data/Rakefile

@@ -0,0 +1,39 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'IWonder'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+Bundler::GemHelper.install_tasks
+
+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

data/app/assets/javascripts/i_wonder/application.js

@@ -0,0 +1,9 @@
+// This is a manifest file that'll be compiled into including all the files listed below.
+// Add new JavaScript/Coffee code in separate files in this directory and they'll automatically
+// be included in the compiled file accessible from http://example.com/assets/application.js
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/javascripts/i_wonder/dashboard.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/javascripts/i_wonder/events.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/javascripts/i_wonder/metrics.js

@@ -0,0 +1,19 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.
+
+
+$(function(){
+  $("#metric_collection_type").change(function(){
+    $(".details_for_option").appendTo($("#unused_form_elements"));
+    
+    $("."+$(this).val()+"_details").appendTo($("#active_options_holder"));
+  });
+  
+  $("#metric_takes_snapshots").change(function(){
+    if($(this).prop('checked')){
+      $(".snapshot_details").show();
+    }else{
+      $(".snapshot_details").hide();
+    }
+  });
+})

data/app/assets/javascripts/i_wonder/reports.js

@@ -0,0 +1,4 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.
+//= require_self
+//= require highcharts

data/app/assets/stylesheets/i_wonder/_shared.css.scss

@@ -0,0 +1,28 @@
+
+$light_blue_box_background: #F8F8F8;
+$light_blue_box_border: #E9E9E9;
+$dark_red: #af0000;
+$pale_red: #ffd2d2;
+
+@mixin rounded_corners($radius: 5px) { -moz-border-radius: $radius; -webkit-border-radius: $radius; border-radius: $radius; position:relative;}
+
+
+@mixin shadow($x_offset: 0px, $y_offset: 1px, $size: 8px, $color: rgba(0, 0, 0, 0.5)) { 
+  -webkit-box-shadow:$x_offset $y_offset $size $color;
+  -moz-box-shadow:$x_offset $y_offset $size $color;
+  box-shadow:$x_offset $y_offset $size $color;
+}
+
+@mixin gradiant ($color_a:#aaa, $color_b:#bbb) { 
+  position:relative;
+  background-image:     -webkit-linear-gradient(top, $color_a, $color_b);                       /* Chrome 10+, Saf5.1+ */
+  background-image:     -webkit-gradient(linear, 0% 0%, 0% 100%, from($color_a), to($color_b)); /* Saf4+, Chrome */
+  background-image:     -moz-linear-gradient(top,$color_a,$color_b);                            /* FF3.6 */
+  background-image:     -ms-linear-gradient(top, $color_a, $color_b);                           /* IE10 */
+  background-image:     -o-linear-gradient(top, $color_a, $color_b);                            /* Opera 11.10+ */
+}
+
+@mixin quick_grad ($main_color:#aaa, $buldge:0.2) {
+	background-color:$main_color;
+	@include gradiant($main_color*(1 + $buldge), $main_color*(1 - $buldge));
+}

data/app/assets/stylesheets/i_wonder/application.css.scss

@@ -0,0 +1,90 @@
+/*
+ * This is a manifest file that'll automatically include all the stylesheets available in this directory
+ * and any sub-directories. You're free to add application-wide styles to this file and they'll appear at
+ * the top of the compiled file, but it's generally better to create a new file per style scope.
+ *= require_self
+ *= require i_wonder/dashboard
+ *= require i_wonder/events
+ *= require i_wonder/reports
+ *= require i_wonder/metrics
+*/
+
+@import "_shared.css.scss";
+
+html, body { background-color: #e5e5e5;  font-family: Verdana, Helvetica, Arial; font-size: 14px; }
+
+.flash { padding: 5px 8px; margin: 10px 0; @include rounded_corners(3px);
+  &.flash_notice { background-color: #CFC; border: solid 1px #6C6; }
+  &.flash_warning { background-color: #FFFFE0; border: solid 1px #ffa500; }
+  &.flash_error, &.flash_alert { background-color:$pale_red; border: solid 1px$dark_red; }
+}
+
+#i_wonder_wrapper {width:75%; margin: 20px auto 0 auto; @include shadow(); @include rounded_corners(4px); overflow:hidden; background-color: #FFF;
+  
+  nav {background-color:#777; @include quick_grad(#777, 0.2);  text-align:right; @include rounded_corners(4px);
+    a, span { display:block; padding:5px 10px;}
+    a { font-weight:bold; color:#eef; float:left; text-decoration:none; border-right:1px solid #222; border-left:1px solid #778; text-shadow:-1px -1px 1px #444;
+      &:hover {color:#bbb; text-shadow:1px 1px 1px #333;}
+    }
+    span { color:#234;}
+  }
+  #container { padding: 20px 40px; }
+  
+  p.empty_list {color:#666; }
+
+  ul.primary_list { padding:0px; margin:10px 0; border:1px solid $light_blue_box_border; border-bottom:none; background-color:$light_blue_box_background;
+    li { list-style:none; padding:0px; margin:0px; border-bottom:1px solid $light_blue_box_border;
+      a {display:block; padding:5px; text-decoration:none; height:40px;
+        h3 {padding:0px; margin:0 0 10px 0; font-size:110%; color:#000; font-weight:normal;
+          span {color:#555; font-weight:normal;}
+        }
+        p {padding:0px; margin:0px; font-size:85%; color:#333;}
+        &:hover { background-color:#eef; color:black;
+          * {text-decoration:none; color:blue;}
+        }
+      } 
+    }
+  }
+
+  .show {
+    p.description { font-size:90%; color:#555;}
+  }
+  
+  
+  form.main_form { background-color:$light_blue_box_background; border:1px solid $light_blue_box_border; padding:10px 15px; display:inline-block;
+   h3 {margin:0 0 10px 0;}
+   .field { margin:20px 0 20px 0;
+     label {font-weight:bold; color:#333; font-size:90%; margin-bottom:5px; display:block;}
+     input, textarea, select {margin-left:0px; clear:left;}
+     input[type=checkbox] {float:left; margin-right:5px;}
+     input[type=submit] {font-size:120%; font-weight:bold;}
+     span.description {color:#555; font-size:80%;}
+   }
+  }
+  
+  form .field_with_errors { display:inline;
+    label { color:red; }
+    input { color:red; border-color:red;}
+  }
+
+  #error_explanation {
+    width: 450px;
+    border: 2px solid red;
+    padding: 7px;
+    padding-bottom: 0;
+    margin-bottom: 20px;
+    background-color: #f0f0f0;
+    h2 {
+      text-align: left;
+      font-weight: bold;
+      padding: 5px 5px 5px 15px;
+      font-size: 12px;
+      margin: -7px;
+      margin-bottom: 0px;
+      background-color: #c00;
+      color: #fff; }
+    ul li {
+      font-size: 12px;
+      list-style: square; } }
+  
+}

data/app/assets/stylesheets/i_wonder/dashboard.css.scss

@@ -0,0 +1,6 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/
+
+@import "_shared.css.scss";

data/app/assets/stylesheets/i_wonder/events.css.scss

@@ -0,0 +1,10 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/
+
+@import "_shared.css.scss";
+
+#event_list {
+  li span {margin-right:30px;}
+}

data/app/assets/stylesheets/i_wonder/metrics.css.scss

@@ -0,0 +1,11 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/
+
+@import "_shared.css.scss";
+
+
+pre { padding: 20px; border:1px solid $light_blue_box_border; background-color:$light_blue_box_background; text-align:left; display:inline-block;}
+
+#unused_form_elements {display:none;}

data/app/assets/stylesheets/i_wonder/reports.css.scss

@@ -0,0 +1,19 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/
+
+@import "_shared.css.scss";
+
+form.report {
+  
+  #new_metric_button {float:right;}
+  .nested_metric_form {border:1px solid $light_blue_box_border; padding:5px; margin:5px 0; background-color:#fff;
+    label {width:95px;}
+    textarea {margin:10px 0 10px 20px;}
+  }
+  
+  .report_metric_ids { padding:0px; margin:10px 0;
+    li {padding:0px; margin:0px; list-style:none;}
+  }
+}

data/app/controllers/i_wonder/application_controller.rb

@@ -0,0 +1,4 @@
+module IWonder
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/i_wonder/dashboard_controller.rb

@@ -0,0 +1,9 @@
+module IWonder
+  class DashboardController < ApplicationController
+    layout "i_wonder"
+    
+    def landing
+    end
+    
+  end
+end

data/app/controllers/i_wonder/events_controller.rb

@@ -0,0 +1,14 @@
+module IWonder
+  class EventsController < ApplicationController
+    layout "i_wonder"
+    
+    def index
+      @groups = Event.groups
+    end
+  
+    def show
+      @event_details = Event.get_details_for_event_type(params[:id])
+    end
+  
+  end
+end

data/app/controllers/i_wonder/metrics_controller.rb

@@ -0,0 +1,49 @@
+module IWonder
+  class MetricsController < ApplicationController
+    layout "i_wonder"
+    
+     def index
+        @metrics = Metric.all
+      end
+
+      def show
+        @metric = Metric.find(params[:id])
+      end
+
+      def new
+        @metric = Metric.new(params[:metric])
+      end
+
+      def create
+        @metric = Metric.new(params[:metric])
+
+        if @metric.save
+          redirect_to @metric, :notice => "Successfully created metric"
+        else
+          render "new"
+        end
+      end
+
+      def edit
+        @metric = Metric.find(params[:id])
+        render "edit"
+      end
+
+      def update
+        @metric = Metric.find(params[:id])
+
+        if @metric.update_attributes(params[:metric])
+          redirect_to @metric, :notice => "Successfully updated metric"
+        else
+          render "edit"
+        end
+      end
+
+      def destroy
+        @metric = Metric.find(params[:id])
+        @metric.destroy
+        redirect_to metrics_path, :notice => "Metric has been destroyed"
+      end
+    
+  end
+end

data/app/controllers/i_wonder/reports_controller.rb

@@ -0,0 +1,53 @@
+module IWonder
+  class ReportsController < ApplicationController
+    layout "i_wonder"
+    
+    def index
+      @reports = Report.all
+    end
+
+    def show
+      @report = Report.find(params[:id])
+      
+      @start_time = Time.zone.now - 30.hours #(params[:start_time] || @report.default_start_time)
+      @end_time = (params[:end_time] || Time.zone.now)
+      @interval_length = 1.hour
+    end
+
+    def new
+      @report = Report.new(params[:report])
+    end
+
+    def create
+      @report = Report.new(params[:report])
+
+      if @report.save
+        redirect_to @report, :notice => "Successfully created report"
+      else
+        render "new"
+      end
+    end
+
+    def edit
+      @report = Report.find(params[:id])
+      render "edit"
+    end
+
+    def update
+      @report = Report.find(params[:id])
+
+      if @report.update_attributes(params[:report])
+        redirect_to @report, :notice => "Successfully updated report"
+      else
+        render "edit"
+      end
+    end
+
+    def destroy
+      @report = Report.find(params[:id])
+      @report.destroy
+      redirect_to reports_path, :notice => "Report has been destroyed"
+    end
+    
+  end
+end

data/app/helpers/i_wonder/application_helper.rb

@@ -0,0 +1,4 @@
+module IWonder
+  module ApplicationHelper
+  end
+end

data/app/helpers/i_wonder/dashboard_helper.rb

@@ -0,0 +1,4 @@
+module IWonder
+  module DashboardHelper
+  end
+end

data/app/helpers/i_wonder/events_helper.rb

@@ -0,0 +1,4 @@
+module IWonder
+  module EventsHelper
+  end
+end

data/app/helpers/i_wonder/metrics_helper.rb

@@ -0,0 +1,4 @@
+module IWonder
+  module MetricsHelper
+  end
+end

data/app/helpers/i_wonder/reports_helper.rb

@@ -0,0 +1,4 @@
+module IWonder
+  module ReportsHelper
+  end
+end

data/app/models/i_wonder/event.rb

@@ -0,0 +1,61 @@
+module IWonder
+  class Event < ActiveRecord::Base
+    attr_accessible :event_type, :account_id, :user_id, :session_id, :controller, :action, :referrer, :user_agent, :remote_ip
+    serialize :extra_details, Hash
+   
+    validates_presence_of :event_type, :on => :create, :message => "can't be blank"
+    
+    class << self
+      def merge_session_to_user(session_id, user_id)
+        update_all("user_id = '#{user_id}'", "session_id = '#{session_id}' AND user_id IS NULL")
+        
+        # TODO: remove all, but the earliest new_visit event
+      end
+      # handle_asynchronously :merge_session_to_user
+      
+      
+      def fast_create(attr_hash)
+        attr_hash[:created_at] = Time.now.utc
+        attr_hash[:updated_at] = Time.now.utc
+        
+        keys = [:event_type, :account_id, :user_id, :session_id, :controller, :action, :extra_details, :remote_ip, :user_agent, :referrer, :created_at, :updated_at]
+        key_str = keys.collect(&:to_s).join(", ")
+        
+        pre_value = keys.collect{ "?" }.join(", ")
+        values_array = keys.collect{|k|
+          v = attr_hash[k] 
+          v = v.delete_blank.to_yaml if v.is_a?(Hash)
+          v
+        }
+        value_str = sanitize_sql_array( [pre_value] +  values_array) 
+        
+        Event.connection.execute "INSERT INTO #{table_name} (#{key_str}) values (#{value_str})"
+      end
+      
+      # returns an array of hashes. Each one has a {:event_type, :count, :most_recent} and is sorted by decending most_recent
+      def groups
+        Event.select("event_type, COUNT(event_type) as count, MAX(created_at) as most_recent").group("event_type").order("most_recent DESC").collect{|e|
+          {
+            :event_type => e["event_type"],
+            :count => e["count"].to_i,
+            :most_recent => Time.parse(e["most_recent"])
+          }
+        }
+      end
+
+      
+      def get_details_for_event_type(type)
+        Event.where(:event_type => type).select("COUNT(event_type) as count, MAX(created_at) as most_recent").group("event_type").collect{|e|
+          {
+            :event_type => type,
+            :count => e["count"].to_i,
+            :most_recent => Time.parse(e["most_recent"])
+          }
+        }.first
+      end
+      
+
+      
+    end
+  end
+end