keyword_ranking 1.0.2.1 → 1.1

data/README.markdown

@@ -0,0 +1,19 @@
+#Keyword Ranking
+
+Use this gem to calculate the keyword ranking for *Bing*, *Yahoo* or *Google* as follows:
+
+KeywordRanking::Ranking.new(:keyword => 'one keyword', :url => 'www.mydomain.com', :limit => 100).from_google
+
+##Note
+
+* Only *:keyword* and *:url* are required
+* You can search -->  *.from_google*,  *.from_yahoo*,  *.from_bing*
+* *:limit* by default is 200
+* You can change the results per page value changing *: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
+
+* Improve Testing Code
+

data/keyword_ranking.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{keyword_ranking}
-  s.version = "1.0.2.1"
+  s.version = "1.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 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.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README.markdown", "lib/keyword_ranking.rb"]
+  s.files = ["CHANGELOG", "Gemfile", "LICENSE", "README.markdown", "Rakefile", "lib/keyword_ranking.rb", "spec/keyword_ranking_spec.rb", "spec/spec.opts", "keyword_ranking.gemspec"]
   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"]

data/lib/keyword_ranking.rb

@@ -9,43 +9,57 @@ end
 
 module KeywordRanking
 
-  RES_LIMIT = 200
-  RES_PER_PAGE = 10 #careful, it doesn't work with more than 10 for all search engines!
 
   class Ranking
+    @@default_options = { :limit => 200, :res_per_page => 10, :supported_engines => [:bing, :google, :yahoo] } #careful, res_per_page doesn't work with more than 10 for all search engines!
 
-    def initialize(finder = Finder.new)
-      @finder = finder
+    attr_reader :options
+
+    def initialize(*options) # keyword, url, limit
+      self.options = options.extract_options!
+    end
+
+    def options=(options)
+      @options = @@default_options.merge(options)
+      @options[:url].gsub!(/(http:\/\/|https:\/\/)/, '')
+      @options[:url].gsub!(/^www/, '')
     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
-      @finder.find(options[:keyword], site_uri, limit, options[:engine])
+    def from
+      validate_options
+      @finder ||= Finder.new
+      @finder.find(@options)
+    end
+
+    def method_missing(method, *args, &block)
+      engine = @@default_options[:supported_engines].find{ |name| ("from_" << name.to_s).match /#{method}/ }
+      if engine
+        @options.merge!({:engine => engine})
+        send("from")
+      else
+        super(method, *args, &block)
+      end
     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)
+    def validate_options
+      raise "Keyword and site parameters must be Strings" unless @options[:keyword].is_a?(String) and @options[:url].is_a?(String)
+      raise "Engine should be 'bing', 'google' or 'yahoo'" unless @@default_options[:supported_engines].include?(@options[:engine].to_sym)
     end
 
   end
 
   class Finder
 
-    def find(keyword, site, limit, engine)
-      keyword.gsub!(/\s/, '+')
-      request_url, results_selector, cite_selector = case engine.to_sym
+    def find(options) #keyword, url, limit, engine, res_per_page
+      options[:keyword].gsub!(/\s/, '+')
+      request_url, results_selector, cite_selector = case options[:engine].to_sym
       when :bing
-        ["http://www.bing.com/search?q=#{keyword}&count=#{RES_PER_PAGE}&first=", '#wg0 > li', 'cite']
+        ["http://www.bing.com/search?q=#{options[:keyword]}&count=#{options[: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']
+        ["http://www.google.com/search?q=#{options[:keyword]}&num=#{options[: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']
+        ["http://search.yahoo.com/search?p=#{options[:keyword]}&n=#{options[:res_per_page]}&b=", '#web > ol > li', 'span']
       end
 
       count, rank = 0, nil
@@ -53,15 +67,15 @@ module KeywordRanking
       loop {
         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) })
+        rank = html_results.index(html_results.detect{ |result| result.css(cite_selector).text.match Regexp.new(options[:url]) })
 
-        if count > limit
+        if count > options[:limit]
           break
         elsif rank
           rank += count
           break
         end
-        count += RES_PER_PAGE
+        count += options[:res_per_page]
       }
 
       rank ? rank.next : nil
@@ -71,3 +85,4 @@ module KeywordRanking
   end
 
 end
+

metadata

@@ -1,14 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: keyword_ranking
 version: !ruby/object:Gem::Version 
-  hash: 85
+  hash: 13
   prerelease: false
   segments: 
   - 1
-  - 0
-  - 2
   - 1
-  version: 1.0.2.1
+  version: "1.1"
 platform: ruby
 authors: 
 - Luis Alberto Velasco
@@ -61,13 +59,13 @@ extensions: []
 extra_rdoc_files: 
 - CHANGELOG
 - LICENSE
-- README
+- README.markdown
 - lib/keyword_ranking.rb
 files: 
 - CHANGELOG
 - Gemfile
 - LICENSE
-- README
+- README.markdown
 - Rakefile
 - lib/keyword_ranking.rb
 - spec/keyword_ranking_spec.rb

data/README

@@ -1,18 +0,0 @@
-Keyword Ranking
-
-Use this gem to calculate the keyword ranking for Bing, Yahoo or Google as follows:
-
-KeywordRanking::Ranking.get(: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
-