favicon_party 0.7.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 04c20f8f3afd2ba553493eaccc622a53e8475d52
+  data.tar.gz: 9236896799c20478321d54209c26c6bdd88bf9b7
+SHA512:
+  metadata.gz: 675b832b0921b0570a077627428da752f3272d35b500798d72e7539727da2c4153b6e474bdd2307776bcd1842b20252e0cfc3a4062574988dfe883b9fe6192e2
+  data.tar.gz: 764055135af45b2d82ae4cc1f30150942e2ec89c46ea6a65051bf51921370a3dd28b2806a53d6c0bab3716ff492fd1838ba54fe07023dc8861ed317ffa6b31c9

data/.gitignore

@@ -0,0 +1,3 @@
+.ruby-version
+*.gem
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Linmiao Xu
+
+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

@@ -0,0 +1,74 @@
+# Favicon Party
+
+Fetch favicons from websites and convert them into other image formats!
+
+
+## Fetching favicon images
+
+Favicon Party parses the html response of the query url to find favicon
+links, and falls back to checking /favicon.ico for valid favicon images.
+
+```ruby
+image = FaviconParty.fetch! "https://github.com"
+
+# => #<FaviconParty::Image mime_type: "image/x-icon", size: 6518>
+
+image.valid?        # true
+image.source_data   # binary favicon image data
+image.to_png        # binary 16x16 png data
+image.base64_png    # base64-encoded 16x16 png data
+
+
+FaviconParty.fetch! "http://example.com"    # raises FaviconNotFound
+FaviconParty.fetch  "http://example.com"    # nil
+```
+
+
+## Loading favicon images
+
+You can load favicon files directly as well.
+
+```ruby
+image = FaviconParty.load "/path/to/favicon.ico"
+
+# => #<FaviconParty::Image mime_type: "image/x-icon", size: 6518>
+```
+
+Same for loading favicon URLs.
+
+```ruby
+image = FaviconParty.load "https://github.com/favicon.ico"
+
+# => #<FaviconParty::Image mime_type: "image/x-icon", size: 6518>
+```
+
+
+## Command-line client
+
+Favicon Party also provides a command-line script for fetching favicons. By
+default, it attempts to fetch a favicon from the given URL and prints it out.
+Run `fetch_favicon --help` to see the list of options.
+
+```bash
+fetch_favicon github.com                  # prints favicon data to STDOUT
+fetch_favicon --format png github.com     # prints 16x16 favicon png to STDOUT
+fetch_favicon example.com                 # prints an error to STDERR
+```
+
+
+## Installation
+
+The best way to install Favicon Party is through [RubyGems](https://rubygems.org/)
+
+```
+$ gem install favicon_party
+```
+
+
+## Requirements
+
+* Ruby 2.0.0+
+* [Nokogiri](https://github.com/sparklemotion/nokogiri) - parsing html
+* [Imagemagick](http://www.imagemagick.org/) - validating and converting favicons
+* [Curl](http://curl.haxx.se/) - http client
+* [File](http://darwinsys.com/file/) - mime-type detection

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "favicon_party"
+
+# require "irb"
+# IRB.start
+
+require "pry"
+Pry.start

data/bin/fetch_favicon

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+
+$:.unshift "./lib"
+
+require 'optparse'
+require 'favicon_party'
+
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: ./fetch_favicon <url>"
+
+  opts.on("--png", "Outputs favicon as a 16x16 png") do
+    options[:format] = :png
+  end
+
+  opts.on("-o", "--output-file FILE", "Saves favicon to FILE") do |output|
+    options[:output] = output
+  end
+
+  opts.on_tail("-h", "--help", "Show this help text") do
+    puts opts
+    exit
+  end
+
+  if ARGV.length == 0
+    puts opts
+    exit
+  end
+
+end.parse!
+
+
+image = FaviconParty.fetch!(ARGV[0])
+case options[:format]
+when :png
+  favicon = image.to_png
+else
+  favicon = image.source_data
+end
+
+
+if options[:output]
+  open(options[:output], "wb").write {|f| f.write favicon }
+else
+  puts favicon
+end

data/favicon_party.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$:.unshift(lib) unless $:.include?(lib)
+
+require 'favicon_party/version'
+
+
+Gem::Specification.new do |s|
+  s.name           = "favicon_party"
+  s.version        = FaviconParty::VERSION
+  s.authors        = ["Linmiao Xu"]
+  s.email          = ["linmiao.xu@gmail.com"]
+
+  s.summary        = "Fetch favicons from websites and have a blast!"
+  s.description    = "Fetch favicons from websites and have a blast!"
+  s.homepage       = "https://github.com/linrock/favicon_party"
+  s.license        = "MIT"
+
+  s.files          = `git ls-files -z`.split("\0")
+  s.bindir         = "bin"
+  s.executables    = ["fetch_favicon"]
+  s.require_paths  = ["lib"]
+
+  s.add_development_dependency "rake",     "~> 10.0"
+  s.add_development_dependency "minitest", "~> 5.0"
+  s.add_development_dependency "pry",      "~> 0.10"
+
+  s.add_dependency "nokogiri", "~> 1.6"
+end

data/lib/favicon_party.rb

@@ -0,0 +1,34 @@
+require 'favicon_party/utils'
+require 'favicon_party/errors'
+require 'favicon_party/http_client'
+require 'favicon_party/image'
+require 'favicon_party/fetcher'
+require 'favicon_party/loader'
+require 'favicon_party/version'
+
+
+module FaviconParty
+
+  class << self
+
+    # @return [FaviconParty::Image]
+    #
+    def fetch!(url, options = {})
+      Fetcher.new(url, options).fetch
+    end
+
+    # @return [FaviconParty::Image]
+    #
+    def fetch(url)
+      fetch!(url) rescue nil
+    end
+
+    # @return [FaviconParty::Image]
+    #
+    def load(url_or_filename)
+      Loader.load url_or_filename
+    end
+
+  end
+
+end

data/lib/favicon_party/errors.rb

@@ -0,0 +1,32 @@
+module FaviconParty
+
+  class CurlError < StandardError; end
+
+  module Curl
+    class DNSError < CurlError; end
+    class SSLError < CurlError; end
+  end
+
+  class FaviconNotFound < StandardError; end
+
+  class Error < StandardError
+    attr_accessor :meta
+
+    def initialize(message)
+      @meta = {}
+      super(message)
+    end
+
+    def to_h
+      {
+        :error_class    => self.class.to_s,
+        :error_message  => self.message
+      }.merge(meta)
+    end
+
+  end
+
+  class InvalidData < StandardError; end
+  class ImageMagickError < Error; end
+
+end

data/lib/favicon_party/fetcher.rb

@@ -0,0 +1,153 @@
+require 'base64'
+require 'nokogiri'
+
+
+module FaviconParty
+
+  # Actually go and grab the favicon from the given url
+  #
+  class Fetcher
+    include FaviconParty::Utils
+
+    ICON_SELECTORS = [ 'link[rel="shortcut icon"]',
+                       'link[rel="icon"]',
+                       'link[type="image/x-icon"]',
+                       'link[rel="fluid-icon"]',
+                       'link[rel="apple-touch-icon"]'
+                     ]
+
+    attr_accessor :query_url, :final_url, :favicon_url, :candidate_urls, :html, :data
+
+    def initialize(url, options = {})
+      @query_url       = prefix_url(url)
+      @final_url       = nil
+      @favicon_url     = nil
+      @html            = nil
+      @data            = nil
+      @candidate_urls  = []
+    end
+
+    # Encodes output as utf8 - Not for binary http responses
+    #
+    def http_get(url)
+      FaviconParty::HTTPClient.get(url)
+    end
+
+    def fetch
+      @html = http_get final_url
+      set_candidate_favicon_urls
+      get_favicon_data
+    end
+
+    def get_favicon_data
+      return @data if !@data.nil?
+      @data = get_favicon_data_from_candidate_urls
+      raise FaviconParty::FaviconNotFound.new(@query_url) unless @data
+      @data
+    end
+
+    def get_favicon_data_from_candidate_urls
+      @candidate_urls.each do |url|
+        data = FaviconParty::Image.new(get_favicon_data_from_url(url))
+        begin
+          if data.valid?
+            @favicon_url = url
+            return data
+          end
+        rescue FaviconParty::ImageMagickError => error
+          error.meta = get_urls
+          error.meta[:favicon_url] ||= url
+          error.meta[:base64_favicon_data] = data.base64_source_data
+          raise error
+        end
+      end
+      nil
+    end
+
+    # Tries to find favicon urls from the html content of query_url
+    #
+    def find_favicon_urls_in_html(html)
+      doc = Nokogiri.parse html
+      candidate_urls = doc.css(ICON_SELECTORS.join(",")).map {|e| e.attr('href') }.compact
+      candidate_urls.sort_by! {|href|
+        if href =~ /\.ico/
+          0
+        elsif href =~ /\.png/
+          1
+        else
+          2
+        end
+      }
+      uri = URI final_url
+      candidate_urls.map! do |href|
+        href = URI.encode(href.strip)
+        if href =~ /\A\/\//
+          href = "#{uri.scheme}:#{href}"
+        elsif href !~ /\Ahttp/
+          # Ignore invalid URLS - ex. {http://i50.tinypic.com/wbuzcn.png}
+          href = URI.join(url_root, href).to_s rescue nil
+        end
+        href
+      end.compact
+    end
+
+    def set_candidate_favicon_urls
+      @candidate_urls = find_favicon_urls_in_html(@html)
+      @candidate_urls << URI.join(url_root, "favicon.ico").to_s
+      @candidate_urls << URI.join(url_root, "favicon.png").to_s
+    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
+        else
+          uri = URI @query_url
+          root = "#{uri.scheme}://#{uri.host}"
+          @final_url = URI.encode URI.join(root, final).to_s
+        end
+      end
+      if !@final_url.nil?
+        if %w( 127.0.0.1 localhost ).any? {|host| @final_url.include? host }
+          # TODO Exception for invalid final urls
+          @final_url = @query_url
+        end
+        return @final_url
+      end
+      @final_url = @query_url
+    end
+
+    def url_root
+      uri = URI final_url
+      "#{uri.scheme}://#{uri.host}"
+    end
+
+    def get_favicon_data_from_url(url)
+      if url =~ /^data:/
+        data = url.split(',')[1]
+        return data && Base64.decode64(data)
+      end
+      FaviconParty::HTTPClient.bin_get url
+    end
+
+    def get_urls
+      {
+        :query_url    => @query_url,
+        :final_url    => final_url,
+        :favicon_url  => @favicon_url
+      }
+    end
+
+    def has_data?
+      !@data.nil? && !@data.empty?
+    end
+
+  end
+
+end

data/lib/favicon_party/http_client.rb

@@ -0,0 +1,50 @@
+require 'open3'
+
+
+module FaviconParty
+
+  module HTTPClient
+    include FaviconParty::Utils
+
+    TIMEOUT = 5
+
+    # For now, wrap command-line curl rather than using net/http or open-uri
+    # because of easier/more reliable SSL handling
+    #
+    def curl_cmd(url)
+      "curl -sL -k --compressed -m #{TIMEOUT} --ciphers 'RC4,3DES,ALL' --fail --show-error '#{url}'"
+    end
+
+    # Encodes output as utf8 - Not for binary http responses
+    #
+    def get(url)
+      stdin, stdout, stderr, t = Open3.popen3(curl_cmd(url))
+      output = encode_utf8(stdout.read).strip
+      error = encode_utf8(stderr.read).strip
+      if !error.nil? && !error.empty?
+        if error.include? "SSL"
+          raise FaviconParty::Curl::SSLError.new(error)
+        elsif error.include? "Couldn't resolve host"
+          raise FaviconParty::Curl::DNSError.new(error)
+        else
+          raise FaviconParty::CurlError.new(error)
+        end
+      end
+      output
+    end
+
+    # Get binary data from url and ignore errors
+    #
+    def bin_get(url)
+      `#{curl_cmd(url)} 2>/dev/null`
+    end
+
+    def head(url)
+      headers = `curl -sIL -1 --ciphers 'RC4,3DES,ALL' -m #{TIMEOUT} "#{url}"`
+      encode_utf8 headers
+    end
+
+    extend self
+  end
+
+end

data/lib/favicon_party/image.rb

@@ -0,0 +1,178 @@
+require 'base64'
+require 'open3'
+
+
+module FaviconParty
+
+  # For handling anything related to the image data of the favicon itself
+  #
+  class Image
+    include FaviconParty::Utils
+
+    # Threshold for stdev of color values under which the image data
+    # is considered one color
+    #
+    STDEV_THRESHOLD = 0.005
+
+    MAX_FILE_SIZE = 1024 * 1024
+
+    VALID_MIME_TYPES = %w(
+      image/x-ico
+      image/x-icon
+      image/png
+      image/gif
+      image/svg+xml
+      image/jpeg
+    )
+
+    attr_accessor :source_data, :png_data, :error
+
+    def initialize(source_data)
+      @source_data = source_data
+      @png_data = nil
+      @error = nil
+    end
+
+    def imagemagick_run(cmd, binmode = false)
+      stdin, stdout, stderr, t = Open3.popen3(cmd)
+      stdout.binmode if binmode
+      output = stdout.read.strip
+      error = stderr.read.strip
+      if output.empty? && !error.nil? && !error.empty?
+        raise FaviconParty::ImageMagickError.new(error)
+      end
+      output
+    end
+
+    def mime_type
+      return @mime_type if defined? @mime_type
+      @mime_type = get_mime_type(@source_data)
+    end
+
+    def identify(verbose = false)
+      with_temp_data_file(@source_data) do |t|
+        imagemagick_run("identify #{"-verbose" if verbose} #{t.path.to_s}")
+      end
+    end
+
+    # Does the data look like a valid favicon?
+    #
+    def valid?
+      @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)"
+        end
+      @error.nil?
+    end
+
+    def blank?
+      @source_data.nil? || @source_data.length <= 1
+    end
+
+    def size_too_big?
+      size >= MAX_FILE_SIZE
+    end
+
+    # TODO set an option to decide how mime-type validity is handled
+    #
+    def invalid_mime_type?
+      mime_type =~ /(text|html|x-empty|octet-stream|ERROR|zip|jar)/
+    end
+
+    def valid_mime_type?
+      VALID_MIME_TYPES.include? mime_type
+    end
+
+    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
+      end
+    end
+
+    def one_pixel?
+      files = identify.split(/\n/)
+      files.length == 1 && files[0].include?(" 1x1 ")
+    end
+
+    def one_color?
+      colors_stdev < STDEV_THRESHOLD
+    end
+
+    def colors_stdev
+      with_temp_data_file(to_png) do |t|
+        cmd = "identify -format '%[fx:image.standard_deviation]' #{t.path.to_s}"
+        imagemagick_run(cmd).to_f
+      end
+    end
+
+    def n_colors
+      with_temp_data_file(@source_data) do |t|
+        cmd = "identify -format '%k' #{t.path.to_s}"
+        imagemagick_run(cmd).to_i
+      end
+    end
+
+    def dimensions
+      with_temp_data_file(@source_data) do |t|
+        cmd = "convert #{t.path.to_s}[0] -format '%wx%h' info:"
+        imagemagick_run(cmd)
+      end
+    end
+
+    # number of bytes in the raw data
+    #
+    def size
+      @source_data && @source_data.size || 0
+    end
+
+    def info_str
+      "#{mime_type}, #{dimensions}, #{size} bytes"
+    end
+
+    # Export source_data as a 16x16 png
+    #
+    def to_png
+      return @png_data if !@png_data.nil?
+      with_temp_data_file(@source_data) do |t|
+        sizes = imagemagick_run("identify #{t.path.to_s}").split(/\n/)
+        images = []
+        %w(16x16 32x32 64x64).each do |dims|
+          %w(32-bit 24-bit 16-bit 8-bit).each do |bd|
+            images += sizes.select {|x| x.include?(dims) and x.include?(bd) }.
+                           map     {|x| x.split(' ')[0] }
+          end
+        end
+        image_to_convert = images.uniq[0] || "#{t.path.to_s}[0]"
+        cmd = "convert -strip -resize 16x16! #{image_to_convert} png:fd:1"
+        @png_data = imagemagick_run(cmd, true)
+        raise FaviconParty::InvalidData.new("Empty png") if @png_data.empty?
+        @png_data
+      end
+    end
+
+    def base64_source_data
+      Base64.encode64(@source_data).split(/\s+/).join
+    end
+
+    def base64_png
+      Base64.encode64(to_png).split(/\s+/).join
+    end
+
+    def inspect
+      %(#<FaviconParty::Image mime_type: "#{mime_type}", size: #{size}>)
+    end
+
+  end
+
+end

data/lib/favicon_party/loader.rb

@@ -0,0 +1,14 @@
+require 'open-uri'
+
+
+module FaviconParty
+
+  module Loader
+
+    def self.load(url_or_filename)
+      Image.new open(url_or_filename, "rb").read
+    end
+
+  end
+
+end

data/lib/favicon_party/utils.rb

@@ -0,0 +1,47 @@
+require 'uri'
+require 'tempfile'
+
+
+module FaviconParty
+  
+  module Utils
+
+    def prefix_url(url)
+      url = URI.encode url.strip.downcase
+      if url =~ /https?:\/\//
+        url
+      else
+        "http://#{url}"
+      end
+    end
+
+    def encode_utf8(text)
+      return text if text.valid_encoding?
+      text.encode("UTF-8", :invalid => :replace, :undef => :replace, :replace => '')
+    end
+
+    def get_mime_type(data, use_file_cmd = true)
+      if use_file_cmd
+        with_temp_data_file(data) {|t| `file -b --mime-type #{t.path.to_s}`.strip }
+      else
+        FileMagic.new(:mime_type).buffer(data)
+      end
+    end
+
+    def with_temp_data_file(data, &block)
+      begin
+        t = Tempfile.new(["favicon", ".ico"])
+        t.binmode
+        t.write data
+        t.close
+        result = block.call(t)
+      ensure
+        t.unlink
+      end
+      result
+    end
+
+    extend self
+  end
+
+end

data/lib/favicon_party/version.rb

@@ -0,0 +1,3 @@
+module FaviconParty
+  VERSION = "0.7.2"
+end

data/test/fetcher_test.rb

@@ -0,0 +1,31 @@
+require 'test_helper'
+
+
+class FetcherTest < Minitest::Test
+
+  def setup
+    test_url = "http://localhost"
+    @fetcher = FaviconParty::Fetcher.new(test_url)
+    @fetcher.final_url = test_url
+  end
+
+  def test_fetcher_raises_error_if_no_favicon_found
+    @fetcher.candidate_urls = []
+    assert_raises(FaviconParty::FaviconNotFound) do
+      @fetcher.get_favicon_data
+    end
+  end
+
+  def test_fetcher_finds_favicon_urls_in_html
+    html = open("#{File.dirname(__FILE__)}/fixtures/html/page1.html").read
+    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_uri = "data:image/png;base64,#{image.base64_png}"
+    assert @fetcher.get_favicon_data_from_url(data_uri) == image.source_data
+  end
+
+end

data/test/fixtures/favicons/white-16x16.svg

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px" width="16px" height="16px" viewBox="0 0 16 16" enable-background="new 0 0 16 16" xml:space="preserve">  <image id="image0" width="16" height="16" x="0" y="0"
+    xlink:href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQAQAAAAA3iMLMAAAABGdBTUEAALGPC/xhBQAAACBjSFJN
+AAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAAAmJLR0QAAd2KE6QAAAAHdElN
+RQffCxwWHC8XrmKqAAAADklEQVQI12P4/5+BFAQA/U4f4XOLpqwAAAAldEVYdGRhdGU6Y3JlYXRl
+ADIwMTUtMTEtMjhUMjI6Mjg6NDctMDg6MDC802/MAAAAJXRFWHRkYXRlOm1vZGlmeQAyMDE1LTEx
+LTI4VDIyOjI4OjQ3LTA4OjAwzY7XcAAAAABJRU5ErkJggg==" />
+</svg>

data/test/fixtures/html/page1.html

@@ -0,0 +1,7 @@
+<html>
+<head>
+  <link rel="shortcut icon" href="/assets/favicon.ico">
+</head>
+<body>
+</body>
+</html>

data/test/image_test.rb

@@ -0,0 +1,59 @@
+require 'test_helper'
+
+
+class ImageTest < Minitest::Test
+
+  def setup
+    @klass = FaviconParty::Image
+  end
+
+  def test_nil_data_is_invalid
+    @image = @klass.new nil
+    assert @image.valid? == false
+  end
+
+  def test_transparent_png_is_invalid
+    filename = "#{File.dirname(__FILE__)}/fixtures/favicons/transparent-16x16.png"
+    @image = @klass.new open(filename, "rb").read
+    assert @image.mime_type == "image/png"
+    assert @image.transparent? == true
+    assert @image.one_color? == true
+    assert @image.valid? == false
+  end
+
+  def test_1x1_gif_is_invalid
+    filename = "#{File.dirname(__FILE__)}/fixtures/favicons/transparent-1x1.gif"
+    @image = @klass.new open(filename, "rb").read
+    assert @image.mime_type == "image/gif"
+    assert @image.one_pixel? == true
+    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
+    assert %w( image/x-ico image/x-icon ).include? @image.mime_type
+    assert @image.one_color? == true
+    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
+    assert @image.one_color?
+    assert @image.valid_mime_type?
+  end
+
+  def test_base64_png_works
+    filename = "#{File.dirname(__FILE__)}/fixtures/favicons/white-16x16.ico"
+    @image = @klass.new open(filename, "rb").read
+    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
+    assert @image.dimensions == "16x16"
+  end
+
+end

data/test/loader_test.rb

@@ -0,0 +1,16 @@
+require 'test_helper'
+
+
+class LoaderTest < Minitest::Test
+
+  def setup
+    @klass = FaviconParty::Loader
+  end
+
+  def test_loader_loads_favicon_images
+    filename = "#{File.dirname(__FILE__)}/fixtures/favicons/transparent-16x16.png"
+    image = @klass.load filename
+    assert image.class == FaviconParty::Image
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'minitest/autorun'
+
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'favicon_party'

data/test/utils_test.rb

@@ -0,0 +1,43 @@
+require 'test_helper'
+
+
+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"
+  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"
+  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)
+  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"
+  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"
+  end
+
+  def test_prefix_url_always_returns_prefixed_urls
+    assert prefix_url("localhost") =~ /\Ahttp:\/\//
+    assert prefix_url("http://localhost") =~ /\Ahttp:\/\//
+  end
+
+  def test_encode_utf8_returns_valid_utf8_string
+    string = "\x12\x61\xA3"
+    assert !string.valid_encoding?
+    assert encode_utf8(string).valid_encoding?
+  end
+
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: favicon_party
+version: !ruby/object:Gem::Version
+  version: 0.7.2
+platform: ruby
+authors:
+- Linmiao Xu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: Fetch favicons from websites and have a blast!
+email:
+- linmiao.xu@gmail.com
+executables:
+- fetch_favicon
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/fetch_favicon
+- favicon_party.gemspec
+- lib/favicon_party.rb
+- lib/favicon_party/errors.rb
+- lib/favicon_party/fetcher.rb
+- lib/favicon_party/http_client.rb
+- lib/favicon_party/image.rb
+- lib/favicon_party/loader.rb
+- lib/favicon_party/utils.rb
+- lib/favicon_party/version.rb
+- test/fetcher_test.rb
+- 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/image_test.rb
+- test/loader_test.rb
+- test/test_helper.rb
+- test/utils_test.rb
+homepage: https://github.com/linrock/favicon_party
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Fetch favicons from websites and have a blast!
+test_files: []