Pass $env in more Middleware APIs so subclasses can do more things flexibly in the...

[catagits/Web-Session.git] / lib / Plack / Session.pm

diff --git a/lib/Plack/Session.pm b/lib/Plack/Session.pm
index 14c93b6..e6a1c91 100644 (file)
--- a/lib/Plack/Session.pm
+++ b/lib/Plack/Session.pm
@@ -2,49 +2,160 @@ package Plack::Session;
 use strict;
 use warnings;
 
-use Plack::Util::Accessor qw[
-    id
-    store
-    state
-];
+our $VERSION   = '0.03';
+our $AUTHORITY = 'cpan:STEVAN';
+
+use Plack::Util::Accessor qw( session options );
 
 sub new {
-    my ($class, %params) = @_;
+    my ($class, $env) = @_;
+    # NOTE: when you make a subclass, be sure to NEVER save $env in
+    # your hash. That will create a circular reference.
     bless {
-        id    => $params{ state }->get_session_id( $params{ request } ),
-        state => $params{ state },
-        store => $params{ store },
-    } => $class;
+        session => $env->{'psgix.session'},
+        options => $env->{'psgix.session.options'},
+    }, $class;
+}
+
+sub id {
+    my $self = shift;
+    $self->options->{id};
 }
 
 ## Data Managment
 
+sub dump {
+    my $self = shift;
+    $self->session;
+}
+
 sub get {
     my ($self, $key) = @_;
-    $self->store->fetch( $self->id, $key )
+    $self->session->{$key};
 }
 
 sub set {
     my ($self, $key, $value) = @_;
-    $self->store->store( $self->id, $key, $value );
+    delete $self->options->{no_store};
+    $self->session->{$key} = $value;
 }
 
 sub remove {
     my ($self, $key) = @_;
-    $self->store->delete( $self->id, $key );
+    delete $self->options->{no_store};
+    delete $self->session->{$key};
+}
+
+sub keys {
+    my $self = shift;
+    keys %{$self->session};
 }
 
 ## Lifecycle Management
 
 sub expire {
     my $self = shift;
-    $self->store->cleanup( $self->id );
-    $self->state->expire_session_id( $self->id );
+    for my $key ($self->keys) {
+        delete $self->session->{$key};
+    }
+    $self->options->{expire} = 1;
 }
 
-sub finalize {
-    my $self = shift;
-    $self->store->persist( $self->id )
-}
+1;
+
+__END__
+
+=pod
+
+=head1 NAME
+
+Plack::Session - Middleware for session management
+
+=head1 SYNOPSIS
+
+  # Use with Middleware::Session
+  enable "Session", session_class => "Plack::Session";
+
+  my $app = sub {
+      my $env = shift;
+      my $session = $env->{'plack.session'}; # not psgix.
+
+      $session->id;
+      $session->get($key);
+      $session->set($key, $value);
+      $session->remove($key);
+      $session->keys;
+
+      $session->expire;
+  };
+
+=head1 DESCRIPTION
+
+This is the core session object, you probably want to look
+at L<Plack::Middleware::Session>, unless you are writing your
+own session middleware component.
+
+=head1 METHODS
+
+=over 4
+
+=item B<new ( $env )>
+
+The constructor takes a PSGI request env hash reference.
+
+=item B<id>
+
+This is the accessor for the session id.
+
+=back
+
+=head2 Session Data Management
+
+These methods allows you to read and write the session data like
+Perl's normal hash.
+
+=over 4
+
+=item B<get ( $key )>
+
+=item B<set ( $key, $value )>
+
+=item B<remove ( $key )>
+
+=item B<keys>
+
+=item B<session>, B<dump>
+
+=back
+
+=head2 Session Lifecycle Management
+
+=over 4
+
+=item B<expire>
+
+This method can be called to expire the current session id.
+
+=back
+
+=head1 BUGS
+
+All complex software has bugs lurking in it, and this module is no
+exception. If you find a bug please either email me, or add the bug
+to cpan-RT.
+
+=head1 AUTHOR
+
+Stevan Little E<lt>stevan.little@iinteractive.comE<gt>
+
+=head1 COPYRIGHT AND LICENSE
+
+Copyright 2009, 2010 Infinity Interactive, Inc.
+
+L<http://www.iinteractive.com>
+
+This library is free software; you can redistribute it and/or modify
+it under the same terms as Perl itself.
+
+=cut
 
-1;
\ No newline at end of file