youtube 0.1.1 → 0.8.0

data/AUTHORS

@@ -0,0 +1,2 @@
+Shane Vitarana <shanev@gmail.com>
+Walter Korman  <shaper@wgks.org>

data/CHANGELOG

@@ -0,0 +1,50 @@
+* 2006/11/15
+
+- [drummr77] Applied a modified version of the patch sent in by Lucas
+  Carlson that uses a more functional style of programming in the API
+  calls.
+
+* 2006/11/14
+
+- [drummr77] Changed video_details to take in a video id instead of
+  the whole object.
+
+* 2006/11/04
+
+- [shaper] Restructured to follow standard RubyGems directory structure.
+
+- [shaper] Created a Rakefile.
+
+- [shaper] Created initial unit tests.
+
+- [shaper] Fixed bug wherein responses with only a single result
+  (e.g. from a videos_by_tag call) would fail to successfully parse.
+
+- [shaper] Moved all classes within a YouTube module for cleaner namespace
+  management and in particular to avoid potential conflicts.
+
+- [shaper] Added Video.embed_html method to allow easy retrieval of HTML
+  to embed the video in a web page conforming to the HTML specified on
+  YouTube video pages, with width/height of video optionally specifiable.
+
+- [shaper] Merged dirtywork.rb into the main youtube.rb file and added
+  support for optionally specifying the host and api path for future
+  flexibility without requiring code modifications should YouTube change
+  their API access details.
+
+- [shaper] Modified parsing response payload data to translate to the most
+  appropriate Ruby objects (e.g. integers via to_i(), boolean strings to
+  TrueClass/FalseClass, time strings to Time) wherever applicable.
+
+- [shaper] Moved Video.details() into Client.video_details() for
+  consistency and to avoid having to store a reference to the client in
+  every Video object.
+
+- [shaper] Updated existing and added more RDoc documentation.
+
+- [shaper] Changed API hostname to fully-qualified www.youtube.com from
+  youtube.com.
+
+* 2006/09/28
+
+- [drummr77] Initial Release.

data/README

@@ -0,0 +1,56 @@
+= YouTube
+
+A pure Ruby object-oriented interface to the YouTube REST API documented
+at http://www.youtube.com/dev.
+
+API access requires a developer id.  You can obtain one for free at
+http://www.youtube.com/my_profile_dev.
+
+The RubyForge project is at http://rubyforge.org/projects/youtube.
+
+== About
+
+Implements version 2 of YouTube's API.
+
+== Installing
+
+Install the gem via:
+
+  % gem install youtube
+
+== Usage
+
+An example as:
+
+  require 'rubygems'
+  require 'youtube'
+
+  youtube = YouTube::Client.new 'DEVELOPER_ID'
+
+  profile = youtube.profile('br0wnpunk')
+  puts "age: " + profile.age.to_s
+
+  favorites = youtube.favorite_videos('br0wnpunk')
+  puts "number of favorite videos: " + favorites.size.to_s
+
+  friends = youtube.friends('paolodona')
+  puts "number of friends: " + friends.size.to_s
+  puts "friend name: " + friends[0].user
+
+  videos = youtube.videos_by_tag('iron maiden')
+  puts "number of videos by tag iron maiden: " + videos.size.to_s
+
+  videos = youtube.videos_by_user('whytheluckystiff')
+  puts "number of videos by why: " + videos.size.to_s
+  puts "title: " + videos[0].title
+
+  videos = youtube.featured_videos
+  puts "number of featured videos: " + videos.size.to_s
+  puts "title: " + videos[0].title
+  puts "url: " + videos[0].url
+  puts "embed url: " + videos[0].embed_url
+  puts "embed html: \n" + videos[0].embed_html
+
+  details = youtube.video_details(videos[0])
+  puts "detailed description: " + details.description
+  puts "thumbnail url: " + details.thumbnail_url

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+
+spec = Gem::Specification.new do |s|
+  s.name = 'youtube'
+  s.version = '0.8.0'
+  s.author = 'Shane Vitarana'
+  s.email = 'shanev@gmail.com'
+  s.platform = Gem::Platform::RUBY
+  s.summary = 'A Ruby object-oriented interface to the YouTube REST API.'
+  s.rubyforge_project = 'youtube'
+  s.has_rdoc = true
+  s.extra_rdoc_files = [ 'README' ]
+  s.rdoc_options << '--main' << 'README'
+  s.files = Dir.glob("{examples,lib,test}/**/*") +
+    [ 'AUTHORS', 'CHANGELOG', 'README', 'Rakefile', 'TODO' ]
+  s.add_dependency("xml-simple", ">= 1.0.9")
+end
+
+desc 'Run tests'
+task :default => [ :test ]
+
+Rake::TestTask.new('test') do |t|
+  t.libs << 'test'
+  t.pattern = 'test/test_*.rb'
+  t.verbose = true
+end
+
+desc 'Generate RDoc'
+Rake::RDocTask.new :rdoc do |rd|
+  rd.rdoc_dir = 'doc'
+  rd.rdoc_files.add 'lib', 'README'
+  rd.main = 'README'
+end
+
+desc 'Build Gem'
+Rake::GemPackageTask.new spec do |pkg|
+  pkg.need_tar = true
+end
+
+desc 'Clean up'
+task :clean => [ :clobber_rdoc, :clobber_package ]
+
+desc 'Clean up'
+task :clobber => [ :clean ]

data/TODO

@@ -0,0 +1,15 @@
+- consider creating YouTubeException to raise on failures rather than just
+  a string so that we can pass our request params back up to higher
+  levels should they be interested.
+
+- look into object types stored for comments and channel list and see if
+  we're doing the Right/Best Thing.  It looks like we've got hashes with
+  one key e.g. "comments" that then map to a list of actual comments.
+
+- look at what we store for fields with no actual value; appears we're
+  storing empty hashes in at least some cases.
+
+- add unit tests for client.videos_by_tag page and per_page params.
+
+- add unit tests for specifying alternate api host/path in client
+  constructor.

data/examples/example.rb

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'youtube'
+
+youtube = YouTube::Client.new 'DEVELOPER_ID' # Get one here: <http://youtube.com/my_profile_dev>. 
+
+profile = youtube.profile('br0wnpunk')
+puts "age: " + profile.age.to_s
+
+favorites = youtube.favorite_videos('br0wnpunk')
+puts "number of favorite videos: " + favorites.size.to_s
+
+friends = youtube.friends('paolodona')
+puts "number of friends: " + friends.size.to_s
+puts "friend name: " + friends.first.user
+
+videos = youtube.videos_by_tag('iron maiden')
+puts "number of videos by tag iron maiden: " + videos.size.to_s
+
+videos = youtube.videos_by_user('whytheluckystiff')
+puts "number of videos by why: " + videos.size.to_s
+puts "title: " + videos.first.title
+
+videos = youtube.featured_videos
+puts "number of featured videos: " + videos.size.to_s
+puts "title: " + videos.first.title
+puts "url: " + videos.first.url
+puts "embed url: " + videos.first.embed_url
+puts "embed html: \n" + videos.first.embed_html
+
+details = youtube.video_details(videos.first.id)
+puts "detailed description: " + details.description
+puts "thumbnail url: " + details.thumbnail_url

data/lib/youtube.rb

@@ -0,0 +1,299 @@
+#--
+# Copyright (c) 2006 Shane Vitarana
+#
+# 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.
+#++
+
+require 'net/http'
+require 'uri'
+require 'xmlsimple'
+
+module YouTube
+
+  # Main client class managing all interaction with the YouTube server.
+  # Server communication is handled via method_missing() emulating an
+  # RPC-like call and performing all of the work to send out the HTTP
+  # request and retrieve the XML response.  Inspired by the Flickr
+  # interface by Scott Raymond <http://redgreenblu.com/flickr/>.
+  class Client
+    # the default hostname at which the YouTube API is hosted
+    DEFAULT_HOST = 'http://www.youtube.com'
+    # the default api path to the YouTube API
+    DEFAULT_API_PATH = '/api2_rest'
+
+    def initialize(dev_id = nil, host = DEFAULT_HOST, api_path = DEFAULT_API_PATH)
+      raise "developer id required" unless dev_id
+
+      @host = host
+      @api_path = api_path
+      @dev_id = dev_id
+    end
+
+    # Returns a YouTube::Profile object detailing the profile information
+    # regarding the supplied +username+.
+    def profile(username)
+      response = users_get_profile(:user => username)
+      Profile.new response['user_profile']
+    end
+
+    # Returns a list of YouTube::Video objects detailing the favorite
+    # videos of the supplied +username+.
+    def favorite_videos(username)
+      response = users_list_favorite_videos(:user => username)
+      response['video_list']['video'].compact.map { |video| Video.new(video) }
+    end
+
+    # Returns a list of YouTube::Friend objects detailing the friends of
+    # the supplied +username+.
+    def friends(username)
+      response = users_list_friends(:user => username)
+      response['friend_list']['friend'].compact.map { |friend| Friend.new(friend) }
+    end
+
+    # Returns a list of YouTube::Video objects detailing the videos
+    # matching the supplied +tag+.
+    #
+    # Optional parameters are:
+    # +page+ = the "page" of results to retrieve (e.g. 1, 2, 3)
+    # +per_page+ = the number of results per page (default: 20, max 100).
+    def videos_by_tag(tag, page = 1, per_page = 20)
+      response = videos_list_by_tag(:tag => tag, :page => page, :per_page => per_page)
+      response['video_list']['video'].compact.map { |video| Video.new(video) }
+    end
+
+    # Returns a list of YouTube::Video objects detailing the videos
+    # uploaded by the specified +username+.
+    def videos_by_user(username)
+      response = videos_list_by_user(:user => username)
+      response['video_list']['video'].compact.map { |video| Video.new(video) }
+    end
+
+    # Returns a list of YouTube::Video objects detailing the current
+    # global set of featured videos on YouTube.
+    def featured_videos
+      response = videos_list_featured
+      response['video_list']['video'].compact.map { |video| Video.new(video) }
+    end
+
+    # Returns a YouTube::VideoDetails object detailing additional
+    # information on the supplied video id, obtained from a
+    # YouTube::Video object from a previous client call.
+    def video_details(video_id)
+      raise ArgumentError.new("invalid video id parameter, must be string") unless video_id.is_a?(String)
+      response = videos_get_details(:video_id => video_id)
+      VideoDetails.new(response['video_details'])
+    end
+
+    private
+      # All API methods are implemented with this method.  This method is
+      # like a remote method call, it encapsulates the request/response
+      # cycle to the remote host. It extracts the remote method API name
+      # based on the ruby method name.
+      def method_missing(method_id, *params)
+        _request(method_id.to_s.sub('_', '.'), *params)
+      end
+
+      def _request(method, *params)
+        url = _request_url(method, *params)
+        response = XmlSimple.xml_in(_http_get(url), 
+                                    { 'ForceArray' => [ 'video', 'friend' ] })
+        unless response['status'] == 'ok'
+          raise response['error']['description'] + " : url=#{url}"
+        end
+        response
+      end
+
+      def _request_url(method, *params)
+        param_list = String.new
+        unless params.empty?
+          params.first.each_pair { |k, v| param_list << "&#{k.to_s}=#{URI.encode(v.to_s)}" }
+        end
+        url = "#{@host}#{@api_path}?method=youtube.#{method}&dev_id=#{@dev_id}#{param_list}"
+      end
+
+      def _http_get(url)
+        Net::HTTP.get_response(URI.parse(url)).body.to_s
+      end
+  end
+
+  class Friend
+    attr_reader :favorite_count
+    attr_reader :friend_count
+    attr_reader :user
+    attr_reader :video_upload_count
+
+    def initialize(payload)
+      @favorite_count = payload['favorite_count'].to_i
+      @friend_count = payload['friend_count'].to_i
+      @user = payload['user']
+      @video_upload_count = payload['video_upload_count'].to_i
+    end        
+  end
+
+  class Profile
+    attr_reader :about_me
+    attr_reader :age
+    attr_reader :books
+    attr_reader :city
+    attr_reader :companies
+    attr_reader :country
+    attr_reader :currently_on
+    attr_reader :favorite_video_count
+    attr_reader :first_name
+    attr_reader :friend_count
+    attr_reader :gender
+    attr_reader :hobbies
+    attr_reader :homepage
+    attr_reader :hometown
+    attr_reader :last_name
+    attr_reader :movies
+    attr_reader :occupations
+    attr_reader :relationship
+    attr_reader :video_upload_count
+    attr_reader :video_watch_count
+
+    def initialize(payload)
+      @about_me = payload['about_me']
+      @age = payload['age'].to_i
+      @books = payload['books']
+      @city = payload['city']
+      @companies = payload['companies']
+      @country = payload['country']
+      @currently_on = YouTube._string_to_boolean(payload['currently_on'])
+      @favorite_video_count = payload['favorite_video_count'].to_i
+      @first_name = payload['first_name']
+      @friend_count = payload['friend_count'].to_i
+      @gender = payload['gender']
+      @hobbies = payload['hobbies']
+      @homepage = payload['homepage']
+      @hometown = payload['hometown']
+      @last_name = payload['last_name']
+      @movies = payload['movies']
+      @occupations = payload['occupations']
+      @relationship = payload['relationship']
+      @video_upload_count = payload['video_upload_count'].to_i
+      @video_watch_count = payload['video_watch_count'].to_i
+    end
+  end
+
+  class Video
+    attr_reader :author
+    attr_reader :comment_count
+    attr_reader :description
+    attr_reader :embed_url
+    attr_reader :id
+    attr_reader :length
+    attr_reader :rating_avg
+    attr_reader :rating_count
+    attr_reader :tags
+    attr_reader :thumbnail_url
+    attr_reader :title
+    attr_reader :upload_time
+    attr_reader :url
+    attr_reader :view_count
+
+    def initialize(payload)
+      @author = payload['author']
+      @comment_count = payload['comment_count'].to_i
+      @description = payload['description']
+      @id = payload['id']
+      @length = payload['length']
+      @rating_avg = payload['rating_avg'].to_f
+      @rating_count = payload['rating_count'].to_i
+      @tags = payload['tags']
+      @thumbnail_url = payload['thumbnail_url']
+      @title = payload['title']
+      @upload_time = YouTube._string_to_time(payload['upload_time'])
+      @url = payload['url']
+      @view_count = payload['view_count'].to_i
+
+      # the url provided via the API links to the video page -- for
+      # convenience, generate the url used to embed in a page
+      @embed_url = @url.delete('?').sub('=', '/')
+    end    
+
+    # Returns HTML analogous to that provided by the YouTube web site to
+    # allow for easy embedding of this video in a web page.  Optional
+    # +width+ and +height+ parameters allow specifying the dimensions of
+    # the video for display.
+    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
+  end
+
+  class VideoDetails
+    attr_reader :author
+    attr_reader :channel_list
+    attr_reader :comment_list
+    attr_reader :description
+    attr_reader :length_seconds
+    attr_reader :rating_avg
+    attr_reader :rating_count
+    attr_reader :recoding_location
+    attr_reader :recording_country
+    attr_reader :recording_date
+    attr_reader :tags
+    attr_reader :thumbnail_url
+    attr_reader :title
+    attr_reader :update_time
+    attr_reader :upload_time
+    attr_reader :view_count
+
+    def initialize(payload)
+      @author = payload['author']
+      @channel_list = payload['channel_list']
+      @comment_list = payload['comment_list']
+      @description = payload['description']
+      @length_seconds = payload['length_seconds'].to_i
+      @rating_avg = payload['rating_avg'].to_f
+      @rating_count = payload['rating_count'].to_i
+      @recording_country = payload['recording_country']
+      @recording_date = payload['recording_date']
+      @recording_location = payload['recording_location']
+      @tags = payload['tags']
+      @thumbnail_url = payload['thumbnail_url']
+      @title = payload['title']
+      @update_time = YouTube._string_to_time(payload['update_time'])
+      @upload_time = YouTube._string_to_time(payload['upload_time'])
+      @view_count = payload['view_count'].to_i
+    end
+  end
+
+  private
+    # Returns the Ruby boolean object as TrueClass or FalseClass based on
+    # the supplied string value.  TrueClass is returned if the value is
+    # non-nil and "true" (case-insensitive), else FalseClass is returned.
+    def self._string_to_boolean(bool_str)
+      (bool_str && bool_str.downcase == "true")
+    end
+
+    # Returns a Time object corresponding to the specified time string
+    # representing seconds since the epoch, or nil if the string is nil.
+    def self._string_to_time(time_str)
+      (time_str) ? Time.at(time_str.to_i) : nil
+    end
+end

data/test/test_api.rb

@@ -0,0 +1,158 @@
+require 'rubygems'
+require 'test/unit'
+require 'youtube'
+
+# This test class assumes an active internet connection
+class TestAPI < Test::Unit::TestCase
+  @@DEVELOPER_API_KEY = 'DEVELOPER_ID'
+
+  def setup
+    @client = YouTube::Client.new @@DEVELOPER_API_KEY
+  end
+
+  def test_profile
+    profile = @client.profile('nutria42')
+
+    assert_kind_of YouTube::Profile, profile
+    assert_not_nil profile
+    assert (profile.age >= 33)
+    assert (profile.gender == 'm')
+    assert (profile.country == 'US')
+  end
+
+  def test_favorite_videos
+    favorites = @client.favorite_videos('br0wnpunk')
+
+    # make sure we got some favorites
+    assert_not_nil favorites
+    assert (favorites.length > 0)
+
+    # pull out one to scrutinize
+    sample = favorites.first
+    _test_video(sample)
+  end
+
+  def test_friends
+    friends = @client.friends('paolodona')
+
+    # make sure we got some friends
+    assert_not_nil friends
+    assert (friends.length > 0)
+
+    # pull one out to scrutinize
+    sample = friends.first
+    assert_kind_of YouTube::Friend, sample
+
+    # sanity-check some attributes to make sure we parsed properly
+    assert (sample.favorite_count > 0)
+    assert (sample.friend_count > 0)
+    assert (sample.user && sample.user.length > 0)
+  end
+
+  def test_videos_by_tag
+    videos = @client.videos_by_tag('iron maiden')
+    _test_video_list(videos)
+
+    videos = @client.videos_by_tag('caffe trieste')
+    _test_video_list(videos)
+  end
+
+  def test_videos_by_user
+    videos = @client.videos_by_user('whytheluckystiff')
+    _test_video_list(videos)
+  end
+
+  def test_featured_videos
+    videos = @client.featured_videos
+    _test_video_list(videos)
+  end
+
+  def test_video_details
+    videos = @client.featured_videos
+    _test_video_list(videos)
+
+    videos.each do |video|
+      details = @client.video_details(video.id)
+
+      assert_not_nil details
+      assert_kind_of YouTube::VideoDetails, details
+      assert (details.author && details.author.length > 0)
+      assert (details.length_seconds > 0)
+      assert (details.title && details.title.length > 0)
+      assert (details.description && details.description.length > 0)
+    end
+
+    # make sure parameter validation is operating correctly
+    assert_raise ArgumentError do
+      @client.video_details(5)
+    end
+  end
+
+  def test_embed_html
+    videos = @client.videos_by_tag('iron maiden')
+    sample_video = videos.first
+
+    embed_html = sample_video.embed_html
+    embed_url = sample_video.embed_url
+
+    # make sure embed url is present twice in the html
+    assert (_match_count(embed_url, embed_html) == 2)
+
+    # make sure the default width and height are present
+    dimension_text = "width=\"425\" height=\"350\""
+    assert (_match_count(dimension_text, embed_html) == 2)
+
+    # try changing the width and height in the embed html
+    custom_embed_html = sample_video.embed_html(200, 100)
+    dimension_text = "width=\"200\" height=\"100\""
+
+    # make sure the customized width and height are present
+    entries = custom_embed_html.find_all { |t| t == dimension_text }
+    assert (_match_count(dimension_text, custom_embed_html) == 2)
+  end
+
+  private
+
+  # Returns the number of times +substr+ exists within +text+.
+  def _match_count (substr, text)
+    return 0 if (!text || !substr)
+
+    count = 0
+    offset = 0
+    while (result = text.index(substr, offset))
+      count += 1
+      offset = result + 1
+    end
+    count
+  end
+
+  def _assert_youtube_url (url)
+    (url =~ /^http:\/\/www.youtube.com\//)
+  end
+
+  def _test_video_list (videos)
+    # make sure we got some videos
+    assert_not_nil videos
+    assert (videos.length > 0)
+
+    # make sure all video records look good
+    videos.each { |video| _test_video(video) }
+  end
+
+  def _test_video (video)
+    assert_kind_of YouTube::Video, video
+
+    # sanity-check embed url to make sure it looks ok
+    assert_not_nil video.embed_url
+    _assert_youtube_url video.embed_url
+
+    # check other attributes
+    assert (video.thumbnail_url =~ /\.jpg$/)
+    assert (video.title && video.title.length > 0)
+    assert (video.upload_time && video.upload_time.is_a?(Time))
+    _assert_youtube_url video.url
+    assert (video.view_count > 0)
+    assert (video.tags && video.tags.length > 0)
+    assert (video.author && video.author.length > 0)
+  end
+end

metadata

@@ -3,19 +3,19 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: youtube
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
-date: 2006-09-27 00:00:00 -05:00
-summary: An interface in Ruby to the YouTube REST API. By Shane Vitarana.
+  version: 0.8.0
+date: 2006-11-18 00:00:00 -06:00
+summary: A Ruby object-oriented interface to the YouTube REST API.
 require_paths: 
-- .
+- lib
 email: shanev@gmail.com
-homepage: http://shanesbrain.net
+homepage: 
 rubyforge_project: youtube
 description: 
-autorequire: youtube
+autorequire: 
 default_executable: 
 bindir: bin
-has_rdoc: false
+has_rdoc: true
 required_ruby_version: !ruby/object:Gem::Version::Requirement 
   requirements: 
   - - ">"
@@ -28,20 +28,27 @@ cert_chain:
 authors: 
 - Shane Vitarana
 files: 
-- youtube.rb
-- dirtywork.rb
+- examples/example.rb
+- lib/youtube.rb
+- test/test_api.rb
+- AUTHORS
+- CHANGELOG
+- README
+- Rakefile
+- TODO
 test_files: []
 
-rdoc_options: []
-
-extra_rdoc_files: []
-
+rdoc_options: 
+- --main
+- README
+extra_rdoc_files: 
+- README
 executables: []
 
 extensions: []
 
-requirements: 
-- YouTube Developer ID
+requirements: []
+
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: xml-simple
@@ -50,5 +57,5 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.0.7
+        version: 1.0.9
     version: 

data/dirtywork.rb

@@ -1,64 +0,0 @@
-#--
-# Copyright (c) 2006 Shane Vitarana
-#
-# 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.
-#++
-
-require 'net/http'
-require 'xmlsimple'
-require 'uri'
-
-HOST = 'http://youtube.com'
-API = '/api2_rest'
-
-# Module that does all the work to send out the HTTP request and retrieve
-# the XML response.  Inspired by the Flickr interface by Scott Raymond
-# <http://redgreenblu.com/flickr/>.
-
-module DirtyWork
-  
-  # All API methods are implemented with this method.
-  # This method is like a remote method call, it encapsulates
-  # the request/response cycle to the remote host. It extracts
-  # the remote method API name based on the ruby method name.
-  private
-  def method_missing(method_id, *params)
-    request(method_id.to_s.sub('_', '.'), *params)
-  end
-
-  private
-  def request(method, *params)
-    response = XmlSimple.xml_in(http_get(request_url(method, *params)), { 'ForceArray' => false })
-    raise response['error']['description'] if response['status'] != 'ok'
-    response
-  end
-
-  private
-  def request_url(method, *params)
-    param_list = String.new
-    params[0].each_pair { |k,v| param_list << "&"+k.to_s+"="+URI.encode(v.to_s) } if !params.empty?
-    url = "#{HOST}#{API}?method=youtube."+method+"&dev_id="+@dev_id+param_list
-  end
-  
-  private
-  def http_get(url)
-    Net::HTTP.get_response(URI.parse(url)).body.to_s
-  end
-end

data/youtube.rb

@@ -1,204 +0,0 @@
-#--
-# Copyright (c) 2006 Shane Vitarana
-#
-# 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.
-#++
-
-require 'dirtywork'
-
-# YouTube client class.  Requires a Developer ID.  
-# Get one here: <http://youtube.com/my_profile_dev>.
-
-class YouTube
-  include DirtyWork
-  
-  def initialize(dev_id)
-    @dev_id = dev_id
-  end
-  
-  # username = the user to get the profile for
-  def profile(username)
-    response = users_get_profile(:user => username)
-    Profile.new response['user_profile']
-  end
-  
-  # username = the user to get favorite videos for
-  def favorite_videos(username)
-    videos = Array.new
-    response = users_list_favorite_videos(:user => username)
-    if !response['video_list'].empty?    
-      response['video_list']['video'].each do |video|
-        videos << Video.new(video, @dev_id)
-      end
-    end
-    videos    
-  end
-  
-  #username = the user to get list of friends from
-  def friends(username)
-    friends = Array.new
-    response = users_list_friends(:user => username)
-    if !response['friend_list'].empty?
-      response['friend_list'].each do |friend|
-        friends << Friend.new(friend[1])
-      end
-    end
-    friends
-  end
-
-  # tag = the tag to search for, must be one word
-  # optional: page = the "page" of results to retrieve (e.g. 1, 2, 3)
-  # optional: per_page = the number of results per page (default: 20, max 100)
-  def videos_by_tag(tag, page=1, per_page=20)
-    videos = Array.new
-    response = videos_list_by_tag(:tag => tag, :page => page, :per_page => per_page)
-    if !response['video_list'].empty?
-      response['video_list']['video'].each do |video|
-        videos << Video.new(video, @dev_id)
-      end
-    end
-    videos
-  end
-  
-  # username = the user to get videos for
-  def videos_by_user(username)
-    videos = Array.new
-    response = videos_list_by_user(:user => username)
-    if !response['video_list'].empty?
-      response['video_list']['video'].each do |video|
-        videos << Video.new(video, @dev_id)
-      end
-    end
-    videos    
-  end
-  
-  # this method takes no arguments
-  def featured_videos
-    videos = Array.new
-    response = videos_list_featured
-    if !response['video_list'].empty?
-      response['video_list']['video'].each do |video|
-        videos << Video.new(video, @dev_id)
-      end
-    end
-    videos        
-  end
-  
-  class Friend
-    attr_reader :user, :video_upload_count, :favorite_count, :friend_count
-    
-    def initialize(friend)
-      @user = friend['user']
-      @video_upload_count = friend['video_upload_count']
-      @favorite_count = friend['favorite_count']
-      @friend_count = friend['friend_count']
-    end
-  end
-  
-  class Profile
-    attr_reader :first_name, :last_name, :about_me, :age, :video_upload_count,
-                :video_watch_count, :homepage, :hometown, :gender, :occupations,
-                :companies, :city, :country, :books, :hobbies, :movies,
-                :relationship, :friend_count, :favorite_video_count, :currently_on
-    
-    def initialize(profile)
-      @first_name = profile['first_name']
-      @last_name = profile['last_name']
-      @about_me = profile['about_me']
-      @age = profile['age']
-      @video_upload_count = profile['video_upload_count']
-      @video_watch_count = profile['video_watch_count']
-      @homepage = profile['homepage']
-      @hometown = profile['hometown']
-      @gender = profile['gender']
-      @occupations = profile['occupations']
-      @companies = profile['companies']
-      @city = profile['city']
-      @country = profile['country']
-      @books = profile['books']
-      @hobbies = profile['hobbies']
-      @movies = profile['movies']
-      @relationship = profile['relationship']
-      @friend_count = profile['friend_count']
-      @favorite_video_count = profile['favorite_video_count']
-      @currently_on = profile['currently_on']
-    end    
-  end
-  
-  class Video
-    include DirtyWork
-    attr_reader :author, :id, :title, :length, :rating_avg, :rating_count,
-                :description, :view_count, :upload_time, :comment_count,
-                :tags, :url, :thumbnail_url, :embed_url
-    
-    def initialize(video, dev_id)
-      @dev_id = dev_id      
-      @author = video['author']
-      @id = video['id']
-      @title = video['title']
-      @length = video['length']
-      @rating_avg = video['rating_avg']
-      @rating_count = video['rating_count']
-      @description = video['description']
-      @view_count = video['view_count']
-      @upload_time = video['upload_time']
-      @comment_count = video['comment_count']
-      @tags = video['tags']
-      @url = video['url']
-      @thumbnail_url = video['thumbnail_url']
-      
-      # the url from the API is made for viewing, not for embedding
-      # fix url to allow embedding
-      @embed_url = @url.delete('?').sub('=', '/')
-    end
-
-    def details
-      response = videos_get_details(:video_id => @id)
-      VideoDetails.new response['video_details']
-    end
-  end
-
-  class VideoDetails
-    attr_reader :author, :title, :rating_avg, :rating_count, :tags, :description,
-                :update_time, :view_count, :upload_time, :length_seconds, 
-                :recording_date, :recoding_location, :recording_country,
-                :comment_list, :channel_list, :thumbnail_url
-    
-    def initialize(details)
-      @author = details['author']
-      @title = details['title']
-      @rating_avg = details['rating_avg']
-      @rating_count = details['rating_count']
-      @tags = details['tags']
-      @description = details['description']
-      @update_time = details['update_time']
-      @view_count = details['view_count']
-      @upload_time = details['upload_time']
-      @length_seconds = details['length_seconds']
-      @recording_date = details['recording_date']
-      @recording_location = details['recording_location']
-      @recording_country = details['recording_country']
-      @comment_list = details['comment_list']
-      @channel_list = details['channel_list']
-      @thumbnail_url = details['thumbnail_url']
-    end
-  end
-
-end