yahoo_site_explorer 0.0.1

data/.document

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

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Nathaniel Bibler
+
+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,30 @@
+= Yahoo! Site Explorer
+
+The Yahoo! Site Explorer service provides access to Yahoo!'s information about web pages.  The service stores information about links between web pages and and can gauge the popularity of a given page.
+
+== Installation
+
+To install, simply:
+
+    gem install site-explorer
+
+
+== Example
+
+The following example queries Yahoo! Site Explorer for the number of inlinks (backlinks) for www.google.com:
+
+    require 'yahoo_site_explorer'
+    
+    service = YahooSiteExplorer.new('myapikey')
+    results = service.backlinks('http://www.google.com')
+    puts results.total_results #=> 941822
+
+== Caveats
+
+Currently, this library only implements the inlinksData, totalResultsAvailable, as that is the only data I need.  I'll extend this to fully support the API, shortly.
+
+== Copyright
+
+Yahoo! Site Explorer is owned, operated, and copyrighted (c) by Yahoo Inc.
+
+Copyright (c) 2009 Nathaniel Bibler. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,64 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "yahoo_site_explorer"
+    gem.summary = %Q{Ruby interface to the Yahoo! Site Explorer REST API}
+    gem.email = "gem@nathanielbibler.com"
+    gem.homepage = "http://github.com/nbibler/yahoo_site_explorer"
+    gem.authors = ["Nathaniel Bibler"]
+    gem.rubyforge_project = "site-explorer"
+    
+    gem.add_dependency('relax', '~> 0.1.1')
+    
+    gem.add_development_dependency('jeweler', '~> 0.11.0')
+    gem.add_development_dependency('mocha', '~> 0.9.5')
+    gem.add_development_dependency('thoughtbot-shoulda', '~> 2.10.1')
+    gem.add_development_dependency('fakeweb', '~> 1.2.2')
+  end
+
+  Jeweler::RubyforgeTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "yahoo_site_explorer #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/yahoo_site_explorer.rb

@@ -0,0 +1,29 @@
+require 'relax'
+require 'yahoo_site_explorer/api'
+require 'yahoo_site_explorer/backlinks'
+
+##
+# 
+# 
+class YahooSiteExplorer
+  
+  
+  def initialize(appid)
+    @appid = appid
+  end
+  
+  
+  def backlinks(url, options = {})
+    options[:query] ||= url
+    Backlinks.new(api.inlink_data(options))
+  end
+  
+  
+  private
+  
+  
+  def api
+    @api ||= API.new(:appid => @appid)
+  end
+  
+end

data/lib/yahoo_site_explorer/api.rb

@@ -0,0 +1,29 @@
+class YahooSiteExplorer
+  
+  class API < Relax::Service #:nodoc:
+    
+    defaults do
+      parameter :appid, :required => true
+      parameter :query, :required => true
+    end
+    
+    endpoint 'http://search.yahooapis.com/SiteExplorerService/V1/' do
+      
+      action :inlink_data, :url => 'inlinkData' do
+        parameter :results
+        parameter :start
+        parameter :entire_site
+        parameter :omit_inlinks
+        parameter :output
+        parameter :callback
+        
+        parser 'ResultSet' do
+          element :total_results, :attribute => 'totalResultsAvailable', :xpath => './/@totalResultsAvailable'
+        end
+      end
+      
+    end
+    
+  end
+  
+end

data/lib/yahoo_site_explorer/backlinks.rb

@@ -0,0 +1,17 @@
+class YahooSiteExplorer
+  
+  class Backlinks #:nodoc:
+    
+    attr_reader :total_results
+    
+    def initialize(backlinks_hash)
+      self.total_results = backlinks_hash[:total_results]
+    end
+    
+    def total_results=(count)
+      @total_results = count ? count.to_i : nil
+    end
+    
+  end
+  
+end

data/test/integrations/yahoo_site_explorer_test.rb

@@ -0,0 +1,34 @@
+require 'test_helper'
+
+class YahooSiteExplorerTest < Test::Unit::TestCase
+  
+  context 'YahooSiteExplorer' do
+    
+    context 'backlinks' do
+      
+      setup do
+        mock_response_for('http://search.yahooapis.com:80/SiteExplorerService/V1/inlinkData?appid=testid&query=http://www.google.com',
+                          :response => mock_inlink_data_successful_response)
+      end
+      
+      teardown do
+        FakeWeb.clean_registry
+      end
+      
+      should 'return Backlinks' do
+        assert_kind_of YahooSiteExplorer::Backlinks, site_explorer.backlinks('http://www.google.com')
+      end
+      
+      should 'return total_results as an integer' do
+        assert_equal 941822, site_explorer.backlinks('http://www.google.com').total_results
+      end
+      
+    end
+    
+  end
+  
+  def site_explorer
+    YahooSiteExplorer.new('testid')
+  end
+  
+end

data/test/mocks/inlink_data.rb

@@ -0,0 +1,33 @@
+def mock_inlink_data_successful_response
+<<-RESPONSE
+HTTP/1.1 200 OK
+Date: Mon, 08 Jun 2009 18:36:57 GMT
+P3P: policyref="http://info.yahoo.com/w3c/p3p.xml", CP="CAO DSP COR CUR ADM DEV TAI PSA PSD IVAi IVDi CONi TELo OTPi OUR DELi SAMi OTRi UNRi PUBi IND PHY ONL UNI PUR FIN COM NAV INT DEM CNT STA POL HEA PRE LOC GOV"
+Cache-Control: private
+Connection: close
+Transfer-Encoding: chunked
+Content-Type: text/xml; charset=utf-8
+
+<?xml version='1.0' encoding='UTF-8'?>
+<ResultSet
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns="urn:yahoo:srch"
+    xsi:schemaLocation="urn:yahoo:srch http://api.search.yahoo.com/SiteExplorerService/V1/InlinkDataResponse.xsd"
+    totalResultsAvailable="941822"
+    firstResultPosition="1"
+    totalResultsReturned="2">
+        <Result>
+        <Title>Common Dreams News Center</Title>
+        <Url>http://www.commondreams.org/</Url>
+        <ClickUrl>http://www.commondreams.org/</ClickUrl>
+    </Result>
+    <Result>
+        <Title>Scrub The Web</Title>
+        <Url>http://www.scrubtheweb.com/</Url>
+        <ClickUrl>http://www.scrubtheweb.com/</ClickUrl>
+    </Result>
+</ResultSet>
+<!-- fe02.sitex.search.ac2.yahoo.com uncompressed/chunked Mon Jun  8 11:36:57 PDT 2009 -->
+<!-- ws01.ydn.re2.yahoo.com uncompressed/chunked Mon Jun  8 11:36:57 PDT 2009 -->
+RESPONSE
+end

data/test/test_helper.rb

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'fakeweb'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+Dir[File.dirname(__FILE__) + '/mocks/**/*.rb'].each { |mock| require mock }
+
+require 'yahoo_site_explorer'
+
+# Disable all unregistered (mocked) network traffic when testing.
+FakeWeb.allow_net_connect = false
+
+class Test::Unit::TestCase
+  
+  def mock_response_for(url, response, method = :get)
+    FakeWeb.register_uri(method, url, response)
+  end
+  
+end

data/test/units/inlink_data_test.rb

@@ -0,0 +1,23 @@
+require 'test_helper'
+
+class InlinkDataTest < Test::Unit::TestCase
+  
+  context 'YahooSiteExplorer::API.inlink_data' do
+    
+    teardown do
+      FakeWeb.clean_registry
+    end
+    
+    should 'return the total number of query results' do
+      mock_response_for('http://search.yahooapis.com/SiteExplorerService/V1/inlinkData?appid=testid&query=http://www.google.com',
+                        :response => mock_inlink_data_successful_response)
+      assert_equal '941822', inlink_data(:query => 'http://www.google.com')[:total_results] 
+    end
+    
+  end
+  
+  def inlink_data(options = {})
+    YahooSiteExplorer::API.new.inlink_data({:appid => 'testid'}.merge(options))
+  end
+  
+end

data/yahoo_site_explorer.gemspec

@@ -0,0 +1,69 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{yahoo_site_explorer}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Nathaniel Bibler"]
+  s.date = %q{2009-06-08}
+  s.email = %q{gem@nathanielbibler.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/yahoo_site_explorer.rb",
+     "lib/yahoo_site_explorer/api.rb",
+     "lib/yahoo_site_explorer/backlinks.rb",
+     "test/integrations/yahoo_site_explorer_test.rb",
+     "test/mocks/inlink_data.rb",
+     "test/test_helper.rb",
+     "test/units/inlink_data_test.rb",
+     "yahoo_site_explorer.gemspec"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/nbibler/yahoo_site_explorer}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{site-explorer}
+  s.rubygems_version = %q{1.3.2}
+  s.summary = %q{Ruby interface to the Yahoo! Site Explorer REST API}
+  s.test_files = [
+    "test/integrations/yahoo_site_explorer_test.rb",
+     "test/mocks/inlink_data.rb",
+     "test/test_helper.rb",
+     "test/units/inlink_data_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<relax>, ["~> 0.1.1"])
+      s.add_development_dependency(%q<jeweler>, ["~> 0.11.0"])
+      s.add_development_dependency(%q<mocha>, ["~> 0.9.5"])
+      s.add_development_dependency(%q<thoughtbot-shoulda>, ["~> 2.10.1"])
+      s.add_development_dependency(%q<fakeweb>, ["~> 1.2.2"])
+    else
+      s.add_dependency(%q<relax>, ["~> 0.1.1"])
+      s.add_dependency(%q<jeweler>, ["~> 0.11.0"])
+      s.add_dependency(%q<mocha>, ["~> 0.9.5"])
+      s.add_dependency(%q<thoughtbot-shoulda>, ["~> 2.10.1"])
+      s.add_dependency(%q<fakeweb>, ["~> 1.2.2"])
+    end
+  else
+    s.add_dependency(%q<relax>, ["~> 0.1.1"])
+    s.add_dependency(%q<jeweler>, ["~> 0.11.0"])
+    s.add_dependency(%q<mocha>, ["~> 0.9.5"])
+    s.add_dependency(%q<thoughtbot-shoulda>, ["~> 2.10.1"])
+    s.add_dependency(%q<fakeweb>, ["~> 1.2.2"])
+  end
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification 
+name: yahoo_site_explorer
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Nathaniel Bibler
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-08 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: relax
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.1.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.11.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.9.5
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.10.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.2.2
+    version: 
+description: 
+email: gem@nathanielbibler.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/yahoo_site_explorer.rb
+- lib/yahoo_site_explorer/api.rb
+- lib/yahoo_site_explorer/backlinks.rb
+- test/integrations/yahoo_site_explorer_test.rb
+- test/mocks/inlink_data.rb
+- test/test_helper.rb
+- test/units/inlink_data_test.rb
+- yahoo_site_explorer.gemspec
+has_rdoc: true
+homepage: http://github.com/nbibler/yahoo_site_explorer
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: site-explorer
+rubygems_version: 1.3.2
+signing_key: 
+specification_version: 3
+summary: Ruby interface to the Yahoo! Site Explorer REST API
+test_files: 
+- test/integrations/yahoo_site_explorer_test.rb
+- test/mocks/inlink_data.rb
+- test/test_helper.rb
+- test/units/inlink_data_test.rb