redis_analytics 0.1.0 → 0.6.0

data/lib/redis_analytics/dashboard/views/widgets/bounce_rate.erb

@@ -0,0 +1,3 @@
+<h4 id="bounce_rate">
+  <small class="muted">bounce rate</small>
+</h4>

data/lib/redis_analytics/dashboard/views/widgets/browsers_donut.erb

@@ -0,0 +1,8 @@
+<table class="table table-bordered table-hover">
+  <tr>
+    <td>
+      <p class="text-center"><b>Browser Info</b></p>
+      <div id="browsers_donut" style="width:100%;height:160px;"></div>
+    </td>
+  </tr>
+</table>

data/lib/redis_analytics/dashboard/views/widgets/first_visits.erb

@@ -0,0 +1,3 @@
+<h4 id="first_visits">
+  <small class="muted">first visits</small>
+</h4>

data/lib/redis_analytics/dashboard/views/widgets/page_depth.erb

@@ -0,0 +1,3 @@
+<h4 id="page_depth">
+  <small class="muted">pages per visit</small>
+</h4>

data/lib/redis_analytics/dashboard/views/widgets/referers_donut.erb

@@ -0,0 +1,8 @@
+<table class="table table-bordered table-hover">
+  <tr>
+    <td>
+      <p class="text-center"><b>Traffic Sources</b></p>
+      <div id="referrers_donut" style="width:100%;height:160px;"></div>
+    </td>
+  </tr>
+</table>

data/lib/redis_analytics/dashboard/views/widgets/total_page_views.erb

@@ -0,0 +1,3 @@
+<h4 id="total_page_views">
+  <small class="muted">page views</small>
+</h4>

data/lib/redis_analytics/dashboard/views/widgets/total_visits.erb

@@ -0,0 +1,3 @@
+<h4 id="total_visits">
+  <small class="muted">visits</small>
+</h4>

data/lib/redis_analytics/dashboard/views/widgets/unique_visits_line.erb

@@ -0,0 +1,26 @@
+<table class="table table-bordered table-hover">
+  <tr>
+    <td>
+      <p class="text-center">
+        <b>Unique Visits</b></p>
+      <div id="unique_visits_line" style="width:100%;height:160px;"></div>
+    </td>
+  </tr>
+</table>
+
+<script type="text/javascript">
+    unique_visits_line = Morris.Line({
+	element: 'unique_visits_line',
+	xkey: 'raw',
+	ykeys: ['unique_visits'],
+	labels: ['Unique Visits'],
+	ymax: 'auto',
+	hideHover: 'auto',
+	parseTime: false,
+	lineWidth: 1,
+	pointSize: 0,
+	grid: true,
+	pointFillColors: ['#fff'],
+	pointStrokeColors: ['#000'],
+    });
+</script>

data/lib/redis_analytics/dashboard/views/widgets/visit_duration.erb

@@ -0,0 +1,3 @@
+<h4 id="visit_duration">
+  <small class="muted">avg time spent</small>
+</h4>

data/lib/redis_analytics/dashboard/views/widgets/visit_spark.erb

@@ -0,0 +1,23 @@
+<div id="visits_spark" style="width:100%;height:90px;"></div>
+<script type="text/javascript">
+  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']
+  });
+</script>

data/lib/redis_analytics/dashboard/views/widgets/visitor_recency_slices.erb

@@ -0,0 +1,39 @@
+<table class="table table-bordered table-hover">
+  <tr>
+    <td>
+      <p class="text-center"><b>Visit Recency</b></p>
+      <div style="height:160px;">
+        <div style="margin:5px;">
+        <div id="recency_d" title="0 visits">
+          <small class="muted">Less than 1 day (<span id="recency_d_cent">0</span>)</small>
+          <div class="progress" style="height: 8px; margin-bottom:10px;">
+            <div id="recency_d_bar" class="bar" style="width: 0%;"></div>
+          </div>
+        </div>
+
+        <div id="recency_w" title="0 visits">
+          <small class="muted">1 to 7 days (<span id="recency_w_cent">0</span>)</small>
+          <div class="progress" style="height: 8px; margin-bottom:10px;">
+            <div id="recency_w_bar" class="bar" style="width: 0%;"></div>
+          </div>
+        </div>
+
+        <div id="recency_m" title="0 visits">
+          <small class="muted">7 to 30 days (<span id="recency_m_cent">0</span>)</small>
+          <div class="progress" style="height: 8px; margin-bottom:10px;">
+            <div id="recency_m_bar" class="bar" style="width: 0%;"></div>
+          </div>
+        </div>
+
+        <div id="recency_o" title="0 visits">
+          <small class="muted">More than 30 days (<span id="recency_o_cent">0</span>)</small>
+          <div class="progress" style="height: 8px; margin-bottom:10px;">
+            <div id="recency_o_bar" class="bar" style="width: 0%;"></div>
+          </div>
+        </div>
+
+        </div>
+      </div>
+    </td>
+  </tr>
+</table>

data/lib/redis_analytics/dashboard/views/widgets/visits_area.erb

@@ -0,0 +1,30 @@
+<table class="table table-bordered table-hover">
+  <tr>
+    <td>
+      <p class="text-center"><b>Visits</b></p>
+      <div id="visits_area" style="width:100%;height:160px;"></div>
+    </td>
+  </tr>
+</table>
+
+<script type="text/javascript">
+    visits_area = Morris.Area({
+	element: 'visits_area',
+	xkey: 'raw',
+	//data: data,
+	ykeys: ['first_visits', 'repeat_visits'],
+	labels: ['First Visits', 'Repeat Visits'],
+	ymax: 'auto',
+	grid: true,
+	eventStrokeWidth: 2,
+	eventLineColors: ['#ccc', '#eee'],
+	smooth: true,
+	hideHover: 'auto',
+	parseTime: false,
+	lineWidth: 1,
+	pointSize: 0,
+	xLabelFormat: function(x) {return x.getFullYear() + '-' + x.getMonth() + '-' + x.getDate();},
+	pointFillColors: ['#fff'],
+	pointStrokeColors: ['#000']
+    });
+</script>

data/lib/redis_analytics/dashboard/views/widgets/visits_donut.erb

@@ -0,0 +1,8 @@
+<table class="table table-bordered table-hover">
+  <tr>
+    <td>
+      <p class="text-center"><b>Total Visits</b></p>
+      <div id="visits_donut" style="width:100%;height:160px;"></div>
+    </td>
+  </tr>
+</table>

data/lib/redis_analytics/dashboard/views/widgets/world_map.erb

@@ -0,0 +1,50 @@
+<table class="table table-bordered">
+  <tr>
+    <td>
+      <p class="text-center"><b>Visitor Map</b></p>
+      <div id="world-map" class="info" style="width: 100%px; height: 160px"></div>
+    </td>
+  </tr>
+</table>
+
+<script type="text/javascript">
+  // Map Overlay
+  var geoLocationData = {}; 
+  $(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'
+        }]
+      },
+      onRegionLabelShow: function(e, el, code){
+	  c = geoLocationData[code];
+	  if(c != undefined)
+	  el.html(el.html()+' ('+c+')');
+      }
+    });
+  });
+</script>

data/lib/redis_analytics/filter.rb

@@ -0,0 +1,33 @@
+module Rack
+  module RedisAnalytics
+    class Filter
+      attr_reader :filter_proc
+
+      def initialize(filter_proc)
+        @filter_proc = filter_proc
+      end
+
+      def matches?(request, response)
+        filter_proc.call(request, response)
+      end
+
+    end
+
+    class PathFilter
+      attr_reader :filter_path
+
+      def initialize(filter_path)
+        @filter_path = filter_path
+      end
+
+      def matches?(request_path)
+        if filter_path.is_a?(String)
+          request_path == filter_path
+        elsif filter_path.is_a?(Regexp)
+          request_path =~ filter_path
+        end
+      end
+    end
+
+  end
+end

data/lib/redis_analytics/helpers.rb

@@ -1,69 +1,75 @@
-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)$/
+        if meth.to_s =~ /^(minute|hour|dai|day|month|year)ly_([a-z_0-9]+)$/
           granularity = ($1 == 'dai' ? 'day' : $1) + 'ly'
-          type = $2
-          data(granularity, type, *args)
+          metric_name = $2
+          data(granularity, metric_name, *args)
         else
           super
         end
       end
 
-      def data(granularity, type, from_date, options = {})
+      def metric_type(metric_name)
+        RedisAnalytics.redis_connection.hget("#{RedisAnalytics.redis_namespace}:#METRICS", metric_name)
+      end
+
+      def data(granularity, metric_name, 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'
+        i = from_date.send("beginning_of_#{x}")
 
-        # 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}
+          slice_key = i.strftime(FORMAT_SPECIFIER[0..GRANULARITY.index(granularity)].map{|x| x[0]}.join('_'))
+          union << "#{RedisAnalytics.redis_namespace}:#{metric_name}:#{slice_key}"
+          time << slice_key.split('_')
+          i += 1.send(x)
         end while i <= to_date
-        # puts "UNION #{union.inspect}"
         seq = get_next_seq
-        if type =~ /unique/
+        if metric_type(metric_name) == 'String'
           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)
+            union_key = "#{RedisAnalytics.redis_namespace}:#{seq}"
+            RedisAnalytics.redis_connection.zunionstore(union_key, union)
+            RedisAnalytics.redis_connection.expire(union_key, 100)
+            return Hash[RedisAnalytics.redis_connection.zrange(union_key, 0, -1, :with_scores => true)]
           else
-            return time.zip(union.map{|x| Rack::RedisAnalytics.redis_connection.scard(x)})
+            return time.zip(union.map{|x| Hash[RedisAnalytics.redis_connection.zrange(x, 0, -1, :with_scores => true)]})
           end
-        elsif type =~ /ratio/
+        elsif metric_type(metric_name) == 'Fixnum'
           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)
+            return RedisAnalytics.redis_connection.mget(*union).map(&:to_i).inject(:+)
           else
-            return time.zip(union.map{|x| Rack::RedisAnalytics.redis_connection.zrange(x,0,-1, :with_scores => true)})
+            return time.zip(RedisAnalytics.redis_connection.mget(*union).map(&:to_i))
           end
         else
-          time.zip(Rack::RedisAnalytics.redis_connection.mget(*union).map(&:to_i))
+          if Metrics.public_instance_methods.any?{|m| m.to_s =~ /^#{metric_name}_ratio_per_(hit|visit)$/}
+            aggregate ? {} : time.zip([{}] * time.length)
+          elsif Metrics.public_instance_methods.any?{|m| m.to_s =~ /^#{metric_name}_count_per_(hit|visit)$/}
+            aggregate ? 0 : time.zip([0] * time.length)
+          else
+            aggregate ? 0 : time.zip([0] * time.length)
+          end
         end
       end
-      
+
       def get_next_seq
-        seq = Rack::RedisAnalytics.redis_connection.incr("#{Rack::RedisAnalytics.redis_namespace}:#SEQUENCER")
+        seq = RedisAnalytics.redis_connection.incr("#{RedisAnalytics.redis_namespace}:#SEQUENCER")
       end
 
+      def time_range
+        (request.cookies["_rarng"] || RedisAnalytics.default_range).to_sym
+      end
     end
   end
 end

data/lib/redis_analytics/metrics.rb

@@ -0,0 +1,96 @@
+module Rack
+  module RedisAnalytics
+    module Metrics
+
+      attr_reader :visit_time_count_per_visit
+      attr_reader :visits_count_per_visit, :first_visits_count_per_visit, :repeat_visits_count_per_visit
+      attr_reader :unique_visits_ratio_per_visit
+      attr_reader :page_views_count_per_hit, :second_page_views_count_per_hit
+
+      # Developers can override or define new public methods here
+      # Methods should start with track and end with count or types
+      # Return types should be Fixnum or String resp.
+      # If you return nil or an error nothing will be tracked
+
+      def browser_ratio_per_visit
+        user_agent.name.to_s
+      end
+
+      def platform_ratio_per_visit
+        user_agent.platform.to_s
+      end
+
+      def country_ratio_per_visit
+        if defined?(GeoIP)
+          begin
+            g = GeoIP.new(RedisAnalytics.geo_ip_data_path)
+            geo_country_code = g.country(@rack_request.ip).to_hash[:country_code2]
+            if geo_country_code and geo_country_code =~ /^[A-Z]{2}$/
+              return geo_country_code
+            end
+          rescue Exception => e
+            warn "Unable to fetch country info #{e}"
+          end
+        end
+      end
+
+      def recency_ratio_per_visit
+        # tracking for visitor recency
+        if @last_visit_time # from first_visit_cookie
+          days_since_last_visit = ((@t.to_i - @last_visit_time.to_i)/(24*3600)).round
+          if days_since_last_visit <= 1
+            return 'd'
+          elsif days_since_last_visit <= 7
+            return 'w'
+          elsif days_since_last_visit <= 30
+            return 'm'
+          else
+            return 'o'
+          end
+        end
+      end
+
+      def device_ratio_per_visit
+        return ((user_agent.mobile? or user_agent.tablet?) ? 'mobile' : 'desktop')
+      end
+
+      def referrer_ratio_per_visit
+        if @rack_request.referrer
+          ['google', 'bing', 'yahoo', 'cleartrip', 'github'].each do |referrer|
+            # this will track x.google.mysite.com as google so its buggy, fix the regex
+            if m = @rack_request.referrer.match(/^(https?:\/\/)?([a-zA-Z0-9\.\-]+\.)?(#{referrer})\.([a-zA-Z\.]+)(:[0-9]+)?(\/.*)?$/)
+              "REFERRER => #{m.to_a[3]}"
+              referrer = m.to_a[3]
+            else
+              referrer = 'other'
+            end
+          end
+        else
+          referrer = 'organic'
+        end
+        return referrer
+      end
+
+      # track the ratio of URL's visits
+      def url_ratio_per_hit
+        return @rack_request.path
+      end
+      
+      # track the landing pages ratio
+      def landing_page_ratio_per_hit
+        return @rack_request.path if @page_view_seq_no.to_i == 0
+      end
+
+      # track the landing pages ratio
+      def http_response_ratio_per_hit
+        return @rack_response.status.to_s
+      end
+
+      private
+      def user_agent
+        Browser.new(:ua => @rack_request.user_agent, :accept_language => 'en-us')
+      end
+
+    end
+  end
+end