mitamirri 0.13.8

data/lib/mitamirri/leads_report.rb

@@ -0,0 +1,90 @@
+module Mitamirri
+
+  class LeadsReport
+
+    # Search params
+    attr_accessor :site
+    attr_accessor :time_period
+    attr_accessor :start_date
+    attr_accessor :end_date
+    
+    # Stat attributes
+    
+    # Initialization
+    
+    def initialize(args = {})
+      args.each{|k,v| self.send("#{k}=",v) if self.respond_to?(k)} 
+      self.time_period = args[:time_period] || 'past 6 months'
+      self.start_date = self.dates.first
+      self.end_date = self.dates.last
+    end
+    
+    # Generate an array of dates spanning the appropriate time period.
+    def dates
+      return @dates if @dates
+      @dates = []
+      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 'all time'
+          _increment = 104
+      end
+      
+      (1.._increment).each{ |i| @dates << (Time.zone.now - i.weeks).beginning_of_week }
+      @dates.reverse!
+      @dates << Time.zone.now
+      @dates
+    end
+    
+    # Graphing objects
+  
+    def leads(args)
+      _leads = []
+      _leads << Lead.new(:stats => lead_stats(args))
+      _leads
+    end
+    
+    def lead_stats(args)
+      _lead_stats = []
+      dates.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
+    
+    # Inner stat classes
+  
+    class Lead
+      attr_accessor :stats
+      def initialize(args)
+        args.each{ |k,v| self.send("#{k}=", v) }
+      end
+    end
+    
+    class LeadStat
+      attr_accessor :date
+      attr_accessor :leads
+      attr_accessor :conversion_rate
+      
+      def initialize(args)
+        args.each{ |k,v| self.send("#{k}=", v) }
+      end
+      
+      def short_date
+        self.date.to_s(:concise)
+      end
+      
+    end
+    
+  end
+
+end

data/lib/mitamirri/session_report.rb

@@ -0,0 +1,219 @@
+module Mitamirri
+
+  class SessionReport
+
+    # Search params
+    attr_accessor :action_kind
+    attr_accessor :site
+    attr_accessor :time_period
+    attr_accessor :visit_kind
+    
+    # Initialization
+    
+    def initialize(args = {})
+      args.each{|k,v| self.send("#{k}=",v) if self.respond_to?(k)} 
+      self.time_period = args[:time_period] || 'past 6 months'
+      self.sessions
+    end
+    
+    def criteria
+      _criteria = self.sessions.to_hash
+      _criteria.delete(:sort)
+      _criteria
+    end
+    
+    def sessions
+      @sessions ||= TrackableSession.search(
+        :action_kind => self.action_kind,
+        :site => self.site,
+        :time_period => self.time_period,
+        :visit_kind => self.visit_kind
+      )
+    end
+
+    # Generate an array of dates spanning the appropriate time period.
+    def dates
+      return @dates if @dates
+      @dates = []
+      case self.time_period
+        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
+    
+    # Graphing data
+    def self.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 self.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 => "#{args[:visit_kind].titleize} Visits", :stats => visit_stats(args))
+      _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
+    
+    # Statistics
+    
+    def average_pages_per_visit
+      sprintf("%.1f", total_pageviews / total_visits.to_f)
+    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)
+    end
+    
+    def bounce_rate
+      bounce_rate = total_bounces / total_visits.to_f
+      sprintf("%.1f%", bounce_rate * 100)
+    end
+    
+    def conversion_rate
+      conversion_rate = total_conversions / total_visits.to_f
+      sprintf("%.1f%", conversion_rate * 100)
+    end
+
+    def total_bounces
+      @total_bounces ||= self.sessions.bounces.count
+    end
+
+    def total_clickthroughs
+      @total_clickthroughs ||= self.sessions.with_clickthroughs.count
+    end
+    
+    def total_clickthroughs_percentage
+      sprintf("%.1f%", (total_clickthroughs / total_visits.to_f) * 100)
+    end
+
+    def total_conversions
+      @total_conversions ||= self.sessions.with_conversions.count
+    end
+    
+    def total_direct_visits
+      @total_direct_visits ||= self.sessions.direct_visits.count
+    end
+    
+    def total_duration
+      @total_duration ||= TrackableSession.collection.group(["site"], self.criteria, {:duration => 0}, "function(doc,prev) { prev.duration += doc.duration}", true).map{|x| x['duration']}.sum.to_i
+    end
+
+    def total_new_visits
+      @total_new_visits ||= self.sessions.new_visits.count
+    end
+    
+    def total_return_visits
+      @total_return_visits ||= total_visits - total_new_visits
+    end
+
+    def total_organic_visits
+      @total_organic_visits ||= self.sessions.organic_visits.count
+    end
+    
+    def total_pageviews
+      @total_pageviews ||= TrackableSession.collection.group(["site"], self.criteria, {:views_count => 0}, "function(doc,prev) { prev.views_count += doc.views_count}", true).map{|x| x['views_count']}.sum.to_i
+    end
+
+    def total_ppc_visits
+      @total_ppc_visits ||= self.sessions.ppc_visits.count
+    end
+    
+    def total_search_visits
+      @total_search_visits ||= self.sessions.search_visits.count
+    end
+    
+    def total_direct_visits_percentage
+      sprintf("%.1f%", (total_direct_visits / total_visits.to_f) * 100)
+    end
+      
+    def total_organic_visits_percentage
+      sprintf("%.1f%", (total_organic_visits / total_visits.to_f) * 100)
+    end
+      
+    def total_new_visits_percentage
+      sprintf("%.1f%", (total_new_visits / total_visits.to_f) * 100)
+    end
+      
+    def total_ppc_visits_percentage
+      sprintf("%.1f%", (total_ppc_visits / total_visits.to_f) * 100)
+    end
+    
+    def total_return_visits_percentage
+      sprintf("%.1f%", (total_return_visits / total_visits.to_f) * 100)
+    end
+    
+    def total_search_visits_percentage
+      sprintf("%.1f%", (total_search_visits / total_visits.to_f) * 100)
+    end
+    
+    def total_visits
+      @total_visits ||= self.sessions.count
+    end
+    
+    # Inner stat classes
+    class KeywordStat
+      attr_accessor :keyword
+      attr_accessor :count
+      def initialize(args)
+        args.each{ |k,v| self.send("#{k}=", v) }
+      end
+    end
+    
+    class ReferrerStat
+      attr_accessor :referrer
+      attr_accessor :count
+      def initialize(args)
+        args.each{ |k,v| self.send("#{k}=", v) }
+      end
+    end
+
+    class Visit
+      attr_accessor :kind
+      attr_accessor :date
+      attr_accessor :stats
+      def initialize(args)
+        args.each{ |k,v| self.send("#{k}=", v) }
+      end
+    end
+    
+    class VisitStat
+      attr_accessor :date
+      attr_accessor :visits
+      
+      def initialize(args)
+        args.each{ |k,v| self.send("#{k}=", v) }
+      end
+      
+      def short_date
+        self.date.to_s(:month_year)
+      end
+      
+    end
+
+  end
+  
+end

data/lib/mitamirri/stat_report.rb

@@ -0,0 +1,216 @@
+module Mitamirri
+
+  class StatReport
+
+    # Search params
+    attr_accessor :action_kind
+    attr_accessor :site
+    attr_accessor :time_period
+    attr_accessor :visit_kind
+    
+    # Initialization
+    
+    def initialize(args = {})
+      args.each{|k,v| self.send("#{k}=",v) if self.respond_to?(k)} 
+      self.time_period = args[:time_period] || 'past 6 months'
+      self.stats
+    end
+    
+    def stats
+      if self.site && self.site.downcase != 'all sites'
+        @stats ||= TrackableStat.by_site(self.site).for_date_range(dates.first, dates.last.end_of_month)
+      else
+        @stats ||= TrackableStat.for_date_range(dates.first, dates.last.end_of_month)
+      end
+    end
+
+    # Generate an array of dates spanning the appropriate time period.
+    def dates
+      return @dates if @dates
+      @dates = []
+      case self.time_period
+        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
+    
+    # Graphing data
+    def self.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 self.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
+    
+    # Statistics
+    
+    def average_pages_per_visit
+      sprintf("%.1f", total_pageviews / total_visits.to_f)
+    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)
+    end
+    
+    def bounce_rate
+      bounce_rate = total_bounces / total_visits.to_f
+      sprintf("%.1f%", bounce_rate * 100)
+    end
+    
+    def conversion_rate
+      conversion_rate = total_conversions / total_visits.to_f
+      sprintf("%.1f%", conversion_rate * 100)
+    end
+    
+    def total_bounces
+      @total_bounces ||= stats.fields(:bounces).map{|s| s.bounces}.sum
+    end
+    
+    def total_clickthroughs
+      @total_clickthroughs ||= stats.fields(:clickthroughs).map{|s| s.clickthroughs}.sum
+    end
+    
+    def total_clickthroughs_percentage
+      sprintf("%.1f%", (total_clickthroughs / total_visits.to_f) * 100)
+    end
+
+    def total_conversions
+      @total_conversions ||= stats.fields(:conversions).map{|s| s.conversions}.sum
+    end
+    
+    def total_direct_visits
+      @total_direct_visits ||= stats.fields(:direct_visits).map{|s| s.direct_visits}.sum
+    end
+  
+    def total_direct_visits_percentage
+      sprintf("%.1f%", (total_direct_visits / total_visits.to_f) * 100)
+    end
+    
+    def total_duration
+      @total_duration ||= stats.fields(:duration).map{|s| s.duration}.sum
+    end
+    
+    def total_new_visits
+      @total_new_visits ||= stats.fields(:new_visits).map{|s| s.new_visits}.sum
+    end
+    
+    def total_new_visits_percentage
+      sprintf("%.1f%", (total_new_visits / total_visits.to_f) * 100)
+    end
+      
+    def total_organic_visits
+      @total_organic_visits ||= stats.fields(:organic_visits).map{|s| s.organic_visits}.sum
+    end
+    
+    def total_organic_visits_percentage
+      sprintf("%.1f%", (total_organic_visits / total_visits.to_f) * 100)
+    end
+      
+    def total_pageviews
+      @total_pageviews ||= stats.fields(:pageviews).map{|s| s.pageviews}.sum
+    end
+    
+    def total_ppc_visits
+      @total_ppc_visits ||= stats.fields(:ppc_visits).map{|s| s.ppc_visits}.sum
+    end
+  
+    def total_ppc_visits_percentage
+      sprintf("%.1f%", (total_ppc_visits / total_visits.to_f) * 100)
+    end
+    
+    def total_return_visits
+      @total_return_visits ||= stats.fields(:return_visits).map{|s| s.return_visits}.sum
+    end
+  
+    def total_return_visits_percentage
+      sprintf("%.1f%", (total_return_visits / total_visits.to_f) * 100)
+    end
+    
+    def total_search_visits
+      @total_search_visits ||= stats.fields(:search_visits).map{|s| s.search_visits}.sum
+    end
+  
+    def total_search_visits_percentage
+      sprintf("%.1f%", (total_search_visits / total_visits.to_f) * 100)
+    end
+  
+    def total_visits
+      @total_visits ||= stats.fields(:visits).map{|s| s.visits}.sum
+    end
+    
+    # Inner stat classes
+    class KeywordStat
+      attr_accessor :keyword
+      attr_accessor :count
+      def initialize(args)
+        args.each{ |k,v| self.send("#{k}=", v) }
+      end
+    end
+    
+    class ReferrerStat
+      attr_accessor :referrer
+      attr_accessor :count
+      def initialize(args)
+        args.each{ |k,v| self.send("#{k}=", v) }
+      end
+    end
+
+    class Visit
+      attr_accessor :kind
+      attr_accessor :date
+      attr_accessor :stats
+      def initialize(args)
+        args.each{ |k,v| self.send("#{k}=", v) }
+      end
+    end
+    
+    class VisitStat
+      attr_accessor :date
+      attr_accessor :visits
+      
+      def initialize(args)
+        args.each{ |k,v| self.send("#{k}=", v) }
+      end
+      
+      def short_date
+        self.date.to_s(:month_year)
+      end
+      
+    end
+    
+  end
+  
+end

data/lib/mitamirri/tasks.rb

@@ -0,0 +1,27 @@
+# require 'mitamirri/tasks' to add tasks to the host application.
+
+namespace :mitamirri do
+
+  desc "Sync migrations and other files from Mitamirri."
+  task :install do
+    dir = Gem.searcher.find('mitamirri').full_gem_path 
+    system "rsync -ruv #{dir}/public/stylesheets public/"
+    system "rsync -ruv #{dir}/config/initializers/database.rb config/initializers/"
+    puts
+    puts "Mitamarri file sync complete."
+    puts "Run rake mitamirri:override to install local views and controllers to override default behaviour."
+    puts
+  end
+  
+  desc "Copy default view and controller files from Mitamirri to the host application."
+  task :override do
+    dir = Gem.searcher.find('mitamirri').full_gem_path 
+    system "rsync -ruv #{dir}/app/controllers/trackable_actions_controller.rb app/controllers/"
+    system "rsync -ruv #{dir}/app/controllers/trackable_sessions_controller.rb app/controllers/"
+    system "rsync -ruv #{dir}/app/views/trackable_sessions app/views/"
+    puts
+    puts "Mitamarri views and controllers copied and ready to override."
+    puts
+  end
+
+end

data/lib/mitamirri/visitor_profile_report.rb

@@ -0,0 +1,127 @@
+module Mitamirri
+
+  class VisitorProfileReport
+
+    # Search params
+    attr_accessor :action_kind
+    attr_accessor :site
+    attr_accessor :time_period
+    attr_accessor :visit_kind
+    
+    # Initialization
+    
+    def initialize(args = {})
+      args.each{|k,v| self.send("#{k}=",v) if self.respond_to?(k)} 
+      self.time_period = args[:time_period] || 'past 6 months'
+      self.sessions
+    end
+    
+    def criteria
+      _criteria = self.sessions.to_hash
+      _criteria.delete(:sort)
+      _criteria
+    end
+    
+    def sessions
+      @sessions ||= TrackableSession.search(
+        :action_kind => self.action_kind,
+        :site => self.site,
+        :time_period => self.time_period,
+        :visit_kind => self.visit_kind
+      )
+    end
+
+    # Generate an array of dates spanning the appropriate time period.
+    def dates
+      return @dates if @dates
+      @dates = []
+      case self.time_period
+        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
+    
+    # Graphing data
+
+    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
+    
+    # Inner stat classes
+
+    class Visitor
+      attr_accessor :user_agent_stats
+      attr_accessor :location_stats
+      def initialize(args)
+        args.each{ |k,v| self.send("#{k}=", v) }
+      end
+    end
+    
+    class UserAgentStat
+      attr_accessor :user_agent
+      attr_accessor :count
+      def initialize(args)
+        args.each{ |k,v| self.send("#{k}=", v) }
+      end
+    end
+
+    class LocationStat
+
+      attr_accessor :name
+      attr_accessor :latitude
+      attr_accessor :longitude
+      attr_accessor :count
+      
+      def initialize(args)
+        args.each{ |k,v| self.send("#{k}=", v) }
+        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
+
+
+  end
+  
+end

data/lib/mitamirri.rb

@@ -0,0 +1,15 @@
+module Mitamirri
+  require 'mitamirri'
+  require 'mitamirri/session_report'
+  
+  # Detects the ability of the host application to output reports to PDF format.
+  def self.pdf_output_enabled?
+    @pdf_output_enabled ||= false
+    begin
+      @pdf_output_enabled = Rails.configuration.middleware.include?('PDFKit::Middleware')
+    rescue
+    end
+    @pdf_output_enabled
+  end
+  
+end