redis_analytics 0.1.0

data/lib/redis_analytics/dashboard/views/visits_js.erb

@@ -0,0 +1,265 @@
+<script type="text/javascript" language="text/javascript">
+
+visits_area = Morris.Area({
+  element: 'visits_area',
+  xkey: 'date',
+  data: <%=@data[@range][:visits_new_visits_plot].to_json%>,
+  ykeys: ['new_visits', 'returning_visits'],
+  labels: ['New Visits', 'Returning Visits'],
+  ymax: 'auto',
+  //events: ['2013-03-02', '2013-03-03'],
+    grid: true,
+  eventStrokeWidth: 2,
+  eventLineColors: ['#ccc', '#eee'],
+  smooth: true,
+  hideHover: 'auto',
+  parseTime: false,
+  lineWidth: 1,
+  pointSize: 0,
+   //  xLabels: 'day',
+    xLabelFormat: function(x) {return '';},
+
+  // hoverCallback: function(index, series)
+  //   {
+  // 	h = series.data[index];
+  // 	d = Date(h.x);
+  // 	return(d + '<br>' + h.new_visits);
+  //   },
+  pointFillColors: ['#fff'],
+  pointStrokeColors: ['#000'],
+});
+
+visits_donut = Morris.Donut({
+  element: 'visits_donut',
+  data: <%=@data[@range][:visits_new_visits_donut].to_json%>
+});
+
+referrers_donut = Morris.Donut({
+  element: 'referrers_donut',
+  data: <%=@data[@range][:referrers_donut].to_json%>
+});
+
+browsers_donut = Morris.Donut({
+  element: 'browsers_donut',
+  data: <%=@data[@range][:browsers_donut].to_json%>
+});
+
+unique_visits_line = Morris.Line({
+  element: 'unique_visits_line',
+  xkey: 'unit',
+  data: <%=@data[@range][:unique_visits].to_json%>,
+  ykeys: ['unique_visits_this', 'unique_visits_last'],
+    labels: ['Current', 'Previous'],
+  ymax: 'auto',
+  hideHover: 'auto',
+  parseTime: false,
+  lineWidth: 1,
+  pointSize: 0,
+  grid: true,
+  pointFillColors: ['#fff'],
+  pointStrokeColors: ['#000'],
+  // hoverCallback: function(index, series)
+  //   {
+  // 	h = series.data[index];
+  // 	this_week_color = series.lineColors[0];
+  // 	last_week_color = series.lineColors[1];
+  // 	html = '';
+  // 	html += '<font style="color:' + this_week_color + '">This ' + h.unit + ': ' + h.unique_visits_this + '</font>';
+  // 	html += '<br/>';
+  // 	html += '<font style="color:' + last_week_color + '">Last ' + h.unit + ': ' + h.unique_visits_last + '</font>';
+  // 	return html;
+  //  },
+
+});
+
+// visits_spark = Morris.Line({
+//   element: 'visits_spark',
+//   xkey: 'date',
+//   data: <%=@data[@range][:visits_page_views_plot].to_json%>,
+//   ykeys: ['visits', 'page_views'],
+//   labels: ['Visits', 'Page Views'],
+//   xLabelFormat: function(x){return '';},
+//   yLabelFormat: function(x){return '';},
+//   hoverCallback: function(i,x){return x.data[i].date + '<br/>' + 'Page Views: ' + x.data[i].page_views + '<br/>Visits: ' + x.data[i].visits;},
+//   ymax: 'auto',
+//   ymin: 0,
+//   smooth: true,
+//   hideHover: 'auto',
+//   parseTime: false,
+//   lineWidth: 2,
+//   pointSize: 0,
+//   grid: false,
+//   pointFillColors: ['#fff'],
+//   pointStrokeColors: ['#000']
+// });
+
+function setSessionCookie(name,value) {
+    document.cookie = name+"="+value+"; path=/";
+}
+
+function changeTimeFrame(range)
+{
+var mapObject = $('#world-map').vectorMap('get', 'mapObject');
+switch(range)
+{
+<% Rack::RedisAnalytics.time_range_formats.map{|x| x[0].to_s}.each do |range| %>
+case '<%=range%>':
+    setSessionCookie("_rarng", "<%=range%>");
+    visits_area.setData(<%=@data[range.to_sym][:visits_new_visits_plot].to_json%>);
+    unique_visits_line.setData(<%=@data[range.to_sym][:unique_visits].to_json%>);
+
+    $("#total_visits")[0].innerHTML = '<%=@data[range.to_sym][:total_visits]%> <small class="muted">visits</small>';
+    $("#total_page_views")[0].innerHTML = '<%=@data[range.to_sym][:total_page_views]%> <small class="muted">page views</small>';
+    $("#page_depth")[0].innerHTML = '<%=parse_float((@data[range.to_sym][:total_page_views].to_f/@data[range.to_sym][:total_visits].to_f).round(2))%> <small class="muted">pages per visit</small>';
+    $("#bounce_rate")[0].innerHTML = '<%=parse_float((((@data[range.to_sym][:total_visits].to_f-@data[range.to_sym][:total_second_page_views].to_f)/@data[range.to_sym][:total_visits].to_f)*100).round(2))%>% <small class="muted">bounce rate</small>';
+    $("#visit_duration")[0].innerHTML = '<%=Time.at(@data[range.to_sym][:avg_visit_time].round(2)).gmtime.strftime("%R:%S")%> <small class="muted">avg time spent</small>';
+    $("#new_visits")[0].innerHTML = '<%=parse_float(((@data[range.to_sym][:total_new_visits].to_f/@data[range.to_sym][:total_visits].to_f)*100).round(2))%>% <small class="muted">new visits</small></h4>';
+
+    visits_donut = Morris.Donut({element: 'visits_donut', data: <%=@data[range.to_sym][:visits_new_visits_donut].to_json%>});
+    browsers_donut = Morris.Donut({element: 'browsers_donut', data: <%=@data[range.to_sym][:browsers_donut].to_json%>});
+    referrers_donut = Morris.Donut({element: 'referrers_donut', data: <%=@data[range.to_sym][:referrers_donut].to_json%>});
+    mapObject.series.regions[0].setValues(<%=@data[range.to_sym][:country_map].to_json%>);
+
+    $("#compare_unit")[0].innerHTML = '<%=range%>'; 
+
+    <% @data[range.to_sym][:visitor_recency_slices].each_with_index do |((k, v), i), c| %>
+    <% p = ((i.to_f/@data[range.to_sym][:visitor_recency_slices].map{|x| x[1]}.sum) * 100).round rescue '0' %>
+    <%= "$('#recency_#{c}')[0].style.width = '#{p}%';" %>
+    <%= "$('#recency_#{c}_num')[0].title = '#{i.to_i} visits';" %>
+    <%= "$('#recency_#{c}_cent')[0].innerHTML = '#{p}';" %>
+    <% end %>
+
+    break;
+<% end %>
+}
+}
+
+// Map Overlay
+
+var geoLocationData = <%=@data[@range][:country_map].to_json%>;
+
+$(function(){
+  $('#world-map').vectorMap({
+    map: 'world_mill_en',
+    min: 0,
+    backgroundColor: '#fff',
+regionStyle: {
+  initial: {
+    fill: '#ddd',
+    "fill-opacity": 1,
+    stroke: 'none',
+    "stroke-width": 0,
+    "stroke-opacity": 1
+  },
+  hover: {
+    fill: '#bbb',
+    "fill-opacity": 0.8
+  },
+  selected: {
+    fill: 'yellow'
+  },
+  selectedHover: {
+  }
+},
+    series: {
+      regions: [{
+        scale: ['#C8EEFF', '#0071A4'],
+        values: geoLocationData,
+        normalizeFunction: 'polynomial'
+      }]
+    },
+    onLabelShow: function(e, el, code){
+      el.html(el.html()+' (GDP - '+geoLocationData[code]+')');
+    }
+  });
+});
+
+function onDownload() {
+    document.location = 'data:Application/octet-stream,' +
+                         encodeURIComponent(convertToCSV(<%=@data[@range][:visits_new_visits_plot].to_json%>));
+}
+
+function convertToCSV(objArray) {
+            var array = typeof objArray != 'object' ? JSON.parse(objArray) : objArray;
+            var str = '';
+
+            for (var i = 0; i < array.length; i++) {
+                var line = '';
+                for (var index in array[i]) {
+                    if (line != '') line += ','
+
+                    line += array[i][index];
+                }
+
+                str += line + '\r\n';
+            }
+
+            return str;
+        };
+
+$('#visits_modal').on('show', function () {
+    
+    colors = Highcharts.getOptions().colors;
+    
+    // create the chart when all data is loaded
+    $(function(){
+	
+	$('#visits_detail').highcharts('StockChart', {
+	    chart: {
+	    },
+	    
+	    // tooltip: {
+	    // 	pointFormat: '<span style="color:{series.color}">{series.name}</span>: <b>{point.y}</b> ({point.change}%)<br/>',
+	    // 	valueDecimals: 2
+	    // },
+	    yAxis: {
+		allowDecimals: false
+	    },
+	    xAxis: {
+		allowDecimals: false
+	    },
+	    
+	    series: [{
+		name: 'Visits',
+		data: <%=@data[:all_visits].to_json%>
+	    }]
+	});
+    });
+});
+
+
+$('#unique_visits_modal').on('show', function () {
+    
+    colors = Highcharts.getOptions().colors;
+    
+    // create the chart when all data is loaded
+    $(function(){
+	
+	$('#unique_visits_detail').highcharts('StockChart', {
+	    chart: {
+	    },
+	    
+	    // tooltip: {
+	    // 	pointFormat: '<span style="color:{series.color}">{series.name}</span>: <b>{point.y}</b> ({point.change}%)<br/>',
+	    // 	valueDecimals: 2
+	    // },
+	    yAxis: {
+		allowDecimals: false
+	    },
+	    xAxis: {
+		allowDecimals: false
+	    },
+	    
+	    series: [{
+		name: 'Unique Visits',
+		data: <%=@data[:all_unique_visits].to_json%>
+	    }]
+	});
+    });
+});
+
+</script>
+
+<style>
+.modal {width:940px;left:36%;}
+</style>

data/lib/redis_analytics/helpers.rb

@@ -0,0 +1,69 @@
+require 'active_support/core_ext'
+
+module Rack
+  module RedisAnalytics
+    module Helpers
+
+      FORMAT_SPECIFIER = [['%Y', 365], ['%m', 30], ['%d', 24], ['%H', 60], ['%M', 60]]
+      GRANULARITY = ['yearly', 'monthly', 'dayly', 'hourly', 'minutely']
+
+      # all methods are private unless explicitly declared public
+      private
+
+      def method_missing(meth, *args, &block)
+        if meth.to_s =~ /^(minute|hour|dai|day|month|year)ly_(new_visits|visits|page_views|second_page_views|unique_visits|visit_time|ratio_recency|ratio_browsers|ratio_platforms|ratio_devices|ratio_country|ratio_referrers)$/
+          granularity = ($1 == 'dai' ? 'day' : $1) + 'ly'
+          type = $2
+          data(granularity, type, *args)
+        else
+          super
+        end
+      end
+
+      def data(granularity, type, from_date, options = {})
+        aggregate = options[:aggregate] || false
+        x = granularity[0..-3]
+        # puts "DATA: #{x} (#{type})"
+        to_date = (options[:to_date] || Time.now).send("end_of_#{x}")
+        i = from_date.send("beginning_of_#{x}") #unless x == 'minute'
+
+        # puts "FROM: #{i} to #{to_date}"
+        union = []
+        time = []
+        begin
+          union << "#{Rack::RedisAnalytics.redis_namespace}:#{type}:#{i.strftime(FORMAT_SPECIFIER[0..GRANULARITY.index(granularity)].map{|x| x[0]}.join('_'))}"
+          time << i
+          i += 1.send(x) # FORMAT_SPECIFIER[GRANULARITY.index(granularity)..-1].map{|x| x[1]}.inject{|p,x| p*=x; p}
+        end while i <= to_date
+        # puts "UNION #{union.inspect}"
+        seq = get_next_seq
+        if type =~ /unique/
+          if aggregate
+            union_key = "#{Rack::RedisAnalytics.redis_namespace}:#{seq}"
+            Rack::RedisAnalytics.redis_connection.sunionstore(union_key, union)
+            Rack::RedisAnalytics.redis_connection.expire(union_key, 100)
+            return Rack::RedisAnalytics.redis_connection.scard(union_key)
+          else
+            return time.zip(union.map{|x| Rack::RedisAnalytics.redis_connection.scard(x)})
+          end
+        elsif type =~ /ratio/
+          if aggregate
+            union_key = "#{Rack::RedisAnalytics.redis_namespace}:#{seq}"
+            Rack::RedisAnalytics.redis_connection.zunionstore(union_key, union)
+            Rack::RedisAnalytics.redis_connection.expire(union_key, 100)
+            return Rack::RedisAnalytics.redis_connection.zrange(union_key, 0, -1, :with_scores => true)
+          else
+            return time.zip(union.map{|x| Rack::RedisAnalytics.redis_connection.zrange(x,0,-1, :with_scores => true)})
+          end
+        else
+          time.zip(Rack::RedisAnalytics.redis_connection.mget(*union).map(&:to_i))
+        end
+      end
+      
+      def get_next_seq
+        seq = Rack::RedisAnalytics.redis_connection.incr("#{Rack::RedisAnalytics.redis_namespace}:#SEQUENCER")
+      end
+
+    end
+  end
+end

