ficon 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8bb5dcc8886d22d589e2f3d9dfef5ab42bc6adb8
+  data.tar.gz: f72571f07afcfc2f9693dbf94c7030cce7bfb321
+SHA512:
+  metadata.gz: ead6ae9ac27815133dd6a219cdcebb44d527f43dc5451e0739d49fc945613b6beb4648ae9132d2e1807b0808d9cc0645ee299671611775c9019773ae9fe4953a
+  data.tar.gz: bd4875fd569db49ab0cebada2a67e9608ec0536dca7b91e5698add2be1bbb3617ad29baf66febdb9592daa173e53ab221b33861e66f204bcd31bbce57e3e523d

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+**/*.sw?

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ficon.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Dan Milne
+
+MIT License
+
+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,40 @@
+# Ficon
+
+Find all the icons for a given URL.  Favicons, og:image etc and return them in as a list.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ficon'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ficon
+
+## Usage
+
+    irb(main)> Ficon.from_uri "https://facebook.com"
+    => ["https://www.facebook.com/images/fb_icon_325x325.png", "https://fbstatic-a.akamaihd.net/rsrc.php/yV/r/hzMapiNYYpW.ico", "https://www.facebook.com/favicon.ico"]
+
+## Todo
+
+When returning a win8-tile, should probably test if there's a colour assocaited with it. EG, twitter returns:
+
+````html
+<meta name="msapplication-TileImage" content="//abs.twimg.com/favicons/win8-tile-144.png"/>
+<meta name="msapplication-TileColor" content="#00aced"/>
+````
+
+
+## Contributing
+
+1. Fork it ( https://github.com/dkam/ficon/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,14 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/*_test.rb'
+  test.verbose = true
+end
+
+task :test
+
+task :default => :test
+

data/ficon.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ficon/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ficon"
+  spec.version       = Ficon::VERSION
+  spec.authors       = ["Dan Milne"]
+  spec.email         = ["d@nmilne.com"]
+  spec.summary       = %q{Find website icons}
+  spec.description   = %q{Ficon finds icons for websites and optionally, the best icon}
+  spec.homepage      = "https://github.com/dkam/ficon"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'nokogiri', "~> 1.6"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10"
+end

data/lib/ficon/version.rb

@@ -0,0 +1,3 @@
+module Ficon
+  VERSION = "0.0.1"
+end

data/lib/ficon.rb

@@ -0,0 +1,76 @@
+require "ficon/version"
+
+require 'open-uri'
+require 'nokogiri'
+require 'uri'
+require 'net/http'
+
+module Ficon
+  def self.from_uri(_uri)
+    uri = URI(_uri)
+    doc = nil
+
+    begin
+      data = open(uri)
+      doc = Nokogiri::HTML(data)
+
+      uri = data.base_uri 
+
+    rescue OpenURI::HTTPError, SocketError => e
+      puts e.inspect
+      return nil
+    end
+
+    results = from_page(doc).collect {|result| normalise(uri, result) }.uniq
+
+    results.concat( from_probes(uri, results) )
+
+    return results
+  end
+
+  def self.from_probes(uri, already_found=[])
+    
+    # Check if root domain redirects before probing, striping path - eg http://www.apple.com.au/ -> http://www.apple.com/au/
+
+    probe = Net::HTTP.new(uri.host).request_head("/")
+    if probe.code == "301" || probe.code == "302"
+      uri = URI(probe.header["Location"])
+      uri.path = ""
+    end
+
+    results = []
+    guesses = ["/favicon.ico", "/favicon.png"]
+
+    guesses.each do |guess|
+      uri.path = guess
+      unless already_found.include?( uri.to_s )
+        results <<  uri.to_s  if( Net::HTTP.new(uri.host).request_head(uri.path).header.code == "200")
+      end
+    end
+
+    return results
+  end
+
+  def self.from_page(page)
+    doc = nil
+    if page.is_a? String
+      doc = Nokogiri::HTML(page) 
+    elsif page.is_a? Nokogiri::HTML::Document
+      doc = page 
+    else
+      raise ArgumentError 
+    end
+
+    doc.xpath("//meta[@property='og:image']|//meta[@name='msapplication-TileImage']|//link[@type='image/ico' or @type='image/vnd.microsoft.icon']|//link[@rel='icon' or @rel='shortcut icon' or @rel='apple-touch-icon-precomposed' or @rel='apple-touch-icon']").collect {|e| e.values.select {|v|  v =~ /\.png$|\.jpg$|\.gif$|\.ico$|\.svg$/ }}.flatten
+
+  end
+
+  def self.normalise(base, candidate)
+      parsed_candidate = URI(candidate); 
+      
+      parsed_candidate.host   = base.host if parsed_candidate.host.nil?      # Set relative URLs to absolute
+      parsed_candidate.scheme = base.scheme if parsed_candidate.scheme.nil?  # Set the schema if missing
+
+      parsed_candidate.to_s
+  end
+end

data/test/ficon_test.rb

@@ -0,0 +1,37 @@
+require 'rubygems'
+
+require 'test/unit'
+
+PathHere = File.dirname(__FILE__)
+$LOAD_PATH.unshift File.join(PathHere, "..", "lib")
+
+require 'ficon'
+
+  Tests = []
+  Tests << { html: %Q{<meta name="msapplication-TileImage" content="https://s.yimg.com/pw/images/favicon-msapplication-tileimage.png"/> }, value: 'https://s.yimg.com/pw/images/favicon-msapplication-tileimage.png' }
+  Tests << { html: %Q{<link rel="shortcut icon" type="image/ico" href="https://s.yimg.com/pw/favicon.ico"> }, value: 'https://s.yimg.com/pw/favicon.ico' }
+  Tests << { html: %Q{<link href="/apple-touch-icon.png" rel="apple-touch-icon-precomposed">}, value: '/apple-touch-icon.png' }
+  Tests << { html: %Q{<link rel="shortcut icon" href="/wp-content/themes/torrentfreakredux/assets/img/icons/favicon.png">}, value: '/wp-content/themes/torrentfreakredux/assets/img/icons/favicon.png' }
+  Tests << { html: %Q{<link rel="apple-touch-icon-precomposed" href="/wp-content/themes/torrentfreakredux/assets/img/icons/57.png">}, value: '/wp-content/themes/torrentfreakredux/assets/img/icons/57.png' }
+  Tests << { html: %Q{<link rel="apple-touch-icon-precomposed" sizes="114x114" href="/wp-content/themes/torrentfreakredux/assets/img/icons/114.png">}, value: '/wp-content/themes/torrentfreakredux/assets/img/icons/114.png' }
+  Tests << { html: %Q{<link rel="apple-touch-icon-precomposed" sizes="72x72" href="/wp-content/themes/torrentfreakredux/assets/img/icons/72.png">}, value: '/wp-content/themes/torrentfreakredux/assets/img/icons/72.png' }
+  Tests << { html: %Q{<link rel="apple-touch-icon-precomposed" sizes="144x144" href="/wp-content/themes/torrentfreakredux/assets/img/icons/144.png">}, value: '/wp-content/themes/torrentfreakredux/assets/img/icons/144.png' }
+  Tests << { html: %Q{<link rel="shortcut icon" href="/favicon.png">}, value: '/favicon.png' }
+  Tests << { html: %Q{<link rel="apple-touch-icon" href="/apple-touch-icon.png">}, value: '/apple-touch-icon.png' }
+  Tests << { html: %Q{<link rel="shortcut icon" href="http://example.com/myicon.ico" />}, value: 'http://example.com/myicon.ico' }
+  Tests << { html: %Q{<link rel="icon" href="http://example.com/image.ico" />}, value: 'http://example.com/image.ico' }
+  Tests << { html: %Q{<link rel="icon" type="image/vnd.microsoft.icon" href="http://example.com/image.ico" />}, value: 'http://example.com/image.ico' }
+  Tests << { html: %Q{<link rel="icon" type="image/png" href="http://example.com/image.png" />}, value: 'http://example.com/image.png' }
+  Tests << { html: %Q{<link rel="icon" type="image/gif"  href="http://example.com/image.gif" />}, value: 'http://example.com/image.gif' }
+  Tests << { html: %Q{<link rel="icon" type="image/x-icon" href="http://example.com/image.ico"/>}, value: 'http://example.com/image.ico' }
+  Tests << { html: %Q{<link rel="shortcut icon" href="https://fbstatic-a.akamaihd.net/rsrc.php/yl/r/H3nktOa7ZMg.ico" />}, value: 'https://fbstatic-a.akamaihd.net/rsrc.php/yl/r/H3nktOa7ZMg.ico' }
+  Tests << { html: %Q{<meta property="og:image" content="https://www.facebook.com/images/fb_icon_325x325.png" />}, value: 'https://www.facebook.com/images/fb_icon_325x325.png'           }
+
+
+class FiconTest < Test::Unit::TestCase
+  def test_html_chunks
+    Tests.each do |t|
+      assert Ficon.from_page( t[:html] )[0] == t[:value], "Seaching |#{t[:html]}| expected #{t[:value]}" 
+    end
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: ficon
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dan Milne
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-06 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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+description: Ficon finds icons for websites and optionally, the best icon
+email:
+- d@nmilne.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ficon.gemspec
+- lib/ficon.rb
+- lib/ficon/version.rb
+- test/ficon_test.rb
+homepage: https://github.com/dkam/ficon
+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: Find website icons
+test_files:
+- test/ficon_test.rb