POE-Filter-HTTP-Parser-1.06 000755 001751 000144 0 11535267211 14751 5 ustar 00chris users 000000 000000 README 000644 001751 000144 6575 11535267210 15725 0 ustar 00chris users 000000 000000 POE-Filter-HTTP-Parser-1.06 NAME
POE::Filter::HTTP::Parser - A HTTP POE filter for HTTP clients or
servers
VERSION
version 1.06
SYNOPSIS
use POE::Filter::HTTP::Parser;
# For HTTP Servers
my $request_filter = POE::Filter::HTTP::Parser->new( type => 'server' );
my $arrayref_of_request_objects = $filter->get( [ $stream ] );
my $arrayref_of_HTTP_stream = $filter->put( $arrayref_of_response_objects );
# For HTTP clients
my $response_filter = POE::Filter::HTTP::Parser->new( type => 'client' );
my $arrayref_of_HTTP_stream = $filter->put( $arrayref_of_request_objects );
my $arrayref_of_response_objects = $filter->get( [ $stream ] );
DESCRIPTION
POE::Filter::HTTP::Parser is a POE::Filter for HTTP which is based on
HTTP::Parser.
It can be used to easily create POE based HTTP servers or clients.
With the "type" set to "client", which is the default behaviour, "get"
will parse HTTP::Response objects from HTTP streams and "put" will
accept HTTP::Request objects and convert them to HTTP streams.
With the "type" set to "server", the reverse will happen. "get" will
parse HTTP::Request objects from HTTP streams and "put" will accept
HTTP::Response objects and convert them to HTTP streams. Like
POE::Filter::HTTPD if there is an error parsing the HTTP request, this
filter will generate a HTTP::Response object instead, to encapsulate the
error message, suitable for simply sending back to the requesting
client.
CONSTRUCTOR
"new"
Creates a new POE::Filter::HTTP::Parser object. Takes one optional
argument, "type" which determines whether the filter will act in
"client" or "server" mode. "client" is the default if "type" is not
specified.
'type', set to either 'client' or 'server', default is 'client';
METHODS
"get"
"get_one_start"
"get_one"
Takes an arrayref which contains lines of text. Returns an arrayref
of either HTTP::Request or HTTP::Response objects depending on the
"type" that has been specified.
"get_pending"
Returns any data remaining in a filter's input buffer. The filter's
input buffer is not cleared, however. Returns an array reference if
there's any data, or undef if the filter was empty.
"put"
Takes an arrayref of either HTTP::Response objects or HTTP::Request
objects depending on whether "type" is set to "server" or "client",
respectively.
If "type" is "client", then this accepts HTTP::Request objects. If
"type" is "server", then this accepts HTTP::Response objects.
This does make sense if you think about it.
The given objects are returned to their stream form.
"clone"
Makes a copy of the filter, and clears the copy's buffer.
CREDITS
The "put" method for HTTP responses was borrowed from
POE::Filter::HTTPD, along with the code to generate HTTP::Response on a
parse error, by Artur Bergman and Rocco Caputo.
SEE ALSO
POE::Filter
HTTP::Parser
POE::Filter::HTTPD
AUTHOR
Chris Williams
COPYRIGHT AND LICENSE
This software is copyright (c) 2011 by Chris Williams, Artur Bergman and
Rocco Caputo.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
LICENSE 000644 001751 000144 43662 11535267210 16070 0 ustar 00chris users 000000 000000 POE-Filter-HTTP-Parser-1.06 This software is copyright (c) 2011 by Chris Williams, Artur Bergman and Rocco Caputo.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
Terms of the Perl programming language system itself
a) the GNU General Public License as published by the Free
Software Foundation; either version 1, or (at your option) any
later version, or
b) the "Artistic License"
--- The GNU General Public License, Version 1, February 1989 ---
This software is Copyright (c) 2011 by Chris Williams, Artur Bergman and Rocco Caputo.
This is free software, licensed under:
The GNU General Public License, Version 1, February 1989
GNU GENERAL PUBLIC LICENSE
Version 1, February 1989
Copyright (C) 1989 Free Software Foundation, Inc.
59 Temple Place, Suite 330, Boston, MA 02111-1307, USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The license agreements of most software companies try to keep users
at the mercy of those companies. By contrast, our General Public
License is intended to guarantee your freedom to share and change free
software--to make sure the software is free for all its users. The
General Public License applies to the Free Software Foundation's
software and to any other program whose authors commit to using it.
You can use it for your programs, too.
When we speak of free software, we are referring to freedom, not
price. Specifically, the General Public License is designed to make
sure that you have the freedom to give away or sell copies of free
software, that you receive source code or can get it if you want it,
that you can change the software or use pieces of it in new free
programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.
For example, if you distribute copies of a such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have. You must make sure that they, too, receive or can get the
source code. And you must tell them their rights.
We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software. If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors' reputations.
The precise terms and conditions for copying, distribution and
modification follow.
GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License Agreement applies to any program or other work which
contains a notice placed by the copyright holder saying it may be
distributed under the terms of this General Public License. The
"Program", below, refers to any such program or work, and a "work based
on the Program" means either the Program or any work containing the
Program or a portion of it, either verbatim or with modifications. Each
licensee is addressed as "you".
1. You may copy and distribute verbatim copies of the Program's source
code as you receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice and
disclaimer of warranty; keep intact all the notices that refer to this
General Public License and to the absence of any warranty; and give any
other recipients of the Program a copy of this General Public License
along with the Program. You may charge a fee for the physical act of
transferring a copy.
2. You may modify your copy or copies of the Program or any portion of
it, and copy and distribute such modifications under the terms of Paragraph
1 above, provided that you also do the following:
a) cause the modified files to carry prominent notices stating that
you changed the files and the date of any change; and
b) cause the whole of any work that you distribute or publish, that
in whole or in part contains the Program or any part thereof, either
with or without modifications, to be licensed at no charge to all
third parties under the terms of this General Public License (except
that you may choose to grant warranty protection to some or all
third parties, at your option).
c) If the modified program normally reads commands interactively when
run, you must cause it, when started running for such interactive use
in the simplest and most usual way, to print or display an
announcement including an appropriate copyright notice and a notice
that there is no warranty (or else, saying that you provide a
warranty) and that users may redistribute the program under these
conditions, and telling the user how to view a copy of this General
Public License.
d) You may charge a fee for the physical act of transferring a
copy, and you may at your option offer warranty protection in
exchange for a fee.
Mere aggregation of another independent work with the Program (or its
derivative) on a volume of a storage or distribution medium does not bring
the other work under the scope of these terms.
3. You may copy and distribute the Program (or a portion or derivative of
it, under Paragraph 2) in object code or executable form under the terms of
Paragraphs 1 and 2 above provided that you also do one of the following:
a) accompany it with the complete corresponding machine-readable
source code, which must be distributed under the terms of
Paragraphs 1 and 2 above; or,
b) accompany it with a written offer, valid for at least three
years, to give any third party free (except for a nominal charge
for the cost of distribution) a complete machine-readable copy of the
corresponding source code, to be distributed under the terms of
Paragraphs 1 and 2 above; or,
c) accompany it with the information you received as to where the
corresponding source code may be obtained. (This alternative is
allowed only for noncommercial distribution and only if you
received the program in object code or executable form alone.)
Source code for a work means the preferred form of the work for making
modifications to it. For an executable file, complete source code means
all the source code for all modules it contains; but, as a special
exception, it need not include source code for modules which are standard
libraries that accompany the operating system on which the executable
file runs, or for standard header files or definitions files that
accompany that operating system.
4. You may not copy, modify, sublicense, distribute or transfer the
Program except as expressly provided under this General Public License.
Any attempt otherwise to copy, modify, sublicense, distribute or transfer
the Program is void, and will automatically terminate your rights to use
the Program under this License. However, parties who have received
copies, or rights to use copies, from you under this General Public
License will not have their licenses terminated so long as such parties
remain in full compliance.
5. By copying, distributing or modifying the Program (or any work based
on the Program) you indicate your acceptance of this license to do so,
and all its terms and conditions.
6. Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the original
licensor to copy, distribute or modify the Program subject to these
terms and conditions. You may not impose any further restrictions on the
recipients' exercise of the rights granted herein.
7. The Free Software Foundation may publish revised and/or new versions
of the General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the Program
specifies a version number of the license which applies to it and "any
later version", you have the option of following the terms and conditions
either of that version or of any later version published by the Free
Software Foundation. If the Program does not specify a version number of
the license, you may choose any version ever published by the Free Software
Foundation.
8. If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author
to ask for permission. For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes
make exceptions for this. Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.
NO WARRANTY
9. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
REPAIR OR CORRECTION.
10. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.
END OF TERMS AND CONDITIONS
Appendix: How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to humanity, the best way to achieve this is to make it
free software which everyone can redistribute and change under these
terms.
To do so, attach the following notices to the program. It is safest to
attach them to the start of each source file to most effectively convey
the exclusion of warranty; and each file should have at least the
"copyright" line and a pointer to where the full notice is found.
Copyright (C) 19yy
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 1, or (at your option)
any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software Foundation,
Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
Also add information on how to contact you by electronic and paper mail.
If the program is interactive, make it output a short notice like this
when it starts in an interactive mode:
Gnomovision version 69, Copyright (C) 19xx name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the
appropriate parts of the General Public License. Of course, the
commands you use may be called something other than `show w' and `show
c'; they could even be mouse-clicks or menu items--whatever suits your
program.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the program, if
necessary. Here a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the
program `Gnomovision' (a program to direct compilers to make passes
at assemblers) written by James Hacker.
, 1 April 1989
Ty Coon, President of Vice
That's all there is to it!
--- The Artistic License 1.0 ---
This software is Copyright (c) 2011 by Chris Williams, Artur Bergman and Rocco Caputo.
This is free software, licensed under:
The Artistic License 1.0
The Artistic License
Preamble
The intent of this document is to state the conditions under which a Package
may be copied, such that the Copyright Holder maintains some semblance of
artistic control over the development of the package, while giving the users of
the package the right to use and distribute the Package in a more-or-less
customary fashion, plus the right to make reasonable modifications.
Definitions:
- "Package" refers to the collection of files distributed by the Copyright
Holder, and derivatives of that collection of files created through
textual modification.
- "Standard Version" refers to such a Package if it has not been modified,
or has been modified in accordance with the wishes of the Copyright
Holder.
- "Copyright Holder" is whoever is named in the copyright or copyrights for
the package.
- "You" is you, if you're thinking about copying or distributing this Package.
- "Reasonable copying fee" is whatever you can justify on the basis of media
cost, duplication charges, time of people involved, and so on. (You will
not be required to justify it to the Copyright Holder, but only to the
computing community at large as a market that must bear the fee.)
- "Freely Available" means that no fee is charged for the item itself, though
there may be fees involved in handling the item. It also means that
recipients of the item may redistribute it under the same conditions they
received it.
1. You may make and give away verbatim copies of the source form of the
Standard Version of this Package without restriction, provided that you
duplicate all of the original copyright notices and associated disclaimers.
2. You may apply bug fixes, portability fixes and other modifications derived
from the Public Domain or from the Copyright Holder. A Package modified in such
a way shall still be considered the Standard Version.
3. You may otherwise modify your copy of this Package in any way, provided that
you insert a prominent notice in each changed file stating how and when you
changed that file, and provided that you do at least ONE of the following:
a) place your modifications in the Public Domain or otherwise make them
Freely Available, such as by posting said modifications to Usenet or an
equivalent medium, or placing the modifications on a major archive site
such as ftp.uu.net, or by allowing the Copyright Holder to include your
modifications in the Standard Version of the Package.
b) use the modified Package only within your corporation or organization.
c) rename any non-standard executables so the names do not conflict with
standard executables, which must also be provided, and provide a separate
manual page for each non-standard executable that clearly documents how it
differs from the Standard Version.
d) make other distribution arrangements with the Copyright Holder.
4. You may distribute the programs of this Package in object code or executable
form, provided that you do at least ONE of the following:
a) distribute a Standard Version of the executables and library files,
together with instructions (in the manual page or equivalent) on where to
get the Standard Version.
b) accompany the distribution with the machine-readable source of the Package
with your modifications.
c) accompany any non-standard executables with their corresponding Standard
Version executables, giving the non-standard executables non-standard
names, and clearly documenting the differences in manual pages (or
equivalent), together with instructions on where to get the Standard
Version.
d) make other distribution arrangements with the Copyright Holder.
5. You may charge a reasonable copying fee for any distribution of this
Package. You may charge any fee you choose for support of this Package. You
may not charge a fee for this Package itself. However, you may distribute this
Package in aggregate with other (possibly commercial) programs as part of a
larger (possibly commercial) software distribution provided that you do not
advertise this Package as a product of your own.
6. The scripts and library files supplied as input to or produced as output
from the programs of this Package do not automatically fall under the copyright
of this Package, but belong to whomever generated them, and may be sold
commercially, and may be aggregated with this Package.
7. C or perl subroutines supplied by you and linked into this Package shall not
be considered part of this Package.
8. The name of the Copyright Holder may not be used to endorse or promote
products derived from this software without specific prior written permission.
9. THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
The End
Changes 000644 001751 000144 3730 11535267211 16327 0 ustar 00chris users 000000 000000 POE-Filter-HTTP-Parser-1.06 ==============================
2011-03-07 23:46:11 +0000 1.06
==============================
commit b19d16ab7884681490695ac7e06145c8e609a293
Author: Chris 'BinGOs' Williams
Date: Mon Mar 7 23:46:11 2011 +0000
Fix trailing space and bump version to 1.06
commit dd95ee1ab0da0d89e8a18e39e9b4cbebabdd4f44
Author: Paul Driver
Date: Mon Mar 7 10:54:55 2011 -0600
Depending on latest HTTP::Parser and fixing some tests
commit a3fbde85a4c52b1f9265b355a40214d4ba69b9d7
Author: Chris 'BinGOs' Williams
Date: Mon Mar 7 21:46:59 2011 +0000
Update dist.ini with 'Prereqs' option rather than 'Prereq'
commit 0337189987690f84435961ee29e0082a6216accf
Author: Chris 'BinGOs' Williams
Date: Wed Jul 28 13:13:58 2010 +0100
Removed the unnecessary tests
commit ae9689f9b53ecfdc6db670daba7db58b72c30126
Author: Chris 'BinGOs' Williams
Date: Wed Jul 28 13:06:43 2010 +0100
Convert distribution to Dist::Zilla
==============================
2010-07-28 13:00:14 +0100 1.04
==============================
commit 73125ea7b37e467d3ee3c9484aa74b6a9df8f159
Author: Chris 'BinGOs' Williams
Date: Wed Jul 28 13:00:14 2010 +0100
Bump version and update Changes
commit 2569462538d5782d38d86cafb114247eacef2224
Author: Chris 'BinGOs' Williams
Date: Wed Jul 28 12:58:15 2010 +0100
Apply a patch from Dariusz Jackowski [RT#59772] which fixes double
encoded utf-8 strings.
==============================
2009-06-17 16:20:07 +0100 1.02
==============================
commit 0fc4b1a7df9292444132814e3f02fafb271ec418
Author: Chris Williams
Date: Wed Jun 17 16:20:07 2009 +0100
Fixed small bug in get_pending()
====================================
End of changes in the last 1825 days
====================================
dist.ini 000644 001751 000144 670 11535267210 16457 0 ustar 00chris users 000000 000000 POE-Filter-HTTP-Parser-1.06 name = POE-Filter-HTTP-Parser
version = 1.06
author = Chris Williams
license = Perl_5
copyright_holder = Chris Williams, Artur Bergman and Rocco Caputo
[@BINGOS]
[Prereqs / BuildRequires]
ExtUtils::MakeMaker = 6.42
Test::More = 0.47
Test::POE::Client::TCP = 0.1
Test::POE::Server::TCP = 0.16
[Prereqs]
Encode = 0
HTTP::Parser = 0.06
HTTP::Request = 0
HTTP::Response = 0
HTTP::Status = 0
POE = 1.003
perl = v5.6.0
META.yml 000644 001751 000144 1445 11535267210 16305 0 ustar 00chris users 000000 000000 POE-Filter-HTTP-Parser-1.06 ---
abstract: 'A HTTP POE filter for HTTP clients or servers'
author:
- 'Chris Williams '
build_requires:
ExtUtils::MakeMaker: 6.42
Test::More: 0.47
Test::POE::Client::TCP: 0.1
Test::POE::Server::TCP: 0.16
configure_requires:
ExtUtils::MakeMaker: 6.31
dynamic_config: 0
generated_by: 'Dist::Zilla version 4.200004, CPAN::Meta::Converter version 2.110580'
license: perl
meta-spec:
url: http://module-build.sourceforge.net/META-spec-v1.4.html
version: 1.4
name: POE-Filter-HTTP-Parser
requires:
Encode: 0
HTTP::Parser: 0.06
HTTP::Request: 0
HTTP::Response: 0
HTTP::Status: 0
POE: 1.003
perl: v5.6.0
resources:
homepage: http://github.com/bingos/poe-filter-http-parser/tree
repository: git://github.com/bingos/poe-filter-http-parser.git
version: 1.06
MANIFEST 000644 001751 000144 427 11535267210 16144 0 ustar 00chris users 000000 000000 POE-Filter-HTTP-Parser-1.06 Changes
LICENSE
MANIFEST
META.json
META.yml
Makefile.PL
README
dist.ini
examples/simpleclient.pl
lib/POE/Filter/HTTP/Parser.pm
t/00-compile.t
t/01_filter_req.t
t/01_filter_resp.t
t/01_get_pending.t
t/02_in_use.t
t/03_bad_request.t
t/release-pod-coverage.t
t/release-pod-syntax.t
META.json 000644 001751 000144 2646 11535267211 16462 0 ustar 00chris users 000000 000000 POE-Filter-HTTP-Parser-1.06 {
"abstract" : "A HTTP POE filter for HTTP clients or servers",
"author" : [
"Chris Williams "
],
"dynamic_config" : 0,
"generated_by" : "Dist::Zilla version 4.200004, CPAN::Meta::Converter version 2.110580",
"license" : [
"perl_5"
],
"meta-spec" : {
"url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec",
"version" : "2"
},
"name" : "POE-Filter-HTTP-Parser",
"prereqs" : {
"build" : {
"requires" : {
"ExtUtils::MakeMaker" : "6.42",
"Test::More" : "0.47",
"Test::POE::Client::TCP" : "0.1",
"Test::POE::Server::TCP" : "0.16"
}
},
"configure" : {
"requires" : {
"ExtUtils::MakeMaker" : "6.31"
}
},
"runtime" : {
"requires" : {
"Encode" : 0,
"HTTP::Parser" : "0.06",
"HTTP::Request" : 0,
"HTTP::Response" : 0,
"HTTP::Status" : 0,
"POE" : "1.003",
"perl" : "v5.6.0"
}
}
},
"release_status" : "stable",
"resources" : {
"homepage" : "http://github.com/bingos/poe-filter-http-parser/tree",
"repository" : {
"type" : "git",
"url" : "git://github.com/bingos/poe-filter-http-parser.git",
"web" : "http://github.com/bingos/poe-filter-http-parser/tree"
}
},
"version" : "1.06"
}
Makefile.PL 000644 001751 000144 2463 11535267211 17010 0 ustar 00chris users 000000 000000 POE-Filter-HTTP-Parser-1.06
use strict;
use warnings;
BEGIN { require v5.6.0; }
use ExtUtils::MakeMaker 6.31;
my %WriteMakefileArgs = (
'ABSTRACT' => 'A HTTP POE filter for HTTP clients or servers',
'AUTHOR' => 'Chris Williams ',
'BUILD_REQUIRES' => {
'ExtUtils::MakeMaker' => '6.42',
'Test::More' => '0.47',
'Test::POE::Client::TCP' => '0.1',
'Test::POE::Server::TCP' => '0.16'
},
'CONFIGURE_REQUIRES' => {
'ExtUtils::MakeMaker' => '6.31'
},
'DISTNAME' => 'POE-Filter-HTTP-Parser',
'EXE_FILES' => [],
'LICENSE' => 'perl',
'NAME' => 'POE::Filter::HTTP::Parser',
'PREREQ_PM' => {
'Encode' => '0',
'HTTP::Parser' => '0.06',
'HTTP::Request' => '0',
'HTTP::Response' => '0',
'HTTP::Status' => '0',
'POE' => '1.003'
},
'VERSION' => '1.06',
'test' => {
'TESTS' => 't/*.t'
}
);
unless ( eval { ExtUtils::MakeMaker->VERSION(6.56) } ) {
my $br = delete $WriteMakefileArgs{BUILD_REQUIRES};
my $pp = $WriteMakefileArgs{PREREQ_PM};
for my $mod ( keys %$br ) {
if ( exists $pp->{$mod} ) {
$pp->{$mod} = $br->{$mod} if $br->{$mod} > $pp->{$mod};
}
else {
$pp->{$mod} = $br->{$mod};
}
}
}
delete $WriteMakefileArgs{CONFIGURE_REQUIRES}
unless eval { ExtUtils::MakeMaker->VERSION(6.52) };
WriteMakefile(%WriteMakefileArgs);
t 000755 001751 000144 0 11535267211 15135 5 ustar 00chris users 000000 000000 POE-Filter-HTTP-Parser-1.06 02_in_use.t 000644 001751 000144 5045 11535267210 17247 0 ustar 00chris users 000000 000000 POE-Filter-HTTP-Parser-1.06/t use strict;
use warnings;
use Test::More tests => 24;
use POE;
use POE::Filter::HTTP::Parser;
use Test::POE::Server::TCP;
use Test::POE::Client::TCP;
use HTTP::Request;
use HTTP::Response;
my @tests = (
'/', '/moocow', '/bingos/was/here',
);
POE::Session->create(
package_states => [
main => [qw(
_start
_run_tests
httpd_registered
httpd_client_input
httpc_connected
httpc_input
)],
],
heap => { tests => \@tests, },
);
$poe_kernel->run();
exit 0;
sub _start {
my ($kernel,$heap) = @_[KERNEL,HEAP];
$heap->{httpd} = Test::POE::Server::TCP->spawn(
prefix => 'httpd',
address => '127.0.0.1',
filter => POE::Filter::HTTP::Parser->new( type => 'server' ),
);
return;
}
sub httpd_registered {
my ($heap,$object) = @_[HEAP,ARG0];
$heap->{port} = $object->port();
$heap->{httpc} = Test::POE::Client::TCP->spawn(
prefix => 'httpc',
autoconnect => 1,
address => '127.0.0.1',
port => $heap->{port},
filter => POE::Filter::HTTP::Parser->new( type => 'client' ),
);
return;
}
sub httpc_connected {
$poe_kernel->yield( '_run_tests' );
return;
}
sub _run_tests {
my $heap = $_[HEAP];
my $test = shift @{ $heap->{tests} };
my $req = HTTP::Request->new( GET => $test );
$req->protocol( 'HTTP/1.1' );
$req->header( 'Host', "127.0.0.1:$heap->{port}" );
$heap->{httpc}->send_to_server( $req );
$heap->{current_test} = $test;
return;
}
sub httpd_client_input {
my ($heap,$id,$req) = @_[HEAP,ARG0,ARG1];
my $test = delete $heap->{current_test};
isa_ok( $req, 'HTTP::Request' );
is( $req->method, 'GET', 'Request method is GET' );
is( $req->uri->path, $test, 'Correct path' );
is( $req->header('X-HTTP-Version'), '1.1', 'X-HTTP-Version' );
diag($req->as_string);
my $resp = HTTP::Response->new( 200 );
$resp->protocol('HTTP/1.1');
$resp->content('Cows go moo, yes they do');
use bytes;
$resp->header('Content-Length', length $resp->content);
$resp->header('Content-Type', 'text/plain');
$heap->{httpd}->send_to_client( $id, $resp );
return;
}
sub httpc_input {
my ($heap,$resp) = @_[HEAP,ARG0];
isa_ok( $resp, 'HTTP::Response' );
diag($resp->as_string);
is( $resp->header('X-HTTP-Version'), '1.1', 'X-HTTP-Version' );
is( $resp->header('Content-Type'), 'text/plain', 'Content-Type' );
is( $resp->content, 'Cows go moo, yes they do', 'Cows go moo, yes they do' );
if ( scalar @{ $heap->{tests} } ) {
$poe_kernel->yield( '_run_tests' );
return;
}
$heap->{httpc}->shutdown();
$heap->{httpd}->shutdown();
delete $heap->{$_} for qw(httpd httpc);
return;
}
00-compile.t 000644 001751 000144 2041 11535267211 17323 0 ustar 00chris users 000000 000000 POE-Filter-HTTP-Parser-1.06/t #!perl
use strict;
use warnings;
use Test::More;
use File::Find;
use File::Temp qw{ tempdir };
my @modules;
find(
sub {
return if $File::Find::name !~ /\.pm\z/;
my $found = $File::Find::name;
$found =~ s{^lib/}{};
$found =~ s{[/\\]}{::}g;
$found =~ s/\.pm$//;
# nothing to skip
push @modules, $found;
},
'lib',
);
my @scripts = glob "bin/*";
my $plan = scalar(@modules) + scalar(@scripts);
$plan ? (plan tests => $plan) : (plan skip_all => "no tests to run");
{
# fake home for cpan-testers
# no fake requested ## local $ENV{HOME} = tempdir( CLEANUP => 1 );
like( qx{ $^X -Ilib -e "require $_; print '$_ ok'" }, qr/^\s*$_ ok/s, "$_ loaded ok" )
for sort @modules;
SKIP: {
eval "use Test::Script 1.05; 1;";
skip "Test::Script needed to test script compilation", scalar(@scripts) if $@;
foreach my $file ( @scripts ) {
my $script = $file;
$script =~ s!.*/!!;
script_compiles( $file, "$script script compiles" );
}
}
}
01_filter_req.t 000644 001751 000144 2143 11535267210 20114 0 ustar 00chris users 000000 000000 POE-Filter-HTTP-Parser-1.06/t use strict;
use warnings;
use Test::More tests => 25;
use_ok('POE::Filter::HTTP::Parser');
my $filter = POE::Filter::HTTP::Parser->new( type => 'request' );
my $clone = $filter->clone();
my @data = (
"GET / HTTP/1.1\x0D\x0A",
"Host: canker.bingosnet.co.uk:6666\x0D\x0A",
"User-Agent: Mozilla/5.0 (Windows; U; Windows NT 5.2; en-GB; rv:1.9.0.5) Gecko/2008120122 Firefox/3.0.5\x0D\x0A",
"Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\x0D\x0A",
"Accept-Language: en-gb,en;q=0.5\x0D\x0A",
"Accept-Encoding: gzip,deflate\x0D\x0A",
"Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\x0D\x0A",
"Keep-Alive: 300\x0D\x0A",
"Connection: keep-alive\x0D\x0A\x0D\x0A",
);
foreach my $test ( $filter, $clone ) {
isa_ok( $test, 'POE::Filter::HTTP::Parser' );
isa_ok( $test, 'POE::Filter' );
my $events = $filter->get( [ join( '', @data, @data, @data ) ] );
ok( scalar @$events == 3, 'Got three requests' );
foreach my $req ( @$events ) {
isa_ok( $req, 'HTTP::Request' );
is( $req->method, 'GET', 'Request method was okay' );
is( $req->uri->path, '/', 'The URI was okay' );
}
}
01_filter_resp.t 000644 001751 000144 2446 11535267210 20304 0 ustar 00chris users 000000 000000 POE-Filter-HTTP-Parser-1.06/t use strict;
use warnings;
use Test::More tests => 25;
use_ok('POE::Filter::HTTP::Parser');
my $filter = POE::Filter::HTTP::Parser->new( type => 'response' );
my $clone = $filter->clone();
my @data = (
"HTTP/1.1 200 OK\x0D\x0A",
"Connection: close\x0D\x0A",
"Date: Wed, 21 Jan 2009 11:24:23 GMT\x0D\x0A",
"Server: Apache\x0D\x0A",
"Content-Length: 204\x0D\x0A",
"Content-Type: text/html; charset=UTF-8\x0D\x0A",
"Content-Type: text/html; charset=iso-8859-1\x0D\x0A",
"Client-Date: Wed, 21 Jan 2009 11:24:23 GMT\x0D\x0A",
"Client-Peer: 62.234.135.115:80\x0D\x0A",
"Client-Response-Num: 1\x0D\x0A",
"\x0D\x0A",
"\n",
"\n",
" \n",
" GumbyNet - ORG - UK\n",
" \n",
" \n",
"
\n",
" \n",
"\n",
);
foreach my $test ( $filter, $clone ) {
isa_ok( $test, 'POE::Filter::HTTP::Parser' );
isa_ok( $test, 'POE::Filter' );
my $events = $filter->get( [ join( '', @data, @data, @data ) ] );
ok( scalar @$events == 3, 'Got three responses' );
foreach my $resp ( @$events ) {
isa_ok( $resp, 'HTTP::Response' );
is( $resp->code, '200', 'Response code okay' );
like( $resp->content, qr/binnetbut.jpg/, 'Content was okay' );
}
}
03_bad_request.t 000644 001751 000144 3707 11535267210 20267 0 ustar 00chris users 000000 000000 POE-Filter-HTTP-Parser-1.06/t use strict;
use warnings;
use Test::More tests => 8;
use POE qw(Filter::Stream);
use POE::Filter::HTTP::Parser;
use Test::POE::Server::TCP;
use Test::POE::Client::TCP;
use HTTP::Request;
use HTTP::Response;
POE::Session->create(
package_states => [
main => [qw(
_start
httpd_registered
httpd_client_input
httpc_connected
httpc_input
)],
],
);
$poe_kernel->run();
exit 0;
sub _start {
my ($kernel,$heap) = @_[KERNEL,HEAP];
$heap->{httpd} = Test::POE::Server::TCP->spawn(
prefix => 'httpd',
address => '127.0.0.1',
filter => POE::Filter::HTTP::Parser->new( type => 'server' ),
);
return;
}
sub httpd_registered {
my ($heap,$object) = @_[HEAP,ARG0];
$heap->{port} = $object->port();
$heap->{httpc} = Test::POE::Client::TCP->spawn(
prefix => 'httpc',
autoconnect => 1,
address => '127.0.0.1',
port => $heap->{port},
inputfilter => POE::Filter::HTTP::Parser->new( type => 'client' ),
outputfilter => POE::Filter::Stream->new(),
);
return;
}
sub httpc_connected {
my $heap = $_[HEAP];
$heap->{httpc}->send_to_server( "Complete and utter cock\x0D\x0A\x0D\x0A" );
return;
}
sub httpd_client_input {
my ($heap,$id,$req) = @_[HEAP,ARG0,ARG1];
isa_ok( $req, 'HTTP::Response' );
is( $req->code, '400', 'Ooops something went wrong' );
is( $req->header('Content-Type'), 'text/html', 'Content-Type' );
diag($req->as_string);
$req->protocol('HTTP/1.1');
$heap->{httpd}->send_to_client( $id, $req );
return;
}
sub httpc_input {
my ($heap,$resp) = @_[HEAP,ARG0];
isa_ok( $resp, 'HTTP::Response' );
diag($resp->as_string);
is( $resp->code, '400', 'Ooops something went wrong' );
is( $resp->header('X-HTTP-Version'), '1.1', 'X-HTTP-Version' );
is( $resp->header('Content-Type'), 'text/html', 'Content-Type' );
like( $resp->content, qr/Complete and utter cock/, 'Complete and utter cock' );
$heap->{httpc}->shutdown();
$heap->{httpd}->shutdown();
delete $heap->{$_} for qw(httpd httpc);
return;
}
01_get_pending.t 000644 001751 000144 266 11535267210 20227 0 ustar 00chris users 000000 000000 POE-Filter-HTTP-Parser-1.06/t use strict;
use warnings;
use Test::More tests => 1;
use_ok('POE::Filter::HTTP::Parser');
my $filter = POE::Filter::HTTP::Parser->new( type => 'request' );
$filter->get_pending();
release-pod-syntax.t 000644 001751 000144 450 11535267211 21164 0 ustar 00chris users 000000 000000 POE-Filter-HTTP-Parser-1.06/t #!perl
BEGIN {
unless ($ENV{RELEASE_TESTING}) {
require Test::More;
Test::More::plan(skip_all => 'these tests are for release candidate testing');
}
}
use Test::More;
eval "use Test::Pod 1.41";
plan skip_all => "Test::Pod 1.41 required for testing POD" if $@;
all_pod_files_ok();
examples 000755 001751 000144 0 11535267210 16507 5 ustar 00chris users 000000 000000 POE-Filter-HTTP-Parser-1.06 simpleclient.pl 000644 001751 000144 2221 11535267210 21670 0 ustar 00chris users 000000 000000 POE-Filter-HTTP-Parser-1.06/examples use strict;
use warnings;
use URI;
use HTTP::Request;
use POE;
use POE::Filter::HTTP::Parser;
use Test::POE::Client::TCP;
$|=1;
my $link = shift;
die "You must provide a url to fetch\n" unless $link;
my $uri = URI->new($link);
die "Can't handle that scheme sorry\n" unless $uri->scheme eq 'http';
POE::Session->create(
package_states => [
main => [qw(_start webc_connected webc_input)],
],
);
$poe_kernel->run();
exit 0;
sub _start {
my ($kernel,$heap) = @_[KERNEL,HEAP];
$heap->{webc} = Test::POE::Client::TCP->spawn(
address => $uri->host,
port => $uri->port,
autoconnect => 1,
prefix => 'webc',
filter => POE::Filter::HTTP::Parser->new( debug => 1 ),
);
return;
}
sub webc_connected {
my ($kernel,$heap) = @_[KERNEL,HEAP];
my $req = HTTP::Request->new( GET => ( $uri->path || '/' ) );
$req->header( 'Host', $uri->host_port );
$req->protocol( 'HTTP/1.1' );
$heap->{webc}->send_to_server( $req );
return;
}
sub webc_input {
my ($heap,$input) = @_[HEAP,ARG0];
print $input->as_string;
$heap->{webc}->shutdown();
delete $heap->{webc};
return;
}
release-pod-coverage.t 000644 001751 000144 765 11535267211 21442 0 ustar 00chris users 000000 000000 POE-Filter-HTTP-Parser-1.06/t #!perl
BEGIN {
unless ($ENV{RELEASE_TESTING}) {
require Test::More;
Test::More::plan(skip_all => 'these tests are for release candidate testing');
}
}
use Test::More;
eval "use Test::Pod::Coverage 1.08";
plan skip_all => "Test::Pod::Coverage 1.08 required for testing POD coverage"
if $@;
eval "use Pod::Coverage::TrustPod";
plan skip_all => "Pod::Coverage::TrustPod required for testing POD coverage"
if $@;
all_pod_coverage_ok({ coverage_class => 'Pod::Coverage::TrustPod' });
HTTP 000755 001751 000144 0 11535267210 20066 5 ustar 00chris users 000000 000000 POE-Filter-HTTP-Parser-1.06/lib/POE/Filter Parser.pm 000644 001751 000144 20350 11535267210 22037 0 ustar 00chris users 000000 000000 POE-Filter-HTTP-Parser-1.06/lib/POE/Filter/HTTP package POE::Filter::HTTP::Parser;
BEGIN {
$POE::Filter::HTTP::Parser::VERSION = '1.06';
}
# ABSTRACT: A HTTP POE filter for HTTP clients or servers
use strict;
use warnings;
use HTTP::Parser;
use HTTP::Status qw(status_message RC_BAD_REQUEST RC_OK RC_LENGTH_REQUIRED);
use base 'POE::Filter';
use Encode qw[encode_utf8];
my %type_map = (
'server', 'request',
'client', 'response',
);
sub new {
my $class = shift;
my %opts = @_;
$opts{lc $_} = delete $opts{$_} for keys %opts;
if ( $opts{type} and defined $type_map{ $opts{type} } ) {
$opts{type} = $type_map{ $opts{type} };
}
$opts{type} = 'response' unless $opts{type} and $opts{type} =~ /^(request|response)$/;
my $self = \%opts;
$self->{BUFFER} = [];
$self->{parser} = HTTP::Parser->new( $self->{type} => 1 );
bless $self, $class;
}
sub get_one_start {
my ($self, $raw) = @_;
push @{ $self->{BUFFER} }, $_ for @$raw;
}
sub get_one {
my $self = shift;
my $events = [];
my $string = shift @{ $self->{BUFFER} };
return [] unless $string;
my $status;
eval { $status = $self->{parser}->add( $string ); };
if ( $@ and $self->{type} eq 'request' ) {
# Build a HTTP::Response error message
return [ $self->_build_error( RC_BAD_REQUEST, "$@
" ) ];
}
if ( $@ and $self->{debug} ) {
warn "$@\n";
warn "Input was: '$string'\n";
return $events;
}
if ( defined $status and $status == 0 ) {
push @$events, $self->{parser}->object();
my $data = $self->{parser}->data();
unshift @{ $self->{BUFFER} }, $data if $data;
$self->{parser} = HTTP::Parser->new( $self->{type} => 1 );
}
return $events;
}
sub _old_put {
my ($self, $chunks) = @_;
[ @$chunks ];
}
sub put {
my $self = shift;
my $return;
if ( $self->{type} eq 'request' ) {
$return = $self->_put_response( @_ );
}
else {
$return = $self->_put_request( @_ );
}
$return;
}
sub _put_response {
my ($self, $responses) = @_;
my @raw;
# HTTP::Response's as_string method returns the header lines
# terminated by "\n", which does not do the right thing if we want
# to send it to a client. Here I've stolen HTTP::Response's
# as_string's code and altered it to use network newlines so picky
# browsers like lynx get what they expect.
# And this is shamelessly stolen from POE::Filter::HTTPD
foreach (@$responses) {
my $code = $_->code;
my $status_message = status_message($code) || "Unknown Error";
my $message = $_->message || "";
my $proto = $_->protocol || 'HTTP/1.0';
my $status_line = "$proto $code";
$status_line .= " ($status_message)" if $status_message ne $message;
$status_line .= " $message" if length($message);
# Use network newlines, and be sure not to mangle newlines in the
# response's content.
my @headers;
push @headers, $status_line;
push @headers, $_->headers_as_string("\x0D\x0A");
push @raw, encode_utf8(join("\x0D\x0A", @headers, "")) . $_->content;
}
\@raw;
}
sub _put_request {
my ($self, $requests) = @_;
my @raw;
foreach (@$requests) {
my $req_line = $_->method || "-";
my $uri = $_->uri;
$uri = (defined $uri) ? $uri->as_string : "-";
$req_line .= " $uri";
my $proto = $_->protocol;
$req_line .= " $proto" if $proto;
# Use network newlines, and be sure not to mangle newlines in the
# response's content.
my @headers;
push @headers, $req_line;
push @headers, $_->headers_as_string("\x0D\x0A");
push @raw, encode_utf8(join("\x0D\x0A", @headers, "")) . $_->content;
}
\@raw;
}
sub clone {
my $self = shift;
my $nself = { };
$nself->{$_} = $self->{$_} for keys %{ $self };
$nself->{BUFFER} = [ ];
$nself->{parser} = HTTP::Parser->new( $nself->{type} => 1 );
return bless $nself, ref $self;
}
sub get_pending {
my $self = shift;
my $data = $self->{parser}->data();
return unless $data or scalar @{ $self->{BUFFER} };
return [ ( $data ? $data : () ), @{ $self->{BUFFER} } ];
}
sub _build_basic_response {
my ($self, $content, $content_type, $status) = @_;
# Need to check lengths in octets, not characters.
BEGIN { eval { require bytes } and bytes->import; }
$content_type ||= 'text/html';
$status ||= RC_OK;
my $response = HTTP::Response->new($status);
$response->push_header( 'Content-Type', $content_type );
$response->push_header( 'Content-Length', length($content) );
$response->content($content);
return $response;
}
sub _build_error {
my($self, $status, $details) = @_;
$status ||= RC_BAD_REQUEST;
$details ||= '';
my $message = status_message($status) || "Unknown Error";
return $self->_build_basic_response(
( "" .
"" .
"Error $status: $message" .
"" .
"" .
"Error $status: $message
" .
"$details
" .
"" .
""
),
"text/html",
$status
);
}
'I filter therefore I am';
__END__
=pod
=head1 NAME
POE::Filter::HTTP::Parser - A HTTP POE filter for HTTP clients or servers
=head1 VERSION
version 1.06
=head1 SYNOPSIS
use POE::Filter::HTTP::Parser;
# For HTTP Servers
my $request_filter = POE::Filter::HTTP::Parser->new( type => 'server' );
my $arrayref_of_request_objects = $filter->get( [ $stream ] );
my $arrayref_of_HTTP_stream = $filter->put( $arrayref_of_response_objects );
# For HTTP clients
my $response_filter = POE::Filter::HTTP::Parser->new( type => 'client' );
my $arrayref_of_HTTP_stream = $filter->put( $arrayref_of_request_objects );
my $arrayref_of_response_objects = $filter->get( [ $stream ] );
=head1 DESCRIPTION
POE::Filter::HTTP::Parser is a L for HTTP which is based on L.
It can be used to easily create L based HTTP servers or clients.
With the C set to C, which is the default behaviour, C will parse
L objects from HTTP streams and C will accept L
objects and convert them to HTTP streams.
With the C set to C, the reverse will happen. C will parse L
objects from HTTP streams and C will accept L objects and convert them to
HTTP streams. Like L if there is an error parsing the HTTP request, this
filter will generate a L object instead, to encapsulate the error message,
suitable for simply sending back to the requesting client.
=head1 CONSTRUCTOR
=over
=item C
Creates a new POE::Filter::HTTP::Parser object. Takes one optional argument, C which
determines whether the filter will act in C or C mode. C is the default
if C is not specified.
'type', set to either 'client' or 'server', default is 'client';
=back
=head1 METHODS
=over
=item C
=item C
=item C
Takes an arrayref which contains lines of text. Returns an arrayref of either
L or L objects depending on the C that has been
specified.
=item C
Returns any data remaining in a filter's input buffer. The filter's input buffer is not cleared, however.
Returns an array reference if there's any data, or undef if the filter was empty.
=item C
Takes an arrayref of either L objects or L objects depending on whether
C is set to C or C, respectively.
If C is C, then this accepts L objects.
If C is C, then this accepts L objects.
This does make sense if you think about it.
The given objects are returned to their stream form.
=item C
Makes a copy of the filter, and clears the copy's buffer.
=back
=head1 CREDITS
The C method for HTTP responses was borrowed from L,
along with the code to generate L on a parse error,
by Artur Bergman and Rocco Caputo.
=head1 SEE ALSO
L
L
L
=head1 AUTHOR
Chris Williams
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2011 by Chris Williams, Artur Bergman and Rocco Caputo.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut