onebox 1.8.80 → 1.8.81

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f4025cb791c71ae3c8e60721222523344220036885b580ab8b95724a3919f9f
-  data.tar.gz: c86237739a577b807887bcab7888b79c69abe4e20a79ad3bd64a44254445a940
+  metadata.gz: 79ca1005a313aaac0d6ca21f616e2b0c12ae6f698f412df6397545788fa0693c
+  data.tar.gz: 2783afdc4693634f7c4a941c61c8b4d361028c966f78fef3c65cf86c39ba7800
 SHA512:
-  metadata.gz: ab7468411bd2f318d70c1d1621f92f90f3c378df3f28ff57abfa744e3778cf1817c9ed486ad52ed00c428fdd782c43f4df68de20c8ff1b8cef0e343a552940ea
-  data.tar.gz: 180a8b88df76668dc6d0f73b35aa28ab21587208c42892d02f024e37dee66f403bb31cacd9cd2160b4b7c8596864652d837bdde8e793fd099204b71046e4a21f
+  metadata.gz: d609a2a64828733b261fdfd05b5ba12e4b1776f56fd67be13ddb2f2b638a29ee8f63f16d6aed932c3b0f0b656670592810589a4391c99d2d34d43950da1ea027
+  data.tar.gz: bbc06c238ffbb465989e30b3de82227f2c92fefca30e0db9c0c7ead87ce14d97b1eda3aca56de64eeef11bb627f12fa71930025e301cd226497b859d6da868ac

data/CHANGELOG.md

@@ -1,26 +1,26 @@
-## 1.8.78
-
- * Kaltura onebox support
- * Typeform onebox support
-
-## 1.8.40
-
-  * remove explicit dependency on fast blank
-
-## 1.8.33
-
-  * add support for private vimeo links
-
-## 1.8.23
-
-  * added public message about ruby support (2.2 and above)
-  * mark all avatars being returned as onebox-avatar
-  * twitter returns larger avatars for retina
-
-## 1.6.6
-
-  * SECURITY: normalize url for audio/video oneboxes
-
-## 1.5.64
-
-  * Escape HTML entities in text when oneboxing Amazon URLs.
+## 1.8.78
+
+ * Kaltura onebox support
+ * Typeform onebox support
+
+## 1.8.40
+
+  * remove explicit dependency on fast blank
+
+## 1.8.33
+
+  * add support for private vimeo links
+
+## 1.8.23
+
+  * added public message about ruby support (2.2 and above)
+  * mark all avatars being returned as onebox-avatar
+  * twitter returns larger avatars for retina
+
+## 1.6.6
+
+  * SECURITY: normalize url for audio/video oneboxes
+
+## 1.5.64
+
+  * Escape HTML entities in text when oneboxing Amazon URLs.

data/Gemfile.lock

@@ -1,152 +1,154 @@
-PATH
-  remote: .
-  specs:
-    onebox (1.8.79)
-      htmlentities (~> 4.3)
-      moneta (~> 1.0)
-      multi_json (~> 1.11)
-      mustache
-      nokogiri (~> 1.7)
-      sanitize
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.4.0)
-    backports (3.11.4)
-    celluloid (0.16.0)
-      timers (~> 4.0.0)
-    coderay (1.1.2)
-    crass (1.0.4)
-    diff-lcs (1.3)
-    fakeweb (1.3.0)
-    faraday (0.9.2)
-      multipart-post (>= 1.2, < 3)
-    ffi (1.10.0)
-    formatador (0.2.5)
-    guard (2.15.0)
-      formatador (>= 0.2.4)
-      listen (>= 2.7, < 4.0)
-      lumberjack (>= 1.0.12, < 2.0)
-      nenv (~> 0.1)
-      notiffany (~> 0.0)
-      pry (>= 0.9.12)
-      shellany (~> 0.0)
-      thor (>= 0.18.1)
-    guard-rspec (4.2.10)
-      guard (~> 2.1)
-      rspec (>= 2.14, < 4.0)
-    haml (4.0.7)
-      tilt
-    hitimes (1.3.1)
-    htmlentities (4.3.4)
-    jaro_winkler (1.5.2)
-    listen (2.10.1)
-      celluloid (~> 0.16.0)
-      rb-fsevent (>= 0.9.3)
-      rb-inotify (>= 0.9)
-    lumberjack (1.0.13)
-    metaclass (0.0.4)
-    method_source (0.9.2)
-    mini_portile2 (2.4.0)
-    mocha (1.8.0)
-      metaclass (~> 0.0.1)
-    moneta (1.0.0)
-    multi_json (1.13.1)
-    multipart-post (2.0.0)
-    mustache (1.1.0)
-    nenv (0.3.0)
-    nokogiri (1.10.1)
-      mini_portile2 (~> 2.4.0)
-    nokogumbo (2.0.1)
-      nokogiri (~> 1.8, >= 1.8.4)
-    notiffany (0.1.1)
-      nenv (~> 0.1)
-      shellany (~> 0.0)
-    parallel (1.13.0)
-    parser (2.6.0.0)
-      ast (~> 2.4.0)
-    powerpack (0.1.2)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    rack (1.6.11)
-    rack-protection (1.5.5)
-      rack
-    rack-test (1.1.0)
-      rack (>= 1.0, < 3)
-    rainbow (3.0.0)
-    rake (10.5.0)
-    rb-fsevent (0.10.3)
-    rb-inotify (0.10.0)
-      ffi (~> 1.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    rubocop (0.64.0)
-      jaro_winkler (~> 1.5.1)
-      parallel (~> 1.10)
-      parser (>= 2.5, != 2.5.1.1)
-      powerpack (~> 0.1)
-      rainbow (>= 2.2.2, < 4.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.4.0)
-    ruby-progressbar (1.10.0)
-    sanitize (5.0.0)
-      crass (~> 1.0.2)
-      nokogiri (>= 1.8.0)
-      nokogumbo (~> 2.0)
-    shellany (0.0.1)
-    simple_oauth (0.3.1)
-    sinatra (1.4.8)
-      rack (~> 1.5)
-      rack-protection (~> 1.4)
-      tilt (>= 1.3, < 3)
-    sinatra-contrib (1.4.7)
-      backports (>= 2.0)
-      multi_json
-      rack-protection
-      rack-test
-      sinatra (~> 1.4.0)
-      tilt (>= 1.3, < 3)
-    thor (0.20.3)
-    tilt (2.0.9)
-    timers (4.0.4)
-      hitimes
-    twitter (4.8.1)
-      faraday (~> 0.8, < 0.10)
-      multi_json (~> 1.0)
-      simple_oauth (~> 0.2)
-    unicode-display_width (1.4.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 2.0)
-  fakeweb (~> 1.3)
-  guard-rspec (~> 4.2.8)
-  haml (~> 4.0)
-  listen (~> 2.10.0)
-  mocha (~> 1.1)
-  onebox!
-  pry (~> 0.10)
-  rake (~> 10.4)
-  rspec (~> 3.2)
-  rubocop (~> 0.50)
-  sinatra (~> 1.4)
-  sinatra-contrib (~> 1.4)
-  twitter (~> 4.8)
-
-BUNDLED WITH
-   2.0.1
+PATH
+  remote: .
+  specs:
+    onebox (1.8.80)
+      htmlentities (~> 4.3)
+      moneta (~> 1.0)
+      multi_json (~> 1.11)
+      mustache
+      nokogiri (~> 1.7)
+      sanitize
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    backports (3.12.0)
+    celluloid (0.16.0)
+      timers (~> 4.0.0)
+    coderay (1.1.2)
+    crass (1.0.4)
+    diff-lcs (1.3)
+    fakeweb (1.3.0)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    ffi (1.10.0)
+    formatador (0.2.5)
+    guard (2.15.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-rspec (4.2.10)
+      guard (~> 2.1)
+      rspec (>= 2.14, < 4.0)
+    haml (4.0.7)
+      tilt
+    hitimes (1.3.1)
+    htmlentities (4.3.4)
+    jaro_winkler (1.5.2)
+    listen (2.10.1)
+      celluloid (~> 0.16.0)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    lumberjack (1.0.13)
+    metaclass (0.0.4)
+    method_source (0.9.2)
+    mini_portile2 (2.4.0)
+    mocha (1.8.0)
+      metaclass (~> 0.0.1)
+    moneta (1.0.0)
+    multi_json (1.13.1)
+    multipart-post (2.0.0)
+    mustache (1.1.0)
+    nenv (0.3.0)
+    nokogiri (1.10.1)
+      mini_portile2 (~> 2.4.0)
+    nokogumbo (2.0.1)
+      nokogiri (~> 1.8, >= 1.8.4)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parallel (1.14.0)
+    parser (2.6.0.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    psych (3.1.0)
+    rack (1.6.11)
+    rack-protection (1.5.5)
+      rack
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.10.0)
+      ffi (~> 1.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.65.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      psych (>= 3.1.0)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.4.0)
+    ruby-progressbar (1.10.0)
+    sanitize (5.0.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.8.0)
+      nokogumbo (~> 2.0)
+    shellany (0.0.1)
+    simple_oauth (0.3.1)
+    sinatra (1.4.8)
+      rack (~> 1.5)
+      rack-protection (~> 1.4)
+      tilt (>= 1.3, < 3)
+    sinatra-contrib (1.4.7)
+      backports (>= 2.0)
+      multi_json
+      rack-protection
+      rack-test
+      sinatra (~> 1.4.0)
+      tilt (>= 1.3, < 3)
+    thor (0.20.3)
+    tilt (2.0.9)
+    timers (4.0.4)
+      hitimes
+    twitter (4.8.1)
+      faraday (~> 0.8, < 0.10)
+      multi_json (~> 1.0)
+      simple_oauth (~> 0.2)
+    unicode-display_width (1.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  fakeweb (~> 1.3)
+  guard-rspec (~> 4.2.8)
+  haml (~> 4.0)
+  listen (~> 2.10.0)
+  mocha (~> 1.1)
+  onebox!
+  pry (~> 0.10)
+  rake (~> 10.4)
+  rspec (~> 3.2)
+  rubocop (~> 0.50)
+  sinatra (~> 1.4)
+  sinatra-contrib (~> 1.4)
+  twitter (~> 4.8)
+
+BUNDLED WITH
+   2.0.1

data/README.md

@@ -1,223 +1,223 @@
-onebox
-======
-
-[![Gem Version](https://badge.fury.io/rb/onebox.png)](https://rubygems.org/gems/onebox)
-[![Code Climate](https://codeclimate.com/github/dysania/onebox.png)](https://codeclimate.com/github/dysania/onebox)
-[![Build Status](https://travis-ci.org/discourse/onebox.png)](https://travis-ci.org/discourse/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](http://discourse.org) 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:
-
-``` ruby
-require "onebox"
-```
-
-Then pass a link to the library's interface:
-
-``` ruby
-require "onebox"
-
-url = "http://www.amazon.com/gp/product/B005T3GRNW/ref=s9_simh_gw_p147_d0_i2"
-preview = Onebox.preview(url)
-```
-
-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:
-
-``` ruby
-require "onebox"
-
-url = "http://www.amazon.com/gp/product/B005T3GRNW/ref=s9_simh_gw_p147_d0_i2"
-preview = Onebox.preview(url)
-"#{preview}" == preview.to_s #=> true
-```
-
-Onebox has its own caching system but you can also provide (or turn off) your own system:
-
-``` ruby
-require "onebox"
-
-url = "http://www.amazon.com/gp/product/B005T3GRNW/ref=s9_simh_gw_p147_d0_i2"
-preview = Onebox.preview(url, cache: Rails.cache)
-"#{preview}" == preview.to_s #=> true
-```
-
-In addition you can set your own options with this handy interface:
-
-``` ruby
-require "onebox"
-
-Onebox.options = {
-  cache: Rails.cache
-}
-
-url = "http://www.amazon.com/gp/product/B005T3GRNW/ref=s9_simh_gw_p147_d0_i2"
-preview = Onebox.preview(url)
-"#{preview}" == preview.to_s #=> true
-```
-
-Ruby Support
-------------
-
-The onebox library is supported on all "officially" supported versions of Ruby.
-
-This means you must be on Ruby 2.3 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
-----------------------------
-
-  1. Check if the site supports [oEmbed](http://oembed.com/) or [Open Graph](https://developers.facebook.com/docs/opengraph/).
-     If it does, you can probably get away with just whitelisting the URL in `Onebox::Engine::WhitelistedGenericOnebox` (see: [Whitelisted Generic Onebox caveats](#user-content-whitelisted-generic-onebox-caveats)).
-     If the site does not support open standards, you can create a new engine.
-
-  2. Create new onebox engine
-
-     ``` ruby
-     # 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
-     ```
-
-  3. Create new onebox spec using [FakeWeb](https://github.com/chrisk/fakeweb)
-
-     ``` ruby
-     # 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
-     ```
-
-  4. Create new mustache template
-
-     ``` html
-     # in templates/name.mustache
-     <div class="onebox">
-       <a href="{{url}}">
-         <h1>{{name}}</h1>
-         <h2 class="host">example.com</h2>
-         <img src="{{image}}" />
-         <p>{{description}}</p>
-       </a>
-     </div>
-     ```
-
-  5. Create new fixture from HTML response for your FakeWeb request(s)
-
-     ``` bash
-     curl --output spec/fixtures/oneboxname.response -L -X GET http://example.com
-     ```
-
-  6. Require in Engine module
-
-     ``` ruby
-     # in lib/onebox/engine.rb
-     require_relative "engine/name_onebox"
-     ```
-
-
-Whitelisted Generic Onebox caveats
-----------------------------------
-
-The Whitelisted Generic Onebox has some caveats for it's use, beyond simply whitelisting the domain.
-
-  1. The domain must be whitelisted
-  2. The URL you're oneboxing cannot be a root url (e.g. `http://example.com` won't work, but `http://example.com/page` will)
-  3. 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.
-
-
-Installing
-----------
-
-Add this line to your application's Gemfile:
-
-    gem "onebox"
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install onebox
-
-
-Issues / Discussion
--------------------
-
-Discussion of the Onebox gem, its development and features should be done on
-[Discourse Meta](https://meta.discourse.org). 
-
-Contributing
-------------
-
-  1. Fork it
-  2. Create your feature branch (`git checkout -b my-new-feature`)
-  3. Commit your changes (`git commit -am 'Add some feature'`)
-  4. Push to the branch (`git push origin my-new-feature`)
-  5. Create new Pull Request
+onebox
+======
+
+[![Gem Version](https://badge.fury.io/rb/onebox.png)](https://rubygems.org/gems/onebox)
+[![Code Climate](https://codeclimate.com/github/dysania/onebox.png)](https://codeclimate.com/github/dysania/onebox)
+[![Build Status](https://travis-ci.org/discourse/onebox.png)](https://travis-ci.org/discourse/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](http://discourse.org) 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:
+
+``` ruby
+require "onebox"
+```
+
+Then pass a link to the library's interface:
+
+``` ruby
+require "onebox"
+
+url = "http://www.amazon.com/gp/product/B005T3GRNW/ref=s9_simh_gw_p147_d0_i2"
+preview = Onebox.preview(url)
+```
+
+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:
+
+``` ruby
+require "onebox"
+
+url = "http://www.amazon.com/gp/product/B005T3GRNW/ref=s9_simh_gw_p147_d0_i2"
+preview = Onebox.preview(url)
+"#{preview}" == preview.to_s #=> true
+```
+
+Onebox has its own caching system but you can also provide (or turn off) your own system:
+
+``` ruby
+require "onebox"
+
+url = "http://www.amazon.com/gp/product/B005T3GRNW/ref=s9_simh_gw_p147_d0_i2"
+preview = Onebox.preview(url, cache: Rails.cache)
+"#{preview}" == preview.to_s #=> true
+```
+
+In addition you can set your own options with this handy interface:
+
+``` ruby
+require "onebox"
+
+Onebox.options = {
+  cache: Rails.cache
+}
+
+url = "http://www.amazon.com/gp/product/B005T3GRNW/ref=s9_simh_gw_p147_d0_i2"
+preview = Onebox.preview(url)
+"#{preview}" == preview.to_s #=> true
+```
+
+Ruby Support
+------------
+
+The onebox library is supported on all "officially" supported versions of Ruby.
+
+This means you must be on Ruby 2.3 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
+----------------------------
+
+  1. Check if the site supports [oEmbed](http://oembed.com/) or [Open Graph](https://developers.facebook.com/docs/opengraph/).
+     If it does, you can probably get away with just whitelisting the URL in `Onebox::Engine::WhitelistedGenericOnebox` (see: [Whitelisted Generic Onebox caveats](#user-content-whitelisted-generic-onebox-caveats)).
+     If the site does not support open standards, you can create a new engine.
+
+  2. Create new onebox engine
+
+     ``` ruby
+     # 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
+     ```
+
+  3. Create new onebox spec using [FakeWeb](https://github.com/chrisk/fakeweb)
+
+     ``` ruby
+     # 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
+     ```
+
+  4. Create new mustache template
+
+     ``` html
+     # in templates/name.mustache
+     <div class="onebox">
+       <a href="{{url}}">
+         <h1>{{name}}</h1>
+         <h2 class="host">example.com</h2>
+         <img src="{{image}}" />
+         <p>{{description}}</p>
+       </a>
+     </div>
+     ```
+
+  5. Create new fixture from HTML response for your FakeWeb request(s)
+
+     ``` bash
+     curl --output spec/fixtures/oneboxname.response -L -X GET http://example.com
+     ```
+
+  6. Require in Engine module
+
+     ``` ruby
+     # in lib/onebox/engine.rb
+     require_relative "engine/name_onebox"
+     ```
+
+
+Whitelisted Generic Onebox caveats
+----------------------------------
+
+The Whitelisted Generic Onebox has some caveats for it's use, beyond simply whitelisting the domain.
+
+  1. The domain must be whitelisted
+  2. The URL you're oneboxing cannot be a root url (e.g. `http://example.com` won't work, but `http://example.com/page` will)
+  3. 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.
+
+
+Installing
+----------
+
+Add this line to your application's Gemfile:
+
+    gem "onebox"
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install onebox
+
+
+Issues / Discussion
+-------------------
+
+Discussion of the Onebox gem, its development and features should be done on
+[Discourse Meta](https://meta.discourse.org). 
+
+Contributing
+------------
+
+  1. Fork it
+  2. Create your feature branch (`git checkout -b my-new-feature`)
+  3. Commit your changes (`git commit -am 'Add some feature'`)
+  4. Push to the branch (`git push origin my-new-feature`)
+  5. Create new Pull Request