import "builder" into the right namespace - thanks, gbhat!
[catagits/Web-Simple.git] / lib / Web / Simple / Application.pm
index f6804dc..65919ad 100644 (file)
@@ -1,5 +1,7 @@
 package Web::Simple::Application;
 
+use Scalar::Util 'weaken';
+
 use Moo;
 
 has 'config' => (
@@ -23,13 +25,23 @@ has '_dispatcher' => (is => 'lazy');
 sub _build__dispatcher {
   my $self = shift;
   require Web::Dispatch;
-  require Web::Simple::DispatchNode;
   my $final = $self->_build_final_dispatcher;
-  Web::Dispatch->new(
-    app => sub { $self->dispatch_request(@_), $final },
-    node_class => 'Web::Simple::DispatchNode',
-    node_args => { app_object => $self }
+
+  # We need to weaken both the copy of $self that the
+  # app parameter will close over and the copy that'll
+  # be passed through as a node argument.
+  #
+  # To ensure that this doesn't then result in us being
+  # DESTROYed unexpectedly early, our to_psgi_app method
+  # closes back over $self
+
+  weaken($self);
+  my %dispatch_args = (
+    dispatch_app => sub { $self->dispatch_request(@_), $final },
+    dispatch_object => $self
   );
+  weaken($dispatch_args{dispatch_object});
+  Web::Dispatch->new(%dispatch_args);
 }
 
 sub _build_final_dispatcher {
@@ -57,26 +69,36 @@ sub _run_fcgi {
 
 sub to_psgi_app {
   my $self = ref($_[0]) ? $_[0] : $_[0]->new;
-  $self->_dispatcher->to_app;
+  my $app = $self->_dispatcher->to_app;
+
+  # Close over $self to keep $self alive even though
+  # we weakened the copies the dispatcher has; the
+  # if 0 causes the ops to be optimised away to
+  # minimise the performance impact and avoid void
+  # context warnings while still doing the closing
+  # over part. As Mithaldu said: "Gnarly." ...
+
+  return sub { $self if 0; goto &$app; };
 }
 
 sub run {
   my $self = shift;
   if (
     $ENV{PHP_FCGI_CHILDREN} || $ENV{FCGI_ROLE} || $ENV{FCGI_SOCKET_PATH}
-    || -S STDIN # STDIN is a socket, almost certainly FastCGI
+    || ( -S STDIN && !$ENV{GATEWAY_INTERFACE} )
+    # If STDIN is a socket, almost certainly FastCGI, except for mod_cgid
     ) {
     return $self->_run_fcgi;
   } elsif ($ENV{GATEWAY_INTERFACE}) {
     return $self->_run_cgi;
   }
-  unless (@ARGV && $ARGV[0] =~ m{^[A-Z/]}) {
+  unless (@ARGV && $ARGV[0] =~ m{(^[A-Z/])|\@}) {
     return $self->_run_cli(@ARGV);
   }
 
   my @args = @ARGV;
 
-  unshift(@args, 'GET') if $args[0] =~ m{^/};
+  unshift(@args, 'GET') if $args[0] !~ /^[A-Z]/;
 
   $self->_run_cli_test_request(@args);
 }
@@ -87,6 +109,12 @@ sub _test_request_spec_to_http_request {
   # if it's a reference, assume a request object
   return $method if ref($method);
 
+  if ($path =~ s/^(.*?)\@//) {
+    my $basic = $1;
+    require MIME::Base64;
+    unshift @rest, 'Authorization:', 'Basic '.MIME::Base64::encode($basic);
+  }
+
   my $request = HTTP::Request->new($method => $path);
 
   my @params;
@@ -95,14 +123,19 @@ sub _test_request_spec_to_http_request {
     unless ($header =~ s/:$//) {
       push @params, $header, $value;
     }
-    $request->headers->push_header($header, $value);
+    $header =~ s/_/-/g;
+    if ($header eq 'Content') {
+      $request->content($value);
+    } else {
+      $request->headers->push_header($header, $value);
+    }
   }
 
-  if (($method eq 'POST' or $method eq 'PUT') and @rest) {
+  if (($method eq 'POST' or $method eq 'PUT') and @params) {
     my $content = do {
       require URI;
       my $url = URI->new('http:');
-      $url->query_form(@rest);
+      $url->query_form(@params);
       $url->query;
     };
     $request->header('Content-Type' => 'application/x-www-form-urlencoded');
@@ -117,6 +150,7 @@ sub run_test_request {
   my ($self, @req) = @_;
 
   require HTTP::Request;
+
   require Plack::Test;
 
   my $request = $self->_test_request_spec_to_http_request(@req);
@@ -248,6 +282,32 @@ that path -
   
   Hello world!
 
+You can also provide a method name -
+
+  $ perl -Ilib examples/hello-world/hello-world.cgi POST /
+  405 Method Not Allowed
+  Content-Type: text/plain
+  
+  Method not allowed
+
+For a POST or PUT request, pairs on the command line will be treated
+as form variables. For any request, pairs on the command line ending in :
+are treated as headers, and 'Content:' will set the request body -
+
+  $ ./myapp POST / Accept: text/html form_field_name form_field_value
+  
+  $ ./myapp POST / Content-Type: text/json Content: '{ "json": "here" }'
+
+The body of the response is sent to STDOUT and the headers to STDERR, so
+
+  $ ./myapp GET / >index.html
+
+will generally do the right thing.
+
+To send basic authentication credentials, use user:pass@ syntax -
+
+  $ ./myapp GET bob:secret@/protected/path
+
 Additionally, you can treat the file as though it were a standard PSGI
 application file (*.psgi).  For example you can start up up with C<plackup>
 
@@ -264,11 +324,10 @@ for use via L<Plack> and L<plackup>. If you want to globally add middleware,
 you can override this method:
 
   use Web::Simple 'HelloWorld';
-  use Plack::Builder;
  
   {
     package HelloWorld;
-
+    use Plack::Builder;
   
     around 'to_psgi_app', sub {
       my ($orig, $self) = (shift, shift);
@@ -305,9 +364,9 @@ you need it, so don't worry about it too much.
 
 =head2 run_test_request
 
-  my $res = $app->run_test_request(GET => '/');
+  my $res = $app->run_test_request(GET => '/' => %headers);
 
-  my $res = $app->run_test_request(POST => '/' => %form);
+  my $res = $app->run_test_request(POST => '/' => %headers_or_form);
 
   my $res = $app->run_test_request($http_request);
 
@@ -319,6 +378,31 @@ this to create a form style message body. If you need to test an upload, then
 create an L<HTTP::Request> object by hand or use the C<POST> subroutine
 provided by L<HTTP::Request::Common>.
 
+If you prefix the URL with 'user:pass@' this will be converted into
+an Authorization header for HTTP basic auth:
+
+  my $res = $app->run_test_request(
+              GET => 'bob:secret@/protected/resource'
+            );
+
+If pairs are passed where the key ends in :, it is instead treated as a
+headers, so:
+
+  my $res = $app->run_test_request(
+              POST => '/',
+             'Accept:' => 'text/html',
+              some_form_key => 'value'
+            );
+
+will do what you expect. You can also pass a special key of Content: to
+set the request body:
+
+  my $res = $app->run_test_request(
+              POST => '/',
+              'Content-Type:' => 'text/json',
+              'Content:' => '{ "json": "here" }',
+            );
+
 =head1 AUTHORS
 
 See L<Web::Simple> for authors.