redis_analytics 0.6.0 → 0.7.1

data/lib/redis_analytics.rb

@@ -1,26 +1,19 @@
-require 'rack'
 require 'redis'
 require 'browser'
-require 'sinatra'
 require 'geoip'
 
 require 'redis_analytics'
+
 require 'redis_analytics/version'
+require 'redis_analytics/time_ext'
 require 'redis_analytics/filter'
 require 'redis_analytics/configuration'
-require 'redis_analytics/analytics'
 require 'redis_analytics/metrics'
 require 'redis_analytics/visit'
-require 'redis_analytics/time_ext'
 require 'redis_analytics/helpers'
-require 'redis_analytics/api'
-require 'redis_analytics/dashboard'
-
 require 'redis_analytics/tracker'
-require 'redis_analytics/railtie' if defined? Rails::Railtie
+require 'redis_analytics/engine'
 
-module Rack
-  module RedisAnalytics
-    extend Configuration
-  end
+module RedisAnalytics
+  extend Configuration
 end

data/lib/redis_analytics/configuration.rb

@@ -1,4 +1,3 @@
-module Rack
   module RedisAnalytics
     module Configuration
       # Redis connection instance
@@ -36,7 +35,7 @@ module Rack
 
       # Minutes the visit should timeout after (if no hit is received)
       def visit_timeout
-        @visit_timeout ||= 1 # minutes
+        @visit_timeout ||= 30 # minutes
       end
 
       # Name of the cookie which tracks first visitors (unknown visitors)
@@ -99,4 +98,4 @@ module Rack
 
     end
   end
-end
+

data/lib/redis_analytics/engine.rb

@@ -0,0 +1,18 @@
+require 'rails'
+require 'jquery-rails'
+
+module RedisAnalytics
+  module Dashboard
+    class Engine < ::Rails::Engine
+      isolate_namespace RedisAnalytics
+      
+      initializer "redis_analytics.middleware" do |app|
+        app.config.app_middleware.use "RedisAnalytics::Tracker"
+      end
+      
+      initializer "redis_analytics.view_helpers" do |app|
+        ActionController::Base.send :include, RedisAnalytics::Helpers
+      end
+    end
+  end
+end

data/lib/redis_analytics/filter.rb

@@ -1,4 +1,3 @@
-module Rack
   module RedisAnalytics
     class Filter
       attr_reader :filter_proc
@@ -30,4 +29,4 @@ module Rack
     end
 
   end
-end
+

data/lib/redis_analytics/helpers.rb

@@ -1,4 +1,3 @@
-module Rack
   module RedisAnalytics
     module Helpers
 
@@ -72,4 +71,4 @@ module Rack
       end
     end
   end
-end
+

data/lib/redis_analytics/metrics.rb

@@ -1,4 +1,3 @@
-module Rack
   module RedisAnalytics
     module Metrics
 
@@ -93,4 +92,4 @@ module Rack
 
     end
   end
-end
+

data/lib/redis_analytics/time_ext.rb

@@ -1,47 +1,5 @@
 require  'date'
 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_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
     Time.local(self.year, self.mon, self.day, self.hour, self.min, 59)
@@ -53,37 +11,3 @@ module TimeExtensions
 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

@@ -1,34 +1,45 @@
-module Rack
-  module RedisAnalytics
-    class Tracker
+# -*- coding: utf-8 -*-
+require 'digest/md5'
+module RedisAnalytics
+  class Tracker
 
-      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
+    def initialize(app)
+      @app = app
+    end
 
-          map '/' do
-            run Analytics.new(app)
-          end
+    def call(env)
+      dup.call!(env)
+    end
 
-          if defined?(Api) and RedisAnalytics.api_endpoint
-            map RedisAnalytics.api_endpoint do
-              run Api.new
-            end
-          end
+    def call!(env)
+      @env = env
+      @request  = Rack::Request.new(env)
+      status, headers, body = @app.call(env)
+      @response = Rack::Response.new(body, status, headers)
+      record if should_record?
+      @response.finish
+    end
 
-        end
+    def should_record?
+      dashboard_path = Rails.application.routes.named_routes[:redis_analytics].path rescue nil
+      return false if dashboard_path =~ @request.path
+      return false unless @response.ok?
+      return false unless @response.content_type =~ /^text\/html/
+      RedisAnalytics.path_filters.each do |filter|
+        return false if filter.matches?(@request.path)
       end
-
-      def call(env)
-        @app.call(env)
+      RedisAnalytics.filters.each do |filter|
+        return false if filter.matches?(@request, @response)
       end
+      return true
+    end
 
+    def record
+      v = Visit.new(@request, @response)
+      @response = v.record
+      @response.set_cookie(RedisAnalytics.current_visit_cookie_name, v.updated_current_visit_info)
+      @response.set_cookie(RedisAnalytics.first_visit_cookie_name, v.updated_first_visit_info)
     end
+
   end
 end

data/lib/redis_analytics/version.rb

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

data/lib/redis_analytics/visit.rb

@@ -1,4 +1,3 @@
-module Rack
   module RedisAnalytics
     class Visit
       include Metrics
@@ -54,7 +53,7 @@ module Rack
           else
             @first_visit_seq ||= counter("unique_visits")
             track("first_visits", 1)
-            track("unique_visits", @first_visit_seq)
+            track("unique_visits", 1)
           end
           exec_custom_methods('visit') # custom methods that are measured on a per-visit basis
         end
@@ -89,7 +88,7 @@ module Rack
         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)
+        expires = @t + RedisAnalytics.visit_timeout.to_i.minutes
         {:value => value.join('.'), :expires => expires}
       end
 
@@ -97,7 +96,7 @@ module Rack
         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
+        expires = @t + 1.year
         {:value => value.join('.'), :expires => expires}
       end
 
@@ -119,4 +118,4 @@ module Rack
 
     end
   end
-end
+

data/lib/tasks/redis_analytics_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :redis_analytics do
+#   # Task goes here
+# end

data/redis_analytics.gemspec

@@ -1,11 +1,11 @@
-
 # -*- 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.license	   = 'MIT'
+  spec.version     = RedisAnalytics::VERSION
   spec.date        = Time.now.strftime('%Y-%m-%d')
   spec.authors     = ["Schubert Cardozo"]
   spec.email       = ["cardozoschubert@gmail.com"]
@@ -17,26 +17,26 @@ Gem::Specification.new do |spec|
 
   spec.files          = Dir.glob("**/*")
 
-  spec.executables = ['redis_analytics_dashboard']
-  spec.default_executable = 'redis_analytics_dashboard'
+  # spec.executables = ['redis_analytics_dashboard']
+  # spec.default_executable = 'redis_analytics_dashboard'
   spec.require_paths  = ["lib"]
 
-  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.add_runtime_dependency 'rails', '>= 3.2.0', '< 5'
+  spec.add_runtime_dependency 'jquery-rails'
+  spec.add_runtime_dependency 'sqlite3'
+  spec.add_runtime_dependency 'redis'
+  spec.add_runtime_dependency 'browser'
+  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/script/rails

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/redis_analytics/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

data/spec/lib/redis_analytics/analytics_spec.rb

@@ -1,59 +0,0 @@
-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

@@ -1,9 +1,9 @@
 require 'spec_helper'
 
-describe Rack::RedisAnalytics::Configuration do
+describe RedisAnalytics::Configuration do
 
   context 'property redis_connection' do
-    subject(:connection) { Rack::RedisAnalytics.redis_connection }
+    subject(:connection) { RedisAnalytics.redis_connection }
     it 'should not be nil' do
       connection.should_not be_nil
     end
@@ -13,7 +13,7 @@ describe Rack::RedisAnalytics::Configuration do
   end
 
   context 'property redis_namespace' do
-    subject(:namespace) { Rack::RedisAnalytics.redis_namespace }
+    subject(:namespace) { RedisAnalytics.redis_namespace }
     it 'should not be nil' do
       namespace.should_not be_nil
     end
@@ -27,7 +27,7 @@ describe Rack::RedisAnalytics::Configuration do
   end
 
   context 'property first_visit_cookie_name' do 
-    subject(:return_cookie) { Rack::RedisAnalytics.first_visit_cookie_name }
+    subject(:return_cookie) { RedisAnalytics.first_visit_cookie_name }
     it 'should not be nil' do
       return_cookie.should_not be_nil
     end
@@ -41,7 +41,7 @@ describe Rack::RedisAnalytics::Configuration do
   end
 
   context 'property current_visit_cookie_name' do 
-    subject(:current_visit_cookie_name) { Rack::RedisAnalytics.current_visit_cookie_name }
+    subject(:current_visit_cookie_name) { RedisAnalytics.current_visit_cookie_name }
     it 'should not be nil' do 
       current_visit_cookie_name.should_not be_nil
     end
@@ -55,21 +55,21 @@ describe Rack::RedisAnalytics::Configuration do
   end
 
   context 'property visit_timeout' do
-    subject(:visit_timeout) { Rack::RedisAnalytics.visit_timeout }
+    subject(:visit_timeout) { 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
+      visit_timeout.should be == 30
     end
     it 'can be set to another value' do 
-      visit_timeout = 5
-      visit_timeout.should be == 5
+      visit_timeout = 10
+      visit_timeout.should be == 10
     end
   end
 
   context 'property visitor_recency_slices' do
-    subject(:visitor_recency_slices) { Rack::RedisAnalytics.visitor_recency_slices }
+    subject(:visitor_recency_slices) { RedisAnalytics.visitor_recency_slices }
     it 'should not be nil' do
       visitor_recency_slices.should_not be_nil
     end
@@ -86,7 +86,7 @@ describe Rack::RedisAnalytics::Configuration do
   end
 
   context 'property default_range' do 
-    subject(:default_range) { Rack::RedisAnalytics.default_range }
+    subject(:default_range) { RedisAnalytics.default_range }
     it 'should not be nil' do
       default_range.should_not be_nil
     end
@@ -103,7 +103,7 @@ describe Rack::RedisAnalytics::Configuration do
   end
 
   context 'property redis_key_timestamps' do
-    subject(:redis_key_timestamps) { Rack::RedisAnalytics.redis_key_timestamps }
+    subject(:redis_key_timestamps) { RedisAnalytics.redis_key_timestamps }
     it 'should not be nil' do
       redis_key_timestamps.should_not be_nil
     end
@@ -117,7 +117,7 @@ describe Rack::RedisAnalytics::Configuration do
   end
 
   context 'property time_range_formats' do
-    subject(:time_range_formats) { Rack::RedisAnalytics.time_range_formats }
+    subject(:time_range_formats) { RedisAnalytics.time_range_formats }
     it 'should not be nil' do
       time_range_formats.should_not be_nil
     end
@@ -134,24 +134,24 @@ describe Rack::RedisAnalytics::Configuration do
   end
 
   context 'method add_filter' do
-    subject(:filters) { Rack::RedisAnalytics.filters }
+    subject(:filters) { RedisAnalytics.filters }
     it 'should add a new filter' do
       proc = Proc.new {}
-      Rack::RedisAnalytics.configure do |c|
+      RedisAnalytics.configure do |c|
         c.add_filter(&proc)
       end
-      filters[0].should be_an_instance_of Rack::RedisAnalytics::Filter
+      filters[0].should be_an_instance_of RedisAnalytics::Filter
     end
   end
 
   context 'method add_path_filter' do
-    subject(:path_filters) { Rack::RedisAnalytics.path_filters }
+    subject(:path_filters) { RedisAnalytics.path_filters }
     it 'should add a new path filter' do
       path = '/hello'
-      Rack::RedisAnalytics.configure do |c|
+      RedisAnalytics.configure do |c|
         c.add_path_filter(path)
       end
-      path_filters[0].should be_an_instance_of Rack::RedisAnalytics::PathFilter
+      path_filters[0].should be_an_instance_of RedisAnalytics::PathFilter
     end
   end