msp-youtube-g 0.4.7 → 0.4.8.1

data/lib/youtube_g/response/video_search.rb

@@ -1,22 +1,22 @@
 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
     end
   end

data/test/search.xml

@@ -0,0 +1,66 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<feed xmlns='http://www.w3.org/2005/Atom' xmlns:openSearch='http://a9.com/-/spec/opensearchrss/1.0/'
+      xmlns:gml='http://www.opengis.net/gml' xmlns:georss='http://www.georss.org/georss'
+      xmlns:media='http://search.yahoo.com/mrss/' xmlns:yt='http://gdata.youtube.com/schemas/2007'
+      xmlns:gd='http://schemas.google.com/g/2005'>
+  <id>http://gdata.youtube.com/feeds/api/users/speechboxmatt/uploads</id>
+  <updated>2008-06-28T16:34:33.062Z</updated>
+  <category scheme='http://schemas.google.com/g/2005#kind' term='http://gdata.youtube.com/schemas/2007#video'/>
+  <title type='text'>Videos of speechboxmatt</title>
+  <logo>http://www.youtube.com/img/pic_youtubelogo_123x63.gif</logo>
+  <link rel='related' type='application/atom+xml' href='http://gdata.youtube.com/feeds/api/users/speechboxmatt'/>
+  <link rel='alternate' type='text/html' href='http://www.youtube.com/profile_videos?user=speechboxmatt'/>
+  <link rel='http://schemas.google.com/g/2005#feed' type='application/atom+xml'
+        href='http://gdata.youtube.com/feeds/api/users/speechboxmatt/uploads'/>
+  <link rel='self' type='application/atom+xml'
+        href='http://gdata.youtube.com/feeds/api/users/speechboxmatt/uploads?start-index=1&amp;max-results=25'/>
+  <author>
+    <name>speechboxmatt</name>
+    <uri>http://gdata.youtube.com/feeds/api/users/speechboxmatt</uri>
+  </author>
+  <generator version='beta' uri='http://gdata.youtube.com/'>YouTube data API</generator>
+  <openSearch:totalResults>1</openSearch:totalResults>
+  <openSearch:startIndex>1</openSearch:startIndex>
+  <openSearch:itemsPerPage>25</openSearch:itemsPerPage>
+  <entry>
+    <id>http://gdata.youtube.com/feeds/api/videos/32_mQ0PRT9I</id>
+    <published>2008-06-28T09:01:58.000-07:00</published>
+    <updated>2008-06-28T09:03:18.000-07:00</updated>
+    <category scheme='http://gdata.youtube.com/schemas/2007/categories.cat' term='People' label='People &amp; Blogs'/>
+    <category scheme='http://schemas.google.com/g/2005#kind' term='http://gdata.youtube.com/schemas/2007#video'/>
+    <category scheme='http://gdata.youtube.com/schemas/2007/keywords.cat' term='test'/>
+    <category scheme='http://gdata.youtube.com/schemas/2007/keywords.cat' term='blah'/>
+    <category scheme='http://gdata.youtube.com/schemas/2007/keywords.cat' term='cool'/>
+    <title type='text'>Speechbox Test</title>
+    <content type='text'>Speechbox test Uploaded on 06/28/2008 at 05:01PM</content>
+    <link rel='alternate' type='text/html' href='http://www.youtube.com/watch?v=32_mQ0PRT9I'/>
+    <link rel='http://gdata.youtube.com/schemas/2007#video.responses' type='application/atom+xml'
+          href='http://gdata.youtube.com/feeds/api/videos/32_mQ0PRT9I/responses'/>
+    <link rel='http://gdata.youtube.com/schemas/2007#video.related' type='application/atom+xml'
+          href='http://gdata.youtube.com/feeds/api/videos/32_mQ0PRT9I/related'/>
+    <link rel='self' type='application/atom+xml'
+          href='http://gdata.youtube.com/feeds/api/users/speechboxmatt/uploads/32_mQ0PRT9I'/>
+    <author>
+      <name>speechboxmatt</name>
+      <uri>http://gdata.youtube.com/feeds/api/users/speechboxmatt</uri>
+    </author>
+    <media:group>
+      <media:title type='plain'>Speechbox Test</media:title>
+      <media:description type='plain'>Speechbox test Uploaded on 06/28/2008 at 05:01PM</media:description>
+      <media:keywords>blah, cool, test</media:keywords>
+      <yt:duration seconds='15'/>
+      <media:category label='People &amp; Blogs' scheme='http://gdata.youtube.com/schemas/2007/categories.cat'>People
+      </media:category>
+      <media:content url='http://www.youtube.com/v/32_mQ0PRT9I' type='application/x-shockwave-flash' medium='video'
+                     isDefault='true' expression='full' duration='15' yt:format='5'/>
+      <media:player url='http://www.youtube.com/watch?v=32_mQ0PRT9I'/>
+      <media:thumbnail url='http://img.youtube.com/vi/32_mQ0PRT9I/2.jpg' height='97' width='130' time='00:00:07.500'/>
+      <media:thumbnail url='http://img.youtube.com/vi/32_mQ0PRT9I/1.jpg' height='97' width='130' time='00:00:03.750'/>
+      <media:thumbnail url='http://img.youtube.com/vi/32_mQ0PRT9I/3.jpg' height='97' width='130' time='00:00:11.250'/>
+      <media:thumbnail url='http://img.youtube.com/vi/32_mQ0PRT9I/0.jpg' height='240' width='320' time='00:00:07.500'/>
+    </media:group>
+    <gd:comments>
+      <gd:feedLink href='http://gdata.youtube.com/feeds/api/videos/32_mQ0PRT9I/comments' countHint='0'/>
+    </gd:comments>
+  </entry>
+</feed>

data/test/test_parser.rb

@@ -0,0 +1,172 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/youtube_g'  
+
+class TestParser < Test::Unit::TestCase           
+  
+  UPLOAD_XML = File.new(File.dirname(__FILE__) +"/upload.xml")                        
+  SEARCH_XML = File.new(File.dirname(__FILE__) +"/search.xml")
+             
+  YT_VALIDATION = "yt:validation"      
+  REQUIRED = "required"                                   
+  TEXT_XPATH = "media:group/media:title/text()"           
+  DESC_XPATH = "media:group/media:description/text()"  
+  
+  def setup
+    @ue_parser = YouTubeG::Parser::UploadErrorParser.new(well_formed_errors_xml)
+    @ue_parser_result = @ue_parser.parse               
+    
+    @vf_parser = YouTubeG::Parser::VideoFeedParser.new(UPLOAD_XML.path)
+    @vf_parser_result = @vf_parser.parse               
+    
+    @vfs_parser = YouTubeG::Parser::VideosFeedParser.new(SEARCH_XML.path)
+    @vfs_parser_result = @vfs_parser.parse               
+  end
+                    
+  def test_feed_parser_error_for_empty_xml          
+    assert_raise YouTubeG::Parser::FeedParserError do
+      parser = YouTubeG::Parser::UploadErrorParser.new("")
+    end
+  end     
+  
+  def test_upload_error_parser     
+    assert_instance_of(Array, @ue_parser_result)       
+    assert_equal(2,@ue_parser_result.length)
+    
+    @ue_parser_result.each_with_index do |error, i|                        
+      assert_instance_of(YouTubeG::Model::UploadError, error)
+      assert_equal(YT_VALIDATION,error.domain)
+      assert_equal(REQUIRED,error.code)
+      assert_equal(i == 0 ? TEXT_XPATH : DESC_XPATH,error.location)      
+    end
+  end                                         
+   
+  def test_videos_feed_parser        
+    assert_instance_of(YouTubeG::Response::VideoSearch, @vfs_parser_result)       
+    assert_equal("http://gdata.youtube.com/feeds/api/users/speechboxmatt/uploads",@vfs_parser_result.feed_id)
+    assert_equal(25,@vfs_parser_result.max_result_count)
+    assert_equal(1,@vfs_parser_result.offset)
+    assert_equal(1,@vfs_parser_result.total_result_count)
+    assert_equal(Time.parse("2008-06-28T16:34:33.062Z"),@vfs_parser_result.updated_at)
+    assert_equal(1,@vfs_parser_result.videos.length)
+    
+    @vfs_parser_result.videos.each_with_index do |video, i|                        
+      assert_instance_of(YouTubeG::Model::Video, video)
+      # assert_equal(15,video.duration)
+      assert_equal(false,video.noembed)
+      assert_equal(false,video.racy)
+      assert_equal("http://gdata.youtube.com/feeds/api/videos/32_mQ0PRT9I",video.video_id)
+      assert_equal(Time.parse("2008-06-28T09:01:58.000-07:00"),video.published_at)
+      assert_equal(Time.parse("2008-06-28T09:03:18.000-07:00"),video.updated_at)
+                     
+      # Categories
+      assert_equal(1,video.categories.length)
+      assert_equal("People & Blogs",video.categories[0].label)
+      assert_equal("People",video.categories[0].term)
+      # Keywords
+      assert_equal(3,video.keywords.length)  
+      assert_equal("test",video.keywords[0]) 
+      assert_equal("blah",video.keywords[1])
+      assert_equal("cool",video.keywords[2])
+      
+      assert_equal("Speechbox test Uploaded on 06/28/2008 at 05:01PM",video.description)
+      assert_equal("Speechbox Test",video.title)
+      assert_equal("Speechbox test Uploaded on 06/28/2008 at 05:01PM",video.html_content)
+      assert_equal("speechboxmatt",video.author.name)
+      assert_equal("http://gdata.youtube.com/feeds/api/users/speechboxmatt",video.author.uri)
+      
+      # Media Content
+      assert_equal(1,video.media_content.length)
+      assert_equal(true,video.media_content[0].default) 
+      assert_equal(15,video.media_content[0].duration)     
+      assert_equal("application/x-shockwave-flash",video.media_content[0].mime_type) 
+                           
+      # Thumbs                     
+      assert_equal(4,video.thumbnails.length)
+      # first thumb
+      assert_equal("http://img.youtube.com/vi/32_mQ0PRT9I/2.jpg",video.thumbnails[0].url)
+      assert_equal(97,video.thumbnails[0].height)
+      assert_equal(130,video.thumbnails[0].width)
+      assert_equal("00:00:07.500",video.thumbnails[0].time)
+      # forth thumb
+      assert_equal("http://img.youtube.com/vi/32_mQ0PRT9I/0.jpg",video.thumbnails[3].url)
+      assert_equal(240,video.thumbnails[3].height)
+      assert_equal(320,video.thumbnails[3].width)
+      assert_equal("00:00:07.500",video.thumbnails[3].time)
+      
+      assert_equal("http://www.youtube.com/watch?v=32_mQ0PRT9I",video.player_url)
+    end
+  end
+ 
+  def test_video_feed_parser_derives_content_source_as_url
+    vf_parser = YouTubeG::Parser::VideoFeedParser.new(UPLOAD_XML.path)
+    assert_equal(true,vf_parser.url_based?)
+  end
+             
+  def test_video_feed_parser_derives_content_source_as_string
+    vf_parser = YouTubeG::Parser::VideoFeedParser.new(UPLOAD_XML.read)
+    assert_equal(false,vf_parser.url_based?)
+  end
+             
+  def test_video_feed_parser             
+    video = @vf_parser_result
+    assert_instance_of(YouTubeG::Model::Video, video)       
+
+    assert_equal(false,video.noembed)
+    assert_equal(false,video.racy)
+    assert_equal("http://gdata.youtube.com/feeds/api/videos/7ARaD731I24",video.video_id)
+    assert_equal(Time.parse("2008-07-11T05:02:24.501-07:00"),video.published_at)
+    assert_equal(Time.parse("2008-07-11T05:02:24.501-07:00"),video.updated_at) 
+    
+    # App control - state of the upload
+    assert_equal("yes", video.app_control.draft)
+    assert_equal("processing", video.app_control.state)
+                   
+    # Categories
+    assert_equal(1,video.categories.length)
+    assert_equal("People & Blogs",video.categories[0].label)
+    assert_equal("People",video.categories[0].term)
+    # Keywords
+    assert_equal(3,video.keywords.length)  
+    assert_equal("test",video.keywords[0]) 
+    assert_equal("blah",video.keywords[1])
+    assert_equal("cool",video.keywords[2])
+    
+    assert_equal("Speechbox test Uploaded on 07/11/2008 at 01:02PM",video.description)
+    assert_equal("Speechbox Test 07/11/2008 at 01:02PM",video.title)
+    assert_equal("Speechbox test Uploaded on 07/11/2008 at 01:02PM",video.html_content)
+    assert_equal("speechboxmatt",video.author.name)
+    assert_equal("http://gdata.youtube.com/feeds/api/users/speechboxmatt",video.author.uri)
+    
+    # Media Content
+    assert_equal(1,video.media_content.length)
+    assert_equal(true,video.media_content[0].default) 
+    assert_equal("application/x-shockwave-flash",video.media_content[0].mime_type) 
+  end
+          
+  def well_formed_errors_xml   
+    errors_xml = ''
+    errors_xml << "<?xml version='1.0' encoding='UTF-8'?>"
+    errors_xml << "<errors>"
+    errors_xml << "  <error>"
+    errors_xml << "    <domain>#{YT_VALIDATION}</domain>"
+    errors_xml << "    <code>#{REQUIRED}</code>"
+    errors_xml << "    <location type='xpath'>#{TEXT_XPATH}</location>"
+    errors_xml << "  </error>"
+    errors_xml << "  <error>"
+    errors_xml << "    <domain>#{YT_VALIDATION}</domain>"
+    errors_xml << "    <code>#{REQUIRED}</code>"
+    errors_xml << "    <location type='xpath'>#{DESC_XPATH}</location>"
+    errors_xml << "  </error>"
+    errors_xml << "</errors>"      
+  end   
+  
+  def malformed_errors_xml   
+    errors_xml = ''
+    errors_xml << "<errors>"
+    errors_xml << "  <error>"
+    errors_xml << "    <domain>yt:validation</domain>"
+    errors_xml << "    <code>required</code>"
+    errors_xml << "    <location type='xpath'>media:group/media:title/text()</location>"
+    errors_xml << "</errors>"      
+  end                        
+end

data/test/test_upload.rb

@@ -0,0 +1,79 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/youtube_g'
+
+class TestClient < Test::Unit::TestCase
+  
+  def setup
+    @uploader = YouTubeG::Upload::VideoUpload.new("user","pswd","dev_key")               
+    @uploader.auth_token = "auth_token_for_testing" 
+    @response = nil
+  end
+
+  def test_logger_still_active_without_rails_default       
+    if Object.const_defined?(@uploader.get_rails_default_logger_name)
+      assert_not_nil "Expected a #{@uploader.get_rails_default_logger_name}", @uploader.logger
+    else
+      assert_not_nil "Expected a Logger.new", @uploader.logger            
+    end  
+  end 
+  
+  def test_passing_auth_token_in_constructor         
+    upload = YouTubeG::Upload::VideoUpload.new("user","pswd","dev_key")
+    assert_nil upload.auth_token  
+    
+    upload = YouTubeG::Upload::VideoUpload.new("user","pswd","dev_key","client_id", :test_token)
+    assert_equal :test_token, upload.auth_token
+  end   
+                        
+  def test_authentication_error_raised_for_403           
+    Net::HTTP.module_eval do 
+      def post(post,data,header)
+        response =  Net::HTTPForbidden.new("403","403","403")
+      end                                
+    end
+
+    assert_raise YouTubeG::Upload::AuthenticationError do          
+      @response = @uploader.upload("a_file")
+    end                                          
+  end     
+  
+  def test_upload_error_raised_for_400
+    Net::HTTP.module_eval do 
+      def post(post,data,header)
+        response =  YTErrors.new("400","400","400")
+      end                                
+    end
+
+    assert_raise YouTubeG::Upload::UploadError do          
+      response = @uploader.upload("a_file")
+    end
+  end     
+              
+  # stubs
+  class Net::HTTPForbidden < Net::HTTPClientError # 403
+    def body
+      return "ERROR=redefined_body_for_testing_only"
+    end
+  end 
+  
+  class YTErrors < Net::HTTPClientError
+    def body   
+      errors_xml = ''
+      errors_xml << "<?xml version='1.0' encoding='UTF-8'?>"
+      errors_xml << "<errors>"
+      errors_xml << "  <error>"
+      errors_xml << "    <domain>yt:validation</domain>"
+      errors_xml << "    <code>required</code>"
+      errors_xml << "    <location type='xpath'>media:group/media:title/text()</location>"
+      errors_xml << "  </error>"
+      errors_xml << "  <error>"
+      errors_xml << "    <domain>yt:validation</domain>"
+      errors_xml << "    <code>required</code>"
+      errors_xml << "    <location type='xpath'>media:group/media:description/text()</location>"
+      errors_xml << "  </error>"
+      errors_xml << "</errors>"      
+    end
+  end 
+  
+                       
+end

data/test/upload.xml

@@ -0,0 +1,51 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<entry xmlns='http://www.w3.org/2005/Atom' xmlns:gml='http://www.opengis.net/gml'
+       xmlns:georss='http://www.georss.org/georss' xmlns:media='http://search.yahoo.com/mrss/'
+       xmlns:batch='http://schemas.google.com/gdata/batch' xmlns:yt='http://gdata.youtube.com/schemas/2007'
+       xmlns:gd='http://schemas.google.com/g/2005'>
+  <id>http://gdata.youtube.com/feeds/api/videos/7ARaD731I24</id>
+  <published>2008-07-11T05:02:24.501-07:00</published>
+  <updated>2008-07-11T05:02:24.501-07:00</updated>
+  <app:control xmlns:app='http://purl.org/atom/app#'>
+    <app:draft>yes</app:draft>
+    <yt:state name='processing'/>
+  </app:control>
+  <category scheme='http://gdata.youtube.com/schemas/2007/categories.cat' term='People' label='People &amp; Blogs'/>
+  <category scheme='http://schemas.google.com/g/2005#kind' term='http://gdata.youtube.com/schemas/2007#video'/>
+  <category scheme='http://gdata.youtube.com/schemas/2007/keywords.cat' term='test'/>
+  <category scheme='http://gdata.youtube.com/schemas/2007/keywords.cat' term='blah'/>
+  <category scheme='http://gdata.youtube.com/schemas/2007/keywords.cat' term='cool'/>
+  <title type='text'>Speechbox Test 07/11/2008 at 01:02PM</title>
+  <content type='text'>Speechbox test Uploaded on 07/11/2008 at 01:02PM</content>
+  <link rel='alternate' type='text/html' href='http://www.youtube.com/my_videos_edit?ns=1&amp;video_id=7ARaD731I24'/>
+  <link rel='http://gdata.youtube.com/schemas/2007#video.responses' type='application/atom+xml'
+        href='http://gdata.youtube.com/feeds/api/videos/7ARaD731I24/responses?client=ytapi-Speechbox-SpeechboxBackend-tvjvg8lf-0'/>
+  <link rel='http://gdata.youtube.com/schemas/2007#video.ratings' type='application/atom+xml'
+        href='http://gdata.youtube.com/feeds/api/videos/7ARaD731I24/ratings?client=ytapi-Speechbox-SpeechboxBackend-tvjvg8lf-0'/>
+  <link rel='http://gdata.youtube.com/schemas/2007#video.complaints' type='application/atom+xml'
+        href='http://gdata.youtube.com/feeds/api/videos/7ARaD731I24/complaints?client=ytapi-Speechbox-SpeechboxBackend-tvjvg8lf-0'/>
+  <link rel='http://gdata.youtube.com/schemas/2007#video.related' type='application/atom+xml'
+        href='http://gdata.youtube.com/feeds/api/videos/7ARaD731I24/related?client=ytapi-Speechbox-SpeechboxBackend-tvjvg8lf-0'/>
+  <link rel='self' type='application/atom+xml'
+        href='http://gdata.youtube.com/feeds/api/users/speechboxmatt/uploads/7ARaD731I24?client=ytapi-Speechbox-SpeechboxBackend-tvjvg8lf-0'/>
+  <link rel='edit' type='application/atom+xml'
+        href='http://gdata.youtube.com/feeds/api/users/speechboxmatt/uploads/7ARaD731I24?client=ytapi-Speechbox-SpeechboxBackend-tvjvg8lf-0'/>
+  <author>
+    <name>speechboxmatt</name>
+    <uri>http://gdata.youtube.com/feeds/api/users/speechboxmatt</uri>
+  </author>
+  <media:group>
+    <media:title type='plain'>Speechbox Test 07/11/2008 at 01:02PM</media:title>
+    <media:description type='plain'>Speechbox test Uploaded on 07/11/2008 at 01:02PM</media:description>
+    <media:keywords>blah, cool, test</media:keywords>
+    <media:category label='People &amp; Blogs' scheme='http://gdata.youtube.com/schemas/2007/categories.cat'>People
+    </media:category>
+    <media:content url='http://www.youtube.com/v/7ARaD731I24' type='application/x-shockwave-flash' medium='video'
+                   isDefault='true' expression='full' yt:format='5'/>
+  </media:group>
+  <gd:comments>
+    <gd:feedLink
+            href='http://gdata.youtube.com/feeds/api/videos/7ARaD731I24/comments?client=ytapi-Speechbox-SpeechboxBackend-tvjvg8lf-0'
+            countHint='0'/>
+  </gd:comments>
+</entry>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: msp-youtube-g
 version: !ruby/object:Gem::Version 
-  version: 0.4.7
+  version: 0.4.8.1
 platform: ruby
 authors: 
 - Shane Vitarana
@@ -13,7 +13,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-06-08 00:00:00 -07:00
+date: 2008-07-25 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -45,14 +45,22 @@ files:
 - lib/youtube_g/model/thumbnail.rb
 - lib/youtube_g/model/user.rb
 - 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
-- test/test_client.rb
-- test/test_video.rb
-- test/test_video_search.rb
+- integration-test/test_client.rb
+- integration-test/test_video.rb
+- integration-test/test_video_search.rb
+- test/test_parser.rb
+- test/test_upload.rb
+- test/search.xml
+- test/upload.xml
 has_rdoc: true
 homepage: http://youtube-g.rubyforge.org/
 post_install_message: 
@@ -81,6 +89,5 @@ 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
+- test/test_parser.rb
+- test/test_upload.rb