eshopworks-rboss 0.1.8 → 0.1.9

data/TODO.txt

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

data/features/steps/web_search_steps.rb

@@ -12,27 +12,39 @@ 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|
+When /^I do the following search$/ do |table|
+  # Do integer conversions
+  table.send :map_headers!, 'limit' => :limit, 'count' => :count
+  table.map_column!(:limit) { |x| x.nil? ? nil : x.to_i }
+  table.map_column!(:count) { |x| x.nil? ? nil : x.to_i }
 
-  case search
+  search_options = table.hashes.first  
+
+  type = search_options.delete('type')
+  term = search_options.delete('term')
+
+  case type
   when 'web'
-    @results = @api.search_web(term)    
+    @results = @api.search_web(term, search_options)    
   when 'news'
-    @results = @api.search_news(term)    
+    @results = @api.search_news(term, search_options)    
   when 'images'
-    @results = @api.search_images(term)
+    @results = @api.search_images(term, search_options)
   when 'spell'
-    @results = @api.search_spelling(term)
+    @results = @api.search_spelling(term, search_options)
   else
-    raise Exception.new "invalid search: #{search}"
+    raise Exception.new "invalid search: #{type}"
   end
-
 end
 
 Then /I will receive search results/ do
   @results.results.nil?.should == false
 end
 
+Then /^I will receive "([^\"]*)" search results$/ do |number_of_results|
+  @results.results.size.should == number_of_results.to_i
+end
+
 Then /I will be able to see the total hits/ do
   @results.totalhits.to_i.should > 0 
 end

data/features/web_search.feature

@@ -3,16 +3,23 @@ Feature: Web Search
   As a API user
   I want to query yahoo boss
 
-  Scenario: Search web
+  Scenario Outline: Search
     Given a valid API key
-    When I do a 'web' search for 'monkeys'
-    Then I will receive search results
+    When I do the following search
+      | type   | term   | count   | limit   |
+      | <type> | <term> | <count> | <limit> |
+    Then I will receive "<result_count>" search results
     And I will be able to see the total hits
   
-  More Examples:
-  | type   | term   |
-  | web    | monkey |
-  | images | monkey |
-  | news   | monkey |
-  | spell  | girafe |
+  Examples: search types
+    | type   | term   | count | limit | result_count |
+    | web    | monkey |       | 5     | 5            |
+    | web    | monkey | 1     | 3     | 3            |
+    | web    | monkey | 5     | 6     | 10           |
+    | web    | monkey | 50    | 100   | 100          |
+    | images | monkey | 1     | 10    | 10           |
+    | news   | monkey | 1     | 1     | 1            | 
+    | spell  | girafe | 1     | 1     | 1            |
+    
+  
 

data/lib/boss/api.rb

@@ -8,11 +8,13 @@ module Boss
 
   class Api
 
+    MAX_COUNT = 50
     attr_accessor :endpoint
 
     def initialize(app_id)
       @app_id = app_id
-      @endpoint = 'http://boss.yahooapis.com/ysearch/'
+      @basepoint = 'http://boss.yahooapis.com'
+      @endpoint = "#{@basepoint}/ysearch/"
     end
 
     def search(term, *conditions, &block)
@@ -35,28 +37,59 @@ module Boss
       search_boss(term, SearchService::SPELLING, *conditions, &block)
     end
 
+    def next_page
+      make_request(@basepoint + @next_page_path) if @next_page_path
+    end
+
+    def previous_page
+      make_request(@basepoint + @previous_page_path) if @previous_page_path
+    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))
+      config.count = MAX_COUNT if config.count > MAX_COUNT
+      
+      # Remember search instructions for iterating over pages
+      @current_config = config.dup
+      
+      if limit = config.delete_field(:limit)
+        # Do a first request to gather required information
+        results = make_request(build_request_url(terms, search_type, config) )
+        total_count = results.totalhits.to_i
+        limit = total_count if total_count < limit
+        number_of_requests = (limit.to_f / config.count).ceil - 1
+
+        number_of_requests.times { results += next_page }
+        results
+      else
+        results = make_request(build_request_url(terms, search_type, config))
+      end
+    end
+    
+    def make_request(url)
+      request =  URI.parse(url)
       response = Net::HTTP.get_response(request)
 
       case response.code
       when "200"
         data = response.body
-      
-        if config.format?
+
+        if @current_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)
+          search_results.set_instance_variable('page_count', @current_config.count) if search_results.kind_of?(Boss::ResultCollection)
+
+          @next_page_path = search_results.nextpage if search_results.respond_to?(:nextpage)
+          @previous_page_path = search_results.prevpage if search_results.respond_to?(:prevpage)
         else
           search_results = data
         end
@@ -94,4 +127,4 @@ module Boss
 
   end
 
-end
+end

data/lib/boss/config.rb

@@ -5,8 +5,10 @@ module Boss
   class Config < OpenStruct
 
     def initialize(hash={})
-      #Setup defaults      
-      super({:count => 10, :lang => "en"}.merge(hash))
+      #Setup defaults
+      hash[:count] ||= hash[:limit] ||= 10
+      
+      super({:lang => "en"}.merge(hash))
     end
    
     def to_url

data/lib/boss/result_collection.rb

@@ -25,6 +25,12 @@ module Boss
       @results[key]
     end
     
+    def +(other)
+      clone = self.clone
+      clone.instance_variable_set("@results", clone.results + other.results)
+      clone
+    end
+    
     # Implements neccessary api for the will_paginate view helper
     # to work with result sets out of the box
     def size

data/lib/boss/version.rb

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

data/rboss.gemspec

@@ -1,10 +1,12 @@
+# -*- encoding: utf-8 -*-
+
 Gem::Specification.new do |s|
   s.name = %q{rboss}
-  s.version = "0.1.8"
+  s.version = "0.1.9"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Joseph Wilk"]
-  s.date = %q{2008-10-31}
+  s.date = %q{2009-06-04}
   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"]
@@ -14,28 +16,28 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--main", "README.txt"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{rboss}
-  s.rubygems_version = %q{1.2.0}
+  s.rubygems_version = %q{1.3.1}
   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
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') 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.2"])
+      s.add_development_dependency(%q<hoe>, [">= 1.12.2"])
     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.2"])
+      s.add_dependency(%q<hoe>, [">= 1.12.2"])
     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.2"])
+    s.add_dependency(%q<hoe>, [">= 1.12.2"])
   end
 end

data/spec/boss/api_spec.rb

@@ -15,80 +15,44 @@ describe Boss::Api do
   #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))
+    mock('http_response', {:body => yahoo_json, :code => "200"}.merge(stubs))
   end
 
-  def yahoo_json
-    '{"ysearchresponse":{}}'
+  def mock_http_response_with_one_record(stubs={})
+    mock_http_response(:body => yahoo_json)
   end
 
-  before(:each) do
-    @api = Boss::Api.new( appid = 'test' )
-    @api.endpoint = 'http://www.example.com/'
+  def mock_results(stubs={})
+    mock(:results, {:totalhits => 100 }.merge(stubs) )
   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
-
+  
+  def yahoo_json(hash = {})
+    defaults = {:nextpage => "nextpage", :totalhits => "1000"}
+    %[{"ysearchresponse": #{defaults.merge(hash).to_json} }]
   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
+  before(:each) do
+    @api = Boss::Api.new( appid = 'test' )
+    @api.endpoint = 'http://www.example.com/'
   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 }
+  %w(spelling new web image).each do |type|
+    describe "responding to #{type} search" do
 
-      @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
+      it "should make a #{type} request to yahoo service" do
+        Net::HTTP.should_receive(:get_response).and_return{ mock_http_response }
 
-  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
 
-      @api.search_web("monkey")
-    end
+      it "should build the #{type} objects" do
+        Net::HTTP.stub!(:get_response).and_return{ mock_http_response }
+        Boss::ResultFactory.should_receive(:build).with(yahoo_json).and_return(mock_results)
 
-    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
 
-      @api.search_web("monkey")
     end
-
   end
 
   describe "failed search" do
@@ -183,5 +147,64 @@ describe Boss::Api do
     end
     
   end
-
+  
+  describe "#next_page" do
+    it "should request the next results when 'nextpage' is given" do
+      response_mock = mock_http_response(:body => yahoo_json(:nextpage => "nextpage"))
+    
+      Net::HTTP.should_receive(:get_response).exactly(2).times.and_return{ response_mock }
+      @api.search_web("monkey?magic", :count => 1)
+      @api.next_page.should be_kind_of Boss::ResultCollection
+    end
+    
+    it "should not request the next results when 'nextpage' is nil" do
+      response_mock = mock_http_response(:body => yahoo_json(:nextpage => nil))
+    
+      Net::HTTP.should_receive(:get_response).exactly(1).times.and_return{ response_mock }
+      @api.search_web("monkey?magic", :count => 1)
+      @api.next_page.should be_nil
+    end
+  end
+  
+  describe "#previous_page" do
+    it "should request the next results when 'nextpage' is given" do
+      response_mock = mock_http_response(:body => yahoo_json(:prevpage => "prevpage"))
+    
+      Net::HTTP.should_receive(:get_response).exactly(2).times.and_return{ response_mock }
+      @api.search_web("monkey?magic", :count => 1)
+      @api.previous_page.should be_kind_of Boss::ResultCollection
+    end
+    
+    it "should not request the next results when 'nextpage' is nil" do
+      response_mock = mock_http_response(:body => yahoo_json(:prevpage => nil))
+    
+      Net::HTTP.should_receive(:get_response).exactly(1).times.and_return{ response_mock }
+      @api.search_web("monkey?magic", :count => 1)
+      @api.previous_page.should be_nil
+    end
+  end
+  
+  describe "MAX_COUNT" do
+    it "should be 50" do
+      Boss::Api::MAX_COUNT.should eql 50
+    end
+  end
+  
+  describe "#search" do
+    
+    [ {:count => 2,   :limit => 100, :number_of_requests => 50, :totalhits => "400"},
+      {:count => 50,  :limit => 100, :number_of_requests => 2,  :totalhits => "400"},
+      {:count => 3,   :limit => 50,  :number_of_requests => 17, :totalhits => "50"},
+      {:count => 3,   :limit => 50,  :number_of_requests => 14, :totalhits => "40"},
+      {:count => 100, :limit => 1,   :number_of_requests => 1,  :totalhits => "40"},
+      {:limit => 50, :count => nil, :number_of_requests => 1, :totalhits => "100"}
+    ].each do |prop|
+      it "should do #{prop[:number_of_requests]} number of requests when count is #{prop[:count]} and limit is #{prop[:limit]}" do
+        response_mock = mock_http_response(:body => yahoo_json(:nextpage => "nextpage", :totalhits => prop[:totalhits]))
+        Net::HTTP.should_receive(:get_response).exactly(prop[:number_of_requests]).times.and_return{ response_mock }
+        @api.search_web("monkey?magic", :count => prop[:count], :limit => prop[:limit])
+      end
+      
+    end
+  end
 end

data/spec/boss/config_spec.rb

@@ -5,6 +5,7 @@ describe Boss::Config do
   it "should create with defaults" do
     config = Boss::Config.new
 
+    config.respond_to?(:limit).should be_true
     config.respond_to?(:count).should be_true
     config.respond_to?(:lang).should be_true
   end

data/spec/boss/result_collection_spec.rb

@@ -21,6 +21,16 @@ describe Boss::ResultCollection do
     
   end
   
+  it "should allow merging two results collections" do
+    collection_one = Boss::ResultCollection.new
+    collection_one << 1
+    collection_two = Boss::ResultCollection.new
+    collection_two << 2
+    
+    collection_one += collection_two
+    collection_one.size.should be 2
+  end
+  
 end
 
 describe Boss::ResultCollection, 'implementing the will_paginate collection api' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: eshopworks-rboss
 version: !ruby/object:Gem::Version 
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors: 
 - Joseph Wilk
@@ -9,11 +9,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-10-31 00:00:00 -07:00
+date: 2009-06-04 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: json_pure
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -23,6 +24,7 @@ dependencies:
     version: 
 - !ruby/object:Gem::Dependency 
   name: rspec
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -32,6 +34,7 @@ dependencies:
     version: 
 - !ruby/object:Gem::Dependency 
   name: diff-lcs
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -41,12 +44,13 @@ dependencies:
     version: 
 - !ruby/object:Gem::Dependency 
   name: hoe
+  type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.8.2
+        version: 1.12.2
     version: 
 description: Api wrapping Yahoo Boss search
 email: