eshopworks-rboss 0.1.5 → 0.1.6

data/History.txt

@@ -0,0 +1,25 @@
+=== Version 0.1.6
+* Implement the collection api will_paginate uses to display page links in the Boss::ResultCollection (Jared Pace)
+
+=== Version 0.1.5
+* Use pure ruby json gem
+
+=== Version 0.1.4
+* Parse yahoo error reports and return message
+* Encapsulate spell/spelling difference into result factory
+* Removed 'object' format in favour of defaulting to object if format is not set
+* Validate app_id
+
+=== Version 0.1.3
+* Fix for duplicate information being storied in the ResultCollection
+
+=== Version 0.1.2
+* Maintain search result data in ResultCollection
+
+=== Version 0.1.1
+* Fixed exact search error
+* search method takes the same arguments as other search methods
+* Encodes parameters correctly
+
+=== Version 0.1.0
+* Brand spanking new release.

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 eShopworks
+
+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/Manifest.txt

@@ -0,0 +1,37 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+TODO.txt
+config/hoe.rb
+config/requirements.rb
+features/steps/web_search_steps.rb
+features/web_search.feature
+gem_tasks/cucumber.rake
+gem_tasks/deployment.rake
+gem_tasks/environment.rake
+gem_tasks/fix_cr_lf.rake
+gem_tasks/gemspec.rake
+gem_tasks/rspec.rake
+gem_tasks/verify_rcov.rake
+gem_tasks/website.rake
+lib/boss.rb
+lib/boss/api.rb
+lib/boss/config.rb
+lib/boss/result.rb
+lib/boss/result/base.rb
+lib/boss/result/image.rb
+lib/boss/result/news.rb
+lib/boss/result/spell.rb
+lib/boss/result/web.rb
+lib/boss/result_collection.rb
+lib/boss/result_factory.rb
+lib/boss/version.rb
+rboss.gemspec
+spec/boss/api_spec.rb
+spec/boss/config_spec.rb
+spec/boss/result_collection_spec.rb
+spec/boss/result_factory_spec.rb
+spec/spec.opts
+spec/spec_helper.rb

data/README.txt

@@ -0,0 +1,42 @@
+= Rboss
+
+* http://github.com/eshopworks/rboss-gem/
+
+== DESCRIPTION:
+
+A handy gem to make using the Yahoo Boss API nice and easy in ruby.
+Documentation: http://github.com/eshopworks/rboss-gem/wikis/home
+
+== REQUIREMENTS:
+
+* json_pure: http://json.rubyforge.org/
+
+== INSTALL:
+
+* gem sources --add http://gems.github.com/ 
+* gem install eshopworks-rboss
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 eShopworks
+
+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/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['gem_tasks/**/*.rake'].each { |rake| load rake }

data/TODO.txt

@@ -0,0 +1,4 @@
+== FEATURES/PROBLEMS:
+
+* Search all
+* Integrate with Tagging service

data/config/hoe.rb

@@ -0,0 +1,69 @@
+require 'boss'
+require 'boss/version'
+
+AUTHOR = 'Joseph Wilk'  # can also be an array of Authors
+EMAIL = "joe@eshopworks.co.uk"
+DESCRIPTION = "Api wrapping Yahoo Boss search"
+GEM_NAME = 'rboss' # what ppl will type to install your gem
+HOMEPATH = "http://github.com/eshopworks/rboss-gem"
+RUBYFORGE_PROJECT = nil
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "eshopworks"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = YAML.load(`svn info`)['Revision']
+VERS = Boss::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'RBoss documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README.txt",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
+    @extra_deps
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store', '**/*.class', '**/*.jar']  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = []     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  p.extra_deps = [ ['json_pure', '>= 1.1.3'], ['rspec', '>= 1.1.4'], ['diff-lcs', '>= 1.1.2'] ]
+
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+end
+
+CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+$hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+$hoe.rsync_args = '-av --delete --ignore-errors'

data/config/requirements.rb

@@ -0,0 +1,15 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))

data/features/steps/web_search_steps.rb

@@ -0,0 +1,38 @@
+require 'spec'
+$:.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'boss'
+
+Before do
+end
+
+After do
+end
+
+Given "a valid API key" do
+  @api = Boss::Api.new("put-your-api-key-here")
+end
+
+When /I do a '(.+)' search for '(.+)'/ do |search, term|
+
+  case search
+  when 'web'
+    @results = @api.search_web(term)    
+  when 'news'
+    @results = @api.search_news(term)    
+  when 'images'
+    @results = @api.search_images(term)
+  when 'spell'
+    @results = @api.search_spelling(term)
+  else
+    raise Exception.new "invalid search: #{search}"
+  end
+
+end
+
+Then /I will receive search results/ do
+  @results.results.nil?.should == false
+end
+
+Then /I will be able to see the total hits/ do
+  @results.totalhits.to_i.should > 0 
+end

data/features/web_search.feature

@@ -0,0 +1,17 @@
+Feature: Web Search
+  In order to get search results
+  As a API user
+  I want to query yahoo boss
+
+  Scenario: Search web
+    Given a valid API key
+    When I do a 'web' search for 'monkeys'
+    Then I will receive search results
+    And I will be able to see the total hits
+    
+  | type   | term   |
+  | web    | monkey |
+  | images | monkey |
+  | news   | monkey |
+  | spell  | girafe |
+

data/gem_tasks/cucumber.rake

@@ -0,0 +1,6 @@
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "--format pretty" 
+  t.step_pattern = "features/steps/" 
+end

data/gem_tasks/deployment.rake

@@ -0,0 +1,34 @@
+desc 'Release the website and new gem version'
+task :deploy => [:check_version, :website, :release] do
+  puts "Remember to create SVN tag:"
+  puts "svn copy svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/trunk " +
+    "svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/tags/REL-#{VERS} "
+  puts "Suggested comment:"
+  puts "Tagging release #{CHANGES}"
+end
+
+desc 'Runs tasks website_generate and install_gem as a local deployment of the gem'
+task :local_deploy => [:website_generate, :install_gem]
+
+task :check_version do
+  unless ENV['VERSION']
+    puts 'Must pass a VERSION=x.y.z release version'
+    exit
+  end
+  unless ENV['VERSION'] == VERS
+    puts "Please update your version.rb to match the release version, currently #{VERS}"
+    exit
+  end
+end
+
+desc 'Install the package as a gem, without generating documentation(ri/rdoc)'
+task :install_gem_no_doc => [:clean, :package] do
+  sh "#{'sudo ' unless Hoe::WINDOZE }gem install pkg/*.gem --no-rdoc --no-ri"
+end
+
+namespace :manifest do
+  desc 'Recreate Manifest.txt to include ALL files'
+  task :refresh do
+    `rake check_manifest | patch -p0 > Manifest.txt`
+  end
+end

data/gem_tasks/environment.rake

@@ -0,0 +1,7 @@
+task :ruby_env do
+  RUBY_APP = if RUBY_PLATFORM =~ /java/
+    "jruby"
+  else
+    "ruby"
+  end unless defined? RUBY_APP
+end

data/gem_tasks/fix_cr_lf.rake

@@ -0,0 +1,10 @@
+desc 'Make all files use UNIX (\n) line endings'
+task :fix_cr_lf do
+  files = FileList['**/*']
+  files.each do |f|
+    next if File.directory?(f)
+    s = IO.read(f)
+    s.gsub!(/\r?\n/, "\n")
+    File.open(f, "w") { |io| io.write(s) }
+  end
+end

data/gem_tasks/gemspec.rake

@@ -0,0 +1,6 @@
+namespace :gemspec do
+  desc 'Refresh rboss-gem.gemspec to include ALL files'
+  task :refresh => 'manifest:refresh' do
+    File.open('rboss.gemspec', 'w') {|io| io.write($hoe.spec.to_ruby)}
+  end
+end

data/gem_tasks/rspec.rake

@@ -0,0 +1,27 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+
+  unless ENV['NO_RCOV']
+    t.rcov = true
+    t.rcov_dir = 'coverage'
+    t.rcov_opts = ['--exclude', 'spec\/boss,bin\/spec,examples,\/var\/lib\/gems,\/Library\/Ruby,\.autotest']
+  end
+end

data/gem_tasks/verify_rcov.rake

@@ -0,0 +1,7 @@
+require 'rake'
+require 'spec/rake/verify_rcov'
+
+RCov::VerifyTask.new(:verify_rcov => :spec) do |t|
+  t.threshold = 99.7 # Make sure you have rcov 0.9 or higher!
+  t.index_html = 'coverage/index.html'
+end

data/gem_tasks/website.rake

@@ -0,0 +1,17 @@
+desc 'Generate website files'
+task :website_generate => :ruby_env do
+  (Dir['website/**/*.txt'] - Dir['website/version*.txt']).each do |txt|
+    sh %{ #{RUBY_APP} script/txt2html #{txt} > #{txt.gsub(/txt$/,'html')} }
+  end
+end
+
+desc 'Upload website files to rubyforge'
+task :website_upload do
+  host = "#{rubyforge_username}@rubyforge.org"
+  remote_dir = "/var/www/gforge-projects/#{PATH}/"
+  local_dir = 'website'
+  sh %{rsync -aCv #{local_dir}/ #{host}:#{remote_dir}}
+end
+
+desc 'Generate and upload website files'
+task :website => [:website_generate, :website_upload, :publish_docs]

data/lib/boss.rb

@@ -0,0 +1,23 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'boss/api'
+require 'boss/config'
+require 'boss/result'
+require 'boss/result_collection'
+require 'boss/result_factory'
+require 'boss/version'
+
+module Boss
+  YAHOO_VERSION = 1
+
+  module SearchService
+    %w[web images news spelling].each { |e| const_set(e.upcase, e) }
+  end
+
+  FORMATS = %w[xml json]
+ 
+  class BossError < StandardError; end
+  class InvalidFormat < StandardError; end
+  class InvalidConfig < StandardError; end
+end

data/lib/boss/api.rb

@@ -0,0 +1,97 @@
+require 'net/http'
+require 'rexml/document'
+require 'uri'
+
+require 'cgi'
+  
+module Boss
+
+  class Api
+
+    attr_accessor :endpoint
+
+    def initialize(app_id)
+      @app_id = app_id
+      @endpoint = 'http://boss.yahooapis.com/ysearch/'
+    end
+
+    def search(term, *conditions, &block)
+       search_boss(term, SearchService::WEB, *conditions, &block)
+    end
+
+    def search_images(term, *conditions, &block)
+      search_boss(term, SearchService::IMAGES, *conditions, &block)
+    end
+
+    def search_news(term, *conditions, &block)
+      search_boss(term, SearchService::NEWS, *conditions, &block)
+    end
+
+    def search_web(term, *conditions, &block)
+      search_boss(term, SearchService::WEB, *conditions, &block)
+    end
+
+    def search_spelling(term, *conditions, &block)
+      search_boss(term, SearchService::SPELLING, *conditions, &block)
+    end
+
+    private
+    def search_boss(terms, search_type=SearchService::WEB, config = {})
+      config = config.empty? ? Config.new : Config.new(config)
+      yield config if block_given?
+  
+      raise InvalidFormat, "'#{config.format}' is not a valid format. Valid formats are: #{FORMATS.join(',')}" unless FORMATS.include?(config.format) || config.format?
+      raise InvalidConfig, "count must be > 0" unless config.count>0
+      raise InvalidConfig, "App ID cannot be empty!" if @app_id.empty?
+      
+      request =  URI.parse(build_request_url(terms, search_type, config))
+      response = Net::HTTP.get_response(request)
+
+      case response.code
+      when "200"
+        data = response.body
+      
+        if config.format?
+          search_results = ResultFactory.build(data)
+          
+          # set requested page count size
+          # Used in math to determine total pages and current page
+          search_results.set_instance_variable('page_count', config.count) if search_results.kind_of?(Boss::ResultCollection)
+        else
+          search_results = data
+        end
+      else
+        raise BossError, parse_error(response)
+      end
+
+      search_results
+    end
+    
+    private
+    def parse_error(data)
+      doc = REXML::Document.new(data.body) 
+      # message = doc.elements['Error/Message'].text
+      message = REXML::XPath.first( doc, "//Message" )
+      if message
+        message.text
+      else
+        "Error contacting Yahoo Boss web-service"
+      end
+    end
+
+    private
+    def build_request_url(terms, search_type, config)
+      #We could use URI.encode but it leaves things like ? unencoded which fails search.
+      encoded_terms = CGI.escape(terms)
+      # puts "#{@endpoint}#{search_type}/#{boss_version}/#{encoded_terms}?appid=#{@app_id}#{config.to_url}"
+      "#{@endpoint}#{search_type}/#{boss_version}/#{encoded_terms}?appid=#{@app_id}#{config.to_url}"
+    end
+
+    private
+    def boss_version
+      "v#{Boss::YAHOO_VERSION}"
+    end
+
+  end
+
+end

data/lib/boss/config.rb

@@ -0,0 +1,22 @@
+require 'ostruct'
+
+module Boss
+
+  class Config < OpenStruct
+
+    def initialize(hash={})
+      #Setup defaults      
+      super({:count => 10, :lang => "en"}.merge(hash))
+    end
+   
+    def to_url
+      self.marshal_dump.inject("") {|accum, key| encoded_value=CGI.escape(key[1].to_s); accum+="&#{key[0]}=#{encoded_value}"  }
+    end
+    
+    def format?
+      self.format.nil?
+    end
+
+  end
+
+end

data/lib/boss/result.rb

@@ -0,0 +1 @@
+%w{base web image news spell}.each{|f| require "boss/result/#{f}"}

data/lib/boss/result/base.rb

@@ -0,0 +1,15 @@
+require 'ostruct'
+
+module Boss
+  module Result
+    class Base < OpenStruct
+
+      def initialize(data={})
+        super
+      end
+
+    end
+    
+  end
+  
+end

data/lib/boss/result/image.rb

@@ -0,0 +1,8 @@
+module Boss
+  module Result
+    class Image < Base
+    end
+
+  end
+
+end

data/lib/boss/result/news.rb

@@ -0,0 +1,8 @@
+module Boss
+  module Result
+    class News < Base
+    end
+    
+  end
+  
+end

data/lib/boss/result/spell.rb

@@ -0,0 +1,8 @@
+module Boss
+  module Result
+    class Spell < Base
+    end
+    
+  end
+  
+end

data/lib/boss/result/web.rb

@@ -0,0 +1,8 @@
+module Boss
+  module Result
+    class Web < Base
+    end
+    
+  end
+  
+end

data/lib/boss/result_collection.rb

@@ -0,0 +1,55 @@
+module Boss
+  class ResultCollection 
+    include Enumerable
+
+    attr_reader :results
+
+    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 }
+    end
+    
+    def <<(element)
+      @results << element
+    end
+    
+    def [](key)
+      @results[key]
+    end
+    
+    # Implements neccessary api for the will_paginate view helper
+    # to work with result sets out of the box
+    def size
+      @results.size
+    end
+    
+    def empty?
+      @results.empty?
+    end
+    
+    def previous_page
+      self.current_page == 1 ? nil : self.current_page.to_i-1
+    end
+    
+    def next_page
+      self.current_page == self.total_pages ? nil : self.current_page+1
+    end
+    
+    def total_pages
+      (self.totalhits.to_f/self.page_count.to_f).ceil
+    end
+    
+    def current_page
+      (self.start.to_i/self.page_count.to_i) + 1
+    end
+
+  end
+end

data/lib/boss/result_factory.rb

@@ -0,0 +1,61 @@
+require 'json'
+
+module Boss
+    
+  class ResultFactory
+
+    module SearchType
+      %w[web images news spell].each { |e| const_set(e.upcase, e) }
+    end
+
+    SEARCH_RESPONSE = 'ysearchresponse'
+    RESULT_SET = 'resultset'
+
+    class << self
+  
+      def build(data)
+        json_hash = JSON.parse(data)
+
+        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].each do |key,value|
+
+          if key.include? "#{RESULT_SET}_"
+
+            search_type = discover_search_type(key)
+            
+            json_hash[SEARCH_RESPONSE][key].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
+        result_collection
+      end
+
+      private
+      def discover_search_type(string)
+        /#{RESULT_SET}_(.*)/.match(string)[1]
+      end
+      
+    end
+
+  end
+end

data/lib/boss/version.rb

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

data/rboss.gemspec

@@ -0,0 +1,41 @@
+Gem::Specification.new do |s|
+  s.name = %q{rboss}
+  s.version = "0.1.6"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Joseph Wilk"]
+  s.date = %q{2008-10-17}
+  s.description = %q{Api wrapping Yahoo Boss search}
+  s.email = ["joe@eshopworks.co.uk"]
+  s.extra_rdoc_files = ["History.txt", "License.txt", "Manifest.txt", "README.txt", "TODO.txt"]
+  s.files = ["History.txt", "License.txt", "Manifest.txt", "README.txt", "Rakefile", "TODO.txt", "config/hoe.rb", "config/requirements.rb", "features/steps/web_search_steps.rb", "features/web_search.feature", "gem_tasks/cucumber.rake", "gem_tasks/deployment.rake", "gem_tasks/environment.rake", "gem_tasks/fix_cr_lf.rake", "gem_tasks/gemspec.rake", "gem_tasks/rspec.rake", "gem_tasks/verify_rcov.rake", "gem_tasks/website.rake", "lib/boss.rb", "lib/boss/api.rb", "lib/boss/config.rb", "lib/boss/result.rb", "lib/boss/result/base.rb", "lib/boss/result/image.rb", "lib/boss/result/news.rb", "lib/boss/result/spell.rb", "lib/boss/result/web.rb", "lib/boss/result_collection.rb", "lib/boss/result_factory.rb", "lib/boss/version.rb", "rboss.gemspec", "spec/boss/api_spec.rb", "spec/boss/config_spec.rb", "spec/boss/result_collection_spec.rb", "spec/boss/result_factory_spec.rb", "spec/spec.opts", "spec/spec_helper.rb"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/eshopworks/rboss-gem}
+  s.rdoc_options = ["--main", "README.txt"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{rboss}
+  s.rubygems_version = %q{1.2.0}
+  s.summary = %q{Api wrapping Yahoo Boss search}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if current_version >= 3 then
+      s.add_runtime_dependency(%q<json_pure>, [">= 1.1.3"])
+      s.add_runtime_dependency(%q<rspec>, [">= 1.1.4"])
+      s.add_runtime_dependency(%q<diff-lcs>, [">= 1.1.2"])
+      s.add_development_dependency(%q<hoe>, [">= 1.8.0"])
+    else
+      s.add_dependency(%q<json_pure>, [">= 1.1.3"])
+      s.add_dependency(%q<rspec>, [">= 1.1.4"])
+      s.add_dependency(%q<diff-lcs>, [">= 1.1.2"])
+      s.add_dependency(%q<hoe>, [">= 1.8.0"])
+    end
+  else
+    s.add_dependency(%q<json_pure>, [">= 1.1.3"])
+    s.add_dependency(%q<rspec>, [">= 1.1.4"])
+    s.add_dependency(%q<diff-lcs>, [">= 1.1.2"])
+    s.add_dependency(%q<hoe>, [">= 1.8.0"])
+  end
+end

data/spec/boss/api_spec.rb

@@ -0,0 +1,187 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+# require File.dirname(__FILE__) + '/../../boss/api.rb'
+
+describe Boss::Api do
+
+  yahoo_error=<<-EOF
+  <Error xmlns="urn:yahoo:api"
+      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+      xsi:noNamespaceSchemaLocation="http://api.yahoo.com/Api/V1/error.xsd">
+    The following errors were detected:
+    <Message>Service not found. Please see http://developer.yahoo.net for service locations</Message>
+  </Error>
+  EOF
+
+  #TODO: Mock HTTPSuccess
+  def mock_http_response(stubs={})
+    # mock('Net::HTTPSuccess',{:head => Net::HTTPSuccess.new('1.2', '200', 'OK'), :body => '{"ysearchresponse":{}}' })
+    mock('http_response', {:body => '{"ysearchresponse":{}}', :code => "200"}.merge(stubs))
+  end
+
+  def yahoo_json
+    '{"ysearchresponse":{}}'
+  end
+
+  before(:each) do
+    @api = Boss::Api.new( appid = 'test' )
+    @api.endpoint = 'http://www.example.com/'
+  end
+
+  describe "responding to spelling search" do
+
+    it "should make a spelling request to yahoo service" do
+      Net::HTTP.should_receive(:get_response).and_return{ mock_http_response }
+
+      @api.search_spelling("girafes")
+    end
+
+    it "should build the spelling objects" do
+      Net::HTTP.stub!(:get_response).and_return{ mock_http_response }
+      Boss::ResultFactory.should_receive(:build).with(yahoo_json)
+
+      @api.search_spelling("girafes")
+    end
+
+  end
+
+  describe "responding to news search" do
+    it "should make a news request to yahoo service" do
+      Net::HTTP.should_receive(:get_response).and_return{ mock_http_response }
+
+      @api.search_news("monkey")
+    end
+
+    it "should build the news objects" do
+      Net::HTTP.stub!(:get_response).and_return{ mock_http_response }
+      Boss::ResultFactory.should_receive(:build).with(yahoo_json)
+
+      @api.search_news("monkey")
+    end
+  end
+
+  describe "responding to image search" do
+    it "should make a image request to yahoo service" do
+      Net::HTTP.should_receive(:get_response).and_return{ mock_http_response }
+
+      @api.search_images("hippo")
+    end
+
+    it "should build the image objects" do
+      Net::HTTP.stub!(:get_response).and_return{ mock_http_response }
+      Boss::ResultFactory.should_receive(:build).with(yahoo_json)
+
+      @api.search_images("hippo")
+    end
+  end
+
+  describe "responding to web search" do
+
+    it "should make a web request to yahoo service" do
+      Net::HTTP.should_receive(:get_response).and_return{ mock_http_response }
+
+      @api.search_web("monkey")
+    end
+
+    it "should build the web objects" do
+      Net::HTTP.stub!(:get_response).and_return{ mock_http_response }
+      Boss::ResultFactory.should_receive(:build).with(yahoo_json)
+
+      @api.search_web("monkey")
+    end
+
+  end
+
+  describe "failed search" do
+
+    it "should raise error on failed search" do
+      Net::HTTP.stub!(:get_response).and_return{ mock_http_response :code => "404" }
+
+      lambda { @api.search_web("monkey")  }.should raise_error(Boss::BossError)
+    end
+    
+    it "should extract error from xml on failed search" do
+      Net::HTTP.stub!(:get_response).and_return{ mock_http_response :code => "404", :body => yahoo_error }
+
+      lambda { @api.search_web("monkey")  }.should raise_error(Boss::BossError, 'Service not found. Please see http://developer.yahoo.net for service locations')
+    end
+
+  end
+
+  describe "configuring search" do
+
+    before(:each) do
+      Net::HTTP.stub!(:get_response).and_return{ mock_http_response }
+
+      @config = Boss::Config.new
+    end
+
+    it "should allow configuring through block" do
+      @config.should_receive(:count=).with(1)
+      Boss::Config.should_receive(:new).and_return(@config)
+
+      result = @api.search_web("monkeys") do |setup|
+        setup.count = 1
+      end
+    end
+
+    it "should allow configuring through hash" do
+      Boss::Config.should_receive(:new).with({:count => 1}).and_return(@config)
+
+      @api.search_web("monkeys", :count => 1)
+    end
+
+  end
+
+  describe "formats" do
+
+    before(:each) do
+      Net::HTTP.stub!(:get_response).and_return{ mock_http_response }
+    end
+
+    it "should not return any objects when format is 'xml'" do
+      Boss::ResultFactory.should_receive(:build).never
+      @api.search_web("monkeys", :format => 'xml', :count => 1)
+    end
+
+    it "should not return any objects when format is 'json'" do
+      Boss::ResultFactory.should_receive(:build).never
+      @api.search_web("monkeys", :format => 'json', :count => 1)
+    end
+
+    it "should raise an error invalid format" do
+      lambda { @api.search_web("monkeys", :format => 'grilled_cheese', :count => 1) }.should raise_error(Boss::InvalidFormat)
+    end
+
+    it "should raise an error on invalid count" do
+      lambda { @api.search_web("monkeys", :count => 0) }.should raise_error(Boss::InvalidConfig)
+    end
+    
+    it "should raise an error on invalid app id" do
+      @api = Boss::Api.new( app_id = '' )
+
+      lambda { @api.search("monkeys", :count => 1) }.should raise_error(Boss::InvalidConfig)
+    end
+
+  end
+
+  describe "search should still work when get returns a successful but not code 200" do
+    it "should description" do
+      pending("fix for http://eshopworks.lighthouseapp.com/projects/15732/tickets/1")
+      Net::HTTP.stub!(:get_response).and_return{ mock_http_response :code => "206" }
+
+      lambda { @api.search_web("monkey")  }.should_not raise_error(Boss::BossError)
+    end
+  end
+
+  describe "searching terms" do
+    it "should encode invalid characters" do
+      Net::HTTP.stub!(:get_response).and_return{ mock_http_response }
+      CGI.stub!(:escape)
+      CGI.should_receive(:escape).with('monkey?magic').and_return('monkey%3Fmagic')
+      
+      @api.search_web("monkey?magic")
+    end
+    
+  end
+
+end

data/spec/boss/config_spec.rb

@@ -0,0 +1,31 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Boss::Config do
+
+  it "should create with defaults" do
+    config = Boss::Config.new
+
+    config.respond_to?(:count).should be_true
+    config.respond_to?(:lang).should be_true
+  end
+  
+  it "should create url from defaults" do
+    config = Boss::Config.new :count => 1, :lang => 'en', :format => "object"
+  
+    config.to_url.should include("&count=1")
+    config.to_url.should include("&lang=en")
+  end
+  
+  it "should add custom values to url" do
+    config = Boss::Config.new(:mizaru => 'cannot_see')
+    
+    config.to_url.should include("&mizaru=cannot_see")
+  end
+  
+  it "should encode invalid url characters" do
+    config = Boss::Config.new(:mizaru => 'dancing monkeys?')
+    
+    config.to_url.should include("dancing+monkeys%3F")
+  end
+  
+end

data/spec/boss/result_collection_spec.rb

@@ -0,0 +1,73 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Boss::ResultCollection do
+
+  it "should dynamically set instance values given at creation" do
+    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 << 1
+    collection << 2
+    
+    collection.each do |value| 
+      [1,2].member?(value).should be_true
+    end
+    
+  end
+  
+end
+
+describe Boss::ResultCollection, 'implementing the will_paginate collection api' do
+  before(:each) do
+    @collection = Boss::ResultCollection.new
+    @collection.set_instance_variable(:totalhits, "99")
+    @collection.set_instance_variable(:count, "10")
+    @collection.set_instance_variable(:page_count, "10")
+  end
+  
+  it "should be able to return the collection size" do
+    @collection << 1
+    @collection << 2
+    
+    @collection.size.should eql(2)
+  end
+  
+  it "should be empty if no results have been added" do
+    @collection.should be_empty
+  end
+  
+  it "should not have a previous page if it is on page 1" do
+    @collection.set_instance_variable(:start, "0")
+    @collection.previous_page.should be_nil
+  end
+  
+  it "should return the correct previous page" do
+    @collection.set_instance_variable(:start, "10")
+    @collection.previous_page.should eql(1)
+  end
+  
+  it "should return the correct current page" do
+    @collection.set_instance_variable(:start, "10")
+    @collection.current_page.should eql(2)
+  end
+  
+  it "should return the correct next page" do
+    @collection.set_instance_variable(:start, "10")
+    @collection.next_page.should eql(3)
+  end
+  
+  it "should not have a next page if we are on the last page" do
+    @collection.set_instance_variable(:start, "90")
+    @collection.next_page.should be_nil
+  end
+  
+  it "should return the correct number of total pages" do
+    @collection.total_pages.should eql(10)
+  end
+end

data/spec/boss/result_factory_spec.rb

@@ -0,0 +1,57 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Boss::ResultFactory do
+
+  news_json_result = '{"ysearchresponse":{"responsecode":"200","nextpage":"nextpage","totalhits":"344","count":"1","start":"0","resultset_news":[{"abstract":"abstract","clickurl":"clickurl","date":"2008\/08\/18","language":"en english","source":"source","sourceurl":"sourceurl","time":"09:17:29","title":"monkey_title","url":"url"}]}}'
+
+  image_json_result = '{"ysearchresponse":{"responsecode":"200","nextpage":"http:\/\/www.example.com","totalhits":"80","count":"1","start":"0","resultset_images":[{"abstract":"more monkeys","clickurl":"http:\/\/www.example.con\/click","date":"2001\/12\/19","filename":"monkeys.jpg","format":"jpeg","height":"600","mimetype":"image\/jpeg","refererclickurl":"http:\/\/www.example.com\/ref","refererurl":"http:\/\/www.monkeys.com","size":"60900","thumbnail_height":"116","thumbnail_url":"http:\/\/monkey.com\/image\/25\/m7\/3918546506","thumbnail_width":"155","title":"monkeys.jpg","url":"http:\/\/monkey\/monkeys.jpg","width":"800"}]}}'
+
+  web_json_result = '{"ysearchresponse":{"responsecode":"200","nextpage":"nextpage","totalhits":"344","count":"1","start":"0","resultset_web":[{"abstract":"abstract","clickurl":"clickurl","date":"2008\/08\/18","language":"en english","source":"source","sourceurl":"sourceurl","time":"09:17:29","title":"monkey_title","url":"url"}]}}'
+
+  spelling_json_result = '{"ysearchresponse":{"responsecode":"200","totalhits":"1","count":"1","start":"0","resultset_spell":[{"suggestion":"giraffes"}]}}'
+
+  error_json_result = '{"Error":"true"}'
+
+  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(news_json_result)
+  end
+  
+  it "should create a new news object from json" do
+    Boss::Result::News.should_receive(:new).once
+
+    Boss::ResultFactory.build(news_json_result)
+  end
+
+  it "should correctly map fields with from json to news object" do
+    news_results = Boss::ResultFactory.build(news_json_result)
+
+    news_results[0].title.should == "monkey_title"
+  end
+
+  it "should build image objects from json" do
+    Boss::Result::Image.should_receive(:new).once
+
+    Boss::ResultFactory.build(image_json_result)
+  end
+
+  it "should build web object from json" do
+    Boss::Result::Web.should_receive(:new).once
+
+    Boss::ResultFactory.build(web_json_result)
+  end
+
+  it "should build spelling object from json" do
+    Boss::Result::Spell.should_receive(:new).once
+
+    Boss::ResultFactory.build(spelling_json_result)
+  end
+
+  it "should raise an error if json result carries an error" do
+    lambda { Boss::ResultFactory.build(error_json_result) }.should raise_error(Boss::BossError)
+  end
+
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--colour
+--diff

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+gem 'rspec'
+require 'spec'
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))
+
+require 'boss'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: eshopworks-rboss
 version: !ruby/object:Gem::Version 
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors: 
 - Joseph Wilk
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-09-13 00:00:00 -07:00
+date: 2008-10-17 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -46,7 +46,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.7.0
+        version: 1.8.0
     version: 
 description: Api wrapping Yahoo Boss search
 email: 
@@ -55,10 +55,50 @@ executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
-files: []
-
+extra_rdoc_files: 
+- History.txt
+- License.txt
+- Manifest.txt
+- README.txt
+- TODO.txt
+files: 
+- History.txt
+- License.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- TODO.txt
+- config/hoe.rb
+- config/requirements.rb
+- features/steps/web_search_steps.rb
+- features/web_search.feature
+- gem_tasks/cucumber.rake
+- gem_tasks/deployment.rake
+- gem_tasks/environment.rake
+- gem_tasks/fix_cr_lf.rake
+- gem_tasks/gemspec.rake
+- gem_tasks/rspec.rake
+- gem_tasks/verify_rcov.rake
+- gem_tasks/website.rake
+- lib/boss.rb
+- lib/boss/api.rb
+- lib/boss/config.rb
+- lib/boss/result.rb
+- lib/boss/result/base.rb
+- lib/boss/result/image.rb
+- lib/boss/result/news.rb
+- lib/boss/result/spell.rb
+- lib/boss/result/web.rb
+- lib/boss/result_collection.rb
+- lib/boss/result_factory.rb
+- lib/boss/version.rb
+- rboss.gemspec
+- spec/boss/api_spec.rb
+- spec/boss/config_spec.rb
+- spec/boss/result_collection_spec.rb
+- spec/boss/result_factory_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/eshopworks/rboss-gem
 post_install_message: