howcast 0.4.16 → 0.5.0

data/CHANGELOG

@@ -1,3 +1,7 @@
+== 0.5.0 2010-03-17
+
+* Add user object
+
 == 0.4.16 2010-03-16
 
 * Add permalink to category object

data/VERSION

@@ -1 +1 @@
-0.4.16
+0.5.0

data/howcast.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{howcast}
-  s.version = "0.4.16"
+  s.version = "0.5.0"
 
   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-16}
+  s.date = %q{2010-03-17}
   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
@@ -38,12 +38,14 @@ Gem::Specification.new do |s|
      "lib/howcast/client/category.rb",
      "lib/howcast/client/marker.rb",
      "lib/howcast/client/search.rb",
+     "lib/howcast/client/user.rb",
      "lib/howcast/client/video.rb",
      "lib/howcast/errors.rb",
      "lib/howcast/logging.rb",
      "spec/howcast/client/base_spec.rb",
      "spec/howcast/client/category_spec.rb",
      "spec/howcast/client/search_spec.rb",
+     "spec/howcast/client/user_spec.rb",
      "spec/howcast/client/video_spec.rb",
      "spec/output_capture_helper.rb",
      "spec/spec.opts",
@@ -61,6 +63,7 @@ Gem::Specification.new do |s|
     "spec/howcast/client/base_spec.rb",
      "spec/howcast/client/category_spec.rb",
      "spec/howcast/client/search_spec.rb",
+     "spec/howcast/client/user_spec.rb",
      "spec/howcast/client/video_spec.rb",
      "spec/output_capture_helper.rb",
      "spec/spec_helper.rb",

data/lib/howcast/client.rb

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

data/lib/howcast/client/user.rb

@@ -0,0 +1,94 @@
+#--
+# 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 User
+    extend WatchAttrAccessors
+    attr_accessor :login, :videos
+    
+    # Creates a new User object which is used to encapsulate all the attributes available
+    # from the Howcast user profile API.
+    #
+    # === Inputs
+    #
+    # * <tt>attributes</tt> -- A hash to set the various attributes of the user object
+    #
+    # === Examples
+    # 
+    # Initialize a user with login "someone"
+    #   User.new :login => "someone"
+    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 user API.
+  # 
+  # === Inputs
+  #
+  # * <tt>login</tt> -- The login/username of the user to lookup
+  #
+  # === Outputs
+  # 
+  # User object if the login exists or nil if the login doesn't exist or is malformed
+  #
+  # === Exceptions
+  # 
+  # * <tt>Howcast::ApiNotFound</tt>
+  #
+  # === Examples
+  # 
+  # Get the Howcast user with login 'someone'
+  #   Howcast::Client.new.user('someone')
+  def user(login)
+    response = establish_connection("users/#{login}/profile/videos.xml")
+    parse_single_user_xml(login, response)
+  end
+  
+  private
+    # Exception here to set the login vs. parsing it (not currently included in the api response)
+    def parse_single_user_xml(login, xml)
+      hash = {}
+      User.attr_accessors.each do |attribute|
+        node_name = attribute.to_s.gsub("_", "-") # xml schema uses hyphens for spaces, but ruby uses underscores
+        if node_name == "videos"
+          hash[attribute] = 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[:login] = login
+      hash.values.all?{|v| v==""} ? nil : User.new(hash)
+    end
+    
+    def videos_for(xml)
+      videos = []
+      node = xml.at('videos')
+      node.children_of_type('video').each do |child|
+        videos << parse_single_xml(child, Video)
+      end unless node.nil?
+      videos
+    end
+end

data/spec/howcast/client/user_spec.rb

@@ -0,0 +1,43 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe Howcast::Client::User, "initialize" do
+  it "should create a user object with all the inputted attributes" do
+    user = Howcast::Client::User.new :login => "someone"
+    user.login.should == 'someone'
+  end
+  
+  it "should ignore inputs which are not user attributes" do
+    user = Howcast::Client::User.new :not_an_attribute => "value", :login => "someone"
+    user.respond_to?(:not_an_attribute).should be_false
+    user.login.should == "someone"
+  end
+end
+
+describe Howcast::Client, "user" do  
+  before do
+    @hc = Howcast::Client.new(:key => "myapikey")
+    @hc.stub!(:open).and_return(user_videos_xml)
+  end
+  
+  it "should establish a connection with the correct user url" do
+    @hc.should_receive(:open).with(equivalent_uri("http://www.howcast.com/users/someone/profile/videos.xml?api_key=myapikey")).and_return(user_videos_xml)
+    @hc.user('someone')
+  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.user('someone')
+    }.should raise_error(Howcast::ApiKeyNotFound)
+  end
+
+  it "should set the login attribute in the user model response" do
+    @hc.user('someone').login.should == "someone"
+  end
+  
+  it "should set the videos attribute in the user model response" do
+    videos = @hc.user('someone').videos
+    videos.size.should == 1
+    videos[0].title.should == "How To Remove Bike Handlebar Grips"
+  end
+end

data/spec/xml_fixtures_helper.rb

@@ -2485,4 +2485,44 @@ module XmlFixturesHelper
     </howcast>
     VID
   end
+  
+  def user_videos_xml
+    <<-VID
+    <?xml version="1.0" encoding="UTF-8"?>
+    <howcast version="0.1">
+      <title>Howcast - mrmark86's videos</title>
+      <count>1</count>
+      <videos>
+        <video>
+          <category-id>1356</category-id>
+          <id>329098</id>
+          <title>How To Remove Bike Handlebar Grips</title>
+          <views>77</views>
+          <type>HowcastGuide</type>
+          <created-at>Sun, 14 Mar 2010 11:02:07 -0700</created-at>
+          <rating>0</rating>
+          <username>mrmark86</username>
+          <description>
+            <![CDATA[Remove your handlebar grips in just a few minutes with these tips.]]>
+          </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=329098"></param><param name="allowFullScreen" value="true"></param><param name="allowScriptAccess" value="always"></param><embed src="http://www.howcast.com/flash/howcast_player.swf?file=329098" type="application/x-shockwave-flash" width="425" height="352" allowFullScreen="true" allowScriptAccess="always" ></embed></object>]]>
+          </embed>
+          <duration>61</duration>
+          <filename>http://media.howcast.com/system/videos/6/16/57/32/325716.flv</filename>
+          <tags>sports, fitness, bikes, biking, bicycles, handles, grips, removal, tools, screwdriver</tags>
+          <category-hierarchy>
+            <category id="1334">Sports &amp; Fitness</category>
+            <category parent_id="1334" id="1353">Bikes &amp; Biking</category>
+            <category parent_id="1353" id="1356">Biking Equipment</category>
+          </category-hierarchy>
+          <comment-count>0</comment-count>
+          <thumbnail-url>http://img.howcast.com/system/thumbnails/329098/RemoveBikeHandlebarGrips_xxlarge_maintained_aspect.png</thumbnail-url>
+          <permalink>http://www.howcast.com/videos/329098-How-To-Remove-Bike-Handlebar-Grips</permalink>
+          <content_rating>nonadult</content_rating>
+        </video>
+      </videos>
+    </howcast>
+    VID
+  end
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 4
-  - 16
-  version: 0.4.16
+  - 5
+  - 0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Jingshen Jimmy Zhang
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-16 00:00:00 -07:00
+date: 2010-03-17 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -64,12 +64,14 @@ files:
 - lib/howcast/client/category.rb
 - lib/howcast/client/marker.rb
 - lib/howcast/client/search.rb
+- lib/howcast/client/user.rb
 - lib/howcast/client/video.rb
 - lib/howcast/errors.rb
 - lib/howcast/logging.rb
 - spec/howcast/client/base_spec.rb
 - spec/howcast/client/category_spec.rb
 - spec/howcast/client/search_spec.rb
+- spec/howcast/client/user_spec.rb
 - spec/howcast/client/video_spec.rb
 - spec/output_capture_helper.rb
 - spec/spec.opts
@@ -111,6 +113,7 @@ test_files:
 - spec/howcast/client/base_spec.rb
 - spec/howcast/client/category_spec.rb
 - spec/howcast/client/search_spec.rb
+- spec/howcast/client/user_spec.rb
 - spec/howcast/client/video_spec.rb
 - spec/output_capture_helper.rb
 - spec/spec_helper.rb