search-sniffer 0.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in search-sniffer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 ATimofeev
+
+MIT License
+
+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,52 @@
+# Search::Sniffer
+
+Simple plugin to sniff inbound search terms from popular search engines
+
+## Installation
+
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'search-sniffer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install search-sniffer
+
+## Usage
+
+```ruby
+class ApplicationController < ActionController::Base
+  before_filter :sniff_referring_search
+  ...
+end
+```
+
+The plugin populates the @@referring_search@ object containing info that can be passed to a keyword highlighter or internal site search engine to pull related content. For an HTTP referer of @http://www.google.com/search?q=ruby+on+rails+houston&ie=utf-8&oe=utf-8&aq=t&rls=org.mozilla:en-US:official&client=firefox-a@@
+
+```ruby
+@referring_search.search_terms
+ => "ruby rails houston"
+@referring_search.raw
+ => "ruby on rails houston"
+@referring_search.engine
+ => "google"
+```
+
+Copyright (c) 2008 Squeejee, released under the MIT license
+
+Converted to Rails gem by Alexander Timofeev (https://github.com/ATimofeev) 2012
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/search-sniffer/search-sniffer.rb

@@ -0,0 +1,91 @@
+# Adapted from http://www.insiderpages.com/rubyonrails/2007/01/get-referring-search-engine-keywords.html
+
+module Search
+  module Sniffer
+
+    module ControllerMethods
+      #   Creates @referring_search containing any referring search engine query minus stop words
+      #
+      # eg. If the HTTP_REFERER header indicates page referer as:
+      #     http://www.google.com/search?q=ruby+on+rails+houston&ie=utf-8&oe=utf-8&aq=t&rls=org.mozilla:en-US:official&client=firefox-a
+      #
+      #     then this function will create:
+      #     @referring_search = "Ruby Rails Houston"
+      #
+      def sniff_referring_search
+        # Check whether referring URL was a search engine result
+        # uncomment out the line below to test
+        # request.env["HTTP_REFERER"] = "http://www.google.com/search?q=ruby+on+rails+houston&ie=utf-8&oe=utf-8&aq=t&rls=org.mozilla:en-US:official&client=firefox-a"
+        referer = request.env["HTTP_REFERER"]
+        @referring_search = ReferringSearch.new(referer)
+        true
+      end # sniff_referring_search
+    end # Module Controller Methods
+
+    class ReferringSearch
+
+      attr_reader :search_terms # sanitized search terms
+      attr_reader :raw # original terms as typed by user
+      attr_reader :engine # search engine
+
+      def initialize(referer)
+
+        @search_referers = {
+              :google     => [/^http:\/\/(www\.)?google.*/, 'q'],
+              :yahoo      => [/^http:\/\/search\.yahoo.*/, 'p'],
+              :msn        => [/^http:\/\/search\.msn.*/, 'q'],
+              :aol        => [/^http:\/\/search\.aol.*/, 'userQuery'],
+              :altavista  => [/^http:\/\/(www\.)?altavista.*/, 'q'],
+              :feedster   => [/^http:\/\/(www\.)?feedster.*/, 'q'],
+              :lycos      => [/^http:\/\/search\.lycos.*/, 'query'],
+              :alltheweb  => [/^http:\/\/(www\.)?alltheweb.*/, 'q']
+            }
+
+        @stop_words = /\b(\d+|\w|about|after|also|an|and|are|as|at|be|because|before|between|but|by|can|com|de|do|en|for|from|has|how|however|htm|html|if|i|in|into|is|it|la|no|of|on|or|other|out|since|site|such|than|that|the|there|these|this|those|to|under|upon|vs|was|what|when|where|whether|which|who|will|with|within|without|www|you|your)\b/i
+
+        # Get query args
+        query_args =
+          begin
+            URI.split(referer)[7]
+          rescue URI::InvalidURIError
+            nil
+          end
+
+        # Determine the referring search that was used
+        unless referer.blank?
+          @search_referers.each do |k, v|
+            reg, query_param_name = v
+            # Check if the referrer is a search engine we are targetting
+            if (reg.match(referer))
+
+              # set the search engine
+              @engine = k
+
+              unless query_args.empty?
+                query_args.split("&").each do |arg|
+                  pieces = arg.split('=')
+                  if pieces.length == 2 && pieces.first == query_param_name
+                    unstopped_keywords = CGI.unescape(pieces.last)
+                    @raw = unstopped_keywords
+                    @search_terms = unstopped_keywords.gsub(@stop_words, '').squeeze(' ')
+                    #logger.info("Referring Search Keywords: #{search_terms}")
+                    return true
+                  end
+                end
+              end # unless
+
+              return true # because we found a match
+            end # if
+          end # do
+        end #unless
+      end #initialize
+
+      # Return the referring search string instead of the object serialized into a string
+      def to_s
+        @search_terms
+      end
+
+    end # ReferringSearch
+
+  end
+end

data/lib/search-sniffer/version.rb

@@ -0,0 +1,5 @@
+module Search
+  module Sniffer
+    VERSION = "0.0.1"
+  end
+end

data/lib/search-sniffer.rb

@@ -0,0 +1,5 @@
+require "search-sniffer/version"
+require "search-sniffer/search-sniffer"
+
+
+ActionController::Base.send(:include, Search::Sniffer::ControllerMethods)

data/search-sniffer.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'search-sniffer/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "search-sniffer"
+  gem.version       = Search::Sniffer::VERSION
+  gem.authors       = ["ATimofeev"]
+  gem.email         = ["atimofeev@reactant.ru"]
+  gem.description   = %q{Simple plugin to sniff inbound search terms from popular search engines}
+  gem.summary       = %q{Squeejee search_sniffer plugin implementation}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: search-sniffer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- ATimofeev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-28 00:00:00.000000000 Z
+dependencies: []
+description: Simple plugin to sniff inbound search terms from popular search engines
+email:
+- atimofeev@reactant.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/search-sniffer.rb
+- lib/search-sniffer/search-sniffer.rb
+- lib/search-sniffer/version.rb
+- search-sniffer.gemspec
+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: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Squeejee search_sniffer plugin implementation
+test_files: []
+has_rdoc: