msp-youtube-g 0.4.5

data/History.txt

@@ -0,0 +1,30 @@
+== trunk
+
+* Fix issue with REXML parsing of video upload response. [FiXato]
+* Fix issue with response code comparison. [FiXato]
+* Authcode is now retrieved for video uploads. [FiXato]
+* Add basic support for uploading videos [thanks Joe Damato]
+* Add basic support for related videos [tmm1]
+* Improve docs for order_by attribute [thanks Jason Arora]
+* Added support for the "racy" parameter (choices are "include" or "exclude") [thanks Jason Arora]
+* Add missing attribute reader for description [tmm1]
+* Fix issue with missing yt:statistics and viewCount [tmm1]
+* Allow Client#video_by to take either a url or a video id [tmm1]
+
+== 0.4.1 / 2008-02-11
+
+* Added 3GPP video format [shane]
+* Fixed tests [shane]
+
+== 0.4.0 / 2007-12-18
+
+* Fixed API projection in search URL [Pete Higgins]
+* Fixed embeddable video searching [Pete Higgins]
+* Fixed video embeddable detection [Pete Higgins]
+* Fixed unique id hyphen detection [Pete Higgins, Chris Taggart]
+
+== 0.3.0 / 2007-09-17
+
+* Initial public release
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,25 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+TODO.txt
+lib/youtube_g.rb
+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/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

data/README.txt

