flavicon 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2fa853720ba3467ae1e98ffc4867714d2396e37e
+  data.tar.gz: f35b0bbc8a07845cf6c66e00a49576fafec4926e
+SHA512:
+  metadata.gz: ee1f8fda545e3927f39c8551975f63fca9ab7bd7a6c7c9dcb91ed88efa17100315d8eeb3b13a2172be33433417d2d48d2a2a0e28fe2b318a08265c9a15c37366
+  data.tar.gz: 6f115a44c07cc3069bb88dbb1a40908a14c2bc2370e9e435f399485d1df9d8fcd98cffca2827b14b7a8c2b56b5b3fdbf2fac7c8c6932f4d06ad3bf7f8f8cc3a2

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+flavicon

data/.ruby-version

@@ -0,0 +1 @@
+2.1.1

data/Gemfile

@@ -0,0 +1,15 @@
+source 'http://rubygems.org'
+
+gem 'nokogiri', '~> 1.6'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem 'rspec', '~> 2.14'
+  gem 'webmock', '~> 1.17'
+  gem 'rdoc', '~> 3.12'
+  gem 'bundler', '~> 1.0'
+  gem 'jeweler', '~> 2.0'
+  gem 'simplecov', '~> 0'
+  gem 'pry', '~> 0'
+end

data/Gemfile.lock

@@ -0,0 +1,90 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.6)
+    builder (3.2.2)
+    coderay (1.1.0)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.2.5)
+    docile (1.1.3)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    git (1.2.6)
+    github_api (0.11.3)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.1)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 1.2)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.0)
+      oauth2
+    hashie (2.1.1)
+    highline (1.6.21)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.1)
+    jwt (0.1.11)
+      multi_json (>= 1.5)
+    method_source (0.8.2)
+    mini_portile (0.5.3)
+    multi_json (1.9.2)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.1)
+      mini_portile (~> 0.5.0)
+    oauth2 (0.9.3)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 0.1.8)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    pry (0.9.12.6)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rack (1.5.2)
+    rake (10.3.1)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+    safe_yaml (1.0.2)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    slop (3.5.0)
+    thread_safe (0.3.3)
+    webmock (1.17.4)
+      addressable (>= 2.2.7)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  jeweler (~> 2.0)
+  nokogiri (~> 1.6)
+  pry (~> 0)
+  rdoc (~> 3.12)
+  rspec (~> 2.14)
+  simplecov (~> 0)
+  webmock (~> 1.17)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Hamed Asghari
+
+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,21 @@
+# flavicon
+
+Disclaimer: This is a rewrite of the [www-favicon](https://github.com/youpy/www-favicon) gem for a couple reasons:
+
+1. Update the project structure to conform to rubygems.org conventions
+2. Handle relative URLs as the value for a Location header field on redirect responses.
+
+## Contributing to flavicon
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2014 Hamed Asghari. See LICENSE.txt for further details.
+

data/Rakefile

@@ -0,0 +1,50 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts 'Run `bundle install` to install missing gems'
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = 'flavicon'
+  gem.homepage = 'http://github.com/hasghari/flavicon'
+  gem.license = 'MIT'
+  gem.summary = 'fetch favicon url for provided url'
+  gem.description = 'fetch favicon url by parsing html and falling back on /favicon.ico as default'
+  gem.email = 'hasghari@gmail.com'
+  gem.authors = ['Hamed Asghari']
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+desc 'Code coverage detail'
+task :simplecov do
+  ENV['COVERAGE'] = 'true'
+  Rake::Task['spec'].execute
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ''
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "flavicon #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/flavicon.rb

@@ -0,0 +1,7 @@
+module Flavicon
+  autoload :Finder, 'flavicon/finder'
+
+  def self.find(url)
+    Finder.new(url).find
+  end
+end

data/lib/flavicon/finder.rb

@@ -0,0 +1,60 @@
+module Flavicon
+  class Finder < Struct.new(:url)
+    require 'uri'
+    require 'net/http'
+    require 'nokogiri'
+
+    TooManyRedirects = Class.new(StandardError)
+
+    def find
+      response, resolved = request(url)
+      favicon_url = extract_from_html(response.body, resolved) || default_path(resolved)
+      valid_favicon_url?(favicon_url) ? favicon_url : nil
+    end
+
+    def valid_favicon_url?(url)
+      response, _ = request(url)
+      response.is_a?(Net::HTTPSuccess) && response.body.to_s != '' && response.content_type =~ /image/i
+    end
+
+    def extract_from_html(html, url)
+      link = Nokogiri::HTML(html).css('head link').find do |link|
+        link[:rel] =~ /\A(shortcut )?icon\z/i
+      end
+
+      URI.join(url, link[:href]).to_s if link
+    end
+
+    def default_path(url)
+      URI.join(url, '/favicon.ico').to_s
+    end
+
+    def request(url, limit = 10)
+      raise TooManyRedirects if limit < 0
+
+      uri = URI.parse(url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      request = Net::HTTP::Get.new(uri.request_uri)
+
+      if uri.scheme == 'https'
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+
+      response = http.request(request)
+
+      if response.is_a? Net::HTTPRedirection
+        request(extract_location(response, url), limit - 1)
+      else
+        return response, url
+      end
+    end
+
+    # While the soon-to-be obsolete IETF standard RFC 2616 (HTTP 1.1) requires a complete absolute URI for redirection,
+    # the most popular web browsers tolerate the passing of a relative URL as the value for a Location header field.
+    # Consequently, the current revision of HTTP/1.1 makes relative URLs conforming.
+    def extract_location(response, url)
+      URI.join(url, response['location']).to_s
+    end
+  end
+end

data/spec/fixtures/absolute.html

@@ -0,0 +1,8 @@
+<!DOCTYPE html>
+<html>
+<head>
+    <link rel="shortcut icon" href="http://sub.example.com/absolute.ico" type="image/x-icon" />
+</head>
+<body>
+</body>
+</html>

data/spec/fixtures/missing.html

@@ -0,0 +1,8 @@
+<!DOCTYPE html>
+<html>
+<head>
+    <link rel="publisher" href="http://www.google.com" />
+</head>
+<body>
+</body>
+</html>

data/spec/fixtures/multiple.html

@@ -0,0 +1,9 @@
+<!DOCTYPE html>
+<html>
+<head>
+    <link rel="icon" href="/first.ico" type="image/x-icon" />
+    <link rel="shortcut icon" href="/second.ico" type="image/x-icon" />
+</head>
+<body>
+</body>
+</html>

data/spec/fixtures/relative.html

@@ -0,0 +1,8 @@
+<!DOCTYPE html>
+<html>
+<head>
+    <link rel="shortcut icon" href="/relative.ico" type="image/x-icon" />
+</head>
+<body>
+</body>
+</html>

data/spec/flavicon/finder_spec.rb

@@ -0,0 +1,133 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'flavicon/finder'
+
+describe Flavicon::Finder do
+  subject { Flavicon::Finder.new('http://www.ex.com') }
+
+  describe '#find' do
+    it '' do
+
+    end
+  end
+
+  describe '#valid_favicon_url?' do
+    let(:favicon_url) { 'http://www.ex.com/favicon.ico' }
+    let(:response) do
+      { status: 200, body: 'blah', headers: { 'Content-Type' => 'image/x-icon'} }
+    end
+
+    before do
+      stub_request(:get, favicon_url).to_return(response)
+    end
+
+    it 'should be true by default' do
+      subject.valid_favicon_url?(favicon_url).should be_true
+    end
+
+    context 'http failure' do
+      let(:response) do
+        { status: 400, body: 'blah', headers: { 'Content-Type' => 'image/x-icon'} }
+      end
+
+      it 'should be false' do
+        subject.valid_favicon_url?(favicon_url).should be_false
+      end
+    end
+
+    context 'empty body' do
+      let(:response) do
+        { status: 200, body: '', headers: { 'Content-Type' => 'image/x-icon'} }
+      end
+
+      it 'should be false' do
+        subject.valid_favicon_url?(favicon_url).should be_false
+      end
+    end
+
+    context 'invalid content-type' do
+      let(:response) do
+        { status: 200, body: 'blah', headers: { 'Content-Type' => 'text/javascript'} }
+      end
+
+      it 'should be false' do
+        subject.valid_favicon_url?(favicon_url).should be_false
+      end
+    end
+  end
+
+  describe '#extract_from_html' do
+    def html(file)
+      File.read(File.expand_path(File.dirname(__FILE__) + "/../fixtures/#{file}"))
+    end
+
+    it 'should return nil for empty body' do
+      subject.extract_from_html('', 'http://www.ex.com').should be_nil
+    end
+
+    it 'should return nil if no favicon found' do
+      subject.extract_from_html(html('missing.html'), 'http://www.ex.com').should be_nil
+    end
+
+    it 'should handle absolute url' do
+      subject.extract_from_html(html('absolute.html'), 'http://www.ex.com')
+        .should == 'http://sub.example.com/absolute.ico'
+    end
+
+    it 'should handle relative url' do
+      subject.extract_from_html(html('relative.html'), 'http://www.ex.com')
+        .should == 'http://www.ex.com/relative.ico'
+    end
+
+    it 'should return first if multiple matches' do
+      subject.extract_from_html(html('multiple.html'), 'http://www.ex.com')
+        .should == 'http://www.ex.com/first.ico'
+    end
+  end
+
+  describe '#request' do
+    before do
+      stub_request(:get, 'http://www.ex.com/abc/')
+        .to_return(status: 200, body: '', headers: {})
+    end
+
+    it 'should raise error when redirect limit reached' do
+      expect {
+        subject.request('http://www.ex.com', -1)
+      }.to raise_error(Flavicon::Finder::TooManyRedirects)
+    end
+
+    it 'should return response and url when successful' do
+      response, url = subject.request('http://www.ex.com/abc/')
+      response.should be_a Net::HTTPSuccess
+      url.should == 'http://www.ex.com/abc/'
+    end
+
+    context 'redirect' do
+      before do
+        stub_request(:get, 'http://www.ex.com/abc')
+          .to_return(status: 301, body: '', headers: { 'Location' => 'http://www.ex.com/abc/' })
+      end
+
+      it 'should follow redirect responses' do
+        response, resolved = subject.request('http://www.ex.com/abc')
+        response.should be_a Net::HTTPSuccess
+        resolved.should == 'http://www.ex.com/abc/'
+      end
+
+      it 'should recurse' do
+        subject.should_receive(:request).with('http://www.ex.com/abc', 2).and_call_original
+        subject.should_receive(:request).with('http://www.ex.com/abc/', 1)
+        subject.request('http://www.ex.com/abc', 2)
+      end
+
+      it 'should handle relative redirect urls' do
+        stub_request(:get, 'http://www.ex.com/def')
+          .to_return(status: 301, body: '', headers: { 'Location' => '/ghi/' })
+
+        subject.should_receive(:request).with('http://www.ex.com/def').and_call_original
+        subject.should_receive(:request).with('http://www.ex.com/ghi/', 9)
+        subject.request('http://www.ex.com/def')
+      end
+    end
+  end
+end

data/spec/flavicon_spec.rb

@@ -0,0 +1,18 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'flavicon'
+
+describe Flavicon do
+  describe '::find' do
+    it 'should delegate to Finder' do
+      double = double('Finder').as_null_object
+      Flavicon::Finder.should_receive(:new).with('http://www.example.com').and_return(double)
+      Flavicon.find('http://www.example.com')
+    end
+
+    it 'should call find on Finder instance' do
+      double = double('Finder', find: 'http://www.example.com/favicon.ico')
+      Flavicon::Finder.should_receive(:new).with('http://www.example.com').and_return(double)
+      Flavicon.find('http://www.example.com').should eq('http://www.example.com/favicon.ico')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,33 @@
+require 'simplecov'
+
+module SimpleCov::Configuration
+  def clean_filters
+    @filters = []
+  end
+end
+
+SimpleCov.configure do
+  clean_filters
+  load_profile 'test_frameworks'
+end
+
+ENV['COVERAGE'] && SimpleCov.start do
+  add_filter '/.rvm/'
+end
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rspec'
+require 'flavicon'
+require 'pry'
+
+require 'webmock/rspec'
+WebMock.disable_net_connect!(allow_localhost: true)
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: flavicon
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hamed Asghari
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-21 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: fetch favicon url by parsing html and falling back on /favicon.ico as
+  default
+email: hasghari@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- ".document"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/flavicon.rb
+- lib/flavicon/finder.rb
+- spec/fixtures/absolute.html
+- spec/fixtures/missing.html
+- spec/fixtures/multiple.html
+- spec/fixtures/relative.html
+- spec/flavicon/finder_spec.rb
+- spec/flavicon_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/hasghari/flavicon
+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.2.2
+signing_key: 
+specification_version: 4
+summary: fetch favicon url for provided url
+test_files: []