onebox 1.1.0 → 1.2.0

data/Gemfile

@@ -1,4 +1,4 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in discourse-onebox.gemspec
+# Specify your gem's dependencies in onebox.gemspec
 gemspec

data/README.md

@@ -10,6 +10,14 @@ 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
 =====
@@ -51,12 +59,12 @@ preview = Onebox.preview(url, cache: Rails.cache)
 "#{preview}" == preview.to_s #=> true
 ```
 
-In addition you can set your own defaults with this handy interface:
+In addition you can set your own options with this handy interface:
 
 ``` ruby
 require "onebox"
 
-Onebox.defaults = {
+Onebox.options = {
   cache: Rails.cache
 }
 
@@ -66,10 +74,14 @@ preview = Onebox.preview(url)
 ```
 
 
-Setup
-=====
+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`.
+     If the site does not support open standards, you can create a new engine.
 
-  1. Create new onebox engine
+  2. Create new onebox engine
 
     ``` ruby
     # in lib/onebox/engine/name_onebox.rb
@@ -77,7 +89,7 @@ Setup
     module Onebox
       module Engine
         class NameOnebox
-          include Engine
+          include LayoutSupport
           include HTML
 
           private
@@ -95,7 +107,7 @@ Setup
     end
     ```
 
-  2. Create new onebox spec
+  3. Create new onebox spec
 
     ``` ruby
     # in spec/lib/onebox/engine/name_spec.rb
@@ -127,7 +139,7 @@ Setup
     end
     ```
 
-  3. Create new handlebars template
+  4. Create new handlebars template
 
     ``` html
     # in templates/name.handlebars
@@ -141,52 +153,18 @@ Setup
     </div>
     ```
 
-  4. Create new fixture from HTML response
+  5. Create new fixture from HTML response
 
     ``` bash
     curl --output spec/fixtures/oneboxname.response -L -X -GET http://example.com
     ```
 
-  5. Require in Engine module
+  6. Require in Engine module
 
     ``` ruby
     # in lib/onebox/engine/engine.rb
     require_relative "engine/name_onebox"
     ```
-    
-Onebox currently has support for page, image, and video URLs from these sites:
-
-  - Amazon
-  - Android App Store
-  - Apple Store
-  - BlipTV
-  - Clikthrough
-  - College Humor
-  - Dailymotion
-  - Dotsub
-  - Flickr
-  - Funny or Die
-  - GitHub
-    - Blob
-    - Commit
-    - Gist
-    - Pull Request
-  - Hulu
-  - Imgur
-  - Kinomap
-  - NFB
-  - Open Graph
-  - Qik
-  - Revision
-  - Rotten Tomatoes
-  - Slideshare
-  - SmugMug
-  - SoundCloud
-  - Stack Exchange
-  - TED
-  - Twitter
-  - Wikipedia
-  - yFrog
 
 
 Installing
@@ -194,7 +172,7 @@ Installing
 
 Add this line to your application's Gemfile:
 
-    gem "onebox". "~> 1.0"
+    gem "onebox". "~> 1.2"
 
 And then execute:
 

data/lib/onebox.rb

@@ -7,30 +7,38 @@ require "hexpress"
 require "hexpress/web"
 require "ostruct"
 require "moneta"
-
-require_relative "onebox/version"
-require_relative "onebox/preview"
-require_relative "onebox/matcher"
-require_relative "onebox/engine"
-require_relative "onebox/view"
+require "cgi"
 
 module Onebox
   DEFAULTS = {
     cache: Moneta.new(:Memory, expires: true, serializer: :json),
-    timeout: 10
+    timeout: 10,
+    load_paths: [File.join(Gem::Specification.find_by_name("onebox").gem_dir, "templates")]
   }
 
-  @@defaults = DEFAULTS
+  @@options = DEFAULTS
 
-  def self.preview(url, options = Onebox.defaults)
+  def self.preview(url, options = Onebox.options)
     Preview.new(url, options)
   end
 
-  def self.defaults
-    OpenStruct.new(@@defaults)
+  def self.options
+    OpenStruct.new(@@options)
+  end
+
+  def self.has_matcher?(url)
+    result = Matcher.new(url).oneboxed
+    !!result
   end
 
-  def self.defaults=(options)
-    @@defaults = DEFAULTS.merge(options)
+  def self.options=(options)
+    @@options = DEFAULTS.merge(options)
   end
 end
+
+require_relative "onebox/version"
+require_relative "onebox/preview"
+require_relative "onebox/matcher"
+require_relative "onebox/engine"
+require_relative "onebox/layout"
+require_relative "onebox/view"

data/lib/onebox/engine.rb

@@ -13,92 +13,102 @@ module Onebox
     attr_reader :url
     attr_reader :cache
     attr_reader :timeout
-    attr_reader :view
 
     def initialize(link, cache = nil, timeout = nil)
       @url = link
-      @cache = cache || Onebox.defaults.cache
-      @timeout = timeout || Onebox.defaults.timeout
-      @view = View.new(self.class.template_name, true)
+      @cache = cache || Onebox.options.cache
+      @timeout = timeout || Onebox.options.timeout
     end
 
+    # raises error if not defined in onebox engine. This is the output method for
+    # an engine.
     def to_html
-      view.to_html(record)
+      fail NoMethodError, "Engines need to implement this method"
+    end
+
+    # Some oneboxes create iframes or other complicated controls. If you're using
+    # a live editor with HTML preview, rendering those complicated controls can
+    # be slow or cause flickering.
+    #
+    # This method allows engines to produce a placeholder such as static image
+    # frame of a video.
+    #
+    # By default it just calls `to_html` unless implemented.
+    def placeholder_html
+      to_html
     end
 
     private
 
     def record
-      if cache.key?(url)
-        cache.fetch(url)
-      else
-        cache.store(url, data)
-      end
+      result = cache.fetch(url) { data } 
+      cache[url] = result if cache.respond_to?(:key?)
+      result
     end
 
     # raises error if not defined in onebox engine
-    # in each onebox, uses either Nokogiri or OpenGraph to get raw HTML from url
+    # in each onebox, uses either Nokogiri or StandardEmbed to get raw HTML from url
     def raw
-      raise NoMethodError, "Engines need to implement this method"
+      fail NoMethodError, "Engines need to implement this method"
     end
 
     # raises error if not defined in onebox engine
     # in each onebox, returns hash of desired onebox content
     def data
-      raise NoMethodError, "Engines need this method defined"
+      fail NoMethodError, "Engines need this method defined"
+    end
+
+    def link
+      @url.gsub(/['\"<>]/, {
+        "'" => '&#39;',
+        '&' => '&amp;',
+        '"' => '&quot;',
+        '<' => '&lt;',
+        '>' => '&gt;',
+      })
     end
 
     module ClassMethods
-      def ===(object)
-        if object.kind_of?(String)
-          !!(object =~ class_variable_get(:@@matcher))
+      def ===(other)
+        if other.kind_of?(URI)
+          !!(other.to_s =~ class_variable_get(:@@matcher))
         else
           super
         end
       end
 
       def matches(&block)
-        class_variable_set :@@matcher, Hexpress.new(&block).to_r
+        matches_regexp(Hexpress.new(&block).to_r)
+      end
+
+      def matches_regexp(r)
+        class_variable_set :@@matcher, r
       end
 
-      # calculates handlebars template name for onebox using name of engine
-      def template_name
+      # calculates a name for onebox using the class name of engine
+      def onebox_name
         name.split("::").last.downcase.gsub(/onebox/, "")
       end
+
     end
   end
 end
 
-require_relative "engine/open_graph"
+require_relative "helpers"
+require_relative "layout_support"
+require_relative "engine/standard_embed"
 require_relative "engine/html"
 require_relative "engine/json"
-require_relative "engine/example_onebox"
 require_relative "engine/amazon_onebox"
-require_relative "engine/bliptv_onebox"
-require_relative "engine/clikthrough_onebox"
-require_relative "engine/college_humor_onebox"
-require_relative "engine/dailymotion_onebox"
-require_relative "engine/dotsub_onebox"
-require_relative "engine/flickr_onebox"
-require_relative "engine/funny_or_die_onebox"
+require_relative "engine/classic_google_maps_onebox"
 require_relative "engine/github_blob_onebox"
 require_relative "engine/github_commit_onebox"
 require_relative "engine/github_gist_onebox"
 require_relative "engine/github_pullrequest_onebox"
-require_relative "engine/hulu_onebox"
-require_relative "engine/imgur_image_onebox"
-require_relative "engine/itunes_onebox"
-require_relative "engine/kinomap_onebox"
-require_relative "engine/nfb_onebox"
-require_relative "engine/qik_onebox"
-require_relative "engine/revision3_onebox"
-require_relative "engine/slideshare_onebox"
-require_relative "engine/sound_cloud_onebox"
-require_relative "engine/spotify_onebox"
+require_relative "engine/google_play_app_onebox"
+require_relative "engine/image_onebox"
 require_relative "engine/stack_exchange_onebox"
-require_relative "engine/ted_onebox"
-require_relative "engine/twitter_onebox"
-require_relative "engine/viddler_onebox"
-require_relative "engine/vimeo_onebox"
+require_relative "engine/twitter_status_onebox"
 require_relative "engine/wikipedia_onebox"
-require_relative "engine/yfrog_onebox"
+require_relative "engine/youtube_onebox"
+require_relative "engine/whitelisted_generic_onebox"

data/lib/onebox/engine/amazon_onebox.rb

@@ -2,6 +2,7 @@ module Onebox
   module Engine
     class AmazonOnebox
       include Engine
+      include LayoutSupport
       include HTML
 
       matches do
@@ -11,16 +12,42 @@ module Onebox
         has(".").either("com", "ca").maybe("/")
       end
 
+      def url
+        return "http://www.amazon.com/gp/aw/d/" + URI::encode(match[:id]) if match && match[:id]
+        @url
+      end
+
+      def http_params
+        {'User-Agent' => 'Mozilla/5.0 (iPhone; CPU iPhone OS 5_0_1 like Mac OS X) AppleWebKit/534.46 (KHTML, like Gecko) Version/5.1 Mobile/9A405 Safari/7534.48.3'}
+      end
+
       private
 
+      def match
+        @match ||= @url.match(/(?:d|g)p\/(?:product\/)?(?<id>[^\/]+)(?:\/|$)/mi)
+      end
+
+      def image
+        case
+        when raw.css("#main-image").any?
+          raw.css("#main-image").first["src"]
+        when raw.css("#landingImage").any?
+          raw.css("#landingImage").first["src"]
+        end
+      end
+
       def data
-        {
-          url: @url,
-          name: raw.css("h1").inner_text,
-          image: raw.css("#main-image").first["src"],
-          description: raw.css("#postBodyPS").inner_text,
-          price: raw.css(".priceLarge").inner_text
-        }
+        result = { link: link,
+                   title: raw.css("h1").inner_text,
+                   image: image,
+                   price: raw.css(".priceLarge").inner_text }
+
+        result[:by_info] = raw.at("#by-line")
+        result[:by_info] = Onebox::Helpers.clean(result[:by_info].inner_html) if result[:by_info]
+
+        summary = raw.at("#about-item span")
+        result[:description] = summary.inner_html if summary
+        result
       end
     end
   end

data/lib/onebox/engine/classic_google_maps_onebox.rb

@@ -0,0 +1,37 @@
+module Onebox
+  module Engine
+    class ClassicGoogleMapsOnebox
+      include Engine
+      include LayoutSupport
+
+      matches_regexp /^(https?:)?\/\/(maps\.google\.[\w.]{2,}|goo\.gl)\/maps?.+$/
+
+      def url
+        @url = get_long_url if @url.include?("//goo.gl/maps/") 
+        @url
+      end
+
+      def to_html
+        "<iframe src='#{url}&output=embed' width='690px' height='400px' frameborder='0' style='border:0'></iframe>" 
+      end
+
+      private 
+
+      def data
+        {link: url, title: url}
+      end
+
+      def get_long_url
+        uri = URI(@url)
+        http = Net::HTTP.start(uri.host, uri.port)
+        http.open_timeout = timeout
+        http.read_timeout = timeout
+        response = http.head(uri.path)
+        response["Location"] if response.code == "301"
+      rescue
+        @url
+      end
+
+    end
+  end
+end

data/lib/onebox/engine/github_blob_onebox.rb

@@ -2,7 +2,7 @@ module Onebox
   module Engine
     class GithubBlobOnebox
       include Engine
-      include HTML
+      include LayoutSupport
 
       matches do
         http
@@ -15,13 +15,33 @@ module Onebox
 
       private
 
+      def raw
+        return @raw if @raw
+        m = @url.match(/github\.com\/(?<user>[^\/]+)\/(?<repo>[^\/]+)\/blob\/(?<sha1>[^\/]+)\/(?<file>[^#]+)(#(L(?<from>[^-]*)(-L(?<to>.*))?))?/mi)
+        if m
+          from = (m[:from] || -1).to_i
+          to = (m[:to] || -1).to_i
+          @file = m[:file]
+          contents = open("https://raw.github.com/#{m[:user]}/#{m[:repo]}/#{m[:sha1]}/#{m[:file]}", read_timeout: timeout).read
+          if from > 0
+            if to < 0
+              from = from - 10
+              to = from + 20
+            end
+            if to > from
+              contents = contents.split("\n")[from..to].join("\n")
+            end
+          end
+          if contents.length > 5000
+            contents = contents[0..5000]
+            @truncated = true
+          end
+          @raw = contents
+        end
+      end
+
       def data
-        {
-          url: @url,
-          filename: raw.css(".final-path").inner_text,
-          lines: raw.css("#files .file .info .mode + span").inner_text,
-          file: raw.css("#files .file .blob-wrapper").inner_text
-        }
+        @data ||= {title: link, link: link, content: raw, truncated: @truncated}
       end
     end
   end