youtube_it 2.1.4 → 2.1.5

data/README.rdoc

@@ -1,3 +1,5 @@
+== YOUTUBE_IT {<img src="https://secure.travis-ci.org/kylejginavan/youtube_it.png"/>}[http://travis-ci.org/kylejginavan/youtube_it]
+
 == DONATION
 
   YOUTUBE_IT is developed by many contributors who are passioned about opensource projects 
@@ -58,6 +60,12 @@ If your access token is still valid (be careful, access tokens may only be valid
 
   $ client.refresh_access_token!
 
+== PROFILES
+  you can use multiple profiles in the same account like that
+
+  $ profiles = client.profiles(['username1','username2']) 
+  $ profiles['username1'].username, "username1"
+
 == VIDEO QUERIES
 
 Note:  Each type of client enables searching capabilities.
@@ -84,6 +92,16 @@ Advanced Queries (with boolean operators OR (either), AND (include), NOT (exclud
   $ client.videos_by(:categories => { :either => [:news, :sports], :exclude => [:comedy] }, :tags => { :include => ['football'], :exclude => ['soccer'] })
 
 
+Custom Query Params
+ You can use custom query params like that:
+
+   $ client.videos_by(:query => "penguin", :safe_search => "strict")
+   $ client.videos_by(:query => "penguin", :duration => "long")
+   $ client.videos_by(:query => "penguin", :hd => "true")
+   $ client.videos_by(:query => "penguin", :region => "AR")
+
+ you can see more options here https://developers.google.com/youtube/2.0/reference#yt_format
+
 Fields Parameter(experimental features):
   Return videos more than 1000 views
   $ client.videos_by(:fields => {:view_count => "1000"})
@@ -106,6 +124,10 @@ Upload Video:
 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')
 
+Upload Private Video:
+  $ client.video_upload(File.open("test.mov"), :title => "test",:description => 'some description', :category => 'People',:keywords => %w[cool blah test], :private => true)
+
+
 Update Video:
   $ client.video_update("FQK1URcxmb4", :title => "new test",:description => 'new description', :category => 'People',:keywords => %w[cool blah test])
 
@@ -117,7 +139,7 @@ My Videos:
 
 My Video:
   $ client.my_video(video_id)
-  
+
 Profile Details:
   $ client.profile(user) #default: current user
 
@@ -127,6 +149,12 @@ List Comments:
 Add A Comment:
   $ client.add_comment(video_id, "test comment!")
 
+Add A Reply Comment:
+  $ client.add_comment(video_id, "test reply!", :reply_to => another_comment)
+
+Delete A Comment:
+  $ client.delete_comment(video_id, comment_id)
+
 List Favorites:
   $ client.favorites(user) # default: current user
 
@@ -134,7 +162,7 @@ Add Favorite:
   $ client.add_favorite(video_id)
 
 Delete Favorite:
-  $ client.delete_favorite(video_id)
+  $ client.delete_favorite(favorite_entry_id)
 
 Like A Video:
   $ client.like_video(video_id)
@@ -151,8 +179,17 @@ Subscribe To A Channel:
 Unsubscribe To A Channel:
   $ client.unsubscribe_channel(subscription_id)
 
+List New Subscription Videos:
+  $ client.new_subscription_videos(user) # default: current user
+  
 List Playlists:
-  $ client.playlists(user) # default: current user
+  $ client.playlists(user, order_by) # default: current user, position
+
+  for example you can get the videos of your playlist ordered by title
+
+  $ client.playlists(user, "title")
+
+  you can see more about options for order_by here: https://developers.google.com/youtube/2.0/reference#orderbysp
 
 Select Playlist:
   $ client.playlist(playlist_id)
@@ -173,6 +210,17 @@ Add Video To Playlist:
 Remove Video From Playlist:
   $ client.remove_video_from_playlist(playlist_id, playlist_entry_id)
 
+Select All Videos From your Watch Later Playlist:
+  $ watcher_later = client.watcherlater(user) #default: current user
+  $ watcher_later.videos
+
+Add Video To Watcher Later Playlist:
+  $ client.add_video_to_watchlater(video_id)
+
+Remove Video From Watch Later Playlist:
+  $ client.remove_video_from_watchlater(watchlater_entry_id)
+
+
 List Related Videos
   $ video = client.video_by("https://www.youtube.com/watch?v=QsbmrCtiEUU&feature=player_embedded")
   $ video.related.videos
@@ -207,7 +255,11 @@ List Response Videos
 
   client.video_upload(File.open("test.mov"), :title => "test",:description => 'some description', :category => 'People',:keywords => %w[cool blah test], :comment => "denied")
 
-
+== User Activity
+ You can get user activity with the followings params:
+ 
+ $ client.activity(user) #default current user
+ 
 == Video Upload From Browser:
 
 When uploading a video from your browser you need make a form upload with the followings params:
@@ -241,7 +293,7 @@ Note: you can specify width or just use the default of 1280.
 Now you can embed videos without use flash using html5, usefull for mobiles that not support flash but has html5 browser
 
 You can specify these options
-  $ video.embed_html5({:class => 'video-player', :id => 'my-video', :width => '425', :height => '350', :frameborder => '1'})
+  $ video.embed_html5({:class => 'video-player', :id => 'my-video', :width => '425', :height => '350', :frameborder => '1', :url_params => {:option_one => "value", :option_two => "value"}})
 
 or just use with default options
   $ video.embed_html5 #default: width: 425, height: 350, frameborder: 0

data/lib/youtube_it.rb

@@ -2,9 +2,10 @@ require 'logger'
 require 'open-uri'
 require 'net/https'
 require 'digest/md5'
-require 'rexml/document'
+require 'nokogiri'
 require 'builder'
 require 'oauth'
+require 'oauth2'
 require 'faraday'
 
 class YouTubeIt
@@ -19,8 +20,7 @@ class YouTubeIt
   end
 
   def self.esc(s) #:nodoc:
-    # URI encodes correctly Unicode characters
-    URI.encode(s.to_s.tr(' ','+'))
+    CGI.escape(s.to_s)
   end
 
   # Set the logger for the library

data/lib/youtube_it/chain_io.rb

@@ -63,7 +63,7 @@ class YouTubeIt::GreedyChainIO < DelegateClass(YouTubeIt::ChainIO)
     __setobj__(YouTubeIt::ChainIO.new(with_ios))
   end
   
-  def read(any_buffer_size)
+  def read(any_buffer_size = nil)
     __getobj__.read(BIG_CHUNK)
   end
 

data/lib/youtube_it/client.rb

@@ -38,7 +38,7 @@ class YouTubeIt
     #
     # 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),
+    #                  :author, :safe_search, :response_format, :video_format, :page (default is 1),
     #                  and :per_page(default is 25)
     #
     #   options<Hash>:: Not used. (Optional)
@@ -122,8 +122,12 @@ class YouTubeIt
       client.get_upload_token(options, nexturl)
     end
 
-    def add_comment(video_id, comment)
-      client.add_comment(video_id, comment)
+    def add_comment(video_id, comment, opts = {})
+      client.add_comment(video_id, comment, opts)
+    end
+
+    def delete_comment(video_id, comment_id)
+      client.delete_comment(video_id, comment_id)
     end
 
     # opts is converted to get params and appended to comments gdata api url
@@ -148,14 +152,30 @@ class YouTubeIt
     def profile(user = nil)
       client.profile(user)
     end
+
+    def profiles(*users)
+      client.profiles(*users)
+    end
     
     # Fetches a user's activity feed.
     def activity(user = nil, opts = {})
       client.get_activity(user, opts)
     end
 
-    def playlist(playlist_id)
-      client.playlist playlist_id
+    def watchlater(user = nil)
+      client.watchlater(user)
+    end
+    
+    def add_video_to_watchlater(video_id)
+      client.add_video_to_watchlater(video_id)
+    end
+
+    def delete_video_from_watchlater(video_id)
+      client.delete_video_from_watchlater(video_id)
+    end
+
+    def playlist(playlist_id, order_by = :position)
+      client.playlist(playlist_id, order_by)
     end
 
     def playlists(user = nil)
@@ -228,20 +248,30 @@ class YouTubeIt
       client.get_my_videos(opts)
     end
     
-    # Get's all of the user's contacts/friends. 
+    # Gets all of the user's contacts/friends. 
     def my_contacts(opts = {})
       client.get_my_contacts(opts)
     end
     
-    # Send vedio message
+    # Send video message
     def send_message(opts = {})
       client.send_message(opts)
     end
     
-    # Get's all of the user's messages/inbox. 
+    # Gets all of the user's messages/inbox. 
     def my_messages(opts = {})
       client.get_my_messages(opts)
     end
+    
+    # Gets the user's watch history
+    def watch_history
+      client.get_watch_history
+    end
+    
+    # Gets new subscription videos
+    def new_subscription_videos(user_id = nil)
+      client.new_subscription_videos(user_id)
+    end
 
     private
 
@@ -388,7 +418,7 @@ class YouTubeIt
       response_code = profile.code.to_i
 
       if response_code/10 == 20 # success
-        REXML::Document.new(profile.body).elements["entry"].elements['author'].elements['name'].text
+        Nokogiri::XML(profile.body).at("entry/author/name").text
       elsif response_code == 403 || response_code == 401 # auth failure
         raise YouTubeIt::Upload::AuthenticationError.new(profile.inspect, response_code)
       else
@@ -413,6 +443,7 @@ class YouTubeIt
       @client_refresh_token    = options[:client_refresh_token]
       @client_token_expires_at = options[:client_token_expires_at]
       @dev_key                 = options[:dev_key]
+      @legacy_debug_flag       = options[:debug]
     end
 
     def oauth_client
@@ -427,7 +458,13 @@ class YouTubeIt
     end
 
     def refresh_access_token!
-      @access_token = access_token.refresh!
+      new_access_token = access_token.refresh!
+      require 'thread' unless Thread.respond_to?(:exclusive)
+      Thread.exclusive do
+        @access_token = new_access_token
+        @client = nil
+      end
+      @access_token
     end
 
     def current_user
@@ -435,7 +472,7 @@ class YouTubeIt
       response_code = profile.status
 
       if response_code/10 == 20 # success
-        REXML::Document.new(profile.body).elements["entry"].elements['author'].elements['name'].text
+        Nokogiri::XML(profile.body).at("entry/author/name").text
       elsif response_code == 403 || response_code == 401 # auth failure
         raise YouTubeIt::Upload::AuthenticationError.new(profile.inspect, response_code)
       else

data/lib/youtube_it/model/comment.rb

@@ -1,14 +1,14 @@
 class YouTubeIt
   module Model
     class Comment < YouTubeIt::Record
-      attr_reader :content, :published, :title, :updated, :url
+      attr_reader :content, :published, :title, :updated, :url, :reply_to
 
       # YouTubeIt::Model::Author:: Information about the YouTube user who owns a piece of video content.
       attr_reader :author
-      
+
       # unique ID of the comment.
       def unique_id
-        url.split("/").last
+        url.split(":").last
       end
     end
   end

data/lib/youtube_it/model/playlist.rb

@@ -3,7 +3,7 @@ class YouTubeIt
     class Playlist < YouTubeIt::Record
       attr_reader :title, :description, :summary, :playlist_id, :xml, :published, :response_code
       def videos
-        YouTubeIt::Parser::VideosFeedParser.new("http://gdata.youtube.com/feeds/api/playlists/#{playlist_id}?v=2").parse_videos
+        YouTubeIt::Parser::VideosFeedParser.new(@xml).parse_videos
       end
     end
   end

data/lib/youtube_it/model/user.rb

@@ -5,23 +5,30 @@ class YouTubeIt
       attr_reader :books
       attr_reader :company
       attr_reader :description
+      attr_reader :first_name
       attr_reader :gender
       attr_reader :hobbies
       attr_reader :hometown
       attr_reader :last_login
+      attr_reader :last_name
       attr_reader :location
       attr_reader :join_date
+      attr_reader :max_upload_duration
       attr_reader :movies
       attr_reader :music
       attr_reader :occupation
       attr_reader :relationship
       attr_reader :school
       attr_reader :subscribers
+      attr_reader :upload_count
       attr_reader :upload_views
+      attr_reader :user_id
       attr_reader :username
+      attr_reader :username_display
       attr_reader :videos_watched
       attr_reader :view_count
       attr_reader :avatar
+      attr_reader :insight_uri
     end
   end
 end

data/lib/youtube_it/model/video.rb

@@ -68,7 +68,7 @@ class YouTubeIt
       attr_reader :position
 
       # *Boolean*:: Specifies that a video is flagged as adult or not.
-      attr_reader :racy
+      attr_reader :safe_search
 
       # *String*: Specifies a URI that uniquely and permanently identifies the video.
       attr_reader :video_id
@@ -79,6 +79,9 @@ class YouTubeIt
       # *Time*:: When the video's data was last updated.
       attr_reader :updated_at
 
+      # *Time*:: When the video's was uploaded.
+      attr_reader :uploaded_at
+
       # *Array*:: A array of YouTubeIt::Model::Category objects that describe the videos categories.
       attr_reader :categories
 
@@ -100,6 +103,9 @@ class YouTubeIt
       # *Array*:: An array of YouTubeIt::Model::Content objects describing the individual media content data available for this video.  Most, but not all, videos offer this.
       attr_reader :media_content
 
+      # *Hash*:: string-keyed, string-valued permissions e.g., {'comment'=>'allowed','videoRespond'=>'moderated'}
+      attr_reader :access_control
+
       # *Array*:: An array of YouTubeIt::Model::Thumbnail objects that contain information regarding the videos thumbnail images.
       attr_reader :thumbnails
 
@@ -114,13 +120,20 @@ class YouTubeIt
 
       # *Fixnum*:: Number of times that the video has been favorited
       attr_reader :favorite_count
+
+      # *Fixnum*:: Number of comments for this video
+      attr_reader :comment_count
       
       # *String*:: State of the video (processing, restricted, deleted, rejected and failed)
       attr_reader :state
 
+      # *String*:: URI for insight for this video, if present; nil otherwise
+      attr_reader :insight_uri
 
+      # *Boolean*:: Whether or not a video is private. Non-standard name to avoid collision with Rubys own 'private' stuff.
+      attr_reader :perm_private
+ 
       # Geodata
-      attr_reader :where
       attr_reader :position
       attr_reader :latitude
       attr_reader :longitude
@@ -152,6 +165,16 @@ class YouTubeIt
         @unique_id || video_id[/videos\/([^<]+)/, 1] || video_id[/video\:([^<]+)/, 1]
       end
 
+      # ID of this video in the watch later list (work only if you are listing watch later videos)
+      # Can be use to modify or remove the entry from the watch later list
+      #
+      # === Example
+      #   >> @client.watchlater.videos.first.watch_later_id
+      #   => "PL78jdHcOatSF7DGMd4O9K6Mbo0cNlxm_j"
+      def watch_later_id
+        video_id[/watch_later\:([^:]+)/, 1]
+      end
+
       # Allows you to check whether the video can be embedded on a webpage.
       #
       # === Returns
@@ -160,6 +183,14 @@ class YouTubeIt
         not @noembed
       end
 
+      # Allows you to check whether the video is listed and searchable on youtube.
+      #
+      # === Returns
+      #   Boolean
+      def listed?
+        access_control['list'] == 'allowed'
+      end
+
       # Allows you to check whether the video is widescreen (16:9) or not.
       #
       # === Returns
@@ -200,10 +231,12 @@ EDOC
                       :id     => params[:id]     || "",
                       :width  => params[:width]  || "425",
                       :height => params[:height] || "350",
-                      :frameborder => params[:frameborder] || "0"
+                      :frameborder => params[:frameborder] || "0",
+                      :url_params => params[:url_params] || {}
                       }
+              url_opts = opts[:url_params].empty? ? "" : "?#{Rack::Utils::build_query(opts[:url_params])}"
               <<EDOC
-<iframe class="#{opts[:class]}" id="#{opts[:id]}" type="text/html" width="#{opts[:width]}" height="#{opts[:height]}" src="http://www.youtube.com/embed/#{unique_id}" frameborder="#{opts[:frameborder]}"></iframe>
+<iframe class="#{opts[:class]}" id="#{opts[:id]}" type="text/html" width="#{opts[:width]}" height="#{opts[:height]}" src="http://www.youtube.com/embed/#{unique_id}#{url_opts}" frameborder="#{opts[:frameborder]}"></iframe>
 EDOC
             end