mitamirri 0.13.8 → 2.0.8

data/Capfile

@@ -0,0 +1,4 @@
+load 'deploy' if respond_to?(:namespace) # cap2 differentiator
+Dir['vendor/plugins/*/recipes/*.rb'].each { |plugin| load(plugin) }
+
+load 'config/deploy' # remove this line to skip loading any of the default tasks

data/Gemfile

@@ -0,0 +1,29 @@
+source "http://rubygems.org"
+source 'http://jose.seologic.com:8808/'
+
+gem 'bantik-user-agent', :require => 'user-agent'
+gem 'bson_ext'
+gem 'geokit'
+gem 'mongoid'
+gem 'rails', '>= 3.0.1'
+gem 'pdfkit'
+gem 'scaffold_logic'
+gem 'seer'
+gem 'SystemTimer'
+
+group :development do
+  gem 'jeweler'
+end
+
+group :test do
+  gem 'be_valid_asset'
+  gem 'capybara'
+  gem 'cucumber-rails'
+  gem 'database_cleaner'
+  gem 'faker'
+  gem 'launchy'
+  gem 'machinist_mongo', :require => 'machinist/mongoid'
+  gem 'metric_fu'
+  gem 'mocha'
+  gem 'rspec-rails'
+end

data/README.rdoc

@@ -1,45 +1,13 @@
 = 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.
+Mitamirri is 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.
 
 == 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
@@ -48,28 +16,15 @@ It's a Rails engine designed to be a drop-in substitute for (or companion to) Go
     
     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
+* Include Mitamirri's CSS in your admin layout:
 
-* 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; }
+    <link href="/stylesheets/mitamirri.css" media="all" rel="stylesheet" type="text/css" />
+    <link href="/stylesheets/mitamirri_print.css" media="print" rel="stylesheet" type="text/css" />
 
-  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:
@@ -98,15 +53,11 @@ It's a Rails engine designed to be a drop-in substitute for (or companion to) Go
 
 == Accessing Reports
 
-To view reports and session details, point your browser to http://localhost:3000/tracking/
+To view reports and session details, point your browser to http://localhost:3000/admin/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.
+* To run specs, use rspec spec/
 
 * If you add features, run rake version:bump:minor to adjust the version number accordingly.
 

data/Rakefile

@@ -1,26 +1,39 @@
-# 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 'rubygems'
+require 'bundler'
+require 'metric_fu'
 require 'rake'
-require 'rake/testtask'
-require 'rake/rdoctask'
+require 'jeweler'
+require File.expand_path('../config/application', __FILE__)
+
+Mitamirri::Application.load_tasks
 
 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"
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
 end
 
