onebox 1.5.20 → 1.5.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ecd245b860952c9a28eb5447bc161ac33faf88c7
-  data.tar.gz: 22c1a7591f80bc67dad9b9b496de3351b167958c
+  metadata.gz: d81ab9ca72a2dea627e57a27c47f38afce6cfaca
+  data.tar.gz: 01a0b589ea13c180bf59d83acd4a41b96f156d75
 SHA512:
-  metadata.gz: 7007497474adad17ad08fefe10c19dfe3a1a5c785b2dfe6de0d34895ef7788b71cfa5d8b31510f4201ba07ace156c7496accf17c14ffea36a0cd2b00385a7a2b
-  data.tar.gz: 29b0731949d0efdd0285d15b8e920df917725a022f64c2245dbbde689bc70b5ed3fbbe278091d990423f0f220decf33174a8198ee85e2cda613de92cb09266bb
+  metadata.gz: e6cfa6120bdbb68a11343f8858e528767d29e94e6fcec54e1c6b60c9ed1e513de6f311cdb5d461f6b0ed090ccd4ec4279e56e0c0ac57ad0a3d5f9448f9563298
+  data.tar.gz: 5cddf24c71ff367a226c41cd1b399c4ba288317879ab1537c0b1209ee3179a5a6681c7d676984f8ce464f0d973386858b24f9c3f3116c7c0e300dfe2643c882a

data/README.md

@@ -87,7 +87,7 @@ 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 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
@@ -176,12 +176,22 @@ Adding Support for a new URL
     ```
 
 
+Whitelisted Generic Onebox caveats
+==================================
+
+The Whitedlisted 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", "~> 1.2"
+    gem "onebox"
 
 And then execute:
 
@@ -192,6 +202,12 @@ 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
 ============
 

data/lib/onebox.rb

@@ -23,6 +23,10 @@ module Onebox
     Preview.new(url, options)
   end
 
+  def self.check(url, options = Onebox.options)
+    StatusCheck.new(url, options)
+  end
+
   def self.options
     OpenStruct.new(@@options)
   end
@@ -39,6 +43,7 @@ end
 
 require_relative "onebox/version"
 require_relative "onebox/preview"
+require_relative "onebox/status_check"
 require_relative "onebox/matcher"
 require_relative "onebox/engine"
 require_relative "onebox/layout"

data/lib/onebox/status_check.rb

@@ -0,0 +1,44 @@
+module Onebox
+  class StatusCheck
+    def initialize(url, options = Onebox.options)
+      @url = url
+      @options = options
+      @status = -1
+    end
+
+    def ok?
+      status > 199 && status < 300
+    end
+
+    def status
+      check if @status == -1
+      @status
+    end
+
+    def human_status
+      case status
+      when 0
+        :connection_error
+      when 200..299
+        :success
+      when 400..499
+        :client_error
+      when 500..599
+        :server_error
+      else
+        :unknown_error
+      end
+    end
+
+    private
+
+    def check
+      res = open(@url, read_timeout: (@options.timeout || Onebox.options.timeout))
+      @status = res.status.first.to_i
+    rescue OpenURI::HTTPError => e
+      @status = e.io.status.first.to_i
+    rescue Timeout::Error, Errno::ECONNREFUSED, Net::HTTPError
+      @status = 0
+    end
+  end
+end

data/lib/onebox/version.rb

@@ -1,3 +1,3 @@
 module Onebox
-  VERSION = "1.5.20"
+  VERSION = "1.5.21"
 end

data/spec/lib/onebox/status_check_spec.rb

@@ -0,0 +1,68 @@
+require "spec_helper"
+
+describe Onebox::StatusCheck do
+  before do
+    FakeWeb.register_uri(:get, "http://www.amazon.com/200-url", status: 200)
+    FakeWeb.register_uri(:get, "http://www.amazon.com/201-url", status: 201)
+    FakeWeb.register_uri(:get, "http://www.amazon.com/401-url", status: 401)
+    FakeWeb.register_uri(:get, "http://www.amazon.com/403-url", status: 403)
+    FakeWeb.register_uri(:get, "http://www.amazon.com/404-url", status: 404)
+    FakeWeb.register_uri(:get, "http://www.amazon.com/500-url", status: 500)
+    FakeWeb.register_uri(:get, "http://www.amazon.com/503-url", status: 503)
+    FakeWeb.register_uri(:get, "http://www.amazon.com/timeout-url", exception: Timeout::Error)
+    FakeWeb.register_uri(:get, "http://www.amazon.com/http-error", exception: Net::HTTPError)
+    FakeWeb.register_uri(:get, "http://www.amazon.com/error-connecting", exception: Errno::ECONNREFUSED)
+  end
+
+  describe '#human_status' do
+    it 'returns :success on HTTP status code 200' do
+      expect(described_class.new("http://www.amazon.com/200-url").human_status).to eq(:success)
+    end
+
+    it 'returns :success on HTTP status code 201' do
+      expect(described_class.new("http://www.amazon.com/201-url").human_status).to eq(:success)
+    end
+
+    it 'returns :client_error on HTTP status code 401' do
+      expect(described_class.new("http://www.amazon.com/401-url").human_status).to eq(:client_error)
+    end
+
+    it 'returns :client_error on HTTP status code 403' do
+      expect(described_class.new("http://www.amazon.com/403-url").human_status).to eq(:client_error)
+    end
+
+    it 'returns :client_error on HTTP status code 404' do
+      expect(described_class.new("http://www.amazon.com/404-url").human_status).to eq(:client_error)
+    end
+
+    it 'returns :server_error on HTTP status code 500' do
+      expect(described_class.new("http://www.amazon.com/500-url").human_status).to eq(:server_error)
+    end
+
+    it 'returns :server_error on HTTP status code 503' do
+      expect(described_class.new("http://www.amazon.com/503-url").human_status).to eq(:server_error)
+    end
+
+    it 'returns :connection_error if there is a connection refused error' do
+      expect(described_class.new("http://www.amazon.com/error-connecting").human_status).to eq(:connection_error)
+    end
+
+    it 'returns :connection_error if there is a timeout error' do
+      expect(described_class.new("http://www.amazon.com/timeout-url").human_status).to eq(:connection_error)
+    end
+
+    it 'returns :connection_error if there is a general HTTP error' do
+      expect(described_class.new("http://www.amazon.com/http-error").human_status).to eq(:connection_error)
+    end
+  end
+
+  describe '#ok?' do
+    it 'returns true for HTTP status codes 200-299' do
+      expect(described_class.new("http://www.amazon.com/200-url").ok?).to be true
+    end
+
+    it 'returns false for any status codes other than 200-299' do
+      expect(described_class.new("http://www.amazon.com/404-url").ok?).to be false
+    end
+  end
+end

data/templates/githubissue.mustache

@@ -23,7 +23,7 @@
 
 <pre class='content' style="white-space: pre-wrap;">{{content}}</pre>
 
-<div class='lables'>
+<div class='labels'>
 	{{#labels}}
  	<span style="display:inline-block;margin-top:2px;background-color: #B8B8B8;padding: 2px;border-radius: 4px;color: #fff;margin-left: 3px;">{{name}}</span>
  	{{/labels}}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: onebox
 version: !ruby/object:Gem::Version
-  version: 1.5.20
+  version: 1.5.21
 platform: ruby
 authors:
 - Joanna Zeta
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-10 00:00:00.000000000 Z
+date: 2015-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -316,6 +316,7 @@ files:
 - lib/onebox/layout_support.rb
 - lib/onebox/matcher.rb
 - lib/onebox/preview.rb
+- lib/onebox/status_check.rb
 - lib/onebox/template_support.rb
 - lib/onebox/version.rb
 - lib/onebox/view.rb
@@ -368,6 +369,7 @@ files:
 - spec/lib/onebox/layout_spec.rb
 - spec/lib/onebox/matcher_spec.rb
 - spec/lib/onebox/preview_spec.rb
+- spec/lib/onebox/status_check_spec.rb
 - spec/lib/onebox_spec.rb
 - spec/spec_helper.rb
 - spec/support/html_spec_helper.rb
@@ -411,7 +413,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: A gem for turning URLs into previews.
@@ -462,6 +464,7 @@ test_files:
 - spec/lib/onebox/layout_spec.rb
 - spec/lib/onebox/matcher_spec.rb
 - spec/lib/onebox/preview_spec.rb
+- spec/lib/onebox/status_check_spec.rb
 - spec/lib/onebox_spec.rb
 - spec/spec_helper.rb
 - spec/support/html_spec_helper.rb