gravatarify 1.1.0 → 1.2.0

data/README.md

@@ -1,82 +1,101 @@
-# 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).
+Gravatarify
+===========
 
-And it integrates seamlessly with Rails, DataMapper and even plain old Ruby.
+Hassle-free construction of those pesky gravatar.com urls, with out-of-the-box support for
+Rails, DataMapper and Haml. It's not that there aren't 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).
 
 - **Source**: <http://github.com/lwe/gravatarify>
 - **Docs**:   <http://rdoc.info/projects/lwe/gravatarify>
 - **Gem**:    <http://gemcutter.org/gems/gravatarify>
 
-## Install
+Ready, Set, Go!
+---------------
 
-Just install the gem (ensure you have gemcutter in your sources!)
+**READY** Install gravatarify as a gem (requires gemcutter):
 
     [sudo] gem install gravatarify
-   
-Ready to go! Using Rails? Either add as gem (in `config/environment.rb`):
-
-    config.gem 'gravatarify', :source => 'http://gemcutter.org'
     
-or install as Rails plugin:
-
+or as Rails plugin: 
+    
     ./script/plugin install git://github.com/lwe/gravatarify.git
     
-Of course it's also possible to just add the library onto the `$LOAD_PATH`
-and then `require 'gravatarify'` it.
+**SET** When using the Rails plugin, skip this step. Anyhow, just ensure that when installed as a gem
+it's bundled using `bundler` or defined in `config/environment.rb`, or just that it's on the `$LOAD_PATH`
+and then `require 'gravatarify'`'d somehow.
 
-# Usage
+**GO** Use it! When using Rails or Haml then just give it an email and it will return the gravatar url:
 
-This library provides...
+    # creates an 20x20 pixel <img/> tag in your Rails ERB views:
+    <%= gravatar_tag @user.email, :size => 20 %>
+    
+    # or in HAML views
+    # (Note: how it's possible to skip the email attribute, btw - that's a feature)
+    %img{ gravatar_attrs(@user, :size => 20) }/
+    
+**More!?** Allright, that was just the quickstart, to get up and running with ease. However, this library provides
+quite a bit more, like:
 
+ * ...view helpers, namely `gravatar_url` and `gravatar_tag`, see "Using the view helpers".
  * ...object/model helpers, so that an object responds to `gravatar_url`, see "Using the model helpers"
    Works also very well with plain old ruby objects.
- * ...Rails view helpers, namely `gravatar_url` and `gravatar_tag`, see "Using the view helpers". This is rails only though!
  * ...and finally, a base module which provides the gravatar url generation, ready to be integrated into
    custom helpers, plain ruby code or whatever, see "Back to the roots".
 
-## Using the view helpers (Rails only!)
+Using the view helpers
+----------------------
 
-Probably one of the easiest ways to add support for gravatar images is with the included view helpers:
+Probably one of the easiest ways to add support for gravatar images is with the included view helpers.
+When using Rails or HAML these should be automatically available, if not do something like:
 
-    <%= gravatar_tag @user %> # assumes @user has email or mail field!
+    # e.g. for Sinatra
+    helpers Gravatarify::Helper
 
-This builds a neat `<img/>`-tag, if you need to pass in stuff like the size etc. just:
+    # or include for Haml
+    Haml::Helpers.send(:include, Gravatarify::Helper)
 
-    <%= gravatar_tag @user, :size => 25, :rating => :x, :class => "gravatar" %>
+    # NOTE: basically just include the Gravatarify::Helper module
 
-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:
+This then provides three helper methods: `gravatar_url`, `gravatar_attrs` and `gravatar_tag`.
+To just build a simple `<img/>` tag, pass in an object (if it responds to `email` or `mail`)
+or a string containg the e-mail address:
 
-    <%= image_tag gravatar_url(@user.author_email, :size => 16), :size => "16x16",
-         :alt => @user.name, :class => "avatar avatar-16"}/
+    <%= gravatar_tag @user %> # => assumes @user has email or mail field!
 
-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.
+This builds a neat `<img/>`-tag. To display an "X" rated avatar which is 25x25 pixel in size
+and the `<img/>` tag should have a class attribute, do:
 
-## Using the model helpers
+    <%= gravatar_tag @user, :size => 25, :rating => :x, :class => "gravatar" %>
+
+If more control is needed, or just the plain URL is required, resort to `gravatar_url`, which
+returns a string with the (unescaped) url:
+    
+    <img src="<%= h(gravatar_url(@user.author_email, :size => 16)) %>" alt="Gravatar"/>
+        
+Using the model helpers
+-----------------------
 
 A very simple method to add `gravatar_url` support to models is by using the `gravatarify` class method.
 
+    # Assuming User has a field named email or mail!
     class User < ActiveRecord::Base
-     gravatarify
+      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:
@@ -85,10 +104,10 @@ fact that an object can be passed directly to `gravatar_tag` if it responds to `
     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 :)
 
@@ -110,14 +129,14 @@ of `PoroUser`.
 
 No need for sophisticated stuff like view helpers and ActiveRecord integration, want to go back to the roots?
 Then feel free to use `Gravatarify::Base#build_gravatar_url` directly.
-
-For example, want to use `build_gravatar_url` in a Sinatra app?
-
-    helpers Gravatarify::Base
     
-Yeah, that should work :). See {Gravatarify::Base#build_gravatar_url} for more informations and usage examples.
+When the ability to display image tags is required in different view frameworks (like liquid!?),
+then just ensure that `Gravatarify::Helper` is included in the framework in question.
+See {Gravatarify::Base#build_gravatar_url} and of course {Gravatarify::Helper}
+for more informations and usage examples.
 
-## Need more control?
+Need more control?
+==================
 
 <table>
   <tr>
@@ -163,12 +182,23 @@ Yeah, that should work :). See {Gravatarify::Base#build_gravatar_url} for more i
   <tr>
     <td><tt>:filetype</tt></td>
     <td>String, Symbol</td>
-    <td>Change image type, gravatar.com supports <tt>:gif</tt>, <tt>:png</tt> and <tt>:jpg</tt>.</td>
+    <td>Change image type, gravatar.com supports <tt>:gif</tt>, <tt>:png</tt> and <tt>:jpg</tt>. If set to <tt>false</tt> 
+      then a URL without an extension will be built (and gravatar.com then returns a JPG image).</td>
     <td><tt>:jpg</tt></td>
   </tr>
 </table>
 
-## Not yet enough?
+To options globally, access the `Gravatarify.options` hash and set any options which should apply to all
+gravatar urls there. Of course all settings can be overridden locally:
+
+    # disable suffix and set default size to 16x16px
+    Gravatarify.options[:filetype] = false
+    Gravatarify.options[:size] = 16
+    
+    gravatar_url(@user.email) # => http://0.gravatar.com/avatar/..f93ff1e?s=16
+    gravatar_url(@user.email, :filetype => :png) # => http://0.gravatar.com/avatar/..f93ff1e.png?s=16
+
+### Not yet enough?
 
 The `:default` option can be passed in a `Proc`, so this is certainly useful to for example
 to generate an image url, based on the request size:
@@ -195,7 +225,8 @@ Into the block is passed the options hash and as second parameter the object its
 Not only the `:default` option accepts a Proc, but also `:secure`, can be useful to handle cases where
 it should evaluate against `request.ssl?` for example.
 
-## About the code
+About the code
+==============
 
 Eventhough this library has less than 100 LOC, it's split into four files, maybe a bit
 of an overkill, though I like neat and tidy classes :)
@@ -214,9 +245,16 @@ of an overkill, though I like neat and tidy classes :)
                                             # gravatarify class method to add a gravatar_url
                                             # to any object.
                                             
-    lib/gravatarify/view_helper.rb          # Defines rails view helpers.
+    lib/gravatarify/helper.rb               # Defines those view helpers, mainly gravatar_tag
+    
+### Contribute
+
+ 1. Fork the project and hack away
+ 2. Ensure that the changes are well tested
+ 3. Send me a pull request
 
-## Licence
+Licence
+=======
 
 Copyright (c) 2009 Lukas Westermann
 

data/Rakefile

@@ -64,7 +64,7 @@ namespace :metrics do
     require 'code_statistics'
     dirs = {
       'Libraries' => 'lib',
-      'Unit tests' => 'test'
+      'Unit tests' => 'test/unit'
     }.map { |name,dir| [name, File.join(File.dirname(__FILE__), dir)] }
     CodeStatistics.new(*dirs).to_s
   end
@@ -73,7 +73,7 @@ namespace :metrics do
   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 )
+    rcov = %(rcov -Ilib:test --exclude '\/gems\/' -o doc/coverage -T test/unit/*_test.rb )
     system rcov
   end
   

data/VERSION.yml

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

data/lib/gravatarify.rb

@@ -4,8 +4,12 @@
 # custom implementations, just include Gravatarify::Base.
 require 'gravatarify/base'
 require 'gravatarify/object_support'
+require 'gravatarify/helper'
 
 # 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)
+
+# and HAML support (if defined)
+Haml::Helpers.send(:include, Gravatarify::Helper) if defined?(Haml)

data/lib/gravatarify/base.rb

@@ -32,6 +32,9 @@ module Gravatarify
     #     # or set a custom default rating
     #     Gravatarify.options[:rating] = :R
     #
+    #     # or disable adding an extension
+    #     Gravatarify.options[:filetype] = false
+    #
     def options; @options ||= {} end
   
     # Globally overide subdomains used to build gravatar urls, normally
@@ -57,7 +60,12 @@ module Gravatarify
     # defined.
     def subdomain(str); subdomains[str.hash % subdomains.size] || GRAVATAR_DEFAULT_SUBDOMAIN end
     
-    def escape(str); defined?(Rack::Utils) ? Rack::Utils.escape(str) : CGI.escape(str) end
+    # Helper method to escape string using either <tt>Rack::Utils</tt> if available or else
+    # fallback to <tt>CGI#escape</tt>.
+    def escape(str)
+      str = str.to_s unless str.is_a?(String) # convert to string!
+      defined?(Rack::Utils) ? Rack::Utils.escape(str) : CGI.escape(str)
+    end
   end
   
   # Provides core support to build gravatar urls based on supplied e-mail strings.
@@ -103,9 +111,8 @@ module Gravatarify
       # 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(email, url_options)}"
+      extension = url_options[:filetype] == false ? '' : ".#{url_options.delete(:filetype) || GRAVATAR_DEFAULT_FILETYPE}"
+      build_gravatar_host(email_hash, url_options.delete(:secure)) << "/avatar/#{email_hash}#{extension}#{build_gravatar_options(email, url_options)}"
     end
   
     private
@@ -128,7 +135,7 @@ module Gravatarify
         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, source.is_a?(String) ? self : source) if key.to_s == 'd' and value.respond_to?(:call)
-          params << "#{Gravatarify.escape(key.to_s)}=#{Gravatarify.escape(value.to_s)}" if value
+          params << "#{Gravatarify.escape(key)}=#{Gravatarify.escape(value)}" if value
         end
         "?#{params.sort * '&'}" unless params.empty?
       end

data/lib/gravatarify/helper.rb

@@ -0,0 +1,32 @@
+module Gravatarify::Helper
+  # so that it's possible to access that build_gravatar_url method
+  include Gravatarify::Base
+  
+  # to simplify things a bit and have a neat-o naming
+  alias_method :gravatar_url, :build_gravatar_url
+  
+  # Helper method for HAML to return a neat hash to be used as attributes in an image tag.
+  #
+  # Now it's as simple as doing something like:
+  #
+  #    %img{ gravatar_attrs(@user.mail, :size => 20) }/
+  #
+  def gravatar_attrs(email, options = {})
+    url_options = options.reject { |key, value| !Gravatarify::GRAVATAR_OPTIONS.include?(key) }
+    options = options.delete_if { |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
+    options[:src] = email.respond_to?(:gravatar_url) ? email.gravatar_url(url_options) : build_gravatar_url(email, url_options)
+    options
+  end
+  
+  # Takes care of creating an <tt><img/></tt>-tag based on a gravatar url, it no longer
+  # makes use of any Rails helper, so is totally useable in any other library.
+  def gravatar_tag(email, options = {})
+    html_attrs = gravatar_attrs(email, options).map do |key,value|
+      escaped = defined?(Rack::Utils) ? Rack::Utils.escape_html(value) : CGI.escapeHTML(value)
+      "#{key}=\"#{escaped}\""
+    end.sort.join(" ")
+    "<img #{html_attrs} />"
+  end
+end

data/rails/init.rb

@@ -1,7 +1,4 @@
 require 'gravatarify'
 
-# load view helpers only if ActionView is available
-if defined?(ActionView)
-  require 'gravatarify/view_helper'
-  ActionView::Base.send(:include, Gravatarify::ViewHelper)
-end
+# include view helpers only if ActionView is available
+ActionView::Base.send(:include, Gravatarify::Helper) if defined?(ActionView)

data/test/test_helper.rb

@@ -3,10 +3,20 @@ require 'test/unit'
 require 'shoulda'
 require 'rr'
 
+require 'active_support'
+begin; require 'activerecord'; rescue LoadError; end
+begin; require 'dm-core'; rescue LoadError; end
+require 'gravatarify'
+
 Test::Unit::TestCase.send :include, RR::Adapters::TestUnit
 
 # Reset +Gravatarify+ to default hosts and cleared options
 def reset_gravatarify!
   Gravatarify.options.clear
   Gravatarify.subdomains = Gravatarify::GRAVATAR_SUBDOMAINS
-end
+end
+
+# some often used values...
+BELLA_AT_GMAIL = "http://0.gravatar.com/avatar/1cacf1bc403efca2e7a58bcfa9574e4d"
+BELLA_AT_GMAIL_JPG = "#{BELLA_AT_GMAIL}.jpg"
+NIL_JPG = "http://1.gravatar.com/avatar/d41d8cd98f00b204e9800998ecf8427e.jpg"

data/test/{gravatarify_integration_test.rb → unit/gravatarify_ar_dm_test.rb}

@@ -1,9 +1,6 @@
 require 'test_helper'
-begin; require 'activerecord'; rescue LoadError; end
-begin; require 'dm-core'; rescue LoadError; end
-require 'gravatarify'
 
-class GravatarifyIntegrationTest < Test::Unit::TestCase
+class GravatarifyArDmTest < Test::Unit::TestCase
   def setup; reset_gravatarify! end
 
   context "ActiveRecord::Base" do

data/test/{gravatarify_base_test.rb → unit/gravatarify_base_test.rb}

@@ -1,5 +1,4 @@
 require 'test_helper'
-require 'gravatarify/base'
 
 class MockView
   include Gravatarify::Base
@@ -12,53 +11,51 @@ class GravatarifyBaseTest < Test::Unit::TestCase
     
   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')
+      assert_equal BELLA_AT_GMAIL_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")
+      assert_equal BELLA_AT_GMAIL_JPG, build_gravatar_url("\tbella@gmail.com \n\t")
+      assert_equal BELLA_AT_GMAIL_JPG, build_gravatar_url("BELLA@gmail.COM")
+      assert_equal BELLA_AT_GMAIL_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('')
+      assert_equal NIL_JPG, build_gravatar_url(nil)
+      assert_equal NIL_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?")
+      assert_equal "#{BELLA_AT_GMAIL_JPG}?s=16", build_gravatar_url('bella@gmail.com', :size => 16)
+      assert_equal "#{BELLA_AT_GMAIL_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 "#{BELLA_AT_GMAIL_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')
+      assert_equal "#{BELLA_AT_GMAIL_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)
+      assert_equal "#{BELLA_AT_GMAIL_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)
+      assert_equal "#{BELLA_AT_GMAIL}.gif", build_gravatar_url('bella@gmail.com', :filetype => :gif)
+      assert_equal "#{BELLA_AT_GMAIL}.png", build_gravatar_url('bella@gmail.com', :filetype => :png)
     end
   
+    should "skip :filetype if set to false" do
+      assert_equal "#{BELLA_AT_GMAIL}", build_gravatar_url('bella@gmail.com', :filetype => false)      
+      assert_equal "#{BELLA_AT_GMAIL_JPG}", build_gravatar_url('bella@gmail.com', :filetype => nil)      
+    end
+    
     should "handle Procs as :default, to easily generate default urls based on supplied :size" do
       default = Proc.new { |*args| "http://example.com/gravatar#{args.first[:size] ? '-' + args.first[: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)
+      assert_equal "#{BELLA_AT_GMAIL_JPG}?d=http%3A%2F%2Fexample.com%2Fgravatar.jpg", build_gravatar_url('bella@gmail.com', :default => default)        
+      assert_equal "#{BELLA_AT_GMAIL_JPG}?d=http%3A%2F%2Fexample.com%2Fgravatar-25.jpg&s=25", build_gravatar_url('bella@gmail.com', :size => 25, :d => default)
+      assert_equal "#{BELLA_AT_GMAIL_JPG}?d=http%3A%2F%2Fexample.com%2Fgravatar-20.jpg&s=20", build_gravatar_url('bella@gmail.com', :size => 20, 'd' => default)
     end    
   end
   
@@ -67,21 +64,21 @@ class GravatarifyBaseTest < Test::Unit::TestCase
       obj = Object.new
       mock(obj).email { "bella@gmail.com" }
       
-      assert_equal "http://0.gravatar.com/avatar/1cacf1bc403efca2e7a58bcfa9574e4d.jpg", build_gravatar_url(obj)
+      assert_equal BELLA_AT_GMAIL_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)      
+      assert_equal BELLA_AT_GMAIL_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)      
+      assert_equal BELLA_AT_GMAIL_JPG, build_gravatar_url(obj)      
     end
     
     should "handle Procs as :default and pass in the 'object' as second parameter" do
@@ -89,7 +86,7 @@ class GravatarifyBaseTest < Test::Unit::TestCase
       girl = Object.new
       mock(girl).email { "bella@gmail.com" }
       mock(girl).female? { true }      
-      assert_equal "http://0.gravatar.com/avatar/1cacf1bc403efca2e7a58bcfa9574e4d.jpg?d=http%3A%2F%2Fexample.com%2Fgravatar_girl.jpg", build_gravatar_url(girl, :default => default)
+      assert_equal "#{BELLA_AT_GMAIL_JPG}?d=http%3A%2F%2Fexample.com%2Fgravatar_girl.jpg", build_gravatar_url(girl, :default => default)
       
       boy = Object.new
       mock(boy).email { "hans@gmail.com" }
@@ -122,7 +119,7 @@ class GravatarifyBaseTest < Test::Unit::TestCase
       
       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')
+      assert_equal BELLA_AT_GMAIL_JPG, mock_no_ssl.build_gravatar_url('bella@gmail.com')
     end
   end
     
@@ -134,13 +131,17 @@ class GravatarifyBaseTest < Test::Unit::TestCase
     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')
+      assert_equal "#{BELLA_AT_GMAIL}.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)
+      assert_equal "#{BELLA_AT_GMAIL}.gif?anything=else&d=http%3A%2F%2Fexample.com%2Fgravatar.jpg", build_gravatar_url('bella@gmail.com', :anything => "else", :filetype => :gif)
+    end
+    
+    should "ensure that no filetypes are added when :filetype set to false, unless locally specified" do
+      Gravatarify.options[:filetype] = false
+      assert_equal "#{BELLA_AT_GMAIL}?anything=test&d=http%3A%2F%2Fexample.com%2Fgravatar.jpg", build_gravatar_url('bella@gmail.com')
+      assert_equal "#{BELLA_AT_GMAIL}.png?anything=test&d=http%3A%2F%2Fexample.com%2Fgravatar.jpg", build_gravatar_url('bella@gmail.com', :filetype => 'png')
     end
   end
 end

data/test/unit/gravatarify_helper_test.rb

@@ -0,0 +1,78 @@
+require 'test_helper'
+require 'gravatarify/helper'
+
+class GravatarifyHelpersTest < Test::Unit::TestCase
+  include Gravatarify::Helper  
+  
+  def setup
+    # just ensure that no global options are defined when starting next test
+    reset_gravatarify!
+  end
+
+  context "#gravatar_url" do
+    should "return same urls as build_gravatar_url" do
+      assert_equal BELLA_AT_GMAIL_JPG, gravatar_url('bella@gmail.com')
+      assert_equal "#{BELLA_AT_GMAIL_JPG}?d=x&s=16", gravatar_url('bella@gmail.com', :d => 'x', :s => 16)      
+    end
+  end
+  
+  context "#gravatar_attrs" do
+    should "return hash with :height, :width, :alt and :src defined" do
+      hash = gravatar_attrs('bella@gmail.com', :size => 16)
+      assert_equal "#{BELLA_AT_GMAIL_JPG}?s=16", hash[:src]
+      assert_equal 16, hash[:width]
+      assert_equal 16, hash[:height]
+      assert_equal 'bella@gmail.com', hash[:alt]
+      assert_nil hash[:size]
+    end
+    
+    should "allow any param to be defined/overridden, except src, width and heigth" do
+      hash = gravatar_attrs('bella@gmail.com', :size => 20, :r => :x, :height => 40, :alt => 'bella', :id => 'test', :title => 'something', :class => 'gravatar')
+      assert_equal "#{BELLA_AT_GMAIL_JPG}?r=x&s=20", hash[:src]
+      assert_equal 20, hash[:width]
+      assert_equal 20, hash[:height]
+      assert_equal 'bella', hash[:alt]
+      assert_equal 'test', hash[:id]
+      assert_equal 'something', hash[:title]
+      assert_equal 'gravatar', hash[:class]
+      assert_nil hash[:size]
+      assert_nil hash[:r]
+    end
+  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?d=x&amp;s=16" width="16" />',
+              gravatar_tag('bella@gmail.com', :class => "gravatar", :size => 16, :d => "x")
+    end
+    
+    should "ensure that all values are correctly html-esacped!" do
+      assert_equal '<img alt="bella@gmail.com" height="80" src="http://0.gravatar.com/avatar/1cacf1bc403efca2e7a58bcfa9574e4d.jpg" title="&lt;&gt;" width="80" />',
+              gravatar_tag('bella@gmail.com', :title => '<>')
+    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/{gravatarify_object_support_test.rb → unit/gravatarify_object_support_test.rb}

@@ -1,6 +1,4 @@
 require 'test_helper'
-require 'gravatarify/base'
-require 'gravatarify/object_support'
 
 class PoroUser
   include Gravatarify::ObjectSupport

data/test/{gravatarify_rack_vs_cgi_test.rb → unit/gravatarify_rack_vs_cgi_test.rb}

@@ -1,9 +1,9 @@
 require 'test_helper'
-require 'gravatarify/base'
+require 'cgi'
 
 class GravatarifyRackVsCgiTest < Test::Unit::TestCase
   include Gravatarify::Base
-  
+
   # Reload Rack::Utils
   def teardown
     begin; require('rack/utils'); rescue LoadError; end
@@ -18,8 +18,7 @@ class GravatarifyRackVsCgiTest < Test::Unit::TestCase
     should "fallback to CGI#escape" do
       assert !defined?(Rack::Utils), 'Rack::Utils should no longer be defined'
       assert defined?(CGI), "CGI should be defined"
-      assert_equal "http://0.gravatar.com/avatar/1cacf1bc403efca2e7a58bcfa9574e4d.jpg?escaped%2Fme=escaped%2Fme",
-                   build_gravatar_url('bella@gmail.com', 'escaped/me' => 'escaped/me')
+      assert_equal "#{BELLA_AT_GMAIL_JPG}?escaped%2Fme=escaped%2Fme", build_gravatar_url('bella@gmail.com', 'escaped/me' => 'escaped/me')
     end
   end
 end

data/test/{gravatarify_subdomain_test.rb → unit/gravatarify_subdomain_test.rb}

@@ -1,5 +1,7 @@
 require 'test_helper'
-require 'gravatarify/base'
+require 'net/http'
+require 'net/https'
+require 'uri'
 
 class GravatarifySubdomainTest < Test::Unit::TestCase
   include Gravatarify::Base
@@ -32,5 +34,31 @@ class GravatarifySubdomainTest < Test::Unit::TestCase
       assert_equal "http://www.gravatar.com/avatar/4979dd9653e759c78a81d4997f56bae2.jpg", build_gravatar_url('info@initech.com')
       assert_equal "http://www.gravatar.com/avatar/d4489907918035d0bc6ff3f6c76e760d.jpg", build_gravatar_url('support@initech.com')      
     end
-  end  
+  end
+  
+  context "with Net::HTTP the gravatar.com subdomains" do
+    should "return an image of type image/jpeg" do
+      Gravatarify.subdomains.each do |subdomain|
+        response = Net::HTTP.get_response URI.parse("http://#{subdomain}.gravatar.com/avatar/4979dd9653e759c78a81d4997f56bae2.jpg")
+        assert_equal 200, response.code.to_i
+        assert_equal "image/jpeg", response.content_type
+      end
+    end
+    
+    should "not respond to 3.gravatar.com, if so add to subdomains dude!!!" do
+      assert_raises(SocketError) { Net::HTTP.get_response URI.parse('http://3.gravatar.com/avatar/4979dd9653e759c78a81d4997f56bae2.jpg') }
+    end
+    
+    should "respond to https://secure.gravatar.com/ urls as well" do
+      http = Net::HTTP.new('secure.gravatar.com', 443)
+      http.use_ssl = true
+      
+      # do not verify peer certificate (get rid of that warning dude!)
+      http.instance_variable_get('@ssl_context').verify_mode = OpenSSL::SSL::VERIFY_NONE
+      
+      response = http.get '/avatar/4979dd9653e759c78a81d4997f56bae2.jpg'
+      assert_equal 200, response.code.to_i
+      assert_equal "image/jpeg", response.content_type      
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: gravatarify
 version: !ruby/object:Gem::Version 
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Lukas Westermann
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-09 00:00:00 +02:00
+date: 2009-10-23 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -32,16 +32,16 @@ files:
 - init.rb
 - lib/gravatarify.rb
 - lib/gravatarify/base.rb
+- lib/gravatarify/helper.rb
 - lib/gravatarify/object_support.rb
-- lib/gravatarify/view_helper.rb
 - rails/init.rb
-- test/gravatarify_base_test.rb
-- test/gravatarify_integration_test.rb
-- test/gravatarify_object_support_test.rb
-- test/gravatarify_rack_vs_cgi_test.rb
-- test/gravatarify_subdomain_test.rb
-- test/gravatarify_view_helper_test.rb
 - test/test_helper.rb
+- test/unit/gravatarify_ar_dm_test.rb
+- test/unit/gravatarify_base_test.rb
+- test/unit/gravatarify_helper_test.rb
+- test/unit/gravatarify_object_support_test.rb
+- test/unit/gravatarify_rack_vs_cgi_test.rb
+- test/unit/gravatarify_subdomain_test.rb
 has_rdoc: true
 homepage: http://github.com/lwe/gravatarify
 licenses: 
@@ -71,10 +71,10 @@ signing_key:
 specification_version: 3
 summary: Awesome gravatar support for ruby (and rails).
 test_files: 
-- test/gravatarify_base_test.rb
-- test/gravatarify_integration_test.rb
-- test/gravatarify_object_support_test.rb
-- test/gravatarify_rack_vs_cgi_test.rb
-- test/gravatarify_subdomain_test.rb
-- test/gravatarify_view_helper_test.rb
 - test/test_helper.rb
+- test/unit/gravatarify_ar_dm_test.rb
+- test/unit/gravatarify_base_test.rb
+- test/unit/gravatarify_helper_test.rb
+- test/unit/gravatarify_object_support_test.rb
+- test/unit/gravatarify_rack_vs_cgi_test.rb
+- test/unit/gravatarify_subdomain_test.rb

data/lib/gravatarify/view_helper.rb

@@ -1,24 +0,0 @@
-# The view helper, especially for the +gravatar_tag+ helper, requires
-# rails!
-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_view_helper_test.rb

@@ -1,47 +0,0 @@
-require 'test_helper'
-require 'active_support'
-require 'action_view/helpers'
-require 'gravatarify'
-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
-    reset_gravatarify!
-  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