.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Jifty::LetMe 3pm"
.TH Jifty::LetMe 3pm "2010-12-08" "perl v5.14.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Jifty::LetMe \- A way to expose single\-link URLs to your applications
.SS "new"
.IX Subsection "new"
Create a new \*(L"LetMe\*(R" authentication object; it takes no parameters.
It calls \*(L"_init\*(R" to do any initialization.
.PP
A LetMe is a way to provide a one-time-use \s-1URL\s0 for a particular purpose.
All LetMe objects give you a way to validate a user's identity and to
allow them a very small set of possible actions or page-access permissions.
.PP
For example, you can put a LetMe \s-1URL\s0 in an email to a new user,
so that when they click on the \s-1URL\s0 you know that their email address
is valid.
.ie n .SS "_init @_"
.el .SS "_init \f(CW@_\fP"
.IX Subsection "_init @_"
Called with whatever \*(L"new\*(R" was called with.  By default, does nothing.
.SS "user"
.IX Subsection "user"
Contains an app-specific \*(L"user\*(R" object.
.SS "validated_current_user"
.IX Subsection "validated_current_user"
If the user has presented a valid token, returns an (app-specific
subclass of the) Jifty::CurrentUser object for the user who has the
email address in \f(CW$self\fR\->email.  If no user has that email address,
returns undef.
.SS "_user_from_email \s-1ADDRESS\s0"
.IX Subsection "_user_from_email ADDRESS"
Returns an (app-specific subclass of the) Jifty::CurrentUser object
for the user who has the email address \fI\s-1ADDRESS\s0\fR.
.SS "generate_checksum"
.IX Subsection "generate_checksum"
Returns an authentication checksum for the current combination of:
.PP
.Vb 4
\&    user
\&    path
\&    arguments
\&    until
.Ve
.SS "generate_koremutake_checksum"
.IX Subsection "generate_koremutake_checksum"
Generate a slightly more pronounceable version of the checksum using
String::Koremutake.  Due to hex \-> integer limitations, this is
imprecise and may vary depending on the platform it is used on; as
such, it is deprecated.
.SS "from_token \s-1PATH\s0"
.IX Subsection "from_token PATH"
Parse a string of the form
.PP
mylongusername@example.com/update_task/23/until/20050101/bekidrikufryvagygefuba
.PP
into
.PP
.Vb 4
\&      email => mylongusername@example.com,
\&      path  => \*(Aqupdate_task/23\*(Aq
\&      until => 20050101,
\&      checksum_provided => bekidrikufryvagygefuba
.Ve
.SS "as_token"
.IX Subsection "as_token"
Returns the \*(L"letme\*(R" token for this set of credentials. This should round
trip cleanly with from_token
.SS "as_encoded_token"
.IX Subsection "as_encoded_token"
A variant of as_token that encodes the user's email address suitably
for passing in a \s-1URL\s0
.SS "as_url"
.IX Subsection "as_url"
Returns the fully qualified \s-1URL\s0 for this LetMe. It's composed of
Jifty\->web\->url, \*(L"base_path\*(R" and \*(L"as_encoded_token\*(R"
.SS "base_path"
.IX Subsection "base_path"
By default, all \*(L"LetMe\*(R" actions live at URLs under '/let' inside your
application.  Override this subroutine to change that.
.PP
By default, it returns '/let/'
.SS "validate"
.IX Subsection "validate"
Returns true if the credentials the user presented validate \s-1OK\s0.
Returns false otherwise.
.SS "_correct_checksum_provided"
.IX Subsection "_correct_checksum_provided"
Returns true if the checksum the user provided is correct. Doesn't
actually do much input checking. You want to call \*(L"validate\*(R"