rack-referrals 0.0.1 → 0.0.2

data/README.md

@@ -25,14 +25,38 @@ Example Usage (Rails 3 App)
 
 Just add it to your middleware stack:
 
+    # Rails 3 App - in config/application.rb
     class Application < Rails::Application
       ...
       config.middleware.use Rack::Referrals
       ...
     end
+    
+    # Rails 2 App - in config/environment.rb
+    Rails::Initializer.run do |config|
+      ...
+      config.middleware.use "Rack::Referrals"
+      ...
+    end
 
+Now you can check any request to see what search engine referred it, and if any did, then what search terms were used.
+
+  class ExampleController < ApplicationController
+
+    def index
+      str = if request.env['referring.search_engine']
+        "You're from #{request.env['referring.search_engine']}, " \
+        "where you searched: #{request.env['referring.search_terms']}"
+      else
+        "You're from somewhere boring."
+      end
+      
+      render :text => str
+    end
+    
+  end
 
-Getting Fancy
+Gettin' Fancy
 -------------
 
 This knows about a number of search engines by default (Google, Yahoo, Bing, some big Russian ones... check the <code>DEFAULT_ENGINES</code> constant in <code>lib/rack-referrals.rb</code> for the current list).

data/history.md

@@ -0,0 +1,8 @@
+# Changelog
+
+## 0.0.2 October 7, 2011
+* API CHANGE: replacing *search_phrase* with *search_terms*, since phrase implies it was searched "like so"
+
+## 0.0.1 October 7, 2011
+* Initial functioning version
+

data/lib/rack-referrals.rb

@@ -5,7 +5,7 @@ module Rack
   #
   # Rack Middleware for extracting information from the HTTP-REFERER header.
   # Specifically, it populates +env['referring.search_engine']+ and 
-  # +env['referring.search_phrase']+ if it detects a request came from a known 
+  # +env['referring.search_terms']+ if it detects a request came from a known 
   # search engine.
   #
   class Referrals
@@ -54,7 +54,7 @@ module Rack
           rescue URI::InvalidURIError; nil
           end
           
-          env["referring.search_phrase"] = query_string && Rack::Utils.parse_query(query_string)[param_name]
+          env["referring.search_terms"] = query_string && Rack::Utils.parse_query(query_string)[param_name]
         end
       end
       

data/lib/rack-referrals/version.rb

@@ -1,5 +1,5 @@
 module Rack
   class Referrals
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/test/test_referrals.rb

@@ -18,21 +18,21 @@ class ReferralTest < MiniTest::Unit::TestCase
     get '/', nil, 'HTTP_REFERER' => "http://www.google.com/search?q=ruby+on+rails&ie=utf-8&oe=utf-8&aq=t&rls=org.mozilla:en-US:official&client=firefox-a" 
     
     assert_equal "google", last_request.env['referring.search_engine']
-    assert_equal "ruby on rails", last_request.env['referring.search_phrase']
+    assert_equal "ruby on rails", last_request.env['referring.search_terms']
   end
 
   def test_handles_missing_params
     get '/', nil, 'HTTP_REFERER' => "http://www.google.com/search?ie=utf-8&oe=utf-8&aq=t&rls=org.mozilla:en-US:official&client=firefox-a" 
     
     assert_equal "google", last_request.env['referring.search_engine']
-    assert_equal nil, last_request.env['referring.search_phrase']
+    assert_equal nil, last_request.env['referring.search_terms']
   end
 
   def test_handles_no_referer
     get '/'
     
     assert_equal nil, last_request.env['referring.search_engine']
-    assert_equal nil, last_request.env['referring.search_phrase']
+    assert_equal nil, last_request.env['referring.search_terms']
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-referrals
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-10-07 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70197710584540 !ruby/object:Gem::Requirement
+  requirement: &70145645641620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70197710584540
+  version_requirements: *70145645641620
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &70197710583960 !ruby/object:Gem::Requirement
+  requirement: &70145645641180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70197710583960
+  version_requirements: *70145645641180
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70197710583240 !ruby/object:Gem::Requirement
+  requirement: &70145645640760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70197710583240
+  version_requirements: *70145645640760
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &70197710582340 !ruby/object:Gem::Requirement
+  requirement: &70145645630860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70197710582340
+  version_requirements: *70145645630860
 description: If the user clicked through from a search engine, this middleware will
   detect the engine used and the terms searched.
 email:
@@ -67,6 +67,7 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- history.md
 - lib/rack-referrals.rb
 - lib/rack-referrals/version.rb
 - rack-referrals.gemspec