uk_ranking 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,19 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+
+source :gemcutter
+
+gem 'nokogiri'
+
+
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,31 @@
+GEM
+  remote: http://rubygems.org/
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    nokogiri (1.5.0)
+    rake (0.9.2.2)
+    rcov (0.9.11)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  nokogiri
+  rcov
+  rspec (~> 2.3.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Stewart Dick
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,19 @@
+= uk_ranking
+
+Description goes here.
+
+== Contributing to uk_ranking
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Stewart Dick. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "uk_ranking"
+  gem.homepage = "http://github.com/stewd/uk_ranking"
+  gem.license = "MIT"
+  gem.summary = %Q{Get Keyword Ranking for Google UK}
+  gem.description = %Q{A modification of keyword_ranking. To pull the Google UK Rank for a given keyword}
+  gem.email = "stewart@stewd.co.uk"
+  gem.authors = ["Stewart Dick"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "uk_ranking #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/uk_ranking.rb

@@ -0,0 +1,84 @@
+require 'rubygems'
+require 'nokogiri'
+require 'net/http'
+
+class Array
+  def extract_options!
+    last.is_a?(::Hash) ? pop : {}
+  end
+end
+
+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!
+
+  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 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_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(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=#{options[:keyword]}&count=#{options[:res_per_page]}&first=", '#wg0 > li', 'cite']
+    when :google
+      ["http://www.google.co.uk/search?q=#{options[:keyword]}&num=#{options[:res_per_page]}&start=", '#ires > ol > li', 'cite']
+    when :yahoo
+      ["http://search.yahoo.com/search?p=#{options[:keyword]}&n=#{options[:res_per_page]}&b=", '#web > ol > li', 'span']
+    end
+
+    count, rank = 0, nil
+
+    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(options[:url]) })
+
+      if count > options[:limit]
+        break
+      elsif rank
+        rank += count
+        break
+      end
+      count += options[:res_per_page]
+    }
+
+    rank ? rank.next : nil
+
+   end
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'uk_ranking'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

data/spec/uk_ranking_spec.rb

@@ -0,0 +1,72 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+# describe "KeywordRanking" do
+#   it "fails" do
+#     fail "hey buddy, you should probably rename this file and start specing for real"
+#   end
+# end
+# 
+# 
+# # $LOAD_PATH << File.expand_path('../../lib' , __FILE__)
+# # 
+# # require 'rubygems'
+# # 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
+
+      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

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: uk_ranking
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Stewart Dick
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-14 00:00:00.000000000 +00:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &2157628860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2157628860
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2157628320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *2157628320
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2157627740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *2157627740
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &2157627080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *2157627080
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &2157626480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2157626480
+description: A modification of keyword_ranking. To pull the Google UK Rank for a given
+  keyword
+email: stewart@stewd.co.uk
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/uk_ranking.rb
+- spec/spec_helper.rb
+- spec/uk_ranking_spec.rb
+has_rdoc: true
+homepage: http://github.com/stewd/uk_ranking
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Get Keyword Ranking for Google UK
+test_files: []