onebox 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 292535107d74004655646908fd33b6a4aba4229c
-  data.tar.gz: 7b2da58a31b11b745b7f0e4cffa96c050f190637
+  metadata.gz: 63d6aa188d0386a68d9d81be75ae88c844bfcf25
+  data.tar.gz: 705d8c65d0578efc9bb5c21bffcf47183c1d0d87
 SHA512:
-  metadata.gz: 544481fff1bba95af38f1467c35b509d5aa8f6a725f6912ab7f63d31055f2d0073ffce2962b3d546eb06834ddc2d81bcb01eb108d963661c4987e2729b590a23
-  data.tar.gz: 8b7970957af9cd698f52e242d6092acbaca945dd8fbe3f45617d471562c787b8c00b7223846342ca5cd08f4801b097e4fee9892b9d6ae8973ced5c4e34f7d67f
+  metadata.gz: 8518dc4c517c676a6afef5c61fb19bb2b249fce47883997ce1420cf75973cf67f75fe143c5c223f762beb3aced6955201eaeff8b5e1484442b634e8692b8b4e4
+  data.tar.gz: 73286c370651b4dad2721246d044b14ac9f3ab52c5ef1c6855ffdf92a530c4dd8c493061222494f1c902d3c9d258cf2e4331e649fdcf5a94f932953f797cfacb

data/.rspec

@@ -1 +1,5 @@
 --color
+--format documentation
+--fail-fast
+--backtrace
+

data/.travis.yml

@@ -1,3 +1,7 @@
 language: ruby
 rvm:
   - 2.0.0
+notifications:
+  email:
+    on_success: change
+    on_failure: change

data/README.md

@@ -1,159 +1,200 @@
 onebox
 ----------
 
-  - TODO: register to rubygems.org
+  - [![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/dysania/onebox.png)](https://travis-ci.org/dysania/onebox)
   - [![Dependency Status](https://gemnasium.com/dysania/onebox.png)](https://gemnasium.com/dysania/onebox)
   - [![Coverage Status](https://coveralls.io/repos/dysania/onebox/badge.png)](https://coveralls.io/r/dysania/onebox)
 
 
-Onebox is a library for turning media URLs into previews.
+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 from these sites:
-- Amazon
-- Android App Store
-- Apple Store
-- BlipTV
-- Clikthrough
-- College Humor
-- Dailymotion
-- Dotsub
-- Flickr
-- Funny or Die
-- Gist
-- Github
-    - Blob
-    - Commit
-    - Pull Request
-- Hulu
-- Imgur
-- Kinomap
-- NFB
-- Open Graph
-- Qik
-- Revision
-- Rotten Tomatoes
-- Slideshare
-- Smugmug
-- Soundcloud
-- Stack Exchange
-- TED
-- Twitter
-- Wikipedia
-- yFrog
-
-
-Using onebox
-===============
+
+Usage
+=====
+
+Using onebox is fairly simple!
+First, make sure the library is required:
 
 ``` ruby
 require "onebox"
 ```
 
-The `Gemfile` file would look like this:
+Then pass a link to the library's interface:
 
 ``` ruby
-# source/Gemfile
-source "https://rubygems.org"
+require "onebox"
 
-gem "onebox", "~> 1.0"
+url = "http://www.amazon.com/gp/product/B005T3GRNW/ref=s9_simh_gw_p147_d0_i2"
+preview = Onebox.preview(url)
 ```
 
-How to create a new onebox
-===========================
+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
+```
 
-1. Create new onebox engine
+Onebox has its own caching system but you can also provide (or turn off) your own system:
 
 ``` ruby
-# in lib/onebox/engine/name_onebox.rb
-
-module Onebox
-  module Engine
-    class NameOnebox
-      include Engine
-
-      private
-
-      def extracted_data
-        {
-          url: @url,
-          name: @body.css("h1").inner_text,
-          image: @body.css("#main-image").first["src"],
-          description: @body.css("#postBodyPS").inner_text
-        }
-      end
-    end
-  end
-end
+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
 ```
 
-2. Create new onebox spec
+In addition you can set your own defaults with this handy interface:
 
 ``` ruby
-# in spec/lib/onebox/engine/name_spec.rb
-require "spec_helper"
+require "onebox"
 
-describe Onebox::Engine::NameOnebox do
-  let(:link) { "http://yoursitename.com" }
-  let(:html) { described_class.new(link).to_html }
+Onebox.defaults = {
+  cache: Rails.cache
+}
 
-  before do
-    fake(link, response("name.response"))
-  end
+url = "http://www.amazon.com/gp/product/B005T3GRNW/ref=s9_simh_gw_p147_d0_i2"
+preview = Onebox.preview(url)
+"#{preview}" == preview.to_s #=> true
+```
 
-  it "returns video title" do
-    expect(html).to include("title")
-  end
 
-  it "returns video photo" do
-    expect(html).to include("photo.jpg")
-  end
+Setup
+=====
 
-  it "returns video description" do
-    expect(html).to include("description")
-  end
+  1. Create new onebox engine
 
-  it "returns URL" do
-    expect(html).to include(link)
-  end
-end
-```
+    ``` ruby
+    # in lib/onebox/engine/name_onebox.rb
 
-3. Create new handlebars template
-
-``` html
-# in templates/name.handlebars
-<div class="onebox">
-  <a href="{{url}}">
-    <h1>{{name}}</h1>
-    <h2 class="host">yoursitename.com</h2>
-    <img src="{{image}}" />
-    <p>{{description}}</p>
-  </a>
-</div>
-```
+    module Onebox
+      module Engine
+        class NameOnebox
+          include Engine
+          include HTML
 
-4. Create new fixture from HTML response
+          private
 
-``` bash
-curl --output spec/fixtures/name.response -L -X -GET http://yoursitename.com
-```
+          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
+    ```
 
-5. Require in Engine module
+  2. Create new onebox spec
 
-``` ruby
-# in lib/onebox/engine/engine.rb
-require_relative "engine/name_onebox"
-```
+    ``` 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.response"))
+      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
+    ```
+
+  3. Create new handlebars template
+
+    ``` html
+    # in templates/name.handlebars
+    <div class="onebox">
+      <a href="{{url}}">
+        <h1>{{name}}</h1>
+        <h2 class="host">example.com</h2>
+        <img src="{{image}}" />
+        <p>{{description}}</p>
+      </a>
+    </div>
+    ```
+
+  4. Create new fixture from HTML response
+
+    ``` bash
+    curl --output spec/fixtures/oneboxname.response -L -X -GET http://example.com
+    ```
+
+  5. 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:
 
-Installing onebox
-==================
+  - 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
+==========
 
 Add this line to your application's Gemfile:
 
-    gem 'onebox'
+    gem "onebox". "~> 1.0"
 
 And then execute:
 

data/lib/onebox.rb

@@ -3,7 +3,8 @@ require "multi_json"
 require "nokogiri"
 require "mustache"
 require "opengraph_parser"
-require "verbal_expressions"
+require "hexpress"
+require "hexpress/web"
 require "ostruct"
 require "moneta"
 
@@ -11,10 +12,12 @@ require_relative "onebox/version"
 require_relative "onebox/preview"
 require_relative "onebox/matcher"
 require_relative "onebox/engine"
+require_relative "onebox/view"
 
 module Onebox
   DEFAULTS = {
-    cache: Moneta.new(:Memory, expires: true, serializer: :json)
+    cache: Moneta.new(:Memory, expires: true, serializer: :json),
+    timeout: 10
   }
 
   @@defaults = DEFAULTS
@@ -24,7 +27,7 @@ module Onebox
   end
 
   def self.defaults
-    @@defaults
+    OpenStruct.new(@@defaults)
   end
 
   def self.defaults=(options)

data/lib/onebox/engine.rb

@@ -10,24 +10,29 @@ module Onebox
       end.map(&method(:const_get))
     end
 
+    attr_reader :url
     attr_reader :cache
+    attr_reader :timeout
+    attr_reader :view
 
-    def initialize(link, cache = Onebox.defaults)
+    def initialize(link, cache = nil, timeout = nil)
       @url = link
-      @cache = cache
+      @cache = cache || Onebox.defaults.cache
+      @timeout = timeout || Onebox.defaults.timeout
+      @view = View.new(self.class.template_name, true)
     end
 
     def to_html
-      Mustache.render(template, record)
+      view.to_html(record)
     end
 
     private
 
     def record
-      if cache.key?(@url)
-        cache.fetch(@url)
+      if cache.key?(url)
+        cache.fetch(url)
       else
-        cache.store(@url, data)
+        cache.store(url, data)
       end
     end
 
@@ -37,24 +42,6 @@ module Onebox
       raise NoMethodError, "Engines need to implement this method"
     end
 
-    def template
-      File.read(template_path)
-    end
-
-    def template_path
-      File.join(root, "templates", "#{template_name}.handlebars")
-    end
-
-    # returns the gem root directory
-    def root
-      Gem::Specification.find_by_name("onebox").gem_dir
-    end
-
-    # calculates handlebars template name for onebox using name of engine
-    def template_name
-      self.class.name.split("::").last.downcase.gsub(/onebox/, "")
-    end
-
     # raises error if not defined in onebox engine
     # in each onebox, returns hash of desired onebox content
     def data
@@ -71,7 +58,12 @@ module Onebox
       end
 
       def matches(&block)
-        class_variable_set :@@matcher, VerEx.new(&block)
+        class_variable_set :@@matcher, Hexpress.new(&block).to_r
+      end
+
+      # calculates handlebars template name for onebox using name of engine
+      def template_name
+        name.split("::").last.downcase.gsub(/onebox/, "")
       end
     end
   end
@@ -79,6 +71,7 @@ end
 
 require_relative "engine/open_graph"
 require_relative "engine/html"
+require_relative "engine/json"
 require_relative "engine/example_onebox"
 require_relative "engine/amazon_onebox"
 require_relative "engine/bliptv_onebox"
@@ -88,14 +81,23 @@ 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/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/sound_cloud_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/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/wikipedia_onebox"