howcast 0.3.1

data/spec/howcast/client/base_spec.rb

@@ -0,0 +1,14 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe Howcast::Client, "initialize" do
+  it "should create a client object with all the inputted attributes" do
+    client = Howcast::Client.new :key => "myapikey"
+    client.should be_instance_of(Howcast::Client)
+  end
+  
+  it "should raise a Howcast::ApiKeyNotFound error when no key is supplied" do
+    lambda {
+      Howcast::Client.new
+    }.should raise_error(Howcast::ApiKeyNotFound)
+  end
+end

data/spec/howcast/client/guide_spec.rb

@@ -0,0 +1,65 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe Howcast::Client::Guide, "initialize" do
+  it "should create a guide object with all the inputted attributes" do
+    guide = Howcast::Client::Guide.new :title => "guide_title"
+    guide.title.should == 'guide_title'
+  end
+  
+  it "should ignore inputs which are not guide attributes" do
+    guide = Howcast::Client::Guide.new :not_an_attribute => "value", :title => "guide_title"
+    guide.respond_to?(:not_an_attribute).should be_false
+    guide.title.should == "guide_title"
+  end
+end
+
+describe Howcast::Client, "guides" do
+  before do
+    @hc = Howcast::Client.new(:key => "myapikey")
+  end
+  
+  it "should establish a connection with guides/most_recent/howcast_written.xml by default" do
+    @hc.should_receive(:open).with("http://www.howcast.com/guides/most_recent/howcast_written.xml?api_key=myapikey").and_return(guides_xml)
+    @hc.guides
+  end
+  
+  it "should establish a connection with guides/most_recent/howcast_written.xml?page=2 when :page => 2" do
+    @hc.should_receive(:open).with("http://www.howcast.com/guides/most_recent/howcast_written.xml?page=2&api_key=myapikey").and_return(guides_xml)
+    @hc.guides(:page => 2)
+  end
+  
+  it "should establish a connection with guides/most_viewed/howcast_written.xml when :sort => most_viewed" do
+    @hc.should_receive(:open).with("http://www.howcast.com/guides/most_viewed/howcast_written.xml?api_key=myapikey").and_return(guides_xml)
+    @hc.guides(:sort => "most_viewed")    
+  end
+  
+  it "should establish a connection with guides/most_viewed/community_written.xml when :sort => most_viewed and :filter => community_written" do
+    @hc.should_receive(:open).with("http://www.howcast.com/guides/most_viewed/community_written.xml?api_key=myapikey").and_return(guides_xml)
+    @hc.guides(:sort => "most_viewed", :filter => "community_written")    
+  end
+  
+  it "should establish a connection with guides/top_rated/community_written.xml when :sort => top_rated and :filter => community_written" do
+    @hc.should_receive(:open).with("http://www.howcast.com/guides/top_rated/community_written.xml?api_key=myapikey").and_return(guides_xml)
+    @hc.guides(:sort => "top_rated", :filter => "community_written")    
+  end
+  
+  it "should raise a Howcast::ApiNotFound if url is invalid" do
+    lambda {
+      @hc.should_receive(:open).and_raise(URI::InvalidURIError)
+      @hc.guides
+    }.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_guides_xml)
+    @hc.guides.should be_empty
+  end
+  
+  it "should return an array of guide objects if there are some returned" do
+    @hc.should_receive(:open).and_return(guides_xml)
+    guides = @hc.guides
+    guides.size.should == 3
+    guides.first.permalink.should == "http://www.howcast.com/guides/1101-How-To-Pretend-Youre-a-Real-New-Yorker"
+    guides.last.permalink.should == "http://www.howcast.com/guides/866-How-To-Make-a-Water-Gun-Alarm-Clock"
+  end
+end

data/spec/howcast/client/search_spec.rb

@@ -0,0 +1,88 @@
+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
+  
+  it "should raise a Howcast::ApiNotFound if url is invalid" do
+    lambda {
+      @hc.should_receive(:open).and_raise(URI::InvalidURIError)
+      @hc.video_search("something")
+    }.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
+  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"
+  end
+end
+
+describe Howcast::Client, "guide_search" do
+  before do
+    @hc = Howcast::Client.new(:key => "myapikey")
+  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")
+  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)
+  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")
+  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)
+  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
+  
+  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"
+  end
+end

data/spec/howcast/client/video_spec.rb

@@ -0,0 +1,109 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe Howcast::Client::Video, "initialize" do
+  it "should create a video object with all the inputted attributes" do
+    video = Howcast::Client::Video.new :title => "video_title"
+    video.title.should == 'video_title'
+  end
+  
+  it "should ignore inputs which are not video attributes" do
+    video = Howcast::Client::Video.new :not_an_attribute => "value", :title => "video_title"
+    video.respond_to?(:not_an_attribute).should be_false
+    video.title.should == "video_title"
+  end
+end
+
+describe Howcast::Client, "video" do  
+  before do
+    @hc = Howcast::Client.new(:key => "myapikey")
+    @hc.stub!(:open).and_return(video_xml)
+  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.video(2)
+  end  
+  
+  it "should raise Howcast::ApiKeyNotFound error when the response contains Invalid API Key" do
+    lambda {
+      @hc.stub!(:open).and_return(invalid_api_key_xml)
+      @hc.video(2)
+    }.should raise_error(Howcast::ApiKeyNotFound)
+  end
+
+  it "should return nil whenever the result xml is empty" do
+    @hc.stub!(:open).and_return(blank_video_xml)
+    @hc.video(2).should be_nil
+  end
+
+  it "should set the title attribute in the video model response" do
+    @hc.video(2).title.should == "How To Do a Noble Pose"
+  end
+  
+  it "should set the views attribute in the video model response" do
+    @hc.video(2).views.should == "38"
+  end
+  
+  it "should set the rating attribute in the video model response" do
+    @hc.video(2).rating.should == "2.0"
+  end
+  
+  it "should set the description attribute in the video model response" do
+    @hc.video(2).description.should == "You recognize the Noble Pose as the dreaded \"sit-and-reach\" from your childhood gym class. A sample <a href=\"howcast.com\">link</a>"
+  end
+  
+  it "should set the permalink attribute in the video model response" do
+    @hc.video(2).permalink.should == "http://www.howcast.com/videos/233-How-To-Do-a-Noble-Pose"
+  end
+end
+
+describe Howcast::Client, "videos" do
+  before do
+    @hc = Howcast::Client.new(:key => "myapikey")
+  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.videos
+  end
+  
+  it "should establish a connection with videos/most_recent/howcast_studios.xml?page=2 when :page => 2" do
+    @hc.should_receive(:open).with("http://www.howcast.com/videos/most_recent/howcast_studios.xml?page=2&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.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.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.videos(:sort => "top_rated", :filter => "directors_program")    
+  end
+  
+  it "should raise a Howcast::ApiNotFound if url is invalid" do
+    lambda {
+      @hc.should_receive(:open).and_raise(URI::InvalidURIError)
+      @hc.videos
+    }.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.videos.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.videos
+    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

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,167 @@
+ENV["RAILS_ENV"] ||= "test"
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+
+require File.expand_path(File.dirname(__FILE__) + "/../lib/howcast")
+
+Spec::Runner.configure do |config|
+  def invalid_api_key_xml
+    <<-INVALID
+    <?xml version="1.0" encoding="UTF-8"?>
+    <howcast version="0.1">
+      <error>Invalid API Key</error>
+    </howcast>
+    INVALID
+  end
+  
+  def blank_video_xml
+    <<-VID
+    <?xml version="1.0" encoding="UTF-8"?>
+    <howcast version="0.1">
+      <video>
+      </video>
+    </howcast>
+    VID
+  end
+    
+  def blank_guides_xml
+    <<-GUID
+    <?xml version="1.0" encoding="UTF-8"?>
+    <howcast version="0.1">
+      <guides>
+      </guides>
+    </howcast>
+    GUID
+  end
+  
+  def blank_videos_xml
+    <<-VID
+    <?xml version="1.0" encoding="UTF-8"?>
+    <howcast version="0.1">
+      <videos>
+      </videos>
+    </howcast>
+    VID
+  end
+  
+  def video_xml
+    <<-VID
+    <?xml version="1.0" encoding="UTF-8"?>
+    <howcast version="0.1">
+      <video>
+        <category-id>2</category-id>
+        <duration>22</duration>
+        <id>233</id>
+        <title>How To Do a Noble Pose</title>
+        <description>
+          <![CDATA[You recognize the Noble Pose as the dreaded "sit-and-reach" from your childhood gym class. A sample <a href="howcast.com">link</a>]]>
+        </description>
+        <permalink>http://www.howcast.com/videos/233-How-To-Do-a-Noble-Pose</permalink>
+        <username>joekulak</username>
+        <thumbnail-url>http://www.howcast.com/system/thumbnails/233/Mind.How_to_Do_the_Noble_Pose_SD_xxlarge.jpg</thumbnail-url>
+        <views>38</views>
+        <rating>2.0</rating>
+        <created-at>#{Time.now.rfc822}</created-at>
+      </video>
+    </howcast>
+    VID
+  end
+  
+  def guides_xml
+    <<-VID
+    <?xml version="1.0" encoding="UTF-8"?>
+    <howcast version="0.1">
+      <title>Howcast - Top Favorites Howcast Written Guides </title>
+      <guides>
+        <guide>
+          <rating>94</rating>
+          <title>How To Pretend You&#8217;re a Real New Yorker</title>
+          <permalink>http://www.howcast.com/guides/1101-How-To-Pretend-Youre-a-Real-New-Yorker</permalink>
+          <id>1101</id>
+          <category-id>1642</category-id>
+          <description>There&#8217;s nothing wrong with being a tourist in New York City. But if you want to blend in, here&#8217;s what you need to know.</description>
+          <views>2739</views>
+          <username>vinzfeller</username>
+          <created-at>2008-02-05T19:41:21-08:00</created-at>
+        </guide>
+        <guide>
+          <rating>96</rating>
+          <title>How To Look Great in Photographs</title>
+          <permalink>http://www.howcast.com/guides/577-How-To-Look-Great-in-Photographs</permalink>
+          <id>577</id>
+          <category-id>22</category-id>
+          <description>Sure, a beautiful photograph takes some skill behind the lens, but it takes a little skill in front of it, too.</description>
+          <views>3831</views>
+          <username>nicholas</username>
+          <created-at>2008-01-12T09:33:06-08:00</created-at>
+        </guide>
+        <guide>
+          <rating>98</rating>
+          <title>How To Make a Water Gun Alarm Clock</title>
+          <permalink>http://www.howcast.com/guides/866-How-To-Make-a-Water-Gun-Alarm-Clock</permalink>
+          <id>866</id>
+          <category-id>1728</category-id>
+          <description>Having a little trouble waking up in the morning? There&#8217;s nothing like a good soaking to get you going.</description>
+          <views>2663</views>
+          <username>Howcast</username>
+          <created-at>2008-01-31T20:47:08-08:00</created-at>
+        </guide>
+      </guides>
+    </howcast>
+    VID
+  end
+  
+  def videos_xml
+    <<-VID
+    <?xml version="1.0" encoding="UTF-8"?>
+    <howcast version="0.1">
+      <title>Howcast - Top Favorites Howcast Studios Videos </title>
+      <videos>
+        <video>
+          <rating>94</rating>
+          <title>How To Pretend You&#8217;re a Real New Yorker</title>
+          <permalink>http://www.howcast.com/videos/1101-How-To-Pretend-Youre-a-Real-New-Yorker</permalink>
+          <id>1101</id>
+          <category-id>1642</category-id>
+          <description>There&#8217;s nothing wrong with being a tourist in New York City. But if you want to blend in, here&#8217;s what you need to know.</description>
+          <thumbnail-url>http://www.howcast.com/system/thumbnails/1101/ppn_feller_real_newyorker_sd_medium.jpg</thumbnail-url>
+          <views>2739</views>
+          <username>vinzfeller</username>
+          <duration>203</duration>
+          <created-at>2008-02-05T19:41:21-08:00</created-at>
+        </video>
+        <video>
+          <rating>96</rating>
+          <title>How To Look Great in Photographs</title>
+          <permalink>http://www.howcast.com/videos/577-How-To-Look-Great-in-Photographs</permalink>
+          <id>577</id>
+          <category-id>22</category-id>
+          <description>Sure, a beautiful photograph takes some skill behind the lens, but it takes a little skill in front of it, too.</description>
+          <thumbnail-url>http://www.howcast.com/system/thumbnails/577/Arts.How_to_Look_Great_in_Photographs_SD_medium.jpg</thumbnail-url>
+          <views>3831</views>
+          <username>nicholas</username>
+          <duration>156</duration>
+          <created-at>2008-01-12T09:33:06-08:00</created-at>
+        </video>
+        <video>
+          <rating>98</rating>
+          <title>How To Make a Water Gun Alarm Clock</title>
+          <permalink>http://www.howcast.com/videos/866-How-To-Make-a-Water-Gun-Alarm-Clock</permalink>
+          <id>866</id>
+          <category-id>1728</category-id>
+          <description>Having a little trouble waking up in the morning? There&#8217;s nothing like a good soaking to get you going.</description>
+          <thumbnail-url>http://www.howcast.com/system/thumbnails/866/watergunthumb2_medium.jpg</thumbnail-url>
+          <views>2663</views>
+          <username>Howcast</username>
+          <duration>108</duration>
+          <created-at>2008-01-31T20:47:08-08:00</created-at>
+        </video>
+      </videos>
+    </howcast>
+    VID
+  end
+end