Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
An easy way to include external video services in a rails app.
Ruby
branch: master
Failed to load latest commit information.
lib
spec
.coveralls.yml
.gitignore
.travis.yml
Gemfile
MIT-LICENSE
README.markdown
Rakefile
acts_as_unvlogable.gemspec
unvlogable_sample.yml

README.markdown

Acts as unvlogable Build Status Coverage Status

What the hell is this!

This is the plugin that we use in unvlog.com to manage the supported video services. It is an easy way to obtain a few basics about a video only through its url.

A quick example:

To include this video in this post we need to know its title, the correct way to embed it and its thumbnail url. With this plugin we have an easy access to this data:

    @aha = UnvlogIt.new("http://www.youtube.com/watch?v=GPQnbtldFyo")
    @aha.title => "paradon del portero"
    @aha.thumbnail => "http://i4.ytimg.com/vi/GPQnbtldFyo/default.jpg"
    @aha.embed_url => "http://www.youtube.com/v/GPQnbtldFyo"
    @aha.embed_html(width, height) => "<object [...]</object>"
    # all together :)
    @aha.video_details(width, height) => {
                                            :title => ...,
                                            :thumbnail => ...,
                                            :embed_url => ...,
                                            :embed_html => ...,
                                          }

With this plugin we have an unique way to manage multiple services :)

Install it!

  1. Install it as a gem:

    gem "acts_as_unvlogable"
    
  2. Optionally you can create the config/unvlogable.yml to store keys for the different services. You have in the plugin a sample file.

2.1. 'yt' gem will need an API key from google in order to get the youtube video information properly, without dealing with API limits. They explain it better than me here

Use it!

The idea is make it as simple as possible. For a given video URL as http://vimeo.com/1785993:

    videotron = UnvlogIt.new("http://vimeo.com/1785993")

Then we have methods to know the 'basics' for use this video on your application.

  • title: A method to know the title of the video on the service.

      videotron.title
      => "Beached"
    
  • service: A method to know the name of the video provider service.

    videotron.service
    => "Vimeo"
    
  • thumbnail: An image representation of the video. Each service has a different size, but... it works :)

      videotron.thumbnail
      => "http://bc1.vimeo.com/vimeo/thumbs/143104745_640.jpg"
    
  • embed_url: The url (with flashvars) of the video player.

      videotron.embed_url
      => "http://vimeo.com/moogaloop.swf?clip_id=1785993 [...] &show_portrait=1"
    
  • embed_html(width, height): Uses the embed_url to build an oembed string. The default width x height is 425 x 344, but we can specify a different one.

      videotron.embed_html(400, 300)
      => "<object width='400' height='300'><param name='mo [...] 300'></embed></object>"
    
  • flv: DEPRECATED

  • video_details(width, height): All together :), returns all the previous elements in a hash. Width and height can be specified to build the embed_html.

      videotron.video_details
      => "{ [...] }"
    

Supported services

At this moment we support the following video services:

And... what else?

If you find a bug or want to suggest a new video service, please tell it to us in a ticket.

Thanks!!

Something went wrong with that request. Please try again.