eshopworks-rboss 0.1.0 → 0.1.1

data/History.txt

@@ -1,2 +1,7 @@
-== 0.1.0
+=== Version 0.1.1
+* Fixed exact search error
+* search method takes the same arguments as other search methods
+* Encodes parameters correctly
+
+=== Version 0.1.0
 * Brand spanking new release.

data/Manifest.txt

@@ -11,6 +11,7 @@ gem_tasks/environment.rake
 gem_tasks/fix_cr_lf.rake
 gem_tasks/gemspec.rake
 gem_tasks/rspec.rake
+gem_tasks/verify_rcov.rake
 gem_tasks/website.rake
 lib/boss.rb
 lib/boss/api.rb

data/README.textile

@@ -1,14 +1,14 @@
-h1. RBoss-gem Yahoo Boss Search
-
-"Yahoo boss search":http://developer.yahoo.com/search/boss/
-
-"Yahoo boss API":http://developer.yahoo.com/search/boss/boss_guide/
+h1. RBoss Gem - Yahoo! Boss Search
 
 h2.  DESCRIPTION:
 
 A handy gem to make using the Yahoo Boss API nice and easy in ruby.
 
-Bug Tracking: "http://eshopworks.lighthouseapp.com/projects/15732-rboss/overview":http://eshopworks.lighthouseapp.com/projects/15732-rboss/overview
+"Yahoo! Boss Search official site":http://developer.yahoo.com/search/boss/
+
+"Yahoo! Boss Search API":http://developer.yahoo.com/search/boss/boss_guide/
+
+Add feature requests and bugs here: "http://eshopworks.lighthouseapp.com/projects/15732-rboss/overview":http://eshopworks.lighthouseapp.com/projects/15732-rboss/overview
 
 h2.  FEATURES:
 
@@ -47,6 +47,12 @@ h2. USAGE:
   # lang = eng
   api.search('monkeys')
   
+  #Delimit multiple search terms with commas
+  api.search('dancing,monkeys')
+
+  #Delimit Exact search with quotation marks
+  api.search('"dancing monkeys"')
+    
   #Search images, spelling, news and web
   api.search_images('monkeys')
   api.search_spelling('monkeys')
@@ -66,8 +72,86 @@ h2. USAGE:
     config.count = 5
   end
 </code></pre>
+
+h3. Global Search Options
+
+<pre><code>
+  api.search('monkeys') do |config|
+    config.start = 1
+    config.count = 10
+    config.lang = 'en'
+    config.region = 'us'
+    config.format = 'xml'
+    config.callback = ''
+    config.sites = 'abc.com,cnn.com'
+  end
+</pre></code>
+
+h3. Web Search Result
+
+<pre><code>
+  results = api.search_web('monkeys')
+  results.each do |web|
+    puts web.abstract
+    puts web.date
+    puts web.dispurl  #URL of document matching the query result.
+    puts web.clickurl #navigation URL that leads to the target URL
+    puts web.size     #document’s size in bytes
+    puts web.title
+    puts web.url
+  end
+</code></pre>
+
+h3. News Search Result
+
+<pre><code>
+  results = api.search_news('monkeys')
+  results.each do |news|
+    puts news.abstract
+    puts news.clickurl
+    puts news.title
+    puts news.language
+    puts news.date
+    puts news.time
+    puts news.source
+    puts news.sourceurl
+    puts news.url
+  end
+</code></pre>
   
-Check "http://developer.yahoo.com/search/boss/boss_guide/":http://developer.yahoo.com/search/boss/boss_guide/ for the different values accessible for news/images/web/spell ruby object results
+h3. Image Search Result
+
+<pre><code>
+  results = api.search_image('monkeys')
+  results.each do |image|
+    puts image.abstract
+    puts image.clickurl
+    puts image.filename
+    puts image.size
+    puts image.format
+    puts image.height
+    puts image.date
+    puts image.mimetype
+    puts image.refererclickurl
+    puts image.refererurl
+    puts image.title
+    puts image.url
+    puts image.width
+    puts image.thumbnail_height
+    puts image.thumbnail_url
+    puts image.thumbnail_width
+  end
+</code></pre>
+
+h3. Spell Search Result
+
+<pre><code>
+  results = api.search_spelling('monkeys')
+  results.each do |spell|
+    puts spell.suggestion
+  end
+</code></pre>
+
 
 h2.  LICENSE:
 

data/TODO.txt

@@ -1,3 +1,4 @@
 == FEATURES/PROBLEMS:
 
-* Search all
+* Search all
+* TODO: cleanup encode_for_url

data/gem_tasks/rspec.rake

@@ -18,4 +18,10 @@ desc "Run the specs under spec/models"
 Spec::Rake::SpecTask.new do |t|
   t.spec_opts = ['--options', "spec/spec.opts"]
   t.spec_files = FileList['spec/**/*_spec.rb']
+
+  unless ENV['NO_RCOV']
+    t.rcov = true
+    t.rcov_dir = 'coverage'
+    t.rcov_opts = ['--exclude', 'spec\/boss,bin\/spec,examples,\/var\/lib\/gems,\/Library\/Ruby,\.autotest']
+  end
 end

data/gem_tasks/verify_rcov.rake

@@ -0,0 +1,7 @@
+require 'rake'
+require 'spec/rake/verify_rcov'
+
+RCov::VerifyTask.new(:verify_rcov => :spec) do |t|
+  t.threshold = 99.6 # Make sure you have rcov 0.9 or higher!
+  t.index_html = 'coverage/index.html'
+end

data/lib/boss/api.rb

@@ -3,6 +3,8 @@ require 'rexml/document'
 require 'uri'
 
 require 'ostruct'
+require 'cgi'
+  
   
 module Boss
 
@@ -19,28 +21,35 @@ module Boss
 
   class Api
 
+    attr_accessor :endpoint
+
     def initialize(app_id)
       @app_id = app_id
       @endpoint = 'http://boss.yahooapis.com/ysearch/'
     end
 
+    def search(term, *conditions, &block)
+       search_boss term, SearchType::WEB, *conditions, &block
+    end
+
     def search_images(term, *conditions, &block)
-      search term, SearchType::IMAGES, *conditions, &block
+      search_boss term, SearchType::IMAGES, *conditions, &block
     end
 
     def search_news(term, *conditions, &block)
-      search term, SearchType::NEWS, *conditions, &block
+      search_boss term, SearchType::NEWS, *conditions, &block
     end
 
     def search_web(term, *conditions, &block)
-      search term, SearchType::WEB, *conditions, &block
+      search_boss term, SearchType::WEB, *conditions, &block
     end
 
     def search_spelling(term, *conditions, &block)
-      search term, SearchService::SPELL, *conditions, &block
+      search_boss term, SearchService::SPELL, *conditions, &block
     end
 
-    def search(terms, search_type=SearchType::WEB, config = {})
+    private
+    def search_boss(terms, search_type=SearchType::WEB, config = {})
       config = config.empty? ? Config.new : Config.new(config)
       search_results = []
 
@@ -55,8 +64,9 @@ module Boss
         
       raise InvalidFormat unless (FORMATS.include? config.format)
       raise InvalidConfig unless (config.count>0)
-        
-      response = Net::HTTP.get_response(URI.parse(query_url(terms, search_type, config)))
+      
+      request = query_url terms, search_type, config
+      response = Net::HTTP.get_response request
 
       case response.code
       when "200"
@@ -74,19 +84,24 @@ module Boss
       search_results
     end
     
+    #TODO: parse error responses
     def parse_error(data)
+      "Error contacting yahoo webservice"
     end
 
     protected
     def query_url(terms, search_type, config)
-      #puts "#{@endpoint}#{search_type}/#{boss_version}/#{terms}?appid=#{@app_id}#{config.to_url}"
-      "#{@endpoint}#{search_type}/#{boss_version}/#{terms}?appid=#{@app_id}#{config.to_url}"
+      #We could use URI.encode but it leaves things like ? unencoded which fails search.
+      encoded_terms = CGI.escape terms
+      # puts "#{@endpoint}#{search_type}/#{boss_version}/#{encoded_terms}?appid=#{@app_id}#{config.to_url}"
+      "#{@endpoint}#{search_type}/#{boss_version}/#{encoded_terms}?appid=#{@app_id}#{config.to_url}"
     end
 
+    protected
     def boss_version
       "v#{Boss::YAHOO_VERSION}"
     end
 
   end
 
-end
+end

data/lib/boss/config.rb

@@ -8,9 +8,9 @@ module Boss
     end
    
     def to_url
-      self.marshal_dump.inject("") {|accum, key| accum+="&#{key[0]}=#{key[1]}"  }
+      self.marshal_dump.inject("") {|accum, key| encoded_value=CGI.escape(key[1].to_s); accum+="&#{key[0]}=#{encoded_value}"  }
     end
 
   end
 
-end
+end

data/lib/boss/version.rb

@@ -2,7 +2,7 @@ module Boss #:nodoc:
   class VERSION #:nodoc:
     MAJOR = 0
     MINOR = 1
-    TINY  = 0
+    TINY  = 1
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/rboss.gemspec