data/lib/redis_analytics/railtie.rb

@@ -0,0 +1,13 @@
+module Rack
+  module RedisAnalytics
+    class Railtie < Rails::Railtie
+      initializer "redis_analytics.middleware" do |app|
+        app.config.middleware.use "Rack::RedisAnalytics::Tracker"
+      end
+      
+      initializer "redis_analytics.view_helpers" do
+        ActionController::Base.send :include, Rack::RedisAnalytics::Helpers
+      end
+    end
+  end
+end

data/lib/redis_analytics/time_ext.rb

@@ -0,0 +1,19 @@
+module TimeExtensions
+  %w[ round floor ceil ].each do |_method|
+    define_method _method do |*args|
+      seconds = args.first || 60
+      Time.at((self.to_f / seconds).send(_method) * seconds)
+    end
+  end
+
+  def end_of_minute
+    change(:sec => 59, :usec => 999999.999)
+  end
+
+  def beginning_of_minute
+    change(:sec => 0, :usec => 0)
+  end
+end
+
+Time.send :include, TimeExtensions
+

data/lib/redis_analytics/tracker.rb

@@ -0,0 +1,26 @@
+module Rack
+  module RedisAnalytics
+    class Tracker
+
+      def initialize(app)
+        @app = Rack::Builder.new do
+          map '/' do
+            run Analytics.new(app)
+          end
+
+          if defined? Dashboard and RedisAnalytics.dashboard_endpoint
+            map RedisAnalytics.dashboard_endpoint do
+              run Dashboard.new
+            end
+          end
+        end
+      end
+
+      def call(env)
+        @app.call(env)
+      end
+      
+    end
+  end
+end
+

