jro_apps/redmine Commit - r2727:560e915c50e8

Upgraded the gravatar plugin from http://github.com/woods/gravatar-plugin...

Eric Davis -

r2727:560e915c50e8

parent child

Context file:

r2727:560e915c50e8

Collapse all files

vendor/plugins/gravatar/.gitignore created 644 +1 0

	@@ -0,0 +1,1
				1	coverage

vendor/plugins/gravatar/README.rdoc ~~vendor/plugins/gravatar/README~~ renamed +6 -3

             == Gravatar Plugin
             This plugin provides a handful of view helpers for displaying gravatars
             (globally-recognized avatars).
             Gravatars allow users to configure an avatar to go with their email address at
             a central location: http://gravatar.com. Gravatar-aware websites (such
             as yours) can then look up and display each user's preferred avatar, without
             having to handle avatar management. The user gets the benefit of not having to
             set up an avatar for each site that they post on.
             == Installation
               cd ~/myapp
-              ruby script/plugin install svn://rubyforge.org//var/svn/gravatarplugin/plugins/gravatar
+              ruby script/plugin install git://github.com/woods/gravatar-plugin.git
             or, if you're using piston[http://piston.rubyforge.org] (worth it!):
               cd ~/myapp/vendor/plugins
-              piston import svn://rubyforge.org//var/svn/gravatarplugin/plugins/gravatar
+              piston import git://github.com/woods/gravatar-plugin.git
             == Example
             If you represent your users with a model that has an +email+ method (typical
             for most rails authentication setups), then you can simply use this method
             in your views:
               <%= gravatar_for @user %>
             This will be replaced with the full HTML +img+ tag necessary for displaying
             that user's gravatar.
             Other helpers are documented under GravatarHelper::PublicMethods.
             == Acknowledgments
+            Thanks to Magnus Bergmark (http://github.com/Mange), who contributed the SSL
+            support in this plugin, as well as a few minor fixes.
             The following people have also written gravatar-related Ruby libraries:
             * Seth Rasmussen created the gravatar gem[http://gravatar.rubyforge.org]
             * Matt McCray has also created a gravatar
               plugin[http://mattmccray.com/svn/rails/plugins/gravatar_helper]
             == Author
               Scott A. Woods
               West Arete Computing, Inc.
               http://westarete.com
               scott at westarete dot com
             == TODO
-            * Get full spec coverage
+            * Add specs for ssl support
             * Finish rdoc documentation

vendor/plugins/gravatar/Rakefile 0 -1

             require 'spec/rake/spectask'
             require 'rake/rdoctask'
             desc 'Default: run all specs'
             task :default => :spec
             desc 'Run all application-specific specs'
             Spec::Rake::SpecTask.new(:spec) do |t|
-              t.warning = true
               t.rcov = true
             end
             desc "Report code statistics (KLOCs, etc) from the application"
             task :stats do
               RAILS_ROOT = File.dirname(__FILE__)
               STATS_DIRECTORIES = [
                 %w(Libraries  lib/),
                 %w(Specs      spec/),
               ].collect { |name, dir| [ name, "#{RAILS_ROOT}/#{dir}" ] }.select { |name, dir| File.directory?(dir) }
               require 'code_statistics'
               CodeStatistics.new(*STATS_DIRECTORIES).to_s
             end
             namespace :doc do
               desc 'Generate documentation for the assert_request plugin.'
               Rake::RDocTask.new(:plugin) do |rdoc|
                 rdoc.rdoc_dir = 'rdoc'
                 rdoc.title    = 'Gravatar Rails Plugin'
                 rdoc.options << '--line-numbers' << '--inline-source' << '--accessor' << 'cattr_accessor=rw'
                 rdoc.rdoc_files.include('README')
                 rdoc.rdoc_files.include('lib/**/*.rb')
               end
             end

vendor/plugins/gravatar/about.yml +2 -2

             author: Scott Woods, West Arete Computing
             summary: View helpers for displaying gravatars.
-            homepage: http://gravatarplugin.rubyforge.org/
+            homepage: http://github.com/woods/gravatar-plugin/
-            plugin: svn://rubyforge.org//var/svn/gravatarplugin/plugins/gravatar
+            plugin: git://github.com/woods/gravatar-plugin.git
             license: MIT
             version: 0.1
             rails_version: 1.0+

vendor/plugins/gravatar/lib/gravatar.rb +22 -4

             require 'digest/md5'
             require 'cgi'
             module GravatarHelper
               # These are the options that control the default behavior of the public
               # methods. They can be overridden during the actual call to the helper,
               # or you can set them in your environment.rb as such:
               #
               #   # Allow racier gravatars
               #   GravatarHelper::DEFAULT_OPTIONS[:rating] = 'R'
               #
               DEFAULT_OPTIONS = {
                 # The URL of a default image to display if the given email address does
                 # not have a gravatar.
                 :default => nil,
                 # The default size in pixels for the gravatar image (they're square).
                 :size => 50,
                 # The maximum allowed MPAA rating for gravatars. This allows you to
                 # exclude gravatars that may be out of character for your site.
                 :rating => 'PG',
-                # The alt text to use in the img tag for the gravatar.
+                # The alt text to use in the img tag for the gravatar.  Since it's a
-                :alt => 'avatar',
+                # decorational picture, the alt text should be empty according to the
+                # XHTML specs.
+                :alt => '',
                 # The class to assign to the img tag for the gravatar.
                 :class => 'gravatar',
+                # Whether or not to display the gravatars using HTTPS instead of HTTP
+                :ssl => false,
               }
               # The methods that will be made available to your views.
               module PublicMethods
                 # Return the HTML img tag for the given user's gravatar. Presumes that
                 # the given user object will respond_to "email", and return the user's
                 # email address.
                 def gravatar_for(user, options={})
                   gravatar(user.email, options)
                 end
                 # Return the HTML img tag for the given email address's gravatar.
                 def gravatar(email, options={})
                   src = h(gravatar_url(email, options))
                   options = DEFAULT_OPTIONS.merge(options)
                   [:class, :alt, :size].each { |opt| options[opt] = h(options[opt]) }
                   "<img class=\"#{options[:class]}\" alt=\"#{options[:alt]}\" width=\"#{options[:size]}\" height=\"#{options[:size]}\" src=\"#{src}\" />"
                 end
+                # Returns the base Gravatar URL for the given email hash. If ssl evaluates to true,
+                # a secure URL will be used instead. This is required when the gravatar is to be
+                # displayed on a HTTPS site.
+                def gravatar_api_url(hash, ssl=false)
+                  if ssl
+                    "https://secure.gravatar.com/avatar/#{hash}"
+                  else
+                    "http://www.gravatar.com/avatar/#{hash}"
+                  end
+                end
                 # Return the gravatar URL for the given email address.
                 def gravatar_url(email, options={})
                   email_hash = Digest::MD5.hexdigest(email)
                   options = DEFAULT_OPTIONS.merge(options)
                   options[:default] = CGI::escape(options[:default]) unless options[:default].nil?
-                  returning "http://www.gravatar.com/avatar.php?gravatar_id=#{email_hash}" do |url|
+                  returning gravatar_api_url(email_hash, options.delete(:ssl)) do |url|
+                    opts = []
                     [:rating, :size, :default].each do |opt|
                       unless options[opt].nil?
                         value = h(options[opt])
-                        url << "&#{opt}=#{value}"
+                        opts << [opt, value].join('=')
                       end
                     end
+                    url << "?#{opts.join('&')}" unless opts.empty?
                   end
                 end
               end
             end

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages