PageRankr 1.5.1 → 1.6.0

data/.gitignore

@@ -21,4 +21,5 @@ pkg
 ## PROJECT::SPECIFIC
 .idea
 doc
-.yardoc
+.yardoc
+.bundle

data/CHANGELOG.md

@@ -1,4 +1,16 @@
 # Change Log
+## Version 1.6
+
+* Added ability to get global alexa rank instead of just us alexa rank.
+
+## Version 1.5.1
+
+* Added json gem requirement for rubies < 1.9
+
+## Version 1.5.0
+
+* Use googles api to retrieve backlinks.
+* Changed workflow for building gems.
 
 ## Version 1.4.3
 

data/Gemfile.lock

@@ -1,17 +1,38 @@
 PATH
   remote: .
   specs:
-    PageRankr (1.5.0)
+    PageRankr (1.6.0)
+      json (>= 1.4.6)
       nokogiri (>= 1.4.1)
 
 GEM
   remote: http://rubygems.org/
   specs:
+    diff-lcs (1.1.2)
+    fuubar (0.0.2)
+      rspec (~> 2.0)
+      rspec-instafail (~> 0.1.4)
+      ruby-progressbar (~> 0.0.9)
+    json (1.4.6)
     nokogiri (1.4.3.1)
+    rspec (2.1.0)
+      rspec-core (~> 2.1.0)
+      rspec-expectations (~> 2.1.0)
+      rspec-mocks (~> 2.1.0)
+    rspec-core (2.1.0)
+    rspec-expectations (2.1.0)
+      diff-lcs (~> 1.1.2)
+    rspec-instafail (0.1.5)
+    rspec-mocks (2.1.0)
+    ruby-progressbar (0.0.9)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   PageRankr!
+  bundler (>= 1.0.0)
+  fuubar (>= 0.0.1)
+  json (>= 1.4.6)
   nokogiri (>= 1.4.1)
+  rspec (~> 2.1.0)

data/PageRankr.gemspec

@@ -1,42 +1,26 @@
 require File.expand_path("../lib/page_rankr/version", __FILE__)
 
 Gem::Specification.new do |s|
-  s.name = %q{PageRankr}
-  s.version = PageRankr::VERSION
+  s.name        = "PageRankr"
+  s.version     = PageRankr::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Allen Madsen"]
+  s.email       = ["blatyo@gmail.com"]
+  s.homepage    = "http://github.com/blatyo/page_rankr"
+  s.summary     = "Easy way to retrieve Google Page Rank, Alexa Rank, and backlink counts"
+  s.description = "Easy way to retrieve Google Page Rank, Alexa Rank, and backlink counts"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Allen Madsen"]
-  s.date = %q{2010-07-07}
-  s.description = %q{Easy way to retrieve Google Page Rank, Alexa Rank, and backlink counts}
-  s.email = %q{blatyo@gmail.com}
-  s.extra_rdoc_files = [
-    "LICENSE.md",
-     "README.md"
-  ]
-  
-  s.files        = `git ls-files`.split("\n")
-  s.test_files   = `git ls-files`.split("\n").map{|f| f =~ /^spec\/(.*)/ ? $1 : nil}.compact
-  s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
-  s.homepage = %q{http://github.com/blatyo/page_rankr}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.5.0}
-  s.summary = %q{Easy way to retrieve Google Page Rank, Alexa Rank, and backlink counts}
+  s.required_rubygems_version = ">= 1.3.6"
+  s.add_development_dependency "rspec",   "~> 2.1.0"
+  s.add_development_dependency "bundler", ">= 1.0.0"
+  s.add_development_dependency "fuubar",  ">= 0.0.1"
 
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
+  s.add_runtime_dependency "nokogiri", ">= 1.4.1"
+  s.add_runtime_dependency "json",     ">= 1.4.6"
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<nokogiri>, [">= 1.4.1"])
-      s.add_runtime_dependency(%q<json>, [">= 1.4.6"])
-    else
-      s.add_dependency(%q<nokogiri>, [">= 1.4.1"])
-      s.add_dependency(%q<json>, [">= 1.4.6"])
-    end
-  else
-    s.add_dependency(%q<nokogiri>, [">= 1.4.1"])
-    s.add_dependency(%q<json>, [">= 1.4.6"])
-  end
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  s.require_paths = ["lib"]
 end
 

