visitor_sources 0.0.0 → 0.0.1

data/README.md

@@ -9,3 +9,8 @@ Track where a visitor has come from and kep a record of each visit in the cookie
 
 # requires the use of Rack::Session::Cookie 
 
+TODO
+----
+- Allow clearing of all the users history (if they purchase for example)
+- If user clicks an add twice it only shows up once
+

data/RakeFile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "visitor_sources"
+    gem.summary = "Use a cookie to record the sources that each visitor came to your site"
+    gem.description = "Use a cookie to record the sources that each visitor came to your site"
+    gem.email = "mail@matthewfawcett.co.uk"
+    gem.homepage = "http://github.com/mattfawcett/visitor_sources"
+    gem.authors = ["Matt Fawcett"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "visitor_sources #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -1 +1 @@
-0.0.0
+0.0.1

data/lib/visitor_sources/traffic_source.rb

@@ -14,7 +14,8 @@
 
 require "uri"
 class TrafficSource
-  attr_accessor :encoder_version, :unix_timestamp, :medium, :term, :source, :campaign, :content, :custom_parameter_mapping, :env
+  attr_accessor :encoder_version, :unix_timestamp, :medium, :term, :source, :campaign, :content, 
+                :custom_parameter_mapping, :env
   
   COOKIE_LINE_PARAMETERS = ['encoder_version', 'unix_timestamp', 'medium', 'term', 'source', 'campaign', 'content']
   STANDARD_PARAMETER_MAPPING = {:medium => :utm_medium, :term => :utm_term, :source => :utm_source, :campaign => :utm_campaign, :content => :utm_content}
@@ -25,13 +26,13 @@ class TrafficSource
     end
   end
   
-  def self.updated_rack_environment(old_env, custom_parameter_mapping = {})
+  def self.updated_rack_environment(old_env, custom_parameter_mapping = {}, ignore_duplicate_source_within=120)
     old_env["rack.session"][:traffic_sources] ||= ''
     traffic_sources = TrafficSources.new(old_env["rack.session"][:traffic_sources])
     latest_source = TrafficSource.initialize_with_rack_env(old_env, custom_parameter_mapping)
     return old_env if latest_source.to_s.nil?
     if traffic_sources.length > 0
-      return old_env if latest_source.same_as?(traffic_sources.last)
+      return old_env if latest_source.same_as?(traffic_sources.last) && latest_source.unix_timestamp-traffic_sources.last.unix_timestamp <  ignore_duplicate_source_within
     end
     traffic_sources << latest_source
     old_env["rack.session"][:traffic_sources] = traffic_sources.to_s
@@ -40,7 +41,7 @@ class TrafficSource
   
   def TrafficSource.initialize_with_rack_env(env, custom_parameter_mapping = {})
     traffic_source = self.new(:env => env, :custom_parameter_mapping => custom_parameter_mapping, 
-                              :unix_timestamp => Time.now.to_i, :encoder_version => 1)
+                              :unix_timestamp => Time.now.to_i, :encoder_version => 1)    
     
     COOKIE_LINE_PARAMETERS.last(5).each do |attribute| 
       traffic_source.send("#{attribute}=", traffic_source.query_string_value_for(attribute.to_sym))

data/lib/visitor_sources/traffic_source_middleware.rb

@@ -6,6 +6,7 @@ class TrafficSourceMiddleware
     
   def call(env)
     @options[:custom_parameter_mapping] ||= {}        
+    @options[:ignore_duplicate_source_within] ||= 120 #2 mins
     env["rack.request.query_hash"] = Rack::Utils.parse_query(env["QUERY_STRING"]) 
     env = TrafficSource.updated_rack_environment(env, @options[:custom_parameter_mapping])
     env[:traffic_sources] = TrafficSources.new(env["rack.session"][:traffic_sources])        

data/test/app.rb

@@ -3,7 +3,7 @@ require 'sinatra'
 require File.expand_path(File.dirname(__FILE__) + '/../lib/visitor_sources')
 
 use Rack::Session::Cookie
-use TrafficSourceMiddleware, :custom_parameter_mapping => {:campaign => :campaign}
+use TrafficSourceMiddleware, :custom_parameter_mapping => {:campaign => :campaign, :ignore_duplicate_source_within => 120}
 
 
 

data/test/test_helper.rb

@@ -2,6 +2,7 @@ require 'rubygems'
 require 'test/unit'
 require 'rack/test'
 require 'shoulda'
+require 'delorean'
 require 'base64'
 require File.expand_path(File.dirname(__FILE__) + '/app')
 

data/test/traffic_source_test.rb

@@ -11,8 +11,8 @@ class TrafficSourceTest < Test::Unit::TestCase
       @rack_env = EXAMPLE_RACK_ENV.dup
       @custom_variable_matches = {:campaign => :custom_campaign, :term => :custom_keywords, :medium => :custom_medium}        
     end
-    context "initialize_with_rack_env" do     
-         
+    
+    context "initialize_with_rack_env" do              
       context "when there are custom variables in the url present" do
         should "use the custom variables to set the correct TrafficSource" do
           @rack_env["rack.request.query_hash"] = {"custom_campaign" => "MyCamp1", "custom_keywords" => "Product One", "gclid" => "AutoAdwordsTaggingClid"}
@@ -136,6 +136,9 @@ class TrafficSourceTest < Test::Unit::TestCase
     end
     
     context "updated_rack_environment" do
+      setup do
+        @rack_env["rack.session"][:traffic_sources] = ''
+      end
 
       should "not update the enviroment if the current TrafficSource#to_s is nil" do
         @rack_env["HTTP_REFERER"] = "http://localhost:9393/some/path"
@@ -143,13 +146,27 @@ class TrafficSourceTest < Test::Unit::TestCase
         assert_equal "", rack_env["rack.session"][:traffic_sources]
       end
 
-      should "not update the enviroment if the last TrafficSource#to_s is the same as the current traffic source" do
+      should "not update the enviroment if the last TrafficSource#to_s is the same as the current traffic source and the last one was recent" do
         @rack_env["HTTP_REFERER"] = nil
+        timestamp_of_first_request = Time.now.to_i - 60
+        Delorean.time_travel_to("1 minute ago") do         
+          rack_env = TrafficSource.updated_rack_environment(@rack_env)
+          assert_equal "1|#{timestamp_of_first_request}|direct", rack_env["rack.session"][:traffic_sources]
+        end
         rack_env = TrafficSource.updated_rack_environment(@rack_env)
-        assert_equal "1|#{Time.now.to_i}|direct", rack_env["rack.session"][:traffic_sources]
-
+        assert_equal "1|#{timestamp_of_first_request}|direct", rack_env["rack.session"][:traffic_sources]
+      end
+      
+      should "update the enviroment if the last TrafficSource#to_s is the same as the current traffic source but the last source was a while ago" do
+        @rack_env = EXAMPLE_RACK_ENV.dup
+        @rack_env["HTTP_REFERER"] = nil
+        timestamp_of_first_request = Time.now.to_i - 180
+        Delorean.time_travel_to("3 minute ago") do                
+          rack_env = TrafficSource.updated_rack_environment(@rack_env)
+          assert_equal "1|#{timestamp_of_first_request}|direct", rack_env["rack.session"][:traffic_sources]
+        end
         rack_env = TrafficSource.updated_rack_environment(@rack_env)
-        assert_equal "1|#{Time.now.to_i}|direct", rack_env["rack.session"][:traffic_sources]
+        assert_equal "1|#{timestamp_of_first_request}|direct,1|#{Time.now.to_i}|direct", rack_env["rack.session"][:traffic_sources]
       end
 
       should "update the traffic source if the current one is differenty from the last one" do
@@ -164,51 +181,48 @@ class TrafficSourceTest < Test::Unit::TestCase
       end
     end
     
-  end
   
   
   
-  context "same_as?" do
-    setup do
-      @source_1 = TrafficSource.new(:encoder_version => 1, :unix_timestamp => Time.now.to_i, :medium => 'cpc', 
-                                    :term => 'myterm', :source => 'google', :campaign => 'mycamp')
-      @source_2 = @source_1.dup
-    end
+    context "same_as?" do
+      setup do
+        @source_1 = TrafficSource.new(:encoder_version => 1, :unix_timestamp => Time.now.to_i, :medium => 'cpc', 
+                                      :term => 'myterm', :source => 'google', :campaign => 'mycamp')
+        @source_2 = @source_1.dup
+      end
     
-    should "be true if all the main fields are the same" do
-      assert @source_1.same_as?(@source_2)
-      @source_2.encoder_version = 2
-      @source_2.unix_timestamp = 1234
-      assert @source_1.same_as?(@source_2)
-    end
+      should "be true if all the main fields are the same" do
+        assert @source_1.same_as?(@source_2)
+        @source_2.encoder_version = 2
+        @source_2.unix_timestamp = 1234
+        assert @source_1.same_as?(@source_2)
+      end
     
