From: Stevan Little <stevan.little@iinteractive.com>
Date: Mon, 14 Dec 2009 04:24:44 +0000 (-0500)
Subject: Adding some additional docs and VERSION, AUTHORITY stuff
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FWeb-Session.git;a=commitdiff_plain;h=30cc0a719190fa26fb7b844d21db3237b8441db6

Adding some additional docs and VERSION, AUTHORITY stuff
---

diff --git a/Makefile.PL b/Makefile.PL
index 4d5ea9b..b83c970 100644
--- a/Makefile.PL
+++ b/Makefile.PL
@@ -8,7 +8,7 @@ license 'perl';
 
 # prereqs
 requires 'Plack'            => '0.9021';
-requires 'Plack::Request'   => '0.08';
+requires 'Plack::Request'   => '0.09';
 
 # for session ID gen
 requires 'Digest::SHA'      => '0';
diff --git a/lib/Plack/Middleware/Session.pm b/lib/Plack/Middleware/Session.pm
index aeacddc..03f8798 100644
--- a/lib/Plack/Middleware/Session.pm
+++ b/lib/Plack/Middleware/Session.pm
@@ -2,6 +2,9 @@ package Plack::Middleware::Session;
 use strict;
 use warnings;
 
+our $VERSION   = '0.01';
+our $AUTHORITY = 'cpan:STEVAN';
+
 use Plack::Session;
 use Plack::Request;
 use Plack::Response;
@@ -136,6 +139,37 @@ you can use this noop module.
 
 =back
 
+=head1 OPTIONS
+
+The following are options that can be passed to this mdoule.
+
+=over 4
+
+=item I<state>
+
+This is expected to be an instance of L<Plack::Session::State> or an
+object that implements the same interface. If no option is provided
+the default L<Plack::Session::State::Cookie> will be used.
+
+=item I<store>
+
+This is expected to be an instance of L<Plack::Session::Store> or an
+object that implements the same interface. If no option is provided
+the default L<Plack::Session::Store> will be used.
+
+It should be noted that this default is an in-memory volatile store
+is only suitable for development (or single process servers). For a
+more robust solution see L<Plack::Session::Store::File> or
+L<Plack::Session::Store::Cache>.
+
+=item I<session_class>
+
+This can be used to override the actual session class. It currently
+defaults to L<Plack::Session> but you can substitute any class which
+implements the same interface.
+
+=back
+
 =head1 BUGS
 
 All complex software has bugs lurking in it, and this module is no
diff --git a/lib/Plack/Session.pm b/lib/Plack/Session.pm
index 7c0a60c..cec8382 100644
--- a/lib/Plack/Session.pm
+++ b/lib/Plack/Session.pm
@@ -2,6 +2,9 @@ package Plack::Session;
 use strict;
 use warnings;
 
+our $VERSION   = '0.01';
+our $AUTHORITY = 'cpan:STEVAN';
+
 use Plack::Util::Accessor qw[
     id
     store
diff --git a/lib/Plack/Session/State.pm b/lib/Plack/Session/State.pm
index bca98ec..9f204af 100644
--- a/lib/Plack/Session/State.pm
+++ b/lib/Plack/Session/State.pm
@@ -2,6 +2,9 @@ package Plack::Session::State;
 use strict;
 use warnings;
 
+our $VERSION   = '0.01';
+our $AUTHORITY = 'cpan:STEVAN';
+
 use Digest::SHA1 ();
 
 use Plack::Util::Accessor qw[
diff --git a/lib/Plack/Session/State/Cookie.pm b/lib/Plack/Session/State/Cookie.pm
index 1b889e4..f4692f5 100644
--- a/lib/Plack/Session/State/Cookie.pm
+++ b/lib/Plack/Session/State/Cookie.pm
@@ -2,6 +2,9 @@ package Plack::Session::State::Cookie;
 use strict;
 use warnings;
 
+our $VERSION   = '0.01';
+our $AUTHORITY = 'cpan:STEVAN';
+
 use parent 'Plack::Session::State';
 
 use Plack::Util::Accessor qw[
diff --git a/lib/Plack/Session/Store.pm b/lib/Plack/Session/Store.pm
index 32ee737..38fc4d9 100644
--- a/lib/Plack/Session/Store.pm
+++ b/lib/Plack/Session/Store.pm
@@ -2,6 +2,9 @@ package Plack::Session::Store;
 use strict;
 use warnings;
 
+our $VERSION   = '0.01';
+our $AUTHORITY = 'cpan:STEVAN';
+
 use Plack::Util::Accessor qw[ _stash ];
 
 sub new {
diff --git a/lib/Plack/Session/Store/Cache.pm b/lib/Plack/Session/Store/Cache.pm
index 62232f8..2fc5a39 100644
--- a/lib/Plack/Session/Store/Cache.pm
+++ b/lib/Plack/Session/Store/Cache.pm
@@ -2,7 +2,10 @@ package Plack::Session::Store::Cache;
 use strict;
 use warnings;
 
-use Scalar::Util qw/blessed/;
+our $VERSION   = '0.01';
+our $AUTHORITY = 'cpan:STEVAN';
+
+use Scalar::Util qw[ blessed ];
 
 use parent 'Plack::Session::Store';
 
diff --git a/lib/Plack/Session/Store/File.pm b/lib/Plack/Session/Store/File.pm
index 0e5918d..d746cda 100644
--- a/lib/Plack/Session/Store/File.pm
+++ b/lib/Plack/Session/Store/File.pm
@@ -2,6 +2,9 @@ package Plack::Session::Store::File;
 use strict;
 use warnings;
 
+our $VERSION   = '0.01';
+our $AUTHORITY = 'cpan:STEVAN';
+
 use Storable ();
 
 use parent 'Plack::Session::Store';
diff --git a/lib/Plack/Session/Store/Null.pm b/lib/Plack/Session/Store/Null.pm
index dceca1e..e8c3bfa 100644
--- a/lib/Plack/Session/Store/Null.pm
+++ b/lib/Plack/Session/Store/Null.pm
@@ -2,6 +2,9 @@ package Plack::Session::Store::Null;
 use strict;
 use warnings;
 
+our $VERSION   = '0.01';
+our $AUTHORITY = 'cpan:STEVAN';
+
 sub new     { bless {} => shift }
 sub fetch   {}
 sub store   {}