Merge branch 'analytics-plugin' into 'master'

Analytics plugin See merge request !632

Merge branch 'analytics-plugin' into 'master'
Analytics plugin See merge request !632
Braulio Bhavamitra
2 parents c2f481ce 4aee1457
Showing 15 changed files with 489 additions and 0 deletions Show diff stats
config/initializers/unicorn.rb
lib/noosfero/scheduler/defer.rb
plugins/analytics/controllers/profile/analytics_plugin/time_on_page_controller.rb
plugins/analytics/db/migrate/20150715001149_init_analytics_plugin.rb
plugins/analytics/lib/analytics_plugin.rb
plugins/analytics/lib/analytics_plugin/base.rb
plugins/analytics/lib/ext/profile.rb
plugins/analytics/locales/en.yml
plugins/analytics/locales/pt.yml
plugins/analytics/models/analytics_plugin/page_view.rb
plugins/analytics/models/analytics_plugin/visit.rb
plugins/analytics/po/pt/analytics.po
plugins/analytics/public/javascripts/analytics.js
plugins/analytics/test/functional/content_viewer_controller_test.rb
plugins/analytics/views/analytics_plugin/_body_ending.html.slim
@@ -0,0 +1,8 @@
+require_dependency 'scheduler/defer'
+
+if defined? Unicorn
+  ObjectSpace.each_object Unicorn::HttpServer do |s|
+    s.extend Scheduler::Defer::Unicorn
+  end
+end
+
@@ -0,0 +1,95 @@
+# based on https://github.com/discourse/discourse/blob/master/lib/scheduler/defer.rb
+
+module Scheduler
+  module Deferrable
+    def initialize
+      # FIXME: do some other way when not using Unicorn
+      @async = (not Rails.env.test?) and defined? Unicorn
+      @queue = Queue.new
+      @mutex = Mutex.new
+      @paused = false
+      @thread = nil
+    end
+
+    def pause
+      stop!
+      @paused = true
+    end
+
+    def resume
+      @paused = false
+    end
+
+    # for test
+    def async= val
+      @async = val
+    end
+
+    def later desc = nil, &blk
+      if @async
+        start_thread unless (@thread && @thread.alive?) || @paused
+        @queue << [blk, desc]
+      else
+        blk.call
+      end
+    end
+
+    def stop!
+      @thread.kill if @thread and @thread.alive?
+      @thread = nil
+    end
+
+    # test only
+    def stopped?
+      !(@thread and @thread.alive?)
+    end
+
+    def do_all_work
+      while !@queue.empty?
+        do_work _non_block=true
+      end
+    end
+
+    private
+
+    def start_thread
+      @mutex.synchronize do
+        return if @thread && @thread.alive?
+        @thread = Thread.new do
+          while true
+            do_work
+          end
+        end
+        @thread.priority = -2
+      end
+    end
+
+    # using non_block to match Ruby #deq
+    def do_work non_block=false
+      job, desc = @queue.deq non_block
+      begin
+        job.call
+      rescue => ex
+        ExceptionNotifier.notify_exception ex, message: "Running deferred code '#{desc}'"
+      end
+    rescue => ex
+      ExceptionNotifier.notify_exception ex, message: "Processing deferred code queue"
+    end
+  end
+
+  class Defer
+
+    module Unicorn
+      def process_client client
+        ::Scheduler::Defer.pause
+        super client
+        ::Scheduler::Defer.do_all_work
+        ::Scheduler::Defer.resume
+      end
+    end
+
+    extend Deferrable
+    initialize
+  end
+
+end
@@ -0,0 +1,30 @@
+class AnalyticsPlugin::TimeOnPageController < ProfileController
+
+  before_filter :skip_page_view
+
+  def page_load
+    # to avoid concurrency problems with the original deferred request, also defer this
+    Scheduler::Defer.later do
+      page_view = profile.page_views.where(request_id: params[:id]).first
+      page_view.request = request
+      page_view.page_load!
+    end
+
+    render nothing: true
+  end
+
+  def report
+    page_view = profile.page_views.where(request_id: params[:id]).first
+    page_view.request = request
+    page_view.increase_time_on_page!
+
+    render nothing: true
+  end
+
+  protected
+
+  def skip_page_view
+    @analytics_skip_page_view = true
+  end
+
+end
@@ -0,0 +1,47 @@
+class InitAnalyticsPlugin < ActiveRecord::Migration
+
+  def up
+    create_table :analytics_plugin_visits do |t|
+      t.integer :profile_id
+    end
+
+    create_table :analytics_plugin_page_views do |t|
+      t.string :type
+      t.integer :visit_id
+      t.integer :track_id
+      t.integer :referer_page_view_id
+      t.string :request_id
+
+      t.integer :user_id
+      t.integer :session_id
+      t.integer :profile_id
+
+      t.text :url
+      t.text :referer_url
+
+      t.text :user_agent
+      t.string :remote_ip
+
+      t.datetime :request_started_at
+      t.datetime :request_finished_at
+      t.datetime :page_loaded_at
+      t.integer :time_on_page, default: 0
+
+      t.text :data, default: {}.to_yaml
+    end
+    add_index :analytics_plugin_page_views, :request_id
+    add_index :analytics_plugin_page_views, :referer_page_view_id
+
+    add_index :analytics_plugin_page_views, :user_id
+    add_index :analytics_plugin_page_views, :session_id
+    add_index :analytics_plugin_page_views, :profile_id
+    add_index :analytics_plugin_page_views, :url
+    add_index :analytics_plugin_page_views, [:user_id, :session_id, :profile_id, :url], name: :analytics_plugin_referer_find
+  end
+
+  def down
+    drop_table :analytics_plugin_visits
+    drop_table :analytics_plugin_page_views
+  end
+
+end
@@ -0,0 +1,15 @@
+module AnalyticsPlugin
+
+  TimeOnPageUpdateInterval = 2.minutes * 1000
+
+  extend Noosfero::Plugin::ParentMethods
+
+  def self.plugin_name
+    I18n.t'analytics_plugin.lib.plugin.name'
+  end
+
+  def self.plugin_description
+    I18n.t'analytics_plugin.lib.plugin.description'
+  end
+
+end
@@ -0,0 +1,43 @@
+
+class AnalyticsPlugin::Base < Noosfero::Plugin
+
+  def body_ending
+    return unless profile and profile.analytics_enabled?
+    lambda do
+      render 'analytics_plugin/body_ending'
+    end
+  end
+
+  def js_files
+    ['analytics'].map{ |j| "javascripts/#{j}" }
+  end
+
+  def application_controller_filters
+    [{
+      type: 'around_filter', options: {}, block: -> &block do
+        request_started_at = Time.now
+        block.call
+        request_finished_at = Time.now
+
+        return if @analytics_skip_page_view
+        return unless profile and profile.analytics_enabled?
+
+        Scheduler::Defer.later 'analytics: register page view' do
+          page_view = profile.page_views.build request: request, profile_id: profile,
+            request_started_at: request_started_at, request_finished_at: request_finished_at
+
+          unless profile.analytics_anonymous?
+            # FIXME: use session.id in Rails 4
+            session_id = Marshal.load(Base64.decode64 request['_session_id'])['session_id'] rescue nil
+            #session_id = request.session_options[:id]
+            page_view.user = user
+            page_view.session_id = session_id
+          end
+
+          page_view.save!
+        end
+      end,
+    }]
+  end
+
+end
@@ -0,0 +1,30 @@
+require_dependency 'profile'
+require_dependency 'community'
+
+([Profile] + Profile.descendants).each do |subclass|
+subclass.class_eval do
+
+  has_many :visits, foreign_key: :profile_id, class_name: 'AnalyticsPlugin::Visit'
+  has_many :page_views, foreign_key: :profile_id, class_name: 'AnalyticsPlugin::PageView'
+
+end
+end
+
+class Profile
+
+  def analytics_settings attrs = {}
+    @analytics_settings ||= Noosfero::Plugin::Settings.new self, AnalyticsPlugin, attrs
+    attrs.each{ |a, v| @analytics_settings.send "#{a}=", v }
+    @analytics_settings
+  end
+  alias_method :analytics_settings=, :analytics_settings
+
+  def analytics_enabled?
+    self.analytics_settings.enabled
+  end
+
+  def analytics_anonymous?
+    self.analytics_settings.anonymous
+  end
+
+end
@@ -0,0 +1,11 @@
+
+en: &en
+  analytics_plugin:
+    lib:
+      plugin:
+        name: 'Access tracking'
+        description: 'Register the access of selected profiles'
+
+en-US:
+  <<: *en
+
@@ -0,0 +1,10 @@
+
+pt: &pt
+  analytics_plugin:
+    lib:
+      plugin:
+        name: 'Rastreio de accesso'
+        description: 'Registra o acesso de perfis selecionados'
+
+pt-BR:
+  <<: *pt
@@ -0,0 +1,67 @@
+class AnalyticsPlugin::PageView < ActiveRecord::Base
+
+  serialize :data
+
+  attr_accessible *self.column_names
+  attr_accessible :user, :profile
+
+  attr_accessor :request
+  attr_accessible :request
+
+  acts_as_having_settings field: :options
+
+  belongs_to :visit, class_name: 'AnalyticsPlugin::Visit'
+  belongs_to :referer_page_view, class_name: 'AnalyticsPlugin::PageView'
+
+  belongs_to :user, class_name: 'Person'
+  belongs_to :session, primary_key: :session_id, foreign_key: :session_id, class_name: 'Session'
+  belongs_to :profile
+
+  validates_presence_of :visit
+  validates_presence_of :request, on: :create
+  validates_presence_of :url
+
+  before_validation :extract_request_data, on: :create
+  before_validation :fill_referer_page_view, on: :create
+  before_validation :fill_visit, on: :create
+
+  def request_duration
+    self.request_finished_at - self.request_started_at
+  end
+
+  def page_load!
+    self.page_loaded_at = Time.now
+    self.update_column :page_loaded_at, self.page_loaded_at
+  end
+
+  def increase_time_on_page!
+    now = Time.now
+    initial_time = self.page_loaded_at || self.request_finished_at
+    return unless now > initial_time
+
+    self.time_on_page = now - initial_time
+    self.update_column :time_on_page, self.time_on_page
+  end
+
+  protected
+
+  def extract_request_data
+    self.url = self.request.url.sub /\/+$/, ''
+    self.referer_url = self.request.referer
+    self.user_agent = self.request.headers['User-Agent']
+    self.request_id = self.request.env['action_dispatch.request_id']
+    self.remote_ip = self.request.remote_ip
+  end
+
+  def fill_referer_page_view
+    self.referer_page_view = AnalyticsPlugin::PageView.order('request_started_at DESC').
+      where(url: self.referer_url, session_id: self.session_id, user_id: self.user_id, profile_id: self.profile_id).first if self.referer_url.present?
+  end
+
+  def fill_visit
+    self.visit = self.referer_page_view.visit if self.referer_page_view
+    self.visit ||= AnalyticsPlugin::Visit.new profile: profile
+  end
+
+end
+
@@ -0,0 +1,11 @@
+class AnalyticsPlugin::Visit < ActiveRecord::Base
+
+  attr_accessible *self.column_names
+  attr_accessible :profile
+
+  default_scope -> { includes :page_views }
+
+  belongs_to :profile
+  has_many :page_views, class_name: 'AnalyticsPlugin::PageView', dependent: :destroy
+
+end
@@ -0,0 +1,29 @@
+# translation of analytic.po to portuguese
+# Krishnamurti Lelis Lima Vieira Nunes <krishna@colivre.coop.br>, 2007.
+# noosfero - Brazilian Portuguese translation
+# Copyright (C) 2007,
+# Forum Brasileiro de Economia Solidaria <http://www.fbes.org.br/>
+# Copyright (C) 2007,
+# Ynternet.org Foundation <http://www.ynternet.org/>
+# This file is distributed under the same license as noosfero itself.
+# Joenio Costa <joenio@colivre.coop.br>, 2008.
+#
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: 1.0-690-gcb6e853\n"
+"POT-Creation-Date: 2015-03-05 12:10-0300\n"
+"PO-Revision-Date: 2015-07-21 09:23-0300\n"
+"Last-Translator: Michal Čihař <michal@cihar.com>\n"
+"Language-Team: Portuguese <https://hosted.weblate.org/projects/noosfero"
+"/plugin-solr/pt/>\n"
+"Language: pt\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=2; plural=n != 1;\n"
+"X-Generator: Weblate 2.3-dev\n"
+
+msgid "Select the set of communities and users to track"
+msgstr "Seleciona o conjunto de comunidades e usuários para rastrear"
+
@@ -0,0 +1,39 @@
+analytics = {
+  requestId: '',
+
+  timeOnPage: {
+    updateInterval: 0,
+    baseUrl: '',
+
+    report: function() {
+      $.ajax(analytics.timeOnPage.baseUrl+'/report', {
+        type: 'POST', data: {id: analytics.requestId},
+        success: function(data) {
+
+          analytics.timeOnPage.poll()
+        },
+      })
+    },
+
+    poll: function() {
+      if (analytics.timeOnPage.updateInterval)
+        setTimeout(analytics.timeOnPage.report, analytics.timeOnPage.updateInterval)
+    },
+  },
+
+  init: function() {
+    analytics.timeOnPage.poll()
+  },
+
+  pageLoad: function() {
+    $.ajax(analytics.timeOnPage.baseUrl+'/page_load', {
+      type: 'POST', data: {id: analytics.requestId},
+      success: function(data) {
+      },
+    });
+  }
+
+};
+
+$(document).ready(analytics.pageLoad)
+
@@ -0,0 +1,48 @@
+require 'test_helper'
+require 'content_viewer_controller'
+
+class ContentViewerControllerTest < ActionController::TestCase
+
+  def setup
+    @controller = ContentViewerController.new
+    @request    = ActionController::TestRequest.new
+    @response   = ActionController::TestResponse.new
+
+    @environment = Environment.default
+    @environment.enabled_plugins += ['AnalyticsPlugin']
+    @environment.save!
+
+    @user = create_user('testinguser').person
+    login_as @user.identifier
+
+    @community = build Community, identifier: 'testcomm', name: 'test'
+    @community.analytics_settings.enabled = true
+    @community.analytics_settings.anonymous = false
+    @community.save!
+    @community.add_member @user
+  end
+
+  should 'register page view correctly' do
+    @request.env['HTTP_REFERER'] = 'http://google.com'
+    first_url = 'http://test.host'
+    get :view_page, profile: @community.identifier, page: []
+    assert_equal 1, @community.page_views.count
+    assert_equal 1, @community.visits.count
+
+    first_page_view = @community.page_views.order(:id).first
+    assert_equal @request.referer, first_page_view.referer_url
+
+    @request.env['HTTP_REFERER'] = first_url
+    get :view_page, profile: @community.identifier, page: @community.articles.last.path.split('/')
+    assert_equal 2, @community.page_views.count
+    assert_equal 1, @community.visits.count
+
+    second_page_view = @community.page_views.order(:id).last
+    assert_equal first_page_view, second_page_view.referer_page_view
+
+    assert_equal @user, second_page_view.user
+
+    assert second_page_view.request_duration > 0 and second_page_view.request_duration < 1
+  end
+
+end
@@ -0,0 +1,6 @@
+javascript:
+  analytics.timeOnPage.baseUrl = #{url_for(controller: 'analytics_plugin/time_on_page').to_json}
+  analytics.timeOnPage.updateInterval = #{AnalyticsPlugin::TimeOnPageUpdateInterval.to_json}
+  analytics.requestId = #{request.env['action_dispatch.request_id'].to_json}
+  analytics.init()
+
...	...	@@ -0,0 +1,8 @@
	1	+require_dependency 'scheduler/defer'
	2	+
	3	+if defined? Unicorn
	4	+ ObjectSpace.each_object Unicorn::HttpServer do \|s\|
	5	+ s.extend Scheduler::Defer::Unicorn
	6	+ end
	7	+end
	8	+
...	...
...	...	@@ -0,0 +1,95 @@
	1	+# based on https://github.com/discourse/discourse/blob/master/lib/scheduler/defer.rb
	2	+
	3	+module Scheduler
	4	+ module Deferrable
	5	+ def initialize
	6	+ # FIXME: do some other way when not using Unicorn
	7	+ @async = (not Rails.env.test?) and defined? Unicorn
	8	+ @queue = Queue.new
	9	+ @mutex = Mutex.new
	10	+ @paused = false
	11	+ @thread = nil
	12	+ end
	13	+
	14	+ def pause
	15	+ stop!
	16	+ @paused = true
	17	+ end
	18	+
	19	+ def resume
	20	+ @paused = false
	21	+ end
	22	+
	23	+ # for test
	24	+ def async= val
	25	+ @async = val
	26	+ end
	27	+
	28	+ def later desc = nil, &blk
	29	+ if @async
	30	+ start_thread unless (@thread && @thread.alive?) \|\| @paused
	31	+ @queue << [blk, desc]
	32	+ else
	33	+ blk.call
	34	+ end
	35	+ end
	36	+
	37	+ def stop!
	38	+ @thread.kill if @thread and @thread.alive?
	39	+ @thread = nil
	40	+ end
	41	+
	42	+ # test only
	43	+ def stopped?
	44	+ !(@thread and @thread.alive?)
	45	+ end
	46	+
	47	+ def do_all_work
	48	+ while !@queue.empty?
	49	+ do_work _non_block=true
	50	+ end
	51	+ end
	52	+
	53	+ private
	54	+
	55	+ def start_thread
	56	+ @mutex.synchronize do
	57	+ return if @thread && @thread.alive?
	58	+ @thread = Thread.new do
	59	+ while true
	60	+ do_work
	61	+ end
	62	+ end
	63	+ @thread.priority = -2
	64	+ end
	65	+ end
	66	+
	67	+ # using non_block to match Ruby #deq
	68	+ def do_work non_block=false
	69	+ job, desc = @queue.deq non_block
	70	+ begin
	71	+ job.call
	72	+ rescue => ex
	73	+ ExceptionNotifier.notify_exception ex, message: "Running deferred code '#{desc}'"
	74	+ end
	75	+ rescue => ex
	76	+ ExceptionNotifier.notify_exception ex, message: "Processing deferred code queue"
	77	+ end
	78	+ end
	79	+
	80	+ class Defer
	81	+
	82	+ module Unicorn
	83	+ def process_client client
	84	+ ::Scheduler::Defer.pause
	85	+ super client
	86	+ ::Scheduler::Defer.do_all_work
	87	+ ::Scheduler::Defer.resume
	88	+ end
	89	+ end
	90	+
	91	+ extend Deferrable
	92	+ initialize
	93	+ end
	94	+
	95	+end
...	...
...	...	@@ -0,0 +1,30 @@
	1	+class AnalyticsPlugin::TimeOnPageController < ProfileController
	2	+
	3	+ before_filter :skip_page_view
	4	+
	5	+ def page_load
	6	+ # to avoid concurrency problems with the original deferred request, also defer this
	7	+ Scheduler::Defer.later do
	8	+ page_view = profile.page_views.where(request_id: params[:id]).first
	9	+ page_view.request = request
	10	+ page_view.page_load!
	11	+ end
	12	+
	13	+ render nothing: true
	14	+ end
	15	+
	16	+ def report
	17	+ page_view = profile.page_views.where(request_id: params[:id]).first
	18	+ page_view.request = request
	19	+ page_view.increase_time_on_page!
	20	+
	21	+ render nothing: true
	22	+ end
	23	+
	24	+ protected
	25	+
	26	+ def skip_page_view
	27	+ @analytics_skip_page_view = true
	28	+ end
	29	+
	30	+end
...	...
...	...	@@ -0,0 +1,47 @@
	1	+class InitAnalyticsPlugin < ActiveRecord::Migration
	2	+
	3	+ def up
	4	+ create_table :analytics_plugin_visits do \|t\|
	5	+ t.integer :profile_id
	6	+ end
	7	+
	8	+ create_table :analytics_plugin_page_views do \|t\|
	9	+ t.string :type
	10	+ t.integer :visit_id
	11	+ t.integer :track_id
	12	+ t.integer :referer_page_view_id
	13	+ t.string :request_id
	14	+
	15	+ t.integer :user_id
	16	+ t.integer :session_id
	17	+ t.integer :profile_id
	18	+
	19	+ t.text :url
	20	+ t.text :referer_url
	21	+
	22	+ t.text :user_agent
	23	+ t.string :remote_ip
	24	+
	25	+ t.datetime :request_started_at
	26	+ t.datetime :request_finished_at
	27	+ t.datetime :page_loaded_at
	28	+ t.integer :time_on_page, default: 0
	29	+
	30	+ t.text :data, default: {}.to_yaml
	31	+ end
	32	+ add_index :analytics_plugin_page_views, :request_id
	33	+ add_index :analytics_plugin_page_views, :referer_page_view_id
	34	+
	35	+ add_index :analytics_plugin_page_views, :user_id
	36	+ add_index :analytics_plugin_page_views, :session_id
	37	+ add_index :analytics_plugin_page_views, :profile_id
	38	+ add_index :analytics_plugin_page_views, :url
	39	+ add_index :analytics_plugin_page_views, [:user_id, :session_id, :profile_id, :url], name: :analytics_plugin_referer_find
	40	+ end
	41	+
	42	+ def down
	43	+ drop_table :analytics_plugin_visits
	44	+ drop_table :analytics_plugin_page_views
	45	+ end
	46	+
	47	+end
...	...
...	...	@@ -0,0 +1,15 @@
	1	+module AnalyticsPlugin
	2	+
	3	+ TimeOnPageUpdateInterval = 2.minutes * 1000
	4	+
	5	+ extend Noosfero::Plugin::ParentMethods
	6	+
	7	+ def self.plugin_name
	8	+ I18n.t'analytics_plugin.lib.plugin.name'
	9	+ end
	10	+
	11	+ def self.plugin_description
	12	+ I18n.t'analytics_plugin.lib.plugin.description'
	13	+ end
	14	+
	15	+end
...	...
...	...	@@ -0,0 +1,43 @@
	1	+
	2	+class AnalyticsPlugin::Base < Noosfero::Plugin
	3	+
	4	+ def body_ending
	5	+ return unless profile and profile.analytics_enabled?
	6	+ lambda do
	7	+ render 'analytics_plugin/body_ending'
	8	+ end
	9	+ end
	10	+
	11	+ def js_files
	12	+ ['analytics'].map{ \|j\| "javascripts/#{j}" }
	13	+ end
	14	+
	15	+ def application_controller_filters
	16	+ [{
	17	+ type: 'around_filter', options: {}, block: -> &block do
	18	+ request_started_at = Time.now
	19	+ block.call
	20	+ request_finished_at = Time.now
	21	+
	22	+ return if @analytics_skip_page_view
	23	+ return unless profile and profile.analytics_enabled?
	24	+
	25	+ Scheduler::Defer.later 'analytics: register page view' do
	26	+ page_view = profile.page_views.build request: request, profile_id: profile,
	27	+ request_started_at: request_started_at, request_finished_at: request_finished_at
	28	+
	29	+ unless profile.analytics_anonymous?
	30	+ # FIXME: use session.id in Rails 4
	31	+ session_id = Marshal.load(Base64.decode64 request['_session_id'])['session_id'] rescue nil
	32	+ #session_id = request.session_options[:id]
	33	+ page_view.user = user
	34	+ page_view.session_id = session_id
	35	+ end
	36	+
	37	+ page_view.save!
	38	+ end
	39	+ end,
	40	+ }]
	41	+ end
	42	+
	43	+end
...	...
...	...	@@ -0,0 +1,30 @@
	1	+require_dependency 'profile'
	2	+require_dependency 'community'
	3	+
	4	+([Profile] + Profile.descendants).each do \|subclass\|
	5	+subclass.class_eval do
	6	+
	7	+ has_many :visits, foreign_key: :profile_id, class_name: 'AnalyticsPlugin::Visit'
	8	+ has_many :page_views, foreign_key: :profile_id, class_name: 'AnalyticsPlugin::PageView'
	9	+
	10	+end
	11	+end
	12	+
	13	+class Profile
	14	+
	15	+ def analytics_settings attrs = {}
	16	+ @analytics_settings \|\|= Noosfero::Plugin::Settings.new self, AnalyticsPlugin, attrs
	17	+ attrs.each{ \|a, v\| @analytics_settings.send "#{a}=", v }
	18	+ @analytics_settings
	19	+ end
	20	+ alias_method :analytics_settings=, :analytics_settings
	21	+
	22	+ def analytics_enabled?
	23	+ self.analytics_settings.enabled
	24	+ end
	25	+
	26	+ def analytics_anonymous?
	27	+ self.analytics_settings.anonymous
	28	+ end
	29	+
	30	+end
...	...
...	...	@@ -0,0 +1,11 @@
	1	+
	2	+en: &en
	3	+ analytics_plugin:
	4	+ lib:
	5	+ plugin:
	6	+ name: 'Access tracking'
	7	+ description: 'Register the access of selected profiles'
	8	+
	9	+en-US:
	10	+ <<: *en
	11	+
...	...
...	...	@@ -0,0 +1,10 @@
	1	+
	2	+pt: &pt
	3	+ analytics_plugin:
	4	+ lib:
	5	+ plugin:
	6	+ name: 'Rastreio de accesso'
	7	+ description: 'Registra o acesso de perfis selecionados'
	8	+
	9	+pt-BR:
	10	+ <<: *pt
...	...
...	...	@@ -0,0 +1,67 @@
	1	+class AnalyticsPlugin::PageView < ActiveRecord::Base
	2	+
	3	+ serialize :data
	4	+
	5	+ attr_accessible *self.column_names
	6	+ attr_accessible :user, :profile
	7	+
	8	+ attr_accessor :request
	9	+ attr_accessible :request
	10	+
	11	+ acts_as_having_settings field: :options
	12	+
	13	+ belongs_to :visit, class_name: 'AnalyticsPlugin::Visit'
	14	+ belongs_to :referer_page_view, class_name: 'AnalyticsPlugin::PageView'
	15	+
	16	+ belongs_to :user, class_name: 'Person'
	17	+ belongs_to :session, primary_key: :session_id, foreign_key: :session_id, class_name: 'Session'
	18	+ belongs_to :profile
	19	+
	20	+ validates_presence_of :visit
	21	+ validates_presence_of :request, on: :create
	22	+ validates_presence_of :url
	23	+
	24	+ before_validation :extract_request_data, on: :create
	25	+ before_validation :fill_referer_page_view, on: :create
	26	+ before_validation :fill_visit, on: :create
	27	+
	28	+ def request_duration
	29	+ self.request_finished_at - self.request_started_at
	30	+ end
	31	+
	32	+ def page_load!
	33	+ self.page_loaded_at = Time.now
	34	+ self.update_column :page_loaded_at, self.page_loaded_at
	35	+ end
	36	+
	37	+ def increase_time_on_page!
	38	+ now = Time.now
	39	+ initial_time = self.page_loaded_at \|\| self.request_finished_at
	40	+ return unless now > initial_time
	41	+
	42	+ self.time_on_page = now - initial_time
	43	+ self.update_column :time_on_page, self.time_on_page
	44	+ end
	45	+
	46	+ protected
	47	+
	48	+ def extract_request_data
	49	+ self.url = self.request.url.sub /\/+$/, ''
	50	+ self.referer_url = self.request.referer
	51	+ self.user_agent = self.request.headers['User-Agent']
	52	+ self.request_id = self.request.env['action_dispatch.request_id']
	53	+ self.remote_ip = self.request.remote_ip
	54	+ end
	55	+
	56	+ def fill_referer_page_view
	57	+ self.referer_page_view = AnalyticsPlugin::PageView.order('request_started_at DESC').
	58	+ where(url: self.referer_url, session_id: self.session_id, user_id: self.user_id, profile_id: self.profile_id).first if self.referer_url.present?
	59	+ end
	60	+
	61	+ def fill_visit
	62	+ self.visit = self.referer_page_view.visit if self.referer_page_view
	63	+ self.visit \|\|= AnalyticsPlugin::Visit.new profile: profile
	64	+ end
	65	+
	66	+end
	67	+
...	...