keyword_ranking 1.0.1 → 1.0.2.1

data/Gemfile

@@ -5,5 +5,5 @@ gemspec
 group 'development' do
   gem 'echoe'
   gem 'rspec'
-  gem 'nokogiri'
+  gem 'nokogiri' , ">= 1.4.3.1"
 end

data/README

@@ -1,8 +1,8 @@
 Keyword Ranking
 
-Use this gem to calculate the keyword ranking in Bing, Yahoo or Google as follows:
+Use this gem to calculate the keyword ranking for Bing, Yahoo or Google as follows:
 
-KeywordRanking::Ranking.instance.get(:keyword => 'one_keyword', :url => 'www.mydomain.com', :engine => :bing, :limit => 100)
+KeywordRanking::Ranking.get(:keyword => 'one_keyword', :url => 'www.mydomain.com', :engine => :bing, :limit => 100)
 
 Note:
 
@@ -15,5 +15,4 @@ More updates coming
 TODO:
 
 * Testing code
-* GEM for Rails structure
 

data/keyword_ranking.gemspec

@@ -2,16 +2,16 @@
 
 Gem::Specification.new do |s|
   s.name = %q{keyword_ranking}
-  s.version = "1.0.1"
+  s.version = "1.0.2.1"
 
   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.description = %q{Create keyword rankings from the 3 major search engines}
   s.email = %q{whizkas@hotmail.com}
   s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README", "lib/keyword_ranking.rb"]
   s.files = ["CHANGELOG", "Gemfile", "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.homepage = %q{http://github.com/crowdint/keyword_ranking}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Keyword_ranking", "--main", "README"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{keyword_ranking}

data/lib/keyword_ranking.rb

@@ -1,5 +1,5 @@
-require 'singleton'
 require 'nokogiri'
+require 'net/http'
 
 class Array
   def extract_options!
@@ -8,32 +8,38 @@ class Array
 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!
+  RES_LIMIT = 200
+  RES_PER_PAGE = 10 #careful, it doesn't work with more than 10 for all search engines!
+
+  class Ranking
 
-    include Singleton
+    def initialize(finder = Finder.new)
+      @finder = finder
+    end
 
     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])
+      @finder.find(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)
+  end
+
+  class Finder
+
+    def find(keyword, site, limit, engine)
       keyword.gsub!(/\s/, '+')
-      request_url, results_container, cite_container = case engine.to_sym
+      request_url, results_selector, cite_selector = case engine.to_sym
       when :bing
         ["http://www.bing.com/search?q=#{keyword}&count=#{RES_PER_PAGE}&first=", '#wg0 > li', 'cite']
       when :google
@@ -41,21 +47,27 @@ module KeywordRanking
       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
+        html_response = Net::HTTP.get_response(URI.parse("#{request_url}#{count}")).body
+        html_results = Nokogiri.parse(html_response).css(results_selector)
+        rank = html_results.index(html_results.detect{ |result| result.css(cite_selector).text.match Regexp.new(site) })
+
+        if count > limit
           break
-      elsif rank
-          rank = count + rank
+        elsif rank
+          rank += count
           break
         end
         count += RES_PER_PAGE
       }
-      rank.try(:next)
-    end
+
+      rank ? rank.next : nil
+
+     end
 
   end
-end
 
+end

data/spec/keyword_ranking_spec.rb

@@ -5,16 +5,59 @@ require 'bundler'
 Bundler.setup(:development)
 require 'keyword_ranking'
 
+module FinderSpecHelper
+  class Finder
+    def find(keyword, site, limit, engine)
+      0
+    end
+  end
+end
+
 module KeywordRanking
 
     describe Ranking do
 
-      describe "#start" do
-        it "creates a ranking instance" do
-          Ranking.instance.should_not be(nil)
+      let (:options) { {:keyword => 'agile', :url => 'www.crowdint.com', :engine => 'google', :limit => 20} }
+      let(:ranking) { Ranking.new(FinderSpecHelper::Finder.new) }
+
+      context '#get ranking fails' do
+
+        it 'without parameters' do
+          lambda { ranking.get }.should raise_exception
+        end
+
+        it 'with unsupported engine' do
+          lambda { ranking.get(options.merge({:engine => 'mugle'})) }.should raise_exception
+        end 
+
+        it 'exceeding results limit' do
+          lambda { ranking.get(options.merge({:limit => 201})) }.should raise_exception
+        end 
+
+        it 'with bad keyword and url data types' do
+          lambda { ranking.get(options.merge({:keyword  => 1000, :url => 1.2})) }.should raise_exception
         end 
+
+        it 'using malformed URLs'
+
       end 
 
+      context '#get ranking success' do
+
+        it 'with correct parameters on google' do
+          ranking.get(options).should equal 0
+        end
+
+        it 'with correct parameters on yahoo'
+
+        it 'with correct parameters on bing'
+
+        it 'should support multiple keywords'
+
+        it 'should support a symbol as an engine name'
+
+      end
+
     end 
 
 end

data/spec/spec.opts

@@ -2,4 +2,3 @@
 --format progress
 --loadby mtime
 --reverse
---drb

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification 
 name: keyword_ranking
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 85
   prerelease: false
   segments: 
   - 1
   - 0
+  - 2
   - 1
-  version: 1.0.1
+  version: 1.0.2.1
 platform: ruby
 authors: 
 - Luis Alberto Velasco
@@ -51,7 +52,7 @@ dependencies:
         version: 0.9.26
   type: :development
   version_requirements: *id002
-description: Create keyword rankings from the 3 major browsers
+description: Create keyword rankings from the 3 major search engines
 email: whizkas@hotmail.com
 executables: []
 
@@ -73,7 +74,7 @@ files:
 - spec/spec.opts
 - keyword_ranking.gemspec
 has_rdoc: true
-homepage: http://github.com/whizkas/keyword_ranking
+homepage: http://github.com/crowdint/keyword_ranking
 licenses: []
 
 post_install_message: