mitamirri 0.13.8 → 2.0.8

data/app/models/keyword_stat.rb

@@ -0,0 +1,4 @@
+class KeywordStat < StatBase
+  attr_accessor :keyword
+  attr_accessor :count
+end

data/app/models/lead.rb

@@ -0,0 +1,3 @@
+class Lead < StatBase
+  attr_accessor :stats
+end

data/app/models/lead_stat.rb

@@ -0,0 +1,5 @@
+class LeadStat < StatBase
+  attr_accessor :leads
+  attr_accessor :conversion_rate
+  attr_accessor :date
+end

data/app/models/leads_report.rb

@@ -0,0 +1,32 @@
+class LeadsReport < Report
+
+  # Initialization =================================================================================
+  
+  def ready?
+    self.site && self.time_period && self.visit_kind
+  end
+  
+  def wants_traffic_kind?
+    true
+  end
+
+  # Stats for Visualization ========================================================================
+
+  def leads(args)
+    _leads = []
+    _leads << Lead.new(:stats => lead_stats(args))
+    _leads
+  end
+  
+  def lead_stats(args)
+    _lead_stats = []
+    dates_by_week.each do |date|
+      _total_sessions = TrackableSession.search_without_date(args).for_week(date).count
+      _total_conversions = TrackableSession.search_without_date(args).for_week(date).with_conversions.count
+      _conversion_rate = (_total_conversions.to_f / _total_sessions) * 100
+      _lead_stats << LeadStat.new(:date => date, :leads => _total_conversions, :conversion_rate => sprintf("%0.1f",_conversion_rate).to_f)
+    end
+    _lead_stats
+  end
+  
+end

data/app/models/location_stat.rb

@@ -0,0 +1,37 @@
+class LocationStat < StatBase
+  attr_accessor :name
+  attr_accessor :latitude
+  attr_accessor :longitude
+  attr_accessor :count
+
+  def initialize(args)
+    super
+    geocode
+  end
+
+  def geocode
+    if _location = TrackableLocation.where(:location => self.name).first
+      self.latitude = _location.latitude
+      self.longitude = _location.longitude
+    else
+      begin
+        _coords = Geokit::Geocoders::MultiGeocoder.geocode(self.name)
+      rescue
+      end
+      if _coords && _coords.success
+        self.latitude = _coords.lat
+        self.longitude = _coords.lng
+        TrackableLocation.create(:location => self.name, :latitude => self.latitude, :longitude => self.longitude)
+      end
+    end
+  end
+
+  def geocoded?
+    self.latitude && self.longitude
+  end
+
+  def sanitized_name
+    self.name.gsub("'","\\\\'")
+  end
+
+end

data/app/models/referrer_stat.rb

@@ -0,0 +1,4 @@
+class ReferrerStat < StatBase
+  attr_accessor :referrer
+  attr_accessor :count
+end

data/app/models/report.rb

@@ -0,0 +1,83 @@
+class Report
+  
+  attr_accessor :site
+  attr_accessor :time_period
+  attr_accessor :visit_kind
+  attr_accessor :action_kind
+  
+  def initialize(args)
+    args.each{|k,v| self.send("#{k}=", v.downcase) if self.respond_to?(k)}
+    self.time_period ||= 'past 3 months'
+    self.visit_kind ||= 'all'
+    self.visit_kind = 'all' if self.visit_kind == 'total'
+  end
+  
+  def dates
+    return @dates if @dates
+    @dates = []
+    case self.time_period.downcase
+      when 'past month'
+        _increment = 1
+      when 'past 3 months'
+        _increment = 2
+      when 'past 6 months'
+        _increment = 5
+      when 'past 12 months'
+        _increment = 11
+      else 'all time'
+        _increment = 24
+    end
+    
+    (1.._increment).each{ |i| @dates << (Time.zone.now - i.months).beginning_of_month }
+    @dates.reverse!
+    @dates << Time.zone.now.end_of_month
+    @dates
+  end
+  
+  def dates_by_week
+    return @dates_by_week if @dates_by_week
+    @dates_by_week = []
+    case self.time_period.downcase
+      when 'past month'
+        _increment = 4
+      when 'past 3 months'
+        _increment = 12
+      when 'past 6 months'
+        _increment = 24
+      when 'past 12 months'
+        _increment = 52
+      else
+        _increment = 52
+    end
+    
+    (1.._increment).each{ |i| @dates_by_week << (Time.zone.now - i.weeks).end_of_week }
+    @dates_by_week.reverse!
+    @dates_by_week << Time.zone.now.end_of_week
+    @dates_by_week
+  end
+  
+  def start_date
+    self.dates.first
+  end
+  
+  def end_date
+    self.dates.last.end_of_month
+  end
+
+  def multiple_sites?
+    self.site.downcase == 'all sites'
+  end
+  
+  def recent_sessions
+    self.sessions[0..24]
+  end
+  
+  def sessions
+    @sessions ||= TrackableSession.search(:action_kind => self.action_kind, :visit_kind => self.visit_kind, :site => self.site, :time_period => self.time_period.downcase)
+  end
+  
+  def wants_traffic_kind?
+    false
+  end
+  
+end

data/app/models/stat_base.rb

@@ -0,0 +1,11 @@
+class StatBase
+
+  def initialize(args)
+    args.each{ |k,v| self.send("#{k}=", v) if self.respond_to?(k) }
+  end
+
+  def short_date
+    self.date.to_s(:concise)
+  end
+  
+end

data/app/models/trackable_action.rb

@@ -1,46 +1,61 @@
-class TrackableAction
-
-  include MongoMapper::Document
-
-  # MongoMapper Setup ==============================================================================
-  
-  belongs_to :trackable_session
-
-  key :trackable_session_id, ObjectId
-  key :kind, String, :index => true
-  key :label, String, :index => true
-  key :referrer, String
-  key :url, String, :index => true
-  key :relative_url, String
-  key :site, String, :index => true
-  key :new_visit, Boolean
-  timestamps!
-  
+class TrackableAction < TrackableBase
+
+  # Mongoid Config =================================================================================
+
+  include Mongoid::Document
+  include Mongoid::Timestamps
+
+  field :kind
+  field :label
+  field :referrer
+  field :url
+  field :relative_url
+  field :site
+  field :new_visit, :type => Boolean
+
+  index :kind,  :unique => false
+  index :label, :unique => false
+  index :url,   :unique => false
+  index :site,  :unique => false
+
+  referenced_in :trackable_session
+
   # Scopes =========================================================================================
 
-  scope :by_kind,         lambda { |k| { :conditions => { :kind => k } } }
-  scope :by_label,        lambda { |l| { :conditions => { :label => l } } }
-  scope :clicks,          :conditions => {:kind => 'click'}
-  scope :clickthroughs,   :conditions => {:kind => 'clickthrough'}
-  scope :conversions,     :conditions => {:kind => 'conversion'}
-  scope :leads,           :conditions => {:kind => 'conversion'}
-  scope :for_site,        lambda { |s| { :conditions => { :site => s } } }
-  scope :for_month,       lambda { |d| { :conditions => { :created_at => { '$gte' => d.beginning_of_month,  '$lte' => d.end_of_month } } } }
-  scope :for_week,        lambda { |d| { :conditions => { :created_at => { '$gte' => d.beginning_of_week,  '$lte' => d.end_of_week } } } }
-  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 :mouseovers,      :conditions => {:kind => 'mouseover'}
-  scope :scrolls,         :conditions => {:kind => 'scroll'}
-  scope :views,           :conditions => {:kind => 'view'}
-  
+  scope :by_kind,         lambda { |k| { :where => { :kind => k } } }
+  scope :by_label,        lambda { |l| { :where => { :label => l } } }
+  scope :clicks,          :where => {:kind => 'click'}
+  scope :clickthroughs,   :where => {:kind => 'clickthrough'}
+  scope :conversions,     :where => {:kind => 'conversion'}
+  scope :leads,           :where => {:kind => 'conversion'}
+  scope :for_site,        lambda { |s| { :where => { :site => s } } }
+  scope :for_month,       lambda { |d| { :where => { :created_at => { '$gte' => d.beginning_of_month,  '$lte' => d.end_of_month } } } }
+  scope :for_week,        lambda { |d| { :where => { :created_at => { '$gte' => d.beginning_of_week,  '$lte' => d.end_of_week } } } }
+  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 :mouseovers,      :where => {:kind => 'mouseover'}
+  scope :scrolls,         :where => {:kind => 'scroll'}
+  scope :views,           :where => {:kind => 'view'}
+
   # Constants ======================================================================================
 
   KINDS = ['clicks', 'leads', 'scrolls', 'mouseovers', 'clickthroughs']
 
   # Class Methods ==================================================================================
 
