agiley-youtube-g 0.6.2

data/lib/youtube_g/response/comments_search.rb

@@ -0,0 +1,41 @@
+class YouTubeG
+  module Response
+    class CommentsSearch < YouTubeG::Record
+      # *String*:: Unique feed identifying url.
+      attr_reader :feed_id 
+      
+      # *Fixnum*:: Number of results per page.
+      attr_reader :max_result_count
+      
+      # *Fixnum*:: 1-based offset index into the full result set.
+      attr_reader :offset
+      
+      # *Fixnum*:: Total number of results available for the original request.
+      attr_reader :total_result_count
+
+      # *Time*:: Date and time at which the feed was last updated
+      attr_reader :updated_at
+
+      # *Array*:: Array of YouTubeG::Model::Video records
+      attr_reader :comments
+
+      def current_page
+        ((offset - 1) / max_result_count) + 1
+      end
+      
+      # current_page + 1 or nil if there is no next page
+      def next_page
+        current_page < total_pages ? (current_page + 1) : nil
+      end
+
+      # current_page - 1 or nil if there is no previous page
+      def previous_page
+        current_page > 1 ? (current_page - 1) : nil
+      end
+
+      def total_pages
+        (total_result_count / max_result_count.to_f).ceil
+      end
+    end
+  end
+end

data/lib/youtube_g/response/video_search.rb

@@ -0,0 +1,41 @@
+class YouTubeG
+  module Response
+    class VideoSearch < YouTubeG::Record
+      # *String*:: Unique feed identifying url.
+      attr_reader :feed_id 
+      
+      # *Fixnum*:: Number of results per page.
+      attr_reader :max_result_count
+      
+      # *Fixnum*:: 1-based offset index into the full result set.
+      attr_reader :offset
+      
+      # *Fixnum*:: Total number of results available for the original request.
+      attr_reader :total_result_count
+
+      # *Time*:: Date and time at which the feed was last updated
+      attr_reader :updated_at
+
+      # *Array*:: Array of YouTubeG::Model::Video records
+      attr_reader :videos
+
+      def current_page
+        ((offset - 1) / max_result_count) + 1
+      end
+      
+      # current_page + 1 or nil if there is no next page
+      def next_page
+        current_page < total_pages ? (current_page + 1) : nil
+      end
+
+      # current_page - 1 or nil if there is no previous page
+      def previous_page
+        current_page > 1 ? (current_page - 1) : nil
+      end
+
+      def total_pages
+        (total_result_count / max_result_count.to_f).ceil
+      end
+    end
+  end
+end

data/lib/youtube_g/version.rb

@@ -0,0 +1,3 @@
+class YouTubeG
+  VERSION = '0.6.2'
+end

data/test/helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'test/unit'
+require 'pp'
+require File.dirname(__FILE__) + '/../lib/youtube_g'
+
+YouTubeG.logger.level = Logger::ERROR

data/test/test_chain_io.rb

@@ -0,0 +1,63 @@
+require File.dirname(__FILE__) + '/helper'
+
+class TestChainIO < Test::Unit::TestCase
+  def setup
+    @klass = YouTubeG::ChainIO # save typing
+  end
+  
+  def test_should_support_read_from_one_io
+    io = @klass.new "abcd"
+    assert io.respond_to?(:read)
+    assert_equal "ab", io.read(2)
+    assert_equal "cd", io.read(2)
+    assert_equal false, io.read(2)
+  end
+  
+  def test_should_skip_over_depleted_streams
+    io = @klass.new '', '', '', '', 'ab'
+    assert_equal 'ab', io.read(2)
+  end
+  
+  def test_should_read_across_nultiple_streams_with_large_offset
+    io = @klass.new 'abc', '', 'def', '', 'ghij'
+    assert_equal 'abcdefgh', io.read(8)
+  end
+
+  def test_should_return_false_for_empty_items
+    io = @klass.new '', '', '', '', ''
+    assert_equal false, io.read(8)
+  end
+  
+  def test_should_support_overzealous_read
+    io = @klass.new "ab"
+    assert_equal "ab", io.read(5000)
+  end
+  
+  def test_should_predict_expected_length
+    io = @klass.new "ab", "cde"
+    assert_equal 5, io.expected_length
+  end
+
+  def test_should_predict_expected_length_with_prepositioned_io
+    first_buf = StringIO.new("ab")
+    first_buf.read(1)
+    
+    io = @klass.new first_buf, "cde"
+    assert_equal 4, io.expected_length
+  end
+  
+  def test_should_predict_expected_length_with_file_handle
+    test_size = File.size(__FILE__)
+    first_buf = StringIO.new("ab")
+    first_buf.read(1)
+    
+    io = @klass.new File.open(__FILE__), first_buf
+    assert_equal test_size + 1, io.expected_length
+  end
+  
+  def test_greedy
+    io = YouTubeG::GreedyChainIO.new("a" * (1024 * 513))
+    chunk = io.read(123)
+    assert_equal 1024 * 512, chunk.length, "Should have read the first 512 KB chunk at once instead"
+  end
+end

data/test/test_client.rb

@@ -0,0 +1,265 @@
+require File.dirname(__FILE__) + '/helper'
+
+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
+  
+  def test_should_get_videos_by_user_with_pagination_and_ordering
+    response = @client.videos_by(:user => 'liz', :page => 2, :per_page => '2', :order_by => 'published')
+    response.videos.each { |v| assert_valid_video v }
+    assert_equal 3, response.offset
+    assert_equal 2, response.max_result_count
+  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_favorite_videos_by_user
+    response = @client.videos_by(:favorites, :user => 'drnicwilliams')
+    assert_equal "http://gdata.youtube.com/feeds/api/users/drnicwilliams/favorites", response.feed_id
+    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&feature=youtube_gdata\"></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_equal "<object width=\"425\" height=\"350\">\n  <param name=\"movie\" value=\"http://www.youtube.com/v/EkF4JD2rO3Q&feature=youtube_gdata\"></param>\n  <param name=\"wmode\" value=\"transparent\"></param>\n  <embed src=\"http://www.youtube.com/v/EkF4JD2rO3Q&feature=youtube_gdata\" 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_always_return_a_logger
+    @client = YouTubeG::Client.new
+    assert_not_nil @client.logger
+  end
+  
+  def test_should_not_bail_if_debug_is_true
+    assert_nothing_raised { YouTubeG::Client.new(true) }
+  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
+      assert_instance_of Fixnum, video.favorite_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/test/test_video.rb

@@ -0,0 +1,38 @@
+require File.dirname(__FILE__) + '/helper'
+
+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