link_preview 0.2.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9ecbcafc85c04588af5ed7ef77f971756f97418e
+  data.tar.gz: f77f0214f0de673b6920e22d37b64f94adb41e00
+SHA512:
+  metadata.gz: 711a72d409dafcde725db0de6acefd785fc968cec14914f5098630e79978ebd7f3dc0bf7e419d0b3c8af48ee0e0943d1b8dd95bac864c731c661f66d97023112
+  data.tar.gz: 43db146cbef88b3d00724c740e14979b9317b50d2a85cc4f13fa67f9b6ea94e0a590b26eb3044b94dac2fd61c391fef77b50033830e619010fc81d2139fd25b6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014, VMware, Inc. All Rights Reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,109 @@
+[![Build Status](https://secure.travis-ci.org/socialcast/link_preview.png?branch=master)](http://travis-ci.org/socialcast/link_preview) 
+[![Code Climate](https://codeclimate.com/github/socialcast/link_preview.png)](https://codeclimate.com/github/socialcast/link_preview)
+
+link_preview
+==============
+
+Generate an [oEmbed](http://oembed.com/) response for any URL.
+
+Usage
+------
+
+```ruby
+content = LinkPreview.fetch(url)
+content.as_oembed
+```
+
+Serialize content sources:
+```ruby
+content.sources
+```
+
+Load previous content via sources:
+```ruby
+previous_content = LinkPreview.load_content(url, options, content.sources)
+```
+
+Features
+--------
+- Designed to make the minimal number of HTTP requests to generate a preview
+- Configurable via [Faraday](https://github.com/lostisland/faraday) middleware
+- Battletested on wide variety of URLs and HTML in the wild
+- Includes test helper for stubbing `LinkPreview::Content`
+
+Installation
+-------------
+```shell
+gem install link_preview
+```
+
+Configuration
+--------------
+LinkPreview is configured via [`Faraday`](https://github.com/lostisland/faraday) with some additional middleware:
+
+```ruby
+# $RAILS_ROOT/config/initializer/link_preview.rb
+
+# Cache responses in Rails.cache
+class HTTPCache < Faraday::Middleware
+  CACHE_PREFIX = name
+  EXPIRES_IN = 10.minutes
+
+  def call(env)
+    url = env[:url].to_s
+    Rails.cache.fetch("#{CACHE_PREFIX}::#{url}", :expires_in => EXPIRES_IN) do
+      @app.call(env)
+    end
+  end
+end
+
+# Report unknown exceptions to Airbrake
+module ErrorHandler
+  IGNORED_EXCEPTIONS = [
+    IOError,
+    SocketError,
+    Timeout::Error,
+    Errno::ECONNREFUSED,
+    Errno::ECONNRESET,
+    Errno::EHOSTUNREACH,
+    Errno::ENETUNREACH,
+    Errno::ETIMEDOUT,
+    Net::ProtocolError,
+    Net::NetworkTimeoutError,
+    OpenSSL::SSL::SSLError
+  ]
+
+  class << self
+    def error_handler(e)
+      case e
+      when *IGNORED_EXCEPTIONS
+        # Ignore
+      else
+        Airbrake.notify_or_ignore(e)
+      end
+    end
+  end
+end
+
+LinkPreview.configure do |config|
+  config.http_adapter            = Faraday::Adapter::NetHttp
+  config.max_requests            = 10
+  config.follow_redirects        = true
+  config.middleware              = HTTPCache
+  config.error_handler           = ErrorHandler.method(:error_handler)
+end
+```
+
+Contributing
+--------------
+* Fork the project
+* Fix the issue
+* Add unit tests
+* Submit pull request on github
+
+See CONTRIBUTORS.txt for list of project contributors
+
+Copyright
+---------
+Copyright (c) 2014, VMware, Inc. All Rights Reserved.
+See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,15 @@
+#!/usr/bin/env rake
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/faraday/follow_redirects.rb

@@ -0,0 +1,155 @@
+# Copyright (c) 2011 Erik Michaels-Ober, Wynn Netherland, et al.
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+# NOTE faraday-middleware is not compatible with faraday 0.9.0
+# https://github.com/lostisland/faraday_middleware/pull/59
+#
+# Copied from https://github.com/lostisland/faraday_middleware
+require 'faraday'
+require 'set'
+
+module Faraday
+  # Public: Exception thrown when the maximum amount of requests is exceeded.
+  class RedirectLimitReached < Faraday::Error::ClientError
+    attr_reader :response
+
+    def initialize(response)
+      super "too many redirects; last one to: #{response['location']}"
+      @response = response
+    end
+  end
+
+  # Public: Follow HTTP 301, 302, 303, and 307 redirects.
+  #
+  # For HTTP 301, 302, and 303, the original GET, POST, PUT, DELETE, or PATCH
+  # request gets converted into a GET. With `:standards_compliant => true`,
+  # however, the HTTP method after 301/302 remains unchanged. This allows you
+  # to opt into HTTP/1.1 compliance and act unlike the major web browsers.
+  #
+  # This middleware currently only works with synchronous requests; i.e. it
+  # doesn't support parallelism.
+  class FollowRedirects < Faraday::Middleware
+    # HTTP methods for which 30x redirects can be followed
+    ALLOWED_METHODS = Set.new [:head, :options, :get, :post, :put, :patch, :delete]
+    # HTTP redirect status codes that this middleware implements
+    REDIRECT_CODES  = Set.new [301, 302, 303, 307]
+    # Keys in env hash which will get cleared between requests
+    ENV_TO_CLEAR    = Set.new [:status, :response, :response_headers]
+
+    # Default value for max redirects followed
+    FOLLOW_LIMIT = 3
+
+    # Public: Initialize the middleware.
+    #
+    # options - An options Hash (default: {}):
+    #           :limit               - A Numeric redirect limit (default: 3)
+    #           :standards_compliant - A Boolean indicating whether to respect
+    #                                  the HTTP spec when following 301/302
+    #                                  (default: false)
+    #           :cookies             - An Array of Strings (e.g.
+    #                                  ['cookie1', 'cookie2']) to choose
+    #                                  cookies to be kept, or :all to keep
+    #                                  all cookies (default: []).
+    def initialize(app, options = {})
+      super(app)
+      @options = options
+
+      @convert_to_get = Set.new [303]
+      @convert_to_get << 301 << 302 unless standards_compliant?
+    end
+
+    def call(env)
+      perform_with_redirection(env, follow_limit)
+    end
+
+    private
+
+    def convert_to_get?(response)
+      ![:head, :options].include?(response.env[:method]) &&
+        @convert_to_get.include?(response.status)
+    end
+
+    def perform_with_redirection(env, follows)
+      request_body = env[:body]
+      response = @app.call(env)
+
+      response.on_complete do |env|
+        if follow_redirect?(env, response)
+          raise RedirectLimitReached, response if follows.zero?
+          env = update_env(env, request_body, response)
+          response = perform_with_redirection(env, follows - 1)
+        end
+      end
+      response
+    end
+
+    def update_env(env, request_body, response)
+      env[:url] += response['location']
+      if @options[:cookies]
+        cookies = keep_cookies(env)
+        env[:request_headers][:cookies] = cookies unless cookies.nil?
+      end
+
+      if convert_to_get?(response)
+        env[:method] = :get
+        env[:body] = nil
+      else
+        env[:body] = request_body
+      end
+
+      ENV_TO_CLEAR.each {|key| env.delete key }
+
+      env
+    end
+
+    def follow_redirect?(env, response)
+      ALLOWED_METHODS.include? env[:method] and
+        REDIRECT_CODES.include? response.status
+    end
+
+    def follow_limit
+      @options.fetch(:limit, FOLLOW_LIMIT)
+    end
+
+    def keep_cookies(env)
+      cookies = @options.fetch(:cookies, [])
+      response_cookies = env[:response_headers][:cookies]
+      cookies == :all ? response_cookies : selected_request_cookies(response_cookies)
+    end
+
+    def selected_request_cookies(cookies)
+      selected_cookies(cookies)[0...-1]
+    end
+
+    def selected_cookies(cookies)
+      "".tap do |cookie_string|
+        @options[:cookies].each do |cookie|
+          string = /#{cookie}=?[^;]*/.match(cookies)[0] + ';'
+          cookie_string << string
+        end
+      end
+    end
+
+    def standards_compliant?
+      @options.fetch(:standards_compliant, false)
+    end
+  end
+end

data/lib/link_preview/configuration.rb

@@ -0,0 +1,86 @@
+# Copyright (c) 2014, VMware, Inc. All Rights Reserved.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights to
+# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+# of the Software, and to permit persons to whom the Software is furnished to do
+# so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require 'link_preview/http_client'
+
+module LinkPreview
+  class Configuration
+    attr_accessor :http_client
+    attr_accessor :http_adapter
+    attr_accessor :follow_redirects
+    attr_accessor :max_redirects
+    attr_accessor :max_requests
+    attr_accessor :timeout
+    attr_accessor :open_timeout
+    attr_accessor :error_handler
+    attr_accessor :middleware
+
+    def http_client
+      @http_client ||= HTTPClient.new(self)
+    end
+
+    def http_client=(http_client)
+      @http_client = http_client
+    end
+
+    def http_adapter
+      @http_adapter ||= Faraday::Adapter::NetHttp
+    end
+
+    def http_adapter=(http_adapter)
+      @http_adapter = http_adapter
+    end
+    def follow_redirects
+      @follow_redirects ||= true
+    end
+
+    def follow_redirects=(follow_redirects)
+      @follow_redirects = follow_redirects
+    end
+
+    def max_redirects
+      @max_redirects || 3
+    end
+
+    def max_requests
+      @max_requests || 10
+    end
+
+    def timeout
+      @timeout || 5 # seconds
+    end
+
+    def open_timeout
+      @open_timeout || 2 # seconds
+    end
+
+    def error_handler
+      @error_handler ||= Proc.new() { |_| }
+    end
+
+    def middleware
+      @middleware || []
+    end
+
+    def middleware=(*middleware)
+      @middleware = middleware
+    end
+  end
+end