search_terms 0.0.1

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--color --format=doc

data/Gemfile

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

data/README.md

@@ -0,0 +1,14 @@
+# search\_terms
+
+**TL;DR**: **search\_terms** extracts search terms (keywords) from
+search engine referral URLs
+
+## Quick Examples
+
+```ruby
+require "rubygems"
+require "search_terms"
+
+referrer = URI("http://google.com/?q=how+to+extract+search+terms")
+referrer.search_string # => "how to extract search terms"
+```

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/lib/search_terms.rb

@@ -0,0 +1,7 @@
+require "uri"
+require "cgi"
+
+require "search_terms/version"
+require "search_terms/extractor"
+
+require "search_terms/ext/uri"

data/lib/search_terms/ext/uri.rb

@@ -0,0 +1,3 @@
+class URI::Generic
+  include SearchTerms::Extractor
+end

data/lib/search_terms/extractor.rb

@@ -0,0 +1,37 @@
+module SearchTerms
+  # Expects to be mixed into an object that responds to:
+  # * fragment: URI parameters after a #
+  # * query: URI parameters afer a ?
+  # * host: URI host
+  module Extractor
+    def search_string
+      case search_engine
+      when :google, :bing, :aol, :duckduckgo
+        query_parameters["q"].first
+      when :yahoo
+        query_parameters["p"].first
+      end
+    end
+
+    private
+
+    def search_engine
+      case host
+      when /google\./
+        :google
+      when /bing\./
+        :bing
+      when /yahoo\./
+        :yahoo
+      when /search\.aol\./
+        :aol
+      when /duckduckgo\./
+        :duckduckgo
+      end
+    end
+
+    def query_parameters
+      CGI.parse(query || fragment || "")
+    end
+  end
+end

data/lib/search_terms/version.rb

@@ -0,0 +1,3 @@
+module SearchTerms
+  VERSION = "0.0.1"
+end

data/search_terms.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "search_terms/version"
+
+Gem::Specification.new do |s|
+  s.name        = "search_terms"
+  s.version     = SearchTerms::VERSION
+  s.authors     = ["Andy Lindeman"]
+  s.email       = ["alindeman@gmail.com"]
+  s.homepage    = "https://github.com/alindeman/search_terms"
+  s.summary     = %q{Extracts search terms from search engine referral URLs}
+  s.description = %q{Supports extracting search terms from Google, Bing, Yahoo, DuckDuckGo, and AOL}
+
+  s.rubyforge_project = "search_terms"
+
+  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"]
+
+  s.add_development_dependency "rspec", "~>2.7.0"
+  s.add_development_dependency "rake"
+end

data/spec/search_terms_spec.rb

@@ -0,0 +1,55 @@
+require "spec_helper"
+
+describe SearchTerms::Extractor do
+  context "non-search engine" do
+    it "returns nil for search terms even if they are present" do
+      uri = URI("http://andylindeman.com/?q=how+to+do+everything")
+      uri.search_string.should be_nil
+    end
+
+    it "returns nil for search terms if they are not present" do
+      uri = URI("http://andylindeman.com/")
+      uri.search_string.should be_nil
+    end
+  end
+
+  context "google" do
+    it "returns search terms from query string" do
+      uri = URI("http://google.com/?q=how+to+extract+search+terms")
+      uri.search_string.should == "how to extract search terms"
+    end
+
+    it "returns search terms from query fragment" do
+      uri = URI("http://google.com/#q=how+to+extract+search+terms")
+      uri.search_string.should == "how to extract search terms"
+    end
+  end
+
+  context "yahoo" do
+    it "returns search terms from query string" do
+      uri = URI("http://search.yahoo.com/search;_ylt=abc123?p=how+to+extract+search+terms")
+      uri.search_string.should == "how to extract search terms"
+    end
+  end
+
+  context "bing" do
+    it "returns search terms from query string" do
+      uri = URI("http://www.bing.com/search?q=how+to+extract+search+terms")
+      uri.search_string.should == "how to extract search terms"
+    end
+  end
+
+  context "aol" do
+    it "returns search terms from query string" do
+      uri = URI("http://search.aol.com/aol/search?q=how+to+extract+search+terms")
+      uri.search_string.should == "how to extract search terms"
+    end
+  end
+
+  context "duckduckgo" do
+    it "returns search terms from query string" do
+      uri = URI("http://duckduckgo.com/?q=how+to+extract+search+terms")
+      uri.search_string.should == "how to extract search terms"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require "rubygems"
+require "bundler"
+Bundler.require(:default, :development)
+
+require File.expand_path("../lib/search_terms", File.dirname(__FILE__))

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification 
+name: search_terms
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Andy Lindeman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-10-24 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 2
+        - 7
+        - 0
+        version: 2.7.0
+  requirement: *id001
+  type: :development
+  prerelease: false
+  name: rspec
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id002
+  type: :development
+  prerelease: false
+  name: rake
+description: Supports extracting search terms from Google, Bing, Yahoo, DuckDuckGo, and AOL
+email: 
+- alindeman@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- README.md
+- Rakefile
+- lib/search_terms.rb
+- lib/search_terms/ext/uri.rb
+- lib/search_terms/extractor.rb
+- lib/search_terms/version.rb
+- search_terms.gemspec
+- spec/search_terms_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/alindeman/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: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: search_terms
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Extracts search terms from search engine referral URLs
+test_files: 
+- spec/search_terms_spec.rb
+- spec/spec_helper.rb