link_thumbnailer 0.0.6 → 1.0.0

data/README.md

@@ -2,6 +2,8 @@
 
 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](https://github.com/gottfrois/link_thumbnailer_demo) !
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -26,6 +28,9 @@ This will add `link_thumbnailer.rb` to `config/initializers/`. See [#Configurati
 
 Run `irb` and require the gem:
 
+	require 'rails'
+	 => true
+
 	require 'link_thumbnailer'
 	 => true
 
@@ -64,14 +69,11 @@ Now with a regular website with no particular protocol:
 	object.images.first.source_url
 	 => #<URI::HTTP:0x007ff7a923ef58 URL:http://foo.com/media/BAhbB1sHOgZmSSItMjAxMi8wNC8yNi8yMC8xMS80OS80MjYvY29yZG92YWJlYWNoLmpwZwY6BkVUWwg6BnA6CnRodW1iSSINNzUweDIwMCMGOwZU/cordovabeach.jpg>
 
-	object.images.first.to_json
-	 => "{\"source_url\":\"http://foo.com/media/BAhbB1sHOgZmSSItMjAxMi8wNC8yNi8yMC8xMS80OS80MjYvY29yZG92YWJlYWNoLmpwZwY6BkVUWwg6BnA6CnRodW1iSSINNzUweDIwMCMGOwZU/cordovabeach.jpg\",\"mime_type\":\"image/jpeg\",\"density\":\"72x72\",\"rows\":200,\"filesize\":46501,\"number_colors\":9490}"
+	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.images.first.to_a
-	 => {:source_url=>#<URI::HTTP:0x007f8a4a2561c0 URL:http://foo.com/media/BAhbB1sHOgZmSSItMjAxMi8wNC8yNi8yMC8xMS80OS80MjYvY29yZG92YWJlYWNoLmpwZwY6BkVUWwg6BnA6CnRodW1iSSINNzUweDIwMCMGOwZU/cordovabeach.jpg>, :mime_type=>"image/jpeg", :density=>"72x72", :rows=>200, :filesize=>46501, :number_colors=>9490}
-
-	object.images.map(&:to_a)
-	 => [{:source_url=>#<URI::HTTP:0x007f8a4a2561c0 URL:http://foo.com/media/BAhbB1sHOgZmSSItMjAxMi8wNC8yNi8yMC8xMS80OS80MjYvY29yZG92YWJlYWNoLmpwZwY6BkVUWwg6BnA6CnRodW1iSSINNzUweDIwMCMGOwZU/cordovabeach.jpg>, :mime_type=>"image/jpeg", :density=>"72x72", :rows=>200, :filesize=>46501, :number_colors=>9490}]
+	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]`)
 
@@ -81,6 +83,29 @@ You can check whether this object is valid or not (set mandatory attributes in t
  You also can set `limit` and `top` options at runtime:
 
  	object = LinkThumbnailer.generate('http://foo.com', :top => 10, :limit => 20)
+ 	
+## 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 runned 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
 
@@ -120,6 +145,7 @@ Implemented:
 - 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:
 

data/app/controllers/link_thumbnailer/application_controller.rb

@@ -0,0 +1,4 @@
+module LinkThumbnailer
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/link_thumbnailer/previews_controller.rb

@@ -0,0 +1,11 @@
+module LinkThumbnailer
+  class PreviewsController < ApplicationController
+
+    respond_to :json
+
+    def create
+      @preview = LinkThumbnailer.generate(params[:url])
+      render :json => @preview.to_json
+    end
+  end
+end

data/lib/generators/link_thumbnailer/install_generator.rb

@@ -6,6 +6,10 @@ module LinkThumbnailer
 
       desc 'Creates a LinkThumbnailer initializer for your application.'
 
+      def install
+        route "use_link_thumbnailer"
+      end
+
       def copy_initializer
         template 'initializer.rb', 'config/initializers/link_thumbnailer.rb'
       end

data/lib/generators/templates/initializer.rb

@@ -18,6 +18,12 @@ LinkThumbnailer.configure do |config|
   #   %r{^http://s7\.addthis\.com/}
   # ]
 
+  # Included Rmagick attributes for images. See http://www.imagemagick.org/RMagick/doc/
+  # for more details.
+  # 'source_url' is a custom attribute and should always be included since this
+  # is where you'll find the image url.
+  # config.rmagick_attributes = %w(source_url mime_type colums rows filesize number_colors)
+
   # Fetch 10 images maximum.
   # config.limit = 10
 

data/lib/link_thumbnailer/engine.rb

@@ -0,0 +1,9 @@
+module LinkThumbnailer
+  class Engine < Rails::Engine
+
+    initializer 'link_thumbnailer.routes' do
+      LinkThumbnailer::Rails::Routes.install!
+    end
+
+  end
+end

data/lib/link_thumbnailer/object.rb

@@ -1,4 +1,5 @@
 require 'hashie'
+require 'json'
 
 module LinkThumbnailer
   class Object < Hashie::Mash
@@ -20,5 +21,21 @@ module LinkThumbnailer
       true
     end
 
+    def to_hash
+      if self.images.none? {|i| i.is_a?(String)}
+        super.merge('images' => self.images.map(&:to_hash))
+      else
+        super
+      end
+    end
+
+    def to_json
+      if self.images.none? {|i| i.is_a?(String)}
+        JSON.generate(self.to_hash.merge('images' => self.images.map(&:to_hash)))
+      else
+        JSON.generate(self.to_hash)
+      end
+    end
+
   end
 end

data/lib/link_thumbnailer/opengraph.rb

@@ -7,7 +7,11 @@ module LinkThumbnailer
             object[$1.gsub('-', '_')] = m.attribute('content').to_s
           end
         end
-        object[:images] = [object[:image]] if object[:image]
+
+        object[:images] = []
+        if object[:image]
+          object[:images] << { :source_url => object[:image] }
+        end
 
         object
       end

data/lib/link_thumbnailer/rails/routes/mapper.rb

@@ -0,0 +1,30 @@
+module LinkThumbnailer
+  module Rails
+    class Routes
+      class Mapper
+
+        def initialize(mapping = Mapping.new)
+          @mapping = mapping
+        end
+
+        def map(&block)
+          self.instance_eval(&block) if block
+          @mapping
+        end
+
+        def controllers(controller_names = {})
+          @mapping.controllers.merge!(controller_names)
+        end
+
+        def skip_controllers(*controller_names)
+          @mapping.skips = controller_names
+        end
+
+        def as(alias_names = {})
+          @mapping.as.merge!(alias_names)
+        end
+
+      end
+    end
+  end
+end

data/lib/link_thumbnailer/rails/routes/mapping.rb

@@ -0,0 +1,33 @@
+module LinkThumbnailer
+  module Rails
+    class Routes
+      class Mapping
+
+        attr_accessor :controllers, :as, :skips
+
+        def initialize
+          @controllers = {
+            :previews => 'link_thumbnailer/previews'
+          }
+
+          @as = {
+            :previews => :preview
+          }
+
+          @skips = []
+        end
+
+        def [](routes)
+          {
+            :controllers => @controllers[routes],
+            :as => @as[routes]
+          }
+        end
+
+        def skipped?(controller)
+          return @skips.include?(controller)
+        end
+      end
+    end
+  end
+end

data/lib/link_thumbnailer/rails/routes.rb

@@ -0,0 +1,47 @@
+require 'link_thumbnailer/rails/routes/mapping'
+require 'link_thumbnailer/rails/routes/mapper'
+
+module LinkThumbnailer
+  module Rails
+    class Routes
+
+      module Helper
+        def use_link_thumbnailer(options = {}, &block)
+          LinkThumbnailer::Rails::Routes.new(self, &block).generate_routes!(options)
+        end
+      end
+
+      def self.install!
+        ActionDispatch::Routing::Mapper.send :include, LinkThumbnailer::Rails::Routes::Helper
+      end
+
+      attr_accessor :routes
+
+      def initialize(routes, &options)
+        @routes, @options = routes, options
+      end
+
+      def generate_routes!(options)
+        @mapping = Mapper.new.map(&@options)
+        routes.scope 'link', :as => 'link' do
+          map_route(:previews, :preview_routes)
+        end
+      end
+
+      private
+
+      def map_route(name, method)
+        unless @mapping.skipped?(name)
+          send method, @mapping[name]
+        end
+      end
+
+      def preview_routes(mapping)
+        routes.scope :controller => mapping[:controllers] do
+          routes.match 'preview', :via => :post, :action => :create, :as => mapping[:as], :defaults => { :format => 'json' }
+        end
+      end
+
+    end
+  end
+end

data/lib/link_thumbnailer/version.rb

@@ -1,3 +1,3 @@
 module LinkThumbnailer
-  VERSION = "0.0.6"
+  VERSION = "1.0.0"
 end

data/lib/link_thumbnailer/web_image.rb

@@ -1,22 +1,18 @@
-require 'json'
-
 module LinkThumbnailer
   module WebImage
 
     attr_accessor :source_url, :doc
 
-    def to_a
+    def to_hash
       result = {}
-      %w(source_url mime_type density colums rows filesize number_colors).each {|m|
-        result[m.to_sym] = self.send(m) if self.respond_to?(m)
+      LinkThumbnailer.configuration.rmagick_attributes.each {|m|
+        k = m.to_sym
+        result[k] = self.send(m) if self.respond_to?(m)
+        result[k] = result[k].to_s if result[k].is_a?(URI)
       }
 
       result
     end
 
-    def to_json
-      JSON(self.to_a)
-    end
-
   end
 end

data/lib/link_thumbnailer.rb

@@ -1,3 +1,4 @@
+require 'link_thumbnailer/engine' if defined? Rails
 require 'link_thumbnailer/config'
 require 'link_thumbnailer/object'
 require 'link_thumbnailer/fetcher'
@@ -7,13 +8,15 @@ require 'link_thumbnailer/img_url_filter'
 require 'link_thumbnailer/img_parser'
 require 'link_thumbnailer/img_comparator'
 require 'link_thumbnailer/web_image'
-
 require 'link_thumbnailer/opengraph'
-
 require 'link_thumbnailer/version'
 
 module LinkThumbnailer
 
+  module Rails
+    autoload :Routes, 'link_thumbnailer/rails/routes'
+  end
+
   class << self
 
     attr_accessor :configuration, :object, :fetcher, :doc_parser,
@@ -30,6 +33,7 @@ module LinkThumbnailer
           %r{^http://pixel\.quantserve\.com/},
           %r{^http://s7\.addthis\.com/}
         ],
+        :rmagick_attributes   => %w(source_url mime_type colums rows filesize number_colors),
         :limit                => 10,
         :top                  => 5
       )
@@ -48,6 +52,8 @@ module LinkThumbnailer
       self.object           = LinkThumbnailer::Object.new
       self.fetcher          = LinkThumbnailer::Fetcher.new
       self.doc_parser       = LinkThumbnailer::DocParser.new
+      self.img_url_filters  = [LinkThumbnailer::ImgUrlFilter.new]
+      self.img_parser       = LinkThumbnailer::ImgParser.new(self.fetcher, self.img_url_filters)
 
       doc_string = self.fetcher.fetch(url)
       doc = self.doc_parser.parse(doc_string, url)
@@ -56,11 +62,10 @@ module LinkThumbnailer
 
       # Try Opengraph first
       self.object = LinkThumbnailer::Opengraph.parse(self.object, doc)
+
       return self.object if self.object.valid?
 
       # Else try manually
-      self.img_url_filters  = [LinkThumbnailer::ImgUrlFilter.new]
-      self.img_parser       = LinkThumbnailer::ImgParser.new(self.fetcher, self.img_url_filters)
 
       self.object[:title] = doc.title
       self.object[:description] = doc.description

data/link_thumbnailer.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency(%q{hashie}, ['~> 1.2.0'])
   gem.add_dependency(%q{net-http-persistent}, ['~> 2.7'])
   gem.add_dependency(%q{rmagick}, ['~> 2.13.1'])
-  gem.add_dependency(%q{json}, ['~> 1.7.5'])
+  gem.add_dependency(%q{json}, ['~> 1.7.6'])
 
   gem.add_development_dependency(%q{rspec}, ['~> 2.11.0'])
   gem.add_development_dependency(%q{webmock}, ['~> 1.8.10'])

data/spec/link_thumbnailer_spec.rb

@@ -25,6 +25,7 @@ describe LinkThumbnailer do
           config.strict = false
           config.redirect_limit = 5
           config.blacklist_urls = []
+          config.rmagick_attributes = []
           config.limit = 5
           config.top = 10
         }
@@ -38,6 +39,7 @@ describe LinkThumbnailer do
       specify { LinkThumbnailer.configuration.strict.should be_false }
       specify { LinkThumbnailer.configuration.redirect_limit.should eq(5) }
       specify { LinkThumbnailer.configuration.blacklist_urls.should eq([]) }
+      specify { LinkThumbnailer.configuration.rmagick_attributes.should eq([]) }
       specify { LinkThumbnailer.configuration.limit.should eq(5) }
       specify { LinkThumbnailer.configuration.top.should eq(10) }
 
@@ -60,6 +62,7 @@ describe LinkThumbnailer do
       %r{^http://pixel\.quantserve\.com/},
       %r{^http://s7\.addthis\.com/}
     ]) }
+    specify { LinkThumbnailer.configuration.rmagick_attributes.should eq(%w(source_url mime_type colums rows filesize number_colors)) }
     specify { LinkThumbnailer.configuration.limit.should eq(10) }
     specify { LinkThumbnailer.configuration.top.should eq(5) }
 

data/spec/object_spec.rb

@@ -3,6 +3,8 @@ require 'spec_helper'
 describe LinkThumbnailer::Object do
 
   it { should respond_to :valid? }
+  it { should respond_to :to_hash }
+  it { should respond_to :to_json }
 
   let(:object) { LinkThumbnailer::Object.new }
 
@@ -92,4 +94,37 @@ describe LinkThumbnailer::Object do
 
   end
 
+  context "dealing with WebImage module" do
+
+    class Foo
+    end
+
+    let(:foo) { Foo.new }
+
+    before do
+      foo.extend LinkThumbnailer::WebImage
+      object['images'] = [foo]
+    end
+
+    describe ".to_hash" do
+
+      subject { object.to_hash }
+
+      it { subject.is_a?(Hash).should be_true }
+      it { should include('images') }
+      it { subject['images'].is_a?(Array).should be_true }
+
+    end
+
+    describe ".to_json" do
+
+      subject { object.to_json }
+
+      it { subject.is_a?(String).should be_true }
+      it { should include('images') }
+
+    end
+
+  end
+
 end

data/spec/spec_helper.rb

@@ -1,7 +1,9 @@
 require 'rspec'
 require 'webmock/rspec'
+require 'json'
 
 require 'link_thumbnailer'
 
 RSpec.configure do |config|
+  config.mock_with :rspec
 end

data/spec/web_image_spec.rb

@@ -13,26 +13,25 @@ describe LinkThumbnailer::WebImage do
 
   subject { foo }
 
-  it { should respond_to :to_a }
-  it { should respond_to :to_json }
+  it { should respond_to :to_hash }
   it { should respond_to :source_url }
   it { should respond_to :doc }
 
-  describe ".to_a" do
+  describe ".to_hash" do
 
     context "with default attributes" do
 
       let(:attributes) { [:source_url] }
 
-      subject { foo.to_a }
+      subject { foo.to_hash }
 
-      it { subject.keys.should eq(attributes) }
+      it { subject.keys.should eq(attributes.map(&:to_sym)) }
 
     end
 
     context "with all attributes" do
 
-      let(:attributes) { [:source_url, :mime_type, :density, :colums, :rows, :filesize, :number_colors] }
+      let(:attributes) { LinkThumbnailer.configuration.rmagick_attributes }
 
       before do
         attributes.each {|a| foo.class.send(:define_method, a.to_sym) { 'foo' } }
@@ -42,46 +41,13 @@ describe LinkThumbnailer::WebImage do
         attributes.each {|a| foo.class.send(:undef_method, a.to_sym) }
       end
 
-      subject { foo.to_a }
+      subject { foo.to_hash }
 
-      it { subject.keys.should eq(attributes) }
+      it { subject.keys.should eq(attributes.map(&:to_sym)) }
       it { subject.values.should include('foo') }
 
     end
 
   end
 
-  describe ".to_json" do
-
-    context "with default attributes" do
-
-      let(:attributes) { [:source_url] }
-
-      subject { foo.to_json }
-
-      it { JSON.parse(subject).keys.map(&:to_sym).should eq(attributes) }
-
-    end
-
-    context "with all attributes" do
-
-      let(:attributes) { [:source_url, :mime_type, :density, :colums, :rows, :filesize, :number_colors] }
-
-      before do
-        attributes.each {|a| foo.class.send(:define_method, a.to_sym) { 'foo' } }
-      end
-
-      after do
-        attributes.each {|a| foo.class.send(:undef_method, a.to_sym) }
-      end
-
-      subject { foo.to_json }
-
-      it { JSON.parse(subject).keys.map(&:to_sym).should eq(attributes) }
-      it { JSON.parse(subject).values.should include('foo') }
-
-    end
-
-  end
-
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: link_thumbnailer
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-27 00:00:00.000000000 Z
+date: 2012-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -82,7 +82,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.7.5
+        version: 1.7.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -90,7 +90,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.7.5
+        version: 1.7.6
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -137,18 +137,24 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- app/controllers/link_thumbnailer/application_controller.rb
+- app/controllers/link_thumbnailer/previews_controller.rb
 - lib/generators/link_thumbnailer/install_generator.rb
 - lib/generators/templates/initializer.rb
 - lib/link_thumbnailer.rb
 - lib/link_thumbnailer/config.rb
 - lib/link_thumbnailer/doc.rb
 - lib/link_thumbnailer/doc_parser.rb
+- lib/link_thumbnailer/engine.rb
 - lib/link_thumbnailer/fetcher.rb
 - lib/link_thumbnailer/img_comparator.rb
 - lib/link_thumbnailer/img_parser.rb
 - lib/link_thumbnailer/img_url_filter.rb
 - lib/link_thumbnailer/object.rb
 - lib/link_thumbnailer/opengraph.rb
+- lib/link_thumbnailer/rails/routes.rb
+- lib/link_thumbnailer/rails/routes/mapper.rb
+- lib/link_thumbnailer/rails/routes/mapping.rb
 - lib/link_thumbnailer/version.rb
 - lib/link_thumbnailer/web_image.rb
 - link_thumbnailer.gemspec