mitamirri 0.13.8

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,26 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+log/*
+doc/*
+mitamirri.sqlite3.db
+spec/debug.log
+

data/README.rdoc

@@ -0,0 +1,117 @@
+= mitamirri
+
+Mitamirri is still in development and will not be production-ready until version 1.0.
+
+It's a Rails engine designed to be a drop-in substitute for (or companion to) Google Analytics that allows tracking of custom user events at a very granular level (e.g. specific link or button clicks and even mouseovers) in addition to the standard visits, etc. It uses MongoDB on the backend for optimal performance, even with hundreds of thousands of visits, and to stay out of the way of your application's database.
+
+== Installation
+
+* Make sure that you have MongoDB installed and configured for your environment.
+  
+  * See http://www.mongodb.org/display/DOCS/Quickstart
+
+  * For the development environment, this OSX-specific installation guide is useful: http://shiftcommathree.com/articles/how-to-install-mongodb-on-os-x
+  
+  * Install the mongo_mapper:
+
+    gem install mongo_mapper
+  
+  * Install mongo_mapper's dependency:
+
+    gem install bson_ext
+  
+* Make sure that you have the Jeweler gem installed:
+
+    gem install jeweler
+    
+* Install the gem. From the Mitamirri repo:
+
+    rake install
+    
+* Add the following lines to your config/environment.rb file:
+
+    config.gem 'bantik-user-agent', :lib => 'user-agent'
+    config.gem 'mitamirri'
+    config.gem 'mongo_mapper'
+    config.gem 'pdfkit'
+    config.gem 'seer'
+    
+* Add the following line to your application's Rakefile:
+
+    require 'mitamirri/tasks'
+  
+* Add this to the top of your app/helpers/application_helper.rb file:
+
+    include Mitamirri::Helper
+
+* To install the necessary files into your application, run: 
+    
+    rake mitamirri:install 
+
+* Update the database name in config/initializers/database.rb with the name of your application. Be sure to remove the timestamp from the database name!
+
+* If you want to override default behaviour (strongly recommended, to at least require authorization for accessing reports), run the following rake command to copy Mitamirri's views and controllers to your application for customization:
+  
+    rake mitamirri:override
+
+* Mitamirri will automatically detect the host application's ability to render PDF versions of reports. To enable PDF output of reports, install PDFKit on your system add the following lines to your environment.rb file:
+
+    config.gem 'pdfkit'
+    config.gem 'geokit'
+    config.gem 'user-agent'
+    config.gem 'bantik-user-agent', :lib => 'user-agent'
+    config.middleware.use "PDFKit::Middleware", :print_media_type => true
+
+* Recommended for optimal PDF output: add the following rule to your application's print style sheet:
+  
+    .page_break { display: block; text-align: center; margin-top: 2em; page-break-after: always; }
+
+  And the following to your screen style sheet:
+  
+    .page_break { display: none; }
+  
+== Configuring Tracking
+
+* To track pageviews, add this anywhere in the HTML body of your view (or layout) file:
+
+    <%= track_action 'view' -%>
+  
+* To track scroll events, add this:
+
+    <%= track_action 'scroll' -%>
+  
+* To track mouseovers, add the DOM element ID and a custom label:
+  
+    <%= track_action 'mouseover', :observe => 'my_element_id', :label => 'My Label for This Action' -%>
+
+* To track click events, add the DOM element ID and a custom label:
+
+    <%= track_action 'click', :observe => 'my_element_id', :label => 'My Submit Button Pressed' -%>
+
+* To track conversions, add the DOM element ID and an optional custom label:
+
+    <%= track_action 'conversion', :observe => 'my_element_id', :label => 'Contact Form Submitted' -%>
+
+* To track clickthroughs to other sites, add the DOM element ID and an optional custom label:
+
+    <%= track_action 'clickthrough', :observe => 'my_link_id', :label => 'Link to CorporateSite.com' -%>
+
+== Accessing Reports
+
+To view reports and session details, point your browser to http://localhost:3000/tracking/
+    
+== Development Tips
+
+* To run specs, use spec spec/
+
+* If you're just changing views, run rake:install from your local Mitamirri directory and updates will appear in your host application immediately.
+
+* If you're changing models, run rake:install and then restart your host application.
+
+* If you add features, run rake version:bump:minor to adjust the version number accordingly.
+
+* If you're just fixing bugs, run rake version:bump:patch instead.
+
+== Copyright
+
+Copyright (c) 2010 Corey Ehmke / SEO Logic. All rights reserved.

data/Rakefile

@@ -0,0 +1,26 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+#require(File.join(File.dirname(__FILE__), 'config', 'boot'))
+
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+begin
+  require 'jeweler'
+  require 'seer'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "mitamirri"
+    gemspec.summary = "View and action tracking for Rails 2.x."
+    gemspec.description = "View and action tracking for Rails 2.x."
+    gemspec.email = "corey@seologic.com"
+    gemspec.homepage = "http://github.com/Bantik/mitamarri"
+    gemspec.authors = ["Corey Ehmke"]
+    gemspec.test_files = []
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.13.8

data/app/controllers/application_controller.rb

@@ -0,0 +1,10 @@
+# Filters added to this controller apply to all controllers in the application.
+# Likewise, all the methods added will be available for all controllers.
+
+class ApplicationController < ActionController::Base
+  helper :all # include all helpers, all the time
+  protect_from_forgery # See ActionController::RequestForgeryProtection for details
+
+  # Scrub sensitive parameters from your log
+  # filter_parameter_logging :password
+end

data/app/controllers/trackable_actions_controller.rb

@@ -0,0 +1,10 @@
+class TrackableActionsController < ApplicationController
+
+  unloadable
+  
+  def create
+    TrackableAction.create_from_params(params)
+    render :text => ''
+  end
+
+end

data/app/controllers/trackable_sessions_controller.rb

@@ -0,0 +1,100 @@
+class TrackableSessionsController < ApplicationController
+
+  Mime::Type.register "application/vnd.ms-excel", :xls
+
+  def index
+    @sites = (TrackableStat.sites + ["All Sites"]).sort
+    @time_periods = ["Past 3 Months", "Past 6 Months", "Past 12 Months"]
+    params[:time_period] ||= 'past 3 months'
+    if params[:site]
+      @sessions = TrackableSession.search(params).all(:order => :created_at.desc, :limit => 25)
+      @report = Mitamirri::StatReport.new(params)
+      @visits = @report.visits(params)
+      @visits_series = @visits.map{|v| v.stats}
+      @keywords_series = Mitamirri::StatReport.keywords_by_frequency(params)
+      @referrers_series = Mitamirri::StatReport.top_referrers(params)
+    end
+  end
+
+  def content
+    @sites = (TrackableStat.sites + ["All Sites"]).sort
+    @time_periods = ["past 3 months", "past 6 months", "past 12 months"]
+    params[:time_period] ||= 'past 3 months'
+    params[:visit_kind] ||= 'All'
+    if params[:site]
+      params[:visit_kind] = 'all' if params[:visit_kind] == 'total'
+      @report = Mitamirri::ContentReport.new(params)
+      @pages_series = @report.pages_series(params)
+      @entrance_pages_series = @report.entrance_pages_series(:site => params[:site], :time_period => params[:time_period])
+      @exit_pages_series = @report.exit_pages_series(:site => params[:site], :time_period => params[:time_period])
+    end
+  end
+  
+  def explorer
+    @sites = (TrackableStat.sites + ["all sites"]).sort
+    @time_periods = ["past 3 months", "past 6 months", "past 12 months"]
+    @kinds = TrackableAction.kinds
+    params[:time_period] ||= 'past 3 months'
+    params[:visit_kind] ||= 'total'
+    params[:action_kind] ||= 'conversions'
+    if params[:site]
+      params[:visit_kind] = 'all' if params[:visit_kind] == 'total'
+      @sessions = TrackableSession.search(params).all(:order => :created_at.desc, :limit => 25)
+      @report = Mitamirri::SessionReport.new(params)
+      @visits = @report.visits(params)
+      @visits_series = @visits.map{|v| v.stats}
+      @keywords_series = Mitamirri::SessionReport.keywords_by_frequency(params)
+      @referrers_series = Mitamirri::SessionReport.top_referrers(params)
+    end
+  end
+  
+  def export
+    @sessions = TrackableSession.search(params).all
+    respond_to do |format|
+      format.xls { 
+        headers['Content-Type'] = "application/vnd.ms-excel"
+        headers['Content-Disposition'] = 'attachment; filename="sessions_export.xls"'
+        headers['Cache-Control'] = ''
+      }
+    end
+  end
+
+  def leads
+    @sites = (TrackableStat.sites + ["All Sites"]).sort
+    @time_periods = ["Past 3 Months", "Past 6 Months", "Past 12 Months"]
+    params[:time_period] ||= @time_periods.first
+    if params[:site]
+      @report = Mitamirri::LeadsReport.new(params)
+      @leads = @report.leads(params)
+      @leads_series = @leads.map{|l| l.stats}
+    end
+  end
+
+  def intersite
+    @sites = (TrackableStat.sites + ["All Sites"]).sort
+    @time_periods = ["Past 3 Months", "Past 6 Months", "Past 12 Months"]
+    params[:time_period] ||= @time_periods.first
+    if params[:site]
+      @report = Mitamirri::IntersiteTrafficReport.new(params)
+      @total_visits = @report.total_visits(params)
+      @total_visits_series = @total_visits.map{|v| v.stats}
+      @destinations_series = @report.destinations(params)
+    end
+  end
+    
+  def show
+    @trackable_session = TrackableSession.find(params[:id])
+  end
+
+  def visitor_profile
+    @sites = (TrackableStat.sites + ["All Sites"]).sort
+    @time_periods = ["Past 3 Months", "Past 6 Months", "Past 12 Months"]
+    params[:time_period] ||= @time_periods.first
+    if params[:site]
+      @report = Mitamirri::VisitorProfileReport.new(params)
+      @user_agents_series = @report.user_agents_by_frequency(params)
+      @locations_series = @report.locations_by_frequency(params)
+    end
+  end
+
+end

data/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/app/models/trackable_action.rb

@@ -0,0 +1,193 @@
+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!
+  
+  # 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'}
+  
+  # Constants ======================================================================================
+
+  KINDS = ['clicks', 'leads', 'scrolls', 'mouseovers', 'clickthroughs']
+
+  # Class Methods ==================================================================================
+
+  def self.create_from_params(params, creation_date = Time.zone.now)
+    _referring_site = nil
+    _relative_url = nil
+    begin
+      if ! params[:referrer].blank? && params[:referrer] != '/'
+        _referring_site = URI.parse(params[:referrer]).host
+        _referring_site = nil if _referring_site == params[:site]
+      end
+      _relative_url = URI.parse(params[:url]).path.downcase
+    rescue
+    end
+    
+    unless trackable_session = TrackableSession.find_by_session_id(params[:session_id])
+      trackable_session = TrackableSession.create(
+        :session_id => params[:session_id], 
+        :referrer => _referring_site,
+        :referring_keywords => params[:referring_keywords],
+        :ip_address => params[:remote_ip],
+        :site => params[:site].downcase,
+        :session_id => params[:session_id],
+        :initial_request_url => params[:url].downcase,
+        :entrance_page => _relative_url,
+        :exit_page => _relative_url,
+        :user_agent => params[:user_agent],
+        :views_count => 0,
+        :created_at => creation_date
+      )
+    end
+    _action = TrackableAction.create(
+      :kind => params[:kind],
+      :label => params[:label],
+      :referrer => params[:referrer],
+      :url => params[:url],
+      :relative_url => _relative_url,
+      :site => params[:site],
+      :trackable_session_id => trackable_session.id,
+      :created_at => creation_date
+    )
+    trackable_session.touch(params[:kind], params[:destination], _relative_url)
+    _action
+  end
+  
+  def self.create_test_data!(count = 1000, destructive = true)
+
+    if destructive
+      TrackableStat.delete_all
+      TrackableSession.delete_all
+      TrackableAction.delete_all
+    end
+    
+    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
+        params[:referrer] = i == 1 ? params[:initial_referrer] : "/"
+        params[:referring_keywords] = i == 1 ? ['foo','bar','trouble','braids'].rand : nil
+        params[:url] = "http://#{params[:site]}#{['/','/about','/tour','/contact','/services'].rand}"
+        params[:label] = params[:kind].titleize
+        TrackableAction.create_from_params(params, created_at + i.minutes)
+      end
+    end    
+    "Created #{count} sample sessions."
+  end
+
+  # Returns a list of kinds that have already been tracked.
+  def self.kinds
+    _kinds = []
+    KINDS.each{ |kind| _kinds << kind unless self.send(kind).count.zero? }
+    _kinds
+  end
+  
+  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
+  end
+
+  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
+  end
+  
+  # Can't combine date conditions, so this is needed for reports
+  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
+  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
+end

data/app/models/trackable_location.rb

@@ -0,0 +1,19 @@
+class TrackableLocation
+
+  include MongoMapper::Document
+
+  # MongoMapper Setup ==============================================================================
+  
+  key :location, String, :index => true
+  key :latitude, String
+  key :longitude, String
+  
+  # Scopes =========================================================================================
+  
+  # Constants ======================================================================================
+
+  # Class Methods ==================================================================================
+
+  # Instance Methods ===============================================================================
+    
+end