@@ -1,14 +1,14 @@
 Gem::Specification.new do |s|
   s.name = %q{rboss}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Joseph Wilk"]
-  s.date = %q{2008-08-19}
+  s.date = %q{2008-08-21}
   s.description = %q{Api wrapping Yahoo Boss search}
   s.email = ["joe@eshopworks.co.uk"]
   s.extra_rdoc_files = ["History.txt", "License.txt", "Manifest.txt", "TODO.txt"]
-  s.files = ["History.txt", "License.txt", "Manifest.txt", "README.textile", "Rakefile", "TODO.txt", "config/hoe.rb", "config/requirements.rb", "gem_tasks/deployment.rake", "gem_tasks/environment.rake", "gem_tasks/fix_cr_lf.rake", "gem_tasks/gemspec.rake", "gem_tasks/rspec.rake", "gem_tasks/website.rake", "lib/boss.rb", "lib/boss/api.rb", "lib/boss/config.rb", "lib/boss/result.rb", "lib/boss/result/base.rb", "lib/boss/result/image.rb", "lib/boss/result/news.rb", "lib/boss/result/spell.rb", "lib/boss/result/web.rb", "lib/boss/result_factory.rb", "lib/boss/version.rb", "rboss.gemspec", "spec/boss/api_spec.rb", "spec/boss/config_spec.rb", "spec/boss/result_factory_spec.rb", "spec/spec.opts", "spec/spec_helper.rb"]
+  s.files = ["History.txt", "License.txt", "Manifest.txt", "README.textile", "Rakefile", "TODO.txt", "config/hoe.rb", "config/requirements.rb", "gem_tasks/deployment.rake", "gem_tasks/environment.rake", "gem_tasks/fix_cr_lf.rake", "gem_tasks/gemspec.rake", "gem_tasks/rspec.rake", "gem_tasks/verify_rcov.rake", "gem_tasks/website.rake", "lib/boss.rb", "lib/boss/api.rb", "lib/boss/config.rb", "lib/boss/result.rb", "lib/boss/result/base.rb", "lib/boss/result/image.rb", "lib/boss/result/news.rb", "lib/boss/result/spell.rb", "lib/boss/result/web.rb", "lib/boss/result_factory.rb", "lib/boss/version.rb", "rboss.gemspec", "spec/boss/api_spec.rb", "spec/boss/config_spec.rb", "spec/boss/result_factory_spec.rb", "spec/spec.opts", "spec/spec_helper.rb"]
   s.has_rdoc = true
   s.homepage = %q{http://github.com/eshopworks/rboss-gem}
   s.rdoc_options = ["--main", "README.txt"]

data/spec/boss/api_spec.rb

@@ -4,25 +4,25 @@ require File.dirname(__FILE__) + '/../spec_helper'
 describe Boss::Api do
 
   def mock_http_response(stubs={})
-    mock('http_response', {:body => 'pretend:"json"', :code => "200"}.merge(stubs))
+    mock('http_response', {:body => '{"ysearchresponse":{}}', :code => "200"}.merge(stubs))
   end
 
   before(:each) do
     @api = Boss::Api.new( appid = 'test' )
+    @api.endpoint = 'http://www.example.com/'
   end
 
   describe "responding to spelling search" do
 
     it "should make a spelling request to yahoo service" do
       Net::HTTP.should_receive(:get_response).and_return{ mock_http_response }
-      Boss::ResultFactory.stub!(:build)
 
       @api.search_spelling "girafes"
     end
 
     it "should build the spelling objects" do
       Net::HTTP.stub!(:get_response).and_return{ mock_http_response }
-      Boss::ResultFactory.should_receive(:build).with(Boss::SearchService::SPELL, 'pretend:"json"')
+      Boss::ResultFactory.should_receive(:build).with(Boss::SearchService::SPELL, '{"ysearchresponse":{}}')
 
       @api.search_spelling "girafes"
     end
@@ -32,14 +32,13 @@ describe Boss::Api do
   describe "responding to news search" do
     it "should make a news request to yahoo service" do
       Net::HTTP.should_receive(:get_response).and_return{ mock_http_response }
-      Boss::ResultFactory.stub!(:build)
 
       @api.search_news "monkey"
     end
 
     it "should build the news objects" do
       Net::HTTP.stub!(:get_response).and_return{ mock_http_response }
-      Boss::ResultFactory.should_receive(:build).with(Boss::SearchType::NEWS, 'pretend:"json"')
+      Boss::ResultFactory.should_receive(:build).with(Boss::SearchType::NEWS, '{"ysearchresponse":{}}')
 
       @api.search_news "monkey"
     end
@@ -48,14 +47,13 @@ describe Boss::Api do
   describe "responding to image search" do
     it "should make a image request to yahoo service" do
       Net::HTTP.should_receive(:get_response).and_return{ mock_http_response }
-      Boss::ResultFactory.stub!(:build)
 
       @api.search_images "hippo"
     end
 
     it "should build the image objects" do
       Net::HTTP.stub!(:get_response).and_return{ mock_http_response }
-      Boss::ResultFactory.should_receive(:build).with(Boss::SearchType::IMAGES, 'pretend:"json"')
+      Boss::ResultFactory.should_receive(:build).with(Boss::SearchType::IMAGES, '{"ysearchresponse":{}}')
 
       @api.search_images "hippo"
     end
@@ -65,13 +63,13 @@ describe Boss::Api do
 
     it "should make a web request to yahoo service" do
       Net::HTTP.should_receive(:get_response).and_return{ mock_http_response }
-      Boss::ResultFactory.stub!(:build)
+
       @api.search_web "monkey"
     end
 
     it "should build the web objects" do
       Net::HTTP.stub!(:get_response).and_return{ mock_http_response }
-      Boss::ResultFactory.should_receive(:build).with(Boss::SearchType::WEB, 'pretend:"json"')
+      Boss::ResultFactory.should_receive(:build).with(Boss::SearchType::WEB, '{"ysearchresponse":{}}')
 
       @api.search_web "monkey"
     end
@@ -88,20 +86,10 @@ describe Boss::Api do
 
   end
 
-  describe "search should still work when get returns a successful but not code 200" do
-    it "should description" do
-      pending("fix for http://rboss.lighthouseapp.com/projects/15732/tickets/1")
-      Net::HTTP.stub!(:get_response).and_return{ mock_http_response :code => "206" }
-
-      lambda { @api.search_web "monkey"  }.should_not raise_error(Boss::BossError)
-    end
-  end
-
   describe "configuring search" do
 
     before(:each) do
       Net::HTTP.stub!(:get_response).and_return{ mock_http_response }
-      Boss::ResultFactory.stub!(:build)
 
       @config = Boss::Config.new
     end
@@ -149,4 +137,24 @@ describe Boss::Api do
 
   end
 
-end
+  describe "search should still work when get returns a successful but not code 200" do
+    it "should description" do
+      pending("fix for http://eshopworks.lighthouseapp.com/projects/15732/tickets/1")
+      Net::HTTP.stub!(:get_response).and_return{ mock_http_response :code => "206" }
+
+      lambda { @api.search_web "monkey"  }.should_not raise_error(Boss::BossError)
+    end
+  end
+
+  describe "searching terms" do
+    it "should encode invalid characters" do
+      Net::HTTP.stub!(:get_response).and_return{ mock_http_response }
+      CGI.stub!(:escape)
+      CGI.should_receive(:escape).with('monkey?magic').and_return('monkey%3Fmagic')
+      
+      @api.search_web "monkey?magic"
+    end
+    
+  end
+
+end

data/spec/boss/config_spec.rb

@@ -24,4 +24,10 @@ describe Boss::Config do
     config.to_url.should include("&mizaru=cannot_see")
   end
   
+  it "should encode invalid url characters" do
+    config = Boss::Config.new :mizaru => 'dancing monkeys?'
+    
+    config.to_url.should include("dancing+monkeys%3F")
+  end
+  
 end

data/spec/boss/result_factory_spec.rb

@@ -10,6 +10,7 @@ describe Boss::ResultFactory do
    
    spelling_json_result = '{"ysearchresponse":{"responsecode":"200","totalhits":"1","count":"1","start":"0","resultset_spell":[{"suggestion":"giraffes"}]}}'
 
+   error_json_result = '{"Error":"true"}'
 
   it "should create a new news object from json" do
     Boss::Result::News.should_receive(:new).once
@@ -41,4 +42,8 @@ describe Boss::ResultFactory do
     Boss::ResultFactory.build(Boss::SearchType::SPELL, spelling_json_result)
   end
   
+  it "should raise an error if json result carries an error" do
+    lambda { Boss::ResultFactory.build(Boss::SearchType::WEB, error_json_result) }.should raise_error(Boss::BossError)
+  end
+  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: eshopworks-rboss
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Joseph Wilk
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-08-19 00:00:00 -07:00
+date: 2008-08-21 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -74,6 +74,7 @@ files:
 - gem_tasks/fix_cr_lf.rake
 - gem_tasks/gemspec.rake
 - gem_tasks/rspec.rake
+- gem_tasks/verify_rcov.rake
 - gem_tasks/website.rake
 - lib/boss.rb
 - lib/boss/api.rb