File: README.md

package info (click to toggle)
libplack-builder-conditionals-perl 0.05-1.1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, sid
  • size: 120 kB
  • sloc: perl: 140; makefile: 2
file content (110 lines) | stat: -rw-r--r-- 2,651 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
# NAME

Plack::Builder::Conditionals - Plack::Builder extension

# SYNOPSIS

    use Plack::Builder;
    use Plack::Builder::Conditionals;
    # exports "match_if, addr, path, method, header, browser, any, all"

    builder {
        enable match_if addr(['192.168.0.0/24','127.0.0.1']),
            "Plack::Middleware::ReverseProxy";

      enable match_if all( path(qr!^/private!), addr( '!', [qw!127.0.0.1 ::1!] ) ),
          "Plack::Middleware::Auth::Basic", authenticator => \&authen_cb;

      enable match_if sub { my $env = shift; $env->{HTTP_X_ENABLE_FRAMEWORK} },
          "Plack::Middleware::XFramework", framework => 'Test';

        $app;
    };

    use Plack::Builder::Conditionals -prefx => 'c';
    # exports "c_match_if, c_addr, c_path, c_method, c_header, c_any, c_all"



# DESCRIPTION

Plack::Builder::Conditionals is..

# FUNCTIONS

- match\_if

        enable match_if addr('127.0.0.1'), "Plack::Middleware::ReverseProxy";
        enable match_if sub { $_[0]->{REMOTE_ADDR} eq '127.0.0.1' }, "Plack::Middleware::ReverseProxy";

    As like Plack::Builder's enable\_if enable middleware if given conditions return true

- addr

        addr('127.0.0.1');
        addr([qw!192.168.0.0/24 127.0.0.1 ::1!]);
        addr('!','127.0.0.1');

    return true if REMOTE\_ADDR is found in the CIDR range. If first argument is '!', return the opposite result.
    This function supports IPv6 addresses

- path

        path('/')
        path(qr!^/(\w+)/!)
        path('!', qr!^/private!)

    matching PATH\_INFO

- method

        method('GET')
        method(qr/^(get|head)$/i)
        method(qw(GET HEAD))
        method('!','GET')
        method('!', qr/^(post|put)$/i)
        method('!', qw(POST PUT))
- header

        header('User-Agent',qr/iphone/)
        header('If-Modified-Since') #exists check
        header('!', 'User-Agent',qr/MSIE/)
- browser

        browser(qr/\bMSIE (7|8)/)
        browser('!',qr!^Mozilla/4!);

    Shortcut for header('User-Agent')

- all

        all( method('GET'), path(qr!^/static!) )

    return true if all conditions are return true

- any

        any( path(qr!^/static!), path('/favicon.ico') )

    return true if any condition return true

# EXPORT

    use Plack::Builder::Conditionals -prefx => 'c';
    # exports "c_match_if, c_addr, c_path, c_method, c_header, c_any, c_all"
    

you can add selected prefix to export functions

# AUTHOR

Masahiro Nagano <kazeburo {at} gmail.com>

# SEE ALSO

[Plack::Builder](http://search.cpan.org/perldoc?Plack::Builder)

# LICENSE

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