beef-youtube-g 0.4.9.9

data/History.txt

@@ -0,0 +1,41 @@
+== 0.4.9.9 / 2008-09-01
+
+* Add Geodata information (thanks Jose Galisteo)
+* Added :page and :per_page options, this allows easier usage of the will_paginate
+  plugin with the library. The :offset and :max_results options are no longer available. [Daniel Insley]
+* Added ability to get video responses on the instances of the YouTube::Model::Video object. [Daniel Insley]
+* Added and improved the existing documentation [Daniel Insley]
+* Fixed usage of deprecated yt:racy, now using media:rating [Daniel Insley]
+* Renamed can_embed? method to embeddable? [Daniel Insley]
+* Added ability for padingation and ordering on standard feeds. [Daniel Insley]
+* Add error-handling for video upload errors. [FiXato]
+* Add error-handling for authentication errors from YouTube during video upload. [FiXato]
+* Add support for making videos private upon video upload. [FiXato]
+* 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,28 @@
+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/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

data/README.txt

@@ -0,0 +1,84 @@
+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(:query => "penguin", :page => 2, :per_page => 15)
+  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')
+  client.videos_by(:favorites, :user => 'liz')
+	
+Standard feeds:
+	
+  client.videos_by(:most_viewed)
+  client.videos_by(:most_linked, :page => 3)
+  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/TODO.txt

@@ -0,0 +1,16 @@
+[ ] stub out http request/response cycle for tests
+[ ] 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
+[ ] 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.rb

@@ -0,0 +1,29 @@
+require 'logger'
+require 'open-uri'
+require 'net/https'
+require 'digest/md5'
+require 'rexml/document'
+require 'cgi'
+
+require File.dirname(__FILE__) + '/youtube_g/client'
+require File.dirname(__FILE__) + '/youtube_g/record'
+require File.dirname(__FILE__) + '/youtube_g/parser'
+require File.dirname(__FILE__) + '/youtube_g/model/author'
+require File.dirname(__FILE__) + '/youtube_g/model/category'
+require File.dirname(__FILE__) + '/youtube_g/model/contact'
+require File.dirname(__FILE__) + '/youtube_g/model/content'
+require File.dirname(__FILE__) + '/youtube_g/model/playlist'
+require File.dirname(__FILE__) + '/youtube_g/model/rating'
+require File.dirname(__FILE__) + '/youtube_g/model/thumbnail'
+require File.dirname(__FILE__) + '/youtube_g/model/user'
+require File.dirname(__FILE__) + '/youtube_g/model/video'
+require File.dirname(__FILE__) + '/youtube_g/request/base_search'
+require File.dirname(__FILE__) + '/youtube_g/request/user_search'
+require File.dirname(__FILE__) + '/youtube_g/request/standard_search'
+require File.dirname(__FILE__) + '/youtube_g/request/video_upload'
+require File.dirname(__FILE__) + '/youtube_g/request/video_search'
+require File.dirname(__FILE__) + '/youtube_g/response/video_search'
+
+class YouTubeG #:nodoc:
+  VERSION = '0.4.9.9'
+end

data/lib/youtube_g/client.rb

@@ -0,0 +1,85 @@
+class YouTubeG
+  class Client
+    attr_accessor :logger
+    
+    def initialize(logger=false)
+      @logger = Logger.new(STDOUT) if logger
+    end
+    
+    # Retrieves an array of standard feed, custom query, or user videos.
+    # 
+    # === Parameters
+    # If fetching videos for a standard feed:
+    #   params<Symbol>:: Accepts a symbol of :top_rated, :top_favorites, :most_viewed, 
+    #                    :most_popular, :most_recent, :most_discussed, :most_linked, 
+    #                    :most_responded, :recently_featured, and :watch_on_mobile.
+    #  
+    #   You can find out more specific information about what each standard feed provides
+    #   by visiting: http://code.google.com/apis/youtube/reference.html#Standard_feeds                 
+    #   
+    #   options<Hash> (optional)::  Accepts the options of :time, :page (default is 1), 
+    #                               and :per_page (default is 25). :offset and :max_results
+    #                               can also be passed for a custom offset.
+    #  
+    # If fetching videos by tags, categories, query:
+    #   params<Hash>:: Accepts the keys :tags, :categories, :query, :order_by, 
+    #                  :author, :racy, :response_format, :video_format, :page (default is 1), 
+    #                  and :per_page(default is 25)
+    #                  
+    #   options<Hash>:: Not used. (Optional)
+    # 
+    # If fetching videos for a particular user:
+    #   params<Hash>:: Key of :user with a value of the username.
+    #   options<Hash>:: Not used. (Optional)
+    # === Returns
+    # YouTubeG::Response::VideoSearch
+    def videos_by(params, options={})
+      request_params = params.respond_to?(:to_hash) ? params : options
+      request_params[:page] = integer_or_default(request_params[:page], 1)
+      
+      unless request_params[:max_results]
+        request_params[:max_results] = integer_or_default(request_params[:per_page], 25)
+      end
+      
+      unless request_params[:offset]
+        request_params[:offset] = calculate_offset(request_params[:page], request_params[:max_results] )
+      end
+      
+      if params.respond_to?(:to_hash) and not params[:user]
+        request = YouTubeG::Request::VideoSearch.new(request_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, request_params)
+      end
+      
+      logger.debug "Submitting request [url=#{request.url}]." if logger
+      parser = YouTubeG::Parser::VideosFeedParser.new(request.url)
+      parser.parse
+    end
+    
+    # Retrieves a single YouTube video.
+    #
+    # === Parameters
+    #   vid<String>:: The ID or URL of the video that you'd like to retrieve.
+    # 
+    # === Returns
+    # YouTubeG::Model::Video
+    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
+    
+    private
+    
+    def calculate_offset(page, per_page)
+      page == 1 ? 1 : ((per_page * page) - per_page + 1)
+    end
+    
+    def integer_or_default(value, default)
+      value = value.to_i
+      value > 0 ? value : default
+    end
+  end
+end

data/lib/youtube_g/logger.rb

@@ -0,0 +1,25 @@
+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,11 @@
+class YouTubeG
+  module Model
+    class Author < YouTubeG::Record
+      # *String*: Author's YouTube username.
+      attr_reader :name
+      
+      # *String*: Feed URL of the author.
+      attr_reader :uri
+    end
+  end
+end

data/lib/youtube_g/model/category.rb

@@ -0,0 +1,11 @@
+class YouTubeG
+  module Model
+    class Category < YouTubeG::Record
+      # *String*:: Name of the YouTube category
+      attr_reader :label 
+      
+      # *String*:: Identifies the type of item described.
+      attr_reader :term
+    end
+  end
+end

data/lib/youtube_g/model/contact.rb

@@ -0,0 +1,16 @@
+class YouTubeG
+  module Model
+    class Contact < YouTubeG::Record
+      # *String*:: Identifies the status of a contact.
+      #
+      # * The tag's value will be accepted if the authenticated user and the contact have marked each other as friends.
+      # * The tag's value will be requested if the contact has asked to be added to the authenticated user's contact list, but the request has not yet been accepted (or rejected).
+      # * The tag's value will be pending if the authenticated user has asked to be added to the contact's contact list, but the request has not yet been accepted or rejected.
+      #
+      attr_reader :status
+      
+      # *String*:: The Youtube username of the contact.
+      attr_reader :username
+    end
+  end
+end

data/lib/youtube_g/model/content.rb

@@ -0,0 +1,18 @@
+class YouTubeG
+  module Model
+    class Content < YouTubeG::Record
+      # *Boolean*:: Description of the video.
+      attr_reader :default
+      # *Fixnum*:: Length of the video in seconds.
+      attr_reader :duration
+      # YouTubeG::Model::Video::Format:: Specifies the video format of the video object
+      attr_reader :format
+      # *String*:: Specifies the MIME type of the media object.
+      attr_reader :mime_type
+      # *String*:: Specifies the URL for the media object.
+      attr_reader :url
+      
+      alias :is_default? :default
+    end
+  end
+end

data/lib/youtube_g/model/playlist.rb

@@ -0,0 +1,8 @@
+class YouTubeG
+  module Model
+    class Playlist < YouTubeG::Record
+      # *String*:: User entered description for the playlist.
+      attr_reader :description
+    end
+  end
+end

data/lib/youtube_g/model/rating.rb

@@ -0,0 +1,17 @@
+class YouTubeG
+  module Model
+    class Rating < YouTubeG::Record
+      # *Float*:: Average rating given to the video
+      attr_reader :average
+      
+      # *Fixnum*:: Maximum rating that can be assigned to the video
+      attr_reader :max
+      
+      # *Fixnum*:: Minimum rating that can be assigned to the video
+      attr_reader :min
+      
+      # *Fixnum*:: Indicates how many people have rated the video
+      attr_reader :rater_count
+    end
+  end
+end

data/lib/youtube_g/model/thumbnail.rb

@@ -0,0 +1,17 @@
+class YouTubeG
+  module Model
+    class Thumbnail < YouTubeG::Record
+      # *String*:: URL for the thumbnail image.
+      attr_reader :url
+      
+      # *Fixnum*:: Height of the thumbnail image.
+      attr_reader :height
+      
+      # *Fixnum*:: Width of the thumbnail image.
+      attr_reader :width
+      
+      # *String*:: Specifies the time offset at which the frame shown in the thumbnail image appears in the video.
+      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