discourse/onebox is one of the open-source repositories TopGit tracks, currently at 787 stars, written primarily in Ruby. (DEPRECATED) A gem for turning URLs into website previews
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
:warning: This project isn't maintained anymore as the onebox library has moved into core repository. If you wish to help by maintaining the project please contact [email protected].
onebox
Onebox is a library for turning media URLs into simple HTML previews of the resource.
Onebox currently has support for page, image, and video URLs for many popular sites.
It's great if you want users to input URLs and have your application convert them into
rich previews for display. For example, a link to a YouTube video would be automatically
converted into a video player.
It was originally created for Discourse but has since been
extracted into this convenient gem for all to use!
Usage
Using onebox is fairly simple!
First, make sure the library is required:
This will contain a simple Onebox::Preview object that handles all the transformation.
From here you either call Onebox::Preview#to_s or just pass the object to a string:
The onebox library is supported on all "officially" supported versions of Ruby.
This means you must be on Ruby 2.4 or above for it to work.
Development Preview Interface
The onebox gem comes with a development server for previewing the results
of your changes. You can run it by running bundle exec rake server after checking
out the project. You can then try out URLs.
The server doesn't reload code changes automatically (PRs accepted!) so
make sure to hit CTRL-C and restart the server to try a code change out.
Adding Support for a new URL
Check if the site supports oEmbed or Open Graph.
If it does, you can probably get away with just allowing the URL in Onebox::Engine::AllowlistedGenericOnebox (see: Allowlisted Generic Onebox caveats).
If the site does not support open standards, you can create a new engine.
Create new onebox engine
# in lib/onebox/engine/name_onebox.rb
module Onebox
module Engine
class NameOnebox
include LayoutSupport
include HTML
private
def data
{
url: @url,
name: raw.css("h1").inner_text,
image: raw.css("#main-image").first["src"],
description: raw.css("#postBodyPS").inner_text
}
end
end
end
end
Create new onebox spec using FakeWeb
# in spec/lib/onebox/engine/name_spec.rb
require "spec_helper"
describe Onebox::Engine::NameOnebox do
let(:link) { "http://example.com" }
let(:html) { described_class.new(link).to_html }
before do
fake(link, response("name"))
end
it "has the video's title" do
expect(html).to include("title")
end
it "has the video's still shot" do
expect(html).to include("photo.jpg")
end
it "has the video's description" do
expect(html).to include("description")
end
it "has the URL to the resource" do
expect(html).to include(link)
end
end
Create new fixture from HTML response for your FakeWeb request(s)
curl --output spec/fixtures/oneboxname.response -L -X GET http://example.com
Require in Engine module
# in lib/onebox/engine.rb
require_relative "engine/name_onebox"
Allowlisted Generic Onebox caveats
The Allowlisted Generic Onebox has some caveats for its use, beyond simply allowlisting the domain.
The domain must be allowlisted
The URL you're oneboxing cannot be a root url (e.g. http://example.com won't work, but http://example.com/page will)
If the oneboxed URL responds with oEmbed and has a rich type: the html content must contain an <iframe>. Responses without an iframe will not be oneboxed.
Ignoring Canonical URLs
Onebox prefers to use canonical URLs instead of the raw inputted URL when searching for Open Graph metadata. If your site's canonical URL does not have opengraph metadata, use the og:ignore_canonical property to have Onebox ignore the canonical URL.
The most recent commit recorded on discourse/onebox was 2.8 years ago, based on the GitHub push timestamp. The repository has 155 forks — one of the better signals of community interest.
How many stars does discourse/onebox have?
discourse/onebox has 787 GitHub stars — refresh the page for the live number, or check github.com/discourse/onebox. TopGit mirrors GitHub's count but does not claim minute-by-minute accuracy.
Is discourse/onebox open source?
Yes — discourse/onebox ships under the MIT license, which makes its source code freely readable (and, depending on license terms, forkable and reusable). Source: github.com/discourse/onebox.
What is discourse/onebox?
discourse/onebox (discourse/onebox) is a Ruby project on GitHub. From the project's own README: (DEPRECATED) A gem for turning URLs into website previews
What language is discourse/onebox written in?
discourse/onebox is written primarily in Ruby. GitHub's language field is based on the largest share of bytes in the default branch.
What license does discourse/onebox use?
discourse/onebox is released under the MIT license. Always verify the LICENSE file directly on GitHub for the authoritative terms — license strings can be edited out of sync with a project's actual stance.
Where do I read more about discourse/onebox?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/discourse/onebox is the definitive source.
Read full README in the tab above.
Want a second opinion on onebox?
Ask an AI that can read this page — one click and you get its take on onebox.