vibedeck-youtube_it 0.0.1

data/README.rdoc

@@ -0,0 +1,234 @@
+== DESCRIPTION
+
+  youtube_it is the most complete Ruby client for the YouTube GData API. It provides an easy
+  way to access the latest and most complete access to YouTube's video API.
+  In comparison with the earlier Youtube interfaces, this new API and
+  library offers much-improved flexibility around executing complex search
+  queries to obtain well-targeted video search results.  In addition, standard video management 
+  including but not limited to uploading, deleting, updating, like, dislike, ratings and
+  comments.
+  
+== INSTALLATION & SETUP:
+  * Create a youtube account.
+  * Create a developer key here http://code.google.com/apis/youtube/dashboard.
+  * sudo gem install youtube_it
+
+Note: youtube_it supports ClientLogin(YouTube account), OAuth or AuthSub authentication methods.
+
+== ESTABLISHING A CLIENT
+
+Creating a client:
+  $ require 'youtube_it'
+  $ client = YouTubeIt::Client.new
+
+Client with developer key:
+  $ client = YouTubeIt::Client.new(:dev_key => "developer_key")
+    
+Client with youtube account and developer key:
+  $ client = YouTubeIt::Client.new(:username => "youtube_username", :password =>  "youtube_passwd", :dev_key => "developer_key")
+
+Client with AuthSub:
+    $ client = YouTubeIt::AuthSubClient.new(:token => "token" , :dev_key => "developer_key")
+
+Client with OAuth:
+  $ client = YouTubeIt::OAuthClient.new("consumer_key", "consumer_secret", "youtube_username", "developer_key")
+  $ client.authorize_from_access("access_token", "access_secret")
+
+== VIDEO QUERIES
+
+Note:  Each type of client enables searching capabilities.
+
+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')
+  $ client.video_by("FQK1URcxmb4")
+  $ client.video_by_user("chebyte","FQK1URcxmb4")
+
+Standard Queries:
+  $ 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'] })
+
+
+Fields Parameter(experimental features):
+  Return videos more than 1000 views
+  $ client.videos_by(:fields => {:view_count => "1000"})
+
+  Filter by date
+  $ client.videos_by(:fields => {:published  => ((Date.today)})
+  $ client.videos_by(:fields => {:recorded   => ((Date.today)})  
+
+  Filter by date with range
+  $ client.videos_by(:fields => {:published  => ((Date.today - 30)..(Date.today))})
+  $ client.videos_by(:fields => {:recorded   => ((Date.today - 30)..(Date.today))})  
+  
+== VIDEO MANAGEMENT
+
+Note: YouTube account, OAuth or AuthSub enables video management.
+
+Upload Video:
+  $ client.video_upload(File.open("test.mov"), :title => "test",:description => 'some description', :category => 'People',:keywords => %w[cool blah test])
+
+Upload Video With A Developer Tag (Note the tags are not immediately available):
+  $ client.video_upload(File.open("test.mov"), :title => "test",:description => 'some description', :category => 'People',:keywords => %w[cool blah test], :dev_tag => 'tagdev')
+
+Update Video:
+  $ client.video_update("FQK1URcxmb4", :title => "new test",:description => 'new description', :category => 'People',:keywords => %w[cool blah test])
+
+Delete Video:
+  $ client.video_delete("FQK1URcxmb4")
+
+My Videos:
+  $ client.my_videos
+
+My Video:
+  $ client.my_video(video_id)
+  
+Profile Details:
+  $ client.profile(user) #default: current user
+
+List Comments:
+  $ client.comments(video_id)
+
+Add A Comment:
+  $ client.add_comment(video_id, "test comment!")
+
+List Favorites:
+  $ client.favorites(user) # default: current user
+
+Add Favorite:
+  $ client.add_favorite(video_id)
+
+Delete Favorite:
+  $ client.delete_favorite(video_id)
+
+Like A Video:
+  $ client.like_video(video_id)
+
+Dislike A Video:
+  $ client.dislike_video(video_id)
+
+List Subscriptions:
+  $ client.subscriptions(user) # default: current user
+
+Subscribe To A Channel:
+  $ client.subscribe_channel(channel_name)
+
+Unsubscribe To A Channel:
+  $ client.unsubscribe_channel(subscription_id)
+
+List Playlists:
+  $ client.playlists(user) # default: current user
+
+Select Playlist:
+  $ client.playlist(playlist_id)
+
+Select All Videos From A Playlist:
+  $ playlist = client.playlist(playlist_id)
+  $ playlist.videos
+
+Create Playlist:
+  $ playlist = client.add_playlist(:title => "new playlist", :description => "playlist description")
+
+Delete Playlist:
+  $ client.delete_playlist(playlist_id)
+
+Add Video To Playlist:
+  $ client.add_video_to_playlist(playlist_id, video_id)
+
+Remove Video From Playlist:
+  $ client.remove_video_from_playlist(playlist_id, playlist_entry_id)
+  
+== ACCESS CONTROL LIST
+
+  You can give permissions in your videos, for example denied comments, rate, etc...
+  you can read more there http://code.google.com/apis/youtube/2.0/reference.html#youtube_data_api_tag_yt:accessControl
+  you have available the followings options:
+
+* :rate, :comment, :commentVote, :videoRespond, :list, :embed, :syndicate
+
+  with just two values:
+*    allowed or denied
+
+  Example
+
+  client = YouTubeIt::Client.new(:username => "youtube_username", :password =>  "youtube_passwd", :dev_key => "developer_key")
+
+* upload video with denied comments
+
+  client.video_upload(File.open("test.mov"), :title => "test",:description => 'some description', :category => 'People',:keywords => %w[cool blah test], :comment => "denied")
+
+
+== Video Upload From Browser:
+
+When uploading a video from your browser you need make a form upload with the followings params:
+  $ upload_token(params, nexturl)
+params  => params like :title => "title", :description => "description", :category => "People", :tags => ["test"]
+nexturl => redirect to this url after upload
+
+
+Controller
+  def upload
+    @upload_info = YouTubeIt::Client.new.upload_token(params, videos_url)
+  end
+
+View (upload.html.erb)
+  <% form_tag @upload_info[:url], :multipart => true do %>
+    <%= hidden_field_tag :token, @upload_info[:token] %>
+    <%= label_tag :file %>
+    <%= file_field_tag :file %>
+    <%= submit_tag "Upload video" %>
+  <% end %>
+
+== WIDESCREEN VIDEOS
+
+If the videos has support for widescreen:
+  $ video.embed_html_with_width(1280)
+
+Note: you can specify width or just use the default of 1280.
+
+== LOGGING
+
+YouTubeIt passes all logs through the logger variable on the class itself. In Rails context, assign the Rails logger to that variable to collect the messages
+(don't forget to set the level to debug):
+  $ YouTubeIt.logger = RAILS_DEFAULT_LOGGER
+  $ RAILS_DEFAULT_LOGGER.level = Logger::DEBUG
+
+== CONTRIBUTORS:
+
+* Kyle J. Ginavan.
+* Mauro Torres - http://github.com/chebyte
+* Marko Seppa - https://github.com/mseppae
+
+== LICENSE:
+
+MIT License
+
+Copyright (c) 2010 Kyle J. Ginavan
+
+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,35 @@
+require 'rubygems'
+require 'rake'
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "constantations #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/lib/youtube_it/chain_io.rb

@@ -0,0 +1,76 @@
+require 'delegate'
+#:stopdoc:
+
+# Stream wrapper that reads IOs in succession. Can be fed to Net::HTTP as post body stream. We use it internally to stream file content
+# instead of reading whole video files into memory. Strings passed to the constructor will be wrapped in StringIOs. By default it will auto-close
+# file handles when they have been read completely to prevent our uploader from leaking file handles
+#
+# chain = ChainIO.new(File.open(__FILE__), File.open('/etc/passwd'), "abcd")
+class YouTubeIt::ChainIO
+  attr_accessor :autoclose
+
+  def initialize(*any_ios)
+    @autoclose = true
+    @chain = any_ios.flatten.map{|e| e.respond_to?(:read)  ? e : StringIO.new(e.to_s) }
+  end
+
+  def read(buffer_size = 1024)
+    # Read off the first element in the stack
+    current_io = @chain.shift
+    return false if !current_io
+    
+    buf = current_io.read(buffer_size)
+    if !buf && @chain.empty? # End of streams
+      release_handle(current_io) if @autoclose
+      false
+    elsif !buf # This IO is depleted, but next one is available
+      release_handle(current_io) if @autoclose
+      read(buffer_size)
+    elsif buf.length < buffer_size # This IO is depleted, but we were asked for more
+      release_handle(current_io) if @autoclose
+      buf + (read(buffer_size - buf.length) || '') # and recurse
+    else # just return the buffer
+      @chain.unshift(current_io) # put the current back
+      buf
+    end
+  end
+  
+  # Predict the length of all embedded IOs. Will automatically send file size.  
+  def expected_length
+    @chain.inject(0) do | len, io |
+      if io.respond_to?(:length)
+        len + (io.length - io.pos)
+      elsif io.is_a?(File)
+        len + File.size(io.path) - io.pos
+      else
+        raise "Cannot predict length of #{io.inspect}"
+      end
+    end
+  end
+    
+  private
+    def release_handle(io)
+      io.close if io.respond_to?(:close)
+    end
+end
+  
+# Net::HTTP only can send chunks of 1024 bytes. This is very inefficient, so we have a spare IO that will send more when asked for 1024.
+# We use delegation because the read call is recursive.
+class YouTubeIt::GreedyChainIO < DelegateClass(YouTubeIt::ChainIO)
+  BIG_CHUNK = 512 * 1024 # 500 kb
+  
+  def initialize(*with_ios)
+    __setobj__(YouTubeIt::ChainIO.new(with_ios))
+  end
+  
+  def read(any_buffer_size)
+    __getobj__.read(BIG_CHUNK)
+  end
+
+  def length()
+    __getobj__.expected_length
+  end
+
+end
+
+#:startdoc: