tubeclip 0.1.0

data/lib/tubeclip/model/comment.rb

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

data/lib/tubeclip/model/contact.rb

@@ -0,0 +1,19 @@
+class Tubeclip
+  module Model
+    class Contact < Tubeclip::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
+      
+      # *String*:: The Youtube title of the contact.
+      attr_reader :title
+    end
+  end
+end

data/lib/tubeclip/model/content.rb

@@ -0,0 +1,18 @@
+class Tubeclip
+  module Model
+    class Content < Tubeclip::Record
+      # *Boolean*:: Description of the video.
+      attr_reader :default
+      # *Fixnum*:: Length of the video in seconds.
+      attr_reader :duration
+      # Tubeclip::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/tubeclip/model/message.rb

@@ -0,0 +1,12 @@
+class Tubeclip
+  module Model
+    class Message < Tubeclip::Record
+      attr_reader :id, :name, :title, :summary, :published
+      
+      def content
+        # This tag contains the same value as the <summary> tag.
+        self.summary
+      end
+    end
+  end
+end

data/lib/tubeclip/model/playlist.rb

@@ -0,0 +1,11 @@
+class Tubeclip
+  module Model
+    class Playlist < Tubeclip::Record
+      attr_reader :title, :description, :summary, :author, :videos_count, :playlist_id, :xml, :published, :response_code
+      def videos
+        Tubeclip::Parser::VideosFeedParser.new(@xml).parse_videos
+      end
+    end
+  end
+end
+

data/lib/tubeclip/model/rating.rb

@@ -0,0 +1,23 @@
+class Tubeclip
+  module Model
+    class Rating < Tubeclip::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
+
+      # *Fixnum*:: Indicates how many people likes this video
+      attr_reader :likes
+
+      # *Fixnum*:: Indicates how many people dislikes this video
+      attr_reader :dislikes
+    end
+  end
+end

data/lib/tubeclip/model/subscription.rb

@@ -0,0 +1,7 @@
+class Tubeclip
+  module Model
+    class Subscription < Tubeclip::Record
+      attr_reader :id, :title, :published, :youtube_user_name
+    end
+  end
+end

data/lib/tubeclip/model/thumbnail.rb

@@ -0,0 +1,20 @@
+class Tubeclip
+  module Model
+    class Thumbnail < Tubeclip::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
+
+      # *String*:: Specified type of the thumbnail, attribute yt:name in feed
+      attr_reader :name
+    end
+  end
+end

data/lib/tubeclip/model/user.rb

@@ -0,0 +1,35 @@
+class Tubeclip
+  module Model
+    class User < Tubeclip::Record
+      attr_reader :age
+      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
+      attr_reader :channel_uri
+    end
+  end
+end

data/lib/tubeclip/model/video.rb

