jpignata-bossman 0.0.3 → 0.0.4

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

@@ -2,10 +2,134 @@
 
 == 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/
+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/. 
+
+== Example Usage
+
+=== Web
+
+	require 'rubygems'
+	require 'bossman'
+	include BOSSMan
+
+	BOSSMan.application_id = <Your Application ID>
+
+	prospectpark_web = BOSSMan::Search.web("prospect park", 0, 20)
+
+	puts "Number of results: #{madmen_web.totalhits}"
+	puts
+
+	prospectpark_web.results.each do |result|
+	  puts "#{result.title}"
+	  puts "-" * 80
+	  puts "#{result.abstract}"
+	  puts
+	end
+
+=== News
+
+	require 'rubygems'
+	require 'bossman'
+	include BOSSMan
+
+	BOSSMan.application_id = <Your Application ID>
+
+	brooklyn_news = BOSSMan::Search.news("brooklyn new york", 0, 20)
+
+	brooklyn_news.results.each do |result|
+	  puts "#{result.title} [from #{result.source}]"
+	  puts "-" * 80
+	  puts "#{result.abstract}"
+	  puts
+	
+=== Images
+
+	require 'rubygems'
+	require 'bossman'
+	include BOSSMan
+
+	BOSSMan.application_id = <Your Application ID>
+
+	dumbo_images = BOSSMan::Search.images("brooklyn dumbo", 0, 20)
+
+	dumbo_images.results.each do |result|
+	  puts "<img src=\"#{result.url}\" alt=\"#{result.abstract}\" /><br />"
+	end
+	
+== Output Objects
+
+=== 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
+
+=== 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
+
+=== 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
+
+=== 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
 
 == Installation
 
    jp@populuxe:~/code/ruby$ gem sources -a http://gems.github.com
    jp@populuxe:~/code/ruby$ gem install jpignata-bossman
 
+== 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/bossman.gemspec

@@ -1,12 +1,14 @@
 Gem::Specification.new do |s|
   s.name = "bossman"
-  s.version = "0.0.3"
-  s.date = "2008-08-14"
+  s.version = "0.0.4"
+  s.date = "2008-08-17"
   s.summary = "Class for interaction with the Yahoo BOSS web service."
   s.email = "jpignata@waterfrontmedia.com"
-  s.homepage = "http://github.com/jpignata/bossman"
-  s.authors = ["John Pignata"]
-  s.files = ["README", "bossman.gemspec", "lib/bossman.rb"]
-  s.add_dependency("rails", [">= 2.1.0"])
+  s.homepage = "http://github.com/jpignata/bossman-gem"
+  s.authors = ["Jay Pignata"]
+  s.files = ['bossman.gemspec', 'lib/bossman.rb', 'lib/bossman/basevalueobject.rb', 
+    'lib/bossman/rest.rb', 'lib/bossman/result.rb', 'lib/bossman/resultset.rb', 
+    'lib/bossman/search.rb', 'README', 'LICENSE']
+  s.add_dependency("activesupport", [">= 2.1.0"])
   s.has_rdoc = false
 end

data/lib/bossman/basevalueobject.rb

@@ -0,0 +1,10 @@
+module BOSSMan
+  class BaseValueObject
+
+      def set_parameter(key, value)
+        instance_variable_set("@#{key}", value) 
+        instance_eval("def #{key}; @#{key}; end")
+      end
+
+  end 
+end

data/lib/bossman/rest.rb

@@ -0,0 +1,36 @@
+module BOSSMan
+  class REST
+    
+    def self.get(method, query, options)
+      validate_parameters(options)
+      uri = URI.parse(URI.encode("#{API_BASEURI}/#{method}/#{API_VERSION}/#{query}"))
+      uri.query = options.to_query
+      request = Net::HTTP::Get.new(uri.request_uri)
+      response = Net::HTTP.new(uri.host).request(request)
+      case response
+        when Net::HTTPSuccess
+          return ResultSet.new(ActiveSupport::JSON.decode(response.body))
+        else
+          raise BOSSError, parse_error(response.body)
+      end
+    end  
+    
+    def self.parse_error(response_string)
+      response_document = REXML::Document.new(response_string)
+      error_code = REXML::XPath.first(response_document, '//yahoo:code').text
+      error_description = REXML::XPath.first(response_document, '//yahoo:description').text
+      error_detail = REXML::XPath.first(response_document, '//yahoo:detail').text
+      return "#{error_code} #{error_description}: #{error_detail}"
+    end        
+    
+    def self.validate_parameters(options) 
+      unless BOSSMan.application_id
+        raise MissingConfiguration, "Application ID must be set prior to making a service call."
+      end
+      unless options[:count] > 0 
+        raise InvalidParameter, "Invalid count. Count must be > 0." 
+      end
+    end
+  
+  end
+end

data/lib/bossman/result.rb

@@ -0,0 +1,9 @@
+module BOSSMan
+  class Result < BaseValueObject
+
+    def initialize(results)
+      results.each { |key, value| set_parameter(key, value) }
+    end
+
+  end
+end

data/lib/bossman/resultset.rb

@@ -0,0 +1,17 @@
+module BOSSMan
+  class ResultSet < BaseValueObject
+
+    def initialize(response)      
+      response["ysearchresponse"].each do |key, value|
+        if key.include? "resultset"
+          results = Array.new
+          response["ysearchresponse"][key].each { |result| results << Result.new(result) }
+          set_parameter("results", results)
+        else
+          set_parameter(key, value)
+        end        
+      end
+    end
+
+  end  
+end

data/lib/bossman/search.rb

@@ -0,0 +1,45 @@
+module BOSSMan
+  class Search 
+    class << self
+
+      def web(query, start=0, count=10, filter=nil, type=nil, lang=nil, region=nil)    
+        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
+
+        return REST.get(method, query, options)
+      end
+
+      def images(query, start=0, count=10, filter=nil, dimensions=nil, refererurl=nil, url=nil)
+        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
+
+        return REST.get(method, query, options)
+      end
+
+      def news(query, start=0, count=10, age=nil)
+        method = "news"
+
+        options = default_options(BOSSMan.application_id, count, start)
+        options[:age] = age if age
+
+        return REST.get(method, query, options)
+      end
+
+      private    
+      def default_options(appid, count, start)
+        return {:appid => appid, :count => count, :start => start}
+      end
+
+    end
+  end
+end

data/lib/bossman.rb

@@ -1,93 +1,22 @@
-require 'net/http'
-require 'uri'
 require 'rubygems'
 require 'active_support'
-require 'rexml/xpath'
-require 'rexml/document'
 
-module BOSSMan
-  VERSION = :v1
-  BASE_URI = "http://boss.yahooapis.com/ysearch"
-  
-  def application_id(application_id=nil)
-    raise MissingConfiguration, "Application ID must be set prior to making a service call" unless @application_id || application_id
-    return @application_id unless application_id #get
-    @application_id = application_id #set
-  end
-      
-  def web_search(query, start=0, count=10, filter=nil, type=nil, lang=nil, region=nil)    
-    method = "web"
-    
-    options = { 
-      :appid => application_id,
-      :count => count,
-      :start => start
-    }
-    
-    options[:filter] = filter if filter
-    options[:type] = type if type
-    options[:lang] = lang if lang
-    options[:region] = region if region
-    
-    get_from_boss(method, query, options)
-  end
-  
-  def images_search(query, start=0, count=10, filter=nil, dimensions=nil, refererurl=nil, url=nil)
-    method = "images"
-
-    options = { 
-      :appid => application_id,
-      :count => count,
-      :start => start
-    }
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
-    options[:filter] = filter if filter
-    options[:dimensions] = dimensions if dimensions
-    options[:refererurl] = refererurl if refererurl
-    options[:url] = url if url
+require 'bossman/search'
+require 'bossman/rest'
+require 'bossman/basevalueobject'
+require 'bossman/resultset'
+require 'bossman/result'
 
-    get_from_boss(method, query, options)
-  end
-  
-  def news_search(query, start=0, count=10, age=nil)
-    method = "news"
-    
-    options = { 
-      :appid => application_id,
-      :count => count,
-      :start => start
-    }
+module BOSSMan
+  API_VERSION = :v1
+  API_BASEURI = "http://boss.yahooapis.com/ysearch"
 
-    options[:age] = age if age
-    
-    get_from_boss(method, query, options)
-  end
-  
-  private
-  def get_from_boss(method, query, options)
-    uri = URI.parse("#{BASE_URI}/#{method}/#{VERSION}/#{query}")
-    uri.query = options.to_query
+  attr_accessor :application_id
 
-    request = Net::HTTP::Get.new(uri.request_uri)
-    response = Net::HTTP.new(uri.host).request(request)
-    
-    case response
-      when Net::HTTPSuccess
-        return ActiveSupport::JSON.decode(response.body)["ysearchresponse"]        
-      else
-        raise BOSSError, parse_error(response.body)
-    end
-  end
-  
-  def parse_error(response_string)
-    response_document = REXML::Document.new(response_string)
-    code = REXML::XPath.first(response_document, '//yahoo:code').text
-    description = REXML::XPath.first(response_document, '//yahoo:description').text
-    detail = REXML::XPath.first(response_document, '//yahoo:detail').text
-    return "#{code} #{description}: #{detail}"
-  end
-  
   class MissingConfiguration < StandardError; end
+  class InvalidParameter < StandardError; end
   class BOSSError < StandardError; end
-  
 end

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification 
 name: jpignata-bossman
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
-- John Pignata
+- Jay Pignata
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2008-08-14 00:00:00 -07:00
+date: 2008-08-17 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rails
+  name: activesupport
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -30,11 +30,17 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- README
 - bossman.gemspec
 - lib/bossman.rb
+- lib/bossman/basevalueobject.rb
+- lib/bossman/rest.rb
+- lib/bossman/result.rb
+- lib/bossman/resultset.rb
+- lib/bossman/search.rb
+- README
+- LICENSE
 has_rdoc: false
-homepage: http://github.com/jpignata/bossman
+homepage: http://github.com/jpignata/bossman-gem
 post_install_message: 
 rdoc_options: []