/ 
Template-Plugin-Gravatar-0.03
River stage one • 1 direct dependent • 1 total dependent
/ Template::Plugin::Gravatar

NAME

Template::Plugin::Gravatar - configurable generation of Gravatar URLs from email addresses.

VERSION

0.03

SYNOPSIS

[% USE Gravatar %]
[% FOR user IN user_list %]
 <img src="[% Gravatar( email => user.email ) | html %]"
   alt="[% user.name | html %]" />
[% END %]

# OR a mini CGI example
use strict;
use CGI qw( header start_html end_html );
use Template;

my %config = ( # ... your other config stuff
              GRAVATAR => { default => "/local/image.png",
                            size => 80,
                            rating => "R" },
              );

my $tt2 = Template->new(\%config);

my $user = { email => 'whatever@wherever.whichever',
             rating => "PG",
             name => "Manamana",
             size => 75 };

print header(), start_html();

$tt2->process(\*DATA, { user => $user })
    or warn $Template::ERROR;

print end_html();

__DATA__
[% USE Gravatar %] 
[% FILTER html %]
 <img src="[% Gravatar( user ) | html %]"
   alt="[% user.name | html %]" />
[% END %]

DESCRIPTION

Please see http://www.gravatar.com/implement.php for more on the service interface and http://www.gravatar.com/ for information about Gravatars (globally recognized avatars) in general.

All of the options supported in Gravatars--default, rating, size, and border--can be used here. The gravatar_id is generated from a given email.

INTERFACE/SETTINGS

new

Not called directly. Called when you USE the plugin. Takes defaults from the template config hash and mixes them with any per template defaults. E.g.,

[% USE Gravatar %]
Use config arguments if any.

[% USE Gravatar(default => '/local/default-image.png') %]
Mix config arguments, if any, with new instance arguments.

Arguments

email (required)

The key to using Gravatars is a hex hash of the user's email. This is generated automatically and sent to gravatar.com as the gravatar_id.

default (optional)

The local (any valid image URI) image to use if there is no Gravatar corresponding to the given email.

size (optional)

Gravatars are square. Size is 1 through 80 (pixels) and sets the width and the height.

rating (optional)

G|PG|R|X. The maximum rating of Gravatar you wish returned. If you have a family friendly forum, for example, you might set it to "G."

border (optional)

A hex color, e.g. FF00FF or F0F.

base (developer override)

This is allowed as a courtesy for the one or two developers who might need it. More below.

gravatar_id (not allowed)

This is not an option but a generated variable. It is an MD5 hex hash of the email address. The reason is it not supported as an optional variable is it would allow avatar hijacking.

The only argument that must be given when you call the Gravatar plugin is the email. Everything else -- rating, default image, border, and size -- can be set in three different places: the config, the USE call, or the Gravatar call. All three of the following produce the same Gravatar URL.

Settings via config

Used if the entire "site" should rely on one set of defaults.

use Template;
my %config = (
   GRAVATAR => {
       default => "/avatar.png",
       rating => "PG",
       size => 80,
   }
);

my $template = <<;
[% USE Gravatar %]
[% Gravatar(email => 'me@myself.ego') | html %]

my $tt2 = Template->new(\%config);
$tt2->process(\$template);

Settings via instance

Used if a particular template needs its own defaults.

use Template;
my $template = <<;
[% USE Gravatar( default => "/avatar.png",
                 rating => "PG",
                 size => 80 ) %]
[% Gravatar(email => 'me@myself.ego') | html %]

my $tt2 = Template->new();
$tt2->process(\$template);

Any other calls with different emails will share the defaults in this template.

Settings in the Gravatar call

Used for per URL control.

use Template;
my $template = <<;
[% USE Gravatar %]
[% Gravatar(email => 'me@myself.ego',
            default => "/avatar.png",
            rating => "PG",
            size => 80 ) | html %]

my $tt2 = Template->new();
$tt2->process(\$template);

Base URL (for developers only)

You may also override the base URL for retrieving the Gravatars. It's set to use the service from www.gravatar.com. It can be overridden in the config or the USE.

DIAGNOSTICS

Email is the only required argument. Croaks without it.

Size, border, and rating are also validated on each call. Croaks if an invalid size (like 0 or 100) or rating (like MA or NC-17) or border (like ff0 or FF) is given.

CONFIGURATION AND ENVIRONMENT

No configuration is necessary. You may use the configuration hash of your new template to pass default information like the default image location for those without Gravatars. You can also set it in the USE call per template if needed.

DEPENDENCIES (SEE ALSO)

Template, Template::Plugin, Carp, Digest::MD5, and URI::Escape.

http://www.gravatar.com/

BUGS AND LIMITATIONS

None known. I certainly appreciate bug reports and feedback via bug-template-plugin-gravatar@rt.cpan.org, or through the web interface at http://rt.cpan.org/.

AUTHOR

Ashley Pond V <ashley@cpan.org>

LICENSE AND COPYRIGHT

Copyright 2006, Ashley Pond V <ashley@cpan.org>. All rights reserved.

This module is free software; you may redistribute it or modify it or both under the same terms as Perl itself. See perlartistic.