data/lib/redis_analytics/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  module RedisAnalytics
+    VERSION = '0.1.0'
+  end
+end

data/redis_analytics.gemspec

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require 'redis_analytics/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = "redis_analytics"
+  spec.version     = Rack::RedisAnalytics::VERSION
+  spec.date        = '2013-02-15'
+  spec.authors     = ["Schubert Cardozo"]
+  spec.email       = ["cardozoschubert@gmail.com"]
+  spec.homepage    = "https://github.com/saturnine/redis_analytics"
+  spec.summary     = %q{A gem that provides a Redis based web analytics solution for your rack-compliant apps}
+  spec.description = %q{A gem that provides a Redis based web analytics solution for your rack-compliant apps. It gives you detailed analytics about visitors, unique visitors, browsers, OS, visitor recency, traffic sources and more}
+
+  spec.rubyforge_project = "redis_analytics"
+
+  spec.files          = Dir.glob("**/*")
+
+  spec.executables = ['redis_analytics_dashboard']
+  spec.default_executable = 'redis_analytics_dashboard'
+  spec.require_paths  = ["lib"]
+
+  spec.add_runtime_dependency('rack', '>= 1.4.0')
+  spec.add_runtime_dependency('redis', '>= 3.0.2')
+  spec.add_runtime_dependency('browser', '>= 0.1.6')
+  spec.add_runtime_dependency('sinatra', '>= 1.3.3')
+  spec.add_runtime_dependency('geoip', '>= 1.2.1')
+  spec.add_runtime_dependency('json', '>= 1.7.7')
+  spec.add_runtime_dependency('activesupport', '>= 3.2.0')
+
+  spec.add_development_dependency('rake', '>= 10.0.3')
+  spec.add_development_dependency('rspec', '>= 2.11.0')
+  spec.add_development_dependency('mocha', '>= 0.12.7')
+  spec.add_development_dependency('rack-test', '>= 0.6.2')
+
+  spec.required_ruby_version = '>= 1.9.2'
+end

data/spec/redis_analytics_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe Rack::RedisAnalytics::Analytics do
+  include Rack::Test::Methods
+  
+  def app 
+    Rack::Builder.app do
+      use Rack::RedisAnalytics::Analytics
+      run Proc.new { |env| [200, {'Content-Type' => 'text/html'}, "Hello!"] }
+    end
+  end
+
+  before(:each) do
+    @redis_connection = Rack::RedisAnalytics.redis_connection
+    clear_cookies
+    # @redis_connection.flushdb
+  end
+
+  # Spec for Cookies
+  
+  context "when a user makes 2 visits and the visit cookie and returning user cookie are not expired" do
+    it "it should count as the same visit in the cookie" do
+      t1 = Time.now
+      Time.stubs(:now).returns(t1)
+      get '/'
+      last_response.original_headers['Set-Cookie'].should =~ Regexp.new("#{Rack::RedisAnalytics.visit_cookie_name}=1\.1\.#{t1.to_i}\.#{t1.to_i}")
+      last_response.original_headers['Set-Cookie'].should =~ Regexp.new("#{Rack::RedisAnalytics.returning_user_cookie_name}=1\.#{t1.to_i}\.#{t1.to_i}")
+      t2 = t1 + 5 # just adding 5 seconds
+      Time.stubs(:now).returns(t2)
+      get '/'
+      last_response.original_headers['Set-Cookie'].should =~ Regexp.new("#{Rack::RedisAnalytics.visit_cookie_name}=1\.1\.#{t1.to_i}\.#{t2.to_i}")
+      last_response.original_headers['Set-Cookie'].should =~ Regexp.new("#{Rack::RedisAnalytics.returning_user_cookie_name}=1\.#{t1.to_i}\.#{t2.to_i}")
+    end
+  end
+  
+  context "when a user makes 2 visits, but visit cookie and returning user cookie are both non-existent" do
+    it "should count as a separate and new visit in the cookie" do
+      t1 = Time.now
+      Time.stubs(:now).returns(t1)
+      get '/'
+      last_response.original_headers['Set-Cookie'].should =~ Regexp.new("#{Rack::RedisAnalytics.visit_cookie_name}=1\.1\.#{t1.to_i}\.#{t1.to_i}")
+      last_response.original_headers['Set-Cookie'].should =~ Regexp.new("#{Rack::RedisAnalytics.returning_user_cookie_name}=1\.#{t1.to_i}.#{t1.to_i}")
+      clear_cookies
+
+      t2 = t1 + 5 # just adding 5 seconds
+      Time.stubs(:now).returns(t2)
+      get '/'
+      last_response.original_headers['Set-Cookie'].should =~ Regexp.new("#{Rack::RedisAnalytics.visit_cookie_name}=2\.2\.#{t2.to_i}\.#{t2.to_i}")
+      last_response.original_headers['Set-Cookie'].should =~ Regexp.new("#{Rack::RedisAnalytics.returning_user_cookie_name}=2\.#{t2.to_i}\.#{t2.to_i}")
+    end
+  end
+
+  context "when a user makes 2 visits, and visit cookie is expired but the returning user cookie exists" do
+    it "should count as a separate visit but not a new visit"
+  end
+
+end