video_info 0.2.7 → 0.2.8

data/README.md

@@ -1,52 +1,73 @@
-VideoInfo [![Build Status](https://secure.travis-ci.org/thibaudgg/video_info.png?branch=master)](http://travis-ci.org/thibaudgg/video_info)
-=========
-  
-Small Ruby Gem to get video info from youtube and vimeo url.
-Tested against Ruby 1.8.7, 1.9.2, REE and the latest versions of JRuby & Rubinius.
-  
-Install
---------
-
-``` bash
-  gem install video_info
-```
-  
-Usage
------
-  
-``` ruby
-  video = VideoInfo.new("http://www.youtube.com/watch?v=mZqGqE0D0n4")
-  
-  # video.video_id         => "mZqGqE0D0n4"
-  # video.provider         => "YouTube"
-  # video.title            => "Cherry Bloom - King Of The Knife"
-  # video.description      => "The first video from the upcoming album Secret Sounds, to download in-stores April 14. Checkout http://www.cherrybloom.net"
-  # video.keywords         => "alternative, bloom, cherry, clip, drum, guitar, king, knife, of, Paris-Forum, rock, the, tremplin"
-  # video.duration         => 175 (in seconds)
-  # video.date             => Sat Apr 12 22:25:35 UTC 2008
-  # video.thumbnail_small  => "http://i.ytimg.com/vi/mZqGqE0D0n4/2.jpg"
-  # video.thumbnail_large  => "http://i.ytimg.com/vi/mZqGqE0D0n4/0.jpg"
-  
-  video = VideoInfo.new("http://vimeo.com/898029")
-  
-  # video.video_id         => "898029"
-  # video.provider         => "Vimeo"
-  # video.title            => "Cherry Bloom - King Of The Knife"
-  # video.description      => "The first video from the upcoming album Secret Sounds, to download in-stores April 14. Checkout http://www.cherrybloom.net"
-  # video.keywords         => "alternative, bloom, cherry, clip, drum, guitar, king, knife, of, Paris-Forum, rock, the, tremplin"
-  # video.duration         => 175 (in seconds)
-  # video.date             => Mon Apr 14 13:10:39 +0200 2008
-  # video.width            => 640
-  # video.height           => 360
-  # video.thumbnail_small  => "http://ts.vimeo.com.s3.amazonaws.com/343/731/34373130_100.jpg"
-  # video.thumbnail_large  => "http://ts.vimeo.com.s3.amazonaws.com/343/731/34373130_640.jpg"
-  
-  video = VideoInfo.new("http://badurl.com/898029")
-  
-  # video.valid? => false
-```
-  
-Author
-------
-
-[Thibaud Guillaume-Gentil](https://github.com/thibaudgg) ([@thibaudgg](http://twitter.com/thibaudgg))
+VideoInfo [![Build Status](https://secure.travis-ci.org/thibaudgg/video_info.png?branch=master)](http://travis-ci.org/thibaudgg/video_info)
+=========
+  
+Small Ruby Gem to get video info from youtube and vimeo url.
+Tested against Ruby 1.8.7, 1.9.2, REE and the latest versions of JRuby & Rubinius.
+  
+Install
+--------
+
+``` bash
+  gem install video_info
+```
+  
+Usage
+-----
+  
+``` ruby
+  video = VideoInfo.new("http://www.youtube.com/watch?v=mZqGqE0D0n4")
+  
+  # video.video_id         => "mZqGqE0D0n4"
+  # video.provider         => "YouTube"
+  # video.title            => "Cherry Bloom - King Of The Knife"
+  # video.description      => "The first video from the upcoming album Secret Sounds, to download in-stores April 14. Checkout http://www.cherrybloom.net"
+  # video.keywords         => "alternative, bloom, cherry, clip, drum, guitar, king, knife, of, Paris-Forum, rock, the, tremplin"
+  # video.duration         => 175 (in seconds)
+  # video.date             => Sat Apr 12 22:25:35 UTC 2008
+  # video.thumbnail_small  => "http://i.ytimg.com/vi/mZqGqE0D0n4/2.jpg"
+  # video.thumbnail_large  => "http://i.ytimg.com/vi/mZqGqE0D0n4/0.jpg"
+  
+  video = VideoInfo.new("http://vimeo.com/898029")
+  
+  # video.video_id         => "898029"
+  # video.provider         => "Vimeo"
+  # video.title            => "Cherry Bloom - King Of The Knife"
+  # video.description      => "The first video from the upcoming album Secret Sounds, to download in-stores April 14. Checkout http://www.cherrybloom.net"
+  # video.keywords         => "alternative, bloom, cherry, clip, drum, guitar, king, knife, of, Paris-Forum, rock, the, tremplin"
+  # video.duration         => 175 (in seconds)
+  # video.date             => Mon Apr 14 13:10:39 +0200 2008
+  # video.width            => 640
+  # video.height           => 360
+  # video.thumbnail_small  => "http://ts.vimeo.com.s3.amazonaws.com/343/731/34373130_100.jpg"
+  # video.thumbnail_large  => "http://ts.vimeo.com.s3.amazonaws.com/343/731/34373130_640.jpg"
+  
+  video = VideoInfo.new("http://badurl.com/898029")
+  
+  # video.valid? => false
+```
+
+Options
+-------
+
+``` ruby
+  video = VideoInfo.new("http://www.youtube.com/watch?v=mZqGqE0D0n4", "User-Agent" => "My Youtube Mashup Robot/1.0")
+  video = VideoInfo.new("http://www.youtube.com/watch?v=mZqGqE0D0n4", "Referer"    => "http://my-youtube-mashup.com/")
+  video = VideoInfo.new("http://www.youtube.com/watch?v=mZqGqE0D0n4", "Referer"    => "http://my-youtube-mashup.com/",
+                                                                      "User-Agent" => "My Youtube Mashup Robot/1.0")
+```
+You can also use **symbols** instead of strings (any non-word (`/[^a-z]/i`) character would be converted to hyphen).
+
+``` ruby
+  video = VideoInfo.new("http://www.youtube.com/watch?v=mZqGqE0D0n4", :referer    => "http://my-youtube-mashup.com/",
+                                                                      :user_agent => "My Youtube Mashup Robot/1.0")
+```
+
+User-Agent when empty defaults to "VideoInfo/VERSION" - where version is current VideoInfo version, e.g. **"VideoInfo/0.2.7"**.
+
+It supports all openURI header fields (options), for more information see: [openURI DOCS](http://www.ruby-doc.org/stdlib-1.9.3/libdoc/open-uri/rdoc/OpenURI.html)
+
+
+Author
+------
+
+[Thibaud Guillaume-Gentil](https://github.com/thibaudgg) ([@thibaudgg](http://twitter.com/thibaudgg))

data/lib/provider/vimeo.rb

@@ -1,33 +1,32 @@
-require 'hpricot'
-require 'open-uri'
-
-class Vimeo
-  attr_accessor :video_id, :url, :provider, :title, :description, :keywords,
-                :duration, :date, :width, :height,
-                :thumbnail_small, :thumbnail_large,
-                :view_count
-
-  def initialize(url)
-    @video_id = url.gsub(/.*\.com\/(?:groups\/[^\/]+\/videos\/)?([0-9]+).*$/i, '\1')
-    get_info unless @video_id == url
-  end
-
-private
-
-  def get_info
-    doc = Hpricot(open("http://vimeo.com/api/v2/video/#{@video_id}.xml"))
-    @provider         = "Vimeo"
-    @url              = doc.search("url").inner_text
-    @title            = doc.search("title").inner_text
-    @description      = doc.search("description").inner_text
-    @keywords         = doc.search("tags").inner_text
-    @duration         = doc.search("duration").inner_text.to_i # seconds
-    @width            = doc.search("width").inner_text.to_i
-    @height           = doc.search("height").inner_text.to_i
-    @date             = Time.parse(doc.search("upload_date").inner_text, Time.now.utc).utc
-    @thumbnail_small  = doc.search("thumbnail_small").inner_text
-    @thumbnail_large  = doc.search("thumbnail_large").inner_text
-    @view_count       = doc.search("stats_number_of_plays").inner_text.to_i
-  end
-
+class Vimeo
+  attr_accessor :video_id, :url, :provider, :title, :description, :keywords,
+                :duration, :date, :width, :height,
+                :thumbnail_small, :thumbnail_large,
+                :view_count,
+                :openURI_options
+
+  def initialize(url, options = {})
+    @openURI_options = options
+    @video_id = url.gsub(/.*\.com\/(?:groups\/[^\/]+\/videos\/)?([0-9]+).*$/i, '\1')
+    get_info unless @video_id == url
+  end
+
+private
+
+  def get_info
+    doc = Hpricot(open("http://vimeo.com/api/v2/video/#{@video_id}.xml", @openURI_options))
+    @provider         = "Vimeo"
+    @url              = doc.search("url").inner_text
+    @title            = doc.search("title").inner_text
+    @description      = doc.search("description").inner_text
+    @keywords         = doc.search("tags").inner_text
+    @duration         = doc.search("duration").inner_text.to_i # seconds
+    @width            = doc.search("width").inner_text.to_i
+    @height           = doc.search("height").inner_text.to_i
+    @date             = Time.parse(doc.search("upload_date").inner_text, Time.now.utc).utc
+    @thumbnail_small  = doc.search("thumbnail_small").inner_text
+    @thumbnail_large  = doc.search("thumbnail_large").inner_text
+    @view_count       = doc.search("stats_number_of_plays").inner_text.to_i
+  end
+
 end

data/lib/provider/youtube.rb

@@ -1,47 +1,46 @@
-require 'hpricot'
-require 'open-uri'
-
-class Youtube
-  attr_accessor :video_id, :url, :provider, :title, :description, :keywords,
-                :duration, :date, :width, :height,
-                :thumbnail_small, :thumbnail_large,
-                :view_count
-
-  def initialize(url)
-    video_id_for(url)
-    get_info unless @video_id == url
-  end
-
-  def regex
-    /http:\/\/(www.)?youtube\.com\/watch\?v=([A-Za-z0-9._%-]*)(\&\S+)?|http:\/\/(www.)?youtu\.be\/([A-Za-z0-9._%-]*)?/ 
-  end
-
-  def video_id_for(url)
-    url.gsub(regex) do
-      @video_id = $2 || $5
-    end
-  end
-
-private
-
-  def get_info
-    doc = Hpricot(open("http://gdata.youtube.com/feeds/api/videos/#{@video_id}"))
-    @provider         = "YouTube"
-    @url              = "http://www.youtube.com/watch?v=#{@video_id}"
-    @title            = doc.search("media:title").inner_text
-    @description      = doc.search("media:description").inner_text
-    @keywords         = doc.search("media:keywords").inner_text
-    @duration         = doc.search("yt:duration").first[:seconds].to_i
-    @date             = Time.parse(doc.search("published").inner_text, Time.now.utc)
-    @thumbnail_small  = doc.search("media:thumbnail").min { |a,b| a[:height].to_i * a[:width].to_i <=> b[:height].to_i * b[:width].to_i }[:url]
-    @thumbnail_large  = doc.search("media:thumbnail").max { |a,b| a[:height].to_i * a[:width].to_i <=> b[:height].to_i * b[:width].to_i }[:url]
-    # when your video still has no view, yt:statistics is not returned by Youtube
-    # see: https://github.com/thibaudgg/video_info/issues#issue/2
-    if doc.search("yt:statistics").first
-      @view_count     = doc.search("yt:statistics").first[:viewcount].to_i
-    else
-      @view_count     = 0
-    end
-  end
-
-end
+class Youtube
+  attr_accessor :video_id, :url, :provider, :title, :description, :keywords,
+                :duration, :date, :width, :height,
+                :thumbnail_small, :thumbnail_large,
+                :view_count,
+                :openURI_options
+
+  def initialize(url, options = {})
+    @openURI_options = options
+    video_id_for(url)
+    get_info unless @video_id == url
+  end
+
+  def regex
+    /http:\/\/(www.)?youtube\.com\/watch\?v=([A-Za-z0-9._%-]*)(\&\S+)?|http:\/\/(www.)?youtu\.be\/([A-Za-z0-9._%-]*)?/ 
+  end
+
+  def video_id_for(url)
+    url.gsub(regex) do
+      @video_id = $2 || $5
+    end
+  end
+
+private
+
+  def get_info
+    doc = Hpricot(open("http://gdata.youtube.com/feeds/api/videos/#{@video_id}", @openURI_options))
+    @provider         = "YouTube"
+    @url              = "http://www.youtube.com/watch?v=#{@video_id}"
+    @title            = doc.search("media:title").inner_text
+    @description      = doc.search("media:description").inner_text
+    @keywords         = doc.search("media:keywords").inner_text
+    @duration         = doc.search("yt:duration").first[:seconds].to_i
+    @date             = Time.parse(doc.search("published").inner_text, Time.now.utc)
+    @thumbnail_small  = doc.search("media:thumbnail").min { |a,b| a[:height].to_i * a[:width].to_i <=> b[:height].to_i * b[:width].to_i }[:url]
+    @thumbnail_large  = doc.search("media:thumbnail").max { |a,b| a[:height].to_i * a[:width].to_i <=> b[:height].to_i * b[:width].to_i }[:url]
+    # when your video still has no view, yt:statistics is not returned by Youtube
+    # see: https://github.com/thibaudgg/video_info/issues#issue/2
+    if doc.search("yt:statistics").first
+      @view_count     = doc.search("yt:statistics").first[:viewcount].to_i
+    else
+      @view_count     = 0
+    end
+  end
+
+end

data/lib/video_info.rb

@@ -1,25 +1,39 @@
-require 'provider/vimeo'
-require 'provider/youtube'
-
-class VideoInfo
-
-  def initialize(url)
-    case url
-    when /vimeo\.com/
-      @video = Vimeo.new(url)
-    when /youtube\.com/
-      @video = Youtube.new(url)
-    when /youtu\.be/
-      @video = Youtube.new(url)
-    end
-  end
-
-  def valid?
-    @video != nil && !["", nil].include?(title)
-  end
-
-  def method_missing(sym, *args, &block)
-    @video.send sym, *args, &block
-  end
-
-end
+require 'open-uri'
+require 'hpricot'
+require 'video_info/version'
+require 'provider/vimeo'
+require 'provider/youtube'
+
+class VideoInfo
+
+  def initialize(url, options = {})
+
+    options = { "User-Agent" => "VideoInfo/#{VideoInfoVersion::VERSION}" }.merge options
+    options.dup.each do |key,value|
+      unless OpenURI::Options.keys.include? key
+        if key.is_a? Symbol
+          options[key.to_s.split(/[^a-z]/i).map(&:capitalize).join('-')] = value
+          options.delete key
+        end
+      end
+    end
+
+    case url
+    when /vimeo\.com/
+      @video = Vimeo.new(url, options)
+    when /youtube\.com/
+      @video = Youtube.new(url, options)
+    when /youtu\.be/
+      @video = Youtube.new(url, options)
+    end
+  end
+
+  def valid?
+    @video != nil && !["", nil].include?(title)
+  end
+
+  def method_missing(sym, *args, &block)
+    @video.send sym, *args, &block
+  end
+
+end

data/lib/video_info/version.rb

@@ -1,3 +1,3 @@
 module VideoInfoVersion
-  VERSION = "0.2.7"
+  VERSION = "0.2.8"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: video_info
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.2.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-13 00:00:00.000000000Z
+date: 2011-11-20 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hpricot
-  requirement: &70190131499240 !ruby/object:Gem::Requirement
+  requirement: &70141481121100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.8.4
   type: :runtime
   prerelease: false
-  version_requirements: *70190131499240
+  version_requirements: *70141481121100
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70190131497380 !ruby/object:Gem::Requirement
+  requirement: &70141481120500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70190131497380
+  version_requirements: *70141481120500
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70190131491960 !ruby/object:Gem::Requirement
+  requirement: &70141481119200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 2.7.0
   type: :development
   prerelease: false
-  version_requirements: *70190131491960
+  version_requirements: *70141481119200
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70190131490300 !ruby/object:Gem::Requirement
+  requirement: &70141481118360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70190131490300
+  version_requirements: *70141481118360
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70190131482420 !ruby/object:Gem::Requirement
+  requirement: &70141481117300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70190131482420
+  version_requirements: *70141481117300
 - !ruby/object:Gem::Dependency
   name: vcr
-  requirement: &70190131475840 !ruby/object:Gem::Requirement
+  requirement: &70141481116600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70190131475840
+  version_requirements: *70141481116600
 description: Get video info from youtube and vimeo url.
 email:
 - thibaud@thibaud.me
@@ -104,7 +104,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4408431295325630864
+      hash: -2856754979042863161
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -113,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4408431295325630864
+      hash: -2856754979042863161
 requirements: []
 rubyforge_project: video_info
 rubygems_version: 1.8.9