+Jeweler::Tasks.new do |gem|
+  gem.name = "mitamirri"
+  gem.homepage = "http://github.com/ivanoblomov/mitamirri"
+  gem.summary = %Q{Analytics for Rails 3 applications.}
+  gem.description = %Q{Mitamirri is a Rails engine designed to be a drop-in substitute for (or companion to) Google Analytics that enables standard analytics tracking in addition to tracking of custom client-side events.}
+  gem.email = "rod@seologic.com"
+  gem.authors = ["Bantik"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "mitamirri #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -1 +1 @@
-0.13.8
+2.0.8

data/app/controllers/admin/tracking/reports_controller.rb

@@ -0,0 +1,78 @@
+class Admin::Tracking::ReportsController < ApplicationController
+
+  Mime::Type.register "application/vnd.ms-excel", :xls
+
+  before_filter :configure_options
+
+  # RESTful
+  
+  def index
+  end
+  
+  # Custom
+
+  def content
+    @report = ContentReport.new(params)
+    if @report.ready?
+      @pages_series = @report.pages_series(params)
+      @entrance_pages_series = @report.entrance_pages_series(params)
+      @exit_pages_series = @report.exit_pages_series(params)
+    end
+  end
+  
+  def explorer
+    params[:visit_kind] = nil if params[:visit_kind] == 'total'
+    @report = TrafficExplorerReport.new(params)
+    if @report.ready?
+      @visits = @report.visits(params)
+      @visits_series = @visits.map{|v| v.stats}
+    end
+  end
+  
+  def export
+  end
+  
+  def intersite
+    @report = IntersiteTrafficReport.new(params)
+    if @report.ready?
+      @total_visits = @report.total_visits(params)
+      @total_visits_series = @total_visits.map{|v| v.stats}
+      @destinations_series = @report.destinations(params)
+    end
+  end
+  
+  def leads
+    @report = LeadsReport.new(params)
+    if @report.ready?
+      @leads = @report.leads(params)
+      @leads_series = @leads.map{|l| l.stats}
+    end
+  end
+  
+  def summary
+    @report = TrafficSummaryReport.new(params)
+    if @report.ready?
+      @keywords_series = @report.keywords_by_frequency(params)
+      @referrers_series = @report.top_referrers(params)
+      @visits = @report.visits(params)
+      @visits_series = @visits.map{|v| v.stats}
+    end
+  end
+  
+  def visitor_profile
+    @report = VisitorProfileReport.new(params)
+    if @report.ready?
+      @user_agents_series = @report.user_agents_by_frequency(params)
+      @locations_series = @report.locations_by_frequency(params)
+    end
+  end
+  
+  private
+  
+  def configure_options
+    @sites = (TrackableStat.sites + ["All Sites"]).sort
+    @time_periods = ["Past 3 Months", "Past 6 Months", "Past 12 Months"]
+    params[:time_period] ||= @time_periods.first
+  end
+  
+end

data/app/controllers/admin/tracking/trackable_sessions_controller.rb

@@ -0,0 +1,7 @@
+class Admin::Tracking::TrackableSessionsController < ApplicationController
+
+  def show
+    @trackable_session = TrackableSession.find(params[:id])
+  end
+    
+end

data/app/controllers/application_controller.rb

@@ -1,10 +1,3 @@
-# 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
+  protect_from_forgery
 end

data/app/controllers/trackable_actions_controller.rb

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

data/app/helpers/application_helper.rb

@@ -1,2 +1,23 @@
 module ApplicationHelper
+
+  def breadcrumbs
+    html = %{<ol class="breadcrumbs">}
+
+    # Top-level
+    html << content_tag(:li, link_to('Home', root_path)) if defined?(root_path)
+    html << content_tag(:li, link_to('Tracking', admin_tracking_root_path))
+    html << content_tag(:li, link_to("Traffic Summary", admin_tracking_summary_path)) if controller?('tracking') && action?('summary')
+    html << content_tag(:li, link_to("Intersite Traffic", admin_tracking_foo_path)) if controller?('tracking') && action?('foo')
+    html << content_tag(:li, link_to("Traffic Explorer", admin_tracking_explorer_path)) if controller?('tracking') && action?('explorer')
+    html << content_tag(:li, link_to("Top Content", admin_tracking_content_path)) if controller?('tracking') && action?('content')
+    html << content_tag(:li, link_to("Leads", admin_tracking_leads_path)) if controller?('tracking') && action?('leads')
+    html << content_tag(:li, link_to("Visitor Profile", admin_tracking_visitor_profile_path)) if controller?('tracking') && action?('visitor_profile')
+
+    # Tidy up
+    html << %{</ol>}
+
+    # Output that puppy.
+    html.html_safe
+
+  end
 end

data/app/helpers/layout_helper.rb

@@ -0,0 +1,18 @@
+module LayoutHelper
+  include ScaffoldLogic::FormHelper
+  include ScaffoldLogic::Helper
+  include ScaffoldLogic::TabInterfaceHelper
+  include ScaffoldLogic::MenuHelper
+  
+  def set_title(title = nil, window_title = nil)
+    app_name ||= 'SEO Logic'
+    window_title ||= title
+    if title.nil?
+      content_for(:title) { app_name }
+      content_for(:page_title) {  }
+    else
+      content_for(:title) { window_title + " - #{app_name}" }
+      content_for(:page_title) { title }
+    end
+  end
+end

data/app/models/content_report.rb

@@ -0,0 +1,35 @@
+class ContentReport < Report
+
+  # Initialization =================================================================================
+  
+  def ready?
+    self.site && self.time_period && self.visit_kind
+  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
+
+  def wants_traffic_kind?
+    true
+  end
+  
+  # Graph data =====================================================================================
+
+  def pages_series(args)
+    TrackableAction.pages_histogram(args).map{|datum| ContentStat.new(:url => datum[0], :views => datum[1].to_i)}
+  end
+  
+  def entrance_pages_series(args)
+    TrackableSession.entrance_pages_histogram(args).map{|datum| ContentStat.new(:url => datum[0], :views => datum[1].to_i)}
+  end
+  
+  def exit_pages_series(args)
+    TrackableSession.exit_pages_histogram(args).map{|datum| ContentStat.new(:url => datum[0], :views => datum[1].to_i)}
+  end
+
+end

data/app/models/content_stat.rb

@@ -0,0 +1,4 @@
+class ContentStat < StatBase
+  attr_accessor :url
+  attr_accessor :views
+end

data/app/models/destination.rb

@@ -0,0 +1,4 @@
+class Destination < StatBase
+  attr_accessor :site
+  attr_accessor :clickthroughs
+end

data/app/models/intersite_traffic_report.rb

@@ -0,0 +1,47 @@
+class IntersiteTrafficReport < Report
+
+  # Initialization =================================================================================
+  
+  def ready?
+    self.site && self.time_period && self.visit_kind
+  end
+
+  def destination_histogram(args)
+    @destination_histogram ||= TrackableSession.clickthroughs_histogram(args)
+  end
+  
+  def destination_sites(args)
+    self.destination_histogram(args).keys
+  end
+    
+  # Graph data =====================================================================================
+
+  def total_visits(args)
+    [Visit.new(:stats => visit_stats(args))]
+  end
+
+  def total_visit_stats(args)
+    _visit_stats = []
+    dates_by_week.each do |date| 
+      _visit_stats << VisitStat.new(:date => date, :clickthroughs => TrackableSession.search_without_date(args).for_week(date).with_clickthroughs.count)
+    end
+    _visit_stats
+  end
+  
+  def destinations(args)
+    _destinations = []
+    self.destination_sites(args).each do |site|
+      _destinations << Destination.new(:site => site, :clickthroughs => self.sessions.with_clickthroughs.count)
+    end
+    _destinations
+  end
+  
+  def visit_stats(args)
+    _visit_stats = []
+    dates_by_week.each do |date| 
+      _visit_stats << VisitStat.new(:date => date, :clickthroughs => TrackableSession.search_without_date(args).for_week(date).with_clickthroughs.count)
+    end
+    _visit_stats
+  end
+
+end