referrer_tracker 0.0.1 → 0.0.2

data/README.rdoc

@@ -0,0 +1,34 @@
+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:
+     actions: "home#index home#dashboard"  #These actions will be tracked - with first as landingpage and second as dashboard page.
+     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.
+
+Installation
+=============
+Install the gem as - 
+
+   gem install referrer_tracker
+
+Then run the migrations using - 
+
+    rake db:migrate:rt_setup
+
+This way, it will create a table in your database named - referrer_track.
+
+Then add a referrer_tracker.yml file inside the config directory and add the configuration as shown in above example.
+
+
+
+Copyright (c) 2011 [name of plugin creator], released under the MIT license
+Webonise Software Solutions.

data/Rakefile

@@ -30,6 +30,6 @@ Jeweler::Tasks.new do |gem|
   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"
+  gem.version = "0.0.2"
 end
-Jeweler::RubygemsDotOrgTasks.new
+Jeweler::RubygemsDotOrgTasks.new

data/init.rb

@@ -1,5 +1,6 @@
 # Include hook code here
 require File.join(File.dirname(__FILE__), "lib", "referrer_tracker")
+require File.join(File.dirname(__FILE__), "lib", "referrer_tracker", "utils")
 
 #
 #load the configutraions from yml

data/lib/referrer_tracker.rb

@@ -6,13 +6,20 @@ end
 module ReferrerTracker
   include Utils
 
+  #
+  # This is being called by basic before filter and used to check if conditions from config satisfies..
+  #
+  #
   def notice_referrer
     if config_actions.include?(current_c_a_pair)
       create_track_value
     end
   end
 
-
+  #
+  # Checks for correct configuratios and saves track.
+  #
+  # 
   def create_track_value
     if step==1
       create_for_step(1, current_source_value) if conversion_rate? && source_match?
@@ -24,7 +31,9 @@ module ReferrerTracker
     end
   end
 
-
+  #
+  # Called to save the track
+  #
   def create_for_step(step, source)
     ReferrerTrack.create(:step => step,
                  :track => current_track,
@@ -32,3 +41,5 @@ module ReferrerTracker
   end
 
 end
+
+require 'referrer_tracker/utils'

data/referrer_tracker.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{referrer_tracker}
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["rtdp"]
@@ -13,11 +13,11 @@ Gem::Specification.new do |s|
   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"
+    "README.rdoc"
   ]
   s.files = [
     "MIT-LICENSE",
-    "README",
+    "README.rdoc",
     "Rakefile",
     "init.rb",
     "install.rb",

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: referrer_tracker
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - rtdp
@@ -26,10 +26,10 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- README
+- README.rdoc
 files: 
 - MIT-LICENSE
-- README
+- README.rdoc
 - Rakefile
 - init.rb
 - install.rb

data/README

@@ -1,21 +0,0 @@
-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.