@@ -0,0 +1,81 @@
+youtube-g
+    by Shane Vitarana and Walter Korman
+
+  Rubyforge: http://rubyforge.org/projects/youtube-g/
+  RDoc: http://youtube-g.rubyforge.org/
+  Google Group: http://groups.google.com/group/ruby-youtube-library
+
+== 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 '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'] })
+
+
+== REQUIREMENTS:
+
+* None
+
+== INSTALL:
+
+* sudo gem install youtube-g
+
+== LICENSE:
+
+MIT License
+
+Copyright (c) 2007 Shane Vitarana and Walter Korman
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'hoe'
+require 'lib/youtube_g'
+
+Hoe.new('youtube-g', YouTubeG::VERSION) do |p|
+  p.rubyforge_name = 'youtube-g'
+  p.author = ["Shane Vitarana", "Walter Korman", "Aman Gupta", "Filip H.F. Slagter"]
+  p.email = 'shanev@gmail.com'
+  p.summary = 'Ruby client for the YouTube GData API'
+  p.description = p.paragraphs_of('README.txt', 2..8).join("\n\n")
+  p.url = 'http://rubyforge.org/projects/youtube-g/'
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+  p.remote_rdoc_dir = ''
+end
+
+desc 'Tag release'
+task :tag do
+  svn_root = 'svn+ssh://drummr77@rubyforge.org/var/svn/youtube-g'
+  sh %(svn cp #{svn_root}/trunk #{svn_root}/tags/release-#{YouTubeG::VERSION} -m "Tag YouTubeG release #{YouTubeG::VERSION}")
+end

data/TODO.txt

@@ -0,0 +1,18 @@
+[ ] stub out http request/response cycle for tests
+[ ] consider defaulting the client to no-logger, rather than outputting to STDOUT.
+[ ] allow specifying values as single items where you don't need to wrap in a list, e.g. :tags => :chickens instead of :tags => [ 'chickens' ]
+[ ] make sure symbols will work as well as tags everywhere (again, :tags => :chickens is same as :tags => 'chickens')
+[ ] figure out better structure for class/file (either rename request/video_search.rb or split into one class per file again)
+[ ] restore spaces after method def names
+[ ] use a proxy for testing with static sample result xml so we have repeatable tests
+[ ] Clean up tests using Shoulda to define contexts
+[ ] Consolidate requires
+[ ] Allow :category and :categories for query DSL
+[ ] Exception handling
+
+== API Features TODO
+
+[ ] Profile feed parsing
+[ ] Playlist feeds
+[ ] User subscriptions
+[ ] Video comments

data/lib/youtube_g/client.rb

@@ -0,0 +1,36 @@
+require 'logger'
+
+class YouTubeG
+  class Client
+    attr_accessor :logger
+    
+    def initialize(logger=Logger.new(STDOUT))
+      @logger = logger
+    end
+
+    # Params can be one of :most_viewed, :top_rated, :recently_featured, :watch_on_mobile
+    # Or :tags, :categories, :query, :user
+    def videos_by(params, options={})
+      if params.respond_to?(:to_hash) and not params[:user]
+        request = YouTubeG::Request::VideoSearch.new(params)
+
+      elsif (params.respond_to?(:to_hash) && params[:user]) || (params == :favorites)
+        request = YouTubeG::Request::UserSearch.new(params, options)
+
+      else
+        request = YouTubeG::Request::StandardSearch.new(params, options)
+      end
+      
+      logger.debug "Submitting request [url=#{request.url}]."
+      parser = YouTubeG::Parser::VideosFeedParser.new(request.url)
+      parser.parse
+    end
+    
+    def video_by(vid)
+      video_id = vid =~ /^http/ ? vid : "http://gdata.youtube.com/feeds/videos/#{vid}"
+      parser = YouTubeG::Parser::VideoFeedParser.new(video_id)
+      parser.parse
+    end
+    
+  end
+end

data/lib/youtube_g/logger.rb

@@ -0,0 +1,27 @@
+require 'logger'
+
+class YouTubeG
+  
+  # TODO: Why is this needed? Does this happen if running standalone w/o Rails?
+  # Anyway, isn't it easier to debug w/o the really long timestamp & log level?
+  # How often do you look at the timestamp and log level? Wouldn't it be nice to
+  # see your logger output first?
+  
+  # Extension of the base ruby Logger class to restore the default log
+  # level and timestamp formatting which is so rudely taken forcibly
+  # away from us by the Rails app's use of the ActiveSupport library
+  # that wholesale-ly modifies the Logger's format_message method.
+  #
+  class Logger < ::Logger
+    private
+      begin
+        # restore original log formatting to un-screw the screwage that is
+        # foisted upon us by the activesupport library's clean_logger.rb
+        alias format_message old_format_message
+
+      rescue NameError
+        # nothing for now -- this means we didn't need to alias since the
+        # method wasn't overridden
+      end
+  end
+end

data/lib/youtube_g/model/author.rb

@@ -0,0 +1,8 @@
+class YouTubeG
+  module Model
+    class Author < YouTubeG::Record
+      attr_reader :name
+      attr_reader :uri
+    end
+  end
+end

data/lib/youtube_g/model/category.rb

@@ -0,0 +1,8 @@
+class YouTubeG
+  module Model
+    class Category < YouTubeG::Record
+      attr_reader :label
+      attr_reader :term
+    end
+  end
+end

data/lib/youtube_g/model/contact.rb

@@ -0,0 +1,8 @@
+class YouTubeG
+  module Model
+    class Contact < YouTubeG::Record
+      attr_reader :status
+      attr_reader :username
+    end
+  end
+end

data/lib/youtube_g/model/content.rb

@@ -0,0 +1,13 @@
+class YouTubeG
+  module Model
+    class Content < YouTubeG::Record
+      attr_reader :default
+      attr_reader :duration
+      attr_reader :format
+      attr_reader :mime_type
+      attr_reader :url
+      
+      alias :is_default? :default
+    end
+  end
+end

data/lib/youtube_g/model/playlist.rb

@@ -0,0 +1,7 @@
+class YouTubeG
+  module Model
+    class Playlist < YouTubeG::Record
+      attr_reader :description
+    end
+  end
+end

data/lib/youtube_g/model/rating.rb

@@ -0,0 +1,10 @@
+class YouTubeG
+  module Model
+    class Rating < YouTubeG::Record
+      attr_reader :average
+      attr_reader :max
+      attr_reader :min
+      attr_reader :rater_count
+    end
+  end
+end

data/lib/youtube_g/model/thumbnail.rb

@@ -0,0 +1,10 @@
+class YouTubeG
+  module Model
+    class Thumbnail < YouTubeG::Record
+      attr_reader :url
+      attr_reader :height
+      attr_reader :width
+      attr_reader :time
+    end
+  end
+end

data/lib/youtube_g/model/user.rb

@@ -0,0 +1,20 @@
+class YouTubeG
+  module Model
+    class User < YouTubeG::Record
+      attr_reader :age
+      attr_reader :books
+      attr_reader :company
+      attr_reader :gender
+      attr_reader :hobbies
+      attr_reader :hometown
+      attr_reader :location
+      attr_reader :movies
+      attr_reader :music
+      attr_reader :occupation
+      attr_reader :relationship
+      attr_reader :school
+      attr_reader :description
+      attr_reader :username
+    end
+  end
+end

data/lib/youtube_g/model/video.rb

@@ -0,0 +1,106 @@
+class YouTubeG
+  module Model
+    class Video < YouTubeG::Record
+      # Describes the various file formats in which a Youtube video may be
+      # made available and allows looking them up by format code number.
+      #
+      class Format
+        @@formats = Hash.new
+
+        def initialize(format_code, name)
+          @format_code = format_code
+          @name = name
+
+          @@formats[format_code] = self          
+        end
+
+        def self.by_code(format_code)
+          @@formats[format_code]
+        end
+
+        # Flash format on YouTube site. All videos are available in this
+        # format.
+        #
+        FLASH = YouTubeG::Model::Video::Format.new(0, :flash)
+
+        # RTSP streaming URL for mobile video playback. H.263 video (176x144)
+        # and AMR audio.
+        #
+        RTSP = YouTubeG::Model::Video::Format.new(1, :rtsp)
+
+        # HTTP URL to the embeddable player (SWF) for this video. This format
+        # is not available for a video that is not embeddable.
+        #
+        SWF = YouTubeG::Model::Video::Format.new(5, :swf)
+        
+        THREE_GPP = YouTubeG::Model::Video::Format.new(6, :three_gpp)
+      end
+
+      attr_reader :duration
+      attr_reader :noembed
+      attr_reader :position
+      attr_reader :racy
+      attr_reader :statistics
+      
+      attr_reader :video_id
+      attr_reader :published_at
+      attr_reader :updated_at
+      attr_reader :categories
+      attr_reader :keywords
+      attr_reader :description
+      attr_reader :title
+      attr_reader :html_content
+      attr_reader :author
+
+      # YouTubeG::Model::Content records describing the individual media content
+      # data available for this video.  Most, but not all, videos offer this.
+      attr_reader :media_content
+
+      attr_reader :thumbnails         # YouTubeG::Model::Thumbnail records
+      attr_reader :player_url
+      attr_reader :rating
+      attr_reader :view_count
+
+      # TODO:
+      # self atom feed
+      # alternate youtube watch url
+      # responses feed
+      # comments feedLink
+
+      def related
+        YouTubeG::Parser::VideosFeedParser.new("http://gdata.youtube.com/feeds/api/videos/#{unique_id}/related").parse
+      end
+      
+      # For convenience, the video_id with the URL stripped out, useful for searching for the video again
+      # without having to store it anywhere. A regular query search, with this id will return the same video.
+      # http://gdata.youtube.com/feeds/videos/ZTUVgYoeN_o
+      def unique_id
+        video_id[/videos\/([^<]+)/, 1]
+      end
+      
+      def can_embed?
+        not @noembed
+      end
+      
+      def default_media_content
+        @media_content.find { |c| c.is_default? }
+      end
+      
+      def embed_html(width = 425, height = 350)
+        <<EDOC
+<object width="#{width}" height="#{height}">
+  <param name="movie" value="#{embed_url}"></param>
+  <param name="wmode" value="transparent"></param>
+  <embed src="#{embed_url}" type="application/x-shockwave-flash" 
+   wmode="transparent" width="#{width}" height="#{height}"></embed>
+</object>
+EDOC
+      end
+
+      def embed_url
+        @player_url.sub('watch?', '').sub('=', '/')          
+      end
+      
+    end
+  end
+end

data/lib/youtube_g/parser.rb

@@ -0,0 +1,165 @@
+require 'cgi'
+require 'open-uri'
+require 'rexml/document'
+
+class YouTubeG
+  module Parser
+    class FeedParser
+      def initialize(url)
+        @url = url
+      end
+      
+      def parse
+        parse_content open(@url).read
+      end      
+    end
+
+    class VideoFeedParser < FeedParser
+      
+      def parse_content(content)
+        doc = REXML::Document.new(content)
+        entry = doc.elements["entry"]
+        
+        parse_entry(entry)
+      end
+
+    protected
+      def parse_entry(entry)
+        video_id = entry.elements["id"].text
+        published_at = Time.parse(entry.elements["published"].text)
+        updated_at = Time.parse(entry.elements["updated"].text)
+
+        # parse the category and keyword lists
+        categories = []
+        keywords = []
+        entry.elements.each("category") do |category|
+          # determine if  it's really a category, or just a keyword
+          scheme = category.attributes["scheme"]
+          if (scheme =~ /\/categories\.cat$/)
+            # it's a category
+            categories << YouTubeG::Model::Category.new(
+                            :term => category.attributes["term"],
+                            :label => category.attributes["label"])
+
+          elsif (scheme =~ /\/keywords\.cat$/)
+            # it's a keyword
+            keywords << category.attributes["term"]
+          end
+        end
+
+        title = entry.elements["title"].text
+        html_content = entry.elements["content"].text
+
+        # parse the author
+        author_element = entry.elements["author"]
+        author = nil
+        if author_element
+          author = YouTubeG::Model::Author.new(
+                     :name => author_element.elements["name"].text,
+                     :uri => author_element.elements["uri"].text)
+        end
+      
+        media_group = entry.elements["media:group"]
+        description = media_group.elements["media:description"].text
+        duration = media_group.elements["yt:duration"].attributes["seconds"].to_i
+
+        media_content = []
+        media_group.elements.each("media:content") do |mce|
+          media_content << parse_media_content(mce)
+        end
+
+        player_url = media_group.elements["media:player"].attributes["url"]
+
+        # parse thumbnails
+        thumbnails = []
+        media_group.elements.each("media:thumbnail") do |thumb_element|
+          # TODO: convert time HH:MM:ss string to seconds?
+          thumbnails << YouTubeG::Model::Thumbnail.new(
+                          :url => thumb_element.attributes["url"],
+                          :height => thumb_element.attributes["height"].to_i,
+                          :width => thumb_element.attributes["width"].to_i,
+                          :time => thumb_element.attributes["time"])
+        end
+
+        rating_element = entry.elements["gd:rating"]
+        rating = nil
+        if rating_element
+          rating = YouTubeG::Model::Rating.new(
+                     :min => rating_element.attributes["min"].to_i,
+                     :max => rating_element.attributes["max"].to_i,
+                     :rater_count => rating_element.attributes["numRaters"].to_i,
+                     :average => rating_element.attributes["average"].to_f)
+        end
+
+        view_count = (el = entry.elements["yt:statistics"]) ? el.attributes["viewCount"].to_i : 0
+
+        noembed = entry.elements["yt:noembed"] ? true : false
+        racy = entry.elements["yt:racy"] ? true : false
+
+        YouTubeG::Model::Video.new(
+          :video_id => video_id,
+          :published_at => published_at,
+          :updated_at => updated_at,
+          :categories => categories,
+          :keywords => keywords,
+          :title => title,
+          :html_content => html_content,
+          :author => author,
+          :description => description,
+          :duration => duration,
+          :media_content => media_content,
+          :player_url => player_url,
+          :thumbnails => thumbnails,
+          :rating => rating,
+          :view_count => view_count,
+          :noembed => noembed,
+          :racy => racy)
+      end
+
+      def parse_media_content (media_content_element)
+        content_url = media_content_element.attributes["url"]
+        format_code = media_content_element.attributes["yt:format"].to_i
+        format = YouTubeG::Model::Video::Format.by_code(format_code)
+        duration = media_content_element.attributes["duration"].to_i
+        mime_type = media_content_element.attributes["type"]
+        default = (media_content_element.attributes["isDefault"] == "true")
+
+        YouTubeG::Model::Content.new(
+          :url => content_url,
+          :format => format,
+          :duration => duration,
+          :mime_type => mime_type,
+          :default => default)
+      end      
+    end
+
+    class VideosFeedParser < VideoFeedParser
+
+    private
+      def parse_content(content)
+        doc = REXML::Document.new(content)
+        feed = doc.elements["feed"]
+
+        feed_id = feed.elements["id"].text
+        updated_at = Time.parse(feed.elements["updated"].text)
+        total_result_count = feed.elements["openSearch:totalResults"].text.to_i
+        offset = feed.elements["openSearch:startIndex"].text.to_i
+        max_result_count = feed.elements["openSearch:itemsPerPage"].text.to_i
+
+        videos = []
+        feed.elements.each("entry") do |entry|
+          videos << parse_entry(entry)
+        end
+
+        YouTubeG::Response::VideoSearch.new(
+          :feed_id => feed_id,
+          :updated_at => updated_at,
+          :total_result_count => total_result_count,
+          :offset => offset,
+          :max_result_count => max_result_count,
+          :videos => videos)
+      end
+    end
+    
+  end 
+end

data/lib/youtube_g/record.rb

@@ -0,0 +1,12 @@
+class YouTubeG
+  class Record
+    def initialize (params)
+      return if params.nil?
+
+      params.each do |key, value| 
+        name = key.to_s
+        instance_variable_set("@#{name}", value) if respond_to?(name)
+      end
+    end
+  end
+end