eshopworks-rboss 0.1.1 → 0.1.2

data/History.txt

@@ -1,3 +1,6 @@
+=== 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

data/Manifest.txt

@@ -22,11 +22,13 @@ 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/TODO.txt

@@ -1,4 +1,4 @@
 == FEATURES/PROBLEMS:
 
 * Search all
-* TODO: cleanup encode_for_url
+* Clean up ResultCollection, we store hash result in ResultCollection aswell as objects.

data/lib/boss/api.rb

@@ -2,7 +2,6 @@ require 'net/http'
 require 'rexml/document'
 require 'uri'
 
-require 'ostruct'
 require 'cgi'
   
   
@@ -29,23 +28,23 @@ module Boss
     end
 
     def search(term, *conditions, &block)
-       search_boss term, SearchType::WEB, *conditions, &block
+       search_boss(term, SearchType::WEB, *conditions, &block)
     end
 
     def search_images(term, *conditions, &block)
-      search_boss term, SearchType::IMAGES, *conditions, &block
+      search_boss(term, SearchType::IMAGES, *conditions, &block)
     end
 
     def search_news(term, *conditions, &block)
-      search_boss term, SearchType::NEWS, *conditions, &block
+      search_boss(term, SearchType::NEWS, *conditions, &block)
     end
 
     def search_web(term, *conditions, &block)
-      search_boss term, SearchType::WEB, *conditions, &block
+      search_boss(term, SearchType::WEB, *conditions, &block)
     end
 
     def search_spelling(term, *conditions, &block)
-      search_boss term, SearchService::SPELL, *conditions, &block
+      search_boss(term, SearchService::SPELL, *conditions, &block)
     end
 
     private
@@ -65,15 +64,15 @@ module Boss
       raise InvalidFormat unless (FORMATS.include? config.format)
       raise InvalidConfig unless (config.count>0)
       
-      request = query_url terms, search_type, config
-      response = Net::HTTP.get_response request
+      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 format_as_objects
-          search_results = ResultFactory.build search_type, data
+          search_results = ResultFactory.build(search_type, data)
         else
           search_results = data
         end
@@ -90,9 +89,9 @@ module Boss
     end
 
     protected
-    def query_url(terms, search_type, config)
+    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
+      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

data/lib/boss/config.rb

@@ -1,3 +1,5 @@
+require 'ostruct'
+
 module Boss
 
   class Config < OpenStruct

data/lib/boss/result/base.rb

@@ -1,3 +1,5 @@
+require 'ostruct'
+
 module Boss
   module Result
     class Base < OpenStruct

data/lib/boss/result_collection.rb

@@ -0,0 +1,26 @@
+module Boss
+  class ResultCollection 
+    include Enumerable
+
+    def initialize(search_data)
+      search_data.each do |name, value|
+        instance_variable_set("@#{name}",value)
+        instance_eval("def #{name}\n @#{name}\n end")        
+      end
+      @results=[]
+    end
+
+    def each
+      @results.each { |result| yield result }
+    end
+    
+    def <<(element)
+      @results << element
+    end
+    
+    def [](key)
+      @results[key]
+    end
+
+  end
+end

data/lib/boss/result_factory.rb

@@ -18,31 +18,31 @@ module Boss
         if json_hash.has_key? 'Error'
           raise BossError, "Web service error"
         end
-
-        search_results=[]
                 
-        if has_results json_hash, :for => search_type
+        result_collection = ResultCollection.new(json_hash[SEARCH_RESPONSE])
+                
+        if has_results?(json_hash, :for => search_type)
 
           json_hash[SEARCH_RESPONSE]["#{RESULT_SET}_#{search_type}"].each do |result|
 
             case search_type
             when SearchType::WEB
-              search_results << Result::Web.new(result)
+              result_collection << Result::Web.new(result)
             when SearchType::IMAGES
-              search_results << Result::Image.new(result)
+              result_collection << Result::Image.new(result)
             when SearchType::NEWS
-              search_results << Result::News.new(result)
+              result_collection << Result::News.new(result)
             when SearchType::SPELL
-              search_results << Result::Spell.new(result)
+              result_collection << Result::Spell.new(result)
             end
 
           end
         end
 
-        search_results
+        result_collection
       end
 
-      def has_results(json_hash, type={})
+      def has_results?(json_hash, type={})
         !(json_hash[SEARCH_RESPONSE]["#{RESULT_SET}_#{type[:for]}"]).nil?
       end
 

data/lib/boss/version.rb

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

data/lib/boss.rb

@@ -4,6 +4,7 @@ $:.unshift(File.dirname(__FILE__)) unless
 require 'boss/api'
 require 'boss/config'
 require 'boss/result'
+require 'boss/result_collection'
 require 'boss/result_factory'
 require 'boss/version'
 

data/rboss.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = %q{rboss}
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Joseph Wilk"]
@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.description = %q{Api wrapping Yahoo Boss search}
   s.email = ["joe@eshopworks.co.uk"]
   s.extra_rdoc_files = ["History.txt", "License.txt", "Manifest.txt", "TODO.txt"]
-  s.files = ["History.txt", "License.txt", "Manifest.txt", "README.textile", "Rakefile", "TODO.txt", "config/hoe.rb", "config/requirements.rb", "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_factory.rb", "lib/boss/version.rb", "rboss.gemspec", "spec/boss/api_spec.rb", "spec/boss/config_spec.rb", "spec/boss/result_factory_spec.rb", "spec/spec.opts", "spec/spec_helper.rb"]
+  s.files = ["History.txt", "License.txt", "Manifest.txt", "README.textile", "Rakefile", "TODO.txt", "config/hoe.rb", "config/requirements.rb", "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"]

data/spec/boss/api_spec.rb

@@ -17,14 +17,14 @@ describe Boss::Api 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"
+      @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(Boss::SearchService::SPELL, '{"ysearchresponse":{}}')
 
-      @api.search_spelling "girafes"
+      @api.search_spelling("girafes")
     end
 
   end
@@ -33,14 +33,14 @@ describe Boss::Api 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"
+      @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(Boss::SearchType::NEWS, '{"ysearchresponse":{}}')
 
-      @api.search_news "monkey"
+      @api.search_news("monkey")
     end
   end
 
@@ -48,14 +48,14 @@ describe Boss::Api 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"
+      @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(Boss::SearchType::IMAGES, '{"ysearchresponse":{}}')
 
-      @api.search_images "hippo"
+      @api.search_images("hippo")
     end
   end
 
@@ -64,14 +64,14 @@ describe Boss::Api 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"
+      @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(Boss::SearchType::WEB, '{"ysearchresponse":{}}')
 
-      @api.search_web "monkey"
+      @api.search_web("monkey")
     end
 
   end
@@ -81,7 +81,7 @@ describe Boss::Api 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)
+      lambda { @api.search_web("monkey")  }.should raise_error(Boss::BossError)
     end
 
   end
@@ -98,7 +98,7 @@ describe Boss::Api do
       @config.should_receive(:count=).with(1)
       Boss::Config.should_receive(:new).and_return(@config)
 
-      result = @api.search_web "monkeys" do |setup|
+      result = @api.search_web("monkeys") do |setup|
         setup.count = 1
       end
     end
@@ -106,7 +106,7 @@ describe Boss::Api do
     it "should allow configuring through hash" do
       Boss::Config.should_receive(:new).with({:count => 1}).and_return(@config)
 
-      @api.search_web "monkeys", :count => 1
+      @api.search_web("monkeys", :count => 1)
     end
 
   end
@@ -119,20 +119,20 @@ describe Boss::Api do
 
     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
+      @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
+      @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)
+      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)
+      lambda { @api.search_web("monkeys", :count => 0) }.should raise_error(Boss::InvalidConfig)
     end
 
   end
@@ -142,7 +142,7 @@ describe Boss::Api 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)
+      lambda { @api.search_web("monkey")  }.should_not raise_error(Boss::BossError)
     end
   end
 
@@ -152,7 +152,7 @@ describe Boss::Api do
       CGI.stub!(:escape)
       CGI.should_receive(:escape).with('monkey?magic').and_return('monkey%3Fmagic')
       
-      @api.search_web "monkey?magic"
+      @api.search_web("monkey?magic")
     end
     
   end

data/spec/boss/config_spec.rb

@@ -19,13 +19,13 @@ describe Boss::Config do
   end
   
   it "should add custom values to url" do
-    config = Boss::Config.new :mizaru => 'cannot_see'
+    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 = Boss::Config.new(:mizaru => 'dancing monkeys?')
     
     config.to_url.should include("dancing+monkeys%3F")
   end

data/spec/boss/result_collection_spec.rb

@@ -0,0 +1,23 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Boss::ResultCollection do
+
+  it "should dynamically set instance values given at creation" do
+    collection = Boss::ResultCollection.new({: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

data/spec/boss/result_factory_spec.rb

@@ -2,16 +2,24 @@ 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"}]}}'
+  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"}]}}'
+  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"}]}}'
+  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"}]}}'
 
-   error_json_result = '{"Error":"true"}'
+  spelling_json_result = '{"ysearchresponse":{"responsecode":"200","totalhits":"1","count":"1","start":"0","resultset_spell":[{"suggestion":"giraffes"}]}}'
 
+  error_json_result = '{"Error":"true"}'
+
+  it "should create a result collection" do
+    news_hash = JSON.parse(news_json_result)
+    result_collection = Boss::ResultCollection.new(news_hash)
+    Boss::ResultCollection.should_receive(:new).once.with(news_hash['ysearchresponse']).and_return(result_collection)
+      
+    Boss::ResultFactory.build(Boss::SearchType::NEWS, news_json_result)
+  end
+  
   it "should create a new news object from json" do
     Boss::Result::News.should_receive(:new).once
 
@@ -23,27 +31,27 @@ describe Boss::ResultFactory do
 
     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(Boss::SearchType::IMAGES, image_json_result)
   end
-  
+
   it "should build web object from json" do
     Boss::Result::Web.should_receive(:new).once
 
     Boss::ResultFactory.build(Boss::SearchType::WEB, web_json_result)
   end
-   
+
   it "should build spelling object from json" do
     Boss::Result::Spell.should_receive(:new).once
-    
+
     Boss::ResultFactory.build(Boss::SearchType::SPELL, spelling_json_result)
   end
-  
+
   it "should raise an error if json result carries an error" do
     lambda { Boss::ResultFactory.build(Boss::SearchType::WEB, error_json_result) }.should raise_error(Boss::BossError)
   end
-  
-end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: eshopworks-rboss
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Joseph Wilk
@@ -85,11 +85,13 @@ files:
 - 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