msp-youtube-g 0.4.7 → 0.4.8.1

data/History.txt

@@ -1,5 +1,15 @@
 == trunk
 * Move network dependent tests to integration-test [msp]
+* Create a parser and a model for upload errors [msp]
+* Stub driven tests for VideoFeedParser, VideosFeedParser, UploadErrorParser [msp]
+* Added :page and :per_page options, this allows easier usage of the will_paginate
+  plugin with the library. The :offset and :max_results options are no longer available. [Daniel Insley]
+* Added ability to get video responses on the instances of the YouTube::Model::Video object. [Daniel Insley]
+* Added and improved the existing documentation [Daniel Insley]
+* Fixed usage of deprecated yt:racy, now using media:rating [Daniel Insley]
+* Renamed can_embed? method to embeddable? [Daniel Insley]
+* Added ability for padingation and ordering on standard feeds. [Daniel Insley]
+* Move network dependent tests to integration-test [msp]
 * Create a parser and a model for upload errors  [msp]
 * Stub driven tests for VideoFeedParser, VideosFeedParser, UploadErrorParser [msp]
 * Add error-handling for video upload errors. [FiXato]

data/Manifest.txt

@@ -18,6 +18,9 @@ lib/youtube_g/model/video.rb
 lib/youtube_g/model/upload_error.rb
 lib/youtube_g/parser.rb
 lib/youtube_g/record.rb
+lib/youtube_g/request/base_search.rb
+lib/youtube_g/request/standard_search.rb
+lib/youtube_g/request/user_search.rb
 lib/youtube_g/request/video_search.rb
 lib/youtube_g/request/video_upload.rb
 lib/youtube_g/response/video_search.rb

data/README.txt

@@ -32,6 +32,7 @@ Create a client:
 Basic queries:
 
   client.videos_by(:query => "penguin")
+  client.videos_by(:query => "penguin", :page => 2, :per_page => 15)
   client.videos_by(:tags => ['tiger', 'leopard'])
   client.videos_by(:categories => [:news, :sports])
   client.videos_by(:categories => [:news, :sports], :tags => ['soccer', 'football'])
@@ -40,6 +41,7 @@ Basic queries:
 Standard feeds:
 	
   client.videos_by(:most_viewed)
+  client.videos_by(:most_linked, :page => 3)
   client.videos_by(:top_rated, :time => :today)
 	
 Advanced queries (with boolean operators OR (either), AND (include), NOT (exclude)):

data/Rakefile

@@ -17,4 +17,9 @@ desc 'Tag release'
 task :tag do
   svn_root = 'svn+ssh://drummr77@rubyforge.org/var/svn/youtube-g'
   sh %(svn cp #{svn_root}/trunk #{svn_root}/tags/release-#{YouTubeG::VERSION} -m "Tag YouTubeG release #{YouTubeG::VERSION}")
+end
+
+desc 'Load the library in an IRB session'
+task :console do
+  sh %(irb -r lib/youtube_g.rb)
 end

data/TODO.txt

@@ -1,12 +1,10 @@
 [ ] stub out http request/response cycle for tests (partially done in test_parser, need to do the same for pre-existing tests [msp])
-[ ] consider defaulting the client to no-logger, rather than outputting to STDOUT.
 [ ] allow specifying values as single items where you don't need to wrap in a list, e.g. :tags => :chickens instead of :tags => [ 'chickens' ]
 [ ] make sure symbols will work as well as tags everywhere (again, :tags => :chickens is same as :tags => 'chickens')
 [ ] figure out better structure for class/file (either rename request/video_search.rb or split into one class per file again)
 [ ] restore spaces after method def names
 [ ] use a proxy for testing with static sample result xml so we have repeatable tests (see above [msp])
 [ ] Clean up tests using Shoulda to define contexts
-[ ] Consolidate requires
 [ ] Allow :category and :categories for query DSL
 [ ] Exception handling
 

data/integration-test/test_client.rb

@@ -0,0 +1,256 @@
+require 'rubygems'
+require 'test/unit'
+require 'pp'
+
+require 'youtube_g'
+
+class TestClient < Test::Unit::TestCase
+  def setup
+    @client = YouTubeG::Client.new
+  end
+
+  def test_should_respond_to_a_basic_query
+    response = @client.videos_by(:query => "penguin")
+  
+    assert_equal "http://gdata.youtube.com/feeds/api/videos", response.feed_id
+    assert_equal 25, response.max_result_count
+    assert_equal 25, response.videos.length
+    assert_equal 1, response.offset
+    assert(response.total_result_count > 100)
+    assert_instance_of Time, response.updated_at
+  
+    response.videos.each { |v| assert_valid_video v }
+  end
+  
+    def test_should_respond_to_a_basic_query_with_offset_and_max_results
+    response = @client.videos_by(:query => "penguin", :offset => 15, :max_results => 30)
+  
+    assert_equal "http://gdata.youtube.com/feeds/api/videos", response.feed_id
+    assert_equal 30, response.max_result_count
+    assert_equal 30, response.videos.length
+    assert_equal 15, response.offset
+    assert(response.total_result_count > 100)
+    assert_instance_of Time, response.updated_at
+  
+    response.videos.each { |v| assert_valid_video v }
+  end
+  
+  def test_should_respond_to_a_basic_query_with_paging
+    response = @client.videos_by(:query => "penguin") 
+    assert_equal "http://gdata.youtube.com/feeds/api/videos", response.feed_id
+    assert_equal 25, response.max_result_count
+    assert_equal 1, response.offset
+
+    response = @client.videos_by(:query => "penguin", :page => 2) 
+    assert_equal "http://gdata.youtube.com/feeds/api/videos", response.feed_id
+    assert_equal 25, response.max_result_count
+    assert_equal 26, response.offset
+    
+    response2 = @client.videos_by(:query => "penguin", :page => 3) 
+    assert_equal "http://gdata.youtube.com/feeds/api/videos", response2.feed_id
+    assert_equal 25, response2.max_result_count
+    assert_equal 51, response2.offset
+  end
+  
+  
+  def test_should_get_videos_for_multiword_metasearch_query
+    response = @client.videos_by(:query => 'christina ricci')
+  
+    assert_equal "http://gdata.youtube.com/feeds/api/videos", response.feed_id
+    assert_equal 25, response.max_result_count
+    assert_equal 25, response.videos.length
+    assert_equal 1, response.offset
+    assert(response.total_result_count > 100)
+    assert_instance_of Time, response.updated_at
+  
+    response.videos.each { |v| assert_valid_video v }
+  end
+  
+  def test_should_handle_video_not_yet_viewed
+    response = @client.videos_by(:query => "YnqHZDh_t2Q")
+
+    assert_equal 1, response.videos.length
+    response.videos.each { |v| assert_valid_video v }
+  end
+
+  # TODO: this doesn't work because the returned feed is in an unknown format
+  # def test_should_get_video_for_search_by_video_id
+  #   response = @client.videos_by(:video_id => "T7YazwP8GtY")
+  #   response.videos.each { |v| assert_valid_video v }    
+  # end
+  
+  def test_should_get_videos_for_one_tag
+    response = @client.videos_by(:tags => ['panther'])
+    response.videos.each { |v| assert_valid_video v }
+  end
+  
+  def test_should_get_videos_for_multiple_tags
+    response = @client.videos_by(:tags => ['tiger', 'leopard'])
+    response.videos.each { |v| assert_valid_video v }    
+  end
+  
+  def test_should_get_videos_for_one_category
+    response = @client.videos_by(:categories => [:news])
+    response.videos.each { |v| assert_valid_video v }    
+  end
+  
+  def test_should_get_videos_for_multiple_categories
+    response = @client.videos_by(:categories => [:news, :sports])
+    response.videos.each { |v| assert_valid_video v }        
+  end
+  
+  # TODO: Need to do more specific checking in these tests
+  # Currently, if a URL is valid, and videos are found, the test passes regardless of search criteria
+  def test_should_get_videos_for_categories_and_tags
+    response = @client.videos_by(:categories => [:news, :sports], :tags => ['soccer', 'football'])
+    response.videos.each { |v| assert_valid_video v }            
+  end
+  
+  def test_should_get_most_viewed_videos
+    response = @client.videos_by(:most_viewed)
+    response.videos.each { |v| assert_valid_video v }                
+  end
+  
+  def test_should_get_top_rated_videos_for_today
+    response = @client.videos_by(:top_rated, :time => :today)
+    response.videos.each { |v| assert_valid_video v }                    
+  end
+  
+  def test_should_get_videos_for_categories_and_tags_with_category_boolean_operators
+    response = @client.videos_by(:categories => { :either => [:news, :sports], :exclude => [:comedy] },
+                                 :tags => { :include => ['football'], :exclude => ['soccer'] })
+    response.videos.each { |v| assert_valid_video v }
+  end
+
+  def test_should_get_videos_for_categories_and_tags_with_tag_boolean_operators
+    response = @client.videos_by(:categories => { :either => [:news, :sports], :exclude => [:comedy] },
+                                 :tags => { :either => ['football', 'soccer', 'polo'] })
+    response.videos.each { |v| assert_valid_video v }
+  end
+  
+  def test_should_get_videos_by_user
+    response = @client.videos_by(:user => 'liz')
+    response.videos.each { |v| assert_valid_video v }
+  end
+
+  # HTTP 403 Error
+  # def test_should_get_favorite_videos_by_user
+  #   response = @client.videos_by(:favorites, :user => 'liz')
+  #   response.videos.each { |v| assert_valid_video v }
+  # end
+  
+  def test_should_get_videos_for_query_search_with_categories_excluded
+    video = @client.video_by("EkF4JD2rO3Q")
+    assert_equal "<object width=\"425\" height=\"350\">\n  <param name=\"movie\" value=\"http://www.youtube.com/v/EkF4JD2rO3Q\"></param>\n  <param name=\"wmode\" value=\"transparent\"></param>\n  <embed src=\"http://www.youtube.com/v/EkF4JD2rO3Q\" type=\"application/x-shockwave-flash\" \n   wmode=\"transparent\" width=\"425\" height=\"350\"></embed>\n</object>\n", video.embed_html
+    assert_valid_video video
+  end
+
+  def test_should_disable_debug_if_debug_is_set_to_false
+    @client = YouTubeG::Client.new
+    assert_nil @client.logger
+  end
+  
+  def test_should_enable_logger_if_debug_is_true
+    @client = YouTubeG::Client.new(true)
+    assert_not_nil @client.logger
+  end
+  
+  def test_should_determine_if_nonembeddable_video_is_embeddable
+    response = @client.videos_by(:query => "avril lavigne girlfriend")
+  
+    video = response.videos.first
+    assert !video.embeddable?
+  end
+
+  def test_should_determine_if_embeddable_video_is_embeddable
+    response = @client.videos_by(:query => "strongbad")
+  
+    video = response.videos.first
+    assert video.embeddable?
+  end
+  
+  def test_should_retrieve_video_by_id
+    video = @client.video_by("http://gdata.youtube.com/feeds/videos/EkF4JD2rO3Q")
+    assert_valid_video video
+
+    video = @client.video_by("EkF4JD2rO3Q")
+    assert_valid_video video
+  end
+  
+  private
+
+    def assert_valid_video (video)
+      # pp video
+
+      # check general attributes
+      assert_instance_of YouTubeG::Model::Video, video
+      assert_instance_of Fixnum, video.duration
+      assert(video.duration > 0)
+      #assert_match(/^<div style=.*?<\/div>/m, video.html_content)
+      assert_instance_of String, video.html_content
+
+      # validate media content records
+      video.media_content.each do |media_content|
+        # http://www.youtube.com/v/IHVaXG1thXM
+        assert_valid_url media_content.url
+        assert(media_content.duration > 0)
+        assert_instance_of YouTubeG::Model::Video::Format, media_content.format
+        assert_instance_of String, media_content.mime_type
+        assert_match(/^[^\/]+\/[^\/]+$/, media_content.mime_type)
+      end
+
+      default_content = video.default_media_content
+      if default_content
+        assert_instance_of YouTubeG::Model::Content, default_content
+        assert default_content.is_default?
+      end
+
+      # validate keywords
+      video.keywords.each { |kw| assert_instance_of(String, kw) }
+
+      # http://www.youtube.com/watch?v=IHVaXG1thXM
+      assert_valid_url video.player_url
+      assert_instance_of Time, video.published_at
+
+      # validate optionally-present rating
+      if video.rating
+        assert_instance_of YouTubeG::Model::Rating, video.rating
+        assert_instance_of Float, video.rating.average
+        assert_instance_of Fixnum, video.rating.max
+        assert_instance_of Fixnum, video.rating.min
+        assert_instance_of Fixnum, video.rating.rater_count
+      end
+      
+      # validate thumbnails
+      assert(video.thumbnails.size > 0)
+
+      assert_not_nil video.title
+      assert_instance_of String, video.title
+      assert(video.title.length > 0)
+
+      assert_instance_of Time, video.updated_at
+      # http://gdata.youtube.com/feeds/videos/IHVaXG1thXM
+      assert_valid_url video.video_id
+      assert_instance_of Fixnum, video.view_count
+
+      # validate author
+      assert_instance_of YouTubeG::Model::Author, video.author
+      assert_instance_of String, video.author.name
+      assert(video.author.name.length > 0)
+      assert_valid_url video.author.uri
+      
+      # validate categories
+      video.categories.each do |cat|
+        assert_instance_of YouTubeG::Model::Category, cat
+        assert_instance_of String, cat.label
+        assert_instance_of String, cat.term
+      end
+    end
+
+    def assert_valid_url (url)
+      URI::parse(url)
+      return true
+    rescue
+      return false
+    end
+end

data/integration-test/test_video.rb

@@ -0,0 +1,42 @@
+require 'rubygems'
+require 'test/unit'
+require 'pp'
+
+require 'youtube_g'
+
+class TestVideo < Test::Unit::TestCase
+  def test_should_extract_unique_id_from_video_id
+    video = YouTubeG::Model::Video.new(:video_id => "http://gdata.youtube.com/feeds/videos/ZTUVgYoeN_o")
+    assert_equal "ZTUVgYoeN_o", video.unique_id
+  end
+
+  def test_should_extract_unique_id_with_hypen_from_video_id
+    video = YouTubeG::Model::Video.new(:video_id => "http://gdata.youtube.com/feeds/videos/BDqs-OZWw9o")
+    assert_equal "BDqs-OZWw9o", video.unique_id
+  end
+
+  def test_should_have_related_videos
+    video = YouTubeG::Model::Video.new(:video_id => "http://gdata.youtube.com/feeds/videos/BDqs-OZWw9o")
+    response = video.related
+
+    assert_equal "http://gdata.youtube.com/feeds/api/videos/BDqs-OZWw9o/related", response.feed_id
+    assert_equal 25, response.max_result_count
+    assert_equal 25, response.videos.length
+    assert_equal 1, response.offset
+    assert(response.total_result_count > 0)
+    assert_instance_of Time, response.updated_at
+  end
+  
+  def test_should_have_response_videos
+    video = YouTubeG::Model::Video.new(:video_id => "http://gdata.youtube.com/feeds/videos/BDqs-OZWw9o")
+    response = video.responses
+
+    assert_equal "http://gdata.youtube.com/feeds/api/videos/BDqs-OZWw9o/responses", response.feed_id
+    assert_equal 25, response.max_result_count
+    assert_equal 25, response.videos.length
+    assert_equal 1, response.offset
+    assert(response.total_result_count > 0)
+    assert_instance_of Time, response.updated_at
+  end
+  
+end

data/integration-test/test_video_search.rb

@@ -0,0 +1,128 @@
+require 'rubygems'
+require 'test/unit'
+require 'pp'
+
+require 'youtube_g'
+
+class TestVideoSearch < Test::Unit::TestCase
+
+  def test_should_build_basic_query_url
+    request = YouTubeG::Request::VideoSearch.new(:query => "penguin")
+    assert_equal "http://gdata.youtube.com/feeds/api/videos?vq=penguin", request.url
+  end
+  
+  def test_should_build_multiword_metasearch_query_url
+    request = YouTubeG::Request::VideoSearch.new(:query => 'christina ricci')
+    assert_equal "http://gdata.youtube.com/feeds/api/videos?vq=christina+ricci", request.url
+  end
+  
+  def test_should_build_video_id_url
+    request = YouTubeG::Request::VideoSearch.new(:video_id => 'T7YazwP8GtY')
+    assert_equal "http://gdata.youtube.com/feeds/api/videos/T7YazwP8GtY", request.url
+  end
+
+  def test_should_build_one_tag_querl_url
+    request = YouTubeG::Request::VideoSearch.new(:tags => ['panther'])
+    assert_equal "http://gdata.youtube.com/feeds/api/videos/-/panther/", request.url
+  end
+  
+  def test_should_build_multiple_tags_query_url
+    request = YouTubeG::Request::VideoSearch.new(:tags => ['tiger', 'leopard'])
+    assert_equal "http://gdata.youtube.com/feeds/api/videos/-/tiger/leopard/", request.url
+  end
+  
+  def test_should_build_one_category_query_url
+    request = YouTubeG::Request::VideoSearch.new(:categories => [:news])
+    assert_equal "http://gdata.youtube.com/feeds/api/videos/-/News/", request.url
+  end
+  
+  def test_should_build_multiple_categories_query_url
+    request = YouTubeG::Request::VideoSearch.new(:categories => [:news, :sports])
+    assert_equal "http://gdata.youtube.com/feeds/api/videos/-/News/Sports/", request.url
+  end
+  
+  def test_should_build_categories_and_tags_query_url
+    request = YouTubeG::Request::VideoSearch.new(:categories => [:news, :sports], :tags => ['soccer', 'football'])
+    assert_equal "http://gdata.youtube.com/feeds/api/videos/-/News/Sports/soccer/football/", request.url
+  end
+  
+  def test_should_build_categories_and_tags_url_with_max_results
+    request = YouTubeG::Request::VideoSearch.new(:categories => [:music], :tags => ['classic', 'rock'], :max_results => 2)
+    assert_equal "http://gdata.youtube.com/feeds/api/videos/-/Music/classic/rock/?max-results=2", request.url
+  end
+  
+  def test_should_build_author_query_url
+    request = YouTubeG::Request::VideoSearch.new(:author => "davidguetta")
+    assert_equal "http://gdata.youtube.com/feeds/api/videos?author=davidguetta", request.url
+  end
+  # -- Standard Feeds --------------------------------------------------------------------------------
+  
+  def test_should_build_url_for_most_viewed
+    request = YouTubeG::Request::StandardSearch.new(:most_viewed)
+    assert_equal "http://gdata.youtube.com/feeds/api/standardfeeds/most_viewed", request.url    
+  end
+  
+  def test_should_build_url_for_top_rated_for_today
+    request = YouTubeG::Request::StandardSearch.new(:top_rated, :time => :today)
+    assert_equal "http://gdata.youtube.com/feeds/api/standardfeeds/top_rated?time=today", request.url    
+  end  
+  
+  def test_should_build_url_for_most_viewed_offset_and_max_results_without_time
+    request = YouTubeG::Request::StandardSearch.new(:top_rated, :offset => 5, :max_results => 10)
+    assert_equal "http://gdata.youtube.com/feeds/api/standardfeeds/top_rated?max-results=10&start-index=5", request.url   
+  end
+  
+  def test_should_build_url_for_most_viewed_offset_and_max_results_with_time
+    request = YouTubeG::Request::StandardSearch.new(:top_rated, :offset => 5, :max_results => 10, :time => :today)
+    assert_equal "http://gdata.youtube.com/feeds/api/standardfeeds/top_rated?time=today&max-results=10&start-index=5", request.url   
+  end
+
+  def test_should_raise_exception_for_invalid_type
+    assert_raise RuntimeError do
+      request = YouTubeG::Request::StandardSearch.new(:most_viewed_yo)
+    end
+  end
+  
+  # -- Complex Video Queries -------------------------------------------------------------------------
+  
+  def test_should_build_url_for_boolean_or_case_for_categories
+    request = YouTubeG::Request::VideoSearch.new(:categories => { :either => [:news, :sports] })
+    assert_equal "http://gdata.youtube.com/feeds/api/videos/-/News%7CSports/", request.url
+  end
+
+  def test_should_build_url_for_boolean_or_and_exclude_case_for_categories
+    request = YouTubeG::Request::VideoSearch.new(:categories => { :either => [:news, :sports], :exclude => [:comedy] })
+    assert_equal "http://gdata.youtube.com/feeds/api/videos/-/News%7CSports/-Comedy/", request.url
+  end
+
+  def test_should_build_url_for_exclude_case_for_tags
+    request = YouTubeG::Request::VideoSearch.new(:categories => { :either => [:news, :sports], :exclude => [:comedy] },
+                                                 :tags => { :include => ['football'], :exclude => ['soccer'] })
+    assert_equal "http://gdata.youtube.com/feeds/api/videos/-/News%7CSports/-Comedy/football/-soccer/", request.url
+  end
+
+  def test_should_build_url_for_either_case_for_tags
+    request = YouTubeG::Request::VideoSearch.new(:categories => { :either => [:news, :sports], :exclude => [:comedy] },
+                                                 :tags => { :either => ['soccer', 'football', 'donkey'] })
+    assert_equal "http://gdata.youtube.com/feeds/api/videos/-/News%7CSports/-Comedy/soccer%7Cfootball%7Cdonkey/", request.url
+  end
+  
+  def test_should_build_url_for_query_search_with_categories_excluded
+    request = YouTubeG::Request::VideoSearch.new(:query => 'bench press', 
+                                                 :categories => { :exclude => [:comedy, :entertainment] },
+                                                 :max_results => 10)
+    assert_equal "http://gdata.youtube.com/feeds/api/videos/-/-Comedy/-Entertainment/?vq=bench+press&max-results=10", request.url
+  end
+  
+  # -- User Queries ---------------------------------------------------------------------------------
+  
+  def test_should_build_url_for_videos_by_user
+    request = YouTubeG::Request::UserSearch.new(:user => 'liz')
+    assert_equal "http://gdata.youtube.com/feeds/api/users/liz/uploads", request.url
+  end
+  
+  def test_should_build_url_for_favorite_videos_by_user
+    request = YouTubeG::Request::UserSearch.new(:favorites, :user => 'liz')
+    assert_equal "http://gdata.youtube.com/feeds/api/users/liz/favorites", request.url
+  end
+end