gricer 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 Sven G. Brönstrup
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,84 @@
+= Gricer
+
+Web Analytics Tool for Rails 3.1
+
+== Installation
+
+* Add Gricer to your Rails application's Gemfile:
+
+    gem 'rails',     '>=3.1rc5'
+    gem 'gricer',    git: 'https://github.com/gmah/gricer.git'
+
+* Include the Gricer's CSS theme to your Rails 3 asset chain (e.g. your application.css[.scss]):
+
+    /*
+     ...
+     *= require gricer/fluid
+     ...
+     */
+     
+  If you are using jquery you may add the default theme unless you use your own jquery-ui theme:
+      
+     *= require gricer/fluid-jquery-ui
+     
+  At the moment there is only the fluid theme. More will come with the time.
+  
+* Include the Gricer's JS files to your Rails 3 asset chain (e.g. your application.js):
+    
+    //= require gricer
+    
+  For the backend you need to include jquery JS files (the jquery-ui is optional):
+    
+    //= require jquery
+    //= require jquery-ui
+    //= require jquery_ujs
+    
+* Add the Gricer's hook to your controllers (or your ApplicationController if you want to track all controllers):
+
+    class ApplicationController < ActionController::Base
+      ...
+      gricer_track_requests
+      ...
+    end
+    
+* To track values captured by javascript (Flash, Silverlight, screen resolution, ...) add to the end of your layout file:
+
+    <%= gricer_track_tag %>
+    
+* Migrate your DB:
+
+    bundle exec rake db:migrate
+    
+== Geocoding your visitors    
+    
+* If you want to geocode your visitors add geoip-c to your Gemfile:
+
+    gem 'geoip-c'
+
+* Configure Gricer to use GeoIP (e.g. in an initializer)
+    
+    require 'geoip'
+
+    Gricer.configure do |config|
+      config.geoip_db = GeoIP::City.new("#{PATH_TO_YOUR_GEOIP_DB}/GeoLiteCity.dat", :index, false)    
+    end
+    
+== API Documentation
+
+* API Documentation can be created by running 
+    rake doc:yard
+  from the Gricer project directory.
+* There is an auto-generated, up-to-the-hour online_documentation[http://gricer.org/api] of the API Documentation.
+    
+  
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. No discussion. No tests, no game. We use rspec and cucumber with associated addons.
+* Commit, do not mess with rakefile, version, or history. If you want to have your own version, thats fine. But bump your version in a seperate commit that can be ignored when pulling.
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2011 Sven G. Brönstrup. See MIT-LICENSE for details.

data/Rakefile

@@ -0,0 +1,49 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+  
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new(:cucumber)
+
+namespace :doc do 
+  RDoc::Task.new(:rdoc) do |rdoc|
+    rdoc.rdoc_dir = 'rdoc'
+    rdoc.title    = 'Gricer'
+    rdoc.options << '--line-numbers' << '--inline-source'
+    rdoc.rdoc_files.include('README.rdoc')
+    rdoc.rdoc_files.include('lib/**/*.rb')
+  end
+  
+  begin
+    require 'yard'
+  
+    YARD::Rake::YardocTask.new(:yard) do |t|
+      t.files   = ['lib/**/*.rb', 'app/**/*.rb', '-', 'README.rdoc', 'MIT-LICENSE']
+      t.options = ['--title', 'API - Gricer - Web Analytics Tool for Rails 3.1', '--private', '--protected'] 
+    end
+  rescue
+  end
+end
+
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+desc "Run RSpec and Cucumber tests"
+task :test => [:spec, :cucumber]
+task :default => :test

data/app/assets/javascripts/gricer.js.coffee

@@ -0,0 +1,85 @@
+window.Gricer =
+  getFlashVersion: ->
+    if navigator?.plugins?.length > 0
+      for r in navigator.plugins
+        if r.name.indexOf("Shockwave Flash") > -1
+          return r.description.split("Shockwave Flash ")[1]
+    else 
+      if window.ActiveXObject
+        for q in [12..2]
+          try 
+            g = new ActiveXObject "ShockwaveFlash.ShockwaveFlash." + q
+            if g
+              return q + ".0"        
+          catch p
+            # nop
+    return false
+    
+  hasJava: ->
+    if !self.screen && self.java
+      return java.awt.Toolkit.getDefaultToolkit() ? 1 : 0
+    else 
+      if navigator?.javaEnabled()
+        return navigator.javaEnabled() ? 1 : 0
+    return undefined
+    
+  getSilverlightVersion: ->
+    version = false;
+    if plugin = navigator?.plugins?["Silverlight Plug-In"]
+      version = plugin.description
+      if version == "1.0.30226.2" 
+        version = "2.0.30226.2";
+    else 
+      if window.ActiveXObject
+        try 
+          control = new ActiveXObject('AgControl.AgControl')
+          q = 1;
+          while control.IsVersionSupported(q + '.0')
+            q++;
+          
+          version = q-1
+          q = 0;
+          
+          while control.IsVersionSupported(version +'.' + q)
+              q++
+              
+          version += '.' + (q-1) + '.'
+
+          i = 10000
+          while i >= 1 
+            q=1;
+            while control.IsVersionSupported(version + (q*i))
+              q++
+            version += (q-1)
+            
+            i = i / 10
+          control = null
+        catch p
+          version = false
+        
+    return version
+    
+  getWindowSize: ->
+    if typeof( window.innerWidth ) == 'number' 
+      # Non-IE
+      return {width: window.innerWidth, height: window.innerHeight}
+    else if _ref = document.documentElement?.clientWidth
+      # IE 6+ in 'standards compliant mode'
+      return {width: document.documentElement.clientWidth, height: document.documentElement.clientHeight}
+    else if _ref = document.body?.clientWidth 
+      # IE 4 compatible
+      return {width: document.body.clientWidth, height: document.body.clientHeight}
+      
+  prepareValues: ->
+    windowsize = Gricer.getWindowSize()
+    
+    {
+      f: Gricer.getFlashVersion(),
+      j: Gricer.hasJava(),
+      sl: Gricer.getSilverlightVersion(),
+      sx: screen.width,
+      sy: screen.height,
+      sd: screen.colorDepth,
+      wx: windowsize.width,
+      wy: windowsize.height
+    }

data/app/assets/javascripts/gricer_backend_jquery.js.coffee

@@ -0,0 +1,352 @@
+#=require jquery.flot
+#=require jquery.flot.resize
+#=require jquery.flot.symbol
+#=require jquery.flot.pie
+
+$.gricer =
+  month: ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']
+
+  colors: [
+    "#5a9bd4", "#f9a65b", "#fd8c96", "#ce7058", "#f15961", "#d77eb4", 
+    "#9e67ac", "#8cd5f4", "#fede8f", "#fede8f", "#9e67ac", "#b6eea2", 
+    #"#edc240", "#afd8f8", "#cb4b4b", "#4da74d", "#9440ed"
+  ]
+  others_color: '#cccccc'
+  unknown_color: '#999999'
+  
+  last_called: $('a[data-gricer-dashboard]').first()
+
+  loading: ->
+    $('#gricer-dashboard').hide()
+    $('#gricer-container').html('<div class="loading">Loading ...</div>').show()
+    
+  formatPercentage: (value) ->
+    (value * 100).toFixed(2) + '%'
+    
+  formatDate: (value, options = {}) ->
+    return '' if not value
+    
+    if options.tb 
+      if $.datepicker != null
+        return $.datepicker.formatDate('M<br/>dd', value)
+      else
+        day = value.getDate()
+        day = '0' + day if day < 10
+        return '' + @month[value.getMonth()] + '<br/>' + day
+    else
+      if $.datepicker != undefined
+        return $.datepicker.formatDate($.datepicker.RFC_1036, value)
+      else
+        day = value.getDate()
+        day = '0' + day if day < 10
+        month = value.getMonth() + 1
+        month = '0' + month if month < 10
+        return '' + value.getFullYear() + '-' + month + '-' + day
+      
+  formatHour: (value) ->
+    return '' if not value
+
+    hour = value.getHours() 
+    hour = '0' + hour if hour < 10
+
+    return hour
+    
+  labelFor: (value) ->
+    if value == true or value == 'true'
+      return 'Yes'
+    if value == false or value == 'false'
+      return 'No'
+    if value == null or value == ''
+      return '(Unknown)'
+    
+    return value
+    
+  typeSelector: (alternatives) ->
+    container = $('<div class="type-selector">')
+    
+    for alt in alternatives
+      do(alt) ->
+        if alt.uri
+          container.append($('<a>').attr('href', alt.uri).addClass(alt.type).attr('data-gricer-' + alt.type, true).attr('data-label', alt.type).attr('data-type-selector', true).append(alt.type))
+        else
+          container.append($('<span>').addClass(alt.type).append(alt.type))
+    
+    return container
+    
+    
+  blowUpProcessFlotData: (data, from, thru, step) ->
+    output = []
+    
+    for timestamp in [from..thru+86400000] by step
+      do(timestamp) ->
+        value = 0
+        for item in data
+          do(item) ->
+            value = item[1] if item[0] == timestamp 
+        output.push [timestamp, value] 
+        
+    return output
+  
+  updateBreadcrumb: (elem) ->
+    $.gricer.last_called = $(elem)
+    
+    label = $(elem).text() || $(elem).attr('data-label')
+    
+    if $(elem).parents('#gricer-menu').length > 0
+      $('#gricer-header .path').empty()
+    else if $(elem).parents('#gricer-header .path').length > 0
+      $(elem).nextAll().remove()
+      return
+    else if $(elem).attr('data-type-selector')
+      label = $('#gricer-header .path a:last').attr('data-label')
+      $('#gricer-header .path a:last').remove()
+  
+    $('#gricer-header .path').append( $(elem).clone().attr('data-label', label).html(label) )
+  
+$('a[data-gricer-process]').live 'click', ->
+  $.gricer.loading()
+  $.gricer.updateBreadcrumb(this)
+  
+  $.getJSON $(this).attr('href'), {
+    from: $('#gricer-from-field').val()
+    thru: $('#gricer-thru-field').val()
+  }, (data) ->
+  
+    table = $('<table class="process">')
+    plot_data = []
+    
+    row = $('<tr>')
+    if data.thru-data.from == 0
+      date = new Date
+      date.setTime data.from
+      
+      row.append( $('<th>').append($.gricer.formatDate(date)) )
+    else
+      row.append( $('<th>') )
+    
+    table_step = data.step
+    table_step = 86400000 if table_step < 86400000 and data.thru-data.from > 0
+    
+    # Needs improvement for durations over a month
+    
+    for timestamp in [data.from..data.thru+86399999] by table_step
+      do(timestamp) ->
+        date = new Date
+        date.setTime timestamp
+        
+        if table_step >= 86400000
+          date_string = $.gricer.formatDate(date, {tb: (data.thru-data.from > 86400000*6)})
+        else
+          date_string = $.gricer.formatHour(date)
+
+        row.append($('<th>').append($('<span>').append date_string))
+        
+    table.append row
+
+    $('#gricer-container').html($('<div class="data">').append table)
+      
+    chart = $('<div class="flot-chart">').append $('<div id="flot-line-chart">')
+   
+    $('#gricer-container').append(chart).append($.gricer.typeSelector data.alternatives)
+  
+    i = 0
+    for key, value of data.data
+      do(key, value) ->        
+        detail_link = null
+        graph = $.gricer.colors[i]
+          
+        label = label_row = $('<td>')
+        if data.detail_uri
+          label = $('<a data-gricer-process="true"></a>').attr('href', data.detail_uri.replace('%25%7Bself%7D', encodeURI(key)))
+          label_row.append(label)
+      
+        if graph
+          label.append($('<span class="badge" style="background:' + $.gricer.colors[i] + '">'))
+        else
+          label.append($('<span class="badge">'))
+          
+        lable_text = $.gricer.labelFor key
+        label.attr('data-label', lable_text)
+        label.append(lable_text)
+      
+        row = $('<tr>').append( label_row )
+        
+        for timestamp in [data.from..data.thru+86399999] by table_step
+          do(timestamp) ->
+            count = 0
+            for item in value
+              do(item) ->
+                count += item[1] if item[0] >= timestamp and item[0] < timestamp + table_step
+            count = '' if count == 0      
+            row.append($('<td class="number">').append(count))
+        table.append(row)
+        
+        if $.gricer.colors[i]
+          plot_data.push
+            label: $.gricer.labelFor key
+            data: $.gricer.blowUpProcessFlotData value, data.from, data.thru, data.step
+            color: $.gricer.colors[i]
+            lines: 
+              show: true
+            points:
+              show: false     
+              symbol: 'cross'
+        i++
+  
+    $.plot $("#flot-line-chart"), plot_data, 
+      xaxis:
+        mode: 'time',
+        min: data.from,
+        max: data.thru+86400000
+      yaxis:
+        min: 0
+      legend:
+        show: false
+      grid:
+        color: $("#flot-line-chart").css('color')
+        borderColor: 'transparent'
+      colors: $.gricer.colors      
+        
+  return false
+  
+$('a[data-gricer-spread]').live 'click', ->
+  $.gricer.loading()
+  $.gricer.updateBreadcrumb(this)
+  
+  $.getJSON $(this).attr('href'), {
+    from: $('#gricer-from-field').val()
+    thru: $('#gricer-thru-field').val()
+  }, (data) ->
+    table = $('<table>')
+    plot_data = []
+    
+    row = $('<tr>')
+    row.append( $('<th>') )
+    row.append( $('<th>').append('Count') )
+    row.append( $('<th>').append('Percentage') )
+    table.append row
+  
+    i = 0
+    others = 0  
+    unknown = 0
+    
+    for line in data.data
+      do(line) ->
+        if line[0] == null
+          unknown += line[1]
+        else
+          detail_link = null
+          graph = data.data.length < 4 or $.gricer.colors[i] and line[1]/data.total > 0.05 
+          label = label_row = $('<td>')
+          if data.detail_uri
+            label = $('<a data-gricer-spread="true"></a>').attr('href', data.detail_uri.replace('%25%7Bself%7D', encodeURI(line[0])))
+            label_row.append(label)
+          
+          if graph
+            label.append($('<span class="badge" style="background:' + $.gricer.colors[i] + '">'))
+          else
+            label.append($('<span class="badge">'))
+          
+          label_text = $.gricer.labelFor(line[0])
+          label.attr('data-label', label_text)
+          label.append(label_text)
+                 
+          row = $('<tr>')
+          .append( label_row )
+          .append( $('<td class="number">').append(line[1]) )
+          .append( $('<td class="number">').append($.gricer.formatPercentage(line[1]/data.total)) )
+        
+          table.append row
+        
+          if graph
+            plot_data.push
+              label: $.gricer.labelFor line[0]
+              data: line[1]
+              color: $.gricer.colors[i]
+            i++
+          else
+            others += line[1]
+            
+    if others > 0
+      plot_data.push
+        label: 'Others'
+        data: others
+        color: $.gricer.others_color
+    
+    if unknown > 0   
+      plot_data.push
+        label: $.gricer.labelFor null
+        data: unknown
+        color: $.gricer.unknown_color
+        
+      row = $('<tr>')
+      .append( 
+        $('<td>')
+        .append($('<span class="badge" style="background:' + $.gricer.unknown_color + '">')) 
+        .append($.gricer.labelFor null) 
+      )
+      .append( $('<td class="number">').append(unknown) )
+      .append( $('<td class="number">').append($.gricer.formatPercentage(unknown/data.total)) )
+      
+      table.append row
+
+
+    $('#gricer-container').html($('<div class="data">').append table)
+    
+    chart = $('<div class="flot-chart">').append $('<div id="flot-pie-chart">')
+      
+    $('#gricer-container').append(chart).append($.gricer.typeSelector(data.alternatives))
+  
+    $.plot $("#flot-pie-chart"), plot_data, 
+      series:
+        pie:
+          show: true
+          stroke:
+            color: $("#flot-pie-chart").css('background-color')
+          label:
+            formatter: (label, slice) ->
+              '<div style="font-size:x-small;text-align:center;padding:2px;color:'+slice.color+';">'+label+'</div>'
+      legend:
+        show: false
+      colors: $.gricer.colors
+
+  return false
+  
+$('a[data-gricer-dashboard]').live 'click', ->
+  $.gricer.loading()
+  $.gricer.updateBreadcrumb(this)
+
+  $('#gricer-container').load $(this).attr('href'), 
+    from: $('#gricer-from-field').val()
+    thru: $('#gricer-thru-field').val()
+
+  return false
+  
+$('#gricer-menu a').live 'click', ->
+  $('#gricer-menu a.active').removeClass('active')
+  $(this).addClass('active')
+  return false
+  
+jQuery ->
+  $('#gricer-menu a:first')?.click();
+  
+  if $.datepicker != undefined
+    dates = $('#gricer-from-field, #gricer-thru-field').datepicker
+      defaultDate: "+1w"
+      changeMonth: true
+      changeYear: true
+      numberOfMonths: 1
+      dateFormat: 'yy-mm-dd'
+      maxDate: new Date
+      onSelect: (selectedDate) ->
+        if this.id == "gricer-from-field"
+          option = 'minDate'
+        else
+          option = 'maxDate'
+      
+        instance = $(this).data 'datepicker'
+        dateFormat = instance.settings.dateFormat || $.datepicker._defaults.dateFormat
+        date = $.datepicker.parseDate dateFormat, selectedDate, instance.settings 
+        dates.not(this).datepicker 'option', option, date
+      onClose: (dateText, inst) ->
+        $.gricer.last_called.click()