Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mamuso/acts_as_unvlogable

An easy way to include external video services in a rails app.
https://github.com/mamuso/acts_as_unvlogable

Last synced: 3 months ago
JSON representation

An easy way to include external video services in a rails app.

Host: GitHub
URL: https://github.com/mamuso/acts_as_unvlogable
Owner: mamuso
License: mit
Created: 2008-12-30T23:11:41.000Z (almost 16 years ago)
Default Branch: master
Last Pushed: 2016-07-24T07:01:21.000Z (over 8 years ago)
Last Synced: 2024-05-11T02:03:00.378Z (6 months ago)
Language: Ruby
Homepage:
Size: 231 KB
Stars: 143
Watchers: 4
Forks: 31
Open Issues: 0
Metadata Files:
- Readme: README.markdown
- License: MIT-LICENSE

Awesome Lists containing this project

README

        # Acts as unvlogable [![Build Status](https://travis-ci.org/mamuso/acts_as_unvlogable.svg?branch=master)](https://travis-ci.org/mamuso/acts_as_unvlogable) [![Coverage Status](https://coveralls.io/repos/mamuso/acts_as_unvlogable/badge.png?branch=master)](https://coveralls.io/r/mamuso/acts_as_unvlogable?branch=master)

What the hell is this!

----------------------

This is the plugin that we use in [unvlog.com](http://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](http://www.youtube.com/watch?v=GPQnbtldFyo) in [this post](http://unvlog.com/blat/2008/3/10/otro-pelotazo) 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) => ""

        # 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](http://github.com/mamuso/acts_as_unvlogable/tree/master/unvlogable_sample.yml).

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](https://github.com/Fullscreen/yt#apps-that-do-not-require-user-interactions)

Use it!

-------

The idea is make it as simple as possible. For a given video URL as :

        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)

          => ""

-   __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:

-   [Youtube](http://www.youtube.com/)

-   [Vimeo](http://vimeo.com/)

-   [Vine](http://vine.co/)

-   [Giphy](http://giphy.com/)

-   [Gfycat](http://gfycat.com/)

-   [Flickr (videos)](http://flickr.com/)

-   [Metacafe](http://metacafe.com/)

-   [Dailymotion](http://dailymotion.com/)

-   [Collegehumor](http://collegehumor.com/)

-   [Myspace](http://vids.myspace.com/)

-   [Ted Talks](http://www.ted.com/talks/)

-   [11870.com](http://11870.com/)

-   [Dalealplay](http://www.dalealplay.com/)

-   [RuTube](http://www.rutube.ru/)

-   [Wistia](http://wistia.com/)

-   [Pleer — Audio](http://pleer.com/)

And... what else?

-----------------

If you find a bug or want to suggest a new video service, please tell it to us in [a ticket](http://github.com/mamuso/acts_as_unvlogable/issues).

Thanks!!