google-video 0.5.0

data/test/test_client.rb

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'test/unit'
+require 'google-video'
+require File.dirname(__FILE__) + '/video_test_helper'
+
+class TestClient < Test::Unit::TestCase
+  include VideoTestHelper
+
+  def test_validation
+    # make sure we can do basic client instantiation
+    assert_nothing_raised do
+      @client = GoogleVideo::Client.new
+    end
+    
+    # make sure we get an error if we specify a bad host
+    assert_raise GoogleVideo::GoogleVideoException do
+      @client = GoogleVideo::Client.new :host => 'nO)domain#!badbadbad'
+      request = GoogleVideo::TopVideosRequest.new
+      @client.top_videos request
+    end
+  end
+end

data/test/test_top_videos.rb

@@ -0,0 +1,76 @@
+require 'rubygems'
+require 'test/unit'
+require 'google-video'
+require File.dirname(__FILE__) + '/video_test_helper'
+
+class TestTopVideos < Test::Unit::TestCase
+  include VideoTestHelper
+
+  # the number of top videos in the list
+  @@TOP_VIDEOS_COUNT = 100
+
+  def setup
+    @client = GoogleVideo::Client.new
+  end
+
+  def test_request_validation
+    # make sure an invalid country is detected
+    assert_raise ArgumentError do
+      GoogleVideo::TopVideosRequest.new(:country => 'foobarbaz')
+    end
+    
+    # make sure the top videos method requires an appropriate request object type
+    assert_raise ArgumentError do
+      @client.top_videos 'foo'
+    end
+  end
+
+  # check the basic top video page listings
+  def test_top_videos
+    request = GoogleVideo::TopVideosRequest.new
+    response = @client.top_videos request
+    assert_valid_top_videos_response response
+  end
+  
+  # make sure specifying a country operates properly
+  def test_top_videos_country
+    request = GoogleVideo::TopVideosRequest.new(:country => 'Brazil')
+    brazil_response = @client.top_videos request
+    assert_valid_top_videos_response brazil_response
+
+    request = GoogleVideo::TopVideosRequest.new(:country => 'Japan')
+    japanese_response = @client.top_videos request
+    assert_valid_top_videos_response japanese_response
+
+    # assume that at least one video in the japanese list will differ from the
+    # brazilian list, which seems like a safe bet given the number of videos
+    # in the list
+    diff = false
+    japanese_response.videos.each_with_index { 
+      |jv, index| diff ||= (brazil_response.videos[index].video.doc_id != jv.video.doc_id) }
+    assert diff
+  end
+
+  def assert_valid_top_videos_response (response)
+    # sanity-check the result
+    assert_not_nil response
+    assert_valid_google_video_url response.request_url
+    assert_not_nil response.videos
+    assert_instance_of Array, response.videos
+
+    # make sure we got the proper number of entries
+    assert_equal response.videos.length, @@TOP_VIDEOS_COUNT
+    
+    # validate each entry
+    response.videos.each { |video| assert_valid_top_video(video) }
+  end
+
+  def assert_valid_top_video (top_video)
+    assert_not_nil top_video
+    assert_instance_of GoogleVideo::TopVideo, top_video
+    assert ([0, 1, -1].include?(top_video.movement))
+    assert (top_video.rank_today >= 0 && top_video.rank_today <= @@TOP_VIDEOS_COUNT)
+    assert (top_video.rank_yesterday >= 0 && top_video.rank_yesterday <= @@TOP_VIDEOS_COUNT)
+    assert_valid_video(top_video.video)
+  end
+end

data/test/test_video_details.rb

@@ -0,0 +1,104 @@
+require 'rubygems'
+require 'test/unit'
+require 'google-video'
+require File.dirname(__FILE__) + '/video_test_helper'
+
+class TestVideoDetails < Test::Unit::TestCase
+  include VideoTestHelper
+
+  @@QUERY = 'christina ricci'
+  @@DOC_ID = 5338330163635012030
+
+  def setup
+    @client = GoogleVideo::Client.new
+  end
+
+  def test_request_validation
+    # make sure the video details method requires an appropriate request object type
+    assert_raise ArgumentError do
+      @client.video_details 'foo'
+    end
+
+    # fetch a sample video for parameter testing purposes
+    request = GoogleVideo::VideoSearchRequest.new(:query => @@QUERY)
+    video = @client.video_search(request).videos.first
+
+    # make sure general and correct request construction succeeds
+    assert_nothing_raised do
+      GoogleVideo::VideoDetailsRequest.new(:doc_id => @@DOC_ID)
+      GoogleVideo::VideoDetailsRequest.new(:video => video)
+    end
+
+    # make sure an attempt to use nothing fails
+    assert_raise ArgumentError do
+      GoogleVideo::VideoDetailsRequest.new
+    end
+    
+    # make sure an attempt to use both fails
+    assert_raise ArgumentError do
+      GoogleVideo::VideoDetailsRequest.new(:doc_id => @@DOC_ID, :video => video)
+    end
+  end
+
+  def test_video_details_by_video
+    # grab a sample video
+    request = GoogleVideo::VideoSearchRequest.new(:query => @@QUERY)
+    response = @client.video_search request
+    assert (response.videos && response.videos.length >= 1)
+
+    # test running a detail request on each video
+    response.videos.each do |video|
+      # look up the video's details
+      request = GoogleVideo::VideoDetailsRequest.new(:video => video)
+      response = @client.video_details request
+      # check it out
+      assert_valid_video_detail_response(response)
+    end
+  end
+
+  def test_video_details_by_doc_id
+    request = GoogleVideo::VideoDetailsRequest.new(:doc_id => @@DOC_ID)
+    response = @client.video_details request
+    assert_valid_video_detail_response(response)
+  end
+
+  # TODO: test the three variants of possible "durationetc" span parsing
+
+  def assert_valid_playlist_entry (entry)
+    assert_not_nil entry
+    assert_instance_of GoogleVideo::PlaylistEntry, entry
+    assert (entry.title && entry.title.length > 0)
+    assert_valid_google_video_url entry.thumbnail_image_url
+    assert (entry.duration && entry.duration.length > 0)
+    assert_match(/\d+/, entry.duration)
+    assert_valid_google_video_url entry.page_url
+  end
+
+  def assert_valid_video_frame_thumbnail (frame)
+    assert_not_nil frame
+    assert (frame.title && frame.title.length > 0)
+    assert_valid_google_video_url frame.thumbnail_image_url
+  end
+
+  def assert_valid_video_detail_response (response)
+    # sanity-check a couple of basic things
+    assert_valid_google_video_url response.request_url
+    video = response.video
+
+    # poke and prod the video object
+    assert_valid_video video
+    assert (video.view_count >= video.yesterday_view_count)
+    assert_match /http:\/\/video\.google\.com\/videogvp\/[^\.]+\.gvp\?docid=[0-9\-\+]+/, video.video_file_url
+    assert_kind_of Numeric, video.rank
+    assert_kind_of Numeric, video.rank_delta
+    assert_instance_of Time, video.upload_date
+
+    # check the video frame thumbnails
+    assert (video.video_frame_thumbnails && video.video_frame_thumbnails.length > 0)
+    video.video_frame_thumbnails.each { |frame| assert_valid_video_frame_thumbnail(frame) }
+
+    # check the playlist entries
+    assert (video.playlist_entries && video.playlist_entries.length > 0)
+    video.playlist_entries.each { |entry| assert_valid_playlist_entry(entry) }
+  end
+end

data/test/test_video_search.rb

@@ -0,0 +1,89 @@
+require 'rubygems'
+require 'test/unit'
+require 'google-video'
+require File.dirname(__FILE__) + '/video_test_helper'
+
+class TestVideoSearch < Test::Unit::TestCase
+  include VideoTestHelper
+  
+  @@RESULTS_PER_PAGE = 10
+  @@QUERY_STRING = 'tessa'
+  @@DURATION = 'long'
+  @@PAGE = 2
+
+  def setup
+    @client = GoogleVideo::Client.new
+  end
+
+  def test_request_validation
+    # make sure some general valid requests work ok
+    assert_nothing_raised do
+      GoogleVideo::VideoSearchRequest.new(:query => @@QUERY_STRING)
+      GoogleVideo::VideoSearchRequest.new(:query => @@QUERY_STRING, :sort => 'date')
+      GoogleVideo::VideoSearchRequest.new(:query => @@QUERY_STRING, :sort => 'date', :duration => 'all')
+      GoogleVideo::VideoSearchRequest.new(:query => @@QUERY_STRING, :duration => 'all')
+      GoogleVideo::VideoSearchRequest.new(:query => @@QUERY_STRING, :duration => 'all', :page => 2)
+    end
+
+    # make sure an invalid sort is detected
+    assert_raise ArgumentError do
+      GoogleVideo::VideoSearchRequest.new(:query => @@QUERY_STRING, :sort => 'monkey')
+    end
+
+    # make sure an invalid duration is detected
+    assert_raise ArgumentError do
+      GoogleVideo::VideoSearchRequest.new(:query => @@QUERY_STRING, :duration => 'el_pollo_diablo')
+    end
+    
+    # make sure a query string is required
+    assert_raise ArgumentError do
+      GoogleVideo::VideoSearchRequest.new(:duration => 'all')
+    end
+
+    # make sure the video search method requires an appropriate request object
+    assert_raise ArgumentError do
+      @client.video_search "foo"
+    end
+  end
+
+  def test_search
+    request = GoogleVideo::VideoSearchRequest.new(:query => @@QUERY_STRING)
+    response = @client.video_search request
+    assert_valid_search_response response
+    
+    assert_equal response.start_index, 1
+    assert_equal response.end_index, @@RESULTS_PER_PAGE
+    assert (response.total_result_count >= @@RESULTS_PER_PAGE)
+    assert_equal response.videos.length, @@RESULTS_PER_PAGE
+  end
+
+  def test_search_duration
+    request = GoogleVideo::VideoSearchRequest.new(:query => @@QUERY_STRING, :duration => @@DURATION)
+    response = @client.video_search request
+    assert_valid_search_response response
+
+    assert_equal response.start_index, 1
+    assert_equal response.end_index, @@RESULTS_PER_PAGE
+    assert (response.total_result_count >= @@RESULTS_PER_PAGE)
+    assert_equal response.videos.length, @@RESULTS_PER_PAGE
+
+    # TODO: make sure all videos are within the specified duration
+  end
+
+  def test_search_paginate
+    request = GoogleVideo::VideoSearchRequest.new(:query => @@QUERY_STRING, :duration => @@DURATION, :page => @@PAGE)
+    response = @client.video_search request
+    assert_valid_search_response response
+
+    assert_equal response.start_index, @@RESULTS_PER_PAGE + 1
+    max_result_index = @@RESULTS_PER_PAGE * @@PAGE
+    assert_equal response.end_index, ((response.total_result_count < max_result_index) ? response.total_result_count : max_result_index)
+  end
+  
+  def assert_valid_search_response (response)
+    assert_not_nil response
+    assert_valid_google_video_url response.request_url
+    assert (response.execution_time > 0.0)
+    response.videos.each { |video| assert_valid_video(video) }
+  end
+end

data/test/video_test_helper.rb

@@ -0,0 +1,19 @@
+module VideoTestHelper
+  def assert_valid_video (video)
+    assert_not_nil video
+    assert_instance_of GoogleVideo::Video, video
+    assert_instance_of Bignum, video.doc_id
+    assert_valid_google_video_url video.page_url
+    # we don't always have a thumbnail image, e.g. on a detail page request
+    if (video.thumbnail_image_url)
+      assert_valid_google_video_url video.thumbnail_image_url
+    end
+    assert (video.duration && video.duration.length > 0)
+    assert (video.rating_count >= 0)
+    assert (video.star_count >= 0)
+  end
+  
+  def assert_valid_google_video_url (url)
+    assert(url && (url =~ /^http:\/\/video.google.com\//))
+  end  
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.0
+specification_version: 1
+name: google-video
+version: !ruby/object:Gem::Version 
+  version: 0.5.0
+date: 2006-11-09 00:00:00 -08:00
+summary: A Ruby object-oriented interface to Google Video content.
+require_paths: 
+- lib
+email: shaper@wgks.org
+homepage: 
+rubyforge_project: google-video
+description: 
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Walter Korman
+files: 
+- examples/example.rb
+- examples/get-top-videos.rb
+- examples/get-video-details.rb
+- examples/search-videos.rb
+- lib/google-video.rb
+- test/test_client.rb
+- test/test_top_videos.rb
+- test/test_video_details.rb
+- test/test_video_search.rb
+- test/video_test_helper.rb
+- AUTHORS
+- CHANGELOG
+- README
+- Rakefile
+- TODO
+test_files: 
+- test/test_client.rb
+- test/test_top_videos.rb
+- test/test_video_details.rb
+- test/test_video_search.rb
+rdoc_options: 
+- --main
+- README
+extra_rdoc_files: 
+- README
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hpricot
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0.4"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: htmlentities
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 3.0.1
+    version: