Awesome
VideoInfo
Simple Ruby Gem to get video information from different providers. Supported providers:
- YouTube (with playlists)
- Vimeo
- Dailymotion
- Wistia
Features
- Simple, single-function API that returns a simple data structure
- Has a mere three gem dependencies
- Automatic fallback to scrapers when required API keys aren't provided
- Fetches metadata on the video, including title, duration, upload date, description, keywords, thumbnail, and dimensions
- Fetches metadata on the author, including name, thumbnail, and channel/profile URL
Install
gem install video_info
Or add to the Gemfile:
gem 'video_info'
Usage
Note for YouTube and Vimeo usage!
Youtube and Vimeo have recently updated their APIs to require API keys.
Scrapers has been implemented for both Youtube and Vimeo. However, the Youtube scraper can only get the date the video was posted, while the API is able to get the date and the exact time the video was posted. You may also wish to use the API to protect against potential HTML changes that could break the scrapers.
How to get these API keys
- To get a Youtube API key, follow the instructions here. After generating a Youtube API key it is necessary to enable the YouTube Data API for the project which your API key was generated enable Youtube Data API here.
- To get a Vimeo API key, follow the instructions here.
To set the API keys, do the following:
VideoInfo.provider_api_keys = { youtube: 'YOUR_YOUTUBE_API_KEY', vimeo: 'YOUR_VIMEO_API_KEY' }
Basic Usage
video = VideoInfo.new('http://www.dailymotion.com/video/x7lni3')
# video.available? => true
# video.video_id => 'x7lni3'
# video.provider => 'Dailymotion'
# video.title => 'Mario Kart (Rémi Gaillard)'
# video.description => 'Super Rémi Kart est un jeu vidéo de course développé et édité par N'Importe Quoi TV.'
# video.duration => 136 (in seconds)
# video.date => Mon Mar 03 16:29:31 UTC 2008
# video.thumbnail_small => 'http://s2.dmcdn.net/BgWxI/x60-kbf.jpg'
# video.thumbnail_medium => 'http://s2.dmcdn.net/BgWxI/x240-b83.jpg'
# video.thumbnail_large => 'http://s2.dmcdn.net/BgWxI/x720-YcV.jpg'
# video.embed_url => 'http://www.dailymotion.com/embed/video/x7lni3'
# video.embed_code => "<iframe src='//www.dailymotion.com/embed/video/x7lni3' frameborder='0' allowfullscreen='allowfullscreen'></iframe>"
# video.stats => {"views_total"=>10342797, "likes_total"=>3850}
video = VideoInfo.new("http://vimeo.com/898029")
# video.available? => true
# 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.author => 'Octave Zangs'
# video.author_thumbnail => 'https://i.vimeocdn.com/portrait/2577152_75x75.jpg'
# video.author_url => 'https://vimeo.com/octave'
# 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://b.vimeocdn.com/ts/343/731/34373130_100.jpg'
# video.thumbnail_medium => 'http://b.vimeocdn.com/ts/343/731/34373130_200.jpg'
# video.thumbnail_large => 'http://b.vimeocdn.com/ts/343/731/34373130_640.jpg'
# video.embed_url => 'http://player.vimeo.com/video/898029'
# video.embed_code => "<iframe src='//player.vimeo.com/video/898029?title=0&byline=0&portrait=0&autoplay=0' frameborder='0'></iframe>"
# video.stats => {"plays"=>630, "likes"=>3, "comments"=>0}
video = VideoInfo.new("http://fast.wistia.com/embed/medias/pxonqr42is")
# video.available? => true
# video.provider => 'Wistia'
# video.video_id => 'pxonqr42is'
# video.title => 'Understanding Analytics'
# video.duration => 250 (in seconds)
# video.width => 960
# video.height => 568
# video.thumbnail_small => 'https://embed-ssl.wistia.com/deliveries/0fccbdc60ade35723f79f1c002bc61b135b610fa.jpg?image_crop_resized=960x540'
# video.thumbnail_medium => 'https://embed-ssl.wistia.com/deliveries/0fccbdc60ade35723f79f1c002bc61b135b610fa.jpg?image_crop_resized=960x540'
# video.thumbnail_large => 'https://embed-ssl.wistia.com/deliveries/0fccbdc60ade35723f79f1c002bc61b135b610fa.jpg?image_crop_resized=960x540'
# video.embed_url => '//fast.wistia.net/embed/iframe/pxonqr42is'
# video.embed_code => "<iframe src='//fast.wistia.net/embed/iframe/pxonqr42is' frameborder='0'></iframe>"
video = VideoInfo.new("http://www.youtube.com/watch?v=mZqGqE0D0n4")
# video.available? => true
# video.video_id => 'mZqGqE0D0n4'
# video.provider => 'YouTube'
# video.title => 'Cherry Bloom - King Of The Knife'
# video.author => 'Cherry Bloom'
# video.author_thumbnail => 'https://yt3.ggpht.com/-7rhnfdQaI3k/AAAAAAAAAAI/AAAAAAAAAAA/eMJZ5HBukCQ/s88-c-k-no/photo.jpg'
# video.author_url => 'https://www.youtube.com/channel/UCzxQk-rZGowoqMBKxGD5jSA'
# video.description => 'The first video from the upcoming album Secret Sounds, to download in-stores April 14. Checkout http://www.cherrybloom.net'
# video.duration => 175 (in seconds)
# video.date => Sat Apr 12 22:25:35 UTC 2008
# video.thumbnail_small => 'http://i.ytimg.com/vi/mZqGqE0D0n4/default.jpg'
# video.thumbnail_medium => 'http://i.ytimg.com/vi/mZqGqE0D0n4/mqdefault.jpg'
# video.thumbnail_large => 'http://i.ytimg.com/vi/mZqGqE0D0n4/hqdefault.jpg'
# video.embed_url => 'http://www.youtube.com/embed/mZqGqE0D0n4'
# video.embed_code => "<iframe src='//www.youtube.com/embed/mZqGqE0D0n4' frameborder='0' allowfullscreen='allowfullscreen'></iframe>"
# video.stats => {"viewCount"=>"8297", "likeCount"=>"66", "favoriteCount"=>"0", "commentCount"=>"5"}
playlist = VideoInfo.new("http://www.youtube.com/playlist?p=PL9hW1uS6HUftLdHI6RIsaf-iXTm09qnEr")
# playlist.available? => true
# playlist.playlist_id => 'PL9hW1uS6HUftLdHI6RIsaf'
# playlist.provider => 'YouTube'
# playlist.title => 'YouTube Policy and Copyright'
# playlist.author => 'YouTube Help'
# playlist.author_thumbnail => 'https://yt3.ggpht.com/-ni_VaN38-AE/AAAAAAAAAAI/AAAAAAAAAAA/bJCTTfihBl0/s100-c-k-no/photo.jpg'
# playlist.author_url => 'https://www.youtube.com/user/YouTubeHelp'
# playlist.thumbnail_small => 'http://i.ytimg.com/vi/8b0aEoxqqC0/default.jpg'
# playlist.thumbnail_medium => 'http://i.ytimg.com/vi/8b0aEoxqqC0/mqdefault.jpg'
# playlist.thumbnail_large => 'http://i.ytimg.com/vi/8b0aEoxqqC0/hqdefault.jpg'
# playlist.embed_url => 'http://www.youtube.com/embed/videoseries?list=PL9hW1uS6HUftLdHI6RIsaf-iXTm09qnEr'
# playlist.embed_code => "<iframe src='//www.youtube.com/embed/videoseries?list=PL9hW1uS6HUftLdHI6RIsaf-iXTm09qnEr' frameborder='0' allowfullscreen='allowfullscreen'></iframe>"
# playlist.videos => [VideoInfo.new('http://www.youtube.com/watch?v=_Bt3-WsHfB0'), VideoInfo.new('http://www.youtube.com/watch?v=9g2U12SsRns'), VideoInfo.new('http://www.youtube.com/watch?v=8b0aEoxqqC0'), VideoInfo.new('http://www.youtube.com/watch?v=6c3mHikRz0I'), VideoInfo.new('http://www.youtube.com/watch?v=OQVHWsTHcoc')]
You can also use the valid_url? helper to check if a given url is valid in some of the enabled providers:
> VideoInfo.valid_url?('http://www.youtube.com/watch?v=AT_5xOGh6Ko')
=> true
> VideoInfo.valid_url?('http://vimeo.com/898029')
=> true
> VideoInfo.valid_url?('http://www.example.com/video/12345')
=> false
Options
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).
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.
You can also include an iframe_attributes or url_attributes hash to the embed_code method to include arbitrary attributes in the iframe embed code or as additional URL params:
VideoInfo.new('http://www.youtube.com/watch?v=mZqGqE0D0n4').embed_code(iframe_attributes: { width: 800, height: 600, 'data-key' => 'value' })
=> '<iframe src="//www.youtube.com/embed/mZqGqE0D0n4" frameborder="0" allowfullscreen="allowfullscreen" width="800" height="600" data-key="value"></iframe>'
VideoInfo.new('http://www.youtube.com/watch?v=mZqGqE0D0n4').embed_code(url_attributes: { autoplay: 1 })
=> '<iframe src="//www.youtube.com/embed/mZqGqE0D0n4?autoplay=1" frameborder="0" allowfullscreen="allowfullscreen"></iframe>'
If you would like to disable certain providers, you can do so by modifying the class variable disable_providers:
VideoInfo.disable_providers = %w[YouTube] # disable YouTube
VideoInfo.disable_providers = %w[Vimeo YouTube] # disable Vimeo and Youtube
VideoInfo.disable_providers = [] # enable all providers
NOTE: disable_providers is case-insensitive. Attempting to use a disabled provider will raise a UrlError, just like attempting to use a non-video URL.
Contributing
Please read the contributing guidelines.
Author
Thibaud Guillaume-Gentil (@thibaudgg)
Maintainers
Contributors
Thanks to all contributors!