output status+headers to STDERR in CLI mode
[catagits/Web-Simple.git] / lib / Web / Simple / Application.pm
index 05873c5..fdf8369 100644 (file)
@@ -67,20 +67,42 @@ sub run {
   } elsif ($ENV{GATEWAY_INTERFACE}) {
     return $self->_run_cgi;
   }
-  unless (@ARGV && $ARGV[0] =~ m{^/}) {
+  unless (@ARGV && $ARGV[0] =~ m{^[A-Z/]}) {
     return $self->_run_cli(@ARGV);
   }
 
-  my $path = shift @ARGV;
+  my @args = @ARGV;
 
-  require HTTP::Request::Common;
+  unshift(@args, 'GET') if $args[0] =~ m{^/};
+
+  $self->_run_test_request(@args);
+}
+
+sub _run_test_request {
+  my ($self, $method, $path, @rest) = @_;
+
+  require HTTP::Request;
   require Plack::Test;
-  local *GET = \&HTTP::Request::Common::GET;
 
-  my $request = GET($path);
+  my $request = HTTP::Request->new($method => $path);
+  if ($method eq 'POST' or $method eq 'PUT' and @rest) {
+    my $content = do {
+      require URI;
+      my $url = URI->new('http:');
+      $url->query_form(@rest);
+      $url->query;
+    };
+    $request->header('Content-Type' => 'application/x-www-form-urlencoded');
+    $request->header('Content-Length' => length($content));
+    $request->content($content);
+  }
   my $response;
-  Plack::Test::test_psgi($self->to_psgi_app, sub { $response = shift->($request) });
-  print $response->as_string;
+  Plack::Test::test_psgi(
+    $self->to_psgi_app, sub { $response = shift->($request) }
+  );
+  print STDERR $response->status_line."\n";
+  print STDERR $response->headers_as_string("\n")."\n";
+  print STDOUT $response->content."\n";
 }
 
 sub _run_cli {
@@ -99,7 +121,7 @@ sub _cli_usage {
 
 =head1 NAME
 
-Web::Simple::Application - A base class for your Web-Simple applications
+Web::Simple::Application - A base class for your Web-Simple application
 
 =head1 DESCRIPTION
 
@@ -109,11 +131,12 @@ lifting' for you in that regards.
 
 =head1 METHODS
 
-This class exposes the follow public methods.
+This class exposes the following public methods.
 
 =head2 default_config
 
-Provide configuration information to your application, for example:
+Merges with the C<config> initializer to provide configuration information for
+your application.  For example:
 
   sub default_config {
     (
@@ -122,19 +145,28 @@ Provide configuration information to your application, for example:
     );
   }
 
-Now, C<$self> will have an attribute C<config> which will be set to a HashRef
+Now, the C<config> attribute of C<$self>  will be set to a HashRef
 containing keys 'title' and 'posts_dir'.
 
-=head2 run_if_script
+The keys from default_config are merged into any config supplied, so
+if you construct your application like:
 
-In the case where you wish to run you L<Web::Simple> based application as a 
-stand alone CGI application, you can simple do:
+  MyWebSimpleApp::Web->new(
+    config => { title => 'Spoon', environment => 'dev' }
+  )
 
-  ## my_web_simple_app.pl
-  use MyWebSimpleApp::Web;
-  MyWebSimpleApp::Web->run_if_script.
+then C<config> will contain:
 
-Or (even more simply) just inline the entire application:
+  {
+    title => 'Spoon',
+    posts_dir => '/path/to/myapp/posts',
+    environment => 'dev'
+  }
+
+=head2 run_if_script
+
+The run_if_script method is designed to be used at the end of the script
+or .pm file where your application class is defined - for example:
 
   ## my_web_simple_app.pl
   #!/usr/bin/env perl
@@ -155,35 +187,80 @@ Or (even more simply) just inline the entire application:
 
   HelloWorld->run_if_script;
 
+This returns a true value, so your file is now valid as a module - so
+
+  require 'my_web_simple_app.pl';
+
+  my $hw = HelloWorld->new;
+
+will work fine (and you can rename it to lib/HelloWorld.pm later to make it
+a real use-able module).
+
+However, it detects if it's being run as a script (via testing $0) and if
+so attempts to do the right thing.
+
+If run under a CGI environment, your application will execute as a CGI.
+
+If run under a FastCGI environment, your application will execute as a
+FastCGI process (this works both for dynamic shared-hosting-style FastCGI
+and for apache FastCgiServer style setups).
+
+If run from the commandline with a URL path, it runs a GET request against
+that path -
+
+  $ perl -Ilib examples/hello-world/hello-world.cgi /
+  200 OK
+  Content-Type: text/plain
+  
+  Hello world!
+
+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>
+
+  plackup my_web_simple_app.pl
+
+or C<starman>
+
+  starman my_web_simple_app.pl
+
 =head2 to_psgi_app
 
-Given a L<Web::Simple> application root namespace, return it in a form suitable
-to run in inside a L<Plack> container, or in L<Plack::Builder> or in a C<*.psgi>
-file:
+This method is called by L</run_if_script> to create the L<PSGI> app coderef
+for use via L<Plack> and L<plackup>. If you want to globally add middleware,
+you can override this method:
 
-  ## app.psgi
-  use strictures 1;
+  use Web::Simple 'HelloWorld';
   use Plack::Builder;
-  use MyWebSimpleApp::Web;
+  {
+    package HelloWorld;
 
-  builder {
-    ## enable middleware
-    enable 'StackTrace';
-    enable 'Debug';
+  
+    around 'to_psgi_app', sub {
+      my ($orig, $self) = (shift, shift);
+      my $app = $self->$orig(@_); 
+      builder {
+        enable ...; ## whatever middleware you want
+        $app;
+      };
+    };
+  }
 
-    ## return application
-    MyWebSimpleApp::Web->to_psgi_app;
-  };
+This method can also be used to mount a Web::Simple application within
+a separate C<*.psgi> file -
 
-This could be run via C<plackup>, etc.  Please note the L<Plack::Builder> DSL
-is optional, if you are enabling L<Plack::Middleware> internally in your
-L<Web::Simple> application; your app.psgi could be as simple as:
+  use strictures 1;
+  use Plack::Builder;
+  use WSApp;
+  use AnotherWSApp;
 
-  use MyWebSimpleApp::Web;
-  MyWebSimpleApp::Web->to_psgi_app;
+  builder {
+    mount '/' => WSApp->to_psgi_app;
+    mount '/another' => AnotherWSApp->to_psgi_app;
+  };
 
-As always, mix and match the pieces you actually need and remember the 
-L<Web::Simple> philosophy of trying to keep it as minimal and simple as possible.
+This method can be called as a class method, in which case it implicitly
+calls ->new, or as an object method ... in which case it doesn't.
 
 =head2 run
 
@@ -194,22 +271,12 @@ useful for testing:
     my $c = HTTP::Request::AsCGI->new(@args)->setup;
     $app->run;
 
-=head1 AUTHOR
-
-Matt S. Trout <mst@shadowcat.co.uk>
-
-=head1 CONTRIBUTORS
-
-None required yet. Maybe this module is perfect (hahahahaha ...).
-
-=head1 COPYRIGHT
+=head1 AUTHORS
 
-Copyright (c) 2009 the Web::Simple L</AUTHOR> and L</CONTRIBUTORS>
-as listed above.
+See L<Web::Simple> for authors.
 
-=head1 LICENSE
+=head1 COPYRIGHT AND LICENSE
 
-This library is free software and may be distributed under the same terms
-as perl itself.
+See L<Web::Simple> for the copyright and license.
 
 =cut