data/README.md

@@ -10,7 +10,7 @@ Check out a little [web app][1] I wrote up that uses it or look at the [source][
 ## Get it!
 
     gem install PageRankr
-    
+
 ## Use it!
 
     require 'page_rankr'
@@ -21,16 +21,16 @@ Backlinks are the result of doing a search with a query like "link:www.google.co
 
     PageRankr.backlinks('www.google.com', :google, :bing) #=> {:google=>161000, :bing=>208000000}
     PageRankr.backlinks('www.google.com', :yahoo)         #=> {:yahoo=>256300062}
-    
+
 If you don't specify a search engine, then all of them are used.
 
     # this
-    PageRankr.backlinks('www.google.com') 
-        #=> {:google=>23000, :bing=>215000000, :yahoo=>250522337, :altavista=>137000000, :alltheweb=>74500000, :alexa=>727036} 
-    
+    PageRankr.backlinks('www.google.com')
+        #=> {:google=>23000, :bing=>215000000, :yahoo=>250522337, :altavista=>137000000, :alltheweb=>74500000, :alexa=>727036}
+
     # is equivalent to
     PageRankr.backlinks('www.google.com', :google, :bing, :yahoo, :altavista, :alltheweb, :alexa)
-        #=> {:google=>23000, :bing=>215000000, :yahoo=>250522337, :altavista=>137000000, :alltheweb=>74500000, :alexa=>727036} 
+        #=> {:google=>23000, :bing=>215000000, :yahoo=>250522337, :altavista=>137000000, :alltheweb=>74500000, :alexa=>727036}
 
 You can also use the alias `backlink` instead of `backlinks`.
 Valid search engines are: `:google, :bing, :yahoo, :altavista, :alltheweb, :alexa`. To get this list you can do:
@@ -39,10 +39,10 @@ Valid search engines are: `:google, :bing, :yahoo, :altavista, :alltheweb, :alex
 
 ### Ranks
 
-    PageRankr.ranks('www.google.com', :alexa, :google) #=> {:alexa=>1, :google=>10}
-    
+    PageRankr.ranks('www.google.com', :alexa, :google) #=> {:alexa=>{:us=>1, :global=>1}, :google=>10}
+
     # this also gives the same result
-    PageRankr.ranks('www.google.com')                  #=> {:alexa=>1, :google=>10}
+    PageRankr.ranks('www.google.com')                  #=> {:alexa=>{:us=>1, :global=>1}, :google=>10}
 
 You can also use the alias `rank` instead of `ranks`.
 There are two valid rank trackers supported: `:alexa, :google`. To get this you can do:
@@ -76,11 +76,11 @@ If you ever come across a site that provides a rank or backlinks you can hook th
           def url(site)
             "http://example.com/?q=#{site}"
           end
-          
+
           def xpath
             "//backlinks/text()"
           end
-          
+
           def clean(backlink_count)
             #do some of my own cleaning
             super(backlink_count) # strips letters, commas, and a few other nasty things and converts it to an integer
@@ -88,11 +88,11 @@ If you ever come across a site that provides a rank or backlinks you can hook th
         end
       end
     end
-    
-Then, just make sure you require the class and PageRankr and whenver you call PageRankr.backlinks it'll be able to use your class.
+
+Then, just make sure you require the class and PageRankr and whenever you call PageRankr.backlinks it'll be able to use your class.
 
 ## Note on Patches/Pull Requests
- 
+
 * Fork the project.
 * Make your feature addition or bug fix.
 * Add tests for it. This is important so I don't break it in a
@@ -101,18 +101,13 @@ Then, just make sure you require the class and PageRankr and whenver you call Pa
   (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.
 
-## TODO
-* <del>Get backlink counts for:</del>
-  * <del>Google</del>
-  * <del>Bing</del>
-  * <del>Yahoo!</del>
-  * <del>AltaVista</del>
-  * <del>AllTheWeb</del>
-  * <del>Alexa</del>
-* <del>Get Google Page Rank</del>
-  * <del>Implement Hashing Algorithm</del>
-* <del>Get Alexa ranking</del>
+## TODO Version 2
 * Use API's where possible
+* Use [Typhoeus](https://github.com/pauldix/typhoeus) to improve speed when requesting multiple ranks and/or backlinks
+* Configuration
+    * API keys
+    * Alexa rank options
+* Add compete rank tracker
 
 ## Contributors
 * [Druwerd](http://github.com/Druwerd) - Use Google Search API instead of scraping.
@@ -120,9 +115,9 @@ Then, just make sure you require the class and PageRankr and whenver you call Pa
 ## Shout Out
 Gotta give credit where credits due!
 
-* http://github.com/alexmipego/PageRankSharp
-* http://snipplr.com/view/18329/google-page-range-lookup/
-* http://www.sitetoolcenter.com/free-website-scripts/ajax-pr-checker.php 
+* [http://github.com/alexmipego/PageRankSharp](http://github.com/alexmipego/PageRankSharp)
+* [http://snipplr.com/view/18329/google-page-range-lookup/](http://snipplr.com/view/18329/google-page-range-lookup/)
+* [http://www.sitetoolcenter.com/free-website-scripts/ajax-pr-checker.php](http://www.sitetoolcenter.com/free-website-scripts/ajax-pr-checker.php)
 
 ## Copyright
 

data/Rakefile

@@ -1,31 +1,5 @@
-require 'rubygems'
-require 'rake'
+require 'bundler'
+Bundler::GemHelper.install_tasks
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "PageRankr"
-    gem.summary = %Q{Easy way to retrieve Google Page Rank, Alexa Rank, and backlink counts}
-    gem.description = %Q{Easy way to retrieve Google Page Rank, Alexa Rank, and backlink counts}
-    gem.email = "blatyo@gmail.com"
-    gem.homepage = "http://github.com/blatyo/page_rankr"
-    gem.authors = ["Allen Madsen"]
-    gem.add_dependency "nokogiri", ">= 1.4.1"
-    gem.add_development_dependency "yard", ">= 0"
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
-
-task :default => :yardoc
-
-begin
-  require 'yard'
-  YARD::Rake::YardocTask.new
-rescue LoadError
-  task :yardoc do
-    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
-  end
-end
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)

data/lib/page_rankr/ranks/alexa.rb

@@ -6,11 +6,16 @@ module PageRankr
   class Ranks < Tracker
     class Alexa < Rank
       def initialize(site)
-        @rank = Nokogiri::HTML(open(url(site))).search(xpath).to_s.to_i
+        @rank = {}
+        xpath.each_key do |key|
+          @rank[key] = Nokogiri::HTML(open(url(site))).search(xpath[key]).to_s.to_i
+        end
+        @rank
       end
       
       def xpath
-        "//reach/@rank"
+        { :us     => "//reach/@rank", 
+          :global => "//popularity/@text" }
       end
       
       def url(site)

data/lib/page_rankr/version.rb

@@ -1,3 +1,3 @@
 module PageRankr
-  VERSION = "1.5.1"
+  VERSION = "1.6.0"
 end

data/spec/page_rankr_spec.rb

@@ -0,0 +1,91 @@
+require 'spec_helper'
+
+RSpec::Matchers.define :be_in do |expected|
+  match do |actual|
+    expected === actual
+  end
+  
+  failure_message_for_should do |actual|
+    "expected that #{actual} would be in #{expected}"
+  end
+end
+
+describe PageRankr do
+  describe "#rank_trackers" do
+    subject{ PageRankr.rank_trackers }
+    
+    it{ should include(:alexa) }
+    it{ should include(:google) }
+  end
+
+  describe "#ranks" do
+    describe "success" do
+      subject{ PageRankr.ranks("google.com") }
+  
+      it{ should have_key(:alexa) }
+      it{ should have_key(:google) }
+    
+      let(:alexa_rank) { subject[:alexa] }
+      it{ alexa_rank.should have_key(:us) }
+      it{ alexa_rank.should have_key(:global) }
+    
+      let(:alexa_us_rank) { alexa_rank[:us] }
+      it{ alexa_us_rank.should >= 1 }
+      let(:alexa_global_rank) { alexa_rank[:global] }
+      it{ alexa_global_rank.should >= 1 }
+    
+      let(:google_rank) { subject[:google] }
+      it{ google_rank.should be_in(0..10)}
+    end
+    
+    describe "failure" do
+      subject{ PageRankr.ranks("please-dont-register-a-site-that-breaks-this-test.com") }
+      
+      it{ should have_key(:alexa) }
+      it{ should have_key(:google) }
+      
+      let(:alexa_rank) { subject[:alexa] }
+      it{ alexa_rank.should have_key(:us) }
+      it{ alexa_rank.should have_key(:global) }
+    
+      let(:alexa_us_rank) { alexa_rank[:us] }
+      it{ alexa_us_rank.should == 0 }
+      let(:alexa_global_rank) { alexa_rank[:global] }
+      it{ alexa_global_rank.should == 0 }
+    
+      let(:google_rank) { subject[:google] }
+      it{ google_rank.should == -1 }
+    end
+  end
+  
+  describe "#backlink_trackers" do
+    subject{ PageRankr.backlink_trackers }
+    
+    it{ should include(:alexa) }
+    it{ should include(:alltheweb) }
+    it{ should include(:altavista) }
+    it{ should include(:bing) }
+    it{ should include(:google) }
+    it{ should include(:yahoo) }
+  end
+  
+  describe "#backlinks" do
+    describe "success" do
+      subject{ PageRankr.backlinks("google.com") }
+    
+      PageRankr.backlink_trackers.each do |tracker|
+        it{ should have_key(tracker) }
+        it{ subject[tracker].should >= 0 }
+      end
+    end
+    
+    describe "failure" do
+      subject{ PageRankr.backlinks("please-dont-register-a-site-that-breaks-this-test.com") }
+      
+      PageRankr.backlink_trackers.each do |tracker|
+        it{ should have_key(tracker) }
+        it{ subject[tracker].should == 0 }
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require File.join(File.dirname(__FILE__), '..', 'lib', 'page_rankr')
+require 'rspec'
+require 'fuubar'
+
+Rspec.configure do |c|
+  c.formatter = Fuubar
+  c.color_enabled = true
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 1
-  - 5
-  - 1
-  version: 1.5.1
+  - 6
+  - 0
+  version: 1.6.0
 platform: ruby
 authors: 
 - Allen Madsen
@@ -14,13 +14,58 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-07 00:00:00 -04:00
+date: 2010-12-04 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: nokogiri
+  name: rspec
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 1
+        - 0
+        version: 2.1.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: fuubar
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 0
+        - 1
+        version: 0.0.1
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -31,11 +76,11 @@ dependencies:
         - 1
         version: 1.4.1
   type: :runtime
-  version_requirements: *id001
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: json
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -46,19 +91,17 @@ dependencies:
         - 6
         version: 1.4.6
   type: :runtime
-  version_requirements: *id002
+  version_requirements: *id005
 description: Easy way to retrieve Google Page Rank, Alexa Rank, and backlink counts
-email: blatyo@gmail.com
+email: 
+- blatyo@gmail.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- LICENSE.md
-- README.md
+extra_rdoc_files: []
+
 files: 
-- .bundle/config
-- .document
 - .gitignore
 - .rvmrc
 - CHANGELOG.md
@@ -84,13 +127,15 @@ files:
 - lib/page_rankr/ranks/google/checksum.rb
 - lib/page_rankr/tracker.rb
 - lib/page_rankr/version.rb
+- spec/page_rankr_spec.rb
+- spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/blatyo/page_rankr
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -107,8 +152,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   - - ">="
     - !ruby/object:Gem::Version 
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
 requirements: []
 
 rubyforge_project: 
@@ -116,5 +163,6 @@ rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Easy way to retrieve Google Page Rank, Alexa Rank, and backlink counts
-test_files: []
-
+test_files: 
+- spec/page_rankr_spec.rb
+- spec/spec_helper.rb

data/.bundle/config

@@ -1,2 +0,0 @@
---- 
-BUNDLE_DISABLE_SHARED_GEMS: "1"

data/.document

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