gravatarify 0.6.0

data/.gitignore

@@ -0,0 +1,3 @@
+doc/
+pkg/
+.yardoc

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Lukas Westermann, Zurich (CHE)
+
+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,81 @@
+# Gravatarify
+    
+Removes any hassles building those pesky gravatar urls, it's not there arent any alternatives [out](http://github.com/mdeering/gravitar_image_tag),
+[there](http://github.com/chrislloyd/gravtastic), but none seem to support stuff like `Proc`s for the default picture url, or
+the multiple host names supported by gravatar.com (great when displaying lots of avatars).
+
+Best of it? It works with Rails, probably Merb and even plain old Ruby :)
+
+## Install
+
+TODO: need to gemify it...
+
+## Using the view helpers
+
+Probably one of the easiest ways to add support for gravatar images is with the included view helpers:
+
+    <%= gravatar_tag @user %> # assumes @user has email or mail field!
+    
+This builds a neat `<img/>`-tag, if you need to pass in stuff like the size etc. just:
+
+    <%= gravatar_tag @user, :size => 25, :rating => :x, :class => "gravatar" %>
+    
+This will display an "X" rated avatar which is 25x25 pixel in size and the image tag will have the class `"gravatar"`.
+If more control is required, or just the URL, well then go ahead and use `gravatar_url` instead:
+
+     <%= image_tag gravatar_url(@user.author_email, :size => 16), :size => "16x16",
+          :alt => @user.name, :class => "avatar avatar-16"}/
+    
+Using rails `image_tag` to create an `<img/>`-tag with `gravatar_url`. It's important to know that 
+also an object can be passed to `gravatar_url`, if it responds to either `email` or `mail`. If not (like
+in the example above), the email address must be passed in.
+
+## Using the model helpers
+
+Another way (especially cool) for models is to do:
+
+    class User < ActiveRecord::Base
+     gravatarify
+    end
+   
+Thats it! Well, at least if the `User` model responds to `email` or `mail`. Then in the views all left to do is:
+
+    <%= image_tag @user.gravatar_url %>
+   
+Neat, isn't it? Of course passing options works just like with the view helpers:
+
+    <%= image_tag @user.gravatar_url(:size => 16, :rating => :r) %>
+   
+Defaults can even be passed to the `gravatarify` call, so no need to repeat them on every `gravatar_url` call.
+
+    gravatarify :employee_mail, :size => 16, :rating => :r
+   
+All gravatars will now come from the `employee_mail` field, not the default `email` or `mail` field and be in 16x16px in size
+and have a rating of 'r'. Of course these can be overriden in calls to `gravatar_url` like before. Pretty cool is also the
+fact that an object can be passed directly to `gravatar_tag` if it responds to `gravatar_url`, like:
+
+    # model:
+    class User < ActiveRecord::Base
+      gravatarify :size => 16, :secure => true
+    end
+    
+    # view:
+    <%= gravatar_tag @user %> # -> <img ... width="16" src="https://secure.gravatar..." height="16" />
+    
+The `gravatar_tag` looks if the object responds to `gravatar_url` and if so, just passes the options to it,
+it works also with plain old ruby objects, of course :)
+
+### PORO - plain old ruby objects (yeah, POJO sounds smoother :D)
+
+Not using Rails, ActiveRecord or DataMapper? It's as easy as including `Gravatarify::ObjectSupport` to your
+class:
+
+    require 'gravatarify'
+    class PoroUser
+      include Gravatarify::ObjectSupport
+      gravatarify
+    end
+    
+Tadaaa! Works exactly like the model helpers, so it's now possible to call `gravatar_url` on instances
+of `PoroUser`.
+

data/Rakefile

@@ -0,0 +1,77 @@
+require 'rake'
+require 'rake/testtask'
+require 'yard'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the gravatarify plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for gravatarify. (requires yard)'
+YARD::Rake::YardocTask.new(:doc) do |t|
+  t.files = ['lib/**/*.rb']
+  t.options = [
+      "--readme", "README.md",
+      "--title", "Gravatarify API Documentation"
+  ]
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "gravatarify"
+    gemspec.summary = "Gravatar URLs for your ruby"
+    gemspec.email = "lukas.westermann@gmail.com"
+    gemspec.homepage = "http://github.com/lwe/gravatarify"
+    gemspec.authors = ["Lukas Westermann"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+desc 'Clean all generated files (.yardoc and doc/*)'
+task :clean do |t|
+  FileUtils.rm_rf "doc"
+  FileUtils.rm_rf "pkg"
+  FileUtils.rm_rf ".yardoc"
+end
+
+namespace :metrics do
+  desc 'Report all metrics, i.e. stats and code coverage.'
+  task :all => [:stats, :coverage]
+  
+  desc 'Report code statistics for library and tests to shell.'
+  task :stats do |t|
+    require 'code_statistics'
+    dirs = {
+      'Libraries' => 'lib',
+      'Unit tests' => 'test'
+    }.map { |name,dir| [name, File.join(File.dirname(__FILE__), dir)] }
+    CodeStatistics.new(*dirs).to_s
+  end
+  
+  desc 'Report code coverage to HTML (doc/coverage) and shell (requires rcov).'
+  task :coverage do |t|
+    rm_f "doc/coverage"
+    mkdir_p "doc/coverage"
+    rcov = %(rcov -Ilib:test --exclude '\/gems\/' -o doc/coverage -T test/*_test.rb )
+    system rcov
+  end
+  
+  desc 'Report the fishy smell of bad code (requires reek)'
+  task :smelly do |t|
+    puts
+    puts "* * * NOTE: reek currently reports several false positives,"
+    puts "      eventhough it's probably good to check once in a while!"
+    puts
+    reek = %(reek -s lib)
+    system reek
+  end
+end

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:patch: 0
+:major: 0
+:minor: 6

data/init.rb

@@ -0,0 +1,2 @@
+# Include hook code here
+require File.join(File.dirname(__FILE__), 'lib', 'gravatarify')

data/lib/gravatarify.rb

@@ -0,0 +1,15 @@
+# Loads all required submodules
+
+# Base -> provides the basic gravatar_url method, can also be used for
+# custom implementations, just include Gravatarify::Base.
+require 'gravatarify/base'
+require 'gravatarify/view_helper'
+require 'gravatarify/object_support'
+
+# include helper for rails
+ActionView::Base.send(:include, Gravatarify::ViewHelper) if defined?(ActionView)
+
+# setup for AR und DataMapper, note: DataMapper yet untested :) but I suppose it works, because
+# it works as expected on plain old ruby objects!
+ActiveRecord::Base.send(:include, Gravatarify::ObjectSupport) if defined?(ActiveRecord)
+DataMapper::Model.append_inclusions(Gravatarify::ObjectSupport) if defined?(DataMapper)

data/lib/gravatarify/base.rb

@@ -0,0 +1,90 @@
+require 'digest/md5'
+require 'cgi'
+
+module Gravatarify
+  
+  # Hosts used for balancing
+  GRAVATAR_HOSTS = %w{ 0 1 2 www }
+  
+  # If no size is specified, gravatar.com returns 80x80px images
+  GRAVATAR_DEFAULT_SIZE = 80
+  
+  # Default filetype is JPG
+  GRAVATAR_DEFAULT_FILETYPE = 'jpg'
+
+  # List of known and valid gravatar options (includes shortened options).
+  GRAVATAR_OPTIONS = [ :default, :d, :rating, :r, :size, :s, :secure, :filetype ]
+
+  # Hash of :ultra_long_option_name => 'abbrevated option'
+  GRAVATAR_ABBREV_OPTIONS = { :default => 'd', :rating => 'r', :size => 's' }
+  
+  # Options which can be globally overriden by the application
+  def self.options; @options ||= {} end
+  
+  # Provides core support to build gravatar urls based on supplied e-mail strings.
+  module Base
+    
+    # Method which builds a gravatar url based on a supplied email and options as
+    # defined by gravatar.com (http://en.gravatar.com/site/implement/url).
+    #
+    #    build_gravatar_url('peter.gibbons@initech.com', :size => 16) # => "http://0.gravatar.com/avatar/cb7865556d41a3d800ae7dbb31d51d54.jpg?s=16"
+    #
+    # It supports multiple gravatar hosts (based on email hash), i.e. depending
+    # on the hash, either <tt>0.gravatar.com</tt>, <tt>1.gravatar.com</tt>, <tt>2.gravatar.com</tt> or <tt>www.gravatar.com</tt>
+    # is used.
+    #
+    # If supplied +email+ responds to either a method named +email+ or +mail+, the value of that method
+    # is used instead to build the gravatar hash. Very useful to just pass in ActiveRecord object for instance:
+    #    
+    #    @user = User.find_by_email("samir@initech.com")
+    #    build_gravatar_url(@user) # => "http://2.gravatar.com/avatar/58cf31c817d76605d5180ce1a550d0d0.jpg"
+    #    build_gravatar_url(@user.email) # same as above!
+    # 
+    # Among all options as defined by gravatar.com's specification, there also exist some special options:
+    #
+    #    build_gravatar_url(@user, :secure => true) # => https://secure.gravatar.com/ava....
+    #
+    # Useful when working on SSL enabled sites. Of course often used options should be set through
+    # +Gravatarify.options+.
+    #
+    # @param [String, #email, #mail] email a string representing an email, or object which responds to +email+ or +mail+
+    # @param [Hash] url_options customize generated gravatar.com url
+    # @option url_options [String, Proc] :default (nil) URL of an image to use as default when no gravatar exists. Gravatar.com
+    #                                    also accepts special values like +identicon+, +monsterid+ or +wavater+ which just displays
+    #                                    a generic icon based on the hash or <tt>404</tt> which return a HTTP Status 404.
+    # @option url_options [String, Symbol] :rating (:g) Specify the rating, gravatar.com supports <tt>:g</tt>, <tt>:pg</tt>,
+    #                                     <tt>:r</tt> or <tt>:x</tt>, they correspond to movie ratings :)
+    # @option url_options [Integer] :size (80) The size of the (square) image.
+    # @option url_options [Boolean, Proc] :secure (false) If set to +true+, then uses the secure gravatar.com URL. If a Proc is
+    #                                     supplied it's evaluated, the Proc should evaluate to +true+ or +false+.
+    # @option url_options [String, Symbol] :filetype (:jpg) Gravatar.com supports only <tt>:gif</tt>, <tt>:jpg</tt> and <tt>:png</tt>
+    # @return [String] In any case (even if supplied +email+ is +nil+) returns a fully qualified gravatar.com URL.
+    #                  The returned string is not yet HTML escaped, *but* all +url_options+ have been URI escaped.
+    def build_gravatar_url(email, url_options = {})
+      # FIXME: add symbolize_keys again, maybe just write custom method, so we do not depend on ActiveSupport magic...
+      url_options = Gravatarify.options.merge(url_options)
+      email_hash = Digest::MD5.hexdigest(Base.get_smart_email_from(email).strip.downcase)
+      build_gravatar_host(email_hash, url_options.delete(:secure)) << "/avatar/#{email_hash}.#{url_options.delete(:filetype) || GRAVATAR_DEFAULT_FILETYPE}#{build_gravatar_options(url_options)}"
+    end
+  
+    private
+      def build_gravatar_host(str_hash, secure = false)
+        secure = secure.call(respond_to?(:request) ? request : nil) if secure.respond_to?(:call)
+        secure ? "https://secure.gravatar.com" : "http://#{GRAVATAR_HOSTS[str_hash.hash % GRAVATAR_HOSTS.size] || 'www'}.gravatar.com"        
+      end
+    
+      def build_gravatar_options(url_options = {})
+        params = []
+        url_options.each_pair do |key, value|
+          key = GRAVATAR_ABBREV_OPTIONS[key] if GRAVATAR_ABBREV_OPTIONS.include?(key) # shorten key!
+          value = value.call(url_options) if key.to_s == 'd' and value.respond_to?(:call)
+          params << "#{CGI.escape(key.to_s)}=#{CGI.escape(value.to_s)}" if value
+        end
+        "?#{params.sort * '&'}" unless params.empty?
+      end
+      
+      def self.get_smart_email_from(obj)
+        (obj.respond_to?(:email) ? obj.email : (obj.respond_to?(:mail) ? obj.mail : obj)).to_s
+      end
+  end
+end

data/lib/gravatarify/object_support.rb

@@ -0,0 +1,58 @@
+# Enables +gravatarify+ support in any plain old ruby object, ActiveRecord, DataMapper or wherever you like :)
+#
+# Provides the {ClassMethods#gravatarify} method to handle the creation of
+# a +gravatar_url+ method for a ruby object.
+#
+# An ActiveRecord example:
+# 
+#    class User < ActiveRecord::Base
+#      gravatarify
+#    end
+#    @user.gravatar_url # that's it!
+#
+# A DataMapper example:
+#
+#    class User
+#      include DataMapper::Resource
+#      property ...
+#      property :author_email, String
+#    end
+#    @user.gravatar_url :author_email # that's it, using the specified field!
+#
+# And finally, using a plain old ruby object:
+#
+#    class SimpleUser
+#      include Gravatarify::ObjectSupport
+#      attr_accessor :email
+#      gravatarify
+#    end
+#    @user.gravatar_url # that's it!!!
+#
+# If more fine grained controller is required, feel free to use {Gravatarify::Base#build_gravatar_url}
+# directly.
+module Gravatarify::ObjectSupport
+  include Gravatarify::Base
+  
+  def self.included(base) #:nodoc:
+    base.send :extend, ClassMethods
+  end
+  
+  module ClassMethods    
+    def gravatarify(*args)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      source = args.shift
+      define_method(:gravatar_url) do |*params|
+        source = :email if !source and respond_to?(:email)
+        source = :mail if !source and respond_to?(:mail)
+        build_gravatar_url send(source || :email), options.merge(params.first || {})
+      end
+      # has more
+      args.each do |src|
+        method = "#{src}_gravatar_url".sub(/_e?mail/, '')
+        define_method(method) do |*params|
+          build_gravatar_url send(src), options.merge(params.first || {})
+        end
+      end
+    end
+  end
+end

data/lib/gravatarify/view_helper.rb

@@ -0,0 +1,22 @@
+module Gravatarify::ViewHelper
+  include Gravatarify::Base
+
+  # Ensure proper gravatar_url method is available!
+  alias_method :gravatar_url, :build_gravatar_url
+  
+  # Create <img .../> tag by passing +email+ to +gravatar_url+, is based
+  # on rails +image_tag+ helper method.
+  #
+  #    <%= gravatar_tag(current_user.email, :size => 20) %>  # -> <img alt="... height="20" src="http://grava... width="20" />
+  #    <%= gravatar_tag('foo@bar.com', :class => "gravatar") # -> <img alt="foo@bar.com" class="gravatar" height="80" ... width="80" />
+  #
+  # Note: this method tries to be very clever about which options need to be passed to
+  # +gravatar_url+ and which to +image_tag+, so using this method it's not possible to
+  # send arbitary attributes to +gravatar_url+ and have them included in the url.
+  def gravatar_tag(email, options = {})
+    url_options = options.symbolize_keys.reject { |key,value| !Gravatarify::GRAVATAR_OPTIONS.include?(key) }
+    options[:alt] ||= Gravatarify::Base.get_smart_email_from(email) # use email as :alt attribute
+    options[:width] = options[:height] = (url_options[:size] || Gravatarify::GRAVATAR_DEFAULT_SIZE) # customize size
+    image_tag(email.respond_to?(:gravatar_url) ? email.gravatar_url(url_options) : gravatar_url(email, url_options), options)
+  end
+end

data/test/gravatarify_base_test.rb

@@ -0,0 +1,136 @@
+require 'test_helper'
+require 'gravatarify/base'
+
+class MockView
+  include Gravatarify::Base
+end
+
+class GravatarifyBaseTest < Test::Unit::TestCase
+  include Gravatarify::Base
+  
+  def setup
+    # just ensure that no global options are defined when starting next test
+    Gravatarify.options.clear
+  end
+    
+  context "#build_gravatar_url, but without any options yet" do
+    should "generate correct url for hash without options" do
+      assert_equal "http://0.gravatar.com/avatar/1cacf1bc403efca2e7a58bcfa9574e4d.jpg", build_gravatar_url('bella@gmail.com')
+    end
+
+    should "trim and lowercase email address (as according to gravatar docs)" do
+      assert_equal "http://0.gravatar.com/avatar/1cacf1bc403efca2e7a58bcfa9574e4d.jpg", build_gravatar_url("\tbella@gmail.com \n\t")
+      assert_equal "http://0.gravatar.com/avatar/1cacf1bc403efca2e7a58bcfa9574e4d.jpg", build_gravatar_url("BELLA@gmail.COM")
+      assert_equal "http://0.gravatar.com/avatar/1cacf1bc403efca2e7a58bcfa9574e4d.jpg", build_gravatar_url(" BELLA@GMAIL.com")
+    end
+
+    should "handle a nil email as if it were an empty string" do
+      assert_equal "http://1.gravatar.com/avatar/d41d8cd98f00b204e9800998ecf8427e.jpg", build_gravatar_url(nil)
+      assert_equal "http://1.gravatar.com/avatar/d41d8cd98f00b204e9800998ecf8427e.jpg", build_gravatar_url('')
+    end
+  end
+  
+  context "#build_gravatar_url, with options" do
+    should "add well known options like size, rating or default and always in alphabetical order" do
+      assert_equal "http://0.gravatar.com/avatar/1cacf1bc403efca2e7a58bcfa9574e4d.jpg?s=16", build_gravatar_url('bella@gmail.com', :size => 16)
+      assert_equal "http://0.gravatar.com/avatar/1cacf1bc403efca2e7a58bcfa9574e4d.jpg?d=http%3A%2F%2Fexample.com%2Ftest.jpg&s=20",
+                   build_gravatar_url('bella@gmail.com', :size => 20, :default => 'http://example.com/test.jpg')
+      assert_equal "http://0.gravatar.com/avatar/1cacf1bc403efca2e7a58bcfa9574e4d.jpg?other=escaped%26yes%3F&r=x&s=30",
+                   build_gravatar_url('bella@gmail.com', :size => 30, :rating => :x, :other => "escaped&yes?")
+    end
+    
+    should "ensure that all options as well as keys are escaped correctly" do
+      assert_equal "http://0.gravatar.com/avatar/1cacf1bc403efca2e7a58bcfa9574e4d.jpg?escaped%2Fme=escaped%2Fme",
+                   build_gravatar_url('bella@gmail.com', 'escaped/me' => 'escaped/me')
+    end
+    
+    should "ignore false or nil options" do
+      assert_equal "http://0.gravatar.com/avatar/1cacf1bc403efca2e7a58bcfa9574e4d.jpg?s=24",
+                    build_gravatar_url('bella@gmail.com', :s => 24, :invalid => false, :other => nil)
+    end
+    
+    should "allow different :filetype to be set, like 'gif' or 'png'" do
+      assert_equal "http://0.gravatar.com/avatar/1cacf1bc403efca2e7a58bcfa9574e4d.gif", build_gravatar_url('bella@gmail.com', :filetype => :gif)
+      assert_equal "http://0.gravatar.com/avatar/1cacf1bc403efca2e7a58bcfa9574e4d.png", build_gravatar_url('bella@gmail.com', :filetype => :png)
+    end
+  
+    should "handle Procs as :default, to easily generate default urls based on supplied :size" do
+      default = Proc.new { |o| "http://example.com/gravatar#{o[:size] ? '-' + o[:size].to_s : ''}.jpg" }
+      assert_equal "http://0.gravatar.com/avatar/1cacf1bc403efca2e7a58bcfa9574e4d.jpg?d=http%3A%2F%2Fexample.com%2Fgravatar.jpg",
+                    build_gravatar_url('bella@gmail.com', :default => default)        
+      assert_equal "http://0.gravatar.com/avatar/1cacf1bc403efca2e7a58bcfa9574e4d.jpg?d=http%3A%2F%2Fexample.com%2Fgravatar-25.jpg&s=25",
+                    build_gravatar_url('bella@gmail.com', :size => 25, :d => default)
+      assert_equal "http://0.gravatar.com/avatar/1cacf1bc403efca2e7a58bcfa9574e4d.jpg?d=http%3A%2F%2Fexample.com%2Fgravatar-20.jpg&s=20",
+                    build_gravatar_url('bella@gmail.com', :size => 20, 'd' => default)
+    end    
+  end
+  
+  context "#build_gravatar_url when passed in an object" do
+    should "look for :email method and use it to generate build_gravatar_url from" do
+      obj = Object.new
+      mock(obj).email { "bella@gmail.com" }
+      
+      assert_equal "http://0.gravatar.com/avatar/1cacf1bc403efca2e7a58bcfa9574e4d.jpg", build_gravatar_url(obj)
+    end
+    
+    should "look for :mail of field :email does not exist" do
+      obj = Object.new
+      mock(obj).mail { "bella@gmail.com" }
+      
+      assert_equal "http://0.gravatar.com/avatar/1cacf1bc403efca2e7a58bcfa9574e4d.jpg", build_gravatar_url(obj)      
+    end
+    
+    should "finally just use to_s... if neither :email nor :mail exists" do
+      obj = Object.new
+      mock(obj).to_s { "bella@gmail.com" }
+      
+      assert_equal "http://0.gravatar.com/avatar/1cacf1bc403efca2e7a58bcfa9574e4d.jpg", build_gravatar_url(obj)      
+    end
+  end
+  
+  context "Gravatar hosts support" do
+    should "switch to different hosts based on generated email hash, yet always the same for consecutive calls with the same email!" do
+      assert_equal "http://0.gravatar.com/avatar/1cacf1bc403efca2e7a58bcfa9574e4d.jpg", build_gravatar_url('bella@gmail.com')
+      assert_equal build_gravatar_url('bella@gmail.com'), build_gravatar_url('bella@gmail.com')
+      assert_equal "http://1.gravatar.com/avatar/41d86cad3dd465d6913d5a3232744441.jpg", build_gravatar_url('bella@bella.com')
+      assert_equal "http://2.gravatar.com/avatar/8f3af64e9c215d158b062a7b154e071e.jpg", build_gravatar_url('bella@hotmail.com')
+      assert_equal "http://www.gravatar.com/avatar/d2279c22a33da2cb57defd21c33c8ec5.jpg", build_gravatar_url('bella@yahoo.de')
+    end
+    
+    should "switch to https://secure.gravatar.com if :secure => true is supplied" do
+      assert_equal "https://secure.gravatar.com/avatar/1cacf1bc403efca2e7a58bcfa9574e4d.jpg", build_gravatar_url('bella@gmail.com', :secure => true)
+      assert_equal "https://secure.gravatar.com/avatar/41d86cad3dd465d6913d5a3232744441.jpg", build_gravatar_url('bella@bella.com', :secure => true)
+      assert_equal "https://secure.gravatar.com/avatar/d2279c22a33da2cb57defd21c33c8ec5.jpg", build_gravatar_url('bella@yahoo.de', :secure => true)
+    end
+    
+    should "allow Procs for :secure option, enables pretty cool stuff for stuff like request.ssl?" do
+      Gravatarify.options[:secure] = Proc.new { |request| request.respond_to?(:ssl?) ? request.ssl? : false }
+      
+      mock_ssl = MockView.new
+      mock(mock_ssl).request.stub!.ssl? { true }      
+      assert_equal "https://secure.gravatar.com/avatar/1cacf1bc403efca2e7a58bcfa9574e4d.jpg", mock_ssl.build_gravatar_url('bella@gmail.com')
+      
+      mock_no_ssl = MockView.new
+      mock(mock_no_ssl).request.stub!.ssl? { false }
+      assert_equal "http://0.gravatar.com/avatar/1cacf1bc403efca2e7a58bcfa9574e4d.jpg", mock_no_ssl.build_gravatar_url('bella@gmail.com')
+    end
+  end
+    
+  context "Gravatarify#options" do
+    setup do
+      Gravatarify.options[:anything] = "test"
+      Gravatarify.options[:filetype] = "png"
+      Gravatarify.options[:default] = "http://example.com/gravatar.jpg"
+    end
+    
+    should "ensure that default options are always added" do
+      assert_equal "http://0.gravatar.com/avatar/1cacf1bc403efca2e7a58bcfa9574e4d.png?anything=test&d=http%3A%2F%2Fexample.com%2Fgravatar.jpg",
+                    build_gravatar_url('bella@gmail.com')
+    end
+    
+    should "ensure that default options can be overriden by passing options into build_gravatar_url call" do
+      assert_equal "http://0.gravatar.com/avatar/1cacf1bc403efca2e7a58bcfa9574e4d.gif?anything=else&d=http%3A%2F%2Fexample.com%2Fgravatar.jpg",
+                    build_gravatar_url('bella@gmail.com', :anything => "else", :filetype => :gif)
+    end
+  end
+end

data/test/gravatarify_integration_test.rb

@@ -0,0 +1,63 @@
+require 'test_helper'
+begin; require 'activerecord'; rescue LoadError; end
+begin; require 'dm-core'; rescue LoadError; end
+require 'gravatarify'
+
+class GravatarifyIntegrationTest < Test::Unit::TestCase
+  def setup; Gravatarify.options.clear end
+
+  context "ActiveRecord::Base" do
+    if defined?(ActiveRecord)    
+      should "include Gravatarify::ObjectSupport" do
+        assert ActiveRecord::Base.included_modules.include?(Gravatarify::ObjectSupport)
+      end
+    
+      should "respond to #gravatarify" do
+        assert_respond_to ActiveRecord::Base, :gravatarify
+      end
+    else
+      context "tests" do
+        should "be run (but looks like ActiveRecord is not available)" do
+          flunk "ActiveRecord not available -> thus tests are incomplete (error can be ignored though!)"          
+        end
+      end      
+    end
+  end
+  
+  context "DataMapper model (User)" do      
+    if defined?(DataMapper)             
+      setup do
+        class User
+          include DataMapper::Resource
+          property :id, Serial
+          property :name, String
+          property :email, String
+          property :author_email, String
+          
+          gravatarify
+        end
+      end
+      
+      should "include Gravatarify::ObjectSupport" do
+        assert User.included_modules.include?(Gravatarify::ObjectSupport)
+      end
+      
+      should "respond to #gravatarify" do
+        assert_respond_to User, :gravatarify
+      end
+      
+      context "as instance" do
+        should "be able to build correct gravatar_url's!" do
+          u = User.new(:email => "peter.gibbons@initech.com")
+          assert_equal "http://0.gravatar.com/avatar/cb7865556d41a3d800ae7dbb31d51d54.jpg", u.gravatar_url
+        end
+      end
+    else
+      context "tests" do
+        should "be run (but looks like DataMapper is not available)" do
+          flunk "DataMapper not available -> thus tests are incomplete (error can be ignored though!)"
+        end
+      end
+    end
+  end
+end

data/test/gravatarify_object_support_test.rb

@@ -0,0 +1,99 @@
+require 'test_helper'
+require 'gravatarify/base'
+require 'gravatarify/object_support'
+
+class GravatarifyObjectSupportTest < Test::Unit::TestCase
+  def setup; Gravatarify.options.clear end
+  
+  context "#gravatarify" do
+    should "add support for #gravatar_url to POROs (plain old ruby objects, yeah POJO sounds better!)" do
+      poro = Class.new do
+        include Gravatarify::ObjectSupport
+        gravatarify
+        def email; "mike@shiva.ch" end
+      end
+      assert_equal "http://0.gravatar.com/avatar/1b2818d77eadd6c9dbbe7f3beb1492c3.jpg", poro.new.gravatar_url
+      assert_equal "https://secure.gravatar.com/avatar/1b2818d77eadd6c9dbbe7f3beb1492c3.jpg", poro.new.gravatar_url(:secure => true)
+      assert_equal "http://0.gravatar.com/avatar/1b2818d77eadd6c9dbbe7f3beb1492c3.gif?r=x&s=16", poro.new.gravatar_url(:filetype => :gif, :rating => :x, :size => 16)
+    end
+    
+    should "allow some default options to be passed, which can be overriden locally, though" do
+      poro = Class.new do
+        include Gravatarify::ObjectSupport
+        gravatarify :secure => true, :filetype => :gif
+        def email; "mike@shiva.ch" end
+      end
+      assert_equal "https://secure.gravatar.com/avatar/1b2818d77eadd6c9dbbe7f3beb1492c3.gif", poro.new.gravatar_url
+      assert_equal "http://0.gravatar.com/avatar/1b2818d77eadd6c9dbbe7f3beb1492c3.gif", poro.new.gravatar_url(:secure => false)
+      assert_equal "https://secure.gravatar.com/avatar/1b2818d77eadd6c9dbbe7f3beb1492c3.jpg?r=x&s=16", poro.new.gravatar_url(:filetype => :jpg, :rating => :x, :size => 16)      
+    end
+    
+    should "still respect options set by Gravatarify#options" do
+      Gravatarify.options[:size] = 20
+      poro = Class.new do
+        include Gravatarify::ObjectSupport
+        gravatarify
+        def email; "mike@shiva.ch" end
+      end
+      assert_equal "http://0.gravatar.com/avatar/1b2818d77eadd6c9dbbe7f3beb1492c3.jpg?s=20", poro.new.gravatar_url
+    end
+    
+    should "be able to override options set by Gravatarify#options" do
+      Gravatarify.options[:size] = 20
+      poro = Class.new do
+        include Gravatarify::ObjectSupport
+        gravatarify :size => 25
+        def email; "mike@shiva.ch" end
+      end
+      assert_equal "http://0.gravatar.com/avatar/1b2818d77eadd6c9dbbe7f3beb1492c3.jpg?s=25", poro.new.gravatar_url
+    end    
+  end
+  
+  context "#gravatarify with custom fields" do
+    should "detect and use the 'email' field automatically" do
+      poro = Class.new do
+        include Gravatarify::ObjectSupport
+        gravatarify
+        def email; "mike@shiva.ch" end
+      end
+      assert_equal "http://0.gravatar.com/avatar/1b2818d77eadd6c9dbbe7f3beb1492c3.jpg", poro.new.gravatar_url
+    end
+    
+    should "fallback to 'mail' if 'email' is not defined" do
+      poro = Class.new do
+        include Gravatarify::ObjectSupport
+        gravatarify
+        def mail; "mike@shiva.ch" end
+      end
+      assert_equal "http://0.gravatar.com/avatar/1b2818d77eadd6c9dbbe7f3beb1492c3.jpg", poro.new.gravatar_url      
+    end
+    
+    should "raise NoMethodError if object does not respond to source" do
+      poro = Class.new do
+        include Gravatarify::ObjectSupport
+        gravatarify
+      end
+      assert_raise(NoMethodError) { poro.new.gravatar_url }
+    end
+    
+    should "allow to set custom source, like author_email" do
+      poro = Class.new do
+        include Gravatarify::ObjectSupport
+        gravatarify :author_email
+        def author_email; "mike@shiva.ch" end
+      end
+      assert_equal "http://0.gravatar.com/avatar/1b2818d77eadd6c9dbbe7f3beb1492c3.jpg", poro.new.gravatar_url      
+    end
+    
+    should "allow multiple sources to be defined, yet still handle options!" do
+      poro = Class.new do
+        include Gravatarify::ObjectSupport
+        gravatarify :email, :employee_email, :default => Proc.new { |o| "http://initech.com/avatar-#{o[:size] || 80}.jpg" }
+        def email; "info@initech.com" end
+        def employee_email; "peter.gibbons@initech.com" end
+      end
+      assert_equal "http://2.gravatar.com/avatar/4979dd9653e759c78a81d4997f56bae2.jpg?d=http%3A%2F%2Finitech.com%2Favatar-20.jpg&s=20", poro.new.gravatar_url(:size => 20)
+      assert_equal "http://0.gravatar.com/avatar/cb7865556d41a3d800ae7dbb31d51d54.jpg?d=http%3A%2F%2Finitech.com%2Favatar-25.jpg&s=25", poro.new.employee_gravatar_url(:size => 25)
+    end
+  end
+end

data/test/gravatarify_view_helper_test.rb

@@ -0,0 +1,46 @@
+require 'test_helper'
+require 'active_support'
+require 'action_view/helpers'
+require 'gravatarify/view_helper'
+
+class GravatarifyViewHelperTest < Test::Unit::TestCase
+  include ActionView::Helpers
+  include Gravatarify::ViewHelper  
+  
+  def setup
+    # just ensure that no global options are defined when starting next test
+    Gravatarify.options.clear
+  end
+  
+  context "#gravatar_tag helper" do
+    should "create <img/> tag with correct gravatar urls" do
+      assert_equal '<img alt="bella@gmail.com" height="80" src="http://0.gravatar.com/avatar/1cacf1bc403efca2e7a58bcfa9574e4d.jpg" width="80" />',
+                      gravatar_tag('bella@gmail.com')
+    end
+    
+    should "create <img/> tags and handle all options correctly, other options should be passed to Rails' image_tag" do
+      assert_equal '<img alt="bella@gmail.com" height="16" src="http://0.gravatar.com/avatar/1cacf1bc403efca2e7a58bcfa9574e4d.jpg?s=16" width="16" />',
+              gravatar_tag('bella@gmail.com', :size => 16)
+      assert_equal '<img alt="bella@gmail.com" class="gravatar" height="16" src="http://0.gravatar.com/avatar/1cacf1bc403efca2e7a58bcfa9574e4d.jpg?s=16" width="16" />',
+              gravatar_tag('bella@gmail.com', :class => "gravatar", :size => 16)
+    end
+  end
+  
+  context "#gravatar_tag when passed in an object" do
+    should "create <img/>-tag based on :email field" do
+      obj = Object.new
+      mock(obj).email.times(2) { "bella@gmail.com" }
+      
+      assert_equal '<img alt="bella@gmail.com" height="80" src="http://0.gravatar.com/avatar/1cacf1bc403efca2e7a58bcfa9574e4d.jpg" width="80" />',
+                      gravatar_tag(obj)      
+    end
+    
+    should "create <img/>-tag based on gravatar_url from object if object responds to gravatar_url" do
+      obj = Object.new
+      mock(obj).gravatar_url({ :size => 16 }) { "http://0.gravatar.com/avatar/1cacf1bc403efca2e7a58bcfa9574e4d.jpg?s=16" }
+      
+      assert_equal '<img alt="Gravatar" height="16" src="http://0.gravatar.com/avatar/1cacf1bc403efca2e7a58bcfa9574e4d.jpg?s=16" width="16" />',
+                      gravatar_tag(obj, :size => 16, :alt => "Gravatar")
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'rr'
+
+Test::Unit::TestCase.send :include, RR::Adapters::TestUnit

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: gravatarify
+version: !ruby/object:Gem::Version 
+  version: 0.6.0
+platform: ruby
+authors: 
+- Lukas Westermann
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-29 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: 
+email: lukas.westermann@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- VERSION.yml
+- init.rb
+- lib/gravatarify.rb
+- lib/gravatarify/base.rb
+- lib/gravatarify/object_support.rb
+- lib/gravatarify/view_helper.rb
+- test/gravatarify_base_test.rb
+- test/gravatarify_integration_test.rb
+- test/gravatarify_object_support_test.rb
+- test/gravatarify_view_helper_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/lwe/gravatarify
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Gravatar URLs for your ruby
+test_files: 
+- test/gravatarify_base_test.rb
+- test/gravatarify_integration_test.rb
+- test/gravatarify_object_support_test.rb
+- test/gravatarify_view_helper_test.rb
+- test/test_helper.rb