link_thumbnailer 1.0.3 → 1.0.4

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.project

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+# 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

data/README.md

@@ -85,7 +85,7 @@ You can check whether this object is valid or not (set mandatory attributes in t
  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`.
@@ -98,15 +98,15 @@ Basically, all you have to do in your view is something like this:
 		<%= 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
@@ -137,6 +137,12 @@ In `config/initializers/link_thumbnailer.rb`
 
 	  # Return top 5 images only.
 	  # config.top = 5
+
+	  # Set user agent
+	  # config.user_agent = 'linkthumbnailer'
+
+	  # Enable or disable SSL verification
+  	# config.verify_ssl = true
 	end
 
 ## Features
@@ -162,3 +168,7 @@ Coming soon:
 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)

data/lib/generators/templates/initializer.rb

@@ -29,4 +29,10 @@ LinkThumbnailer.configure do |config|
 
   # Return top 5 images only.
   # config.top = 5
+  
+  # Set user agent
+  # config.user_agent = 'linkthumbnailer'
+  
+  # Enable or disable SSL verification 
+  # config.verify_ssl = true
 end

data/lib/link_thumbnailer/fetcher.rb

@@ -16,7 +16,8 @@ module LinkThumbnailer
 
       if self.url.is_a?(URI::HTTP)
         http = Net::HTTP::Persistent.new('linkthumbnailer')
-        http.headers['User-Agent'] = 'linkthumbnailer'
+        http.headers['User-Agent'] = LinkThumbnailer.configuration.user_agent
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE unless LinkThumbnailer.configuration.verify_ssl
         resp = http.request(self.url)
         case resp
           when Net::HTTPSuccess; resp.body

data/lib/link_thumbnailer/img_parser.rb

@@ -19,27 +19,26 @@ module LinkThumbnailer
       img_urls.each { |i|
         break if count >= LinkThumbnailer.configuration.limit
         img = parse_one(i)
+        next unless img
         img.extend LinkThumbnailer::ImgComparator
         imgs << img
         count += 1
       }
 
-      imgs.sort!
+      imgs.sort! unless imgs.count <= 1
 
       imgs.first(LinkThumbnailer.configuration.top)
     end
 
     def parse_one(img_url)
-      begin
-        img_data = @fetcher.fetch(img_url)
-        img = Magick::ImageList.new.from_blob(img_data).extend(
-          LinkThumbnailer::WebImage
-        )
-        img.source_url = img_url
-        img
-      rescue Exception
-        nil
-      end
+      img_data = @fetcher.fetch(img_url)
+      img = Magick::ImageList.new.from_blob(img_data).extend(
+        LinkThumbnailer::WebImage
+      )
+      img.source_url = img_url
+      img
+    rescue Exception
+      nil
     end
 
   end

data/lib/link_thumbnailer/version.rb

@@ -1,3 +1,3 @@
 module LinkThumbnailer
-  VERSION = "1.0.3"
+  VERSION = "1.0.4"
 end

data/lib/link_thumbnailer.rb

@@ -35,7 +35,9 @@ module LinkThumbnailer
         ],
         :rmagick_attributes   => %w(source_url mime_type colums rows filesize number_colors),
         :limit                => 10,
-        :top                  => 5
+        :top                  => 5,
+        :user_agent           => 'linkthumbnailer',
+        :verify_ssl           => true
       )
     end
 

data/link_thumbnailer.gemspec

@@ -15,12 +15,12 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = LinkThumbnailer::VERSION
 
-  gem.add_dependency(%q{nokogiri}, ['~> 1.5.5'])
-  gem.add_dependency(%q{hashie}, ['~> 1.2.0'])
+  gem.add_dependency(%q{nokogiri},            ['~> 1.5.5'])
+  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.6'])
+  gem.add_dependency(%q{rmagick},             ['~> 2.13.1'])
+  gem.add_dependency(%q{json},                ['~> 1.7.6'])
 
-  gem.add_development_dependency(%q{rspec}, ['~> 2.11.0'])
+  gem.add_development_dependency(%q{rspec},   ['~> 2.11.0'])
   gem.add_development_dependency(%q{webmock}, ['~> 1.8.10'])
 end

data/spec/examples/empty_example.html

@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+    <meta charset="UTF-8">
+    <title>Foo.com</title>
+  </head>
+
+  <body>
+  </body>
+</html>

data/spec/link_thumbnailer_spec.rb

@@ -2,8 +2,9 @@ require 'spec_helper'
 
 describe LinkThumbnailer do
 
-  let(:og_example)  { File.open(File.dirname(__FILE__) + '/examples/og_example.html').read() }
-  let(:example)     { File.open(File.dirname(__FILE__) + '/examples/example.html').read() }
+  let(:og_example)    { File.open(File.dirname(__FILE__) + '/examples/og_example.html').read() }
+  let(:example)       { File.open(File.dirname(__FILE__) + '/examples/example.html').read() }
+  let(:empty_example) { File.open(File.dirname(__FILE__) + '/examples/empty_example.html').read() }
 
   it { should respond_to :configuration }
   it { should respond_to :configure }
@@ -20,12 +21,14 @@ describe LinkThumbnailer do
     before do
       LinkThumbnailer.configure {|config|
         config.mandatory_attributes = %w(foo bar)
-        config.strict = false
-        config.redirect_limit = 5
-        config.blacklist_urls = []
-        config.rmagick_attributes = []
-        config.limit = 5
-        config.top = 10
+        config.strict               = false
+        config.redirect_limit       = 5
+        config.blacklist_urls       = []
+        config.rmagick_attributes   = []
+        config.limit                = 5
+        config.top                  = 10
+        config.user_agent           = 'linkthumbnailer'
+        config.verify_ssl           = true
       }
     end
 
@@ -34,12 +37,14 @@ describe LinkThumbnailer do
     end
 
     specify { LinkThumbnailer.configuration.mandatory_attributes.should eq(%w(foo bar)) }
-    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) }
+    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) }
+    specify { LinkThumbnailer.configuration.user_agent.should           eq('linkthumbnailer') }
+    specify { LinkThumbnailer.configuration.verify_ssl.should           be_true }
 
   end
 
@@ -50,17 +55,19 @@ describe LinkThumbnailer do
     end
 
     specify { LinkThumbnailer.configuration.mandatory_attributes.should eq(%w(url title images)) }
-    specify { LinkThumbnailer.configuration.strict.should be_true }
-    specify { LinkThumbnailer.configuration.redirect_limit.should eq(3) }
-    specify { LinkThumbnailer.configuration.blacklist_urls.should eq([
+    specify { LinkThumbnailer.configuration.strict.should               be_true }
+    specify { LinkThumbnailer.configuration.redirect_limit.should       eq(3) }
+    specify { LinkThumbnailer.configuration.blacklist_urls.should       eq([
       %r{^http://ad\.doubleclick\.net/},
       %r{^http://b\.scorecardresearch\.com/},
       %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) }
+    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) }
+    specify { LinkThumbnailer.configuration.user_agent.should           eq('linkthumbnailer') }
+    specify { LinkThumbnailer.configuration.verify_ssl.should           be_true }
 
   end
 
@@ -76,33 +83,40 @@ describe LinkThumbnailer do
       context "and options" do
 
         it "should set top option" do
-          expect { LinkThumbnailer.generate('foo', :top => 20).to change(LinkThumbnailer.configuration.top).from(5).to(20) }
+          expect { LinkThumbnailer.generate('foo', top: 20).to change(LinkThumbnailer.configuration.top).from(5).to(20) }
         end
 
         it "should set limit option" do
-          expect { LinkThumbnailer.generate('foo', :limit => 20).to change(LinkThumbnailer.configuration.limit).from(10).to(20) }
+          expect { LinkThumbnailer.generate('foo', limit: 20).to change(LinkThumbnailer.configuration.limit).from(10).to(20) }
         end
 
         it "should set mandatory_attributes option" do
-          expect { LinkThumbnailer.generate('foo', :mandatory_attributes => %w(one two)).to change(LinkThumbnailer.configuration.mandatory_attributes).from(%w(url title images)).to(%w(one two)) }
+          expect { LinkThumbnailer.generate('foo', mandatory_attributes: %w(one two)).to change(LinkThumbnailer.configuration.mandatory_attributes).from(%w(url title images)).to(%w(one two)) }
         end
 
         it "should set strict option" do
-          expect { LinkThumbnailer.generate('foo', :strict => false).to change(LinkThumbnailer.configuration.strict).from(true).to(false) }
+          expect { LinkThumbnailer.generate('foo', strict: false).to change(LinkThumbnailer.configuration.strict).from(true).to(false) }
         end
 
         it "should set redirect_limit option" do
-          expect { LinkThumbnailer.generate('foo', :redirect_limit => 5).to change(LinkThumbnailer.configuration.redirect_limit).from(3).to(5) }
+          expect { LinkThumbnailer.generate('foo', redirect_limit: 5).to change(LinkThumbnailer.configuration.redirect_limit).from(3).to(5) }
         end
 
         it "should set blacklist_urls option" do
-          expect { LinkThumbnailer.generate('foo', :blacklist_urls => [%r{^http://foo\.bar\.com/}]).to change(LinkThumbnailer.configuration.blacklist_urls).to([%r{^http://foo\.bar\.com/}]) }
+          expect { LinkThumbnailer.generate('foo', blacklist_urls: [%r{^http://foo\.bar\.com/}]).to change(LinkThumbnailer.configuration.blacklist_urls).to([%r{^http://foo\.bar\.com/}]) }
         end
 
         it "should set rmagick_attributes option" do
-          expect { LinkThumbnailer.generate('foo', :rmagick_attributes => %w(one two)).to change(LinkThumbnailer.configuration.rmagick_attributes).to(%w(one two)) }
+          expect { LinkThumbnailer.generate('foo', rmagick_attributes: %w(one two)).to change(LinkThumbnailer.configuration.rmagick_attributes).to(%w(one two)) }
         end
 
+        it "should set user_agent option" do
+          expect { LinkThumbnailer.generate('foo', user_agent: 'Mac Safari').to change(LinkThumbnailer.configuration.mandatory_attributes).from('linkthumbnailer').to('Mac Safari') }
+        end
+
+        it "should set verify_ssl option" do
+          expect { LinkThumbnailer.generate('foo', verify_ssl: false).to change(LinkThumbnailer.configuration.verify_ssl).from(true).to(false) }
+        end
       end
 
       context "when strict" do
@@ -111,20 +125,29 @@ describe LinkThumbnailer do
 
           subject { LinkThumbnailer.generate('foo') }
 
-          it { should be_nil }
+          it { expect(LinkThumbnailer.generate('foo')).to be_nil }
 
         end
 
         context "and valid" do
 
           before do
-            stub_request(:get, "http://foo.com/").to_return(:status => 200, :body => og_example, :headers => {})
+            stub_request(:get, 'http://foo.com/').to_return(status: 200, body: og_example, headers: {})
           end
 
-          subject { LinkThumbnailer.generate('http://foo.com') }
+          it { expect(LinkThumbnailer.generate('http://foo.com')).to_not be_nil }
+          it { expect(LinkThumbnailer.generate('http://foo.com')).to be_valid }
+
+        end
+
+        context "and empty" do
+
+          before do
+            stub_request(:get, 'http://foo.com/').to_return(status: 200, body: empty_example, headers: {})
+          end
 
-          it { should_not be_nil }
-          it { should be_valid }
+          it { expect(LinkThumbnailer.generate('http://foo.com/')).to be_nil }
+          it { expect { LinkThumbnailer.generate('http://foo.com/') }.to_not raise_exception }
 
         end
 
@@ -133,28 +156,35 @@ describe LinkThumbnailer do
       context "when not strict" do
 
         before do
-          LinkThumbnailer.configure {|config| config.strict = false}
+          LinkThumbnailer.configure {|config| config.strict = false }
         end
 
         context "and not valid" do
 
-          subject { LinkThumbnailer.generate('foo') }
-
-          it { should_not be_nil }
-          it { should be_valid }
+          it { expect(LinkThumbnailer.generate('foo')).to_not be_nil }
+          it { expect(LinkThumbnailer.generate('foo')).to be_valid }
 
         end
 
         context "and valid" do
 
           before do
-            stub_request(:get, "http://foo.com/").to_return(:status => 200, :body => og_example, :headers => {})
+            stub_request(:get, 'http://foo.com/').to_return(status: 200, body: og_example, headers: {})
           end
 
-          subject { LinkThumbnailer.generate('http://foo.com') }
+          it { expect(LinkThumbnailer.generate('http://foo.com')).to_not be_nil }
+          it { expect(LinkThumbnailer.generate('http://foo.com')).to be_valid }
+
+        end
+
+        context "and empty" do
+
+          before do
+            stub_request(:get, 'http://foo.com/').to_return(status: 200, body: empty_example, headers: {})
+          end
 
-          it { should_not be_nil }
-          it { should be_valid }
+          it { expect(LinkThumbnailer.generate('http://foo.com/')).to_not be_nil }
+          it { expect { LinkThumbnailer.generate('http://foo.com/') }.to_not raise_exception }
 
         end
 

data/spec/web_image_spec.rb

@@ -23,6 +23,10 @@ describe LinkThumbnailer::WebImage do
 
       let(:attributes) { [:source_url] }
 
+      before do
+        LinkThumbnailer.config
+      end
+
       subject { foo.to_hash }
 
       it { subject.keys.should eq(attributes.map(&:to_sym)) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: link_thumbnailer
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-31 00:00:00.000000000 Z
+date: 2013-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -160,6 +160,7 @@ files:
 - link_thumbnailer.gemspec
 - spec/doc_parser_spec.rb
 - spec/doc_spec.rb
+- spec/examples/empty_example.html
 - spec/examples/example.html
 - spec/examples/og_example.html
 - spec/fetcher_spec.rb
@@ -198,6 +199,7 @@ summary: Ruby gem ranking images from a given URL returning an object containing
 test_files:
 - spec/doc_parser_spec.rb
 - spec/doc_spec.rb
+- spec/examples/empty_example.html
 - spec/examples/example.html
 - spec/examples/og_example.html
 - spec/fetcher_spec.rb