Stevan Little > Web-Machine-0.08 > Web::Machine

Download:
Web-Machine-0.08.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  1
View/Report Bugs
Module Version: 0.08   Source   Latest Release: Web-Machine-0.15

NAME ^

Web::Machine - A Perl port of WebMachine

VERSION ^

version 0.08

SYNOPSIS ^

  use strict;
  use warnings;

  use Web::Machine;

  {
      package HelloWorld::Resource;
      use strict;
      use warnings;

      use parent 'Web::Machine::Resource';

      sub content_types_provided { [{ 'text/html' => 'to_html' }] }

      sub to_html {
          q{<html>
              <head>
                  <title>Hello World Resource</title>
              </head>
              <body>
                  <h1>Hello World</h1>
              </body>
           </html>}
      }
  }

  Web::Machine->new( resource => 'HelloWorld::Resource' )->to_app;

DESCRIPTION ^

This is a port of Webmachine, actually it is much closer to the ruby version, with a little bit of the javascript version and even some of the python version thrown in for good measure.

It runs atop Plack, but since it really handles the whole HTTP transaction, it is not appropriate to use most middleware modules. (NOTE: I will write more about this in the future.)

CAVEAT ^

This module is extremely young and it is a port of an pretty young (June 2011) module in another language (ruby), which itself is a port of a still kind of young module (March 2009) in yet another language (erlang). But that all said, it really seems like a sane idea and so I stole it and ported it to Perl.

METHODS ^

NOTE: This module is a Plack::Component subclass and so follows the interface set forward by that module.

new( resource => $resource_classname, ?resource_args => $arg_list, ?tracing => 1|0, ?streaming => 1|0 )

The constructor expects to get a $resource_classname, which it will use to create an instance of the resource class. If that class requires any additional arguments, they can be specified with the resource_args parameter. It can also take an optional tracing parameter which it will pass onto the Web::Machine::FSM, and an optional streaming parameter, which if true will run the request in a PSGI streaming response, which can be useful if you need to run your content generation asynchronously.

inflate_request( $env )

This takes a raw PSGI $env and inflates it into a Plack::Request instance. By default this also uses HTTP::Headers::ActionPack to inflate the headers of the request to be complex objects.

create_fsm

This will create the Web::Machine::FSM object to run. It will get passed the value of the tracing constructor parameter.

create_resource( $request )

This will create the Web::Machine::Resource instance using the class specified in the resource constructor parameter. It will pass in the $request object and call new_response on the $request object to get a Plack::Response instance.

finalize_response( $response )

Given a $response which is a Plack::Response object, this will finalize it and return a raw PSGI response.

call( $env )

This is the call method overridden from the Plack::Component superclass.

DEBUGGING ^

If you set the WM_DEBUG environment variable to 1 we will print out information about the path taken through the state machine to STDERR.

SEE ALSO ^

Original Erlang - https://github.com/basho/webmachine
Ruby port - https://github.com/seancribbs/webmachine-ruby
Node JS port - https://github.com/tautologistics/nodemachine
Python port - https://github.com/davisp/pywebmachine

AUTHOR ^

Stevan Little <stevan.little@iinteractive.com>

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2012 by Infinity Interactive, Inc..

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

syntax highlighting: