howcast 0.3.2 → 0.4.1

data/History.txt

@@ -1,3 +1,20 @@
+== 0.4.1 2008-11-05
+
+* Support for finding a category ancestor trail from a category object
+
+== 0.4 2008-11-02
+
+* Add support for the new category API to get the name and parent ID
+* Added badges and easy_steps methods for video
+
+== 0.3.4 2008-08-21
+
+* Support for new paging scheme in browse pages - ?page=1 => /1
+
+== 0.3.3 2008-07-25
+
+* Video dimensions
+
 == 0.3.2 2008-06-03
 
 * Clean up with inject

data/Manifest.txt

@@ -13,6 +13,7 @@ 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
@@ -23,6 +24,7 @@ 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

data/lib/howcast/client.rb

@@ -6,3 +6,4 @@ require_local('howcast/client/base.rb')
 require_local('howcast/client/video.rb')
 require_local('howcast/client/guide.rb')
 require_local('howcast/client/search.rb')
+require_local('howcast/client/category.rb')

data/lib/howcast/client/base.rb

@@ -79,7 +79,7 @@ class Howcast::Client
     # === Inputs
     #
     # * <tt>xml</tt> -- See below for a sample xml input
-    # * <tt>klass</tt> -- Class to create - Guide | Video supported
+    # * <tt>klass</tt> -- Class to create - Guide | Video | Category supported
     #
     # Sample input xml
     #   <guide>

data/lib/howcast/client/category.rb

@@ -0,0 +1,85 @@
+#--
+# Copyright (c) 2008 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 Category
+    extend WatchAttrAccessors
+    attr_accessor :id, :name, :parent_id, :parents
+    
+    # Creates a new Category object which is used to encapsulate all the attributes available
+    # from the Howcast Category API. The parents attribute will be an array of category 
+    # ancestors of the form:
+    #   [{:id => 1, :name => 'root'}, {:id => 2, :name => 'immediate parent'}]
+    #
+    # === Inputs
+    #
+    # * <tt>attributes</tt> -- A hash to set the various attributes of the category object
+    #
+    # === Examples
+    # 
+    # Initialize a category with name "Arts & Crafts"
+    #   Category.new :name => "Arts & Crafts"
+    def initialize(attributes={})
+      attributes.each do |k, v|
+        self.send("#{k}=", v) if self.respond_to?(k)
+      end
+    end
+  end
+    
+  # Provides access to the Howcast category API.
+  # 
+  # === Inputs
+  #
+  # * <tt>id</tt> -- The id of the category to lookup
+  #
+  # === Outputs
+  # 
+  # Category object if the id exists or nil if the id doesn't exist or is malformed
+  #
+  # === Exceptions
+  # 
+  # * <tt>Howcast::ApiNotFound</tt>
+  #
+  # === Examples
+  # 
+  # Get the Howcast category with id 2
+  #   Howcast::Client.new.category(2)
+  def category(id)
+    response = establish_connection("categories/#{id}.xml")
+    parse_single_category_xml(response.at(:category))
+  end
+  
+  private
+    # Exception here to parse the <parents> tag in a category, will set a category.parents variable
+    # which is an array of parent metadata hases
+    # [{:id => '123', :name => "root"}, {:id => "1234", :name => "parent"}]
+    def parse_single_category_xml(xml)
+      hash = {}
+      Category.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 : ""
+      end
+      hash[:parents] = (xml.at('parents')/:category).map{ |c| {:id => c['id'], :name => c.inner_html }}
+      hash.values.all?{|v| v==""} ? nil : Category.new(hash)
+    end
+end

data/lib/howcast/client/guide.rb

@@ -44,7 +44,6 @@ class Howcast::Client
     end
   end
     
-  # REFACTOR: Consider combining with videos method
   # Provides access to the Howcast list guides API.
   # 
   # === Inputs
@@ -75,11 +74,6 @@ class Howcast::Client
   	def guides_url(options={})
       defaults = {:page => nil, :sort => "most_recent", :filter => "howcast_written", :category_id => nil}
       options = defaults.update(options)
-      if options[:category_id].nil?
-        uri = "guides/#{options[:sort]}/#{options[:filter]}.xml"
-      else
-        uri = "guides/#{options[:sort]}/#{options[:filter]}/#{options[:category_id]}.xml"
-      end
-      uri + uri_suffix(options)
+      "guides/#{options[:sort]}/#{options[:filter]}#{"/#{options[:category_id]}" if options[:category_id]}#{"/#{options[:page]}" if options[:page]}.xml"
     end
 end

data/lib/howcast/client/video.rb

@@ -37,7 +37,8 @@ class Howcast::Client
   class Video
     extend WatchAttrAccessors
     attr_accessor :id, :title, :permalink, :thumbnail_url, :category_id, 
-      :views, :username, :duration, :created_at, :rating, :description
+      :views, :username, :duration, :created_at, :rating, :description, :width, :height,
+      :badges, :easy_steps
     # Creates a new Video object which is used to encapsulate all the attributes available
     # from the Howcast Video API
     #
@@ -54,6 +55,11 @@ class Howcast::Client
         self.send("#{k}=", v) if self.respond_to?(k)
       end
     end
+    
+    # Return true if the video contains easy step by step directions, else false
+    def easy_steps?
+      easy_steps == "true"
+    end
   end
     
   # Provides access to the Howcast video API.
@@ -109,11 +115,6 @@ class Howcast::Client
   	def videos_url(options={})
       defaults = {:page => nil, :sort => "most_recent", :filter => "howcast_studios", :category_id => nil}
       options = defaults.update(options)
-      if options[:category_id].nil?
-        uri = "videos/#{options[:sort]}/#{options[:filter]}.xml"
-      else
-        uri = "videos/#{options[:sort]}/#{options[:filter]}/#{options[:category_id]}.xml"
-      end
-      uri + uri_suffix(options)
+      "videos/#{options[:sort]}/#{options[:filter]}#{"/#{options[:category_id]}" if options[:category_id]}#{"/#{options[:page]}" if options[:page]}.xml"
     end
 end

data/lib/howcast/version.rb

@@ -1,8 +1,8 @@
 module Howcast #:nodoc:
   module Version #:nodoc:
     MAJOR = 0
-    MINOR = 3
-    TINY  = 2
+    MINOR = 4
+    TINY  = 1
 
     STRING = [MAJOR, MINOR, TINY].join('.')
     class << self

data/spec/howcast/client/category_spec.rb

@@ -0,0 +1,45 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe Howcast::Client::Category, "initialize" do
+  it "should create a category object with all the inputted attributes" do
+    category = Howcast::Client::Category.new :name => "category_title"
+    category.name.should == 'category_title'
+  end
+  
+  it "should ignore inputs which are not category attributes" do
+    category = Howcast::Client::Category.new :not_an_attribute => "value", :name => "category_title"
+    category.respond_to?(:not_an_attribute).should be_false
+    category.name.should == "category_title"
+  end
+end
+
+describe Howcast::Client, "category" do  
+  before do
+    @hc = Howcast::Client.new(:key => "myapikey")
+    @hc.stub!(:open).and_return(category_xml)
+  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.category(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.category(2)
+    }.should raise_error(Howcast::ApiKeyNotFound)
+  end
+
+  it "should set the title attribute in the category model response" do
+    @hc.category(2).name.should == "General African Travel"
+  end
+  
+  it "should set the parent_id attribute in the category model response" do
+    @hc.category(2).parent_id.should == "1584"
+  end  
+  
+  it "should set the parents metadata hash" do
+    @hc.category(2).parents.should == [{:id => "1571", :name => "Travel"}, {:id => "1584", :name => "African Travel"}]
+  end
+end

data/spec/howcast/client/guide_spec.rb

@@ -23,8 +23,8 @@ describe Howcast::Client, "guides" do
     @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)
+  it "should establish a connection with guides/most_recent/howcast_written/2.xml when :page => 2" do
+    @hc.should_receive(:open).with("http://www.howcast.com/guides/most_recent/howcast_written/2.xml?api_key=myapikey").and_return(guides_xml)
     @hc.guides(:page => 2)
   end
   

data/spec/howcast/client/video_spec.rb

@@ -44,6 +44,14 @@ describe Howcast::Client, "video" do
     @hc.video(2).views.should == "38"
   end
   
+  it "should set the badges in the video model response" do
+    @hc.video(2).badges.should == "Howcast Studios"
+  end
+  
+  it "should set the easy_steps boolean in the video model response" do
+    @hc.video(2).easy_steps?.should be_true
+  end
+  
   it "should set the rating attribute in the video model response" do
     @hc.video(2).rating.should == "2.0"
   end
@@ -67,8 +75,8 @@ describe Howcast::Client, "videos" do
     @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)
+  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.videos(:page => 2)
   end
   

data/spec/spec_helper.rb

@@ -48,6 +48,41 @@ Spec::Runner.configure do |config|
     VID
   end
   
+  def category_xml
+    <<-CAT
+    <?xml version="1.0" encoding="UTF-8"?>
+    <howcast version="0.1">
+      <category>
+        <id>1255</id>
+        <name>General African Travel</name>
+        <parent-id>1584</parent-id>
+        <parents>
+          <category id="1571">Travel</category>
+          <category parent_id="1571" id="1584">African Travel</category>
+        </parents>
+        <subcategories>
+          <category>
+            <id>1265</id>
+            <name>African Travel</name>
+          </category>
+          <category>
+            <id>1289</id>
+            <name>European Travel</name>
+          </category>
+          <category>
+            <id>1256</id>
+            <name>General Travel</name>
+          </category>
+          <category>
+            <id>1311</id>
+            <name>General U.S. Travel</name>
+          </category>
+        </subcategories>
+      </category>
+    </howcast>
+    CAT
+  end
+  
   def video_xml
     <<-VID
     <?xml version="1.0" encoding="UTF-8"?>
@@ -56,6 +91,8 @@ Spec::Runner.configure do |config|
         <category-id>2</category-id>
         <duration>22</duration>
         <id>233</id>
+        <easy-steps>true</easy-steps>
+        <badges>Howcast Studios</badges>
         <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>]]>

data/website/index.html

@@ -5,7 +5,7 @@
   <link rel="stylesheet" href="stylesheets/screen.css" type="text/css" media="screen" />
   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   <title>
-      Howcast
+      
   </title>
   <script src="javascripts/rounded_corners_lite.inc.js" type="text/javascript"></script>
 <style>
@@ -30,15 +30,18 @@
 <body>
 <div id="main">
 
-    <h1>Howcast</h1>
+    <h1></h1>
     <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/howcast"; return false'>
       <p>Get Version</p>
-      <a href="http://rubyforge.org/projects/howcast" class="numbers">0.3.2</a>
+      <a href="http://rubyforge.org/projects/howcast" class="numbers">0.4.1</a>
     </div>
-    <h2>What</h2>
+    <h2>Howcast <span class="caps">API</span> Rubygem</h2>
 
 
-	<p>Howcast RubyGem is a Ruby library for interacting with the <a href="http://groups.google.com/group/howcast-developers">Howcast <span class="caps">API</span></a></p>
+	<h2>What</h2>
+
+
+	<p>Howcast Rubygem is a Ruby library for interacting with the <a href="http://groups.google.com/group/howcast-developers">Howcast <span class="caps">API</span></a></p>
 
 
 	<h2>Installing</h2>

data/website/index.txt

@@ -1,8 +1,9 @@
-h1. Howcast
+
+h2. Howcast API Rubygem
 
 h2. What
 
-Howcast RubyGem is a Ruby library for interacting with the "Howcast API":http://groups.google.com/group/howcast-developers
+Howcast Rubygem is a Ruby library for interacting with the "Howcast API":http://groups.google.com/group/howcast-developers
 
 
 h2. Installing

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: howcast
 version: !ruby/object:Gem::Version 
-  version: 0.3.2
+  version: 0.4.1
 platform: ruby
 authors: 
 - Michael Murray
@@ -9,11 +9,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-06-03 00:00:00 -07:00
+date: 2008-11-06 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: hpricot
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -21,6 +22,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0.6"
     version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.2
+    version: 
 description: Howcast API Ruby Wrapper
 email: 
 - michael+gem@howcast.com
@@ -50,6 +61,7 @@ files:
 - 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
@@ -60,6 +72,7 @@ files:
 - 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
@@ -92,7 +105,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: howcast
-rubygems_version: 1.1.0
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
 summary: Howcast API Ruby Wrapper