File Coverage

blib/lib/Plack/Middleware/Proxy/Requests.pm

Criterion	Covered	Total	%
statement	14	14	100.0
branch			n/a
condition			n/a
subroutine	5	5	100.0
pod	1	1	100.0
total	20	20	100.0

package Plack::Middleware::Proxy::Requests;

=head1 NAME

Plack::Middleware::Proxy::Requests - Forward proxy server

=head1 SYNOPSIS

=for markdown ```perl

    # In app.psgi
    use Plack::Builder;
    use Plack::App::Proxy;

    builder {
        enable "Proxy::Connect";
        enable "Proxy::AddVia";
        enable "Proxy::Requests";
        Plack::App::Proxy->new->to_app;
    };

=for markdown ```

=for markdown ```sh

    # From shell
    plackup -s Twiggy -E Proxy -e 'enable q{AccessLog}' app.psgi

    # or
    twiggy -MPlack::App::Proxy \
            -e 'enable q{AccessLog}; enable q{Proxy::Connect}; \
                enable q{Proxy::AddVia}; enable q{Proxy::Requests}; \
                Plack::App::Proxy->new->to_app'

=for markdown ```

=head1 DESCRIPTION

This module handles HTTP requests as a forward proxy server.

Its job is to set a C environment variable based on
C variable.

The HTTP responses from the Internet might be invalid. In that case it
is required to run the server without L module.
This module is started by default and disabled if C<-E> or
C<--no-default-middleware> option is used when starting L
script. Note that this disables also L so
it has to be enabled explicitly if needed.

The default server L alias C can hang
up on the stalled connection. It is better to run a proxy server with
L, L or L.

=for readme stop

=cut

use 5.006;

use strict;
use warnings;

our $VERSION = '0.0104';

use parent qw(Plack::Middleware);

sub call {
    my ($self, $env) = @_;

    $env->{'plack.proxy.url'} = $env->{REQUEST_URI};

    return $self->app->($env);
}

1;

__END__