gcnovus-avatar 0.0.7 → 0.2.0

data/{README.txt → README.rdoc}

@@ -9,6 +9,7 @@ Avatar is a collection of Ruby utilities for displaying avatars.
 
 Avatar currently supports the following sources:
 * Gravatar (see http://www.gravatar.com)
+* Initial Pavatar support (see http://pavatar.com/spec/)
 * a constant URL (e.g. http://mysite.com/images/default_icon.png)
 * parameterized URLs (e.g. http://mysite.com/images/famfamfam/user_#{color}.png)
 * file_column (see http://www.kanthak.net/opensource/file_column/)
@@ -18,7 +19,12 @@ Avatar currently supports the following views:
 * ActionView (Rails), through avatar_tag
 * AbstractView (any framework), through avatar_url_for
 
-== SYNOPSIS:
+== BUG REPORTING:
+
+Submit bugs to https://gcnovus.fogbugz.com/default.asp?pg=pgPublicEdit under the "Avatar Gem" project,
+or discuss at http://groups.google.com/group/ruby-avatar/.
+
+== BASICS:
 
 in RAILS_ROOT/app/helpers/people_helper.rb
 require 'avatar/view/action_view_support'
@@ -43,7 +49,7 @@ in RAILS_ROOT/app/views/people/show.html.erb:
 
 (The MIT License)
 
-Copyright (c) 2008 Universal Presenece, Inc.
+Copyright (c) 2008 James Rosen
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -62,4 +68,4 @@ 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.
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/avatar.rb

@@ -1,6 +1,7 @@
 $:.unshift File.expand_path(File.dirname(__FILE__))
 require 'avatar/source/abstract_source'
 require 'avatar/source/gravatar_source'
+require 'avatar/source/pavatar_source'
 
 # Helpers for displaying avatars.
 # Usage in Rails:
@@ -31,7 +32,7 @@ module Avatar
   
   def self.default_avatar_options=(options)
     raise ArgumentError.new("#{options} is not a Hash") unless options.kind_of?(Hash)
-    @@options = options
+    @@default_avatar_options = options
   end
   
-end
+end

data/lib/avatar/source/pavatar_source.rb

@@ -0,0 +1,109 @@
+require 'net/http'
+require 'uri'
+
+module Avatar # :nodoc:
+  module Source # :nodoc:
+    # Implements http://pavatar.com/spec/
+    class PavatarSource
+      include AbstractSource
+
+      PAVATAR_REGEXP = /^((?:http|https):\/\/.+)$/ix
+      
+      attr_accessor :http_connection_factory
+      
+      # Create a new PAvatar source.
+      #
+      # Options:
+      # * <code>:http_connection_factory</code> - the Object used to start new HTTP connections. By default, 
+      #                                           the <code>Net::HTTP</code> class. To use a proxy, pass 
+      #                                           <code>:http_connection_factory => Net::HTTP::Proxy(...)</code>
+      def initialize(options = {})
+        self.http_connection_factory = options.delete(:http_connection_factory) || Net::HTTP
+      end
+
+      # Discovers pavatar URL.  Returns nil if person is nil.
+      #
+      # Options: 
+      # * <code>:pavatar_field (Symbol)</code> - the field to call from person.  By default, <code>:blog_url</code>.
+      def avatar_url_for(person, options = {})
+        return nil if person.nil?
+        options = options.merge! ::Avatar.default_avatar_options
+        field = options.delete(:pavatar_field) || :blog_url
+        raise ArgumentError.new('No field specified; either specify a default field or pass in a value for :pavatar_field (probably :blog_url)') unless field
+
+        pavatar_url = autodiscover_pavatar_url_from person.send(field)
+        
+        (pavatar_url.nil? || pavatar_url.to_s.blank?) ? nil : pavatar_url
+      end
+      
+      private
+      
+      # Autodiscover PAvatar URL from a +profile_url+.
+      # 
+      # See http://pavatar.com/spec/#autodiscovery
+      #
+      # Returns +nil+ if +profile_url+ is blank.
+      def autodiscover_pavatar_url_from(profile_url)
+        return nil if profile_url.blank?
+        uri = URI.parse(profile_url)
+        begin
+          self.http_connection_factory.start(uri.host, uri.port) do |http|
+            return avatar_from_header(http) || avatar_from_link_element(http) || direct_avatar(profile_url, http) || nil
+          end
+        rescue Errno::ECONNREFUSED => e
+          nil
+        end
+      end
+      
+      
+        # Autodisciover using http headers.
+        #
+        # See http://pavatar.com/spec/#http-header
+        #
+        # Returns the URL if found; +nil+ otherwise.
+        def avatar_from_header(http)
+          resp = http.head('/')
+          resp.kind_of?(Net::HTTPSuccess) && resp['X-Pavatar']
+        end
+      
+      
+        # Autodiscover using link element.
+        #
+        # See http://pavatar.com/spec/#link-element
+        #
+        # Returns the URL if found; +nil+ otherwise.
+        def avatar_from_link_element(http)
+          resp = http.get('/')
+          resp.kind_of?(Net::HTTPSuccess) && parse_html_for_pavatar(resp.body)
+        end
+        
+        
+          # Look for a <link rel='pavatar' href='...' />
+          #
+          # Returns the URL if found; +nil+ otherwise.
+          def parse_html_for_pavatar(doc)
+            return nil if doc.nil? or doc.empty?
+
+            # 4.a 2 http://pavatar.com/spec/#autodiscovery-algorithm
+            # recommends following regexp /<link rel="pavatar" href="([^""]+)" ?/?>/
+            # but it will not always match valid xhtml link element. 
+            #
+            if result = doc.match(/<link(.+)rel=["']pavatar["'](.+)>/)
+              result.to_a[1..-1].map { |s| s.split(/["']/) }.flatten.find { |url| url =~ PAVATAR_REGEXP }
+            end
+          end
+      
+      
+        # Autodiscover using direct URL.
+        #
+        # See http://pavatar.com/spec/#direct-url
+        #
+        # Returns the URL if found; +nil+ otherwise.
+        def direct_avatar(profile_url, http)
+          resp = http.head('/pavatar.png')
+          profile_url + (profile_url =~ /\/$/ ? '' : '/') + 'pavatar.png' if resp.kind_of?(Net::HTTPSuccess)
+        end
+
+    end
+  end
+end

data/lib/avatar/source/wrapper/rails_asset_source_wrapper.rb

@@ -1,4 +1,5 @@
 require 'avatar/source/wrapper/abstract_source_wrapper'
+require 'action_view/helpers/tag_helper' 
 require 'action_view/helpers/asset_tag_helper'
 
 module Avatar # :nodoc:
@@ -33,4 +34,5 @@ module Avatar # :nodoc:
       end
     end
   end
-end
+end
+

data/lib/avatar/version.rb

@@ -1,8 +1,8 @@
 module Avatar #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
-    MINOR = 0
-    TINY  = 7
+    MINOR = 2
+    TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: gcnovus-avatar
 version: !ruby/object:Gem::Version 
-  version: 0.0.7
+  version: 0.2.0
 platform: ruby
 authors: 
 - James Rosen
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-07-17 00:00:00 -07:00
+date: 2009-07-16 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -24,7 +24,7 @@ extra_rdoc_files: []
 files: 
 - History.txt
 - License.txt
-- README.txt
+- README.rdoc
 - init.rb
 - rails/init.rb
 - lib/avatar
@@ -35,6 +35,7 @@ files:
 - lib/avatar/source/gravatar_source.rb
 - lib/avatar/source/nil_source.rb
 - lib/avatar/source/paperclip_source.rb
+- lib/avatar/source/pavatar_source.rb
 - lib/avatar/source/source_chain.rb
 - lib/avatar/source/static_url_source.rb
 - lib/avatar/source/wrapper
@@ -49,7 +50,7 @@ files:
 - lib/avatar/view/action_view_support.rb
 - lib/avatar/view.rb
 - lib/avatar.rb
-has_rdoc: true
+has_rdoc: false
 homepage: http://github.com/gcnovus/avatar
 post_install_message: 
 rdoc_options: