Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Lightweight, Flexible OEmbed Consumer Library

branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 lib
Octocat-spinner-32 spec
Octocat-spinner-32 .gitignore
Octocat-spinner-32 .rspec
Octocat-spinner-32 .ruby-gemset
Octocat-spinner-32 .ruby-version
Octocat-spinner-32 .travis.yml
Octocat-spinner-32 CHANGELOG.md
Octocat-spinner-32 Gemfile
Octocat-spinner-32 Guardfile
Octocat-spinner-32 LICENSE.txt
Octocat-spinner-32 README.md
Octocat-spinner-32 Rakefile
Octocat-spinner-32 oembedr.gemspec
README.md

OEmbedr

Lightweight, Flexible OEmbed Consumer Library.

Build Status

Installation

gem install oembedr

or in your Gemfile

gem 'oembedr'

Goals

Make consuming oembed from any source simple and easy. Uses fast http and fast json parsing by default thanks to Faraday and MultiJSON.

Usage

Oembedr just returns the raw Faraday response object on success. On failure, it raises an appropriate error, e.g. Faraday::Error::ResourceNotFound for 404s. It parses the JSON for you.

N.B. XML is not supported yet. I've no idea why you might need it, but it's on the todo list :).

response = Oembedr.fetch("http://www.youtube.com/watch?v=BxhqVrbixZc")
response.body # => { "type" => "video", ... }
# Now you can do whatever you want!

# To customize your query:
Oembedr.fetch("http://www.youtu.be/BxhqVrbixZc", :params => { :maxwidth => 320 })
Oembedr.fetch("http://custom.com/23423423", :headers => {
  "Accept" => "application/vnd.ms-excel",
  "User-Agent" => "Windows Excel-Based Oembed Service"
})

Other Methods

Oembedr.known_service?("http://www.youtu.be/BxhqVrbixZc") # => true

Configuration

Oembedr.configure do |configuration|
  configuration.user_agent = "MyCoolApp Oembed Client v2.51"
  configuration.adapter = :excon # default :typhoeus
end

Recommendations

Use a fast http library, like excon or typhoeus. Use yajl-ruby.

Contributing to oembedr

  • Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
  • Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
  • Fork the project
  • Start a feature/bugfix branch
  • Commit and push until you are happy with your contribution
  • Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
  • Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

A big thanks to everyone who contributes!

Copyright

Copyright (c) 2012-2014 Matthew Wilson. MIT-license: see LICENSE.txt for further details.

Something went wrong with that request. Please try again.