eshopworks-rboss 0.1.2 → 0.1.3

data/History.txt

@@ -1,3 +1,6 @@
+=== Version 0.1.3
+* Fix for duplicate information being storied in the ResultCollection
+
 === Version 0.1.2
 * Maintain search result data in ResultCollection
 

data/README.textile

@@ -71,9 +71,13 @@ h2. USAGE:
     config.format = 'xml'
     config.count = 5
   end
+  
+  #Access general search result information
+  results = api.search('monkeys', :count => 5)
+  puts results.totalhits
 </code></pre>
 
-h3. Global Search Options
+h3. Global Search Options (applies to news/images/web search)
 
 <pre><code>
   api.search('monkeys') do |config|
@@ -87,10 +91,23 @@ h3. Global Search Options
   end
 </pre></code>
 
+h3. Global Search Results data (applies to news/images/web search results)
+
+<pre><code>
+  results = api.search('monkeys', :count => 1)
+  puts results.deephits      #approximate count that includes duplicates
+  puts results.totalhits     #approximate count that excludes duplicates
+  puts results.responsecode  #response code return by Yahoo webservice
+  puts results.start         #the first numeric result to display
+  puts results.count         #Indicates how many results to show per page
+  puts results.nextpage      #link to what would be the next page of search results
+</pre></code>
+
 h3. Web Search Result
 
 <pre><code>
-  results = api.search_web('monkeys')
+  #We filter here to exclude certain types of content
+  results = api.search_web('monkeys', :filter => '-porn')
   results.each do |web|
     puts web.abstract
     puts web.date
@@ -105,7 +122,8 @@ h3. Web Search Result
 h3. News Search Result
 
 <pre><code>
-  results = api.search_news('monkeys')
+  #We retrieve documents by age (possible options: [1-30]d ) 
+  results = api.search_news('monkeys', :age => '7d')
   results.each do |news|
     puts news.abstract
     puts news.clickurl
@@ -122,7 +140,9 @@ h3. News Search Result
 h3. Image Search Result
 
 <pre><code>
-  results = api.search_image('monkeys')
+  #Add constraint on dimension (possible options: 'small', 'medium', 'large', 'wallpaper')
+  #Activate the Offensive Content Reduction filter
+  results = api.search_images('monkeys', :dimensions => 'small', :filter => 'true')
   results.each do |image|
     puts image.abstract
     puts image.clickurl
@@ -152,7 +172,6 @@ h3. Spell Search Result
   end
 </code></pre>
 
-
 h2.  LICENSE:
 
 Copyright (c) 2008 eShopworks

data/TODO.txt

@@ -1,4 +1,3 @@
 == FEATURES/PROBLEMS:
 
-* Search all
-* Clean up ResultCollection, we store hash result in ResultCollection aswell as objects.
+* Search all

data/lib/boss/api.rb

@@ -85,7 +85,7 @@ module Boss
     
     #TODO: parse error responses
     def parse_error(data)
-      "Error contacting yahoo webservice"
+      "Error contacting Yahoo Boss web-service"
     end
 
     protected

data/lib/boss/result_collection.rb

@@ -2,13 +2,14 @@ module Boss
   class ResultCollection 
     include Enumerable
 
-    def initialize(search_data)
-      search_data.each do |name, value|
-        instance_variable_set("@#{name}",value)
-        instance_eval("def #{name}\n @#{name}\n end")        
-      end
+    def initialize
       @results=[]
     end
+    
+    def set_instance_variable(name, value)
+      instance_variable_set("@#{name}",value)
+      instance_eval("def #{name}\n @#{name}\n end")        
+    end
 
     def each
       @results.each { |result| yield result }

data/lib/boss/result_factory.rb

@@ -15,39 +15,39 @@ module Boss
 
         json_hash = JSON.parse(data)
 
-        if json_hash.has_key? 'Error'
-          raise BossError, "Web service error"
+        if json_hash.has_key? 'Error' or !json_hash.has_key? SEARCH_RESPONSE
+          raise BossError, "Results from webservice appear to be mangled."
         end
-                
-        result_collection = ResultCollection.new(json_hash[SEARCH_RESPONSE])
-                
-        if has_results?(json_hash, :for => search_type)
-
-          json_hash[SEARCH_RESPONSE]["#{RESULT_SET}_#{search_type}"].each do |result|
-
-            case search_type
-            when SearchType::WEB
-              result_collection << Result::Web.new(result)
-            when SearchType::IMAGES
-              result_collection << Result::Image.new(result)
-            when SearchType::NEWS
-              result_collection << Result::News.new(result)
-            when SearchType::SPELL
-              result_collection << Result::Spell.new(result)
-            end
 
+        result_collection = ResultCollection.new
+
+        json_hash[SEARCH_RESPONSE].each do |key,value|
+
+          if key == "#{RESULT_SET}_#{search_type}"
+            
+            json_hash[SEARCH_RESPONSE]["#{RESULT_SET}_#{search_type}"].each do |result|
+
+              case search_type
+              when SearchType::WEB
+                result_collection << Result::Web.new(result)
+              when SearchType::IMAGES
+                result_collection << Result::Image.new(result)
+              when SearchType::NEWS
+                result_collection << Result::News.new(result)
+              when SearchType::SPELL
+                result_collection << Result::Spell.new(result)
+              end
+
+            end
+          else
+            result_collection.set_instance_variable(key, value)
           end
-        end
 
+        end
         result_collection
       end
 
-      def has_results?(json_hash, type={})
-        !(json_hash[SEARCH_RESPONSE]["#{RESULT_SET}_#{type[:for]}"]).nil?
-      end
-
     end
 
   end
-
-end
+end

data/lib/boss/version.rb

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

data/rboss.gemspec

@@ -1,10 +1,10 @@
 Gem::Specification.new do |s|
   s.name = %q{rboss}
-  s.version = "0.1.2"
+  s.version = "0.1.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Joseph Wilk"]
-  s.date = %q{2008-08-21}
+  s.date = %q{2008-08-22}
   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"]

data/spec/boss/result_collection_spec.rb

@@ -3,13 +3,14 @@ require File.dirname(__FILE__) + '/../spec_helper'
 describe Boss::ResultCollection do
 
   it "should dynamically set instance values given at creation" do
-    collection = Boss::ResultCollection.new({:totalhits => "344"})
+    collection = Boss::ResultCollection.new
+    collection.set_instance_variable(:totalhits, "344")
     
     collection.totalhits.should eql("344")
   end
   
   it "should allow iterating over result collection" do
-    collection = Boss::ResultCollection.new({})
+    collection = Boss::ResultCollection.new
     
     collection << 1
     collection << 2

data/spec/boss/result_factory_spec.rb

@@ -12,11 +12,11 @@ describe Boss::ResultFactory do
 
   error_json_result = '{"Error":"true"}'
 
-  it "should create a result collection" do
-    news_hash = JSON.parse(news_json_result)
-    result_collection = Boss::ResultCollection.new(news_hash)
-    Boss::ResultCollection.should_receive(:new).once.with(news_hash['ysearchresponse']).and_return(result_collection)
-      
+  it "should collect result objects in a result collection" do
+    result_collection = Boss::ResultCollection.new
+    result_collection.should_receive(:<<).once
+    Boss::ResultCollection.should_receive(:new).once.and_return(result_collection)
+    
     Boss::ResultFactory.build(Boss::SearchType::NEWS, news_json_result)
   end
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: eshopworks-rboss
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors: 
 - Joseph Wilk
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-08-21 00:00:00 -07:00
+date: 2008-08-22 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency