bossman 0.2.5

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Jay Pignata
+
+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.md

@@ -0,0 +1,172 @@
+# 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 GitHub issues.
+
+## Example Usage
+
+### Web
+
+	require 'bossman'
+	include BOSSMan
+
+	BOSSMan.application_id = <Your Application ID>
+
+	boss = BOSSMan::Search.web("prospect park", { :count => 5, :filter => "-hate" })
+
+	puts "Number of results: #{boss.totalhits}"
+	puts
+
+	boss.results.each do |result|
+	  puts "#{result.title}"
+	  puts "-" * 80
+	  puts "#{result.abstract}"
+	  puts
+	end
+
+### News
+
+	require 'bossman'
+	include BOSSMan
+
+	BOSSMan.application_id = <Your Application ID>
+
+	boss = BOSSMan::Search.news("brooklyn new york", { :age => "7d" })
+
+	boss.results.each do |result|
+	  puts "#{result.title} [from #{result.source}]"
+	  puts "-" * 80
+	  puts "#{result.abstract}"
+	  puts
+		
+### Images
+
+	require 'bossman'
+	include BOSSMan
+
+	BOSSMan.application_id = <Your Application ID>
+
+	boss = BOSSMan::Search.images("brooklyn dumbo", { :dimensions => "large" })
+
+	boss.results.each do |result|
+	  puts "#{result.url}: #{result.abstract}"
+	end
+	
+### Spelling
+
+	require 'bossman'
+	include BOSSMan
+	
+	BOSSMan.application_id = <Your Application ID>
+	
+	boss = BOSSMan::Search.spelling("Diabretes")
+	
+	puts boss.suggestion
+	
+## Output Objects
+
+Assuming an object bossed called search:
+
+search = BOSSMan::Search.web("cobble hill", 0, 20)
+
+### Common
+
+- 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
+
+- 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
+
+- 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
+
+- 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[].thumbnail_url		  : 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
+
+Result sets can be dumped as JSON, XML and YAML by use of to_json, to_xml, to_yaml respectively.
+
+- search.to_xml			          : dumps XML of the result set
+- search.to_json	 			      : dumps JSON of the result set
+- search.to_yaml				      : dumps YAML of the result set
+- 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
+
+jp@populuxe:~/code/ruby$ gem sources -a http://gems.github.com
+jp@populuxe:~/code/ruby$ gem install jpignata-bossman
+
+## Requirements
+
+- Active Support >= 2.1
+- FakeWeb (in order to run the specs)
+
+## LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Jay Pignata
+
+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/lib/bossman.rb

@@ -0,0 +1,17 @@
+require 'active_support'
+require 'net/http'
+require 'uri'
+
+Dir["#{File.dirname(__FILE__)}/bossman/*.rb"].sort.each { |bossman_lib| require bossman_lib }
+
+module BOSSMan
+  API_VERSION = :v1
+  API_BASEURI = "http://boss.yahooapis.com/ysearch"
+
+  attr_accessor :application_id
+  module_function :application_id, :application_id=
+
+  class MissingConfiguration < StandardError; end
+  class InvalidParameter < StandardError; end
+  class BOSSError < StandardError; end
+end

data/lib/bossman/base_value_object.rb

@@ -0,0 +1,20 @@
+module BOSSMan
+  class BaseValueObject
+      def set_parameter(key, value)
+        instance_variable_set("@#{key}", value) 
+      end
+      
+      def to_yaml
+        @response.to_yaml
+      end
+
+      def to_json
+        ActiveSupport::JSON.encode(@response)
+      end
+      
+      def method_missing(*args)
+        method = args.first
+        instance_variable_get("@#{method}")
+      end
+  end 
+end

data/lib/bossman/boss.rb

@@ -0,0 +1,42 @@
+module BOSSMan
+  class BOSS
+    
+    def initialize(method, query, options)      
+      @options = options
+      validate_parameters
+
+      @uri = URI.parse(URI.encode("#{API_BASEURI}/#{method}/#{API_VERSION}/#{query}"))
+      @uri.query = @options.to_query
+      @request = Net::HTTP::Get.new(@uri.request_uri)
+    end
+        
+    def get
+      query_api
+      parse_response
+    end  
+
+    private
+      def query_api
+        @response = Net::HTTP.new(@uri.host).request(@request)
+      end
+        
+      def parse_response
+        case @response
+        when Net::HTTPSuccess
+          ResultSet.new(ActiveSupport::JSON.decode(@response.body))
+        else
+          raise BOSSError, "Error occurred while querying API: #{@response.body}"
+        end 
+      end
+      
+      def validate_parameters
+        unless BOSSMan.application_id
+          raise MissingConfiguration, "Application ID must be set prior to making a service call."
+        end
+
+        if @options[:count] <= 0
+          raise InvalidParameter, "Invalid count. Count must be > 0." 
+        end
+      end      
+  end
+end

data/lib/bossman/result.rb

@@ -0,0 +1,15 @@
+module BOSSMan
+  class Result < BaseValueObject
+
+    def initialize(response)
+      @response = response
+      response.each { |key, value| set_parameter(key, value) }
+    end
+
+    def to_xml
+      @response.to_xml(:root => 'result')
+    end
+
+    alias to_s to_xml
+  end
+end

data/lib/bossman/result_set.rb

@@ -0,0 +1,49 @@
+module BOSSMan
+  class ResultSet < BaseValueObject
+    
+    def initialize(response)
+      @response = response
+      process_response
+    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
+    
+    private
+      def process_response
+        @response["ysearchresponse"].each do |key, value|
+          case key
+          when "resultset_spell"
+            process_spelling_result
+          when /resultset/
+            process_resultset(key)
+          else
+            set_parameter(key, value)
+          end        
+        end
+      end
+      
+      def process_spelling_result
+        set_parameter("suggestion", @response["ysearchresponse"]["resultset_spell"].first["suggestion"])
+      end
+      
+      def process_resultset(key)
+        results = @response["ysearchresponse"][key].map do |result| 
+          Result.new(result) 
+        end
+        
+        set_parameter("results", results)
+      end
+  end  
+end

data/lib/bossman/search.rb

@@ -0,0 +1,20 @@
+module BOSSMan
+  class Search 
+    DEFAULT_COUNT = 10
+    DEFAULT_START = 0
+
+    class << self
+      def method_missing(*args)
+        method, query, options = args
+        super unless [:web, :images, :news, :spelling].include?(method)
+        boss = BOSS.new(method, query, options_defaults.merge!(options))
+        boss.get
+      end
+    end
+
+    private
+      def self.options_defaults
+        {:appid => BOSSMan.application_id, :count => DEFAULT_COUNT, :start => DEFAULT_START }
+      end
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: bossman
+version: !ruby/object:Gem::Version 
+  version: 0.2.5
+platform: ruby
+authors: 
+- Jay Pignata
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-20 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.1.0
+    version: 
+description: 
+email: john.pignata@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/bossman.rb
+- lib/bossman/base_value_object.rb
+- lib/bossman/boss.rb
+- lib/bossman/result.rb
+- lib/bossman/result_set.rb
+- lib/bossman/search.rb
+- README.md
+- LICENSE
+has_rdoc: true
+homepage: http://github.com/jpignata/bossman-gem
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Gem for interaction with the Yahoo BOSS web service.
+test_files: []
+