link_thumbnailer 1.1.2 → 2.0.0

data/lib/link_thumbnailer.rb

@@ -1,119 +1,36 @@
-require 'link_thumbnailer/configuration'
-require 'link_thumbnailer/object'
-require 'link_thumbnailer/fetcher'
-require 'link_thumbnailer/doc_parser'
-require 'link_thumbnailer/doc'
-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,
-                  :img_url_filters, :img_parser, :logger
-
-    def logger
-      @logger ||= ::Rails.logger
-    end
-
-    def config
-      self.configuration ||= Configuration.new(
-        mandatory_attributes: %w(url title images),
-        strict:               true,
-        redirect_limit:       3,
-        blacklist_urls:       [
-          %r{^http://ad\.doubleclick\.net/},
-          %r{^http://b\.scorecardresearch\.com/},
-          %r{^http://pixel\.quantserve\.com/},
-          %r{^http://s7\.addthis\.com/}
-        ],
-        image_attributes:     %w(source_url size type),
-        limit:                10,
-        top:                  5,
-        user_agent:           'linkthumbnailer',
-        verify_ssl:           true,
-        http_timeout:         5
-      )
-    end
-
-    def configure
-      yield config
-    end
-
-    def generate(url, options = {})
-      set_options(options)
-      instantiate_classes
-
-      doc = doc_parser.parse(fetcher.fetch(url), url)
-
-      self.object[:url] = fetcher.url.to_s
-      opengraph(doc) || custom(doc)
-    end
-
-    private
-
-    def set_options(options)
-      config
-      options.each {|k, v| config[k] = v }
-    end
-
-    def instantiate_classes
-      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(fetcher, img_url_filters)
-    end
-
-    def opengraph(doc)
-      return unless opengraph?(doc)
-      self.object = LinkThumbnailer::Opengraph.parse(object, doc)
-      return object if object.valid?
-      nil
-    end
-
-    def custom(doc)
-      self.object[:title]       = doc.title
-      self.object[:description] = doc.description
-      self.object[:images]      = img_parser.parse(doc.img_abs_urls.dup)
-      self.object[:url]         = doc.canonical_url || object[:url]
-      return object if object.valid?
-      nil
-    end
-
-    def opengraph?(doc)
-      !doc.xpath('//meta[starts-with(@property, "og:") and @content]').empty?
-    end
-
-  end
-
-end
-
-begin
-  require 'rails'
-rescue LoadError
-end
-
-$stderr.puts <<-EOC if !defined?(Rails)
-warning: no framework detected.
-
-Your Gemfile might not be configured properly.
----- e.g. ----
-Rails:
-    gem 'link_thumbnailer'
-
-EOC
-
-if defined?(Rails)
-  require 'link_thumbnailer/engine'
-  require 'link_thumbnailer/railtie'
-end
+require 'json'
+require 'link_thumbnailer/version'
+require 'link_thumbnailer/configuration'
+require 'link_thumbnailer/exceptions'
+require 'link_thumbnailer/page'
+
+module LinkThumbnailer
+
+  class << self
+
+    attr_reader :page
+
+    def generate(url, options = {})
+      @page = ::LinkThumbnailer::Page.new(url, options)
+
+      page.generate
+    end
+
+  end
+
+end
+
+begin
+  require 'rails'
+rescue LoadError
+end
+
+$stderr.puts <<-EOC if !defined?(Rails)
+warning: no framework detected.
+
+Your Gemfile might not be configured properly.
+---- e.g. ----
+Rails:
+    gem 'link_thumbnailer'
+
+EOC

data/link_thumbnailer.gemspec

@@ -1,28 +1,26 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/link_thumbnailer/version', __FILE__)
-
-Gem::Specification.new do |gem|
-  gem.authors       = ["Pierre-Louis Gottfrois"]
-  gem.email         = ["pierrelouis.gottfrois@gmail.com"]
-  gem.description   = %q{Ruby gem generating thumbnail images from a given URL.}
-  gem.summary       = %q{Ruby gem ranking images from a given URL returning an object containing images and website informations.}
-  gem.homepage      = "https://github.com/gottfrois/link_thumbnailer"
-
-  gem.files         = `git ls-files`.split($\)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.name          = "link_thumbnailer"
-  gem.require_paths = ["lib"]
-  gem.version       = LinkThumbnailer::VERSION
-
-  gem.add_dependency 'rake',                  '>= 0.9'
-  gem.add_dependency 'nokogiri',              '>= 1.5.5', '< 1.7'
-  gem.add_dependency 'hashie',                '>= 1.2.0'
-  gem.add_dependency 'net-http-persistent',   '~> 2.7'
-  gem.add_dependency 'fastimage',             '~> 1.5.5'
-  gem.add_dependency 'json',                  '>= 1.7.6', '< 1.9'
-
-  gem.add_development_dependency 'bundler',  '~> 1.3'
-  gem.add_development_dependency 'rspec',    '~> 2.14'
-  gem.add_development_dependency 'pry',      '~> 0.9'
-end
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'link_thumbnailer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "link_thumbnailer"
+  spec.version       = LinkThumbnailer::VERSION
+  spec.authors       = ["Pierre-Louis Gottfrois"]
+  spec.email         = ["pierrelouis.gottfrois@gmail.com"]
+  spec.description   = %q{Ruby gem generating thumbnail images from a given URL.}
+  spec.summary       = %q{Ruby gem ranking images from a given URL returning an object containing images and website informations.}
+  spec.homepage      = "https://github.com/gottfrois/link_thumbnailer"
+
+  spec.files         = `git ls-files`.split($\)
+  spec.executables   = spec.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport',          '>= 3.0'
+  spec.add_dependency 'json',                   ['>= 1.7.7', '~> 1.7']
+  spec.add_dependency 'rake',                   '>= 0.9'
+  spec.add_dependency 'nokogiri',               '~> 1.6'
+  spec.add_dependency 'net-http-persistent',    '~> 2.9'
+  spec.add_dependency 'fastimage',              '~> 1.5'
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe LinkThumbnailer::Configuration do
+
+  let(:instance) { described_class.new }
+
+  it { expect(instance.redirect_limit).to         eq(3) }
+  it { expect(instance.user_agent).to             eq('link_thumbnailer') }
+  it { expect(instance.verify_ssl).to             eq(true) }
+  it { expect(instance.http_timeout).to           eq(5) }
+  it { expect(instance.blacklist_urls).to_not     be_empty }
+  it { expect(instance.attributes).to_not         be_empty }
+  it { expect(instance.graders).to_not            be_empty }
+  it { expect(instance.description_min_length).to eq(25) }
+  it { expect(instance.positive_regex).to_not     be_nil }
+  it { expect(instance.negative_regex).to_not     be_nil }
+  it { expect(instance.image_limit).to            eq(5) }
+
+  describe '.config' do
+
+    it { expect(LinkThumbnailer.config).to be_a(described_class) }
+
+  end
+
+  describe '.configure' do
+
+    before do
+      LinkThumbnailer.stub(:config).and_return(instance)
+    end
+
+    context 'when block given' do
+
+      it 'yields' do
+        expect(LinkThumbnailer).to receive(:configure).and_yield(instance)
+        LinkThumbnailer.configure {|config|}
+      end
+
+    end
+
+    context 'when no block given' do
+
+      it 'does nothing' do
+        expect(LinkThumbnailer.configure).to be_nil
+      end
+
+    end
+
+  end
+
+end
+

data/spec/examples/empty_og_image_example.html

@@ -0,0 +1,9 @@
+<html  xmlns:og="http://opengraphprotocol.org/schema/">
+  <head>
+    <meta charset="utf-8"/>
+    <meta property="og:title" content="Foo Title">
+    <meta property="og:image" content="">
+    <title>Foo</title>
+  </head>
+
+</html>

data/spec/fixture_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+
+describe 'Fixture' do
+
+  let(:url)         { 'http://foo.com' }
+  let(:png_url)     { 'http://foo.com/foo.png' }
+  let(:png)         { File.open(File.dirname(__FILE__) + '/fixtures/foo.png') }
+  let(:action)      { LinkThumbnailer.generate(url) }
+
+  before do
+    stub_request(:get, url).to_return(status: 200, body: html, headers: {})
+    stub_request(:get, png_url).to_return(status: 200, body: png, headers: {})
+  end
+
+  describe 'Opengraph' do
+
+    let(:title)       { 'Title from og' }
+    let(:description) { 'Description from og' }
+
+    context 'when valid' do
+
+      let(:html) { File.open(File.dirname(__FILE__) + '/fixtures/og_valid_example.html').read() }
+
+      it { expect(action.title).to                  eq(title) }
+      it { expect(action.description).to            eq(description) }
+      it { expect(action.images.count).to           eq(1) }
+      it { expect(action.images.first.src.to_s).to  eq(png_url) }
+
+    end
+
+    context 'with multi image' do
+
+      let(:png_url_2) { 'http://foo.com/bar.png' }
+      let(:png_2)     { File.open(File.dirname(__FILE__) + '/fixtures/bar.png') }
+      let(:html)      { File.open(File.dirname(__FILE__) + '/fixtures/og_valid_multi_image_example.html').read() }
+
+      before do
+        stub_request(:get, png_url_2).to_return(status: 200, body: png_2, headers: {})
+      end
+
+      it { expect(action.title).to                  eq(title) }
+      it { expect(action.description).to            eq(description) }
+      it { expect(action.images.count).to           eq(2) }
+      it { expect(action.images.first.src.to_s).to  eq(png_url) }
+      it { expect(action.images.last.src.to_s).to   eq(png_url_2) }
+
+    end
+
+    context 'when not valid' do
+
+      let(:html) { File.open(File.dirname(__FILE__) + '/fixtures/og_not_valid_example.html').read() }
+
+      it { expect(action.title).to                  eq(title) }
+      it { expect(action.description).to            eq(description) }
+      it { expect(action.images.count).to           eq(1) }
+      it { expect(action.images.first.src.to_s).to  eq(png_url) }
+
+    end
+
+  end
+
+  describe 'Default' do
+
+    context 'from meta' do
+
+      let(:html)        { File.open(File.dirname(__FILE__) + '/fixtures/default_from_meta.html').read() }
+      let(:title)       { 'Title from meta' }
+      let(:description) { 'Description from meta' }
+
+      it { expect(action.title).to        eq(title) }
+      it { expect(action.description).to  eq(description) }
+
+    end
+
+    context 'from body' do
+
+      let(:html)        { File.open(File.dirname(__FILE__) + '/fixtures/default_from_body.html').read() }
+      let(:description) { 'Description from body' }
+
+      it { expect(action.description).to            eq(description) }
+      it { expect(action.images.count).to           eq(1) }
+      it { expect(action.images.first.src.to_s).to  eq(png_url) }
+
+    end
+
+  end
+
+end