redis_analytics 0.1.0 → 0.6.0

data/lib/redis_analytics/time_ext.rb

@@ -1,3 +1,4 @@
+require  'date'
 module TimeExtensions
   %w[ round floor ceil ].each do |_method|
     define_method _method do |*args|
@@ -6,14 +7,83 @@ module TimeExtensions
     end
   end
 
+  def end_of_year
+    Time.local(self.year, 12, 31, 23, 59, 59)
+  end
+
+  def beginning_of_year
+    Time.local(self.year, 1, 1, 0, 0, 0)
+  end
+
+  def end_of_month
+    Time.local(self.year, self.mon + 1, 1, 23, 59, 59) - 1.day
+  end
+
+  def beginning_of_month
+    Date.civil(self.year, self.mon, -1).to_time
+  end
+
+  def beginning_of_day
+    Time.local(self.year, self.mon, self.day, 0, 0, 0)
+  end
+
+  def end_of_day
+    Time.local(self.year, self.mon, self.day, 23, 59, 59)
+  end
+
+  def beginning_of_day
+    Time.local(self.year, self.mon, self.day, 0, 0, 0)
+  end
+
+  def end_of_hour
+    Time.local(self.year, self.mon, self.day, self.hour, 59, 59)
+  end
+
+  def beginning_of_hour
+    Time.local(self.year, self.mon, self.day, self.hour, 0, 0)
+  end
+
   def end_of_minute
-    change(:sec => 59, :usec => 999999.999)
+    Time.local(self.year, self.mon, self.day, self.hour, self.min, 59)
   end
 
   def beginning_of_minute
-    change(:sec => 0, :usec => 0)
+    Time.local(self.year, self.mon, self.day, self.hour, self.min, 0)
   end
 end
 
 Time.send :include, TimeExtensions
 
+module FixnumExtensions
+
+  def minute
+    self * 60
+  end
+
+  def hour
+    minute * 60
+  end
+
+  def day
+    hour * 24
+  end
+
+  def week
+    day * 7
+  end
+
+  def month
+    day * 30 
+  end
+
+  def year
+    day * 365
+  end
+
+  def ago(time = Time.now)
+    time - self
+  end
+end
+
+Fixnum.send :include, FixnumExtensions
+

data/lib/redis_analytics/tracker.rb

@@ -4,23 +4,31 @@ module Rack
 
       def initialize(app)
         @app = Rack::Builder.new do
+
+          if defined?(Dashboard) and RedisAnalytics.dashboard_endpoint
+            puts("WARNING: RedisAnalytics.dashboard_endpoint is set as \"/\"") if RedisAnalytics.dashboard_endpoint == '/'
+            map RedisAnalytics.dashboard_endpoint do
+              run Dashboard.new
+            end
+          end
+
           map '/' do
             run Analytics.new(app)
           end
 
-          if defined? Dashboard and RedisAnalytics.dashboard_endpoint
-            map RedisAnalytics.dashboard_endpoint do
-              run Dashboard.new
+          if defined?(Api) and RedisAnalytics.api_endpoint
+            map RedisAnalytics.api_endpoint do
+              run Api.new
             end
           end
+
         end
       end
 
       def call(env)
         @app.call(env)
       end
-      
+
     end
   end
 end
-

data/lib/redis_analytics/version.rb

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

data/lib/redis_analytics/visit.rb

@@ -0,0 +1,122 @@
+module Rack
+  module RedisAnalytics
+    class Visit
+      include Metrics
+
+      # This class represents one unique visit
+      # User may have never visited the site
+      # User may have visited before but his visit is expired
+      # Everything counted here is unique for a visit
+
+      # helpers
+      def for_each_time_range(t)
+        RedisAnalytics.redis_key_timestamps.map{|x, y| t.strftime(x)}.each do |ts|
+          yield(ts)
+        end
+      end
+
+      def first_visit_info
+        cookie = @rack_request.cookies[RedisAnalytics.first_visit_cookie_name]
+        return cookie ? cookie.split('.') : []
+      end
+
+      def current_visit_info
+        cookie = @rack_request.cookies[RedisAnalytics.current_visit_cookie_name]
+        return cookie ? cookie.split('.') : []
+      end
+
+      # method used in analytics.rb to initialize visit
+      def initialize(request, response)
+        @t = Time.now
+        @redis_key_prefix = "#{RedisAnalytics.redis_namespace}:"
+        @rack_request = request
+        @rack_response = response
+        @first_visit_seq = first_visit_info[0] || current_visit_info[0]
+        @current_visit_seq = current_visit_info[1]
+
+        @first_visit_time = first_visit_info[1]
+        @last_visit_time = first_visit_info[2]
+
+        @page_view_seq_no = current_visit_info[2] || 0
+        @last_visit_start_time = current_visit_info[3]
+        @last_visit_end_time = current_visit_info[4]
+      end
+
+      # called from analytics.rb
+      def record
+        if @current_visit_seq
+          track("visit_time", @t.to_i - @last_visit_end_time.to_i)
+        else
+          @current_visit_seq ||= counter("visits")
+          track("visits", 1) # track core 'visit' metric
+          if @first_visit_seq
+            track("repeat_visits", 1)
+          else
+            @first_visit_seq ||= counter("unique_visits")
+            track("first_visits", 1)
+            track("unique_visits", @first_visit_seq)
+          end
+          exec_custom_methods('visit') # custom methods that are measured on a per-visit basis
+        end
+        exec_custom_methods('hit') # custom methods that are measured on a per-page-view (per-hit) basis
+        track("page_views", 1) # track core 'page_view' metric
+        track("second_page_views", 1) if @page_view_seq_no.to_i == 1 # @last_visit_start_time and (@last_visit_start_time.to_i == @last_visit_end_time.to_i)
+        @rack_response
+      end
+
+      def exec_custom_methods(type)
+        Metrics.public_instance_methods.each do |meth|
+          if m = meth.to_s.match(/^([a-z_]*)_(count|ratio)_per_#{type}$/)
+            begin
+              return_value = self.send(meth)
+              track(m.to_a[1], return_value) if return_value
+            rescue => e
+              warn "#{meth} resulted in an exception #{e}"
+            end
+          end
+        end
+      end
+
+      # helpers
+      def counter(metric_name)
+        n = RedisAnalytics.redis_connection.incr("#{@redis_key_prefix}#{metric_name}")
+        # to debug, uncomment this line
+        # puts "COUNT #{metric_name} -> #{n}"
+        return n
+      end
+
+      def updated_current_visit_info
+        value = [@first_visit_seq.to_i, @current_visit_seq.to_i, @page_view_seq_no.to_i + 1, (@last_visit_start_time || @t).to_i, @t.to_i]
+        # to debug, uncomment this line
+        # puts "UPDATING VCN COOKIE -> #{value}"
+        expires = @t + (RedisAnalytics.visit_timeout.to_i * 60)
+        {:value => value.join('.'), :expires => expires}
+      end
+
+      def updated_first_visit_info
+        value = [@first_visit_seq.to_i, (@first_visit_time || @t).to_i, @t.to_i]
+        # to debug, uncomment this line
+        # puts "UPDATING RUCN COOKIE -> #{value}"
+        expires = @t + (60 * 60 * 24 * 5) # 5 hours
+        {:value => value.join('.'), :expires => expires}
+      end
+
+      def track(metric_name, metric_value)
+        n = 0
+        RedisAnalytics.redis_connection.hmset("#{@redis_key_prefix}#METRICS", metric_name, metric_value.class)
+        for_each_time_range(@t) do |ts|
+          key = "#{@redis_key_prefix}#{metric_name}:#{ts}"
+          if metric_value.is_a?(Fixnum)
+            n = RedisAnalytics.redis_connection.incrby(key, metric_value)
+          else
+            n = RedisAnalytics.redis_connection.zincrby(key, 1, metric_value)
+          end
+        end
+        # to debug, uncomment this line
+        # puts "TRACK #{metric_name} -> #{n}" 
+        return n
+      end
+
+    end
+  end
+end

data/redis_analytics.gemspec

@@ -1,3 +1,4 @@
+
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
 require 'redis_analytics/version'
@@ -5,11 +6,11 @@ require 'redis_analytics/version'
 Gem::Specification.new do |spec|
   spec.name        = "redis_analytics"
   spec.version     = Rack::RedisAnalytics::VERSION
-  spec.date        = '2013-02-15'
+  spec.date        = Time.now.strftime('%Y-%m-%d')
   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.summary     = %q{Fast and efficient web analytics for Rack 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"
@@ -20,18 +21,22 @@ Gem::Specification.new do |spec|
   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.add_runtime_dependency('rack')
+  spec.add_runtime_dependency('redis')
+  spec.add_runtime_dependency('browser')
+  spec.add_runtime_dependency('sinatra')
+  spec.add_runtime_dependency('sinatra-assetpack')
+  spec.add_runtime_dependency('geoip')
+  spec.add_runtime_dependency('json')
+
+  spec.add_development_dependency('fakeredis')
+  spec.add_development_dependency('rake')
+  spec.add_development_dependency('rspec')
+  spec.add_development_dependency('guard-rspec')
+  spec.add_development_dependency('mocha')
+  spec.add_development_dependency('rack-test')
+  spec.add_development_dependency('simplecov')
+  spec.add_development_dependency('coveralls')
 
   spec.required_ruby_version = '>= 1.9.2'
 end

data/spec/lib/redis_analytics/analytics_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe Rack::RedisAnalytics::Analytics do
+
+  subject(:app) {
+    Rack::Builder.app do
+      use Rack::RedisAnalytics::Analytics
+      run Proc.new { |env| [200, {'Content-Type' => 'text/html'}, "Hello!"] }
+    end
+  }
+
+  before(:each) do
+    clear_cookies
+  end
+
+  # Spec for Cookies
+  context "when a user makes 2 visits and the current visit cookie and first visit cookie are not expired" do
+    def cookie
+      last_response.original_headers['Set-Cookie']
+    end
+    it "should count as the same visit in the cookie" do
+      t1 = Time.now
+      Time.stubs(:now).returns(t1)
+      get '/'
+      cookie.should match("#{Rack::RedisAnalytics.current_visit_cookie_name}=1.1.1.#{t1.to_i}.#{t1.to_i}")
+      cookie.should match("#{Rack::RedisAnalytics.first_visit_cookie_name}=1.#{t1.to_i}.#{t1.to_i}")
+      t2 = t1 + 5 # just adding 5 seconds
+      Time.stubs(:now).returns(t2)
+      get '/'
+      cookie.should match("#{Rack::RedisAnalytics.current_visit_cookie_name}=1.1.2.#{t1.to_i}.#{t2.to_i}")
+      cookie.should match("#{Rack::RedisAnalytics.first_visit_cookie_name}=1.#{t1.to_i}.#{t2.to_i}")
+    end
+  end
+
+  context "when a user makes 2 visits, but current visit cookie and first visit cookie are both non-existent" do
+    def cookie
+      last_response.original_headers['Set-Cookie']
+    end
+    it "should count as a separate and new visit in the cookie" do
+      t1 = Time.now
+      Time.stubs(:now).returns(t1)
+      get '/'
+      cookie.should match("#{Rack::RedisAnalytics.current_visit_cookie_name}=1.1.1.#{t1.to_i}.#{t1.to_i}")
+      cookie.should match("#{Rack::RedisAnalytics.first_visit_cookie_name}=1.#{t1.to_i}.#{t1.to_i}")
+      clear_cookies
+
+      t2 = t1 + 5 # just adding 5 seconds
+      Time.stubs(:now).returns(t2)
+      get '/'
+      cookie.should match("#{Rack::RedisAnalytics.current_visit_cookie_name}=2.2.1.#{t2.to_i}.#{t2.to_i}")
+      cookie.should match("#{Rack::RedisAnalytics.first_visit_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

data/spec/lib/redis_analytics/configuration_spec.rb

@@ -0,0 +1,158 @@
+require 'spec_helper'
+
+describe Rack::RedisAnalytics::Configuration do
+
+  context 'property redis_connection' do
+    subject(:connection) { Rack::RedisAnalytics.redis_connection }
+    it 'should not be nil' do
+      connection.should_not be_nil
+    end
+    it 'should be an instance of Redis' do
+      connection.instance_of? Redis 
+    end
+  end
+
+  context 'property redis_namespace' do
+    subject(:namespace) { Rack::RedisAnalytics.redis_namespace }
+    it 'should not be nil' do
+      namespace.should_not be_nil
+    end
+    it 'should have an default value' do
+      namespace.should be == "_ra_test_namespace"
+    end
+    it 'can be set to another value' do
+      namespace = "test_ra"
+      namespace.should be == "test_ra"
+    end
+  end
+
+  context 'property first_visit_cookie_name' do 
+    subject(:return_cookie) { Rack::RedisAnalytics.first_visit_cookie_name }
+    it 'should not be nil' do
+      return_cookie.should_not be_nil
+    end
+    it 'should have an default value' do 
+      return_cookie.should be == "_rucn"
+    end
+    it 'has an setter method' do 
+      return_cookie = "rucn"
+      return_cookie.should be == "rucn"
+    end
+  end
+
+  context 'property current_visit_cookie_name' do 
+    subject(:current_visit_cookie_name) { Rack::RedisAnalytics.current_visit_cookie_name }
+    it 'should not be nil' do 
+      current_visit_cookie_name.should_not be_nil
+    end
+    it 'should have an default value' do 
+      current_visit_cookie_name.should be == "_vcn"
+    end
+    it 'can be set to another value' do
+      current_visit_cookie_name = "test_vcn"
+      current_visit_cookie_name.should be == "test_vcn"
+    end
+  end
+
+  context 'property visit_timeout' do
+    subject(:visit_timeout) { Rack::RedisAnalytics.visit_timeout }
+    it 'should not be nil' do 
+      visit_timeout.should_not be_nil
+    end
+    it 'should have an default value' do 
+      visit_timeout.should be == 1
+    end
+    it 'can be set to another value' do 
+      visit_timeout = 5
+      visit_timeout.should be == 5
+    end
+  end
+
+  context 'property visitor_recency_slices' do
+    subject(:visitor_recency_slices) { Rack::RedisAnalytics.visitor_recency_slices }
+    it 'should not be nil' do
+      visitor_recency_slices.should_not be_nil
+    end
+    it 'should be an Array of Fixnum' do 
+      visitor_recency_slices.instance_of? Array
+      visitor_recency_slices.each do |value|
+        value.instance_of? Fixnum
+      end
+    end
+    it 'can be set to another value' do 
+      visitor_recency_slices = [3, 7, 9]
+      expect(visitor_recency_slices).to eq([3, 7, 9])
+    end
+  end
+
+  context 'property default_range' do 
+    subject(:default_range) { Rack::RedisAnalytics.default_range }
+    it 'should not be nil' do
+      default_range.should_not be_nil
+    end
+    it 'should be an symbol' do
+      default_range.instance_of? Symbol
+    end
+    it 'should have an value' do
+      default_range.should be == :day
+    end
+    it 'can be set to another value' do
+      default_range = :month
+      default_range.should be :month
+    end
+  end
+
+  context 'property redis_key_timestamps' do
+    subject(:redis_key_timestamps) { Rack::RedisAnalytics.redis_key_timestamps }
+    it 'should not be nil' do
+      redis_key_timestamps.should_not be_nil
+    end
+    it 'should be an instance of Array' do
+      redis_key_timestamps.instance_of? Array
+    end
+    it 'can be set to another value' do
+      redis_key_timestamps = ['one', 'two']
+      expect(redis_key_timestamps).to eq(['one','two'])
+    end
+  end
+
+  context 'property time_range_formats' do
+    subject(:time_range_formats) { Rack::RedisAnalytics.time_range_formats }
+    it 'should not be nil' do
+      time_range_formats.should_not be_nil
+    end
+    it 'should be an Array of Array' do
+      time_range_formats.instance_of? Array
+      time_range_formats.each do |range|
+        range.instance_of? Array
+      end
+    end
+    it 'can be set to another value' do
+      time_range_formats = "nothing"
+      expect(time_range_formats).to eq("nothing")
+    end
+  end
+
+  context 'method add_filter' do
+    subject(:filters) { Rack::RedisAnalytics.filters }
+    it 'should add a new filter' do
+      proc = Proc.new {}
+      Rack::RedisAnalytics.configure do |c|
+        c.add_filter(&proc)
+      end
+      filters[0].should be_an_instance_of Rack::RedisAnalytics::Filter
+    end
+  end
+
+  context 'method add_path_filter' do
+    subject(:path_filters) { Rack::RedisAnalytics.path_filters }
+    it 'should add a new path filter' do
+      path = '/hello'
+      Rack::RedisAnalytics.configure do |c|
+        c.add_path_filter(path)
+      end
+      path_filters[0].should be_an_instance_of Rack::RedisAnalytics::PathFilter
+    end
+  end
+
+end