keyword_ranking 1.0

data/CHANGELOG

@@ -0,0 +1 @@
+v1.0. First draft

data/Gemfile

@@ -0,0 +1,9 @@
+source :gemcutter
+
+gemspec
+
+group 'development' do
+  gem 'echoe'
+  gem 'rspec'
+  gem 'nokogiri'
+end

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    keyword_ranking (1.0)
+      nokogiri
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    echoe (4.3.1)
+      gemcutter
+      rubyforge
+    gemcutter (0.6.1)
+    json_pure (1.4.6)
+    nokogiri (1.4.3.1)
+    rspec (1.3.0)
+    rubyforge (2.0.4)
+      json_pure (>= 1.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  echoe
+  keyword_ranking!
+  nokogiri
+  rspec

data/README

@@ -0,0 +1,19 @@
+Keyword Ranking
+
+Use this gem to calculate the keyword ranking in Bing, Yahoo or Google as follows:
+
+get_ranking(:keyword => 'one_keyword', :url => 'www.mydomain.com', :engine => :bing, :limit => 100)
+
+Note:
+
+* :engine can receive any of these values -->  :google, :yahoo or :bing
+* :limit by default is 200 (defined in RES_LIMIT constant)
+* You can change the results per page desired changing the value of RES_PER_PAGE having in mind that not all the 3 engines support more than 10 results per page with this utility
+
+More updates coming
+
+TODO:
+
+* Testing code
+* GEM for Rails structure
+

data/Rakefile

@@ -0,0 +1,2 @@
+require 'echoe'
+Echoe.new('keyword_ranking')

data/keyword_ranking.gemspec

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{keyword_ranking}
+  s.version = "1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Luis Alberto Velasco"]
+  s.date = %q{2010-08-17}
+  s.description = %q{Create keyword rankings from the 3 major browsers}
+  s.email = %q{whizkas@hotmail.com}
+  s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README", "lib/keyword_ranking.rb"]
+  s.files = ["CHANGELOG", "Gemfile", "Gemfile.lock", "LICENSE", "README", "Rakefile", "lib/keyword_ranking.rb", "spec/keyword_ranking_spec.rb", "spec/spec.opts", "keyword_ranking.gemspec"]
+  s.homepage = %q{http://github.com/whizkas/keyword_ranking}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Keyword_ranking", "--main", "README"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{keyword_ranking}
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Get keyword rankings from Google, Yahoo and Bing}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<nokogiri>, [">= 1.4.3.1"])
+      s.add_development_dependency(%q<bundler>, [">= 0.9.26"])
+    else
+      s.add_dependency(%q<nokogiri>, [">= 1.4.3.1"])
+      s.add_dependency(%q<bundler>, [">= 0.9.26"])
+    end
+  else
+    s.add_dependency(%q<nokogiri>, [">= 1.4.3.1"])
+    s.add_dependency(%q<bundler>, [">= 0.9.26"])
+  end
+end
+

data/lib/keyword_ranking.rb

@@ -0,0 +1,60 @@
+require 'singleton'
+require 'nokogiri'
+
+class Array
+  def extract_options!
+    last.is_a?(::Hash) ? pop : {}
+  end
+end
+
+module KeywordRanking
+  class Ranking
+
+    RES_LIMIT = 200
+    RES_PER_PAGE = 10 #careful, it doesn't work with more than 10 for all search engines!
+
+    include Singleton
+
+    def get(*args) # keyword, url, engine, limit
+      options = args.extract_options!
+      limit = options[:limit] ? options[:limit].to_i : RES_LIMIT
+      site_uri = options[:url].gsub(/(http:\/\/|https:\/\/)/, '').gsub(/^www/, '')
+      validate_arguments options
+      find_ranking(options[:keyword], site_uri, limit, options[:engine])
+    end
+
+    protected
+
+    def validate_arguments(options)
+      raise "Keyword and site parameters must be Strings" unless options[:keyword].is_a?(String) and options[:url].is_a?(String)
+      raise "Limit of #{RES_LIMIT} results at most" if options[:limit] > RES_LIMIT
+      raise "Engine should be 'bing', 'google' or 'yahoo'" unless [:bing, :google, :yahoo].include?(options[:engine].to_sym)
+    end
+
+    def find_ranking(keyword, site, limit, engine)
+      request_url, results_container, cite_container = case engine.to_sym
+      when :bing
+        ["http://www.bing.com/search?q=#{keyword}&count=#{RES_PER_PAGE}&first=", '#wg0 > li', 'cite']
+      when :google
+        ["http://www.google.com/search?q=#{keyword}&num=#{RES_PER_PAGE}&start=", '#ires > ol > li', 'cite']
+      when :yahoo
+        ["http://search.yahoo.com/search?p=#{keyword}&n=#{RES_PER_PAGE}&b=", '#web > ol > li', 'span']
+      end
+      count, rank = 0, nil
+      loop {
+        results = Nokogiri.parse(%x{ curl -A Mozilla "#{request_url}#{count}" }).css(results_container)
+        rank = results.index(results.detect{ |result| result.css(cite_container).text.match Regexp.new(site) })
+        if count > RES_LIMIT
+          break
+        elsif rank.present?
+          rank = count + rank
+          break
+        end
+        count += RES_PER_PAGE
+      }
+      rank.try(:next)
+    end
+
+  end
+end
+

data/spec/keyword_ranking_spec.rb

@@ -0,0 +1,20 @@
+$LOAD_PATH << File.expand_path('../../lib' , __FILE__)
+
+require 'rubygems'
+require 'bundler'
+Bundler.setup(:development)
+require 'keyword_ranking'
+
+module KeywordRanking
+
+    describe Ranking do
+
+      describe "#start" do
+        it "creates a ranking instance" do
+          Ranking.instance.should_not be(nil)
+        end 
+      end 
+
+    end 
+
+end

data/spec/spec.opts

@@ -0,0 +1,5 @@
+--colour
+--format progress
+--loadby mtime
+--reverse
+--drb

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification 
+name: keyword_ranking
+version: !ruby/object:Gem::Version 
+  hash: 15
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  version: "1.0"
+platform: ruby
+authors: 
+- Luis Alberto Velasco
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-17 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 113
+        segments: 
+        - 1
+        - 4
+        - 3
+        - 1
+        version: 1.4.3.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 9
+        - 26
+        version: 0.9.26
+  type: :development
+  version_requirements: *id002
+description: Create keyword rankings from the 3 major browsers
+email: whizkas@hotmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG
+- LICENSE
+- README
+- lib/keyword_ranking.rb
+files: 
+- CHANGELOG
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README
+- Rakefile
+- lib/keyword_ranking.rb
+- spec/keyword_ranking_spec.rb
+- spec/spec.opts
+- keyword_ranking.gemspec
+has_rdoc: true
+homepage: http://github.com/whizkas/keyword_ranking
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Keyword_ranking
+- --main
+- README
+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: 11
+      segments: 
+      - 1
+      - 2
+      version: "1.2"
+requirements: []
+
+rubyforge_project: keyword_ranking
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Get keyword rankings from Google, Yahoo and Bing
+test_files: []
+