youtube 0.0.1

data/dirtywork.rb

@@ -0,0 +1,66 @@
+#--
+# 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'
+
+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)
+    # params[0] is the argument to the YouTube API
+    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 do |k,v|
+      param_list << "&"+k.to_s+"="+v.to_s
+    end
+    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

@@ -0,0 +1,155 @@
+#--
+# 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.
+#++
+
+# USAGE:
+# require 'youtube'
+# youtube = YouTube.new 'your dev id'
+# profile = youtube.profile 'username'
+# profile.age
+# ...
+# videos = youtube.videos_by_tag('malsky')
+# video = video[0]
+# video.title
+# ...
+# details = video.details
+# details.channel_list
+
+require 'dirtywork'
+
+# YouTube client class.  Requires a dev id.
+
+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
+  
+  # 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)
+    response['video_list']['video'].each do |video|
+      videos << Video.new(video, @dev_id)
+    end
+    videos
+  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

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.11
+specification_version: 1
+name: youtube
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+date: 2006-09-27 00:00:00 -05:00
+summary: An interface in Ruby to the YouTube REST API. By Shane Vitarana.
+require_paths: 
+- .
+email: shanev@gmail.com
+homepage: http://shanesbrain.net
+rubyforge_project: youtube
+description: 
+autorequire: youtube
+default_executable: 
+bindir: bin
+has_rdoc: false
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+authors: 
+- Shane Vitarana
+files: 
+- youtube.rb
+- dirtywork.rb
+test_files: []
+
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: []
+
+extensions: []
+
+requirements: 
+- YouTube Developer ID
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: xml-simple
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.7
+    version: