rack-referrals 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in rack-referrals.gemspec
+gemspec

data/README.md

@@ -0,0 +1,61 @@
+Rack::Referrals
+=============
+
+Rack::Referrals is a rack middleware that extracts information about the referring website from each request.  Specifically, it parses the HTTP-REFERER header and tells you if the request came from a known search engine (and if so, what the search terms were). It was inspired by the [search_sniffer](https://github.com/squeejee/search_sniffer) plugin, but provides that functionality as a middleware.
+
+
+Purpose
+-------
+
+Ever wanted to know if the user viewing the current page got there via a search engine?  If so, ever wanted to show them a link like "Click here to browse additional widgets related to *[search term*]"?
+  
+Yeah, this'll help.
+
+
+Installation
+------------
+
+Quick and easy:
+
+    gem install rack-referrals
+
+
+Example Usage (Rails 3 App)
+-------------------------
+
+Just add it to your middleware stack:
+
+    class Application < Rails::Application
+      ...
+      config.middleware.use Rack::Referrals
+      ...
+    end
+
+
+Getting 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).
+
+You can add in support for additional search engines by passing the <code>:additional_engines</code> parameter:
+
+    class Application < Rails::Application
+      ...
+      config.middleware.use Rack::Referrals.new :additional_engines => {
+        :my_engine_name => [/domain_regular_expression/, 'search-term-parameter'],
+        :another_name   => [/domain_regular_expression/, 'search-term-parameter'],
+      }
+      ...
+    end
+    
+You can also just completely clear the default ones and use _only_ those you define with the <code>:engines</code> parameter:
+
+    class Application < Rails::Application
+      ...
+      config.middleware.use Rack::Referrals.new :engines => {
+        :only_engine_i_like => [/domain_regular_expression/, 'search-term-parameter']
+      }
+      ...
+    end
+
+In either case, <code>domain_regular_expression</code> is a regular expression used to identify this search engine, like <code>/^https?:\/\/(www\.)?google.*/</code>, and <code>search-term-parameter</code> is the parameter that the search engine uses to store the user's search (for Google, that's <code>q</code>).

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |task|
+  task.test_files = FileList['test/test_*.rb']
+end
+

data/lib/rack-referrals/version.rb

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

data/lib/rack-referrals.rb

@@ -0,0 +1,65 @@
+require "rack-referrals/version"
+
+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 
+  # search engine.
+  #
+  class Referrals
+    
+    DEFAULT_ENGINES = {
+      # Tested myself
+      :google     => [/^https?:\/\/(www\.)?google.*/, 'q'],
+      :yahoo      => [/^https?:\/\/([^\.]+.)?search\.yahoo.*/, 'p'],
+      :bing       => [/^https?:\/\/search\.bing.*/, 'q'],
+      :biadu      => [/^https?:\/\/(www\.)?baidu.*/, 'wd'],
+      :rambler    => [/^https?:\/\/([^\.]+.)?rambler.ru/, 'query'],
+      :yandex     => [/^https?:\/\/(www\.)?yandex.ru/, 'text'],      
+
+      # Borrowed from https://github.com/squeejee/search_sniffer
+      :msn        => [/^https?:\/\/search\.msn.*/, 'q'],
+      :aol        => [/^https?:\/\/(www\.)?\.aol.*/, 'query'],
+      :altavista  => [/^https?:\/\/(www\.)?altavista.*/, 'q'],
+      :feedster   => [/^https?:\/\/(www\.)?feedster.*/, 'q'],
+      :lycos      => [/^https?:\/\/search\.lycos.*/, 'query'],
+      :alltheweb  => [/^https?:\/\/(www\.)?alltheweb.*/, 'q'] 
+      
+      # Want to add support for more? A good place to start would be this list (note that they
+      # give example domains, though, not anything we can use to construct a reliable reg exp):
+      # http://code.google.com/apis/analytics/docs/tracking/gaTrackingTraffic.html#searchEngine
+    }
+    
+    def initialize(app, opts = {})
+      @app = app
+      
+      @engines   = opts[:engines]
+      @engines ||= DEFAULT_ENGINES.merge(opts[:additional_engines] || {})
+    end      
+
+    def call(env)
+      request = Rack::Request.new(env)
+      from = request.env["HTTP_REFERER"]
+      
+      if from.to_s.length > 0
+        if engine = @engines.detect {|name, data| from =~ data[0] }
+          env["referring.search_engine"] = engine[0].to_s
+          reg, param_name = engine[1]
+          
+          # Pull out the query string from the referring search engine
+          query_string = begin
+            URI.split(from)[7]
+          rescue URI::InvalidURIError; nil
+          end
+          
+          env["referring.search_phrase"] = query_string && Rack::Utils.parse_query(query_string)[param_name]
+        end
+      end
+      
+      @app.call(env)
+    end
+    
+  end
+end

data/rack-referrals.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rack-referrals/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rack-referrals"
+  s.version     = Rack::Referrals::VERSION
+  s.authors     = ["Kali Donovan"]
+  s.email       = ["kali@deviantech.com"]
+  s.homepage    = ""
+  s.summary     = %q{Extracts referring search engine info.}
+  s.description = %q{If the user clicked through from a search engine, this middleware will detect the engine used and the terms searched.}
+
+  s.rubyforge_project = "rack-referrals"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "minitest"
+  s.add_development_dependency "rack-test"
+  s.add_development_dependency "rake"
+  s.add_dependency 'rack'
+end

data/test/test_referrals.rb

@@ -0,0 +1,39 @@
+require "minitest/autorun"
+require "rack/test"
+
+require File.expand_path(File.dirname(__FILE__) + '/../lib/rack-referrals')
+
+class ReferralTest < MiniTest::Unit::TestCase
+  include Rack::Test::Methods
+
+  def app    
+    hello_world_app = lambda do |env|
+      [200, {}, "Hello World"]
+    end
+    
+    Rack::Referrals.new(hello_world_app)
+  end
+
+  def test_parses_google
+    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']
+  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']
+  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']
+  end
+
+end
+

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: rack-referrals
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Kali Donovan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-07 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &70197710584540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70197710584540
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: &70197710583960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70197710583960
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70197710583240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70197710583240
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: &70197710582340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70197710582340
+description: If the user clicked through from a search engine, this middleware will
+  detect the engine used and the terms searched.
+email:
+- kali@deviantech.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/rack-referrals.rb
+- lib/rack-referrals/version.rb
+- rack-referrals.gemspec
+- test/test_referrals.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: rack-referrals
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Extracts referring search engine info.
+test_files:
+- test/test_referrals.rb