howcast 0.4.3 → 0.4.10

data/spec/howcast/client/base_spec.rb

@@ -11,4 +11,44 @@ describe Howcast::Client, "initialize" do
       Howcast::Client.new
     }.should raise_error(Howcast::ApiKeyNotFound)
   end
-end
+end
+
+describe Howcast::Client, "base_uri" do
+  after :each do
+    Howcast::Client.instance_variable_set :@base_uri, nil
+  end
+
+  it "should use a default base_uri of www.howcast.com" do
+    Howcast::Client.base_uri.to_s.should == "http://www.howcast.com"
+  end
+
+  it "should allow easily setting the base_url" do
+    lambda do
+      Howcast::Client.base_uri = URI.parse("http://example.com")
+    end.should change{Howcast::Client.base_uri.to_s}.to("http://example.com")
+  end
+
+  it "should be easy to set the base_uri with a URI object" do
+    Howcast::Client.base_uri = URI::HTTP.new 'http', nil, 'example.com', nil, nil, nil, nil, nil, nil
+    Howcast::Client.base_uri.should be_kind_of(URI)
+    Howcast::Client.base_uri.host.should == "example.com"
+  end
+
+  it "should be easy to set the base_uri with a string" do
+    Howcast::Client.base_uri = "http://example.com"
+    Howcast::Client.base_uri.should be_kind_of(URI)
+    Howcast::Client.base_uri.host.should == "example.com"
+  end
+
+  it "should be easy to set the base_uri with a hash" do
+    Howcast::Client.base_uri = {:scheme => 'http', :host => 'example.com'}
+    Howcast::Client.base_uri.should be_kind_of(URI)
+    Howcast::Client.base_uri.host.should == "example.com"
+  end
+
+  it "should raise an error when trying to set the base_uri to something weird" do
+    lambda do
+      Howcast::Client.base_uri = nil
+    end.should raise_error(ArgumentError)
+  end
+end

data/spec/howcast/client/category_spec.rb

@@ -20,7 +20,7 @@ describe Howcast::Client, "category" do
   end
   
   it "should establish a connection with the correct category url" do
-    @hc.should_receive(:open).with("http://www.howcast.com/categories/2.xml?api_key=myapikey").and_return(category_xml)
+    @hc.should_receive(:open).with(equivalent_uri("http://www.howcast.com/categories/2.xml?api_key=myapikey")).and_return(category_xml)
     @hc.category(2)
   end  
   
@@ -42,4 +42,4 @@ describe Howcast::Client, "category" do
   it "should set the parents metadata hash" do
     @hc.category(2).parents.should == [{:id => "1571", :name => "Travel"}, {:id => "1584", :name => "African Travel"}]
   end
-end
+end

data/spec/howcast/client/search_spec.rb

@@ -1,88 +1,85 @@
 require File.dirname(__FILE__) + '/../../spec_helper'
 
-describe Howcast::Client, "video_search" do
-  before do
-    @hc = Howcast::Client.new(:key => "myapikey")
-  end
-  
-  it "should establish a connection with search.xml?q=something&view=video when query is 'something'" do
-    @hc.should_receive(:open).with("http://www.howcast.com/search.xml?q=something&view=video&api_key=myapikey").and_return(videos_xml)
-    @hc.video_search("something")
-  end
-  
-  it "should establish a connection with search.xml?q=something&view=video&page=2 when query is 'something' and :page => 2" do
-    @hc.should_receive(:open).with("http://www.howcast.com/search.xml?q=something&view=video&page=2&api_key=myapikey").and_return(videos_xml)
-    @hc.video_search("something", :page => 2)
-  end
-  
-  it "should escape the query when esablishing the connection" do
-    @hc.should_receive(:open).with("http://www.howcast.com/search.xml?q=something+%26+something&view=video&api_key=myapikey").and_return(videos_xml)
-    @hc.video_search("something & something")
-  end
-  
-  it "should append mode=extended when passed in as an option" do
-    @hc.should_receive(:open).with("http://www.howcast.com/search.xml?q=something&view=video&mode=extended&api_key=myapikey").and_return(videos_xml)
-    @hc.video_search("something", :mode => :extended)
-  end
-  
+shared_examples_for "a search method" do
   it "should raise a Howcast::ApiNotFound if url is invalid" do
     lambda {
       @hc.should_receive(:open).and_raise(URI::InvalidURIError)
-      @hc.video_search("something")
+      do_search
     }.should raise_error(Howcast::ApiNotFound)
   end
-  
+
   it "should return an empty array if there are no results" do
     @hc.should_receive(:open).and_return(blank_videos_xml)
-    @hc.video_search("something").should be_empty
+    do_search.should be_empty
   end
-  
+
   it "should return an array of video objects if there are some returned" do
     @hc.should_receive(:open).and_return(videos_xml)
-    videos = @hc.video_search("something")
+    videos = do_search
     videos.size.should == 3
     videos.first.permalink.should == "http://www.howcast.com/videos/1101-How-To-Pretend-Youre-a-Real-New-Yorker"
     videos.last.permalink.should == "http://www.howcast.com/videos/866-How-To-Make-a-Water-Gun-Alarm-Clock"
   end
 end
 
-describe Howcast::Client, "guide_search" do
+describe Howcast::Client, "search" do
   before do
     @hc = Howcast::Client.new(:key => "myapikey")
+    @method = :search
   end
-  
-  it "should establish a connection with search.xml?q=something&view=guide when query is 'something'" do
-    @hc.should_receive(:open).with("http://www.howcast.com/search.xml?q=something&view=guide&api_key=myapikey").and_return(guides_xml)
-    @hc.guide_search("something")
+
+  def do_search
+    @hc.search "something"
+  end
+
+  it_should_behave_like "a search method"
+
+  it "should establish a connection with search.xml?q=something&view=videos when query is 'something'" do
+    @hc.should_receive(:open).with(equivalent_uri("http://www.howcast.com/search.xml?q=something&view=videos&api_key=myapikey")).and_return(videos_xml)
+    @hc.search("something")
   end
-  
-  it "should establish a connection with search.xml?q=something&view=guide&page=2 when query is 'something' and :page => 2" do
-    @hc.should_receive(:open).with("http://www.howcast.com/search.xml?q=something&view=guide&page=2&api_key=myapikey").and_return(guides_xml)
-    @hc.guide_search("something", :page => 2)
+
+  it "should establish a connection with search.xml?q=something&view=videos&page=2 when query is 'something' and :page => 2" do
+    @hc.should_receive(:open).with(equivalent_uri("http://www.howcast.com/search.xml?q=something&view=videos&page=2&api_key=myapikey")).and_return(videos_xml)
+    @hc.search("something", :page => 2)
   end
-  
+
   it "should escape the query when esablishing the connection" do
-    @hc.should_receive(:open).with("http://www.howcast.com/search.xml?q=something+%26+something&view=guide&api_key=myapikey").and_return(guides_xml)
-    @hc.guide_search("something & something")
+    @hc.should_receive(:open).with(equivalent_uri("http://www.howcast.com/search.xml?q=something+%26+something&view=videos&api_key=myapikey")).and_return(videos_xml)
+    @hc.search("something & something")
   end
-  
-  it "should raise a Howcast::ApiNotFound if url is invalid" do
-    lambda {
-      @hc.should_receive(:open).and_raise(URI::InvalidURIError)
-      @hc.guide_search("something")
-    }.should raise_error(Howcast::ApiNotFound)
+
+  it "should append mode=extended when passed in as an option" do
+    @hc.should_receive(:open).with(equivalent_uri("http://www.howcast.com/search.xml?q=something&mode=extended&view=videos&api_key=myapikey")).and_return(videos_xml)
+    @hc.search("something", :mode => :extended)
   end
-  
-  it "should return an empty array if there are no results" do
-    @hc.should_receive(:open).and_return(blank_guides_xml)
-    @hc.guide_search("something").should be_empty
+
+end
+
+describe Howcast::Client, "advanced_search" do
+  before do
+    @hc = Howcast::Client.new(:key => "myapikey")
   end
-  
-  it "should return an array of video objects if there are some returned" do
-    @hc.should_receive(:open).and_return(videos_xml)
-    videos = @hc.video_search("something")
-    videos.size.should == 3
-    videos.first.permalink.should == "http://www.howcast.com/videos/1101-How-To-Pretend-Youre-a-Real-New-Yorker"
-    videos.last.permalink.should == "http://www.howcast.com/videos/866-How-To-Make-a-Water-Gun-Alarm-Clock"
+
+  def do_search
+    @hc.advanced_search :q => "something"
+  end
+
+  it_should_behave_like "a search method"
+
+  it "should establish a connection to the search path on howcast.com" do
+    @hc.should_receive(:open).with(to_s_like(%r{^http://www.howcast.com/search.xml})).and_return(videos_xml)
+    @hc.advanced_search({})
   end
-end
+
+  it "should url-encode any passed params" do
+    @hc.should_receive(:open).with(to_s_like(%r{q=something})).and_return(videos_xml)
+    @hc.advanced_search :q => "something"
+  end
+
+  it "should not create default params" do
+    @hc.should_receive(:open).with(to_s_like(%r{mode=foo})).and_return(videos_xml)
+    @hc.should_not_receive(:open).with(to_s_like(%r{view=}))
+    @hc.advanced_search :mode => "foo"
+  end
+end

data/spec/howcast/client/video_spec.rb

@@ -20,7 +20,7 @@ describe Howcast::Client, "video" do
   end
   
   it "should establish a connection with the correct video url" do
-    @hc.should_receive(:open).with("http://www.howcast.com/videos/2.xml?api_key=myapikey").and_return(video_xml)
+    @hc.should_receive(:open).with(equivalent_uri("http://www.howcast.com/videos/2.xml?api_key=myapikey")).and_return(video_xml)
     @hc.video(2)
   end  
   
@@ -75,27 +75,27 @@ describe Howcast::Client, "videos" do
   end
   
   it "should establish a connection with videos/most_recent/howcast_studios.xml by default" do
-    @hc.should_receive(:open).with("http://www.howcast.com/videos/most_recent/howcast_studios.xml?api_key=myapikey").and_return(videos_xml)
+    @hc.should_receive(:open).with(equivalent_uri("http://www.howcast.com/videos/most_recent/howcast_studios.xml?api_key=myapikey")).and_return(videos_xml)
     @hc.videos
   end
   
   it "should establish a connection with videos/most_recent/howcast_studios/2.xml when :page => 2" do
-    @hc.should_receive(:open).with("http://www.howcast.com/videos/most_recent/howcast_studios/2.xml?api_key=myapikey").and_return(videos_xml)
+    @hc.should_receive(:open).with(equivalent_uri("http://www.howcast.com/videos/most_recent/howcast_studios/2.xml?api_key=myapikey")).and_return(videos_xml)
     @hc.videos(:page => 2)
   end
   
   it "should establish a connection with videos/most_viewed/howcast_studios.xml when :sort => most_viewed" do
-    @hc.should_receive(:open).with("http://www.howcast.com/videos/most_viewed/howcast_studios.xml?api_key=myapikey").and_return(videos_xml)
+    @hc.should_receive(:open).with(equivalent_uri("http://www.howcast.com/videos/most_viewed/howcast_studios.xml?api_key=myapikey")).and_return(videos_xml)
     @hc.videos(:sort => "most_viewed")    
   end
   
   it "should establish a connection with videos/most_viewed/directors_program.xml when :sort => most_viewed and :filter => directors_program" do
-    @hc.should_receive(:open).with("http://www.howcast.com/videos/most_viewed/directors_program.xml?api_key=myapikey").and_return(videos_xml)
+    @hc.should_receive(:open).with(equivalent_uri("http://www.howcast.com/videos/most_viewed/directors_program.xml?api_key=myapikey")).and_return(videos_xml)
     @hc.videos(:sort => "most_viewed", :filter => "directors_program")    
   end
   
   it "should establish a connection with videos/top_rated/directors_program.xml when :sort => most_viewed and :filter => directors_program" do
-    @hc.should_receive(:open).with("http://www.howcast.com/videos/top_rated/directors_program.xml?api_key=myapikey").and_return(videos_xml)
+    @hc.should_receive(:open).with(equivalent_uri("http://www.howcast.com/videos/top_rated/directors_program.xml?api_key=myapikey")).and_return(videos_xml)
     @hc.videos(:sort => "top_rated", :filter => "directors_program")    
   end
   
@@ -118,4 +118,4 @@ describe Howcast::Client, "videos" do
     videos.first.permalink.should == "http://www.howcast.com/videos/1101-How-To-Pretend-Youre-a-Real-New-Yorker"
     videos.last.permalink.should == "http://www.howcast.com/videos/866-How-To-Make-a-Water-Gun-Alarm-Clock"
   end
-end
+end

data/spec/spec_helper.rb

@@ -8,6 +8,28 @@ end
 
 require File.expand_path(File.dirname(__FILE__) + "/../lib/howcast")
 
+
+def to_s_like like
+  simple_matcher("converts to a string like #{like.inspect}") do |candidate|
+    like === candidate.to_s
+  end
+end
+
+def equivalent_uri string
+  simple_matcher("is an equivalent uri to #{string.inspect}") do |candidate|
+    verifier = URI.parse string
+    tests = [
+      lambda{|x|x.scheme},
+      lambda{|x|x.userinfo},
+      lambda{|x|x.port},
+      lambda{|x|x.path},
+      lambda{|x|x.query.split('&').sort},
+      lambda{|x|x.fragment}
+    ]
+    tests.all?{|t|t.call(candidate) == t.call(verifier)}
+  end
+end
+
 Spec::Runner.configure do |config|
   def invalid_api_key_xml
     <<-INVALID
@@ -204,4 +226,4 @@ Spec::Runner.configure do |config|
     </howcast>
     VID
   end
-end
+end

data/tasks/github.rake

@@ -0,0 +1,3 @@
+task :build_for_github => [:manifest, :build_gemspec] do
+  p `ruby script/github-test.rb howcast.gemspec`
+end

metadata

@@ -1,92 +1,75 @@
 --- !ruby/object:Gem::Specification 
 name: howcast
 version: !ruby/object:Gem::Version 
-  version: 0.4.3
+  version: 0.4.10
 platform: ruby
 authors: 
-- Michael Murray
+- Jingshen Jimmy Zhang
+- Ian Smith-Heisters
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-03-02 00:00:00 -08:00
+date: 2010-01-04 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: why-hpricot
+  name: hpricot
   type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: "0.6"
+        version: "0"
     version: 
 - !ruby/object:Gem::Dependency 
-  name: hoe
+  name: rspec
   type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.8.2
+        version: "0"
     version: 
-description: Howcast API Ruby Wrapper
-email: 
-- michael+gem@howcast.com
+description: "    Howcast offers an Application Programming Interface (API) which allows\n    developers to build applications that interface with Howcast. The Howcast\n    API is RESTful (REpresentational State Transfer) and users of this API will\n    be able: 1) Retreive detailed information about a single video, including\n    metadata such as title, description, video views, rating etc; 2) Retrieve a\n    list of videos restricted by a set of filters offered by Howcast and sorted\n    using several metrics that you can specify (most recent, most views, etc);\n    3) Search for video; 4) And much more. Note: Before you can use our APIs,\n    you must register an API key, that is submitted with each request.\n"
+email: support@howcast.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- History.txt
-- License.txt
-- Manifest.txt
-- website/index.txt
+- README.markdown
 files: 
-- History.txt
+- CHANGELOG
 - License.txt
-- Manifest.txt
+- Manifest
 - README.markdown
 - Rakefile
-- config/hoe.rb
-- config/requirements.rb
+- VERSION
+- howcast.gemspec
 - lib/howcast.rb
 - lib/howcast/client.rb
-- lib/howcast/version.rb
-- lib/howcast/errors.rb
 - lib/howcast/client/base.rb
-- lib/howcast/client/video.rb
-- lib/howcast/client/guide.rb
-- lib/howcast/client/search.rb
 - lib/howcast/client/category.rb
-- script/destroy
-- script/generate
-- script/txt2html
-- setup.rb
-- spec/spec.opts
-- spec/spec_helper.rb
+- lib/howcast/client/search.rb
+- lib/howcast/client/video.rb
+- lib/howcast/errors.rb
 - spec/howcast/client/base_spec.rb
-- spec/howcast/client/guide_spec.rb
-- spec/howcast/client/video_spec.rb
-- spec/howcast/client/search_spec.rb
 - spec/howcast/client/category_spec.rb
-- tasks/deployment.rake
-- tasks/environment.rake
-- tasks/rspec.rake
-- tasks/website.rake
-- website/index.html
-- website/index.txt
-- website/javascripts/rounded_corners_lite.inc.js
-- website/stylesheets/screen.css
-- website/template.rhtml
+- spec/howcast/client/search_spec.rb
+- spec/howcast/client/video_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/github.rake
 has_rdoc: true
-homepage: http://howcast.rubyforge.org
+homepage: http://github.com/howcast/howcast-gem
+licenses: []
+
 post_install_message: 
 rdoc_options: 
-- --main
-- README.txt
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -103,10 +86,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: howcast
-rubygems_version: 1.3.1
+rubyforge_project: 
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Howcast API Ruby Wrapper
-test_files: []
-
+test_files: 
+- spec/howcast/client/base_spec.rb
+- spec/howcast/client/category_spec.rb
+- spec/howcast/client/search_spec.rb
+- spec/howcast/client/video_spec.rb
+- spec/spec_helper.rb

data/Manifest.txt

@@ -1,36 +0,0 @@
-History.txt
-License.txt
-Manifest.txt
-README.markdown
-Rakefile
-config/hoe.rb
-config/requirements.rb
-lib/howcast.rb
-lib/howcast/client.rb
-lib/howcast/version.rb
-lib/howcast/errors.rb
-lib/howcast/client/base.rb
-lib/howcast/client/video.rb
-lib/howcast/client/guide.rb
-lib/howcast/client/search.rb
-lib/howcast/client/category.rb
-script/destroy
-script/generate
-script/txt2html
-setup.rb
-spec/spec.opts
-spec/spec_helper.rb
-spec/howcast/client/base_spec.rb
-spec/howcast/client/guide_spec.rb
-spec/howcast/client/video_spec.rb
-spec/howcast/client/search_spec.rb
-spec/howcast/client/category_spec.rb
-tasks/deployment.rake
-tasks/environment.rake
-tasks/rspec.rake
-tasks/website.rake
-website/index.html
-website/index.txt
-website/javascripts/rounded_corners_lite.inc.js
-website/stylesheets/screen.css
-website/template.rhtml