@@ -0,0 +1,302 @@
+# TODO
+#  * self atom feed
+#  * alternate youtube watch url
+#  * comments feedLink
+
+class Tubeclip
+  module Model
+    class Video < Tubeclip::Record
+      # Describes the various file formats in which a Youtube video may be
+      # made available and allows looking them up by format code number.
+      class Format
+        attr_reader :format_code, :name
+
+        @@formats = Hash.new
+
+        # Instantiates a new video format object.
+        #
+        # == Parameters
+        #   :format_code<Fixnum>:: The Youtube Format code of the object.
+        #   :name<Symbol>:: The name of the format
+        #
+        # == Returns
+        #   Tubeclip::Model::Video::Format: Video format object
+        def initialize(format_code, name)
+          @format_code = format_code
+          @name = name
+
+          @@formats[format_code] = self
+        end
+
+        # Allows you to get the video format for a specific format code.
+        #
+        # A full list of format codes is available at:
+        #
+        # http://code.google.com/apis/youtube/reference.html#youtube_data_api_tag_media:content
+        #
+        # == Parameters
+        #   :format_code<Fixnum>:: The Youtube Format code of the object.
+        #
+        # == Returns
+        #   Tubeclip::Model::Video::Format: Video format object
+        def self.by_code(format_code)
+          @@formats[format_code]
+        end
+
+        # Flash format on YouTube site. All videos are available in this format.
+        FLASH = Tubeclip::Model::Video::Format.new(0, :flash)
+
+        # RTSP streaming URL for mobile video playback. H.263 video (176x144) and AMR audio.
+        RTSP = Tubeclip::Model::Video::Format.new(1, :rtsp)
+
+        # HTTP URL to the embeddable player (SWF) for this video. This format
+        # is not available for a video that is not embeddable.
+        SWF = Tubeclip::Model::Video::Format.new(5, :swf)
+
+        # RTSP streaming URL for mobile video playback. MPEG-4 SP video (up to 176x144) and AAC audio.
+        THREE_GPP = Tubeclip::Model::Video::Format.new(6, :three_gpp)
+      end
+
+      # *Fixnum*:: Duration of a video in seconds.
+      attr_reader :duration
+
+      # *Boolean*:: Specifies that a video may or may not be 16:9 ratio.
+      attr_reader :widescreen
+
+      # *Boolean*:: Specifies that a video may or may not be embedded on other websites.
+      attr_reader :noembed
+
+      # *Fixnum*:: Specifies the order in which the video appears in a playlist.
+      attr_reader :position
+
+      # *Boolean*:: Specifies that a video is flagged as adult or not.
+      attr_reader :safe_search
+
+      # *String*: Specifies a URI that uniquely and permanently identifies the video.
+      attr_reader :video_id
+
+      # *Time*:: When the video was published on Youtube.
+      attr_reader :published_at
+
+      # *Time*:: When the video's data was last updated.
+      attr_reader :updated_at
+
+      # *Time*:: When the video's was uploaded.
+      attr_reader :uploaded_at
+
+      # *Time*:: When the video's was recorded.
+      attr_reader :recorded_at
+
+      # *Array*:: A array of Tubeclip::Model::Category objects that describe the videos categories.
+      attr_reader :categories
+
+      # *Array*:: An array of words associated with the video.
+      attr_reader :keywords
+
+      # *String*:: Description of the video.
+      attr_reader :description
+
+      # *String*:: Title for the video.
+      attr_reader :title
+
+      # *String*:: Description of the video.
+      attr_reader :html_content
+
+      # *String*:: Description of the video.
+      attr_reader :raw_content
+
+      # Tubeclip::Model::Author:: Information about the YouTube user who owns a piece of video content.
+      attr_reader :author
+
+      # *Array*:: An array of Tubeclip::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 Tubeclip::Model::Thumbnail objects that contain information regarding the videos thumbnail images.
+      attr_reader :thumbnails
+
+      # *String*:: The link to watch the URL on YouTubes website.
+      attr_reader :player_url
+
+      # Tubeclip::Model::Rating:: Information about the videos rating.
+      attr_reader :rating
+
+      # *Fixnum*:: Number of times that the video has been viewed
+      attr_reader :view_count
+
+      # *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 :position
+      attr_reader :latitude
+      attr_reader :longitude
+
+      # Playlist position
+      attr_reader :video_position
+
+      # Videos related to the current video.
+      #
+      # === Returns
+      #   Tubeclip::Response::VideoSearch
+      def related
+        Tubeclip::Parser::VideosFeedParser.new("http://gdata.youtube.com/feeds/api/videos/#{unique_id}/related?v=#{Tubeclip::API_VERSION}").parse
+      end
+      # Video responses to the current video.
+      #
+      # === Returns
+      #   Tubeclip::Response::VideoSearch
+      def responses
+        Tubeclip::Parser::VideosFeedParser.new("http://gdata.youtube.com/feeds/api/videos/#{unique_id}/responses?v=#{Tubeclip::API_VERSION}").parse
+      end
+
+
+      # ID of video in playlist listing
+      # Useful if you have to delete this video from a playlist
+      #
+      # === Example
+      #   >> video.in_playlist_id 
+      #   => "PLk3UVPlPEkey09s2W02R48WMDKjvSb6Hq" 
+      #
+      # === Returns
+      #   String the video id
+      #
+      def in_playlist_id
+        @video_id.split(':').last
+      end
+
+      # The ID of the video, useful for searching for the video again without having to store it anywhere.
+      # A regular query search, with this id will return the same video.
+      #
+      # === Example
+      #   >> video.unique_id
+      #   => "ZTUVgYoeN_o"
+      #
+      # === Returns
+      #   String: The Youtube video id.
+      def unique_id
+        @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
+      #   Boolean: True if the video can be embedded, false if not.
+      def embeddable?
+        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
+      # Boolean: True if the video is (approximately) 16:9, false if not.
+      def widescreen?
+        @widescreen
+      end
+
+      # Provides a URL and various other types of information about a video.
+      #
+      # === Returns
+      #   Tubeclip::Model::Content: Data about the embeddable video.
+      def default_media_content
+        @media_content.find { |c| c.is_default? }
+      end
+
+      # Gives you the HTML to embed the video on your website.
+      #
+      # === Returns
+      #   String: The HTML for embedding the video on your website.
+      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
+
+      # Gives you the HTML 5 to embed the video on your website.
+      # Usefull for mobile that not support flash but has html5 browser
+      # === Returns
+      #   String: The HTML for embedding the video on your website.
+      def embed_html5(params = {})
+        opts = {:class  => params[:class]  || "",
+                :id     => params[:id]     || "",
+                :width  => params[:width]  || "425",
+                :height => params[:height] || "350",
+                :protocol => params[:protocol] || "http",
+                :frameborder => params[:frameborder] || "0",
+                :url_params => params[:url_params] || {},
+                :sandbox => params[:sandbox] || false,
+                :fullscreen => params[:fullscreen] || false,
+                }
+        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="#{opts[:protocol]}://www.youtube.com/embed/#{unique_id}#{url_opts}" frameborder="#{opts[:frameborder]}" #{" sandbox=\"#{opts[:sandbox]}\" " if opts[:sandbox]} #{"allowfullscreen" if opts[:fullscreen]}></iframe>
+EDOC
+      end
+
+      # Gives you the HTML to embed the video on your website.
+      #
+      # === Returns
+      # String: The HTML for embedding the video on your website.
+      def embed_html_with_width(width = 1280)
+        height = (widescreen? ? width * 9/16 : width * 3/4) + 25
+
+        <<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
+
+      # The URL needed for embedding the video in a page.
+      #
+      # === Returns
+      #   String: Absolute URL for embedding video
+      def embed_url
+        @player_url.sub('watch?', '').sub('=', '/').sub('feature/', 'feature=')
+      end
+
+
+    end
+  end
+end
+