howcast 0.4.12 → 0.4.13

data/CHANGELOG

@@ -1,3 +1,7 @@
+== 0.4.13 2010-03-08
+
+* add support for category hierarchy, ingredients, markers, and related videos for video object
+
 == 0.4.9 2009-08-19
 
 * require hpricot, update readme

data/VERSION

@@ -1 +1 @@
-0.4.12
+0.4.13

data/howcast.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{howcast}
-  s.version = "0.4.12"
+  s.version = "0.4.13"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jingshen Jimmy Zhang", "Ian Smith-Heisters"]
-  s.date = %q{2010-03-02}
+  s.date = %q{2010-03-08}
   s.description = %q{    Howcast offers an Application Programming Interface (API) which allows
     developers to build applications that interface with Howcast. The Howcast
     API is RESTful (REpresentational State Transfer) and users of this API will
@@ -36,6 +36,7 @@ Gem::Specification.new do |s|
      "lib/howcast/client.rb",
      "lib/howcast/client/base.rb",
      "lib/howcast/client/category.rb",
+     "lib/howcast/client/marker.rb",
      "lib/howcast/client/search.rb",
      "lib/howcast/client/video.rb",
      "lib/howcast/errors.rb",
@@ -54,17 +55,17 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/howcast/howcast-gem}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.4}
   s.summary = %q{Howcast API Ruby Wrapper}
   s.test_files = [
-    "spec/output_capture_helper.rb",
-     "spec/xml_fixtures_helper.rb",
-     "spec/string_matchers_helper.rb",
-     "spec/spec_helper.rb",
-     "spec/howcast/client/base_spec.rb",
-     "spec/howcast/client/video_spec.rb",
+    "spec/howcast/client/base_spec.rb",
      "spec/howcast/client/category_spec.rb",
-     "spec/howcast/client/search_spec.rb"
+     "spec/howcast/client/search_spec.rb",
+     "spec/howcast/client/video_spec.rb",
+     "spec/output_capture_helper.rb",
+     "spec/spec_helper.rb",
+     "spec/string_matchers_helper.rb",
+     "spec/xml_fixtures_helper.rb"
   ]
 
   if s.respond_to? :specification_version then

data/lib/howcast/client.rb

@@ -2,6 +2,6 @@
 class Howcast::Client
 end
 
-%w(client/base client/video client/search client/category).each do |dependency|
+%w(client/base client/video client/search client/category client/marker).each do |dependency|
   require(File.expand_path(File.join(File.dirname(__FILE__), dependency)))
 end

data/lib/howcast/client/base.rb

@@ -88,8 +88,10 @@ class Howcast::Client
       Howcast.log.info "Established connection with: '#{url}'"
       raise Howcast::ApiKeyNotFound if h.at(:error) && h.at(:error).inner_html.match(/Invalid API Key/)
       return h
-    rescue URI::InvalidURIError, OpenURI::HTTPError
-      raise Howcast::ApiNotFound.new("Invalid URL requested. Refer to the Howcast API for supported URL's")
+    rescue URI::InvalidURIError
+      raise Howcast::ApiNotFound.new("Invalid URL #{url.inspect} requested. Refer to the Howcast API for supported URL's")
+    rescue OpenURI::HTTPError => boom
+      raise Howcast::ApiError.new("HTTP error #{boom.message} accessing the API. Refer to the Howcast API for supported URL's")
     end
     
     # Parses the xml for a single item from +xml+ and creates a new +klass+ object
@@ -121,7 +123,17 @@ class Howcast::Client
       hash = {}
       klass.attr_accessors.each do |attribute|
         node_name = attribute.to_s.gsub("_", "-") # xml schema uses hyphens for spaces, but ruby uses underscores
-        hash[attribute] = !xml.at(node_name).nil? ? xml.at(node_name).inner_text.strip : ""
+        if node_name == "category-hierarchy"
+          hash[attribute] = category_hierarchy_for(xml) unless xml.at(node_name).nil?
+        elsif node_name == "ingredients"
+          hash[attribute] = ingredients_for(xml) unless xml.at(node_name).nil?
+        elsif node_name == "markers"
+          hash[attribute] = markers_for(xml) unless xml.at(node_name).nil?
+        elsif node_name == "related-videos"
+          hash[attribute] = related_videos_for(xml) unless xml.at(node_name).nil?
+        else
+          hash[attribute] = !xml.at(node_name).nil? ? xml.at(node_name).inner_text.strip : ""
+        end
       end
       hash.values.all?{|v| v==""} ? nil : klass.new(hash)
     end
@@ -198,5 +210,42 @@ class Howcast::Client
       params.chop! # trailing &
       params
     end
+    
+  private
+    def category_hierarchy_for(xml)
+      categories = []
+      node = xml.at('category-hierarchy')
+      node.children_of_type('category').each do |child|
+        category = Category.new(:id => child['id'], :parent_id => child['parent_id'], :name => child.inner_text)
+        categories << category
+      end unless node.nil?
+      categories
+    end
+    
+    def ingredients_for(xml)
+      ingredients = []
+      node = xml.at('ingredients')
+      node.children_of_type('ingredient').each do |child|
+        ingredients << child.inner_text.strip
+      end unless node.nil?
+      ingredients
+    end
+    
+    def markers_for(xml)
+      markers = []
+      node = xml.at('markers')
+      node.children_of_type('marker').each do |child|
+        markers << parse_single_xml(child, Marker)
+      end unless node.nil?
+      markers
+    end
+    
+    def related_videos_for(xml)
+      related = []
+      node = xml.at('related-videos')
+      node.children_of_type('video').each do |child|
+        related << parse_single_xml(child, Video)
+      end unless node.nil?
+      related
+    end
 end
-

data/lib/howcast/client/marker.rb

@@ -0,0 +1,46 @@
+#--
+# Copyright (c) 2010 Howcast Media Inc.
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# 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.
+#++
+
+class Howcast::Client
+  class Marker
+    extend WatchAttrAccessors
+    attr_accessor :id, :position, :timemarker, :type, :thumbnail_url, :title, :textile_text, :text
+    
+    # Creates a new Marker object which is used to encapsulate all the attributes available
+    # from the Howcast Video API.
+    #
+    # === Inputs
+    #
+    # * <tt>attributes</tt> -- A hash to set the various attributes of the marker object
+    #
+    # === Examples
+    # 
+    # Initialize a marker with title "Do something"
+    #   Marker.new :title => "Do something"
+    def initialize(attributes={})
+      attributes.each do |k, v|
+        self.send("#{k}=", v) if self.respond_to?(k)
+      end
+    end
+  end
+end

data/lib/howcast/client/video.rb

@@ -38,7 +38,8 @@ class Howcast::Client
     extend WatchAttrAccessors
     attr_accessor :id, :title, :permalink, :thumbnail_url, :category_id, 
       :views, :username, :duration, :created_at, :rating, :description, :width, :height,
-      :badges, :easy_steps, :embed
+      :badges, :easy_steps, :embed, :category_hierarchy, :ingredients, :markers, :related_videos
+
     # Creates a new Video object which is used to encapsulate all the attributes available
     # from the Howcast Video API
     #

data/lib/howcast/errors.rb

@@ -1,8 +1,3 @@
-
-class Howcast::ApiNotFound < Exception
-  
-end
-
-class Howcast::ApiKeyNotFound < Exception
-  
-end
+class Howcast::ApiNotFound < StandardError; end
+class Howcast::ApiKeyNotFound < StandardError; end
+class Howcast::ApiError < StandardError; end

data/spec/howcast/client/video_spec.rb

@@ -67,6 +67,47 @@ describe Howcast::Client, "video" do
   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
+  
+  it "should set the category hierarchy in the video model response" do
+    hierarchy = @hc.video(2).category_hierarchy
+    hierarchy.size.should == 3
+    hierarchy.first.instance_of?(Howcast::Client::Category).should be_true
+    hierarchy[0].name.should == "Health & Nutrition"
+    hierarchy[1].name.should == "Exercise"
+    hierarchy[2].name.should == "Yoga"
+  end
+  
+  it "should set the ingredients in the video model response" do
+    ingredients = @hc.video(2).ingredients
+    ingredients.size.should == 4
+    ingredients[0].should == "Comfortable clothing suitable for stretching and moving"
+    ingredients[1].should == "A calm place where you won't be distracted or disturbed"
+    ingredients[2].should == "A yoga mat or folded blanket"
+    ingredients[3].should == "A belt or strap"
+  end
+  
+  it "should set the markers in the video model response" do
+    markers = @hc.video(2).markers
+    markers.size.should == 4
+    markers.first.instance_of?(Howcast::Client::Marker).should be_true
+    markers[0].type.should == "Step"
+    markers[0].textile_text.should == "Sit down on the mat with your legs straight out in front of you."
+    markers[1].type.should == "Tip"
+    markers[1].textile_text.should == "It's okay to slightly bend at the knees while extending into this pose."
+    markers[2].type.should == "Step"
+    markers[2].textile_text.should == "To release the pose, inhale, and raise your torso straight up with your arms stretched overhead, then exhale and lower your hands to the floor. Now to conquer kickball..."
+    markers[3].type.should == "Fact"
+    markers[3].textile_text.should == "Pop nobility Sting recently admitted that he and his wife's claims of yoga-inspired marathons of tantric sex was all a joke, saying, \"I have frantic sex, not tantric sex.\""
+  end
+  
+  it "should set the related videos in the video model response" do
+    related = @hc.video(2).related_videos
+    related.size.should == 2
+    related.first.instance_of?(Howcast::Client::Video).should be_true
+    related[0].title.should == "How To Do the Extended Triangle Pose"
+    related[0].category_hierarchy.last.name.should == "Yoga"
+    related[1].title.should == "How To Do a Seated Spinal Twist Pose"
+  end
 end
 
 describe Howcast::Client, "videos" do

data/spec/output_capture_helper.rb

@@ -7,7 +7,7 @@ module OutputCaptureHelper
   end
 
   def captured_output
-    return *[@stdout, @stderr].map(&:string)
+    return *[@stdout, @stderr].map{|x|x.string}
   end
 
   def stop_capturing_output

data/spec/xml_fixtures_helper.rb

@@ -81,6 +81,11 @@ module XmlFixturesHelper
         <category-id>2</category-id>
         <duration>22</duration>
         <id>233</id>
+        <category-hierarchy>
+          <category id="479">Health &amp; Nutrition</category>
+          <category parent_id="479" id="510">Exercise</category>
+          <category parent_id="510" id="515">Yoga</category>
+        </category-hierarchy>
         <easy-steps>true</easy-steps>
         <badges>Howcast Studios</badges>
         <title>How To Do a Noble Pose</title>
@@ -96,55 +101,141 @@ module XmlFixturesHelper
         <views>38</views>
         <rating>2.0</rating>
         <created-at>#{Time.now.rfc822}</created-at>
+        <ingredients>
+          <ingredient>
+            <![CDATA[Comfortable clothing suitable for stretching and moving]]>
+          </ingredient>
+          <ingredient>
+            <![CDATA[A calm place where you won't be distracted or disturbed]]>
+          </ingredient>
+          <ingredient>
+            <![CDATA[A yoga mat or folded blanket]]>
+          </ingredient>
+          <ingredient>
+            <![CDATA[A belt or strap]]>
+          </ingredient>
+        </ingredients>
+        <markers>
+          <marker>
+            <id>3716</id>
+            <position>1</position>
+            <timemarker>32</timemarker>
+            <type>Step</type>
+            <thumbnail-url>http://img.howcast.com/system/thumbnails/233/32.jpg</thumbnail-url>
+            <title>Sit down on mat</title>
+            <textile-text>
+              <![CDATA[Sit down on the mat with your legs straight out in front of you.]]>
+            </textile-text>
+            <text>
+              <![CDATA[<p>Sit down on the mat with your legs straight out in front of you.</p>]]>
+            </text>
+          </marker>
+          <marker>
+            <id>3719</id>
+            <position>4</position>
+            <timemarker>48</timemarker>
+            <type>Tip</type>
+            <thumbnail-url></thumbnail-url>
+            <title></title>
+            <textile-text>
+              <![CDATA[It's okay to slightly bend at the knees while extending into this pose.]]>
+            </textile-text>
+            <text>
+              <![CDATA[<p>It&#8217;s okay to slightly bend at the knees while extending into this pose.</p>]]>
+            </text>
+          </marker>
+          <marker>
+            <id>3723</id>
+            <position>8</position>
+            <timemarker>70</timemarker>
+            <type>Step</type>
+            <thumbnail-url>http://img.howcast.com/system/thumbnails/233/70.jpg</thumbnail-url>
+            <title>Release pose</title>
+            <textile-text>
+              <![CDATA[To release the pose, inhale, and raise your torso straight up with your arms stretched overhead, then exhale and lower your hands to the floor. Now to conquer kickball...]]>
+            </textile-text>
+            <text>
+              <![CDATA[<p>To release the pose, inhale, and raise your torso straight up with your arms stretched overhead, then exhale and lower your hands to the floor. Now to conquer kickball&#8230;</p>]]>
+            </text>
+          </marker>
+          <marker>
+            <id>3724</id>
+            <position>9</position>
+            <timemarker>81</timemarker>
+            <type>Fact</type>
+            <thumbnail-url></thumbnail-url>
+            <title></title>
+            <textile-text>
+              <![CDATA[Pop nobility Sting recently admitted that he and his wife's claims of yoga-inspired marathons of tantric sex was all a joke, saying, "I have frantic sex, not tantric sex."]]>
+            </textile-text>
+            <text>
+              <![CDATA[<p>Pop nobility Sting recently admitted that he and his wife&#8217;s claims of yoga-inspired marathons of tantric sex was all a joke, saying, &#8220;I have frantic sex, not tantric sex.&#8221;</p>]]>
+            </text>
+          </marker>
+        </markers>
+        <related-videos>
+          <video>
+            <category-id>515</category-id>
+            <id>224</id>
+            <title>How To Do the Extended Triangle Pose</title>
+            <views>2470</views>
+            <type>HowcastGuide</type>
+            <created-at>Wed, 05 Dec 2007 20:07:04 -0800</created-at>
+            <rating>6</rating>
+            <username>joekulak</username>
+            <description>
+              <![CDATA[What do paintings on a wall, car tires, and promising horoscopes have in common? They all require proper alignment. It's not the easiest skill to acquire, but the Extended Triangle Pose will help hone it.]]>
+            </description>
+            <embed>
+              <![CDATA[<object width="425" height="352" classid="clsid:D27CDB6E-AE6D-11cf-96B8-444553540000" id="howcastplayer"><param name="movie" value="http://www.howcast.com/flash/howcast_player.swf?file=224"></param><param name="allowFullScreen" value="true"></param><param name="allowScriptAccess" value="always"></param><embed src="http://www.howcast.com/flash/howcast_player.swf?file=224" type="application/x-shockwave-flash" width="425" height="352" allowFullScreen="true" allowScriptAccess="always" ></embed></object>]]>
+            </embed>
+            <duration>146</duration>
+            <filename>http://media.howcast.com/system/videos/0/24/02/224.flv</filename>
+            <tags>DIY, Instructional, tutorial, Do It Yourself, Tips, Essential Skills, Learn to, yoga, pose, position, body, exercise, stretch, meditation, extended, triangle, utthita, trikonasana, warrior</tags>
+            <category-hierarchy>
+              <category id="479">Health &amp; Nutrition</category>
+              <category parent_id="479" id="510">Exercise</category>
+              <category parent_id="510" id="515">Yoga</category>
+            </category-hierarchy>
+            <comment-count>0</comment-count>
+            <thumbnail-url>http://img.howcast.com/system/thumbnails/224/Mind.How_to_Do_the_Extended_Triangle_Pose_SD_xxlarge_maintained_aspect.jpg</thumbnail-url>
+            <permalink>http://www.howcast.com/videos/224-How-To-Do-the-Extended-Triangle-Pose</permalink>
+            <content_rating>nonadult</content_rating>
+          </video>
+          <video>
+            <category-id>515</category-id>
+            <id>225</id>
+            <title>How To Do a Seated Spinal Twist Pose</title>
+            <views>3461</views>
+            <type>HowcastGuide</type>
+            <created-at>Wed, 05 Dec 2007 20:07:08 -0800</created-at>
+            <rating>8</rating>
+            <username>joekulak</username>
+            <description>
+              <![CDATA[According to Hindu mythology, this pose was originated by a yogi who spent 12 years in the belly of a fish, eavesdropping on Shiva's secret yoga instructions in an ocean cave.  All you have to do is sit on a mat.]]>
+            </description>
+            <embed>
+              <![CDATA[<object width="425" height="352" classid="clsid:D27CDB6E-AE6D-11cf-96B8-444553540000" id="howcastplayer"><param name="movie" value="http://www.howcast.com/flash/howcast_player.swf?file=225"></param><param name="allowFullScreen" value="true"></param><param name="allowScriptAccess" value="always"></param><embed src="http://www.howcast.com/flash/howcast_player.swf?file=225" type="application/x-shockwave-flash" width="425" height="352" allowFullScreen="true" allowScriptAccess="always" ></embed></object>]]>
+            </embed>
+            <duration>143</duration>
+            <filename>http://media.howcast.com/system/videos/1/25/02/225.flv</filename>
+            <tags>DIY, Instructional, tutorial, Do It Yourself, Tips, Essential Skills, Learn to, yoga, pose, position, body, exercise, stretch, meditation, seated, spinal, twist, Ardha, Matsyendrasana</tags>
+            <category-hierarchy>
+              <category id="479">Health &amp; Nutrition</category>
+              <category parent_id="479" id="510">Exercise</category>
+              <category parent_id="510" id="515">Yoga</category>
+            </category-hierarchy>
+            <comment-count>0</comment-count>
+            <thumbnail-url>http://img.howcast.com/system/thumbnails/225/Mind.How_to_Do_a_Seated_Spinal_Twist_Pose_SD_xxlarge_maintained_aspect.jpg</thumbnail-url>
+            <permalink>http://www.howcast.com/videos/225-How-To-Do-a-Seated-Spinal-Twist-Pose</permalink>
+            <content_rating>nonadult</content_rating>
+          </video>
+        </related-videos>
       </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"?>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: howcast
 version: !ruby/object:Gem::Version 
-  version: 0.4.12
+  version: 0.4.13
 platform: ruby
 authors: 
 - Jingshen Jimmy Zhang
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-02 00:00:00 -08:00
+date: 2010-03-08 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -53,6 +53,7 @@ files:
 - lib/howcast/client.rb
 - lib/howcast/client/base.rb
 - lib/howcast/client/category.rb
+- lib/howcast/client/marker.rb
 - lib/howcast/client/search.rb
 - lib/howcast/client/video.rb
 - lib/howcast/errors.rb
@@ -91,16 +92,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.4
 signing_key: 
 specification_version: 3
 summary: Howcast API Ruby Wrapper
 test_files: 
-- spec/output_capture_helper.rb
-- spec/xml_fixtures_helper.rb
-- spec/string_matchers_helper.rb
-- spec/spec_helper.rb
 - spec/howcast/client/base_spec.rb
-- spec/howcast/client/video_spec.rb
 - spec/howcast/client/category_spec.rb
 - spec/howcast/client/search_spec.rb
+- spec/howcast/client/video_spec.rb
+- spec/output_capture_helper.rb
+- spec/spec_helper.rb
+- spec/string_matchers_helper.rb
+- spec/xml_fixtures_helper.rb