link_thumbnailer 1.1.2 → 2.0.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MTI4ZDFkMDdhMWJiM2Y2M2ZlODEwMTg1NjU4MDg3NWIxNDg1NmVkMw==
-  data.tar.gz: !binary |-
-    ZGY2MzVlMTM1OGQxNWEwODNjMDM2ZGIyNDIwZjAzNWZiNjI5ZmEzNA==
+SHA1:
+  metadata.gz: c1f15206d5f7ec2528178fd2fc49a2c226cbd1d7
+  data.tar.gz: b10ea72d36315c40263688402b268075264131f6
 SHA512:
-  metadata.gz: !binary |-
-    YTRlNGI4Yjk2Njk2MDgwNTI2YTgyMGJlNDdmMTk2Y2Q4YjEyY2UyODAyOGU5
-    YTk0ZTJjOTg5YWJjZDBjN2U5NWM2ODg3YzRiNGY3ZGYzZGU3NTE0YzE2YjM3
-    MDIyM2UwNTQ3MmJkZWY4YzcwZjkzNWU0ZjRiNzNmMmViNzA2MTM=
-  data.tar.gz: !binary |-
-    MGI4ZjIwNWEzODIwN2E4YjA0MGVjYWY1NzUzZGE0Njk3MzcxOTA0Zjk3OGY5
-    YmFkZmM3MTE3ODc5Mzk2OTYxZTY0NTQwYjY0NjQwNzFjODY5NmY2MDE2MDFj
-    ODY0NWYxMzNmMTAzY2FkYjU5YzY3YTg2ODhmNjhhODFlYzc5ZjA=
+  metadata.gz: fd9cb26e28184c783f82f866173b49988ceba7b62f04a26930be127e3382fdcfb7f891f9f21d73cbbfc176b61a29ed6581f7cbd9b52fe56bc474c7ba10cdacd9
+  data.tar.gz: 426fb6ec3bf6f2118807d7eb281b36fa1abb1bccce060b85e734704bb5489806483e4a048df2d81e54d9db5b9be0edb2359909ea4d267dd3f9800aac850e107a

data/.travis.yml

@@ -1,6 +1,6 @@
 bundler_args: --without development
 language: ruby
 rvm:
-  - 1.9.2
   - 1.9.3
   - 2.0.0
+  - 2.1.0

data/CHANGELOG.md

@@ -1,104 +1,117 @@
-# 1.1.2
-
-- Fix issue with FastImage URLs [https://github.com/gottfrois/link_thumbnailer/pull/31](https://github.com/gottfrois/link_thumbnailer/pull/31)
-
-# 1.1.1
-
-- Fix route helper not working under rails 4.
-
-# 1.1.0
-
-- Replace RMagick by [FastImage](https://github.com/sdsykes/fastimage)
-- Rename `rmagick_attributes` config into `image_attributes`
-
-# 1.0.9
-
-- Fix issue when Location header used a relative path instead of an absolute path
-- Update gemfile to be more flexible when using Hashie gem
-
-# 1.0.8
-
-- Thanks to [juriglx](https://github.com/juriglx), support for canonical urls
-- Bug fixes
-
-# 1.0.7
-
-- Fix: Issue with preview controller
-
-# 1.0.6
-
-- Fix: Issue when setting `strict` option. Always returning OG representation.
-
-# 1.0.5
-
-- Thanks to [phlegx](https://github.com/phlegx), support for timeout http connection through configurations.
-
-# 1.0.4
-
-- Fix issue #7: nil img was returned when exception is raised. Now skiping nil images in results.
-- Thanks to [phlegx](https://github.com/phlegx), support for SSL and User Agent customization through configurations.
-
-# 1.0.3
-
-- Fix issue #5: Url was incorect in case of HTTP Redirections.
-
-# 1.0.2
-
-- Feature: User can now set options at runtime by passing valid options to ```generate``` method
-- Bug fix when doing ```rails g link_thumbnailer:install``` by explicitly specifying the scope of Rails
-
-# 1.0.1
-
-- Refactor LinkThumbnailer#generate method to have a cleaner code
-
-# 1.0.0
-
-- Update readme
-- Add PreviewController for easy integration with user's app
-- Add link_thumbnailer routes for easy integration with user's app
-- Refactor some code
-- Change 'to_a' method to 'to_hash' in object model
-
-# 0.0.6
-
-- Update readme
-- Add `to_a` to WebImage class
-- Refactor `to_json` for WebImage class
-- Add specs corresponding
-
-# 0.0.5
-
-- Bug fix
-- Remove `require 'rails'` from spec_helper.rb
-- Remove rails dependences (blank? method) in code
-- Spec fix
-
-# 0.0.4
-
-- Add specs for almost all classes
-- Add a method `to_json` for WebImage class to be able to get a usable array of images' attributes
-
-# 0.0.3
-
-- Add specs for LinkThumbnailer class
-- Refactor config system, now using dedicated configuration class
-
-# 0.0.2
-
-- Added Rspec
-- Bug fixes:
-	- Now checking if attribute is blank for LinkThumbnailer::Object.valid? method
-
-# 0.0.1
-
-- LinkThumbnailer::Object
-- LinkThumbnailer::Doc
-- LinkThumbnailer::DocParser
-- LinkThumbnailer::Fetcher
-- LinkThumbnailer::ImgComparator
-- LinkThumbnailer::ImgParser
-- LinkThumbnailer::ImgUrlFilter
-- LinkThumbnailer::Opengraph
-- LinkThumbnailer::WebImage
-- LinkThumbnailer.configure
-- LinkThumbnailer.generate
+# 2.0.0
+
+- Fully refactored LinkThumbnailer
+- Introduced [Graders](https://github.com/gottfrois/link_thumbnailer/wiki/How-to-build-your-own-Grader%3F)
+- Introduced [Scrapers](https://github.com/gottfrois/link_thumbnailer/wiki/Attributes-option-explained)
+- Ability to score descriptions
+- Ability to fetch multiple `og:image`
+- Fixed memoized run-time options
+- Fixed some website urls not working
+- Refactor ugly code
+- More specs
+- Removed `PreviewsController` since it does not add much value. Simply create your own and use the `to_json` method.
+
+# 1.1.2
+
+- Fix issue with FastImage URLs [https://github.com/gottfrois/link_thumbnailer/pull/31](https://github.com/gottfrois/link_thumbnailer/pull/31)
+
+# 1.1.1
+
+- Fix route helper not working under rails 4.
+
+# 1.1.0
+
+- Replace RMagick by [FastImage](https://github.com/sdsykes/fastimage)
+- Rename `rmagick_attributes` config into `image_attributes`
+
+# 1.0.9
+
+- Fix issue when Location header used a relative path instead of an absolute path
+- Update gemfile to be more flexible when using Hashie gem
+
+# 1.0.8
+
+- Thanks to [juriglx](https://github.com/juriglx), support for canonical urls
+- Bug fixes
+
+# 1.0.7
+
+- Fix: Issue with preview controller
+
+# 1.0.6
+
+- Fix: Issue when setting `strict` option. Always returning OG representation.
+
+# 1.0.5
+
+- Thanks to [phlegx](https://github.com/phlegx), support for timeout http connection through configurations.
+
+# 1.0.4
+
+- Fix issue #7: nil img was returned when exception is raised. Now skiping nil images in results.
+- Thanks to [phlegx](https://github.com/phlegx), support for SSL and User Agent customization through configurations.
+
+# 1.0.3
+
+- Fix issue #5: Url was incorect in case of HTTP Redirections.
+
+# 1.0.2
+
+- Feature: User can now set options at runtime by passing valid options to ```generate``` method
+- Bug fix when doing ```rails g link_thumbnailer:install``` by explicitly specifying the scope of Rails
+
+# 1.0.1
+
+- Refactor LinkThumbnailer#generate method to have a cleaner code
+
+# 1.0.0
+
+- Update readme
+- Add PreviewController for easy integration with user's app
+- Add link_thumbnailer routes for easy integration with user's app
+- Refactor some code
+- Change 'to_a' method to 'to_hash' in object model
+
+# 0.0.6
+
+- Update readme
+- Add `to_a` to WebImage class
+- Refactor `to_json` for WebImage class
+- Add specs corresponding
+
+# 0.0.5
+
+- Bug fix
+- Remove `require 'rails'` from spec_helper.rb
+- Remove rails dependences (blank? method) in code
+- Spec fix
+
+# 0.0.4
+
+- Add specs for almost all classes
+- Add a method `to_json` for WebImage class to be able to get a usable array of images' attributes
+
+# 0.0.3
+
+- Add specs for LinkThumbnailer class
+- Refactor config system, now using dedicated configuration class
+
+# 0.0.2
+
+- Added Rspec
+- Bug fixes:
+	- Now checking if attribute is blank for LinkThumbnailer::Object.valid? method
+
+# 0.0.1
+
+- LinkThumbnailer::Object
+- LinkThumbnailer::Doc
+- LinkThumbnailer::DocParser
+- LinkThumbnailer::Fetcher
+- LinkThumbnailer::ImgComparator
+- LinkThumbnailer::ImgParser
+- LinkThumbnailer::ImgUrlFilter
+- LinkThumbnailer::Opengraph
+- LinkThumbnailer::WebImage
+- LinkThumbnailer.configure
+- LinkThumbnailer.generate

data/Gemfile

@@ -3,7 +3,7 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in link_thumbnailer.gemspec
 gemspec
 
-group :test do
+group :development, :test do
   gem 'coveralls',  require: false
   gem 'simplecov',  require: false
   gem 'rspec',      '~> 2.14'

data/{LICENSE → LICENSE.txt}

@@ -1,22 +1,22 @@
-Copyright (c) 2012 Pierre-Louis Gottfrois
-
-MIT License
-
-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
+Copyright (c) 2012 Pierre-Louis Gottfrois
+
+MIT License
+
+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

@@ -1,184 +1,153 @@
-# LinkThumbnailer
-
-[![Code Climate](https://codeclimate.com/github/gottfrois/link_thumbnailer.png)](https://codeclimate.com/github/gottfrois/link_thumbnailer)
-[![Coverage Status](https://coveralls.io/repos/gottfrois/link_thumbnailer/badge.png?branch=master)](https://coveralls.io/r/gottfrois/link_thumbnailer?branch=master)
-[![Build Status](https://travis-ci.org/gottfrois/link_thumbnailer.png?branch=master)](https://travis-ci.org/gottfrois/link_thumbnailer)
-
-Ruby gem generating image thumbnails from a given URL. Rank them and give you back an object containing images and website informations. Works like Facebook link previewer.
-
-Demo Application is [here](http://link-thumbnailer-demo.herokuapp.com/) !
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'link_thumbnailer'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install link_thumbnailer
-
-Run:
-
-	$ rails g link_thumbnailer:install
-
-This will add `link_thumbnailer.rb` to `config/initializers/`. See [#Configuration](https://github.com/gottfrois/link_thumbnailer#configuration) for more details.
-
-## Usage
-
-Run `irb` and require the gem:
-
-	require 'rails'
-	 => true
-
-	require 'link_thumbnailer'
-	 => true
-
-This gem can handle [Opengraph](http://ogp.me/) protocol. Here is an example with such a website:
-
-	object = LinkThumbnailer.generate('http://zerply.com')
-	 => #<LinkThumbnailer::Object description="Go beyond the résumé - showcase your work and your talent" image="http://zerply.com/img/front/facebook_icon_green.png" images=["http://zerply.com/img/front/facebook_icon_green.png"] site_name="zerply.com" title="Join Me on Zerply" url="http://zerply.com">
-
-	object.title?
- 	=> true
- 	object.title
- 	=> "Join Me on Zerply"
-
- 	object.url?
-	=> true
-	object.url
-	=> "http://zerply.com"
-
-	object.foo?
-	=> false
-	object.foo
-	=> nil
-
-Now with a regular website with no particular protocol:
-
-	object = LinkThumbnailer.generate('http://foo.com')
-	 => #<LinkThumbnailer::Object description=nil images=[[ JPEG 750x200 750x200+0+0 DirectClass 8-bit 45kb] scene=0] title="Foo.com" url="http://foo.com">
-
-	object.title
-	 => "Foo.com"
-
-	object.images
-	 => [[ JPEG 750x200 750x200+0+0 DirectClass 8-bit 45kb]
-	scene=0]
-
-	object.images.first.source_url
-	 => #<URI::HTTP:0x007ff7a923ef58 URL:http://foo.com/media/BAhbB1sHOgZmSSItMjAxMi8wNC8yNi8yMC8xMS80OS80MjYvY29yZG92YWJlYWNoLmpwZwY6BkVUWwg6BnA6CnRodW1iSSINNzUweDIwMCMGOwZU/cordovabeach.jpg>
-
-	object.to_hash
-	 => {"url"=>"http://foo.com", "images"=>[{:source_url=>"http://foo.com/media/BAhbB1sHOgZmSSItMjAxMi8wNC8yNi8yMC8xMS80OS80MjYvY29yZG92YWJlYWNoLmpwZwY6BkVUWwg6BnA6CnRodW1iSSINNzUweDIwMCMGOwZU/cordovabeach.jpg", :mime_type=>"image/jpeg", :rows=>200, :filesize=>46501, :number_colors=>9490}], "title"=>"Foo.com", "description"=>nil}
-
-	object.to_json
-	 => "{\"url\":\"http://foo.com\",\"images\":[{\"source_url\":\"http://foo.com/media/BAhbB1sHOgZmSSItMjAxMi8wNC8yNi8yMC8xMS80OS80MjYvY29yZG92YWJlYWNoLmpwZwY6BkVUWwg6BnA6CnRodW1iSSINNzUweDIwMCMGOwZU/cordovabeach.jpg\",\"mime_type\":\"image/jpeg\",\"rows\":200,\"filesize\":46501,\"number_colors\":9490}],\"title\":\"Foo.com\",\"description\":null}"
-
-You can check whether this object is valid or not (set mandatory attributes in the initializer, defaults are `[url, title, images]`)
-
-	object.valid?
- 	=> true
-
- You also can set options at runtime:
-
- 	object = LinkThumbnailer.generate('http://foo.com', top: 10, limit: 20, redirect_limit: 5)
-
-## Preview Controller
-
-For an easy integration into your application, use the builtin `PreviewController`.
-
-Take a look at the demo application [here](https://github.com/gottfrois/link_thumbnailer_demo).
-
-Basically, all you have to do in your view is something like this:
-
-	<%= form_tag '/link/preview', method: :post, remote: true do %>
-		<%= text_field_tag :url %>
-		<%= submit_tag 'Preview' %>
-	<% end %>
-
-Don't forget to add this anywhere in your `routes.rb` file:
-
-	use_link_thumbnailer
-
-Note: You won't have to bother with this if you did run the installer using:
-
-	$ rails g link_thumbnailer:install
-
-The `PreviewController` will automatically respond to json calls, returning json version of the preview object. Just like in the IRB console above.
-
-## Configuration
-
-In `config/initializers/link_thumbnailer.rb`
-
-	LinkThumbnailer.configure do |config|
-	  # Set mandatory attributes require for the website to be valid.
-	  # You can set `strict` to false if you want to skip this validation.
-	  # config.mandatory_attributes = %w(url title image)
-
-	  # Whether you want to validate given website against mandatory attributes or not.
-	  # config.strict = true
-
-	  # Numbers of redirects before raising an exception when trying to parse given url.
-	  # config.redirect_limit = 3
-
-	  # List of blacklisted urls you want to skip when searching for images.
-	  # config.blacklist_urls = [
-	  #   %r{^http://ad\.doubleclick\.net/},
-	  #   %r{^http://b\.scorecardresearch\.com/},
-	  #   %r{^http://pixel\.quantserve\.com/},
-	  #   %r{^http://s7\.addthis\.com/}
-	  # ]
-
-	  # Fetch 10 images maximum.
-	  # config.limit = 10
-
-	  # Return top 5 images only.
-	  # config.top = 5
-
-	  # Set user agent
-	  # config.user_agent = 'linkthumbnailer'
-
-	  # Enable or disable SSL verification
-  	# config.verify_ssl = true
-
-	  # HTTP open_timeout: The amount of time in seconds to wait for a connection to be opened.
-	  # config.http_timeout = 5
-	end
-
-## Features
-
-Implemented:
-
-- Implements [OpenGraph](http://ogp.me/) protocol.
-- Find images and sort them according to how well they represent what the page is about (includes absolute images).
-- Sort images based on their size and color.
-- Blacklist some well known advertisings image urls.
-- Routes and Controllers to handle preview generation
-
-Coming soon:
-
-- Use the gem [ruby-readability](https://github.com/iterationlabs/ruby-readability) to parse images and website information
-- Cache results on filesystem
-
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Run the specs (`bundle exec rspec spec`)
-4. Commit your changes (`git commit -am 'Added some feature'`)
-5. Push to the branch (`git push origin my-new-feature`)
-6. Create new Pull Request
-
-## Contributors
-
-- [phlegx](https://github.com/phlegx)
-- [juriglx](https://github.com/juriglx)
-
-
-[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/gottfrois/link_thumbnailer/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
-
+# LinkThumbnailer
+
+[![Code Climate](https://codeclimate.com/github/gottfrois/link_thumbnailer.png)](https://codeclimate.com/github/gottfrois/link_thumbnailer)
+[![Coverage Status](https://coveralls.io/repos/gottfrois/link_thumbnailer/badge.png?branch=master)](https://coveralls.io/r/gottfrois/link_thumbnailer?branch=master)
+[![Build Status](https://travis-ci.org/gottfrois/link_thumbnailer.png?branch=master)](https://travis-ci.org/gottfrois/link_thumbnailer)
+
+Ruby gem generating image thumbnails from a given URL. Rank them and give you back an object containing images and website informations. Works like Facebook link previewer.
+
+Demo Application is [here](http://link-thumbnailer-demo.herokuapp.com/) !
+
+## Features
+
+- Dead simple.
+- Support [OpenGraph](http://ogp.me/) protocol.
+- Find and sort images that best represent what the page is about.
+- Find and rate description that best represent what the page is about.
+- Allow for custom class to sort the website descriptions yourself.
+- Support image urls blacklisting (advertisements).
+- Works with and without Rails.
+- Fully customizable.
+- Fully tested.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'link_thumbnailer'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install link_thumbnailer
+
+Run:
+
+	$ rails g link_thumbnailer:install
+
+This will add `link_thumbnailer.rb` to `config/initializers/`.
+
+## Usage
+
+Run `irb` and require the gem:
+
+	require 'link_thumbnailer'
+
+The gem handle regular website but also website that use the [Opengraph](http://ogp.me/) protocol.
+
+	object = LinkThumbnailer.generate('http://stackoverflow.com')
+	 => #<LinkThumbnailer::Models::Website:...>
+
+	object.title
+	 => "Stack Overflow"
+
+	object.description
+	 => "Q&A for professional and enthusiast programmers"
+
+	object.images.first.src.to_s
+	 => "http://cdn.sstatic.net/stackoverflow/img/apple-touch-icon@2.png?v=fde65a5a78c6"
+
+LinkThumbnailer `generate` method return an instance of `LinkThumbnailer::Models::Website` that respond to `to_json` and `as_json` as you would expect:
+
+	object.to_json
+	 => "{\"url\":\"http://stackoverflow.com\",\"title\":\"Stack Overflow\",\"description\":\"Q&A for professional and enthusiast programmers\",\"images\":[{\"src\":\"http://cdn.sstatic.net/stackoverflow/img/apple-touch-icon@2.png?v=fde65a5a78c6\",\"size\":[316,316],\"type\":\"png\"}]}"
+
+
+## Configuration
+
+LinkThumnailer comes with default configuration values. You can change default value by overriding them in a rails initializer:
+
+In `config/initializers/link_thumbnailer.rb`
+
+	LinkThumbnailer.configure do |config|
+	  # Numbers of redirects before raising an exception when trying to parse given url.
+	  #
+	  # config.redirect_limit = 3
+
+	  # Set user agent
+	  #
+	  # config.user_agent = 'link_thumbnailer'
+
+	  # Enable or disable SSL verification
+	  #
+	  # config.verify_ssl = true
+
+	  # The amount of time in seconds to wait for a connection to be opened.
+	  # If the HTTP object cannot open a connection in this many seconds,
+	  # it raises a Net::OpenTimeout exception.
+	  #
+	  # See http://www.ruby-doc.org/stdlib-2.1.1/libdoc/net/http/rdoc/Net/HTTP.html#open_timeout
+	  #
+	  # config.http_timeout = 5
+
+	  # List of blacklisted urls you want to skip when searching for images.
+	  #
+	  # config.blacklist_urls = [
+	  #   %r{^http://ad\.doubleclick\.net/},
+	  #   %r{^http://b\.scorecardresearch\.com/},
+	  #   %r{^http://pixel\.quantserve\.com/},
+	  #   %r{^http://s7\.addthis\.com/}
+	  # ]
+
+	  # List of attributes you want LinkThumbnailer to fetch on a website.
+	  #
+	  # config.attributes = [:title, :images, :description]
+
+	  # List of procedures used to rate the website description. Add you custom class
+	  # here. Note that the order matter to compute the score. See wiki for more details
+	  # on how to build your own graders.
+	  #
+	  # config.graders = [
+	  #   ->(description) { ::LinkThumbnailer::Graders::Length.new(description) },
+	  #   ->(description) { ::LinkThumbnailer::Graders::HtmlAttribute.new(description, :class) },
+	  #   ->(description) { ::LinkThumbnailer::Graders::HtmlAttribute.new(description, :id) },
+	  #   ->(description) { ::LinkThumbnailer::Graders::Position.new(description) },
+	  #   ->(description) { ::LinkThumbnailer::Graders::LinkDensity.new(description) }
+	  # ]
+
+	  # Minimum description length for a website.
+	  #
+	  # config.description_min_length = 25
+
+	  # Regex of words considered positive to rate website description.
+	  #
+	  # config.positive_regex = /article|body|content|entry|hentry|main|page|pagination|post|text|blog|story/i
+
+	  # Regex of words considered negative to rate website description.
+	  #
+	  # config.negative_regex = /combx|comment|com-|contact|foot|footer|footnote|masthead|media|meta|outbrain|promo|related|scroll|shoutbox|sidebar|sponsor|shopping|tags|tool|widget|modal/i
+
+	  # Numbers of images to fetch. Fetching too many images will be slow.
+	  #
+	  # config.image_limit = 5
+	end
+
+Or at runtime:
+
+	object = LinkThumbnailer.generate('http://stackoverflow.com', redirect_limit: 5, user_agent: 'foo')
+
+Note that runtime options will override default global configuration.
+
+See [Configuration Options Explained](https://github.com/gottfrois/link_thumbnailer/wiki/Configuration-options-explained) for more details on each configuration options.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Run the specs (`bundle exec rspec spec`)
+4. Commit your changes (`git commit -am 'Added some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request