gricer 0.0.1

data/lib/gricer/config.rb

@@ -0,0 +1,125 @@
+module Gricer
+  # The configuration object for Gricer
+  #
+  # 
+  class Config
+    attr_writer :table_name_prefix, :admin_prefix, :admin_layout 
+    attr_writer :max_session_duration
+    attr_writer :geoip_db, :geoip_dat 
+    attr_writer :exclude_paths 
+    attr_writer :admin_menu 
+    
+    # A new instance of Gricer::Config.
+    #
+    # Configure options can be passed in a block.
+    #
+    # @see #configure
+    #
+    # @return [Gricer::Config] 
+    def initialize(&block)
+      configure(&block) if block_given?
+    end
+
+    # Configure your Gricer Rails Engine with the given parameters in 
+    # the block. For possible options see Instance Attributes.
+    #
+    # @yield (config) The actual configuration instance
+    # @return [Gricer::Config] The actual configuration instance
+    def configure(&block)
+      yield(self)
+    end
+    
+    # The prefix for table names of gricer database tables.
+    #
+    # Default value is 'gricer_'
+    # @return [String] 
+    def table_name_prefix 
+      @table_name_prefix ||= 'gricer_'
+    end
+    
+    # Configure the prefix for admin pages paths
+    #
+    # Default value is 'gricer'    
+    # @return [String] 
+    def admin_prefix
+      @admin_prefix.blank? ? 'gricer' : @admin_prefix
+    end
+    
+    # Configure to use another layout than the application default for Gricer controllers
+    #
+    # Default value is nil
+    # @return [String] 
+    def admin_layout 
+      @admin_layout
+    end
+    
+    # Configure the structure of Gricer's admin menu
+    #
+    # Default value see source
+    # @return [Array] 
+    def admin_menu 
+      @admin_menu ||= [
+        ['Overview', :dashboard, {controller: 'gricer/dashboard', action: 'overview'}],
+        ['Visitors', :menu, [
+          ['Entry Pages', :spread, {controller: 'gricer/requests', action: 'spread_stats', field: 'entry_path'}],
+          ['Referers', :spread, {controller: 'gricer/requests', action: 'spread_stats', field: 'referer_host'}],
+          ['Search Engines', :spread, {controller: 'gricer/requests', action: 'spread_stats', field: 'search_engine'}],
+          ['Search Terms', :spread, {controller: 'gricer/requests', action: 'spread_stats', field: 'search_query'}],
+          ['Countries', :spread, {controller: 'gricer/sessions', action: 'spread_stats', field: 'country'}],
+          ['Domains', :spread, {controller: 'gricer/sessions', action: 'spread_stats', field: 'domain'}],
+          ['Locales', :spread, {controller: 'gricer/sessions', action: 'spread_stats', field: 'requested_locale_major'}]
+        ] ],
+        ['Pages', :menu, [
+          ['Views', :spread, {controller: 'gricer/requests', action: 'spread_stats', field: 'path'}],
+          ['Hosts', :spread, {controller: 'gricer/requests', action: 'spread_stats', field: 'host'}],
+          ['Methods', :spread, {controller: 'gricer/requests', action: 'spread_stats', field: 'method'}],
+          ['Protocols', :spread, {controller: 'gricer/requests', action: 'spread_stats', field: 'protocol'}],
+        ] ],
+        ['Browsers', :menu, [
+          ['Browsers', :spread, {controller: 'gricer/sessions', action: 'spread_stats', field: 'agent.name'}],
+          ['Operating Systems', :spread, {controller: 'gricer/sessions', action: 'spread_stats', field: 'agent.os'}],
+          ['Engines', :spread, {controller: 'gricer/sessions', action: 'spread_stats', field: 'agent.engine_name'}],
+          ['JavaScript', :spread, {controller: 'gricer/sessions', action: 'spread_stats', field: 'javascript'}],
+          ['Java', :spread, {controller: 'gricer/sessions', action: 'spread_stats', field: 'java'}],
+          ['Silverlight', :spread, {controller: 'gricer/sessions', action: 'spread_stats', field: 'silverlight_major_version'}],
+          ['Flash', :spread, {controller: 'gricer/sessions', action: 'spread_stats', field: 'flash_major_version'}],
+          ['Screen Size', :spread, {controller: 'gricer/sessions', action: 'spread_stats', field: 'screen_size'}],
+          ['Color Depth', :spread, {controller: 'gricer/sessions', action: 'spread_stats', field: 'screen_depth'}]
+        ] ]
+      ]
+    end
+    
+    # Configure page urls matching this Expression to be excluded from being tracked in Gricer statistics
+    # Default is to exclude the admin pages
+    # @return [Regexp] 
+    def exclude_paths 
+      @exclude_actions ||= /^#{admin_prefix}$/
+    end
+    
+    # Configure the data file used by GeoIP
+    # If you configure #geoip_db this property will be ignored.
+    #
+    # Default is no data file given.
+    # @return [String] 
+    def geoip_dat 
+      @geoip_dat
+    end
+    
+    # Configure the database instance used by GeoIP
+    #
+    # Default is none GeoIP database configured
+    # @return [GeoIP::City]
+    def geoip_db 
+      @geoip_db ||= geoip_dat ? GeoIP::City.new(geoip_dat, :index, false) : nil
+    end
+    
+    # Configure after which time of inactivity the Gricer::Session should expire
+    #
+    # Default is 15 minutes 
+    # @return [Integer] 
+    def max_session_duration 
+      @max_session_duration ||= 15.minutes
+    end
+  
+  end
+end

data/lib/gricer/engine.rb

@@ -0,0 +1,9 @@
+module Gricer
+  # The Rails Engine object for Gricer gem.
+  #
+  #
+  class Engine < Rails::Engine
+    # breaks path calls
+    # isolate_namespace Gricer
+  end
+end

data/lib/gricer/localization.rb

@@ -0,0 +1,3 @@
+require 'i18n'
+I18n.load_path += Dir.glob("#{File.dirname(__FILE__)}/../../config/locales/*.yml")
+I18n.backend.reload!

data/lib/tasks/gricer_tasks.rake

@@ -0,0 +1,92 @@
+namespace :gricer do  
+  namespace :db do
+    desc "Migrate the database through scripts in db/migrate and update db/schema.rb by invoking db:schema:dump. Target specific version with VERSION=x. Turn off output with VERBOSE=false."
+    task :migrate => [:environment, :prepare_namespace] do
+      ActiveRecord::Migration.verbose = ENV["VERBOSE"] ? ENV["VERBOSE"] == "true" : true
+      ActiveRecord::Migrator.migrate("#{File.dirname(__FILE__)}/../../db/migrate/", ENV["VERSION"] ? ENV["VERSION"].to_i : nil)
+      Rake::Task["db:schema:dump"].invoke if ActiveRecord::Base.schema_format == :ruby
+    end
+    
+    task :prepare_namespace do
+      require 'active_record'
+      puts 'prepage gricer table_name_prefix'
+      # ActiveRecord::Base.configurations = Rails::Application.config.database_configuration
+      
+      class ActiveRecord::Base
+        self.table_name_prefix = "#{::ActiveRecord::Base.table_name_prefix}#{Gricer::config.table_name_prefix}"
+      end
+    end
+    
+    task :remove_namespace do
+      puts 'remove gricer table_name_prefix'
+      
+      class ActiveRecord::Base
+        self.table_name_prefix = "#{::ActiveRecord::Base.table_name_prefix[Gricer::config.table_name_prefix.length,1000]}"
+      end
+    end
+  
+    namespace :migrate do
+      desc  'Rollbacks the database one migration and re migrate up. If you want to rollback more than one step, define STEP=x. Target specific version with VERSION=x.'
+      task :redo => [:environment, :prepare_namespace] do
+        if ENV["VERSION"]
+          Rake::Task["gricer:db:migrate:down"].invoke
+          Rake::Task["gricer:db:migrate:up"].invoke
+        else
+          Rake::Task["gricer:db:rollback"].invoke
+          Rake::Task["gricer:db:migrate"].invoke
+        end
+      end
+
+      desc 'Runs the "up" for a given migration VERSION.'
+      task :up => [:environment, :prepare_namespace] do
+        version = ENV["VERSION"] ? ENV["VERSION"].to_i : nil
+        raise "VERSION is required" unless version
+        ActiveRecord::Migrator.run(:up, "#{File.dirname(__FILE__)}/../../db/migrate/", version)
+        Rake::Task["db:schema:dump"].invoke if ActiveRecord::Base.schema_format == :ruby
+      end
+
+      desc 'Runs the "down" for a given migration VERSION.'
+      task :down => [:environment, :prepare_namespace] do
+        version = ENV["VERSION"] ? ENV["VERSION"].to_i : nil
+        raise "VERSION is required" unless version
+        ActiveRecord::Migrator.run(:down, "#{File.dirname(__FILE__)}/../../db/migrate/", version)
+        Rake::Task["db:schema:dump"].invoke if ActiveRecord::Base.schema_format == :ruby
+      end
+    end
+
+    desc 'Rolls the schema back to the previous version. Specify the number of steps with STEP=n'
+    task :rollback => [:environment, :prepare_namespace] do
+      step = ENV['STEP'] ? ENV['STEP'].to_i : 1
+      ActiveRecord::Migrator.rollback("#{File.dirname(__FILE__)}/../../db/migrate/", step)
+      Rake::Task["db:schema:dump"].invoke if ActiveRecord::Base.schema_format == :ruby
+    end
+
+    desc 'Pushes the schema to the next version. Specify the number of steps with STEP=n'
+    task :forward => [:environment, :prepare_namespace] do
+      step = ENV['STEP'] ? ENV['STEP'].to_i : 1
+      ActiveRecord::Migrator.forward("#{File.dirname(__FILE__)}/../../db/migrate/", step)
+      Rake::Task["db:schema:dump"].invoke if ActiveRecord::Base.schema_format == :ruby
+    end
+
+    desc "Retrieves the current schema version number"
+    task :version => [:environment, :prepare_namespace] do
+      puts "Current version: #{ActiveRecord::Migrator.current_version}"
+    end
+
+    desc "Raises an error if there are pending migrations"
+    task :abort_if_pending_migrations => [:environment, :prepare_namespace] do
+      if defined? ActiveRecord
+        pending_migrations = ActiveRecord::Migrator.new(:up, "#{File.dirname(__FILE__)}/../../db/migrate/").pending_migrations
+        if pending_migrations.any?
+          puts "You have #{pending_migrations.size} pending migrations:"
+          pending_migrations.each do |pending_migration|
+            puts '  %4d %s' % [pending_migration.version, pending_migration.name]
+          end
+          abort %{Run "rake gricer:db:migrate" to update your database then try again.}
+        end
+      end
+    end
+  end
+end
+
+task :'db:migrate' => [:'gricer:db:migrate', :'gricer:db:remove_namespace']

data/spec/controllers/gricer/base_controller_spec.rb

@@ -0,0 +1,207 @@
+require 'spec_helper'
+
+describe Gricer::BaseController do  
+  context 'process_stats' do
+    let(:collection) { mock_model('MyStatClass') }
+    
+    before do
+      controller.params = {
+        field: 'my_field',
+        filters: nil,
+        from: '2011-04-01',
+        thru: '2011-04-05'
+      }
+      controller.send(:guess_from_thru)
+      controller.stub(:basic_collection) {collection}
+ 
+      controller.stub(:url_for).with(action: "spread_stats", field: 'my_field', filters: nil, only_path: true) { 'my_alt_url' }
+            
+      collection.stub(:stat) { {some: :values} }
+    end
+    
+    it 'should render ajax' do
+      controller.stub(:render).with(json: {
+        alternatives: [
+          {type: "spread", uri: "my_alt_url"}, 
+          {type: "process"}
+        ], 
+        from: 1301608800000, 
+        thru: 1301954400000, 
+        step: 3600000, 
+        data: {some: :values}
+      })
+      
+      controller.send(:process_stats)
+    end
+    
+    it 'should render ajax with filter' do
+      controller.stub(:url_for).with(action: "spread_stats", field: 'my_field', filters: {"filter"=>"some_value"}, only_path: true) { 'my_filtered_alt_url' }
+      
+      controller.params[:filters] = {'filter' => 'some_value'}
+      
+      controller.stub(:render).with(json: {
+        alternatives: [
+          {type: "spread", uri: "my_filtered_alt_url"}, 
+          {type: "process"}
+        ], 
+        from: 1301608800000, 
+        thru: 1301954400000, 
+        step: 3600000, 
+        data: {some: :values}
+      })
+      
+      controller.send(:process_stats)
+    end
+    
+    it 'should render ajax with further details' do
+      controller.stub(:further_details) { {'my_field' => 'my_detail_field'} }
+      controller.stub(:url_for).with({:action=>"process_stats", :field=>"my_detail_field", :filters=>{"my_field"=>"%{self}"}, :only_path=>true}) {'my_detail_url'}
+      
+      controller.stub(:render).with(json: {
+        alternatives: [
+          {type: "spread", uri: "my_alt_url"}, 
+          {type: "process"}
+        ], 
+        from: 1301608800000, 
+        thru: 1301954400000, 
+        step: 3600000, 
+        data: {some: :values},
+        detail_uri: 'my_detail_url'
+      })
+      
+      controller.send(:process_stats)
+    end
+  end
+  
+  context 'spread_stats' do
+    let(:collection) { mock_model('MyStatClass') }
+    let(:items) { {some: :values} }
+    
+    before do
+      controller.params = {
+        field: 'my_field',
+        filters: nil,
+        from: '2011-04-01',
+        thru: '2011-04-05'
+      }
+      controller.send(:guess_from_thru)
+      controller.stub(:basic_collection) {collection}
+ 
+      controller.stub(:url_for).with(action: "process_stats", field: 'my_field', filters: nil, only_path: true) { 'my_alt_url' }
+            
+      collection.stub(:between_dates) { items }
+      items.stub(:count).with(:id) { 42 }
+      items.stub(:count_by).with('my_field') { [['Item 1', 23], ['Item 2', 19]]}
+    end
+    
+    it 'should render ajax' do
+      controller.stub(:render).with(json: {
+        alternatives: [
+          {type: "spread"}, 
+          {type: "process", uri: "my_alt_url"}
+        ], 
+        from: 1301608800000, 
+        thru: 1301954400000, 
+        total: 42, 
+        data: [["Item 1", 23], ["Item 2", 19]]
+      })
+      
+      controller.send(:spread_stats)
+    end
+    
+    it 'should render ajax with filter' do
+      controller.stub(:url_for).with(action: "process_stats", field: 'my_field', filters: {"filter"=>"some_value"}, only_path: true) { 'my_filtered_alt_url' }
+      
+      controller.params[:filters] = {'filter' => 'some_value'}
+      
+      controller.stub(:render).with(json: {
+        alternatives: [
+          {type: "spread"}, 
+          {type: "process", uri: "my_filtered_alt_url"}
+        ], 
+        from: 1301608800000, 
+        thru: 1301954400000, 
+        total: 42, 
+        data: [["Item 1", 23], ["Item 2", 19]]
+      })
+      
+      controller.send(:spread_stats)
+    end
+    
+    it 'should render ajax with further details' do
+      controller.stub(:further_details) { {'my_field' => 'my_detail_field'} }
+      controller.stub(:url_for).with({:action=>"spread_stats", :field=>"my_detail_field", :filters=>{"my_field"=>"%{self}"}, :only_path=>true}) {'my_detail_url'}
+      
+      controller.stub(:render).with(json: {
+        alternatives: [
+          {type: "spread"}, 
+          {type: "process", uri: "my_alt_url"}
+        ], 
+        from: 1301608800000, 
+        thru: 1301954400000, 
+        total: 42, 
+        data: [["Item 1", 23], ["Item 2", 19]],
+        detail_uri: 'my_detail_url'
+      })
+      
+      controller.send(:spread_stats)
+    end 
+  end
+  
+  context 'basic_collection' do
+    it 'should raise error (as it has to be implemented in child classes)' do
+      proc{ controller.send(:basic_collection) }.should raise_error('basic_collection must be defined')
+    end
+  end
+  
+  context 'handle_special_fields' do
+    it 'should do nothing' do
+      controller.send(:handle_special_fields).should be_nil
+    end
+  end
+  
+  context 'further_details' do
+    it 'should return empty hash' do
+      controller.send(:further_details).should == {}
+    end
+  end
+  
+  context 'guess_from_thru' do
+    it 'should assign sane values' do
+      Time.stub(:now) {'2011-04-01 12:42:23'.to_time}
+      
+      controller.send(:guess_from_thru)
+      assigns[:stat_from].should == '2011-03-25'.to_date
+      assigns[:stat_thru].should == '2011-03-31'.to_date
+      assigns[:stat_step].should == 1.hour
+    end
+    
+    it 'should assign given values' do
+      controller.params[:from] = '2010-06-15'
+      controller.params[:thru] = '2011-06-15'
+      
+      controller.send(:guess_from_thru)
+      assigns[:stat_from].should == '2010-06-15'.to_date
+      assigns[:stat_thru].should == '2011-06-15'.to_date
+      assigns[:stat_step].should == 1.day
+    end
+    
+    it 'should assign sane values with from given' do
+      controller.params[:from] = '2011-03-15'
+      
+      controller.send(:guess_from_thru)
+      assigns[:stat_from].should == '2011-03-15'.to_date
+      assigns[:stat_thru].should == '2011-03-21'.to_date
+      assigns[:stat_step].should == 1.hour
+    end
+
+    it 'should assign sane values with from thru' do
+      controller.params[:thru] = '2009-08-15'
+      
+      controller.send(:guess_from_thru)
+      assigns[:stat_from].should == '2009-08-09'.to_date
+      assigns[:stat_thru].should == '2009-08-15'.to_date
+      assigns[:stat_step].should == 1.hour
+    end
+  end
+end

data/spec/controllers/gricer/capture_controller_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe Gricer::CaptureController do
+  context 'index' do
+    it 'should handle proper request' do
+      gricer_session = mock_model(Gricer::Session)
+      gricer_request = mock_model(Gricer::Request, session: gricer_session)
+      controller.stub(:session) { { gricer_session: 42 } }
+      Gricer::Session.should_receive(:find_by_id).with(42) { gricer_session }
+      Gricer::Request.should_receive(:find_by_id).with('23') { gricer_request }
+      
+      gricer_session.should_receive(:javascript=).with(true)
+      gricer_session.should_receive(:java=).with('true')
+      gricer_session.should_receive(:flash_version=).with('10.0 r45')
+      gricer_session.should_receive(:silverlight_version=).with('4.0.51204.0')
+      gricer_session.should_receive(:screen_width=).with('1024')
+      gricer_session.should_receive(:screen_height=).with('768')
+      gricer_session.should_receive(:screen_size=).with('1024x768')
+      gricer_session.should_receive(:screen_depth=).with('8')
+
+      gricer_session.should_receive(:save) { true }
+      
+      gricer_request.should_receive(:javascript=).with(true)
+      gricer_request.should_receive(:window_width=).with('800')
+      gricer_request.should_receive(:window_height=).with('600')
+  
+      gricer_request.should_receive(:save) { true }    
+      
+      xhr(
+        :post, 
+        :index, 
+        id: '23',
+        f: '10.0 r45',
+        j: 'true',
+        sl: '4.0.51204.0',
+        sx: '1024', 
+        sy: '768', 
+        sd: '8', 
+        wx: '800',
+        wy: '600'
+      )
+    end
+  end
+end