msp-youtube-g 0.4.8.1 → 0.4.8.3

data/History.txt

@@ -1,4 +1,5 @@
-== trunk
+== trunk    
+* Create a method to check the status of the uploaded video by status URL [msp]
 * 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]

data/lib/youtube_g.rb

@@ -26,5 +26,5 @@ require File.dirname(__FILE__) + '/youtube_g/request/video_search'
 require File.dirname(__FILE__) + '/youtube_g/response/video_search'
 
 class YouTubeG #:nodoc:
-  VERSION = '0.4.8.1'
+  VERSION = '0.4.8.3'
 end

data/lib/youtube_g/client.rb

@@ -61,16 +61,34 @@ class YouTubeG
     # Retrieves a single YouTube video.
     #
     # === Parameters
-    #   vid<String>:: The ID or URL of the video that you'd like to retrieve.
+    #   vid<String>:: The ID or URL of the video that you'd like to retrieve. If your uncertain
+    # of the processed state use video_processed_by_youtube? first else this will fail.
     # 
     # === Returns
     # YouTubeG::Model::Video
     def video_by(vid)
-      video_id = vid =~ /^http/ ? vid : "http://gdata.youtube.com/feeds/videos/#{vid}"
+      video_id = vid =~ /^http/ ? vid : "http://gdata.youtube.com/feeds/api/videos/#{vid}"
       parser = YouTubeG::Parser::VideoFeedParser.new(video_id)
-      parser.parse
-    end
-    
+      parser.parse      
+    end                        
+
+    # Checks the status of a users uploaded video.
+    #
+    # === Parameters
+    #   status_url<String>:: The URL returned by YT when the video was uploaded e.g.
+    #
+    #   http://gdata.youtube.com/feeds/api/users/speechboxmatt/uploads/QR1sWOVqxoM
+    #
+    #   This is stored on upload as Video.status_url 
+    # === Returns
+    # Boolean   
+    def video_by_status_url(status_url)
+      parser = YouTubeG::Parser::VideoFeedParser.new(status_url)
+      video = parser.parse   
+      return video      
+    end    
+      
+         
     private
     
     def calculate_offset(page, per_page)

data/lib/youtube_g/model/video.rb

@@ -59,7 +59,10 @@ class YouTubeG
       # Used in video uploads only to check the state of the upload
       class AppControl < YouTubeG::Record
          attr_reader :draft
-         attr_reader :state
+         attr_reader :state 
+         attr_reader :reason 
+         attr_reader :help_url 
+         attr_reader :description 
       end
             
       # *Fixnum*:: Duration of a video in seconds.
@@ -113,6 +116,9 @@ class YouTubeG
       # *String*:: The link to watch the URL on YouTubes website.
       attr_reader :player_url
       
+      # *String*:: The URL to check the processing status of the video at YT.
+      attr_reader :status_url
+      
       # YouTubeG::Model::Rating:: Information about the videos rating.
       attr_reader :rating
       
@@ -187,6 +193,15 @@ EDOC
       #   String: Absolute URL for embedding video
       def embed_url
         @player_url.sub('watch?', '').sub('=', '/')          
+      end      
+      
+      # Has this vid been processed by YT?
+      #
+      # === Returns
+      #   Boolean
+      def processed?
+        return true if self.app_control == nil
+        return false if self.app_control.state.upcase == 'PROCESSING' || self.app_control.state.upcase == 'REJECTED' || self.app_control.state.upcase == 'FAILED'
       end
       
     end

data/lib/youtube_g/parser.rb

@@ -68,7 +68,10 @@ class YouTubeG
         if app_control_element
           app_control = YouTubeG::Model::Video::AppControl.new(
                      :draft => app_control_element.elements["app:draft"].text,
-                     :state => app_control_element.elements["yt:state"].attributes["name"])
+                     :state => app_control_element.elements["yt:state"].attributes["name"],
+                     :reason => app_control_element.elements["yt:state"].attributes["reasonCode"],
+                     :help_url => app_control_element.elements["yt:state"].attributes["helpUrl"],
+                     :description => app_control_element.elements["yt:state"].text)                               
         end        
 
         # parse the category and keyword lists
@@ -136,7 +139,12 @@ class YouTubeG
         view_count = (el = entry.elements["yt:statistics"]) ? el.attributes["viewCount"].to_i : 0
 
         noembed = entry.elements["yt:noembed"] ? true : false
-        racy = entry.elements["media:rating"] ? true : false
+        racy = entry.elements["media:rating"] ? true : false   
+                       
+        status_url = nil
+        entry.elements.each("link") do |el|  
+          status_url = el.attributes["href"] if el.attributes["rel"] == "self"
+        end
 
         YouTubeG::Model::Video.new(
           :video_id => video_id,
@@ -156,7 +164,8 @@ class YouTubeG
           :rating => rating,
           :view_count => view_count,
           :noembed => noembed,
-          :racy => racy)
+          :racy => racy,
+          :status_url => status_url)
       end
 
       def parse_media_content (media_content_element) 

data/lib/youtube_g/request/video_upload.rb

@@ -79,9 +79,13 @@ class YouTubeG
           response = upload.post(direct_upload_url, upload_body, upload_header)
           # todo parse this out also
           if response.code.to_i == 403                      
+            logger.error("ERROR: #{response.code}")
             raise AuthenticationError, response.body[/<TITLE>(.+)<\/TITLE>/, 1]
-          elsif response.code.to_i != 201    
+          elsif response.code.to_i != 201               
+            logger.error("ERROR: #{response.code}")
+            logger.debug("response: #{response.body}")
             upload_errors = YouTubeG::Parser::UploadErrorParser.new(response.body).parse
+            logger.debug("upload_errors: #{upload_errors}")
             raise UploadError, upload_errors.inspect
           end 
           return YouTubeG::Parser::VideoFeedParser.new(response.body).parse

data/test/status.xml

@@ -0,0 +1,47 @@
+<?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/QR1sWOVqxoM</id>
+    <published>2008-08-22T04:07:16.000-07:00</published>
+    <updated>2008-08-22T04:07:16.000-07:00</updated>
+    <app:control xmlns:app='http://purl.org/atom/app#'>
+	    <app:draft>yes</app:draft>
+	    <yt:state name='rejected' 
+	        reasonCode='tooLong'
+	        helpUrl='http://www.youtube.com/t/community_guidelines'>Video is too long.</yt:state>
+    </app:control>              
+    <category scheme='http://gdata.youtube.com/schemas/2007/keywords.cat' term='speechbox'/>
+    <category scheme='http://gdata.youtube.com/schemas/2007/categories.cat' term='Film' label='Film &amp; Animation'/>
+    <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='wordia'/>
+    <title type='text'>discombobulate [08/22/2008 at 12:06PM]</title>
+    <content type='text'>To throw into a state of confusion; to befuddle or perplex</content>
+    <link rel='alternate' type='text/html' href='http://www.youtube.com/my_videos_edit?ns=1&amp;video_id=QR1sWOVqxoM'/>
+    <link rel='http://gdata.youtube.com/schemas/2007#video.responses' type='application/atom+xml'
+          href='http://gdata.youtube.com/feeds/api/videos/QR1sWOVqxoM/responses'/>
+    <link rel='http://gdata.youtube.com/schemas/2007#video.related' type='application/atom+xml'
+          href='http://gdata.youtube.com/feeds/api/videos/QR1sWOVqxoM/related'/>
+    <link rel='self' type='application/atom+xml'
+          href='http://gdata.youtube.com/feeds/api/users/speechboxmatt/uploads/QR1sWOVqxoM'/>
+    <author>
+        <name>speechboxmatt</name>
+        <uri>http://gdata.youtube.com/feeds/api/users/speechboxmatt</uri>
+    </author>
+    <media:group>
+        <media:title type='plain'>discombobulate [08/22/2008 at 12:06PM]</media:title>
+        <media:description type='plain'>To throw into a state of confusion; to befuddle or perplex</media:description>
+        <media:keywords>speechbox, wordia</media:keywords>
+        <yt:duration seconds='0'/>
+        <media:category label='Film &amp; Animation' scheme='http://gdata.youtube.com/schemas/2007/categories.cat'>
+            Film
+        </media:category>
+        <media:content url='http://www.youtube.com/v/QR1sWOVqxoM&amp;f=gdata_user_uploads'
+                       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/QR1sWOVqxoM/comments' countHint='0'/>
+    </gd:comments>
+</entry>

data/test/test_parser.rb

@@ -4,7 +4,8 @@ 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")
+  SEARCH_XML = File.new(File.dirname(__FILE__) +"/search.xml")       
+  YOUTUBE_STATUS_XML = File.new(File.dirname(__FILE__) +"/status.xml")
              
   YT_VALIDATION = "yt:validation"      
   REQUIRED = "required"                                   
@@ -18,6 +19,10 @@ class TestParser < Test::Unit::TestCase
     @vf_parser = YouTubeG::Parser::VideoFeedParser.new(UPLOAD_XML.path)
     @vf_parser_result = @vf_parser.parse               
     
+    # video feed error
+    @vfe_parser = YouTubeG::Parser::VideoFeedParser.new(YOUTUBE_STATUS_XML.path)
+    @vfe_parser_result = @vfe_parser.parse               
+    
     @vfs_parser = YouTubeG::Parser::VideosFeedParser.new(SEARCH_XML.path)
     @vfs_parser_result = @vfs_parser.parse               
   end
@@ -93,7 +98,9 @@ class TestParser < Test::Unit::TestCase
       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)
+      assert_equal("http://www.youtube.com/watch?v=32_mQ0PRT9I",video.player_url)  
+      
+      assert_equal("http://gdata.youtube.com/feeds/api/users/speechboxmatt/uploads/32_mQ0PRT9I",video.status_url);
     end
   end
  
@@ -143,6 +150,21 @@ class TestParser < Test::Unit::TestCase
     assert_equal("application/x-shockwave-flash",video.media_content[0].mime_type) 
   end
           
+  def test_video_feed_parser_with_error_status             
+    video = @vfe_parser_result
+    assert_instance_of(YouTubeG::Model::Video, video)       
+
+    assert_equal("http://gdata.youtube.com/feeds/api/videos/QR1sWOVqxoM",video.video_id)
+    
+    # App control - state of the upload
+    assert_equal("yes", video.app_control.draft)
+    assert_equal("rejected", video.app_control.state)             
+    # these populated only if errored
+    assert_equal("tooLong", video.app_control.reason)
+    assert_equal("http://www.youtube.com/t/community_guidelines", video.app_control.help_url)
+    assert_equal("Video is too long.", video.app_control.description)
+  end
+          
   def well_formed_errors_xml   
     errors_xml = ''
     errors_xml << "<?xml version='1.0' encoding='UTF-8'?>"
@@ -169,4 +191,4 @@ class TestParser < Test::Unit::TestCase
     errors_xml << "    <location type='xpath'>media:group/media:title/text()</location>"
     errors_xml << "</errors>"      
   end                        
-end
+end  

data/test/test_video.rb

@@ -0,0 +1,26 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/youtube_g'  
+
+class TestVideo < Test::Unit::TestCase           
+    
+  def test_processed_method_for_nil_state
+    # we assume no app_control from YT means processed.              
+    video = YouTubeG::Model::Video.new({})
+    assert_equal(true, video.processed?)
+  end
+
+  def test_processed_method_for_processing_state
+    video = YouTubeG::Model::Video.new({:app_control => YouTubeG::Model::Video::AppControl.new({:state => 'processing'})})
+    assert_equal(false, video.processed?)
+  end
+
+  def test_processed_method_for_rejected_state
+    video = YouTubeG::Model::Video.new({:app_control => YouTubeG::Model::Video::AppControl.new({:state => 'rejected'})})
+    assert_equal(false, video.processed?)
+  end
+
+  def test_processed_method_for_failed_state
+    video = YouTubeG::Model::Video.new({:app_control => YouTubeG::Model::Video::AppControl.new({:state => 'failed'})})
+    assert_equal(false, video.processed?)
+  end       
+end  

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: msp-youtube-g
 version: !ruby/object:Gem::Version 
-  version: 0.4.8.1
+  version: 0.4.8.3
 platform: ruby
 authors: 
 - Shane Vitarana
@@ -58,9 +58,11 @@ files:
 - integration-test/test_video.rb
 - integration-test/test_video_search.rb
 - test/test_parser.rb
+- test/test_video.rb
 - test/test_upload.rb
 - test/search.xml
 - test/upload.xml
+- test/status.xml
 has_rdoc: true
 homepage: http://youtube-g.rubyforge.org/
 post_install_message: