jpignata-bossman 0.0.5 → 0.1.0

data/README

@@ -1,9 +1,14 @@
-= BOSSMan -- Class for interaction with the Yahoo BOSS web service
+= BOSSMan -- Gem for interaction with the Yahoo BOSS web service
 
 == Description
 
 BOSSMan can be used to perform image, web and news searches against Yahoo's index. For more information about BOSS (Build your Own Search Service) please refer to http://developer.yahoo.com/search/boss/. 
 
+== Bugs, Features, Feedback
+
+Feedback would be really appreciated. You can send it to me at john.pignata@gmail.com -- tickets can
+be submitted by using Lighthouse: http://pignata.lighthouseapp.com/projects/15761-bossman
+
 == Example Usage
 
 === Web
@@ -14,12 +19,12 @@ BOSSMan can be used to perform image, web and news searches against Yahoo's inde
 
 	BOSSMan.application_id = <Your Application ID>
 
-	prospectpark_web = BOSSMan::Search.web("prospect park", 0, 20)
+	return = BOSSMan::Search.web("prospect park", { :count => 5, :filter => "-hate" })
 
-	puts "Number of results: #{madmen_web.totalhits}"
+	puts "Number of results: #{return.totalhits}"
 	puts
 
-	prospectpark_web.results.each do |result|
+	return.results.each do |result|
 	  puts "#{result.title}"
 	  puts "-" * 80
 	  puts "#{result.abstract}"
@@ -34,9 +39,9 @@ BOSSMan can be used to perform image, web and news searches against Yahoo's inde
 
 	BOSSMan.application_id = <Your Application ID>
 
-	brooklyn_news = BOSSMan::Search.news("brooklyn new york", 0, 20)
+	return = BOSSMan::Search.news("brooklyn new york", { :age => "7d" })
 
-	brooklyn_news.results.each do |result|
+	return.results.each do |result|
 	  puts "#{result.title} [from #{result.source}]"
 	  puts "-" * 80
 	  puts "#{result.abstract}"
@@ -50,69 +55,91 @@ BOSSMan can be used to perform image, web and news searches against Yahoo's inde
 
 	BOSSMan.application_id = <Your Application ID>
 
-	dumbo_images = BOSSMan::Search.images("brooklyn dumbo", 0, 20)
+	dumbo = BOSSMan::Search.images("brooklyn dumbo", { :dimensions => "large" })
 
-	dumbo_images.results.each do |result|
-	  puts "<img src=\"#{result.url}\" alt=\"#{result.abstract}\" /><br />"
+	return.results.each do |result|
+	  puts "#{result.url}: #{result.abstract}"
 	end
 	
+=== Spelling
+
+	require 'rubygems'
+	require 'bossman'
+	include BOSSMan
+	
+	BOSSMan.application_id = <Your Application ID>
+	
+	return = BOSSMan::Search.spelling("Diabretes")
+	
+	puts result.suggestion
 	
 == Output Objects
 
+Assuming an object returned called search:
+
+search = BOSSMan::Search.web("staten island", 0, 20)
+
 === Common
 
-.responsecode			: HTTP response code
-.nextpage				: REST URL to next page of search results
-.count					: Number of search results contained in response
-.start					: Search result from which output starts
-.totalhits				: De-duplicated total number of results search yielded
-.deephits				: Total number of results search yielded
-.results[].clickurl		: Tracking URL of result; must be used in user-facing anchor tags by BOSS TOU
-.results[].url			: URL of result
+search.responsecode				: HTTP response code
+search.nextpage					: REST URL to next page of search results
+search.count					: Number of search results contained in response
+search.start					: Search result from which output starts
+search.totalhits				: De-duplicated total number of results search yielded
+search.deephits					: Total number of results search yielded
+search.results[].clickurl		: Tracking URL of result; must be used in user-facing
+										anchor tags by BOSS TOU
+search.results[].url			: URL of result
 
 === Web
 
-.results[].abstract		: Description of result with keywords emboldened
-.results[].title		: Document title with keywords emboldened
-.results[].dispurl		: Display URL of result
-.results[].size			: Size of result in bytes
-.results[].date			: Date result was indexed
+search.results[].abstract		: Description of result with keywords emboldened
+search.results[].title			: Document title with keywords emboldened
+search.results[].dispurl		: Display URL of result
+search.results[].size			: Size of result in bytes
+search.results[].date			: Date result was indexed
 
 === News
 
-.results[].abstract		: Description of news story
-.results[].title		: Title of news story
-.results[].language		: Language of news story
-.results[].date			: Last publication date of news story
-.results[].time			: Last publication time of news story
-.results[].source		: Source of news story
-.results[].sourceurl	: URL of source publication
+search.results[].abstract		: Description of news story
+search.results[].title			: Title of news story
+search.results[].language		: Language of news story
+search.results[].date			: Last publication date of news story
+search.results[].time			: Last publication time of news story
+search.results[].source			: Source of news story
+search.results[].sourceurl		: URL of source publication
 
 === Images
 
-.results[].abstract			: Description of image
-.results[].filename			: Filename of image
-.results[].size				: Size of image
-.results[].format			: Format of image
-.results[].height			: Height of full-size image
-.results[].date				: Last modification date of image (YYYY/MM/DD)
-.results[].mimetype			: MIME type of image
-.results[].refererclickurl	: Link to page where image was found
-.results[].refererurl 		: Link to page where image was found
-.results[].title			: Title of image (usually the filename)
-.results[].width			: Width of full-size image
-.results[].thumbnailurl		: URL of thumbnail image
-.results[].thumbnail_height : Height of thumbnail image
-.results[].thumbnail_width  : Width of thumbnail image
-
-=== Format
-
-Results are dumpable in JSON, XML and YAML by use of to_json, to_xml (or to_s), to_yaml respectively.
-
-puts websearch			 			: dumps XML 
-puts websearch.to_json	 			: dumps JSON
-puts websearch.to_yaml				: dumps YAML
-puts websearch.results[3].to_xml	: dumps XML for third search result
+search.results[].abstract			: Description of image
+search.results[].filename			: Filename of image
+search.results[].size				: Size of image
+search.results[].format				: Format of image
+search.results[].height				: Height of full-size image
+search.results[].date				: Last modification date of image (YYYY/MM/DD)
+search.results[].mimetype			: MIME type of image
+search.results[].refererclickurl	: Link to page where image was found
+search.results[].refererurl 		: Link to page where image was found
+search.results[].title				: Title of image (usually the filename)
+search.results[].width				: Width of full-size image
+search.results[].thumbnailurl		: URL of thumbnail image
+search.results[].thumbnail_height	: Height of thumbnail image
+search.results[].thumbnail_width    : Width of thumbnail image
+
+=== Spelling
+
+search.suggestion					: Returns spelling suggestion from BOSS
+
+=== Raw dump formats
+
+Resultsets are returnable in JSON, XML and YAML by use of to_json, to_xml (or to_s), to_yaml respectively.
+
+search			 			: dumps XML of entire resultset
+search.to_json	 			: dumps JSON of entire resultset
+search.to_yaml				: dumps YAML of entire resultset
+search.results[3]			: dumps XML of one search result
+search.results[3].to_json	: dumps JSON of one search result
+search.results[3].to_yaml	: dumps YAML of one search result
 
 == Installation
 
@@ -146,4 +173,4 @@ 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.
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/bossman.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name = "bossman"
-  s.version = "0.0.5"
-  s.date = "2008-08-17"
+  s.version = "0.1.0"
+  s.date = "2008-08-27"
   s.summary = "Class for interaction with the Yahoo BOSS web service."
   s.email = "jpignata@waterfrontmedia.com"
   s.homepage = "http://github.com/jpignata/bossman-gem"

data/lib/bossman/rest.rb

@@ -29,7 +29,7 @@ module BOSSMan
         raise MissingConfiguration, "Application ID must be set prior to making a service call."
       end
 
-      unless options[:count] > 0 
+      unless options[:count] > 0
         raise InvalidParameter, "Invalid count. Count must be > 0." 
       end
     end

data/lib/bossman/result.rb

@@ -11,6 +11,5 @@ module BOSSMan
     end
 
     alias to_s to_xml
-    
   end
 end

data/lib/bossman/resultset.rb

@@ -5,7 +5,9 @@ module BOSSMan
       @response = response
 
       @response["ysearchresponse"].each do |key, value|
-        if key.include? "resultset"
+        if key.include? "resultset_spell"
+          set_parameter("suggestion", @response["ysearchresponse"]["resultset_spell"][0]["suggestion"])
+        elsif key.include? "resultset"
           results = Array.new
           response["ysearchresponse"][key].each { |result| results << Result.new(result) }
           set_parameter("results", results)
@@ -14,12 +16,19 @@ module BOSSMan
         end        
       end
     end
-          
+              
     def to_xml
       @response['ysearchresponse'].to_xml(:root => 'resultset')
     end
-
+    
+    def _dump(level)
+      @response.to_json
+    end
+    
+    def self._load(string)
+      ResultSet.new(ActiveSupport::JSON.decode(string))
+    end
+    
     alias to_s to_xml
-
   end  
 end

data/lib/bossman/search.rb

@@ -1,43 +1,38 @@
 module BOSSMan
   class Search 
     class << self
-
-      def web(query, start=0, count=10, filter=nil, type=nil, lang=nil, region=nil)    
+      DEFAULT_COUNT = 10
+      DEFAULT_START = 0
+      
+      def web(query, options = {})    
         method = "web"
-
-        options = default_options(BOSSMan.application_id, count, start)
-        options[:filter] = filter if filter
-        options[:type] = type if type
-        options[:lang] = lang if lang
-        options[:region] = region if region
-
+        options.merge!(return_options(options))
         return REST.get(method, query, options)
       end
 
-      def images(query, start=0, count=10, filter=nil, dimensions=nil, refererurl=nil, url=nil)
+      def images(query, options = {})
         method = "images"
-
-        options = default_options(BOSSMan.application_id, count, start)
-        options[:filter] = filter if filter
-        options[:dimensions] = dimensions if dimensions
-        options[:refererurl] = refererurl if refererurl
-        options[:url] = url if url
-
+        options.merge!(return_options(options))        
         return REST.get(method, query, options)
       end
 
-      def news(query, start=0, count=10, age=nil)
+      def news(query, options = {})
         method = "news"
-
-        options = default_options(BOSSMan.application_id, count, start)
-        options[:age] = age if age
-
+        options.merge!(return_options(options))
         return REST.get(method, query, options)
       end
 
-      private    
-      def default_options(appid, count, start)
-        return {:appid => appid, :count => count, :start => start}
+      def spelling(query, options = {})
+        method = "spelling"
+        options.merge!(return_options(options))
+        return REST.get(method, query, options)
+      end
+      
+      private
+      def return_options(options)
+        count = options[:count] ? options[:count] : DEFAULT_COUNT
+        start = options[:start] ? options[:start] : DEFAULT_START
+        return {:appid => BOSSMan.application_id, :count => count, :start => start }
       end
 
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jpignata-bossman
 version: !ruby/object:Gem::Version 
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors: 
 - Jay Pignata
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-08-17 00:00:00 -07:00
+date: 2008-08-27 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency