faviconduit 0.1.0

data/.document

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

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Kevin Swope
+
+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.rdoc

@@ -0,0 +1,65 @@
+= faviconduit
+
+Attempts to download a URL's favicon.
+
+== Synopsis
+
+  raise "url missing" unless uri = ARGV[0]
+
+  begin
+
+    fav = Faviconduit.get(uri)
+
+    puts "found favicon at #{fav.url}"
+
+    File.open('favicon.ico', 'w') do |file|
+      file.write(fav.data)
+    end
+
+  rescue Faviconduit::MissingFavicon
+
+    puts "favicon missing"
+
+  rescue Faviconduit::InvalidFavicon
+
+    puts "favicon invalid"
+
+  end
+
+== Methods
+
+   Faviconduit.get(uri)
+
+Takes a url and attempts to returns the favicon object.  The url can be
+fairly loosely specified because Addressable::URI.heuristic_parse is
+used to figure it out.
+
+   obj.url
+
+The favicon url it was ultimately found at.
+
+   obj.data
+
+The favicon image data.
+
+== Exceptions
+
+   Faviconduit::MissingFavicon
+
+Raises this if the favicon simply isn't found.
+
+   Faviconduit::InvalidFavicon
+
+Raises this if the favicon is determined to be not a valid favicon.
+Currently (0.1) determins this if the content-type is not /^image/
+or the size is 0 bytes.
+
+   Faviconduit::Error
+
+This is the parent of all faviconduit exceptions and can be caught
+instead of the more specific exceptions.
+
+
+== Copyright
+
+Copyright (c) 2010 Kevin Swope. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,30 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    desc = "download a webpage's favicon"
+    gem.name = "faviconduit"
+    gem.summary = desc
+    gem.description = desc
+    gem.email = "git-kevdev@snkmail.com"
+    gem.homepage = "http://github.com/kswope/faviconduit"
+    gem.authors = ["Kevin Swope"]
+    gem.add_dependency 'nokogiri'
+    gem.add_dependency 'addressable'
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+task :default => :test
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end

data/VERSION

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

data/faviconduit.gemspec

@@ -0,0 +1,121 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{faviconduit}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kevin Swope"]
+  s.date = %q{2010-10-22}
+  s.description = %q{download a webpage's favicon}
+  s.email = %q{git-kevdev@snkmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "faviconduit.gemspec",
+     "lib/faviconduit.rb",
+     "lib/runner.rb",
+     "test/helper.rb",
+     "test/rails_root/.gitignore",
+     "test/rails_root/Gemfile",
+     "test/rails_root/Gemfile.lock",
+     "test/rails_root/README",
+     "test/rails_root/Rakefile",
+     "test/rails_root/app/controllers/application_controller.rb",
+     "test/rails_root/app/controllers/welcome_controller.rb",
+     "test/rails_root/app/helpers/application_helper.rb",
+     "test/rails_root/app/helpers/welcome_helper.rb",
+     "test/rails_root/app/views/layouts/application.html.erb",
+     "test/rails_root/app/views/welcome/default.html.erb",
+     "test/rails_root/app/views/welcome/html.html.erb",
+     "test/rails_root/app/views/welcome/icon.html.erb",
+     "test/rails_root/app/views/welcome/missing.html.erb",
+     "test/rails_root/app/views/welcome/shortcut_icon.html.erb",
+     "test/rails_root/app/views/welcome/zero.html.erb",
+     "test/rails_root/config.ru",
+     "test/rails_root/config/application.rb",
+     "test/rails_root/config/boot.rb",
+     "test/rails_root/config/environment.rb",
+     "test/rails_root/config/environments/development.rb",
+     "test/rails_root/config/environments/production.rb",
+     "test/rails_root/config/environments/test.rb",
+     "test/rails_root/config/initializers/backtrace_silencers.rb",
+     "test/rails_root/config/initializers/inflections.rb",
+     "test/rails_root/config/initializers/mime_types.rb",
+     "test/rails_root/config/initializers/secret_token.rb",
+     "test/rails_root/config/initializers/session_store.rb",
+     "test/rails_root/config/locales/en.yml",
+     "test/rails_root/config/routes.rb",
+     "test/rails_root/db/seeds.rb",
+     "test/rails_root/doc/README_FOR_APP",
+     "test/rails_root/public/404.html",
+     "test/rails_root/public/422.html",
+     "test/rails_root/public/500.html",
+     "test/rails_root/public/favicon.ico",
+     "test/rails_root/public/images/favicon_valid.ico",
+     "test/rails_root/public/images/favicon_zero.ico",
+     "test/rails_root/public/images/rails.png",
+     "test/rails_root/public/javascripts/application.js",
+     "test/rails_root/public/robots.txt",
+     "test/rails_root/script/rails",
+     "test/rails_root/test/functional/welcome_controller_test.rb",
+     "test/rails_root/test/unit/helpers/welcome_helper_test.rb",
+     "test/test_faviconduit.rb"
+  ]
+  s.homepage = %q{http://github.com/kswope/faviconduit}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{download a webpage's favicon}
+  s.test_files = [
+    "test/helper.rb",
+     "test/rails_root/app/controllers/application_controller.rb",
+     "test/rails_root/app/controllers/welcome_controller.rb",
+     "test/rails_root/app/helpers/application_helper.rb",
+     "test/rails_root/app/helpers/welcome_helper.rb",
+     "test/rails_root/config/application.rb",
+     "test/rails_root/config/boot.rb",
+     "test/rails_root/config/environment.rb",
+     "test/rails_root/config/environments/development.rb",
+     "test/rails_root/config/environments/production.rb",
+     "test/rails_root/config/environments/test.rb",
+     "test/rails_root/config/initializers/backtrace_silencers.rb",
+     "test/rails_root/config/initializers/inflections.rb",
+     "test/rails_root/config/initializers/mime_types.rb",
+     "test/rails_root/config/initializers/secret_token.rb",
+     "test/rails_root/config/initializers/session_store.rb",
+     "test/rails_root/config/routes.rb",
+     "test/rails_root/db/seeds.rb",
+     "test/rails_root/test/functional/welcome_controller_test.rb",
+     "test/rails_root/test/unit/helpers/welcome_helper_test.rb",
+     "test/test_faviconduit.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<nokogiri>, [">= 0"])
+      s.add_runtime_dependency(%q<addressable>, [">= 0"])
+    else
+      s.add_dependency(%q<nokogiri>, [">= 0"])
+      s.add_dependency(%q<addressable>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<nokogiri>, [">= 0"])
+    s.add_dependency(%q<addressable>, [">= 0"])
+  end
+end
+

data/lib/faviconduit.rb

@@ -0,0 +1,54 @@
+
+require 'nokogiri'
+require 'open-uri'
+require "addressable/uri"
+
+
+module Faviconduit
+
+  class Error < StandardError; end
+  class InvalidFavicon < Error; end
+  class MissingFavicon < Error; end
+
+  class Favicon; attr_accessor :url, :data end
+
+
+  def self.get(url)
+
+    uri = Addressable::URI.heuristic_parse(url)
+    uri = Addressable::URI.encode(uri) # needed for chars with accents in url
+
+    doc = Nokogiri::HTML(open(uri))
+
+    path = doc.xpath("//link[@rel='shortcut icon' or @rel='icon']/@href").first
+    path = path ? path.to_s : '/favicon.ico'
+
+    fav_uri = Addressable::URI.join(uri, path.to_s)
+
+    begin
+
+      stream = open(fav_uri)
+
+      unless stream.content_type[/^image/]
+        raise(InvalidFavicon, "wrong content_type (#{stream.content_type})")
+      end
+
+      data = stream.read
+
+      if data.size == 0
+        raise(InvalidFavicon, "zero data")
+      end
+
+      fav = Favicon.new
+      fav.url = fav_uri.to_s
+      fav.data = data
+      return fav
+
+    rescue OpenURI::HTTPError => e
+      raise MissingFavicon if e.to_s[/404/]
+      raise # nevermind, reraise the previous exception
+    end
+
+  end
+
+end

data/lib/runner.rb

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+
+require './faviconduit'
+
+# just a little script to run the library
+
+# download favicons like this...
+# shell> ./runner.rb slashdot.org
+
+
+raise "url missing" unless uri = ARGV[0]
+
+begin
+
+  fav = Faviconduit.get(uri)
+
+  File.open('favicon.ico', 'w') do |file|
+    puts "writing #{fav.url}";
+    file.write(fav.data)
+  end
+
+rescue Faviconduit::MissingFavicon
+  puts "favicon missing"
+rescue Faviconduit::InvalidFavicon
+  puts "favicon invalid"
+end
+
+

data/test/helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'faviconduit'
+
+class Test::Unit::TestCase
+end
+
+require "addressable/uri"

data/test/rails_root/.gitignore

@@ -0,0 +1,2 @@
+log/*
+tmp/*

data/test/rails_root/Gemfile

@@ -0,0 +1,29 @@
+source 'http://rubygems.org'
+
+gem 'rails', '3.0.0'
+
+# Bundle edge Rails instead:
+# gem 'rails', :git => 'git://github.com/rails/rails.git'
+
+
+# Use unicorn as the web server
+# gem 'unicorn'
+
+# Deploy with Capistrano
+# gem 'capistrano'
+
+# To use debugger
+# gem 'ruby-debug'
+
+# Bundle the extra gems:
+# gem 'bj'
+# gem 'nokogiri'
+# gem 'sqlite3-ruby', :require => 'sqlite3'
+# gem 'aws-s3', :require => 'aws/s3'
+
+# Bundle gems for the local environment. Make sure to
+# put test-only gems in this group so their generators
+# and rake tasks are available in development mode:
+# group :development, :test do
+#   gem 'webrat'
+# end

data/test/rails_root/Gemfile.lock

@@ -0,0 +1,71 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.0)
+      actionpack (= 3.0.0)
+      mail (~> 2.2.5)
+    actionpack (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4.1)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.12)
+      rack-test (~> 0.5.4)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.0)
+      activesupport (= 3.0.0)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activerecord (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+      arel (~> 1.0.0)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+    activesupport (3.0.0)
+    arel (1.0.1)
+      activesupport (~> 3.0.0)
+    builder (2.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    i18n (0.4.1)
+    mail (2.2.7)
+      activesupport (>= 2.3.6)
+      mime-types
+      treetop (>= 1.4.5)
+    mime-types (1.16)
+    polyglot (0.3.1)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.6)
+      rack (>= 1.0)
+    rails (3.0.0)
+      actionmailer (= 3.0.0)
+      actionpack (= 3.0.0)
+      activerecord (= 3.0.0)
+      activeresource (= 3.0.0)
+      activesupport (= 3.0.0)
+      bundler (~> 1.0.0)
+      railties (= 3.0.0)
+    railties (3.0.0)
+      actionpack (= 3.0.0)
+      activesupport (= 3.0.0)
+      rake (>= 0.8.4)
+      thor (~> 0.14.0)
+    rake (0.8.7)
+    thor (0.14.3)
+    treetop (1.4.8)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.23)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rails (= 3.0.0)