+  # Create a tracked action from the specified arguments. The action finds an existing session or creates a new one.
+  #
+  # ==== Attributes
+  #
+  # * +:params+ - {:site => 'foo.com', :referrer => 'cnn.com/foo', :url => '/cnn'}
+  # * +:creation_date+ - action's creation date (used for testing)
+  #
+  # ==== Examples
+  #
+  #    TrackableAction.create_from_params( :site => 'foo.com' )
   def self.create_from_params(params, creation_date = Time.zone.now)
     _referring_site = nil
     _relative_url = nil
+    # Some govt URLs break URI.parse, so wrap in a begin/rescue block
     begin
       if ! params[:referrer].blank? && params[:referrer] != '/'
         _referring_site = URI.parse(params[:referrer]).host
@@ -49,10 +64,10 @@ class TrackableAction
       _relative_url = URI.parse(params[:url]).path.downcase
     rescue
     end
-    
-    unless trackable_session = TrackableSession.find_by_session_id(params[:session_id])
+
+    unless trackable_session = TrackableSession.where(:session_id => params[:session_id]).first
       trackable_session = TrackableSession.create(
-        :session_id => params[:session_id], 
+        :session_id => params[:session_id],
         :referrer => _referring_site,
         :referring_keywords => params[:referring_keywords],
         :ip_address => params[:remote_ip],
@@ -66,7 +81,7 @@ class TrackableAction
         :created_at => creation_date
       )
     end
-    _action = TrackableAction.create(
+    _action = trackable_session.trackable_actions.create(
       :kind => params[:kind],
       :label => params[:label],
       :referrer => params[:referrer],
@@ -79,7 +94,7 @@ class TrackableAction
     trackable_session.touch(params[:kind], params[:destination], _relative_url)
     _action
   end
-  
+
   def self.create_test_data!(count = 1000, destructive = true)
 
     if destructive
@@ -87,15 +102,15 @@ class TrackableAction
       TrackableSession.delete_all
       TrackableAction.delete_all
     end
-    
-    1..count.times do 
+
+    1..count.times do
       params = {
         :remote_ip        => "127.0.0.#{rand(128)}",
         :site             => ['www.test1.com', 'www.test2.com', 'www.test3.com'].rand,
         :initial_referrer => ['','','','','','http://www.google.com','http://www.bing.com','http://www.yahoo.com','http://www.seologic.com','http://www.idolhands.com','http://www.findcounseling.com','http://www.emeritus.com'].rand,
         :session_id       => "#{rand(10000)}#{('a'..'z').to_a.rand}"
       }
-  
+
       created_at = Time.zone.now - rand(6).months - rand(30).days
       (1..rand(10)).each do |i|
         params[:kind] = ['view','view','mouseover','click','view','view','scroll','view','click','conversion'].rand
@@ -105,88 +120,96 @@ class TrackableAction
         params[:label] = params[:kind].titleize
         TrackableAction.create_from_params(params, created_at + i.minutes)
       end
-    end    
+    end
     "Created #{count} sample sessions."
   end
 
-  # Returns a list of kinds that have already been tracked.
+  # Returns a list of kinds for all actions that have already been tracked, used to populate report filters.
   def self.kinds
-    _kinds = []
-    KINDS.each{ |kind| _kinds << kind unless self.send(kind).count.zero? }
-    _kinds
+    TrackableAction.all.map{|ta| ta.kind}.uniq.sort - ['view']
   end
-  
+
+  # Returns a histogram for visited pages in the specified site(s).
+  #
+  # ==== Attributes
+  #
+  # * +:action_kind+ - kind of action: 'clicks', 'leads', 'scrolls', 'mouseovers', 'clickthroughs'
+  # * +:site+ - name of a site
+  # * +:time_period+ - date range as a string: 'past 3 months', 'past 6 months', 'past 12 months'
+  # * +:visit_kind+ - kind of visit as a string: 'direct', 'natural', 'paid', 'search'
+  #
+  # ==== Examples
+  #
+  #    TrackableAction.pages_histogram( :site => 'foo.com' )
   def self.pages_histogram(args)
-    TrackableAction.collection.group("function(x) { return { url: x.url }; }", TrackableAction.search(args).to_hash, { :count => 0}, "function(x,y){y.count++}", true).inject({}){|h,k| h[URI.parse(k['url']).path] ||= 0; h[URI.parse(k['url']).path] += k['count']; h}.sort{|a,b| a[1] <=> b[1]}.reverse
+    conditions = TrackableAction.search(args).selector
+    TrackableAction.collection.group(:keyf => "function(x) { return { url: x.url }; }", :cond => conditions, :initial => { :count => 0}, :reduce => "function(x,y){y.count++}").inject({}){|h,k| k['url'] ||= '/'; h[URI.parse(k['url']).path] ||= 0; h[URI.parse(k['url']).path] += k['count']; h}.sort{|a,b| a[1] <=> b[1]}.reverse
   end
 
+  # Returns a scope based on time period, site, and visit kind. Null arguments returns all.
+  #
+  # ==== Attributes
+  #
+  # * +:action_kind+ - kind of action: 'clicks', 'leads', 'scrolls', 'mouseovers', 'clickthroughs'
+  # * +:site+ - name of a site
+  # * +:time_period+ - date range as a string: 'past 3 months', 'past 6 months', 'past 12 months'
+  # * +:visit_kind+ - kind of visit as a string: 'direct', 'natural', 'paid', 'search'
+  #
+  # ==== Examples
+  #
+  #    TrackableAction.pages_histogram( :site => 'foo.com' )
   def self.search(args = {})
     args[:site] ||= 'all sites'
     args[:action_kind] ||= 'views'
-    [:site, :action_kind, :time_period].each{|a| args[a] = args[a].downcase if args[a]}
-    case args[:time_period]
-      when 'past 3 months'
-        args[:start_date] = (Time.zone.now - 2.months).beginning_of_month
-        args[:end_date] = Time.zone.now
-      when 'past 6 months'
-        args[:start_date] = (Time.zone.now - 5.months).beginning_of_month
-        args[:end_date] = Time.zone.now
-      when 'past 12 months'
-        args[:start_date] = (Time.zone.now - 11.months).beginning_of_month
-        args[:end_date] = Time.zone.now
-      else
-        args[:start_date] = TrackableAction.first.created_at
-        args[:end_date] = Time.zone.now
-    end
-    if args[:time_period]
-      if args[:site] == 'all sites'
-        TrackableAction.send("#{args[:action_kind]}").for_date_range(args[:start_date], args[:end_date])
-      else
-        TrackableAction.for_site(args[:site]).send("#{args[:action_kind]}").for_date_range(args[:start_date], args[:end_date])
-      end
-    else
-      if args[:site] == 'all sites'
-        TrackableAction.send("#{args[:action_kind]}")
-      else
-        TrackableAction.for_site(args[:site]).send("#{args[:action_kind]}")
-      end
-    end
+    args[:action_kind] == 'views' unless TrackableAction::KINDS.include?(args[:action_kind])
+    [:site, :action_kind, :time_period, :visit_kind].each{|a| args[a] = args[a].downcase if args[a]}
+    (args[:start_date], args[:end_date]) = dates_from_time_period(args[:time_period])
+
+    sessions = TrackableSession.search(args).map{|s| s.id.to_s}
+    actions = TrackableAction.where(:trackable_session_id.in => sessions)
+    actions = actions.send("#{args[:action_kind]}")
+    actions
   end
-  
-  # Can't combine date conditions, so this is needed for reports
+
+  # Returns a scope based on action kind, site, and visit kind only.
+  #
+  # ==== Attributes
+  #
+  # * +:action_kind+ - kind of action: 'clicks', 'leads', 'scrolls', 'mouseovers', 'clickthroughs'
+  # * +:site+ - name of a site
+  # * +:visit_kind+ - kind of visit as a string: 'direct', 'natural', 'paid', 'search'
+  #
+  # ==== Examples
+  #
+  #    TrackableAction.search_without_date( :site => 'foo.com' )
   def self.search_without_date(args = {})
-    args[:site] ||= 'all sites'
-    args[:action_kind] ||= 'views'
-    [:site, :action_kind, :visit_kind].each{|a| args[a] = args[a].downcase}
-    if args[:site] == 'all sites'
-      TrackableAction.send("#{args[:action_kind]}")
-    else
-      TrackableAction.for_site(args[:site]).send("#{args[:action_kind]}")
-    end
+    args = args.clone
+    args.delete(:time_period)
+    self.search(args)
   end
-    
+
   # Instance Methods ===============================================================================
 
   def click?
     self.kind == 'click'
   end
-  
+
   def clickthrough?
     self.kind == 'clickthrough'
   end
-  
+
   def conversion?
     self.kind == 'conversion'
   end
-  
+
   def mouseover?
     self.kind == 'mouseover'
   end
-  
+
   def scroll?
     self.kind == 'scroll'
   end
-  
+
   def view?
     self.kind == 'view'
   end