rack-search_terms 0.1.0

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/Gemfile

@@ -0,0 +1,4 @@
+source :gemcutter
+
+# Specify your gem's dependencies in rack-search-terms.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,25 @@
+PATH
+  remote: .
+  specs:
+    rack-search_terms (0.1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    rspec (2.1.0)
+      rspec-core (~> 2.1.0)
+      rspec-expectations (~> 2.1.0)
+      rspec-mocks (~> 2.1.0)
+    rspec-core (2.1.0)
+    rspec-expectations (2.1.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.0.0)
+  rack-search_terms!
+  rspec (~> 2.1.0)

data/MIT-LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2010 Paul Bowsher
+
+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.md

@@ -0,0 +1,57 @@
+Rack::SearchTerms
+=================
+
+* Repository: [http://github.com/boffbowsh/rack-search_terms](http://github.com/boffbowsh/rack-search_terms)
+
+Description
+-----------
+
+Rack::SearchTerms gives your app access to the search terms that drove the visitor to your site. Simply grab `env['search_terms']` in your Rack app and you're away!
+
+Rails 3 Quick Start
+-------------------
+
+Add to your Gemfile:
+
+    gem 'rack-search_terms'
+
+In config/environment.rb, add:
+
+    config.middleware.use "Rack::SearchTerms"
+
+Using with non-Rails Rack apps
+------------------------------
+
+Just `use Rack::SearchTerms` as any other middleware.
+
+Use Cases
+---------
+
+Our use case for this is to help our 404 page. If someone is referred from a Search Engine to an unknown page (it happens!), then we do a lookup against our internal search engine and hopefully return what the user was looking for.
+
+You could also use it to highlight search terms within your page, but this [isn't advised](http://gilesbowkett.blogspot.com/2007/01/stop-highlighting-referrer-search-terms.html) ;)
+
+Contributing to Rack::SearchTerms
+-----------------------
+
+I encourage you to:
+ 
+* Fork the project.
+* Make your feature addition, bug fix, or support for additional search engine.
+* Add specs for it.
+* Send me a pull request. Bonus points for topic branches.
+
+Author
+------
+
+Maintained by [Paul Bowsher](http://www.twitter.com/boffbowsh/)
+
+Thanks
+------
+
+Thanks to Bryan Helmkamp for the Quick Start section of this README :)
+
+License
+-------
+
+See MIT-LICENSE.txt in this directory.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/rack-search_terms.rb

@@ -0,0 +1,39 @@
+require 'rack/utils'
+
+module Rack
+  class SearchTerms
+    include Rack::Utils
+    
+    def initialize app
+      @app = app
+    end
+    
+    def call env
+      @env = env
+      @env.merge! 'search_terms' => search_terms
+      @app.call @env
+    end
+    
+    def referer
+      @env['HTTP_REFERER']
+    end
+    
+    def search_terms
+      case referer 
+      when /^http:\/\/www\.google\..*?\/imgres/
+        prev = terms_from_param 'prev'
+        parse_query(prev.split('?')[1])['q']
+      when /^http:\/\/www\.google\..*?\//
+        terms_from_param 'q'
+      when /^http:\/\/www.bing.com/
+        terms_from_param 'q'
+      end
+    end
+    
+    def terms_from_param param
+      parse_query(URI.parse(referer).query)[param]
+    end
+    
+    def self.version; '0.1.0'; end
+  end
+end

data/rack-search_terms.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/rack-search_terms", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "rack-search_terms"
+  s.version     = Rack::SearchTerms.version
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Paul Bowsher']
+  s.email       = ['paul.bowsher@gmail.com']
+  s.homepage    = "http://rubygems.org/gems/rack-search_terms"
+  s.summary     = "Rack Middleware to extract search terms from the referring search engine"
+  s.description = "Rack::SearchTerms gives your app access to the search terms that drove the visitor to your site"
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "rack-search_terms"
+
+  s.add_development_dependency "bundler", ">= 1.0.0"
+  s.add_development_dependency "rspec", "~> 2.1.0"
+
+  s.files        = `git ls-files`.split("\n")
+  s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  s.require_path = 'lib'
+end

data/spec/middleware_spec.rb

@@ -0,0 +1,37 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Rack::SearchTerms do
+  
+  before :each do
+    @app = mock('app')
+  end
+
+  it "should pass through environment to the underlying app" do
+    expect_env 'HTTP_REFERER' => 'http://www.example.com/', 'x-foo' => 'x-bar'
+    Rack::SearchTerms.new(@app).call({'HTTP_REFERER' => 'http://www.example.com/', 'x-foo' => 'x-bar'})
+  end
+  
+  it "should pass the search terms and engine on to underlying app" do
+    expect_env 'search_terms' => 'how now brown cow'
+    mock_request "http://www.google.com/?q=how%20now%20brown%20cow" do |middleware|
+      middleware.stub(:search_terms) {'how now brown cow'}
+    end
+  end
+  
+  context "term parsing" do
+    it_should_work_for "Google", :from => "http://www.google.com/url?sa=t&source=web&cd=1&ved=0CBUQFjAA&url=http%3A%2F%2Fwww.rawnet.com%2Fblog%2Fmake-my-logo-bigger&rct=j&q=rawnet%20logo&ei=6CPXTJSmCMq6jAehivCwCQ&usg=AFQjCNFa4cEzkMUJXaEpTWedLibVVVOz-w&sig2=eOu7V345cOW9xh9HjG36hQ", :as => 'rawnet logo'
+    it_should_work_for "Google UK", :from => "http://www.google.co.uk/url?sa=t&source=web&cd=1&sqi=2&ved=0CBUQFjAA&url=http%3A%2F%2Fwww.rawnet.com%2Fblog%2Fmake-my-logo-bigger&rct=j&q=rawnet%20logo&ei=sSPXTKn1OIK6hAex86n5BA&usg=AFQjCNFa4cEzkMUJXaEpTWedLibVVVOz-w&sig2=NfPNOdDvdT_u4JBsxH-OTQ", :as => 'rawnet logo'
+    it_should_work_for "Google Images", :from => "http://www.google.com/imgres?imgurl=http://www.rawnet.com/system/logos/18/thumb/logo.jpg%3F1286466114&imgrefurl=http://www.rawnet.com/news&usg=__Ag-l2Kt0yNDIUoOby8Q8bEKbWQ8=&h=66&w=95&sz=18&hl=en&start=0&sig2=YrkGnaNORciIKLuxBZm3_w&zoom=1&tbnid=OmO0aEU9ZGSuUM:&tbnh=61&tbnw=88&ei=YyPXTJGtLIOzhAef7sTFBQ&prev=/images%3Fq%3Drawnet%2Blogo%26hl%3Den%26safe%3Doff%26qscrl%3D1%26biw%3D1196%26bih%3D888%26tbs%3Disch:1&itbs=1&iact=hc&vpx=206&vpy=314&dur=1089&hovh=61&hovw=88&tx=107&ty=17&oei=YyPXTJGtLIOzhAef7sTFBQ&esq=1&page=1&ndsp=26&ved=1t:429,r:6,s:0", :as => 'rawnet logo'
+    it_should_work_for "Bing", :from => 'http://www.bing.com/search?q=rawnet+logo&go=&form=QBLH&filt=all&qs=n&sk=', :as => 'rawnet logo'
+  end
+  
+  it "should fail silently if not a search engine" do
+    expect_env 'HTTP_REFERER' => 'http://www.example.com/', 'search_terms' => nil
+    mock_request "http://www.example.com/"
+  end
+
+  it "should fail silently if a search engine with no terms" do
+    expect_env 'HTTP_REFERER' => 'http://www.google.com/', 'search_terms' => nil
+    mock_request "http://www.google.com/"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+require 'rspec'
+
+Rspec.configure do |c|
+  c.mock_with :rspec
+end
+
+def expect_env hash={}
+  @app.should_receive(:call).with( hash_including(hash) )
+end
+
+def mock_request referer
+  middleware = Rack::SearchTerms.new(@app)
+  yield middleware if block_given?
+  middleware.call({'HTTP_REFERER' => referer})
+end
+
+def it_should_work_for name, options
+  it "should work for #{name}" do
+    expect_env 'search_terms' => options[:as]
+    mock_request options[:from]
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification 
+name: rack-search_terms
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Paul Bowsher
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-07 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 2
+        - 1
+        - 0
+        version: 2.1.0
+  type: :development
+  version_requirements: *id002
+description: Rack::SearchTerms gives your app access to the search terms that drove the visitor to your site
+email: 
+- paul.bowsher@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE.txt
+- README.md
+- Rakefile
+- lib/rack-search_terms.rb
+- rack-search_terms.gemspec
+- spec/middleware_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://rubygems.org/gems/rack-search_terms
+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: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: rack-search_terms
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Rack Middleware to extract search terms from the referring search engine
+test_files: []
+