@@ -18,7 +18,12 @@ Documentation: http://github.com/eshopworks/rboss-gem/wikis/home == AUTHOR -"Joseph Wilk":http://blog.josephwilk.net/ +Joseph Wilk - http://blog.josephwilk.net/ + +Contributors: + * Matthew Bennett + * Jeroen van Dijk + * Jared Pace == LICENSE: @@ -43,4 +48,4 @@ 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. \ No newline at end of file +SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. README.txt @@ -42,42 +42,62 @@ module Boss end def next_page - make_request(@basepoint + @next_page_path) if @next_page_path + send_request(@basepoint + @next_page_path) if @next_page_path end def previous_page - make_request(@basepoint + @previous_page_path) if @previous_page_path + send_request(@basepoint + @previous_page_path) if @previous_page_path end private - def search_boss(terms, search_type=SearchService::WEB, config = {}) + def search_boss(terms, search_type=SearchService::WEB, config = {}, &block) + config = setup_config(config, &block) + + if config.limit + build_and_send_requests_with_limits(terms, search_type, config) + else + build_and_send_request(terms, search_type, config) + end + end + + def setup_config(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? + validate(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 + config + end + + def build_and_send_requests_with_limits(terms, search_type, config) + limit = config.delete_field(:limit) + # Do a first request to gather required information + results = build_and_send_request(terms, search_type, config) + remaining_requests = number_of_requests_to_reach_limit(results.totalhits.to_i, limit, config.count) + remaining_requests.times { results += next_page } + results + end + + def validate(config) + 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? end - def make_request(url) + def number_of_requests_to_reach_limit(total_results, limit, count) + limit = total_results if total_results < limit + (limit.to_f / count).ceil - 1 + end + + def build_and_send_request(terms, search_type, config) + send_request(build_request_url(terms, search_type, config)) + end + + def send_request(url) request = URI.parse(url) response = Net::HTTP.get_response(request) @@ -103,8 +123,7 @@ module Boss search_results end - - private + def parse_error(data) doc = REXML::Document.new(data.body) # message = doc.elements['Error/Message'].text @@ -116,15 +135,12 @@ module Boss 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 lib/boss/api.rb @@ -5,7 +5,6 @@ module Boss class Config < OpenStruct def initialize(hash={}) - #Setup defaults hash[:count] ||= hash[:limit] ||= 10 super({:lang => "en"}.merge(hash)) @@ -21,4 +20,4 @@ module Boss end -end \ No newline at end of file +end lib/boss/config.rb @@ -191,20 +191,22 @@ describe Boss::Api do 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"} + [ {:count => 2, :limit => 100, :totalhits => "400", :number_of_requests => 50}, # Normal case + {:count => 50, :limit => 100, :totalhits => "400", :number_of_requests => 2 }, # Normal case + {:count => 3, :limit => 50, :totalhits => "50", :number_of_requests => 17}, # Rounding down + {:count => 3, :limit => 50, :totalhits => "40", :number_of_requests => 14}, # Totalhits < limit + {:count => 100, :limit => 1, :totalhits => "40" , :number_of_requests => 1 }, # Limit < count + {:count => nil, :limit => 50, :totalhits => "100", :number_of_requests => 1 } # No count specified ].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]) + describe "requesting #{prop[:count] || 'nil'} results per page" do + describe "when we ask for #{prop[:limit]} results from a total of #{prop[:totalhits]}" do + it "should make #{prop[:number_of_requests]} requests" 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 end end spec/boss/api_spec.rb b1cec7f5d73442e246849c33601de5aa5087fae7 Joseph Wilk josephwilk@joesniff.co.uk http://github.com/eshopworks/rboss-gem/commit/905f3d564b1eaf329ed071c2e69b9b003650dac2 905f3d564b1eaf329ed071c2e69b9b003650dac2 2009-06-17T09:03:14-07:00 2009-06-17T09:03:14-07:00 Major refactoring on internals. Cleaning up confusing spec. 26fb05de6f70b613d51974692aa6d95a04fe920f Joseph Wilk josephwilk@joesniff.co.uk