mitamirri 0.13.8 → 2.0.8

data/app/models/trackable_stat.rb

@@ -1,46 +1,64 @@
+# Summarizes all stats for all tracked sessions and their actions for a given site in a given month.
 class TrackableStat
 
-  include MongoMapper::Document
+  # Mongoid Config =============================================================================
 
-  # MongoMapper Setup ==============================================================================
+  include Mongoid::Document
+  include Mongoid::Timestamps
 
-  many :trackable_sessions, :order => :created_at
+  references_many :trackable_sessions
 
-  key :site, String, :index => true
-  key :bounces, :default => 0
-  key :clickthroughs, :default => 0
-  key :conversions, :default => 0
-  key :duration, :default => 0
-  key :new_visits, :default => 0
-  key :organic_visits, :default => 0
-  key :pageviews, :default => 0
-  key :ppc_visits, :default => 0
-  key :direct_visits, :default => 0
-  key :return_visits, :default => 0
-  key :search_visits, :default => 0
-  key :visits, :default => 0
-  timestamps!
+  field :site
+  field :bounces, :type => Integer, :default => 0
+  field :clickthroughs, :type => Integer, :default => 0
+  field :conversions, :type => Integer, :default => 0
+  field :duration, :type => Integer, :default => 0
+  field :new_visits, :type => Integer, :default => 0
+  field :organic_visits, :type => Integer, :default => 0
+  field :pageviews, :type => Integer, :default => 0
+  field :ppc_visits, :type => Integer, :default => 0
+  field :direct_visits, :type => Integer, :default => 0
+  field :return_visits, :type => Integer, :default => 0
+  field :search_visits, :type => Integer, :default => 0
+  field :visits, :type => Integer, :default => 0
+
+  index :site, :unique => false
 
   # Scopes =========================================================================================
-  
-  scope :by_site,         lambda { |site| { :conditions => { :site => site } } }
-  scope :by_date,         lambda { |date| { :conditions => { :created_at => { '$gte' => date.beginning_of_month,  '$lte' => date.end_of_month } } } }
-  scope :for_date_range,  lambda { |start_date,end_date| { :conditions => { :created_at => { '$gte' => start_date.beginning_of_month,  '$lte' => end_date.end_of_month } } } }
+
+  scope :by_site,         lambda { |site| { :where => { :site => site } } }
+  scope :by_date,         lambda { |date| { :where => { :created_at => { '$gte' => date.beginning_of_month,  '$lte' => date.end_of_month } } } }
+  scope :for_date_range,  lambda { |start_date,end_date| { :where => { :created_at => { '$gte' => start_date.beginning_of_month,  '$lte' => end_date.end_of_month } } } }
+  scope :for_site,         lambda { |site| { :where => { :site => site } } }
 
   # Class Methods ==================================================================================
 
+  # Returns the names of all sites that have been tracked, used in report filters.
   def self.sites
-    TrackableStat.all(:fields => :site).map{|s| s.site.downcase}.uniq
+    TrackableStat.only(:site).map{|s| s.site.to_s.downcase}.uniq
   end
-    
+
   # Instance Methods ===============================================================================
-  
+
+  # Increments the running tallies of the session- and action-attributes for a given site in a given
+  # month. For example, an action's clickthroughs or conversions, or the kind of session (direct,
+  # natural, paid, search).
+  #
+  # ==== Attributes
+  #
+  # * +:session+ - action as a string: 'click', 'clickthrough', 'conversion', 'mouseover', 'scroll', 'view'
+  # * +:last_action+ - clickthrough destination
+  # * +:previous_action+ - the referring URL
+  #
+  # ==== Examples
+  #
+  #    trackable_stat.touch( 'click', 'cnn.com', 'foo.com/cnn' )
   def touch(session, last_action, previous_action = nil)
     if previous_action.nil?
       # New session
       self.trackable_sessions << session
-      self.clickthroughs  += 1 if last_action.clickthrough?
-      self.conversions    += 1 if last_action.conversion?
+      self.clickthroughs  += 1 if last_action && last_action.clickthrough?
+      self.conversions    += 1 if last_action && last_action.conversion?
       self.direct_visits  += 1 if session.kind == 'direct'
       self.new_visits     += 1 if session.new_visit
       self.organic_visits += 1 if session.kind == 'natural'
@@ -60,5 +78,5 @@ class TrackableStat
     end
     self.save
   end
-  
+
 end

data/app/models/traffic_explorer_report.rb

@@ -0,0 +1,92 @@
+class TrafficExplorerReport < Report
+
+  # Initialization =================================================================================
+  
+  def ready?
+    self.site && self.time_period
+  end
+  
+  def stats
+    sessions
+  end
+  
+  # Graph data =====================================================================================
+  
+  def visits(args)
+    [Visit.new(:kind => args[:visit_kind].titleize, :stats => visit_stats(args))]
+  end
+
+  def visit_stats(args)
+    _visit_stats = []
+    dates.each do |date| 
+      _visit_stats << VisitStat.new(:date => date, :visits => TrackableSession.search_without_date(args).for_month(date).count)
+    end
+    _visit_stats
+  end
+
+  # Stat Methods ===================================================================================
+  
+  def average_pages_per_visit
+    sprintf("%.1f", total_pageviews / total_visits.to_f).gsub('nan','0')
+  end
+  
+  def average_time_on_site
+    average = total_duration / total_visits.to_f
+    average > 60 ? sprintf("%.1f minutes", average / 60.0) : sprintf("%.1f seconds", average).gsub('nan','0')
+  end
+  
+  def bounce_rate
+    bounce_rate = total_bounces / total_visits.to_f
+    sprintf("%.1f%", bounce_rate * 100).gsub('nan','0')
+  end
+  
+  def conversion_rate
+    conversion_rate = total_conversions / total_visits.to_f
+    sprintf("%.1f%", conversion_rate * 100).gsub('nan','0')
+  end
+  
+  def total_bounces
+    @total_bounces ||= stats.select{|s| s.bounce}.count
+  end
+  
+  def total_clickthroughs
+    @total_clickthroughs ||= stats.select{|s| s.has_clickthroughs}.count
+  end
+  
+  def total_clickthroughs_percentage
+    sprintf("%.1f%", (total_clickthroughs / total_visits.to_f) * 100).gsub('nan','0')
+  end
+
+  def total_conversions
+    @total_conversions ||= stats.select{|s| s.has_conversions}.count
+  end
+  
+  def total_duration
+    @total_duration ||= stats.only(:duration).map{|s| s.duration}.sum
+  end
+  
+  def total_new_visits
+    @total_new_visits ||= stats.select{|s| s.new_visit}.count
+  end
+  
+  def total_new_visits_percentage
+    sprintf("%.1f%", (total_new_visits / total_visits.to_f) * 100).gsub('nan','0')
+  end
+        
+  def total_pageviews
+    @total_pageviews ||= stats.only(:pageviews).map{|s| s.pageviews}.sum
+  end
+  
+  def total_return_visits
+    @total_return_visits ||= stats.reject{|s| s.new_visit}.count
+  end
+
+  def total_return_visits_percentage
+    sprintf("%.1f%", (total_return_visits / total_visits.to_f) * 100).gsub('nan','0')
+  end
+
+  def total_visits
+    @total_visits ||= sessions.count
+  end
+  
+end

data/app/models/traffic_summary_report.rb

@@ -0,0 +1,142 @@
+class TrafficSummaryReport < Report
+
+  # Initialization =================================================================================
+  
+  def ready?
+    self.site && self.time_period
+  end
+  
+  def stats
+    if multiple_sites?
+      @stats ||= TrackableStat.for_date_range(start_date, end_date)
+    else
+      @stats ||= TrackableStat.for_site(site).for_date_range(start_date, end_date)
+    end
+  end
+  
+  # Graph data =====================================================================================
+  
+  def keywords_by_frequency(args)
+    TrackableSession.keywords_histogram(args).inject([]){|a,v| a << KeywordStat.new(:keyword => v[0], :count => v[1]); a}.sort{|a,b| a.count <=> b.count}.reverse[0..24]
+  end
+
+  def top_referrers(args)
+    TrackableSession.referrers_histogram(args).inject([]){|a,v| a << ReferrerStat.new(:referrer => v[0], :count => v[1]); a}.sort{|a,b| a.count <=> b.count}.reverse[0..24]
+  end
+  
+  def visits(args)
+    _visits = []
+    _visits << Visit.new(:kind => 'All', :stats => visit_stats(args))
+    _visits << Visit.new(:kind => 'Direct Traffic', :stats => visit_stats(args.merge(:visit_kind => 'direct')))
+    _visits << Visit.new(:kind => 'Referring Sites', :stats => visit_stats(args.merge(:visit_kind => 'natural')))
+    _visits << Visit.new(:kind => 'Organic Search', :stats => visit_stats(args.merge(:visit_kind => 'search')))
+    _visits << Visit.new(:kind => 'Paid Search', :stats => visit_stats(args.merge(:visit_kind => 'paid')))
+    _visits
+  end
+
+  def visit_stats(args)
+    _visit_stats = []
+    dates.each do |date| 
+      _visit_stats << VisitStat.new(:date => date, :visits => TrackableSession.search_without_date(args).for_month(date).count)
+    end
+    _visit_stats
+  end
+
+  # Stat Methods ===================================================================================
+  
+  def average_pages_per_visit
+    sprintf("%.1f", total_pageviews / total_visits.to_f).gsub('nan','0')
+  end
+  
+  def average_time_on_site
+    average = total_duration / total_visits.to_f
+    average > 60 ? sprintf("%.1f minutes", average / 60.0) : sprintf("%.1f seconds", average).gsub('nan','0')
+  end
+  
+  def bounce_rate
+    bounce_rate = total_bounces / total_visits.to_f
+    sprintf("%.1f%", bounce_rate * 100).gsub('nan','0')
+  end
+  
+  def conversion_rate
+    conversion_rate = total_conversions / total_visits.to_f
+    sprintf("%.1f%", conversion_rate * 100).gsub('nan','0')
+  end
+  
+  def total_bounces
+    @total_bounces ||= stats.only(:bounces).map{|s| s.bounces}.sum
+  end
+  
+  def total_clickthroughs
+    @total_clickthroughs ||= stats.only(:clickthroughs).map{|s| s.clickthroughs}.sum
+  end
+  
+  def total_clickthroughs_percentage
+    sprintf("%.1f%", (total_clickthroughs / total_visits.to_f) * 100).gsub('nan','0')
+  end
+
+  def total_conversions
+    @total_conversions ||= stats.only(:conversions).map{|s| s.conversions}.sum
+  end
+  
+  def total_direct_visits
+    @total_direct_visits ||= stats.only(:direct_visits).map{|s| s.direct_visits}.sum
+  end
+
+  def total_direct_visits_percentage
+    sprintf("%.1f%", (total_direct_visits / total_visits.to_f) * 100).gsub('nan','0')
+  end
+  
+  def total_duration
+    @total_duration ||= stats.only(:duration).map{|s| s.duration}.sum
+  end
+  
+  def total_new_visits
+    @total_new_visits ||= stats.only(:new_visits).map{|s| s.new_visits}.sum
+  end
+  
+  def total_new_visits_percentage
+    sprintf("%.1f%", (total_new_visits / total_visits.to_f) * 100).gsub('nan','0')
+  end
+    
+  def total_organic_visits
+    @total_organic_visits ||= stats.only(:organic_visits).map{|s| s.organic_visits}.sum
+  end
+  
+  def total_organic_visits_percentage
+    sprintf("%.1f%", (total_organic_visits / total_visits.to_f) * 100).gsub('nan','0')
+  end
+    
+  def total_pageviews
+    @total_pageviews ||= stats.only(:pageviews).map{|s| s.pageviews}.sum
+  end
+  
+  def total_ppc_visits
+    @total_ppc_visits ||= stats.only(:ppc_visits).map{|s| s.ppc_visits}.sum
+  end
+
+  def total_ppc_visits_percentage
+    sprintf("%.1f%", (total_ppc_visits / total_visits.to_f) * 100).gsub('nan','0')
+  end
+  
+  def total_return_visits
+    @total_return_visits ||= stats.only(:return_visits).map{|s| s.return_visits}.sum
+  end
+
+  def total_return_visits_percentage
+    sprintf("%.1f%", (total_return_visits / total_visits.to_f) * 100).gsub('nan','0')
+  end
+  
+  def total_search_visits
+    @total_search_visits ||= stats.only(:search_visits).map{|s| s.search_visits}.sum
+  end
+
+  def total_search_visits_percentage
+    sprintf("%.1f%", (total_search_visits / total_visits.to_f) * 100).gsub('nan','0')
+  end
+
+  def total_visits
+    @total_visits ||= stats.only(:visits).map{|s| s.visits}.sum
+  end
+  
+end

data/app/models/user_agent_stat.rb

@@ -0,0 +1,4 @@
+class UserAgentStat < StatBase
+  attr_accessor :user_agent
+  attr_accessor :count
+end

data/app/models/visit.rb

@@ -0,0 +1,6 @@
+class Visit < StatBase
+  attr_accessor :kind
+  attr_accessor :date
+  attr_accessor :stats
+  attr_accessor :site
+end

data/app/models/visit_stat.rb

@@ -0,0 +1,5 @@
+class VisitStat < StatBase
+  attr_accessor :date
+  attr_accessor :visits
+  attr_accessor :clickthroughs
+end

data/app/models/visitor.rb

@@ -0,0 +1,4 @@
+class Visitor < StatBase
+  attr_accessor :user_agent_stats
+  attr_accessor :location_stats
+end

data/app/models/visitor_profile_report.rb

@@ -0,0 +1,23 @@
+class VisitorProfileReport < Report
+
+  # Initialization =================================================================================
+
+  def ready?
+    self.site && self.time_period && self.visit_kind
+  end
+
+  def wants_traffic_kind?
+    true
+  end
+
+  # Stats for Visualization ========================================================================
+
+  def locations_by_frequency(args)
+    TrackableSession.locations_histogram(args).inject([]){|a,v| a << LocationStat.new(:name => v[0], :count => v[1]); a}.sort{|a,b| a.count <=> b.count}.reverse[0..24]
+  end
+
+  def user_agents_by_frequency(args)
+    TrackableSession.user_agents_histogram(args).inject([]){|a,v| a << UserAgentStat.new(:user_agent => v[0], :count => v[1]); a}.sort{|a,b| a.count <=> b.count}.reverse[0..24]
+  end
+
+end

data/app/views/admin/tracking/reports/_content.html.erb

@@ -0,0 +1,28 @@
+<div class="form_container">
+  <%= legend_tag "Top Content", :help => 'This chart shows the top 25 most-requested pages across the selected site(s). Click on any bar in the graph for a count of visits to the corresponding page.' -%>
+  <br />
+  <%- if @pages_series.empty? -%>
+    <p><em>No data matched your criteria.</em></p>
+  <%- else -%>
+    <div id="pages_chart" class="chart" style="width: 100%; border: 1px solid #999999; background-color: #ffffff; text-align: center;"></div>
+    
+    <%= Seer::visualize(
+          @pages_series, 
+          :as => :bar_chart,
+          :in_element => 'pages_chart',
+          :series => {:series_label => 'url', :data_method => 'views'},
+          :chart_options => {
+            :height => @pages_series.size * 20,
+            :width => 900,
+            :is_3_d => false,
+            :legend => 'none',
+            :colors => ["#7e7587"],
+            :title => "# of Page Views",
+            :title_font_size => 9,
+            :title_x => '',
+            :axis_font_size => 10
+          }
+        ).html_safe
+    -%>
+  <%- end -%>
+</div>

data/app/views/admin/tracking/reports/_conversion_rate.html.erb

@@ -0,0 +1,30 @@
+<div class="form_container">
+  <%= legend_tag "Visit-to-Lead Conversion Rate (#{params[:time_period].titleize})", :help => 'This graph shows the overall conversion rate week-over-week, which is the percentage of visits that resulted in a lead being submitted. Click on a data point for the conversion rate for the corresponding week.' -%>
+  <br />
+  <%- if @leads.empty? -%>
+    <p><em>No lead data matches your criteria.</em></p>  
+  <%- else -%>
+    <div id="conversions_chart" class="chart" style="width: 100%; border: 1px solid #999999; background-color: #ffffff; text-align: center;"></div>
+    <%= Seer::visualize(
+          @leads, 
+          :as => :line_chart,
+          :in_element => 'conversions_chart',
+          :series => {
+            :series_label => 'Conversion Rate',
+            :data_label => 'short_date',
+            :data_method => 'conversion_rate',
+            :data_series => @leads_series
+          },
+          :chart_options => { 
+            :height => 300,
+            :width => 900,
+            :axis_font_size => 11,
+            :colors => ['#7e7587','#7e7e00','#007e7e','#7e0000', '#007e00'],
+            :title => "",
+            :point_size => 5,
+            :legend => 'none'
+          }
+         ).html_safe
+     -%>
+  <%- end -%>
+</div>

data/app/views/admin/tracking/reports/_criteria.html.erb

@@ -0,0 +1,33 @@
+<form>
+  <fieldset class="form_container">
+    <%= legend_tag "Report Criteria" -%>
+    <%- if @sites.count > 2 -%>
+      <div class="three_column">
+        <fieldset>
+          <label for="site">Site:</label><br />
+          <%= select_tag "site", options_for_select(@sites, params[:site] || "All Sites") -%>
+        </fieldset>
+      </div>
+    <%- else -%>
+      <%= hidden_field_tag :site, @sites.first -%>
+    <%- end -%>
+    <div class="three_column">
+      <fieldset>
+        <label for="time_period">Time Period:</label><br />
+        <%= select_tag "time_period", options_for_select(@time_periods, params[:time_period].titleize) -%>
+      </fieldset>
+    </div>
+    <%- if @report.wants_traffic_kind? -%>
+      <div class="three_column">
+        <fieldset>
+          <label for="visit_kind">Traffic Type:</label><br />
+          <%= select_tag "visit_kind", options_for_select(TrackableSession.kinds_for_select, params[:visit_kind]) -%>
+        </fieldset>
+      </div>
+    <%- end -%>
+    <div class="link_block">
+      <input type="submit" class="link_button" value="Generate Report" />
+      <%= link_to 'Back', admin_tracking_root_path, :class => 'link_button' -%>
+    </div>
+  </fieldset>
+</form>