@@ -18,7 +18,14 @@ h3. Usage ... end -The plugin populates the @@referring_search@ variable which can then be passed to a keyword highlighter or internal site search engine to pull related content. - - -Copyright (c) 2008 Wynn Netherland, Squeejee, released under the MIT license +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. + + # 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 + @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 README.textile @@ -16,9 +16,7 @@ module Squeejee #:nodoc: # 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"] - rs = ReferringSearch.new(referer) - @referring_search = rs.referring_search - @referring_search_raw = rs.raw + @referring_search = ReferringSearch.new(referer) true end # sniff_referring_search end # Module Controller Methods @@ -26,16 +24,12 @@ module Squeejee #:nodoc: class ReferringSearch - attr_accessor :search_referers - attr_accessor :stop_words - - attr_reader :referring_search - attr_reader :raw + attr_reader :search_terms # sanitized search terms + attr_reader :raw # original terms as typed by user + attr_reader :engine # search engine def initialize(referer) - # stop words is a variable - # .raw .original as they typed to_s, including blacklisted stuff - # .ref + @search_referers = { :google => [/^http:\/\/(www\.)?google.*/, 'q'], :yahoo => [/^http:\/\/search\.yahoo.*/, 'p'], @@ -64,8 +58,8 @@ module Squeejee #:nodoc: # Check if the referrer is a search engine we are targetting if (reg.match(referer)) - # Highlight the Search Term Keywords on the page - #@javascripts.push('keyword_highlighter') + # set the search engine + @engine = k unless query_args.empty? query_args.split("&").each do |arg| @@ -73,8 +67,8 @@ module Squeejee #:nodoc: if pieces.length == 2 && pieces.first == query_param_name unstopped_keywords = CGI.unescape(pieces.last) @raw = unstopped_keywords - @referring_search = unstopped_keywords.gsub(@stop_words, '').squeeze(' ') - #logger.info("Referring Search Keywords: #{referring_search}") + @search_terms = unstopped_keywords.gsub(@stop_words, '').squeeze(' ') + #logger.info("Referring Search Keywords: #{search_terms}") return true end end @@ -88,7 +82,7 @@ module Squeejee #:nodoc: # Return the referring search string instead of the object serialized into a string def to_s - return @referring_search + @search_terms end end # ReferringSearch lib/search_sniffer.rb a17b6a15433cc060fd2599f56ec8cbd9af555661 Wynn Netherland wynn@squeejee.com http://github.com/squeejee/search_sniffer/commit/408d5a814f082ee09d7f3ab3d7dd072bdfd3f2a8 408d5a814f082ee09d7f3ab3d7dd072bdfd3f2a8 2008-07-17T18:35:13-07:00 2008-07-17T18:35:13-07:00 Updated README.textile, commented lib 7c74458696a8b853772c967c8c2ccf58b5f562ca Wynn Netherland wynn@squeejee.com