ruby-oembed

oEmbed for Ruby

3 years after

= ruby-oembed http://stillmaintained.com/metavida/ruby-oembed.png

An oEmbed consumer library written in Ruby, letting you easily get embeddable HTML representations of supported web pages, based on their URLs. See {oembed.com}[http://oembed.com] for more about the protocol.

= Installation

gem install ruby-oembed

= Get Started

== Providers

Get information about a URL via an OEmbed::Provider. This library comes with many Providers built right in, to make your life easy.

resource = OEmbed::Providers::Youtube.get("http://www.youtube.com/watch?v=2BYXBC8WQ5k") resource.video? #=> true resource.thumbnail_url #=> "http://i3.ytimg.com/vi/2BYXBC8WQ5k/hqdefault.jpg" resource.html #=> <<-HTML

HTML

If you'd like to use a provider that isn't included in the library, it's easy to create one. Just provide the oEmbed API endpoint and URL scheme(s).

my_provider = OEmbed::Provider.new("http://my.cool-service.com/api/oembed_endpoint.{format}") my_provider << "http://*.cool-service.com/image/" my_provider << "http://.cool-service.com/video/*" resource = my_provider.get("http://a.cool-service.com/video/1") #=> OEmbed::Response resource.provider.name #=> "My Cool Service"

To use multiple Providers at once, simply register them.

OEmbed::Providers.register(OEmbed::Providers::Youtube, my_provider) resource = OEmbed::Providers.get("http://www.youtube.com/watch?v=2BYXBC8WQ5k") #=> OEmbed::Response resource.type #=> "video" resource.provider.name #=> "Youtube"

Last but not least, ruby-oembed supports both {oohEmbed}[http://oohembed.com] and {Embedly}[http://embed.ly]. These services are provider aggregators. Each supports a wide array of websites ranging from {Amazon.com}[http://www.amazon.com] to {xkcd}[http://www.xkcd.com].

== Formatters

This library works wonderfully on its own, but can get a speed boost by using 3rd party libraries to parse oEmbed data. To use a 3rd party Formatter, just be sure to require the library before ruby-oembed.

require 'json' require 'xmlsimple' require 'oembed'

OEmbed::Formatter::JSON.backend #=> OEmbed::Formatter::JSON::Backends::JSONGem OEmbed::Formatter::XML.backend #=> OEmbed::Formatter::XML::Backends::XmlSimple

The following, optional, backends are currently supported:

= Lend a Hand

Code for the ruby-oembed library is {hosted on GitHub}[https://github.com/judofyr/ruby-oembed].

Get the code.

git clone git://github.com/judofyr/ruby-oembed.git cd ruby-oembed

Install all development-related gems.

gem install bundler bundle install

Run the tests.

bundle exec rake

If you encounter any bug, feel free to {create an Issue}[https://github.com/judofyr/ruby-oembed/issues].

We gladly accept pull requests! Just {fork}[http://help.github.com/forking/] the library and commit your changes along with relevant tests. Once you're happy with the changes, {send a pull request}[http://help.github.com/pull-requests/].

We do our best to {keep our tests green}[http://travis-ci.org/metavida/ruby-oembed] https://secure.travis-ci.org/metavida/ruby-oembed.png

= Contributors

Thanks to {all who have made contributions}[https://github.com/judofyr/ruby-oembed/contributors] to this gem, both large and small.

= License

This code is free to use under the terms of the MIT license.

Related Repositories

slodown

slodown

Markdown + oEmbed + Sanitize + CodeRay = the ultimate user input rendering pipel ...

embedly-ruby

embedly-ruby

Ruby Embedly Client ...

oembed

oembed

A slim library to work with oEmbed format. ...

OhEmbedr

OhEmbedr

OhEmbedr is a super simple ruby OEmbed library. ...

thornbed

thornbed

Thin OEmbed wrapper ...


Top Contributors

metavida judofyr evaryont voidfiles graaff kyleslattery taf2 bradleypriest florianguenther jeremyhaile hypomodern rrichards