youtube-g 0.4.1 → 0.4.9.9

data/lib/youtube_g/response/video_search.rb

@@ -1,23 +1,41 @@
 class YouTubeG
   module Response
     class VideoSearch < YouTubeG::Record
-      # the unique feed identifying url
-      attr_reader :feed_id
+      # *String*:: Unique feed identifying url.
+      attr_reader :feed_id 
       
-      # the number of results per page
+      # *Fixnum*:: Number of results per page.
       attr_reader :max_result_count
       
-      # the 1-based offset index into the full result set
+      # *Fixnum*:: 1-based offset index into the full result set.
       attr_reader :offset
       
-      # the total number of results available for the original request
+      # *Fixnum*:: Total number of results available for the original request.
       attr_reader :total_result_count
 
-      # the date and time at which the feed was last updated
+      # *Time*:: Date and time at which the feed was last updated
       attr_reader :updated_at
 
-      # the list of Video records
+      # *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/test/test_client.rb

@@ -12,7 +12,7 @@ class TestClient < Test::Unit::TestCase
   def test_should_respond_to_a_basic_query
     response = @client.videos_by(:query => "penguin")
   
-    assert_equal "http://gdata.youtube.com/feeds/api/videos?start-index=1&max-results=25&vq=penguin", response.feed_id
+    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
@@ -22,10 +22,40 @@ class TestClient < Test::Unit::TestCase
     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?start-index=1&max-results=25&vq=christina+ricci", response.feed_id
+    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
@@ -35,6 +65,13 @@ class TestClient < Test::Unit::TestCase
     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")
@@ -94,6 +131,13 @@ class TestClient < Test::Unit::TestCase
     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
@@ -102,19 +146,18 @@ class TestClient < Test::Unit::TestCase
   # end
   
   def test_should_get_videos_for_query_search_with_categories_excluded
-    response = @client.videos_by(:query => 'bench press', :categories => { :exclude => [:comedy, :entertainment] },
-                                 :max_results => 10)
-    assert_equal "<object width=\"425\" height=\"350\">\n  <param name=\"movie\" value=\"http://www.youtube.com/v/BlDWdfTAx8o\"></param>\n  <param name=\"wmode\" value=\"transparent\"></param>\n  <embed src=\"http://www.youtube.com/v/BlDWdfTAx8o\" type=\"application/x-shockwave-flash\" \n   wmode=\"transparent\" width=\"425\" height=\"350\"></embed>\n</object>\n", response.videos.first.embed_html
-    response.videos.each { |v| assert_valid_video v }
-  end
-  
-  def test_should_be_able_to_pass_in_logger
-    @client = YouTubeG::Client.new(Logger.new(STDOUT))
-    assert_not_nil @client.logger
+    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_create_logger_if_not_passed_in
+  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
   
@@ -122,19 +165,22 @@ class TestClient < Test::Unit::TestCase
     response = @client.videos_by(:query => "avril lavigne girlfriend")
   
     video = response.videos.first
-    assert !video.can_embed?
+    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.can_embed?
+    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

data/test/test_video.rb

@@ -5,7 +5,6 @@ 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
@@ -15,4 +14,29 @@ class TestVideo < Test::Unit::TestCase
     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/test/test_video_search.rb

@@ -51,23 +51,37 @@ class TestVideoSearch < Test::Unit::TestCase
     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?max-results=10&start-index=5&time=today", 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
-
-  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  
   
   # -- Complex Video Queries -------------------------------------------------------------------------
   
@@ -97,7 +111,7 @@ class TestVideoSearch < Test::Unit::TestCase
     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
+    assert_equal "http://gdata.youtube.com/feeds/api/videos/-/-Comedy/-Entertainment/?max-results=10&vq=bench+press", request.url
   end
   
   # -- User Queries ---------------------------------------------------------------------------------
@@ -107,8 +121,18 @@ class TestVideoSearch < Test::Unit::TestCase
     assert_equal "http://gdata.youtube.com/feeds/api/users/liz/uploads", request.url
   end
   
+  def test_should_build_url_for_videos_by_user_paginate_and_order
+    request = YouTubeG::Request::UserSearch.new(:user => 'liz', :offset => 20, :max_results => 10, :order_by => 'published')
+    assert_equal "http://gdata.youtube.com/feeds/api/users/liz/uploads?max-results=10&orderby=published&start-index=20", 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
+
+  def test_should_build_url_for_favorite_videos_by_user_paginate
+    request = YouTubeG::Request::UserSearch.new(:favorites, :user => 'liz', :offset => 20, :max_results => 10)
+    assert_equal "http://gdata.youtube.com/feeds/api/users/liz/favorites?max-results=10&start-index=20", request.url
+  end
 end

data/youtube-g.gemspec

@@ -0,0 +1,52 @@
+spec = Gem::Specification.new do |s|
+  s.name = 'youtube-g'
+  s.version = '0.4.9.9'
+  s.date = '2008-09-01'
+  s.summary = 'An object-oriented Ruby wrapper for the YouTube GData API'
+  s.email = "ruby-youtube-library@googlegroups.com"
+  s.homepage = "http://youtube-g.rubyforge.org/"
+  s.description = "An object-oriented Ruby wrapper for the YouTube GData API"
+  s.has_rdoc = true
+  s.authors = ["Shane Vitarana", "Walter Korman", "Aman Gupta", "Filip H.F. Slagter"]
+
+  # ruby -rpp -e "pp Dir['**/*.*'].map"
+  s.files = [
+    "History.txt",
+     "lib/youtube_g/client.rb",
+     "lib/youtube_g/logger.rb",
+     "lib/youtube_g/model/author.rb",
+     "lib/youtube_g/model/category.rb",
+     "lib/youtube_g/model/contact.rb",
+     "lib/youtube_g/model/content.rb",
+     "lib/youtube_g/model/playlist.rb",
+     "lib/youtube_g/model/rating.rb",
+     "lib/youtube_g/model/thumbnail.rb",
+     "lib/youtube_g/model/user.rb",
+     "lib/youtube_g/model/video.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",
+     "lib/youtube_g.rb",
+     "Manifest.txt",
+     "README.txt",
+     "test/test_client.rb",
+     "test/test_video.rb",
+     "test/test_video_search.rb",
+     "TODO.txt",
+     "youtube-g.gemspec"
+  ]
+
+  s.test_files = [
+    "test/test_client.rb",
+    "test/test_video.rb",
+    "test/test_video_search.rb"
+  ]
+
+  s.rdoc_options = ["--main", "README.txt"]
+  s.extra_rdoc_files = ["History.txt", "README.txt"]
+end

metadata

@@ -1,41 +1,32 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.4
-specification_version: 1
 name: youtube-g
 version: !ruby/object:Gem::Version 
-  version: 0.4.1
-date: 2008-02-11 00:00:00 -06:00
-summary: Ruby client for the YouTube GData API
-require_paths: 
-- lib
-email: shanev@gmail.com
-homepage: http://rubyforge.org/projects/youtube-g/
-rubyforge_project: youtube-g
-description: "youtube-g is a pure Ruby client for the YouTube GData API. It provides an easy way to access the latest YouTube video search results from your own programs. In comparison with the earlier Youtube search interfaces, this new API and library offers much-improved flexibility around executing complex search queries to obtain well-targeted video search results.  More detail on the underlying source Google-provided API is available at:  http://code.google.com/apis/youtube/overview.html  == FEATURES/PROBLEMS:  * Aims to be in parity with Google's YouTube GData API.  Core functionality is currently present -- work is in progress to fill in the rest.  == SYNOPSIS:  Create a client:  require 'rubygems' require 'youtube_g' client = YouTubeG::Client.new  Basic queries:  client.videos_by(:query => \"penguin\") client.videos_by(:tags => ['tiger', 'leopard']) client.videos_by(:categories => [:news, :sports]) client.videos_by(:categories => [:news, :sports], :tags => ['soccer', 'football']) client.videos_by(:user => 'liz')  Standard feeds:  client.videos_by(:most_viewed) client.videos_by(:top_rated, :time => :today)  Advanced queries (with boolean operators OR (either), AND (include), NOT (exclude)):  client.videos_by(:categories => { :either => [:news, :sports], :exclude => [:comedy] }, :tags => { :include => ['football'], :exclude => ['soccer'] })"
-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: 
+  version: 0.4.9.9
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - Shane Vitarana
 - Walter Korman
-files: 
+- Aman Gupta
+- Filip H.F. Slagter
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-09-01 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: An object-oriented Ruby wrapper for the YouTube GData API
+email: ruby-youtube-library@googlegroups.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
 - History.txt
-- Manifest.txt
 - README.txt
-- Rakefile
-- TODO.txt
-- lib/youtube_g.rb
+files: 
+- History.txt
 - lib/youtube_g/client.rb
 - lib/youtube_g/logger.rb
 - lib/youtube_g/model/author.rb
@@ -49,36 +40,48 @@ files:
 - lib/youtube_g/model/video.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
+- lib/youtube_g.rb
+- Manifest.txt
+- README.txt
 - test/test_client.rb
 - test/test_video.rb
 - test/test_video_search.rb
-test_files: 
-- test/test_client.rb
-- test/test_video.rb
-- test/test_video_search.rb
+- TODO.txt
+- youtube-g.gemspec
+has_rdoc: true
+homepage: http://youtube-g.rubyforge.org/
+post_install_message: 
 rdoc_options: 
 - --main
 - README.txt
-extra_rdoc_files: 
-- History.txt
-- Manifest.txt
-- README.txt
-- TODO.txt
-executables: []
-
-extensions: []
-
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
 requirements: []
 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: hoe
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.5.0
-    version: 
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: An object-oriented Ruby wrapper for the YouTube GData API
+test_files: 
+- test/test_client.rb
+- test/test_video.rb
+- test/test_video_search.rb