youtube 0.8.0 → 0.8.5

data/CHANGELOG

@@ -1,3 +1,16 @@
+* 2007/02/12
+
+- [drummr77] Added fix to check if returned video response contains an
+  Array or not.  Return nil instead of erroring out.
+
+- [drummr77] Fixed Video.length accessor.  Changed to Video.length_seconds.
+
+- [drummr77] Added new API methods:
+  youtube.videos.list_by_related (with paging),
+  youtube.videos.list_by_playlist (with paging),
+  youtube.videos.list_by_category (with paging)
+  youtube.videos.list_by_category_and_tag (with paging)
+
 * 2006/11/15
 
 - [drummr77] Applied a modified version of the patch sent in by Lucas

data/README

@@ -8,6 +8,8 @@ http://www.youtube.com/my_profile_dev.
 
 The RubyForge project is at http://rubyforge.org/projects/youtube.
 
+The Google Group to discuss issues and bugs is at http://groups.google.com/group/ruby-youtube-library?hl=en.
+
 == About
 
 Implements version 2 of YouTube's API.

data/Rakefile

@@ -6,7 +6,7 @@ require 'rake/gempackagetask'
 
 spec = Gem::Specification.new do |s|
   s.name = 'youtube'
-  s.version = '0.8.0'
+  s.version = '0.8.5'
   s.author = 'Shane Vitarana'
   s.email = 'shanev@gmail.com'
   s.platform = Gem::Platform::RUBY

data/lib/youtube.rb

@@ -57,14 +57,15 @@ module YouTube
     # videos of the supplied +username+.
     def favorite_videos(username)
       response = users_list_favorite_videos(:user => username)
-      response['video_list']['video'].compact.map { |video| Video.new(video) }
+      _parse_video_response(response)
     end
 
     # Returns a list of YouTube::Friend objects detailing the friends of
     # the supplied +username+.
     def friends(username)
       response = users_list_friends(:user => username)
-      response['friend_list']['friend'].compact.map { |friend| Friend.new(friend) }
+      friends = response['friend_list']['friend']
+      friends.is_a?(Array) ? friends.compact.map { |friend| Friend.new(friend) } : nil        
     end
 
     # Returns a list of YouTube::Video objects detailing the videos
@@ -75,21 +76,65 @@ module YouTube
     # +per_page+ = the number of results per page (default: 20, max 100).
     def videos_by_tag(tag, page = 1, per_page = 20)
       response = videos_list_by_tag(:tag => tag, :page => page, :per_page => per_page)
-      response['video_list']['video'].compact.map { |video| Video.new(video) }
+      _parse_video_response(response)
+    end
+
+    # Returns a list of YouTube::Video objects that match any of the
+    # specified +tag+s.
+    #
+    # Optional parameters are:
+    # +page+ = the "page" of results to retrieve (e.g. 1, 2, 3)
+    # +per_page+ = the number of results per page (default: 20, max 100).
+    def videos_by_related(tag, page = 1, per_page = 20)
+      response = videos_list_by_related(:tag => tag, :page => page, :per_page => per_page)
+      _parse_video_response(response)
+    end
+
+    # Returns a list of YouTube::Video objects with the specified
+    # +playlist id+.
+    #
+    # Optional parameters are:
+    # +page+ = the "page" of results to retrieve (e.g. 1, 2, 3)
+    # +per_page+ = the number of results per page (default: 20, max 100).
+    def videos_by_playlist(id, page = 1, per_page = 20)
+      response = videos_list_by_playlist(:id => id, :page => page, :per_page => per_page)
+      _parse_video_response(response)
+    end
+
+    # Returns a list of YouTube::Video objects with the specified
+    # +category id+.
+    #
+    # Optional parameters are:
+    # +page+ = the "page" of results to retrieve (e.g. 1, 2, 3)
+    # +per_page+ = the number of results per page (default: 20, max 100).
+    def videos_by_category(id, page = 1, per_page = 20)
+      response = videos_list_by_category(:category_id => id, :page => page, :per_page => per_page)
+      _parse_video_response(response)
+    end
+
+    # Returns a list of YouTube::Video objects detailing the videos
+    # matching the supplied +category id+ and +tag+.
+    #
+    # Optional parameters are:
+    # +page+ = the "page" of results to retrieve (e.g. 1, 2, 3)
+    # +per_page+ = the number of results per page (default: 20, max 100).
+    def videos_by_category_and_tag(id, tag, page = 1, per_page = 20)
+      response = videos_list_by_category_and_tag(:category_id => id, :tag => tag, :page => page, :per_page => per_page)
+      _parse_video_response(response)
     end
 
     # Returns a list of YouTube::Video objects detailing the videos
     # uploaded by the specified +username+.
     def videos_by_user(username)
       response = videos_list_by_user(:user => username)
-      response['video_list']['video'].compact.map { |video| Video.new(video) }
+      _parse_video_response(response)
     end
 
     # Returns a list of YouTube::Video objects detailing the current
     # global set of featured videos on YouTube.
     def featured_videos
       response = videos_list_featured
-      response['video_list']['video'].compact.map { |video| Video.new(video) }
+      _parse_video_response(response)
     end
 
     # Returns a YouTube::VideoDetails object detailing additional
@@ -131,6 +176,11 @@ module YouTube
       def _http_get(url)
         Net::HTTP.get_response(URI.parse(url)).body.to_s
       end
+
+      def _parse_video_response(response)
+        videos = response['video_list']['video']
+        videos.is_a?(Array) ? videos.compact.map { |video| Video.new(video) } : nil        
+      end
   end
 
   class Friend
@@ -199,7 +249,7 @@ module YouTube
     attr_reader :description
     attr_reader :embed_url
     attr_reader :id
-    attr_reader :length
+    attr_reader :length_seconds
     attr_reader :rating_avg
     attr_reader :rating_count
     attr_reader :tags
@@ -214,7 +264,7 @@ module YouTube
       @comment_count = payload['comment_count'].to_i
       @description = payload['description']
       @id = payload['id']
-      @length = payload['length']
+      @length_seconds = payload['length_seconds'].to_i
       @rating_avg = payload['rating_avg'].to_f
       @rating_count = payload['rating_count'].to_i
       @tags = payload['tags']

data/test/test_api.rb

@@ -1,6 +1,7 @@
 require 'rubygems'
 require 'test/unit'
 require 'youtube'
+require 'pp'
 
 # This test class assumes an active internet connection
 class TestAPI < Test::Unit::TestCase
@@ -30,6 +31,11 @@ class TestAPI < Test::Unit::TestCase
     # pull out one to scrutinize
     sample = favorites.first
     _test_video(sample)
+    
+    # user doesn't exist / test exception handling
+    assert_raise RuntimeError do
+      favorites = @client.favorite_videos('dsfa98sd7fa9s8d7fd8')
+    end
   end
 
   def test_friends
@@ -50,18 +56,47 @@ class TestAPI < Test::Unit::TestCase
   end
 
   def test_videos_by_tag
+    # test case where videos exist
     videos = @client.videos_by_tag('iron maiden')
     _test_video_list(videos)
-
     videos = @client.videos_by_tag('caffe trieste')
     _test_video_list(videos)
+
+    # test case where no videos exist
+    videos = @client.videos_by_tag('u423oi4j23oi4j234io')
+    assert_nil videos
   end
 
   def test_videos_by_user
+    # test case where videos exist
     videos = @client.videos_by_user('whytheluckystiff')
     _test_video_list(videos)
+    
+    # test case where videos don't exist
+    videos = @client.videos_by_user('br0wnpunk')
+    assert_nil videos
   end
 
+  def test_videos_by_related
+    videos = @client.videos_by_related('squats')
+    _test_video_list(videos)
+  end
+  
+  def test_videos_by_playlist
+    videos = @client.videos_by_playlist('4009D81B1E0277A1')
+    _test_video_list(videos)
+  end
+  
+  # def test_videos_by_category
+  #   videos = @client.videos_by_category('10')
+  #   _test_video_list(videos)
+  # end
+  # 
+  # def test_videos_by_category_and_tag
+  #   videos = @client.videos_by_category_and_tag('10', 'punk')
+  #   _test_video_list(videos)
+  # end
+  
   def test_featured_videos
     videos = @client.featured_videos
     _test_video_list(videos)
@@ -149,9 +184,10 @@ class TestAPI < Test::Unit::TestCase
     # check other attributes
     assert (video.thumbnail_url =~ /\.jpg$/)
     assert (video.title && video.title.length > 0)
+    assert (video.length_seconds > 0)
     assert (video.upload_time && video.upload_time.is_a?(Time))
     _assert_youtube_url video.url
-    assert (video.view_count > 0)
+    assert (video.view_count >= 0)
     assert (video.tags && video.tags.length > 0)
     assert (video.author && video.author.length > 0)
   end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: youtube
 version: !ruby/object:Gem::Version 
-  version: 0.8.0
-date: 2006-11-18 00:00:00 -06:00
+  version: 0.8.5
+date: 2007-02-12 00:00:00 -06:00
 summary: A Ruby object-oriented interface to the YouTube REST API.
 require_paths: 
 - lib