referrer_tracker 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 [name of plugin creator]
+
+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

@@ -0,0 +1,21 @@
+ReferrerTracker
+===============
+
+This plugin tracks the source of the traffic for you and also tracks the conversations happening in your rails project.
+
+Example
+=======
+
+In referrer_tracker.yml file in cofig directory -
+
+track1:
+  start_action: "home", "index" #This will set landingpage.
+  end_action: "user", "create" #This will be action of successfull conversion. user signup in this case.
+  conversion: true #if set to true, this will track the conversions.
+  conversion_rate: true #if set to true, this will also save landingpage hits, based on which conversion_rate can be calculated.
+  referreral_parameter: sr # on successfull converstion it will credit ?sr= parameter as source. If left null, credit will be given to url, the user came from.
+
+
+
+Copyright (c) 2011 [name of plugin creator], released under the MIT license
+Webonise Software Solutions.

data/Rakefile

@@ -0,0 +1,35 @@
+#require 'rake'
+#require 'rake/testtask'
+#require 'rake/rdoctask'
+#
+#desc 'Default: run unit tests.'
+#task :default => :test
+#
+#desc 'Test the referrer_tracker plugin.'
+#Rake::TestTask.new(:test) do |t|
+#  t.libs << 'lib'
+#  t.libs << 'test'
+#  t.pattern = 'test/**/*_test.rb'
+#  t.verbose = true
+#end
+#
+#desc 'Generate documentation for the referrer_tracker plugin.'
+#Rake::RDocTask.new(:rdoc) do |rdoc|
+#  rdoc.rdoc_dir = 'rdoc'
+#  rdoc.title    = 'ReferrerTracker'
+#  rdoc.options << '--line-numbers' << '--inline-source'
+#  rdoc.rdoc_files.include('README')
+#  rdoc.rdoc_files.include('lib/**/*.rb')
+#end
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "referrer_tracker"
+  gem.summary = %Q{Tracks the urls references.}
+  gem.description = %Q{It pulls in the ?ref= and ?sr= type references from urls and marks visitor comings from those urls.}
+  gem.email = "rtdp@weboniselab.com"
+  gem.authors = ["rtdp"]
+  gem.version = "0.0.1"
+end
+Jeweler::RubygemsDotOrgTasks.new

data/init.rb

@@ -0,0 +1,13 @@
+# Include hook code here
+require File.join(File.dirname(__FILE__), "lib", "referrer_tracker")
+
+#
+#load the configutraions from yml
+ReferrerTracker::Utils.load_configuration_yaml
+
+#
+# load models - ReferrerTracker model
+#
+path = File.join(File.dirname(__FILE__), 'lib', 'app', "models", "track.rb")
+$LOAD_PATH << path
+ActiveSupport::Dependencies.load_file(path)

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/app/models/track.rb

@@ -0,0 +1,3 @@
+class ReferrerTrack < ActiveRecord::Base
+
+end

data/lib/db/migrate/20110523140707_create_referrer_track_model.rb

@@ -0,0 +1,14 @@
+class CreateReferrerTrackModel < ActiveRecord::Migration
+  def self.up
+    create_table :referrer_tracks do |t|
+      t.string :source
+      t.string :track
+      t.integer :step
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :tracks
+  end
+end

data/lib/referrer_tracker/utils.rb

@@ -0,0 +1,102 @@
+module ReferrerTracker::Utils
+
+  class NotConfigured < Exception; end
+
+  class << self
+    attr_accessor :conf
+  end
+
+
+  # to give current pairs order in list of actions
+  def step
+    number = ReferrerTracker::Utils.conf[current_track]["actions"].split.find_index(current_c_a_pair)
+    number.nil? ? 0 : number+1
+  end
+
+
+  # to get value of current source value specified with referrer_parameter
+  def current_source_value
+    params[get_yml_attributes("referrer_parameter").to_s.to_sym]
+  end
+
+
+  # to get value of current source key specified with referrer_parameter
+  def current_source_key
+    get_yml_attributes("referrer_parameter").to_s.to_sym
+  end
+
+
+  # checks value for conversion rate
+  def conversion_rate?
+    get_yml_attributes("conversion_rate").first
+  end
+
+
+  #
+  # Returns array of controller-action pairs present in .yml conf file.
+  def config_actions
+    get_yml_attributes("actions").map{|i| i.split}.flatten
+  end
+
+
+  #
+  # get current track here
+  def current_track
+    result = ""
+    ReferrerTracker::Utils.conf.each_pair do |k, v|
+      if v["actions"].split.include?(current_c_a_pair) and !result.present?
+        result = k
+      end
+    end
+    result
+  end
+
+
+  #
+  # Gives current controller action pair
+  def current_c_a_pair
+     [params[:controller], params[:action]].join("#")
+  end
+
+
+  #
+  # Getter methods over module got get conf,
+  # raises NotConfigured, if nil
+  def self.conf
+    @conf || raise_unconfigured_exception
+  end
+
+
+  #
+  # NotConfigured exception rising class
+  def self.raise_unconfigured_exception
+    raise NotConfigured.new("No configuration provided for Referrer Tracker.")
+  end
+
+
+  #
+  # Loads configuration from yml file. called at application start.
+  #
+  def self.load_configuration_yaml
+    config = YAML.load(File.read(File.join(Rails.root,"config","referrer_tracker.yml")))
+    raise NotConfigured.new("Unable to load configuration for #{::Rails.env} from referrer_tracker.yml. Is it set up?") if config.nil?
+    self.conf = config#.with_indifferent_access
+  end
+
+
+  #
+  # Give Attributes from yml file
+  def get_yml_attributes(action)
+    ReferrerTracker::Utils.conf.values.map{|i| i["#{action}"]}
+  end
+
+
+  #
+  # This is to check if current referrer key is the one defined in configs.
+  #
+  #
+  def source_match?
+      params[current_source_key.to_sym].present?
+  end
+
+end

data/lib/referrer_tracker.rb

@@ -0,0 +1,34 @@
+
+class ActionController::Base
+  before_filter :notice_referrer
+end
+
+module ReferrerTracker
+  include Utils
+
+  def notice_referrer
+    if config_actions.include?(current_c_a_pair)
+      create_track_value
+    end
+  end
+
+
+  def create_track_value
+    if step==1
+      create_for_step(1, current_source_value) if conversion_rate? && source_match?
+      session[current_source_key] = current_source_value
+    end
+    if step!=1
+      create_for_step(2, session[current_source_key])
+      session[current_source_key] = nil
+    end
+  end
+
+
+  def create_for_step(step, source)
+    ReferrerTrack.create(:step => step,
+                 :track => current_track,
+                 :source => source )
+  end
+
+end

data/lib/tasks/set_up.rake

@@ -0,0 +1,29 @@
+namespace :db do
+  namespace :migrate do
+    description = "Migrate the database through scripts in vendor/plugins/referrel_tracker/lib/db/migrate"
+    description << "and update db/schema.rb by invoking db:schema:dump."
+    description << "Target specific version with VERSION=x. Turn off output with VERBOSE=false."
+
+    desc description
+    task :rt_setup => :environment do
+      ActiveRecord::Migration.verbose = ENV["VERBOSE"] ? ENV["VERBOSE"] == "true" : true
+      ActiveRecord::Migrator.migrate("vendor/plugins/referrer_tracker/lib/db/migrate/", ENV['VERSION'])
+      Rake::Task["db:migrate"].execute
+      Rake::Task["db:schema:dump"].invoke
+    end
+  end
+
+#  namespace :rollback do
+#    description = "Migrate the database through scripts in vendor/plugins/referrel_tracker/lib/db/migrate"
+#    description << "and update db/schema.rb by invoking db:schema:dump."
+#    description << "Target specific version with VERSION=x. Turn off output with VERBOSE=false."
+#
+#    desc description
+#    task :rt_rollback => :environment do
+#      ActiveRecord::Migration.verbose = ENV["VERBOSE"] ? ENV["VERBOSE"] == "true" : true
+#      ActiveRecord::Migration.migrate(Dir.glob("vendor/plugins/referrer_tracker/lib/db/migrate/*").first)
+#      Rake::Task["db:rollback"].execute
+#      Rake::Task["db:schema:dump"].invoke
+#    end
+#  end
+end

data/referrer_tracker.gemspec

@@ -0,0 +1,50 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{referrer_tracker}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["rtdp"]
+  s.date = %q{2011-06-01}
+  s.description = %q{It pulls in the ?ref= and ?sr= type references from urls and marks visitor comings from those urls.}
+  s.email = %q{rtdp@weboniselab.com}
+  s.extra_rdoc_files = [
+    "README"
+  ]
+  s.files = [
+    "MIT-LICENSE",
+    "README",
+    "Rakefile",
+    "init.rb",
+    "install.rb",
+    "lib/app/models/track.rb",
+    "lib/db/migrate/20110523140707_create_referrer_track_model.rb",
+    "lib/db/schema.rb",
+    "lib/referrer_tracker.rb",
+    "lib/referrer_tracker/utils.rb",
+    "lib/tasks/set_up.rake",
+    "referrer_tracker.gemspec",
+    "test/old_referrer_tracker.rb",
+    "test/referrer_tracker_test.rb",
+    "test/test_helper.rb",
+    "uninstall.rb"
+  ]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Tracks the urls references.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/test/old_referrer_tracker.rb

@@ -0,0 +1,86 @@
+# ReferrerTracker
+
+class ActionController::Base
+  before_filter :note_referrer
+  after_filter :save_referrer
+end
+
+
+module ReferrerTracker
+  class NotConfigured < Exception; end
+
+  class << self
+    attr_accessor :conf
+  end
+
+  def self.conf
+    @conf || raise_unconfigured_exception
+  end
+
+  def note_referrer
+    logger.info("+===========+++++++++===++++++++===++++++++====+++++===+++++=+++=+++==+++=++++=+++==+++=+++==+++==++++")
+    logger.info(params["action"])
+    logger.info(controller.inspect)
+    logger.info(ReferrerTracker.conf.inspect)
+
+    configurations = ReferrerTracker.conf
+    controller_action = [params[:controller], params[:action]].join("#")
+    conf_actions = get_yml_attributes("start_action")
+    logger.info(controller_action)
+
+
+    if conf_actions.include?(controller_action)
+      logger.info("=====+++++++++++=====++++++=====+++++++=")
+      logger.info("inside if of note_referrer")
+
+      current_configuration = configurations["#{get_current_config_key(controller_action)}"]
+      logger.info(current_configuration.inspect)
+      source = current_configuration["referral_parameter"]
+      logger.info(current_configuration["referral_parameter"])
+      session[source.to_sym] = params[source.to_sym] if params[source.to_sym].present?
+    end
+
+  end
+
+  def save_referrer
+    logger.info(session[:sr])
+    logger.info("@tracker_resource.inspect")
+    logger.info(@tracker_resource.inspect)
+    if session[:sr].present?
+      logger.info("saving referrer as "+ session[:sr])
+      Track.create(:source => session[:sr], :resource_id => user.id, :resource_type => user.class.to_s)
+      session[:sr] = nil
+    end
+
+  end
+
+  def self.raise_unconfigured_exception
+    raise NotConfigured.new("No configuration provided for Referrer Tracker.")
+  end
+
+  def self.load_facebooker_yaml
+    config = YAML.load(File.read(File.join(Rails.root,"config","referrer_tracker.yml")))
+    raise NotConfigured.new("Unable to load configuration for #{::Rails.env} from referrer_tracker.yml. Is it set up?") if config.nil?
+    self.conf = config#.with_indifferent_access
+  end
+
+  def get_yml_attributes(action)
+    ReferrerTracker.conf.values.map{|i| i["#{action}"]}
+  end
+
+  def get_current_config_key(controller_action)
+    result = ""
+    ReferrerTracker.conf.each_pair do |k, v|
+      if v.has_value?(controller_action) and !result.present?
+        result = k
+      end
+    end
+    result
+  end
+end
+
+
+#Load the model files.
+path = File.join(File.dirname(__FILE__), 'app', "models", "track.rb")
+$LOAD_PATH << path
+ActiveSupport::Dependencies.load_file(path)

data/test/referrer_tracker_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class ReferrerTrackerTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'test/unit'
+require 'active_support'

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: referrer_tracker
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- rtdp
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-01 00:00:00 +05:30
+default_executable: 
+dependencies: []
+
+description: It pulls in the ?ref= and ?sr= type references from urls and marks visitor comings from those urls.
+email: rtdp@weboniselab.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- MIT-LICENSE
+- README
+- Rakefile
+- init.rb
+- install.rb
+- lib/app/models/track.rb
+- lib/db/migrate/20110523140707_create_referrer_track_model.rb
+- lib/db/schema.rb
+- lib/referrer_tracker.rb
+- lib/referrer_tracker/utils.rb
+- lib/tasks/set_up.rake
+- referrer_tracker.gemspec
+- test/old_referrer_tracker.rb
+- test/referrer_tracker_test.rb
+- test/test_helper.rb
+- uninstall.rb
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Tracks the urls references.
+test_files: []
+