boss 0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Jamie Hoover
+
+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

@@ -0,0 +1,131 @@
+BOSS (Build your Own Search Service)
+
+Install
+-------
+
+sudo gem install boss
+
+
+Examples
+--------
+
+require 'boss'
+
+boss.appid = 'Bossdemo' # Set the BOSS appid to what Yahoo assigned you.
+
+image_example = boss.images.new('soccer', :count => 30) # Sets a new images resultset of 30 matching 'soccer'.
+image_example.resultset.each do |r| # Gets current images resultset.
+  r.abstract # Now we don't know Crawford from Adam but he's a good friend of WCP-occasional-contributor Beans and he somewhat has a point, or at least made us laugh while making it.
+  r.clickurl # http://us.lrd.yahoo.com/_ylc=X3oDMTFkNXVldGJyBGFwcGlkA2Jvc3NkZW1vBHBvcwMwBHNlcnZpY2UDWVNlYXJjaARzcmNwdmlkAw --/SIG=12f47a1hh/**http%3A//wickedchopspoker.blogs.com/my_weblog/images/why_men_love_soccer.jpg
+  r.date # 2006/06/09
+  r.filename # why_men_love_soccer.jpg
+  r.format # jpeg
+  r.height # 213
+  r.mimetype # image/jpeg
+  r.refererclickur # http://wickedchopspoker.blogs.com/my_weblog/2006/06/world_cup_musin.html
+  r.refererurl # http://wickedchopspoker.blogs.com/my_weblog/2006/06/world_cup_musin.html
+  r.size # 31500
+  r.thumbnail_height # 120
+  r.thumbnail_url # http://re3.yt-thm-a01.yimg.com/image/25/m7/3979077535
+  r.thumbnail_width # 130
+  r.title # why_men_love_soccer.jpg
+  r.url # http://wickedchopspoker.blogs.com/my_weblog/images/why_men_love_soccer.jpg
+  r.width # 230
+end
+image_example.nextpage # Returns string for next images resultset.
+
+news_example = boss.news.new('soccer') # Sets a new news resultset matching 'soccer'.
+news_example.resultset.each do |r| # Gets current news resultset.
+  r.abstract # June 16 (Bloomberg) -- Adidas AG , the world's second - largest sporting-goods maker, will ``clearly exceed'' its full-year sales target for soccer-related goods and gain share in all major markets, Chief Executive Officer Herbert Hainer said.
+  r.clickurl # http://www.bloomberg.com/apps/news?pid=20601100&sid=aSSf0jMZtvBU
+  r.date # 2008/06/16
+  r.language # en english
+  r.source # Bloomberg.com
+  r.sourceurl # http://www.bloomberg.com/
+  r.time # 14:21:15
+  r.title # Adidas Will `Clearly Exceed' Soccer Sales Target, Hainer Says
+  r.url # http://www.bloomberg.com/apps/news?pid=20601100&sid=aSSf0jMZtvBU
+end
+news_example.nextpage # Returns string for next news resultset.
+
+spelling_example = boss.spelling.new # Sets a new spelling resultset.
+spelling_example.resultset.each do |r| # Gets current spelling resultset.
+  r.suggestion # monkeys giraffes
+spelling_example.nextpage # Returns string for next spelling resultset.
+
+web_example = boss.web.new # Sets a new web resultset.
+web_example.resultset.each do |r| # Gets current web resultset.
+  r.abstract # <![CDATA[World <b>soccer</b> coverage from ESPN, including Premiership, Serie A, La Liga, and Major League <b>Soccer</b>. Get news headlines, live scores, stats, and tournament information.]]>
+  r.clickurl # http://us.lrd.yahoo.com/_ylc=X3oDMTFkNXVldGJyBGFwcGlkA2Jvc3NkZW1vBHBvcwMwBHNlcnZpY2UDWVNlYXJjaARzcmNwdmlkAw--/SIG=10u3e8260/**http%3A//www.soccernet.com/
+  r.date # 2008/06/08
+  r.dispurl # <![CDATA[www.<b>soccernet.com</b>]]>
+  r.size # 94650
+  r.title # ESPN Soccernet
+  r.url # http://www.soccernet.com/
+end
+web_example.nextpage # Returns string for next web resultset.
+
+
+Universal Arguments (Image, News, Spelling, and Web)
+----------------------------------------------------
+
+:callback => 'foobar()' # Name of callback function to wrap result.
+
+:count => 10 # Total results to return. Maximum: 50.
+
+:lang => 'en', :region => 'us' # Specifies the language and region (country) search product to query.
+  http://developer.yahoo.com/search/boss/boss_guide/supp_regions_lang.html
+
+:sites => 'abc.com, cnn.com' # Restrict to certain site(s). Note: Images do not yet support multiple sites.
+
+:start => 0 # Ordinal position of first result.
+
+
+Image Arguments
+---------------
+
+:dimensions => # Only images of certain size.
+  'all' # Default
+  'small' # Small images are generally thumbnail or icon sized.
+  'medium' # Medium sized images are average sized; usually not exceeding an average screen size.
+  'large' # Large images are screen size or larger.
+  'wallpaper'
+  'widewallpaper'
+
+:filter => # Offensive Content Reduction filter.
+  'no' # 
+  'yes' # Default, content marked as offensive is omitted.
+
+
+:refererurl => 'http://foo.com' # Only image objects with this referring URL.
+
+:url => 'http://foo.com/images/bar.gif' # Exact image result.
+
+
+News Argument
+-------------
+
+:age => '7d' # String of integer and one of letters "s", "m", "h", "d" and "w" (seconds, minutes, hours, days and weeks)
+
+
+Web Arguments
+-------------
+
+:filter => # Filter out adult or hate content.
+  '-hate' # U.S. only.
+  '-porn'
+  '-hate, -porn' # U.S. only.
+
+:type => # Specifies document formats (pdf, msoffice,etc).
+  'html'
+  'pdf' # Adobe Portable Document Format
+  'msoffice' # xl, msword, ppt
+  'msword' # Microsoft Word
+  'nonhtml' # text, pdf, xl, msword, ppt
+  'ppt' # Microsoft Power Point
+  'text'
+  'xl' # Microsoft Excel: xls, xla, xl
+  'msoffice, -ppt' # Specify a format group then exclude an item.
+  'html, msoffice, -pdf' # Combine inclusion, exclusion, document types, and type groups.
+
+:view => 'keyterms' # Retrieve related words and phrases for each search result.

data/Rakefile

@@ -0,0 +1,38 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+
+spec = Gem::Specification.new do |s|
+  s.add_dependency 'json'
+  s.author = 'UiPoet'
+  s.email = 'dont.tase@me.com'
+  s.files = FileList['lib/boss.rb', '[A-Z]*'].to_a
+  s.has_rdoc = true
+  s.homepage = 'http://uipoet.com'
+  s.name = 'boss'
+  s.rubyforge_project = 'uipoet'
+  s.summary = 'Yahoo BOSS for Ruby'
+  s.version = '0.1'
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc 'Create gemspec'
+task :gemspec do
+  File.open("#{spec.name}.gemspec", 'w') do |file|
+    file.puts spec.to_ruby
+  end
+end
+
+desc 'Release gem to rubyforge.org'
+task :release do
+  require 'rubyforge'
+  sh 'sudo rake package'
+  begin
+    sh 'rubyforge login'
+    sh "rubyforge add_release #{spec.rubyforge_project} #{spec.name} #{spec.version} pkg/#{spec.name}-#{spec.version}.gem"
+  rescue Exception => e
+    puts "Release failed: #{e.message}"
+  end
+end

data/lib/boss.rb

@@ -0,0 +1,295 @@
+require 'rubygems'
+require 'uri'
+require 'net/http'
+require 'json'
+
+module Boss
+
+  def self.appid=(a)
+    @@appid = a
+  end
+
+  def self.appid
+    @@appid || 'Bossdemo'
+  end
+  
+  module Resultset
+
+    def initialize(q, a = {})
+      @query = URI.encode(q)
+      @arguments = arguments(a)
+    end
+
+    def nextpage
+      ysearchresponse['nextpage']
+    end
+
+    def response
+      ysearchresponse["resultset_#{service}"]
+    end
+
+    private
+
+    def arguments(a = {})
+      "appid=#{Boss.appid}&format=json" + a.collect{|n, v| "&#{n}=#{v}"}.to_s
+    end
+    
+    def hostname
+      'boss.yahooapis.com'
+    end
+
+    def page
+      "/ysearch/#{service}/v#{version}/#{@query}?#{@arguments}"
+    end
+
+    def service
+      self.class.to_s.split('::').last.downcase
+    end
+    
+    def uri
+      URI.parse("http://#{hostname}#{page}")
+    end
+
+    def version
+      1
+    end
+
+    def ysearchresponse
+      JSON.parse(Net::HTTP.get_response(uri).body)['ysearchresponse']
+    end
+
+  end
+
+  class Images
+
+    include Resultset
+
+    def resultset
+      response.collect{|r| Result.new(r)}
+    end
+
+    class Result
+
+      attr_accessor :result
+
+      def initialize(r)
+        @result = r
+      end
+
+      def abstract
+        @result['abstract']
+      end
+
+      def clickurl
+        @result['clickurl']
+      end
+
+      def date
+        @result['date']
+      end
+
+      def filename
+        @result['filename']
+      end
+
+      def format
+        @result['format']
+      end
+
+      def height
+        @result['height'].to_i
+      end
+
+      def mimetype
+        @result['mimetype']
+      end
+
+      def refererclickurl
+        @result['refererclickurl']
+      end
+
+      def refererurl
+        @result['refererurl']
+      end
+
+      def size
+        @result['size'].to_i
+      end
+
+      def thumbnail_height
+        @result['thumbnail_height'].to_i
+      end
+
+      def thumbnail_url
+        @result['thumbnail_url']
+      end
+
+      def thumbnail_width
+        @result['thumbnail_width'].to_i
+      end
+
+      def title
+        @result['title']
+      end
+
+      def url
+        @result['url']
+      end
+
+      def width
+        @result['width'].to_i
+      end
+
+    end
+
+  end
+
+  class News
+
+    include Resultset
+
+    def resultset
+      response.collect{|r| Result.new(r)}
+    end
+
+    class Result
+
+      attr_accessor :result
+
+      def initialize(r)
+        @result = r
+      end
+
+      def abstract
+        @result['abstract']
+      end
+  
+      def clickurl
+        @result['clickurl']
+      end
+  
+      def date
+        @result['date']
+      end
+  
+      def language
+        @result['language']
+      end
+  
+      def source
+        @result['source']
+      end
+  
+      def sourceurl
+        @result['sourceurl']
+      end
+  
+      def time
+        @result['time']
+      end
+  
+      def title
+        @result['title']
+      end
+  
+      def url
+        @result['url']
+      end
+      
+    end
+
+  end
+
+  class Spelling
+
+    include Resultset
+
+    def resultset
+      response.collect{|r| Result.new(r)}
+    end
+
+    class Result
+
+      attr_accessor :result
+
+      def initialize(r)
+        @result = r
+      end
+
+      def suggestion
+        @result['suggestion']
+      end
+    
+    end
+
+  end
+
+  class Web
+
+    include Resultset
+
+    def resultset
+      response.collect{|r| Result.new(r)}
+    end
+
+    class Result
+
+      attr_accessor :result
+
+      def initialize(r)
+        @result = r
+      end
+
+      def abstract
+        @result['abstract']
+      end
+  
+      def clickurl
+        @result['clickurl']
+      end
+  
+      def date
+        @result['date']
+      end
+  
+      def dispurl
+        @result['dispurl']
+      end
+  
+      def size
+        @result['size'].to_i
+      end
+  
+      def title
+        @result['title']
+      end
+  
+      def url
+        @result['url']
+      end
+  
+    end
+    
+  end
+
+  def self.images
+    Images
+  end
+
+  def self.news
+    News
+  end
+
+  def self.spelling
+    Spelling
+  end
+
+  def self.web
+    Web
+  end
+
+end
+
+def boss
+  Boss
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: boss
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+platform: ruby
+authors: 
+- UiPoet
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-12 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: dont.tase@me.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/boss.rb
+- LICENSE
+- Rakefile
+- README
+has_rdoc: true
+homepage: http://uipoet.com
+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: uipoet
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: Yahoo BOSS for Ruby
+test_files: []
+