-    should "be false if one of the fields are different" do
-      @source_2.medium = "direct"
-      assert !@source_1.same_as?(@source_2)
+      should "be false if one of the fields are different" do
+        @source_2.medium = "direct"
+        assert !@source_1.same_as?(@source_2)
+      end
     end
-  end
   
-  context "initialize_from_string" do
-    should "create a new TrafficSource using the correct parameters from the string" do
-      string = "1|123456|organic|mysearchterms|google"
-      source = TrafficSource.initialize_from_string(string)
-      assert_equal 1,               source.encoder_version
-      assert_equal 123456,          source.unix_timestamp
-      assert_equal "organic",       source.medium
-      assert_equal "mysearchterms", source.term
-      assert_equal "google",        source.source
-      assert_nil    source.campaign
-      assert_nil    source.content
+    context "initialize_from_string" do
+      should "create a new TrafficSource using the correct parameters from the string" do
+        string = "1|123456|organic|mysearchterms|google"
+        source = TrafficSource.initialize_from_string(string)
+        assert_equal 1,               source.encoder_version
+        assert_equal 123456,          source.unix_timestamp
+        assert_equal "organic",       source.medium
+        assert_equal "mysearchterms", source.term
+        assert_equal "google",        source.source
+        assert_nil    source.campaign
+        assert_nil    source.content
+      end
     end
-  end
   
-  context "date" do
-    should "return a date object using the timestamp" do
-      @source = TrafficSource.new(:unix_timestamp => 1267804832)
-      assert_equal Time.at(1267804832), @source.date
+    context "date" do
+      should "return a date object using the timestamp" do
+        @source = TrafficSource.new(:unix_timestamp => 1267804832)
+        assert_equal Time.at(1267804832), @source.date
+      end
     end
-  end
-  
-  
-  
+  end    
 end                    

data/visitor_sources.gemspec

@@ -0,0 +1,63 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in RakeFile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{visitor_sources}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Matt Fawcett"]
+  s.date = %q{2010-03-08}
+  s.description = %q{Use a cookie to record the sources that each visitor came to your site}
+  s.email = %q{mail@matthewfawcett.co.uk}
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    "README.md",
+     "RakeFile",
+     "VERSION",
+     "lib/visitor_sources.rb",
+     "lib/visitor_sources/search_engine.rb",
+     "lib/visitor_sources/traffic_source.rb",
+     "lib/visitor_sources/traffic_source_middleware.rb",
+     "lib/visitor_sources/traffic_sources.rb",
+     "pkg/visitor_sources-0.0.0.gem",
+     "test/app.rb",
+     "test/search_engine_test.rb",
+     "test/test_helper.rb",
+     "test/traffic_source_middleware_test.rb",
+     "test/traffic_source_test.rb",
+     "test/traffic_sources_test.rb",
+     "visitor_sources.gemspec"
+  ]
+  s.homepage = %q{http://github.com/mattfawcett/visitor_sources}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Use a cookie to record the sources that each visitor came to your site}
+  s.test_files = [
+    "test/app.rb",
+     "test/search_engine_test.rb",
+     "test/test_helper.rb",
+     "test/traffic_source_middleware_test.rb",
+     "test/traffic_source_test.rb",
+     "test/traffic_sources_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: visitor_sources
 version: !ruby/object:Gem::Version 
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors: 
 - Matt Fawcett
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-05 00:00:00 +00:00
+date: 2010-03-08 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,18 +32,21 @@ extra_rdoc_files:
 - README.md
 files: 
 - README.md
+- RakeFile
 - VERSION
 - lib/visitor_sources.rb
 - lib/visitor_sources/search_engine.rb
 - lib/visitor_sources/traffic_source.rb
 - lib/visitor_sources/traffic_source_middleware.rb
 - lib/visitor_sources/traffic_sources.rb
+- pkg/visitor_sources-0.0.0.gem
 - test/app.rb
 - test/search_engine_test.rb
 - test/test_helper.rb
 - test/traffic_source_middleware_test.rb
 - test/traffic_source_test.rb
 - test/traffic_sources_test.rb
+- visitor_sources.gemspec
 has_rdoc: true
 homepage: http://github.com/mattfawcett/visitor_sources
 licenses: []