RubyGems - i_wonder - Versions diffs - 0.0.1 → 0.0.3 - Mend

i_wonder 0.0.1 → 0.0.3

Files changed (37) hide show

data/README.rdoc +1 -24
data/app/assets/javascripts/i_wonder/application.js +1 -0
data/app/assets/javascripts/i_wonder/reports.js +11 -1
data/app/assets/stylesheets/i_wonder/_shared.css.scss +6 -0
data/app/assets/stylesheets/i_wonder/application.css.scss +2 -5
data/app/assets/stylesheets/i_wonder/reports.css.scss +7 -0
data/app/controllers/i_wonder/reports_controller.rb +36 -3
data/app/models/i_wonder/event.rb +16 -6
data/app/models/i_wonder/metric.rb +57 -14
data/app/models/i_wonder/report.rb +2 -2
data/app/models/i_wonder/snapshot.rb +2 -1
data/app/views/i_wonder/events/index.html.erb +4 -0
data/app/views/i_wonder/metrics/_options_for_custom.html.erb +2 -2
data/app/views/i_wonder/metrics/_options_for_model_counter.html.erb +2 -2
data/app/views/i_wonder/metrics/index.html.erb +3 -1
data/app/views/i_wonder/reports/_form.html.erb +1 -1
data/app/views/i_wonder/reports/_line_report.html.erb +10 -33
data/app/views/i_wonder/reports/_line_report.js.erb +20 -0
data/app/views/layouts/i_wonder.html.erb +4 -0
data/db/migrate/20111022230720_i_wonder_migrations.rb +5 -0
data/lib/i_wonder/configuration.rb +3 -3
data/lib/i_wonder/logging/middleware.rb +5 -4
data/lib/i_wonder/version.rb +1 -1
data/lib/tasks/i_wonder_tasks.rake +4 -0
data/test/dummy/app/assets/javascripts/application.js +1 -0
data/test/dummy/db/schema.rb +5 -0
data/test/dummy/log/development.log +1941 -0
data/test/dummy/log/test.log +25698 -0
data/test/dummy/tmp/cache/assets/D8E/250/sprockets%2Fefe57e932e1d26c3b6af42a5311f0a1c +0 -0
data/test/dummy/tmp/cache/assets/DA7/BA0/sprockets%2F463a9dd811f2418d96fa72cfe05fb8cd +0 -0
data/test/integration/i_wonder/reports_controller_test.rb +3 -3
data/test/unit/i_wonder/event_test.rb +25 -0
data/test/unit/i_wonder/metric_collection_test.rb +53 -29
data/test/unit/i_wonder/metric_creation_test.rb +9 -7
data/test/unit/i_wonder/report_test.rb +9 -9
metadata +22 -23
data/test/dummy/tmp/pids/server.pid +0 -1

data/README.rdoc CHANGED

@@ -54,29 +54,6 @@ Add the engine to your routes. This is where the dashboard will be hosted
     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.
@@ -103,7 +80,7 @@ You can choose to navigate directly to the dashboard. If you want to include a l
 If you want to configure this gem, add this to an initializer.
-  IWonder.configuration do |c|
+  IWonder.configure 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.

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

@@ -5,5 +5,6 @@
 // the compiled file.
 //
 //= require jquery
+//= require jquery-ui
 //= require jquery_ujs
 //= require_tree .

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

@@ -1,4 +1,14 @@
 // Place all the behaviors and hooks related to the matching controller here.
 // All this logic will automatically be available in application.js.
+//= require highcharts
 //= require_self
-//= require highcharts
+$(function(){
+  $("#chart_holder .calendar").datepicker({ dateFormat: 'yy/mm/dd' });
+  $("#ui-datepicker-div").hide(); // this shouldn't be needed, but there seems to be a bug
+  $("#chart_holder #chart_options input").change(function(){
+    $(this).closest("form").submit();
+  });
+});

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

@@ -13,6 +13,12 @@ $pale_red: #ffd2d2;
   box-shadow:$x_offset $y_offset $size $color;
 }
+@mixin inset_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 inset;
+  -moz-box-shadow:$x_offset $y_offset $size $color inset;
+  box-shadow:$x_offset $y_offset $size $color inset;
+}
 @mixin gradiant ($color_a:#aaa, $color_b:#bbb) {
   position:relative;
   background-image:     -webkit-linear-gradient(top, $color_a, $color_b);                       /* Chrome 10+, Saf5.1+ */

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

@@ -30,6 +30,8 @@ html, body { background-color: #e5e5e5;  font-family: Verdana, Helvetica, Arial;
   }
   #container { padding: 20px 40px; }
+  p.description { font-size:90%; color:#555;}
   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;
@@ -45,11 +47,6 @@ html, body { background-color: #e5e5e5;  font-family: Verdana, Helvetica, Arial;
       }
     }
   }
-  .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;}

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

@@ -16,4 +16,11 @@ form.report {
   .report_metric_ids { padding:0px; margin:10px 0;
     li {padding:0px; margin:0px; list-style:none;}
   }
+}
+#chart_holder {background-color:#f0f1fa; padding:8px; border:1px solid #ddd; @include rounded_corners(4px); @include inset_shadow(1px, 1px, 3px, rgba(0,0,0,0.3));
+  #chart_options {
+    label {color:#555; font-size:90%; font-weight:bold;}
+  }
+  #iw_chart_container {background-color:#fff; margin-top:5px; border:1px solid #ddd; @include shadow(1px, 1px, 3px, rgba(0,0,0,0.3));}
 }

data/app/controllers/i_wonder/reports_controller.rb CHANGED

@@ -9,9 +9,20 @@ module IWonder
     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
+      @start_time = (params[:start_time] ? Time.zone.parse(params[:start_time]) : Time.zone.now - 1.month)
+      @end_time = (params[:end_time] ? Time.zone.parse(params[:end_time]) : Time.zone.now)
+      @interval_length = default_interval_length
+      respond_to {|format|
+        format.html { }
+        format.js {
+          if @report.line?
+            render :partial => "line_report.js"
+          else
+            render :text => "?"
+          end
+        }
+      }
     end
     def new
@@ -49,5 +60,27 @@ module IWonder
       redirect_to reports_path, :notice => "Report has been destroyed"
     end
+  protected
+    def default_interval_length
+      length = @end_time - @start_time
+      if length > 2.months
+        interval_length = 1.week
+      elsif length > 1.week
+        interval_length = 1.days
+      else
+        interval_length = 1.hours
+      end
+      # can't show a smaller frequency than the snampshots get taken in.
+      longest_metric_frequency = @report.metrics.collect(&:frequency).max
+      if longest_metric_frequency > interval_length
+        interval_length = longest_metric_frequency
+      end
+      return interval_length
+    end
   end
 end

data/app/models/i_wonder/event.rb CHANGED

@@ -7,16 +7,28 @@ module IWonder
     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")
+        # grab the session_id off of the new_visitor attached to that user
+        new_visitor_event = Event.where(:user_id => user_id, :event_type => "new_visitor").first
+        original_session_id = (new_visitor_event ? new_visitor_event.session_id : session_id)
-        # TODO: remove all, but the earliest new_visit event
+        # for all events on the current session, attach the user and session from that first event
+        update_all({:user_id => user_id, :session_id => original_session_id}, ["session_id = ? AND user_id IS NULL", session_id])
+        # clear our any new_visitor events other than the first one
+        if new_visitor_event and original_session_id != session_id
+          Event.where(:user_id => user_id, :event_type => "new_visitor").where("id <> ?", new_visitor_event.id).delete_all
+        end
+        return original_session_id
       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
+        attr_hash[:created_at] = Time.zone.now.utc
+        attr_hash[:updated_at] = Time.zone.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(", ")
@@ -54,8 +66,6 @@ module IWonder
         }.first
       end
     end
   end
 end

data/app/models/i_wonder/metric.rb CHANGED

@@ -1,7 +1,10 @@
 module IWonder
   class Metric < ActiveRecord::Base
-    attr_accessible :name, :frequency, :archived, :collection_method, :back_date_30_snapshots
-    attr_writer :back_date_30_snapshots
+    BACK_DATE_ITERATIONS = 30
+    attr_accessible :name, :frequency, :archived, :collection_method, :back_date_snapshots
+    attr_accessor :back_date_snapshots
+    attr_writer :back_date_snapshots
     serialize :options, Hash
     attr_accessible :collection_type, :combination_rule, :takes_snapshots
@@ -20,9 +23,10 @@ module IWonder
     has_many :reports, :through => :report_memberships
     has_many :snapshots do
       def most_recent
-        order("created_at DESC").first
+        order("end_time DESC").first
       end
     end
+    accepts_nested_attributes_for :snapshots, :allow_destroy => true
     # ==============================================================================================================================
     # The following methods are for creating the metrics with the coorect values ===================================================
@@ -55,6 +59,14 @@ module IWonder
       true # this preventing it from thinking the validation failed
     end
+    before_validation :remove_existing_snapshots
+    def remove_existing_snapshots
+      if collection_method_changed? or frequency_changed?
+        self.earliest_measurement = nil
+        self.snapshots.each(&:mark_for_destruction)
+      end
+    end
     validate :avoid_dangerous_words
     def avoid_dangerous_words
       if collection_method.present? and collection_method.gsub(QUOTE_REMOVER, "") =~ DANGEROUS_WORDS
@@ -82,6 +94,11 @@ module IWonder
               }
             end
           end
+          if self.model_counter_method == "Creation Rate" and !self.model_counter_class.constantize.new.respond_to?("created_at")
+            errors.add(:base, "Can't calculate creation rate on models without a :created_at column")
+          end
         rescue Exception => e
           errors.add(:model_counter_class, "is not a valid class")
         end
@@ -117,10 +134,19 @@ module IWonder
         query += model_counter_scopes.dup
       end
+      #TODO: these queries should be scoped under the table name
       if model_counter_method == "Creation Rate"
+        self.combination_rule = "sum"
         self.collection_method = "#{query}.where(\"created_at >= ? AND created_at < ?\", start_time, end_time).count"
       else # total numbers
-        self.collection_method = "#{query}.count"
+        self.combination_rule = "average"
+        if self.model_counter_class.constantize.new.respond_to?("created_at")
+          # this is more accurate for guessing backwards
+          self.collection_method = "#{query}.where(\"created_at < ?\", end_time).count"
+        else
+          self.collection_method = "#{query}.count"
+        end
       end
     end
@@ -145,7 +171,7 @@ module IWonder
     # returns a hash with all the key values between the two times. If it has been collecting integers, the key will be the name of the metric
     def value_from(start_time, end_time)
       if takes_snapshots?
-        data = self.snapshots.where("created_at >= ? and created_at < ?", start_time, end_time).collect(&:data)
+        data = self.snapshots.where("start_time < ? AND end_time > ?", end_time, start_time).collect(&:data)
       else
         data = [run_collection_method_from(start_time, end_time)]
       end
@@ -177,16 +203,31 @@ module IWonder
     #TODO: some code to avoid overlap in snapshots needs to be added
     def take_snapshot
       start_time, end_time = timeframe_for_next_snapshot
-      self.snapshots.create(:data => run_collection_method_from(start_time, end_time))
+      while end_time <= Time.zone.now do
+        self.snapshots.create(:data => run_collection_method_from(start_time, end_time), :start_time => start_time, :end_time => end_time)
-      if self.earliest_measurement.nil?
-        self.update_attribute(:earliest_measurement, start_time)
+        if self.earliest_measurement.nil? or self.earliest_measurement > start_time
+          self.update_attribute(:earliest_measurement, start_time)
+        end
+        start_time, end_time = timeframe_for_next_snapshot
       end
     end
     after_save :back_date_if_chosen
     def back_date_if_chosen
-      if @back_date_30_snapshots
+      if @back_date_snapshots and @back_date_snapshots.to_s =~ /1|true|on/i and takes_snapshots? and self.earliest_measurement.nil?
+        self.reload # this keeps bad variables and change states from sneaking in
+        start_time = Time.zone.now - BACK_DATE_ITERATIONS * frequency
+        end_time = start_time + frequency
+        start_time += 1.second
+        self.snapshots.create(:data => run_collection_method_from(start_time, end_time), :start_time => start_time, :end_time => end_time)
+        self.update_attribute(:earliest_measurement, start_time)
+        # not that the first snapshot is taken, running the :take_snapshot command will fill in the rest
+        take_snapshot
       end
     end
@@ -210,13 +251,15 @@ module IWonder
     def timeframe_for_next_snapshot
       recent = self.snapshots.most_recent
       if recent.present?
-        start_at =  recent.created_at
-        end_at = start_at + frequency
+        start_time =  recent.end_time
+        end_time = start_time + frequency
+        start_time += 1.second # this avoids overlap with the previous snapshot
       else
-        start_at = Time.zone.now - frequency
-        end_at = Time.zone.now
+        start_time = Time.zone.now - frequency
+        end_time = Time.zone.now
       end
-      [start_at, end_at]
+      [start_time, end_time]
     end
   end

data/app/models/i_wonder/report.rb CHANGED

@@ -67,7 +67,7 @@ module IWonder
         master_hashes_array << master_hash_for_time_slice
         time_iterator += interval_length
-      end while time_iterator <= end_time
+      end while (time_iterator + interval_length) <= end_time
       # set the value to zero for any
       master_hashes_array.each{|hash_for_slice_of_time|
@@ -77,7 +77,7 @@ module IWonder
       }
       keys_list.collect{|key|
-        {:name => key, :pointInterval => interval_length*1000, :data => master_hashes_array.collect{|mha| mha[key] }}
+        {:name => key, :pointStart => start_time.to_i * 1000, :pointInterval => interval_length*1000, :data => master_hashes_array.collect{|mha| mha[key] }}
       }
     end

data/app/models/i_wonder/snapshot.rb CHANGED

@@ -1,6 +1,6 @@
 module IWonder
   class Snapshot < ActiveRecord::Base
-    attr_accessible :data
+    attr_accessible :data, :start_time, :end_time
     serialize :complex_data, Hash
     belongs_to :metric
@@ -28,5 +28,6 @@ module IWonder
     def complex?
       self.complex_data.present?
     end
   end
 end

data/app/views/i_wonder/events/index.html.erb CHANGED

@@ -1,5 +1,9 @@
 <h1>Events</h1>
+<p class="description">
+	These are raw event details. To see them in a graph, create a metric to track them and a report to display the metric.
+</p>
 <ul id="event_list" class="primary_list">
 	<% for type_group in @groups do %>
 		<li>

data/app/views/i_wonder/metrics/_options_for_custom.html.erb CHANGED

@@ -28,8 +28,8 @@
 		</div>
 		<div class="field">
-			<%= f.check_box :back_date_30_snapshots%>
-			<%= f.label :back_date_30_snapshots, "Try and guess values for the last 30 snapshots?" %>
+			<%= f.check_box :back_date_snapshots%>
+			<%= f.label :back_date_snapshots, "Try and guess values for the last 30 snapshots?" %>
 		</div>
 	</div>

data/app/views/i_wonder/metrics/_options_for_model_counter.html.erb CHANGED

@@ -26,8 +26,8 @@
 		</div>
 		<div class="field">
-			<%= f.check_box :back_date_30_snapshots%>
-			<%= f.label :back_date_30_snapshots, "Try and guess values for the last 30 snapshots?" %>
+			<%= f.check_box :back_date_snapshots%>
+			<%= f.label :back_date_snapshots, "Try and guess values for the last 30 snapshots?" %>
 		</div>
 	</div>

data/app/views/i_wonder/metrics/index.html.erb CHANGED

@@ -1,5 +1,7 @@
 <h1>Metrics</h1>
-<h3>What are we tracking?</h3>
+<p class="description">
+	Metrics are anything you want to track. They can be set up to monitor pretty much anything. To view the data collected, try creating a report for the metrics you wish to display.
+</p>
 <% if @metrics.empty? %>
 	<p class="empty_list">You don't have any metrics</p>

data/app/views/i_wonder/reports/_form.html.erb CHANGED

@@ -22,7 +22,7 @@
 	<div class="field">
 		<%= f.label :report_type %>
-		<%= f.select :report_type, {"Line" => {:value => "Line"}, "Bar" => {:disabled => true}, "AB Test" => {:disabled => true}} %>
+		<%= f.select :report_type, {"Line" => {:value => "Line"}, "Bar" => {:disabled => true}, "Pie" => {:disabled => true}} %>
 	</div>
 	<hr/>

data/app/views/i_wonder/reports/_line_report.html.erb CHANGED

@@ -1,38 +1,15 @@
-<div id="iw_chart_container"></div>
+<div id="chart_holder">
+	<%= form_tag report_path(@report), :method => :get, :remote => true, :id => "chart_options" do %>
+		<%= label_tag :start_time, "Range" %>
+		<%= text_field_tag :start_time, @start_time.strftime("%Y/%m/%d"), :size => 12, :class => "calendar" %>
+		-
+		<%= text_field_tag :end_time, @end_time.strftime("%Y/%m/%d"), :size => 12, :class => "calendar" %>
+	<% end %>
+	<div id="iw_chart_container"></div>
+</div>
 <script type="text/javascript" charset="utf-8">
 	$(function() {
-	  <%
-	  options ||= {}
-	  options[:chart] ||= {}
-	  options[:chart][:renderTo] = "iw_chart_container";
-		options[:title] ||= { :text => "I wonder "+@report.name }
-		options[:series] = @report.collect_series_data(@start_time, @end_time, @interval_length);
-	  # options[:chart][:defaultSeriesType] =
-	  #
-	  options[:credits] = false
-	  #
-	  options[:xAxis] = {}
-	  # new_options[:xAxis][:categories] = options[:x_axis_categories]
-	  options[:xAxis][:dateTimeLabelFormats] ||= { :day => '%b %e', :hour => '%b %e' }
-	  options[:xAxis][:type] ||= 'datetime'
-	  #
-	  # new_options[:series] = options[:series]
-	  #
-	  # new_options[:yAxis] = (options[:yAxis] || {})
-	  # new_options[:yAxis][:allow_decimals] = (options[:y_axis_allow_decimals] ? 'true' : 'false')
-	  # new_options[:yAxis][:min] = (options[:y_axis_min] || 0)
-	  # new_options[:yAxis][:title] = { :text => options[:y_axis_title] } if options[:y_axis_title].present?
-	  #
-	  # new_options[:legend] = (options[:legend] || { :enabled => false })
-	  #
-	  #
-	  # new_options[:tooltip] = options[:tooltip] if options[:tooltip].present?
-	  %>
-		var chart = new Highcharts.Chart(<%= raw options.to_json %>);
+	  <%= render :partial => "line_report.js" %>
 	});
 </script>