better docs for the CLI code
[catagits/Web-Simple.git] / lib / Web / Simple / Application.pm
index fdf8369..4ab18bb 100644 (file)
@@ -45,14 +45,14 @@ sub run_if_script {
 
 sub _run_cgi {
   my $self = shift;
-  require Plack::Server::CGI;
-  Plack::Server::CGI->run($self->to_psgi_app);
+  require Plack::Handler::CGI;
+  Plack::Handler::CGI->new->run($self->to_psgi_app);
 }
 
 sub _run_fcgi {
   my $self = shift;
-  require Plack::Server::FCGI;
-  Plack::Server::FCGI->run($self->to_psgi_app);
+  require Plack::Handler::FCGI;
+  Plack::Handler::FCGI->new->run($self->to_psgi_app);
 }
 
 sub to_psgi_app {
@@ -62,7 +62,10 @@ sub to_psgi_app {
 
 sub run {
   my $self = shift;
-  if ($ENV{PHP_FCGI_CHILDREN} || $ENV{FCGI_ROLE} || $ENV{FCGI_SOCKET_PATH}) {
+  if (
+    $ENV{PHP_FCGI_CHILDREN} || $ENV{FCGI_ROLE} || $ENV{FCGI_SOCKET_PATH}
+    || -S STDIN # STDIN is a socket, almost certainly FastCGI
+    ) {
     return $self->_run_fcgi;
   } elsif ($ENV{GATEWAY_INTERFACE}) {
     return $self->_run_cgi;
@@ -75,34 +78,70 @@ sub run {
 
   unshift(@args, 'GET') if $args[0] =~ m{^/};
 
-  $self->_run_test_request(@args);
+  $self->_run_cli_test_request(@args);
 }
 
-sub _run_test_request {
+sub _test_request_spec_to_http_request {
   my ($self, $method, $path, @rest) = @_;
 
-  require HTTP::Request;
-  require Plack::Test;
+  # if it's a reference, assume a request object
+  return $method if ref($method);
 
   my $request = HTTP::Request->new($method => $path);
-  if ($method eq 'POST' or $method eq 'PUT' and @rest) {
+
+  my @params;
+
+  while (my ($header, $value) = splice(@rest, 0, 2)) {
+    unless ($header =~ s/:$//) {
+      push @params, $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 @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');
     $request->header('Content-Length' => length($content));
     $request->content($content);
   }
-  my $response;
+
+  return $request;
+}
+
+sub run_test_request {
+  my ($self, @req) = @_;
+
+  require HTTP::Request;
+  require Plack::Test;
+
+  my $request = $self->_test_request_spec_to_http_request(@req);
+
   Plack::Test::test_psgi(
-    $self->to_psgi_app, sub { $response = shift->($request) }
+    $self->to_psgi_app, sub { shift->($request) }
   );
+}
+
+sub _run_cli_test_request {
+  my ($self, @req) = @_;
+  my $response = $self->run_test_request(@req);
+
+  binmode(STDOUT); binmode(STDERR); # for win32
+
   print STDERR $response->status_line."\n";
   print STDERR $response->headers_as_string("\n")."\n";
-  print STDOUT $response->content."\n";
+  my $content = $response->content;
+  $content .= "\n" if length($content) and $content !~ /\n\z/;
+  print STDOUT $content if $content;
 }
 
 sub _run_cli {
@@ -214,6 +253,28 @@ 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.
+
 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,12 +325,44 @@ calls ->new, or as an object method ... in which case it doesn't.
 
 =head2 run
 
-Used for running your application under stand-alone CGI and FCGI modes. Also
-useful for testing:
+Used for running your application under stand-alone CGI and FCGI modes.
+
+I should document this more extensively but run_if_script will call it when
+you need it, so don't worry about it too much.
+
+=head2 run_test_request
+
+  my $res = $app->run_test_request(GET => '/' => %headers);
+
+  my $res = $app->run_test_request(POST => '/' => %headers_or_form);
+
+  my $res = $app->run_test_request($http_request);
+
+Accepts either an L<HTTP::Request> object or ($method, $path) and runs that
+request against the application, returning an L<HTTP::Response> object.
+
+If the HTTP method is POST or PUT, then a series of pairs can be passed after
+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 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 $app = MyWebSimpleApp::Web->new;
-    my $c = HTTP::Request::AsCGI->new(@args)->setup;
-    $app->run;
+  my $res = $app->run_test_request(
+              POST => '/',
+              'Content-Type:' => 'text/json',
+              'Content:' => '{ "json": "here" }',
+            );
 
 =head1 AUTHORS