referer_tracking 1.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+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.md

@@ -0,0 +1,85 @@
+# RefererTracking
+
+Referer tracking is saves referrer url to session and automates better tracking of who creates models in your Rails app.
+
+Http referer_url and first_url are saved to session in controller before_filter. When creating a new model these values are
+saved to referer_trackings table.
+
+[<img src="https://secure.travis-ci.org/holli/referer_tracking.png" />](http://travis-ci.org/holli/referer_tracking)
+
+## Install
+
+```
+in /gemfile
+  gem 'referer_tracking'
+
+# Run following
+# bundle
+# bundle exec rake railties:install:migrations FROM=referer_tracking
+# rake db:migrate
+
+```
+
+## Configure
+
+```
+
+ApplicationController
+  include RefererTracking::ControllerAddons
+end
+
+OtherController
+  # This monitors saved items and creates RefererTracking items in db, enable in controllers you want it to be used
+  cache_sweeper RefererTracking::Sweeper
+end
+
+/config/initializers/referer_tracking.rb
+  # Referer tracking is enabled for these models
+  RefererTracking.add_tracking_to(User)
+  # RefererTracking.add_tracking_to(User, Messages) # for multiple models
+
+```
+
+## Extras
+
+You can add own info to referer_tracking table by creating a column in the table and in your controller giving the
+value to referer_tracking.
+
+```
+UserController
+  # Example of adding info to referer_tracking, remember to create migration to add column first
+  before_filter do |controller|
+    referer_tracking_add_info('referer_id', session[:referer_id])
+  end
+end
+
+```
+
+**Helpers include**
+
+- referer_tracking_add_info(key, value) # only set in the first time called
+- referer_tracking_set_info(key, value) # change value always
+- referer_tracking_first_request?
+- referer_tracking_get_key(key)
+
+## Inside
+
+RefererTracking::ControllerAddons creates before_filter that saves referer_information to session. Direct access
+is not recommended but possible with session[:referer_tracking]. Information is not saved for known bots.
+
+## Requirements
+
+Gem has been tested with ruby 1.8.7, 1.9.2 and Rails 3.1.
+
+[<img src="https://secure.travis-ci.org/holli/referer_tracking.png" />](http://travis-ci.org/holli/referer_tracking)
+
+
+## Support
+
+Submit suggestions or feature requests as a GitHub Issue or Pull Request. Remember to update tests. Tests are quite extensive.
+
+
+## Licence
+
+This project rocks and uses MIT-LICENSE. (http://www.opensource.org/licenses/mit-license.php)
+

data/Rakefile

@@ -0,0 +1,39 @@
+#!/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
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RefererTracking'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/assets/javascripts/referer_tracking/application.js

@@ -0,0 +1,9 @@
+// This is a manifest file that'll be compiled into including all the files listed below.
+// Add new JavaScript/Coffee code in separate files in this directory and they'll automatically
+// be included in the compiled file accessible from http://example.com/assets/application.js
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/stylesheets/referer_tracking/application.css

@@ -0,0 +1,7 @@
+/*
+ * This is a manifest file that'll automatically include all the stylesheets available in this directory
+ * and any sub-directories. You're free to add application-wide styles to this file and they'll appear at
+ * the top of the compiled file, but it's generally better to create a new file per style scope.
+ *= require_self
+ *= require_tree . 
+*/

data/app/controllers/referer_tracking/application_controller.rb

@@ -0,0 +1,4 @@
+module RefererTracking
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/referer_tracking/application_helper.rb

@@ -0,0 +1,4 @@
+module RefererTracking
+  module ApplicationHelper
+  end
+end

data/app/models/referer_tracking/referer_tracking.rb

@@ -0,0 +1,5 @@
+module RefererTracking
+  class RefererTracking < ActiveRecord::Base
+    belongs_to :trackable, :polymorphic => true
+  end
+end

data/app/views/layouts/referer_tracking/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>RefererTracking</title>
+  <%= stylesheet_link_tag    "referer_tracking/application" %>
+  <%= javascript_include_tag "referer_tracking/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+RefererTracking::Engine.routes.draw do
+end

data/db/migrate/20120119124101_create_referer_tracking_referer_trackings.rb

@@ -0,0 +1,13 @@
+class CreateRefererTrackingRefererTrackings < ActiveRecord::Migration
+  def change
+    create_table :referer_tracking_referer_trackings do |t|
+      t.integer :trackable_id
+      t.string :trackable_type
+      t.text :referer_url
+      t.text :first_url
+      t.string :user_agent
+
+      t.timestamps
+    end
+  end
+end

data/lib/referer_tracking/controller_addons.rb

@@ -0,0 +1,66 @@
+module RefererTracking::ControllerAddons
+
+  #before_filter :before_filter_referer_tracking_save_to_session
+
+  def before_filter_referer_tracking_save_to_session
+    if session[:referer_tracking].nil? && !request_is_from_a_known_bot?
+      @referer_tracking_first_request = true
+      session[:referer_tracking] = hash = Hash.new
+      request_ref = "unknown"
+      request_ref = request.headers["HTTP_REFERER"] if !request.headers["HTTP_REFERER"].blank?
+
+      hash[:referer_url] = request_ref
+      hash[:first_url] = request.url
+
+      logger.info( "REFERER_TRACKING_FIRST: ver03 (ref|first) ||| #{hash[:referer_url]} ||| #{hash[:first_url]}" )
+    end
+  end
+
+  # Add only if referer_tracking already in session and key has not been changed before
+  def referer_tracking_add_info(key, value)
+    if !session[:referer_tracking].nil? && session[:referer_tracking][key.to_sym].nil?
+      session[:referer_tracking][key.to_sym] = value
+    end
+  end
+
+  def referer_tracking_set_info(key, value)
+    if !session[:referer_tracking].nil?
+      session[:referer_tracking][key.to_sym] = value
+    end
+  end
+
+  def referer_tracking_get_info(key)
+    unless session[:referer_tracking].nil?
+      session[:referer_tracking][key.to_sym]
+    else
+      nil
+    end
+  end
+
+  def referer_tracking_first_request?
+    @referer_tracking_first_request
+  end
+
+
+  def request_is_from_a_known_bot?
+    bot_user_agents = /\b(GoogleBot|Mediapartners-Google|msnbot|TwengaBot|DigExt; DTS Agent|YandexImages)\b/i
+    request.user_agent =~ bot_user_agents
+  end
+
+  def request_is_from_a_possible_bot?
+    request.user_agent =~ /bot/i
+  end
+
+
+  def self.included(base)
+    base.class_eval do
+      before_filter :before_filter_referer_tracking_save_to_session
+      helper_method :'referer_tracking_first_request?'
+      helper_method :'referer_tracking_add_info'
+      helper_method :'referer_tracking_set_info'
+      helper_method :'referer_tracking_get_info'
+    end
+  end
+
+end
+

data/lib/referer_tracking/engine.rb

@@ -0,0 +1,5 @@
+module RefererTracking
+  class Engine < Rails::Engine
+    isolate_namespace RefererTracking
+  end
+end

data/lib/referer_tracking/sweeper.rb

@@ -0,0 +1,23 @@
+class RefererTracking::Sweeper < ActionController::Caching::Sweeper
+  def after_create(record)
+
+    if session && session["referer_tracking"]
+      ses = session["referer_tracking"]
+
+
+      ref_mod = RefererTracking::RefererTracking.new(
+          :trackable_id => record.id, :trackable_type => record.class.to_s)
+
+      ses.each_pair do |key, value|
+        ref_mod[key] = value if ref_mod.has_attribute?(key)
+      end
+
+      ref_mod[:user_agent] = request.env['HTTP_USER_AGENT']
+      ref_mod.save
+    end
+
+  rescue Exception => e
+    Rails.logger.info "RefererTracking::Sweeper.after_create problem with creating record: #{e}"
+  end
+end
+

data/lib/referer_tracking/version.rb

@@ -0,0 +1,3 @@
+module RefererTracking
+  VERSION = "1.0.0"
+end

data/lib/referer_tracking.rb

@@ -0,0 +1,27 @@
+require "referer_tracking/engine"
+require "referer_tracking/controller_addons"
+require "referer_tracking/sweeper"
+
+module RefererTracking
+
+  def self.add_tracking_to(*models_list)
+    models_list.each do |model|
+      model.class_eval do
+        include RefererTracking::TrackableModule
+      end
+    end
+
+    RefererTracking::Sweeper.class_eval do
+      observe models_list
+    end
+  end
+
+  module TrackableModule
+    def self.included(base)
+      base.class_eval do
+        has_one :referer_tracking, :class_name => "RefererTracking::RefererTracking", :as => :trackable
+      end
+    end
+  end
+  
+end

data/lib/tasks/referer_tracking_tasks.rake

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

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,9 @@
+// This is a manifest file that'll be compiled into including all the files listed below.
+// Add new JavaScript/Coffee code in separate files in this directory and they'll automatically
+// be included in the compiled file accessible from http://example.com/assets/application.js
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/test/dummy/app/assets/javascripts/users.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,7 @@
+/*
+ * This is a manifest file that'll automatically include all the stylesheets available in this directory
+ * and any sub-directories. You're free to add application-wide styles to this file and they'll appear at
+ * the top of the compiled file, but it's generally better to create a new file per style scope.
+ *= require_self
+ *= require_tree . 
+*/

data/test/dummy/app/assets/stylesheets/scaffold.css

@@ -0,0 +1,56 @@
+body { background-color: #fff; color: #333; }
+
+body, p, ol, ul, td {
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size:   13px;
+  line-height: 18px;
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a { color: #000; }
+a:visited { color: #666; }
+a:hover { color: #fff; background-color:#000; }
+
+div.field, div.actions {
+  margin-bottom: 10px;
+}
+
+#notice {
+  color: green;
+}
+
+.field_with_errors {
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+#error_explanation {
+  width: 450px;
+  border: 2px solid red;
+  padding: 7px;
+  padding-bottom: 0;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+}
+
+#error_explanation h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 5px 5px 15px;
+  font-size: 12px;
+  margin: -7px;
+  margin-bottom: 0px;
+  background-color: #c00;
+  color: #fff;
+}
+
+#error_explanation ul li {
+  font-size: 12px;
+  list-style: square;
+}