favicon_party 0.7.4 → 0.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 75cb9e474827784b1fb9bcf59cc5b08becf2d64b
-  data.tar.gz: 3e7883dea6560948a10d69b6fa2069b2f5e7007e
+  metadata.gz: 5c61876eea35371d7d84d0346af3f1a1c4093914
+  data.tar.gz: 4b67af13faf4e76cfc051540dcf03c2e72f3d3d6
 SHA512:
-  metadata.gz: 00b5fd4647487f79074250ac6ea85af03bab3d7f49b27a514b56ea0ce6f7bc39e4219e83137a88bd8225f776222e6f83939dd9370b228009e7a3b8f2e4271d4a
-  data.tar.gz: 9449e9834e744decb0f3745842953822d3ab34d4157bfeba560c230c4b075196063bf6f881080a1517aec7cd6fbef2d2fde3d0fbbbfbc0434aff40c636993561
+  metadata.gz: 295085e97b4d77f279f5e7cd12c0f23b52bc7dbe03219256fb4a8002bfe555b501a25ff472f110624708d429462a3443dc346ea80935360c34622bfe255b2548
+  data.tar.gz: c92b657ea171abcbab0bbb3b886d34b157bf193bfa6ac16a749194c0ebf0623823280556c156cbb9520d72f4620b98d3175bfcfd4f5380e0f559907255b3d84c

data/lib/favicon_party.rb

@@ -19,8 +19,8 @@ module FaviconParty
 
     # @return [FaviconParty::Image]
     #
-    def fetch(url)
-      fetch!(url) rescue nil
+    def fetch(url, options = {})
+      fetch!(url, options) rescue nil
     end
 
     # @return [FaviconParty::Image]

data/lib/favicon_party/fetcher.rb

@@ -19,6 +19,7 @@ module FaviconParty
     attr_accessor :query_url, :final_url, :favicon_url, :candidate_urls, :html, :data
 
     def initialize(url, options = {})
+      @options         = options
       @query_url       = prefix_url(url)
       @final_url       = nil
       @favicon_url     = nil
@@ -50,7 +51,7 @@ module FaviconParty
       @candidate_urls.each do |url|
         data = FaviconParty::Image.new(get_favicon_data_from_url(url))
         begin
-          if data.valid?
+          if data.valid?(@options)
             @favicon_url = url
             return data
           end
@@ -88,7 +89,7 @@ module FaviconParty
           href = URI.join(url_root, href).to_s rescue nil
         end
         href
-      end.compact
+      end.compact.uniq
     end
 
     def set_candidate_favicon_urls
@@ -97,20 +98,23 @@ module FaviconParty
       @candidate_urls << URI.join(url_root, "favicon.png").to_s
     end
 
+    def final_location(response_headers)
+      location = response_headers.scan(/^Location: (.*)$/)[-1]
+      location && location[0].strip
+    end
+
     # Follow redirects from the query url to get to the last url
     #
     def final_url
       return @final_url if !@final_url.nil?
-      output = FaviconParty::HTTPClient.head(@query_url)
-      final_location = output.scan(/\ALocation: (.*)/)[-1]
-      final = final_location && final_location[0].strip
-      if !final.nil?
-        if final =~ /\Ahttp/
-          @final_url = URI.encode final
+      location = final_location(FaviconParty::HTTPClient.head(@query_url))
+      if !location.nil?
+        if location =~ /\Ahttp/
+          @final_url = URI.encode location
         else
           uri = URI @query_url
           root = "#{uri.scheme}://#{uri.host}"
-          @final_url = URI.encode URI.join(root, final).to_s
+          @final_url = URI.encode URI.join(root, location).to_s
         end
       end
       if !@final_url.nil?

data/lib/favicon_party/http_client.rb

@@ -41,7 +41,7 @@ module FaviconParty
     end
 
     def build_curl_cmd(url, flags = "")
-      "curl #{curl_shared_flags} #{flags} '#{prefix_url(url)}'"
+      "curl #{curl_shared_flags} #{flags} '#{prefix_url(url, :downcase => false)}'"
     end
 
     def curl_get_cmd(url)

data/lib/favicon_party/image.rb

@@ -57,20 +57,22 @@ module FaviconParty
 
     # Does the data look like a valid favicon?
     #
-    def valid?
+    def valid?(options = {})
       @error =
         if blank?
           "source_data is blank"
-        elsif size_too_big?
-          "source_data file size too big"
         elsif !valid_mime_type?
           "source_data mime-type is invalid - #{mime_type}"
-        elsif transparent?
-          "source_data is a transparent image"
         elsif one_pixel?
           "source_data is a 1x1 image"
-        elsif one_color?
-          "png_data is one color (or close to it)"
+        elsif size_too_big?
+          "source_data file size too big"
+        elsif !options[:no_color_check]
+          if transparent?
+            "source_data is a transparent image"
+          elsif one_color?
+            "png_data is one color (or close to it)"
+          end
         end
       @error.nil?
     end
@@ -95,8 +97,8 @@ module FaviconParty
 
     def transparent?
       with_temp_data_file(@source_data) do |t|
-        cmd = "convert #{t.path.to_s} -channel a -negate -format '%[mean]' info:"
-        imagemagick_run(cmd).to_i == 0
+        cmd = "convert #{t.path.to_s} -format '%[opaque]' info:"
+        imagemagick_run(cmd) != "true"
       end
     end
 

data/lib/favicon_party/utils.rb

@@ -6,8 +6,12 @@ module FaviconParty
   
   module Utils
 
-    def prefix_url(url)
-      url = URI.encode url.strip.downcase
+    def prefix_url(url, options = {})
+      unless options[:downcase] == false
+        url = URI.encode url.strip.downcase
+      else
+        url = URI.encode url.strip
+      end
       if url =~ /https?:\/\//
         url
       else

data/lib/favicon_party/version.rb

@@ -1,3 +1,3 @@
 module FaviconParty
-  VERSION = "0.7.4"
+  VERSION = "0.7.5"
 end

data/test/fetcher_test.rb

@@ -17,15 +17,21 @@ class FetcherTest < Minitest::Test
   end
 
   def test_fetcher_finds_favicon_urls_in_html
-    html = open("#{File.dirname(__FILE__)}/fixtures/html/page1.html").read
+    html = read_fixture("html/page1.html")
     assert @fetcher.find_favicon_urls_in_html(html).length == 1
   end
 
   def test_fetcher_decodes_base64_data_uri_links
-    filename = "#{File.dirname(__FILE__)}/fixtures/favicons/transparent-16x16.png"
-    image = FaviconParty::Image.new(open(filename, "rb").read)
+    data = read_fixture("favicons/transparent-16x16.png", "rb")
+    image = FaviconParty::Image.new(data)
     data_uri = "data:image/png;base64,#{image.base64_png}"
     assert @fetcher.get_favicon_data_from_url(data_uri) == image.source_data
   end
 
+  def test_fetcher_finds_location_headers_in_http_response
+    @fetcher = FaviconParty::Fetcher.new("wevorce.com")
+    location = @fetcher.final_location(read_fixture("http_headers/wevorce.com.txt"))
+    assert location == "https://www.wevorce.com"
+  end
+
 end

data/test/fixtures/http_headers/wevorce.com.txt

@@ -0,0 +1,35 @@
+HTTP/1.1 303 See Other
+Content-Type: text/html; charset=utf-8
+Connection: keep-alive
+Status: 303 See Other
+X-Frame-Options: SAMEORIGIN
+X-XSS-Protection: 1; mode=block
+X-Content-Type-Options: nosniff
+Location: https://www.wevorce.com
+Cache-Control: no-cache
+Set-Cookie: request_method=HEAD; path=/
+X-Request-Id: ed843a1e-dbc3-4e2f-ae25-596e41391d4f
+X-Runtime: 0.006208
+X-Powered-By: Phusion Passenger 4.0.53
+Date: Mon, 14 Dec 2015 01:21:42 GMT
+Server: nginx/1.6.2 + Phusion Passenger 4.0.53
+P3P: CP="IDC DSP COR ADM DEVi TAIi PSA PSD IVAi IVDi CONi HIS OUR IND CNT"
+
+HTTP/1.1 200 OK
+Server: Cowboy
+Connection: keep-alive
+Date: Mon, 14 Dec 2015 01:21:42 GMT
+Status: 200 OK
+Strict-Transport-Security: max-age=31536000
+Content-Type: text/html; charset=utf-8
+Content-Length: 43979
+X-Ua-Compatible: IE=Edge,chrome=1
+Etag: "a3ef0ea6d0a8dad4f9e59bbf765000c5"
+Cache-Control: max-age=0, private, must-revalidate
+Set-Cookie: remember_token=; path=/; expires=Mon, 14-Dec-2015 02:21:42 GMT; secure
+Set-Cookie: _wevorce_session=BAh7CEkiD3Nlc3Npb25faWQGOgZFVEkiJWRmZmVjNzFjOWM2ZTM0M2Y4MWI5YTdmNzdjN2FmNjRiBjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMWpuV3RsUVdNYXozNVVab21XUFBDb2VqQU1mb0hzZWx2bXhzY1BwTDZ1VDA9BjsARkkiFmFuYWx5dGljc19zdGFydGVkBjsARlQ%3D--426d95420320c7ef844c19e07f53ae02df49c050; path=/; secure; HttpOnly
+X-Request-Id: a71f958c-7112-4c1b-981c-48c821a2ba4e
+X-Runtime: 0.068463
+X-Rack-Cache: miss
+Via: 1.1 vegur
+

data/test/image_test.rb

@@ -13,46 +13,52 @@ class ImageTest < Minitest::Test
   end
 
   def test_transparent_png_is_invalid
-    filename = "#{File.dirname(__FILE__)}/fixtures/favicons/transparent-16x16.png"
-    @image = @klass.new open(filename, "rb").read
+    @image = @klass.new read_fixture("favicons/transparent-16x16.png", "rb")
     assert @image.mime_type == "image/png"
-    assert @image.transparent? == true
-    assert @image.one_color? == true
+    assert @image.transparent?
+    assert @image.one_color?
     assert @image.valid? == false
   end
 
+  def test_does_not_detect_jpeg_as_transparent
+    @image = @klass.new read_fixture("favicons/specimens/a_jpeg.jpg", "rb")
+    assert @image.mime_type == "image/jpeg"
+    assert @image.transparent? == false
+    assert @image.valid? == true
+  end
+
   def test_1x1_gif_is_invalid
-    filename = "#{File.dirname(__FILE__)}/fixtures/favicons/transparent-1x1.gif"
-    @image = @klass.new open(filename, "rb").read
+    @image = @klass.new read_fixture("favicons/transparent-1x1.gif", "rb")
     assert @image.mime_type == "image/gif"
-    assert @image.one_pixel? == true
+    assert @image.transparent?
+    assert @image.one_color?
+    assert @image.one_pixel?
     assert @image.valid? == false
   end
 
   def test_all_white_ico_is_invalid
-    filename = "#{File.dirname(__FILE__)}/fixtures/favicons/white-16x16.ico"
-    @image = @klass.new open(filename, "rb").read
+    @image = @klass.new read_fixture("favicons/white-16x16.ico")
     assert %w( image/x-ico image/x-icon ).include? @image.mime_type
-    assert @image.one_color? == true
+    assert @image.one_color?
+    assert @image.transparent? == false
     assert @image.valid? == false
   end
 
   def test_svg_mime_type_is_valid
-    filename = "#{File.dirname(__FILE__)}/fixtures/favicons/white-16x16.svg"
-    @image = @klass.new open(filename, "rb").read
+    @image = @klass.new read_fixture("favicons/white-16x16.svg")
     assert @image.one_color?
+    assert @image.transparent? == false
     assert @image.valid_mime_type?
+    assert @image.valid?(:no_color_check => true)
   end
 
   def test_base64_png_works
-    filename = "#{File.dirname(__FILE__)}/fixtures/favicons/white-16x16.ico"
-    @image = @klass.new open(filename, "rb").read
+    @image = @klass.new read_fixture("favicons/white-16x16.ico")
     assert !@image.base64_png.nil?
   end
 
   def test_dimensions_returns_correct_dimensions
-    filename = "#{File.dirname(__FILE__)}/fixtures/favicons/white-16x16.ico"
-    @image = @klass.new open(filename, "rb").read
+    @image = @klass.new read_fixture("favicons/white-16x16.ico")
     assert @image.dimensions == "16x16"
   end
 

data/test/test_helper.rb

@@ -2,3 +2,9 @@ require 'minitest/autorun'
 
 $:.unshift File.expand_path('../../lib', __FILE__)
 require 'favicon_party'
+
+
+def read_fixture(path, flags = "r")
+  filename = "#{File.dirname(__FILE__)}/fixtures/#{path}"
+  open(filename, flags).read
+end

data/test/utils_test.rb

@@ -5,28 +5,27 @@ class UtilsTest < Minitest::Test
   include FaviconParty::Utils
 
   def test_get_mime_type_detects_png_correctly
-    filename = "#{File.dirname(__FILE__)}/fixtures/favicons/transparent-16x16.png"
-    assert get_mime_type(open(filename, "rb").read) == "image/png"
+    data = read_fixture("favicons/transparent-16x16.png", "rb")
+    assert get_mime_type(data) == "image/png"
   end
 
   def test_get_mime_type_detects_gif_correctly
-    filename = "#{File.dirname(__FILE__)}/fixtures/favicons/transparent-1x1.gif"
-    assert get_mime_type(open(filename, "rb").read) == "image/gif"
+    data = read_fixture("favicons/transparent-1x1.gif", "rb")
+    assert get_mime_type(data) == "image/gif"
   end
 
   def test_get_mime_type_detects_ico_correctly
-    filename = "#{File.dirname(__FILE__)}/fixtures/favicons/white-16x16.ico"
-    assert %w( image/x-ico image/x-icon ).include? get_mime_type(open(filename, "rb").read)
+    data = read_fixture("favicons/white-16x16.ico", "rb")
+    assert %w( image/x-ico image/x-icon ).include? get_mime_type(data)
   end
 
   def test_get_mime_type_detects_svg_correctly
-    filename = "#{File.dirname(__FILE__)}/fixtures/favicons/white-16x16.svg"
-    assert get_mime_type(open(filename, "rb").read) == "image/svg+xml"
+    data = read_fixture("favicons/white-16x16.svg", "rb")
+    assert get_mime_type(data) == "image/svg+xml"
   end
 
   def test_get_mime_type_detects_html_correctly
-    filename = "#{File.dirname(__FILE__)}/fixtures/html/page1.html"
-    assert get_mime_type(open(filename, "rb").read) == "text/html"
+    assert get_mime_type(read_fixture("html/page1.html")) == "text/html"
   end
 
   def test_prefix_url_always_returns_prefixed_urls
@@ -34,6 +33,11 @@ class UtilsTest < Minitest::Test
     assert prefix_url("http://localhost") =~ /\Ahttp:\/\//
   end
 
+  def test_prefix_url_does_not_downcase_when_a_flag_is_set
+    assert prefix_url("localhost/tEsT", :downcase => false) =~ /\/tEsT/
+    assert prefix_url("localhost/tEsT") =~ /\/test/
+  end
+
   def test_encode_utf8_returns_valid_utf8_string
     string = "\x12\x61\xA3"
     assert !string.valid_encoding?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: favicon_party
 version: !ruby/object:Gem::Version
-  version: 0.7.4
+  version: 0.7.5
 platform: ruby
 authors:
 - Linmiao Xu
@@ -91,12 +91,15 @@ files:
 - lib/favicon_party/utils.rb
 - lib/favicon_party/version.rb
 - test/fetcher_test.rb
+- test/fixtures/favicons/specimens/a_jpeg.jpg
+- test/fixtures/favicons/specimens/not_actually_transparent.png
 - test/fixtures/favicons/transparent-16x16.png
 - test/fixtures/favicons/transparent-1x1.gif
 - test/fixtures/favicons/transparent-1x1.png
 - test/fixtures/favicons/white-16x16.ico
 - test/fixtures/favicons/white-16x16.svg
 - test/fixtures/html/page1.html
+- test/fixtures/http_headers/wevorce.com.txt
 - test/http_client_test.rb
 - test/image_test.rb
 - test/loader_test.rb