COPYRIGHT000644001750001750 256712544325252 17167 0ustar00kjetilkjetil000000000000LWP-UserAgent-CHICaching-0.03Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ Upstream-Name: LWP-UserAgent-CHICaching Upstream-Contact: Kjetil Kjernsmo (KJETILK) Source: https://metacpan.org/release/LWP-UserAgent-CHICaching Files: Changes META.json META.yml dist.ini doap.ttl t/maxage.t t/vary.t Copyright: Copyright 2015 Kjetil Kjernsmo. License: GPL-1.0+ or Artistic-1.0 Files: README README.pod lib/LWP/UserAgent/CHICaching.pm lib/LWP/UserAgent/Role/CHICaching.pm lib/LWP/UserAgent/Role/CHICaching/SimpleKeyGen.pm lib/LWP/UserAgent/Role/CHICaching/VaryNotAsterisk.pm Copyright: This software is copyright (c) 2015 by Kjetil Kjernsmo. License: GPL-1.0+ or Artistic-1.0 Files: COPYRIGHT CREDITS SIGNATURE Copyright: None License: public-domain Files: INSTALL LICENSE Copyright: Unknown License: Unknown Files: Makefile.PL Copyright: Copyright 2013 Toby Inkster. License: GPL-1.0+ or Artistic-1.0 Files: t/01basic.t Copyright: This software is copyright (c) 2014 by Kjetil Kjernsmo. License: GPL-1.0+ or Artistic-1.0 License: Artistic-1.0 This software is Copyright (c) 2015 by the copyright holder(s). This is free software, licensed under: The Artistic License 1.0 License: GPL-1.0 This software is Copyright (c) 2015 by the copyright holder(s). This is free software, licensed under: The GNU General Public License, Version 1, February 1989 CREDITS000644001750001750 16412544325252 16663 0ustar00kjetilkjetil000000000000LWP-UserAgent-CHICaching-0.03Maintainer: - Kjetil Kjernsmo (KJETILK) Thanks: - Matt S Trout (MSTROUT) Changes000644001750001750 177012544325252 17162 0ustar00kjetilkjetil000000000000LWP-UserAgent-CHICaching-0.03LWP-UserAgent-CHICaching ======================== Created: 2014-09-03 Home page: Bug tracker: Maintainer: Kjetil Kjernsmo (KJETILK) 0.03 2015-06-29 Fix testing on old Perls - Skip some tests on old Perl versions, that doesn't support test syntax. 0.02 2015-06-29 Improve the support for Vary header - Add Moo version dep for coerce to work. - Added: Improve documentation. - Added: More tests. - Added: New role for simplest keys and Vary treatment. - Added: New role for when Vary is *. - Added: Refactor key and logic for Vary headers in roles on their own. 0.01 2015-06-26 Improve support for RFC7234 - Added: Add Perl version dep for better kwalitee. - Added: Improve distro metadata. - Added: Support large parts of RFC7234. 0.002 2015-02-17 Create a Role - Refactor the code into a Role. Matt S Trout++ 0.001 2015-02-17 Initial release INSTALL000644001750001750 177112544325252 16721 0ustar00kjetilkjetil000000000000LWP-UserAgent-CHICaching-0.03 Installing LWP-UserAgent-CHICaching should be straightforward. INSTALLATION WITH CPANMINUS If you have cpanm, you only need one line: % cpanm LWP::UserAgent::CHICaching If you are installing into a system-wide directory, you may need to pass the "-S" flag to cpanm, which uses sudo to install the module: % cpanm -S LWP::UserAgent::CHICaching INSTALLATION WITH THE CPAN SHELL Alternatively, if your CPAN shell is set up, you should just be able to do: % cpan LWP::UserAgent::CHICaching MANUAL INSTALLATION As a last resort, you can manually install it. Download the tarball and unpack it. Consult the file META.json for a list of pre-requisites. Install these first. To build LWP-UserAgent-CHICaching: % perl Makefile.PL % make && make test Then install it: % make install If you are installing into a system-wide directory, you may need to run: % sudo make install LICENSE000644001750001750 4366412544325252 16724 0ustar00kjetilkjetil000000000000LWP-UserAgent-CHICaching-0.03This software is copyright (c) 2015 by Kjetil Kjernsmo. 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) 2015 by Kjetil Kjernsmo. 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. 51 Franklin St, Suite 500, Boston, MA 02110-1335 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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301 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) 2015 by Kjetil Kjernsmo. 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 MANIFEST000644001750001750 51412544325252 16773 0ustar00kjetilkjetil000000000000LWP-UserAgent-CHICaching-0.03COPYRIGHT CREDITS Changes INSTALL LICENSE MANIFEST META.json META.yml Makefile.PL README README.pod SIGNATURE dist.ini doap.ttl lib/LWP/UserAgent/CHICaching.pm lib/LWP/UserAgent/Role/CHICaching.pm lib/LWP/UserAgent/Role/CHICaching/SimpleKeyGen.pm lib/LWP/UserAgent/Role/CHICaching/VaryNotAsterisk.pm t/01basic.t t/maxage.t t/vary.t META.json000644001750001750 501712544325252 17306 0ustar00kjetilkjetil000000000000LWP-UserAgent-CHICaching-0.03{ "abstract" : "LWP::UserAgent with caching based on CHI", "author" : [ "Kjetil Kjernsmo (KJETILK) " ], "dynamic_config" : 0, "generated_by" : "Dist::Inkt::Profile::TOBYINK version 0.023, CPAN::Meta::Converter version 2.133380", "keywords" : [], "license" : [ "perl_5" ], "meta-spec" : { "url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec", "version" : "2" }, "name" : "LWP-UserAgent-CHICaching", "no_index" : { "directory" : [ "eg", "examples", "inc", "t", "xt" ] }, "optional_features" : {}, "prereqs" : { "configure" : { "requires" : { "ExtUtils::MakeMaker" : "6.17" } }, "develop" : { "recommends" : { "Dist::Inkt" : "0.001" } }, "runtime" : { "requires" : { "CHI" : "0", "LWP::UserAgent" : "0", "Moo" : "1.006000", "Types::Standard" : "0", "Types::URI" : "0", "perl" : "5.006000" } }, "test" : { "requires" : { "LWP::Protocol::PSGI" : "0", "Plack::Request" : "0", "Test::More" : "0.96" } } }, "provides" : { "LWP::UserAgent::CHICaching" : { "file" : "lib/LWP/UserAgent/CHICaching.pm", "version" : "0.03" }, "LWP::UserAgent::Role::CHICaching" : { "file" : "lib/LWP/UserAgent/Role/CHICaching.pm", "version" : "0.03" }, "LWP::UserAgent::Role::CHICaching::SimpleKeyGen" : { "file" : "lib/LWP/UserAgent/Role/CHICaching/SimpleKeyGen.pm", "version" : "0.03" }, "LWP::UserAgent::Role::CHICaching::VaryNotAsterisk" : { "file" : "lib/LWP/UserAgent/Role/CHICaching/VaryNotAsterisk.pm", "version" : "0.03" } }, "release_status" : "stable", "resources" : { "bugtracker" : { "web" : "https://github.com/kjetilk/p5-lwp-useragent-chicaching/issues" }, "homepage" : "https://metacpan.org/release/LWP-UserAgent-CHICaching", "license" : [ "http://dev.perl.org/licenses/" ], "repository" : { "type" : "git", "url" : "git://github.com/kjetilk/p5-lwp-useragent-chicaching.git", "web" : "https://github.com/kjetilk/p5-lwp-useragent-chicaching" }, "x_identifier" : "http://purl.org/NET/cpan-uri/dist/LWP-UserAgent-CHICaching/project" }, "version" : "0.03" } META.yml000644001750001750 300012544325252 17124 0ustar00kjetilkjetil000000000000LWP-UserAgent-CHICaching-0.03--- abstract: 'LWP::UserAgent with caching based on CHI' author: - 'Kjetil Kjernsmo (KJETILK) ' build_requires: LWP::Protocol::PSGI: 0 Plack::Request: 0 Test::More: 0.96 configure_requires: ExtUtils::MakeMaker: 6.17 dynamic_config: 0 generated_by: 'Dist::Inkt::Profile::TOBYINK version 0.023, CPAN::Meta::Converter version 2.133380' keywords: [] license: perl meta-spec: url: http://module-build.sourceforge.net/META-spec-v1.4.html version: 1.4 name: LWP-UserAgent-CHICaching no_index: directory: - eg - examples - inc - t - xt optional_features: {} provides: LWP::UserAgent::CHICaching: file: lib/LWP/UserAgent/CHICaching.pm version: 0.03 LWP::UserAgent::Role::CHICaching: file: lib/LWP/UserAgent/Role/CHICaching.pm version: 0.03 LWP::UserAgent::Role::CHICaching::SimpleKeyGen: file: lib/LWP/UserAgent/Role/CHICaching/SimpleKeyGen.pm version: 0.03 LWP::UserAgent::Role::CHICaching::VaryNotAsterisk: file: lib/LWP/UserAgent/Role/CHICaching/VaryNotAsterisk.pm version: 0.03 requires: CHI: 0 LWP::UserAgent: 0 Moo: 1.006000 Types::Standard: 0 Types::URI: 0 perl: 5.006000 resources: Identifier: http://purl.org/NET/cpan-uri/dist/LWP-UserAgent-CHICaching/project bugtracker: https://github.com/kjetilk/p5-lwp-useragent-chicaching/issues homepage: https://metacpan.org/release/LWP-UserAgent-CHICaching license: http://dev.perl.org/licenses/ repository: git://github.com/kjetilk/p5-lwp-useragent-chicaching.git version: 0.03 Makefile.PL000644001750001750 1455612544325252 17667 0ustar00kjetilkjetil000000000000LWP-UserAgent-CHICaching-0.03use strict; use ExtUtils::MakeMaker 6.17; my $EUMM = eval( $ExtUtils::MakeMaker::VERSION ); my $meta = { "abstract" => "LWP::UserAgent with caching based on CHI", "author" => ["Kjetil Kjernsmo (KJETILK) "], "dynamic_config" => 0, "generated_by" => "Dist::Inkt::Profile::TOBYINK version 0.023, CPAN::Meta::Converter version 2.133380", "keywords" => [], "license" => ["perl_5"], "meta-spec" => { url => "http://search.cpan.org/perldoc?CPAN::Meta::Spec", version => 2, }, "name" => "LWP-UserAgent-CHICaching", "no_index" => { directory => ["eg", "examples", "inc", "t", "xt"] }, "prereqs" => { configure => { requires => { "ExtUtils::MakeMaker" => 6.17 } }, develop => { recommends => { "Dist::Inkt" => 0.001 } }, runtime => { requires => { "CHI" => 0, "LWP::UserAgent" => 0, "Moo" => "1.006000", "perl" => "5.006000", "Types::Standard" => 0, "Types::URI" => 0, }, }, test => { requires => { "LWP::Protocol::PSGI" => 0, "Plack::Request" => 0, "Test::More" => 0.96 }, }, }, "provides" => { "LWP::UserAgent::CHICaching" => { file => "lib/LWP/UserAgent/CHICaching.pm", version => 0.03 }, "LWP::UserAgent::Role::CHICaching" => { file => "lib/LWP/UserAgent/Role/CHICaching.pm", version => 0.03 }, "LWP::UserAgent::Role::CHICaching::SimpleKeyGen" => { file => "lib/LWP/UserAgent/Role/CHICaching/SimpleKeyGen.pm", version => 0.03, }, "LWP::UserAgent::Role::CHICaching::VaryNotAsterisk" => { file => "lib/LWP/UserAgent/Role/CHICaching/VaryNotAsterisk.pm", version => 0.03, }, }, "release_status" => "stable", "resources" => { bugtracker => { web => "https://github.com/kjetilk/p5-lwp-useragent-chicaching/issues", }, homepage => "https://metacpan.org/release/LWP-UserAgent-CHICaching", license => ["http://dev.perl.org/licenses/"], repository => { type => "git", url => "git://github.com/kjetilk/p5-lwp-useragent-chicaching.git", web => "https://github.com/kjetilk/p5-lwp-useragent-chicaching", }, x_identifier => "http://purl.org/NET/cpan-uri/dist/LWP-UserAgent-CHICaching/project", }, "version" => 0.03, }; my %dynamic_config; my %WriteMakefileArgs = ( ABSTRACT => $meta->{abstract}, AUTHOR => ($EUMM >= 6.5702 ? $meta->{author} : $meta->{author}[0]), DISTNAME => $meta->{name}, VERSION => $meta->{version}, EXE_FILES => [ map $_->{file}, values %{ $meta->{x_provides_scripts} || {} } ], NAME => do { my $n = $meta->{name}; $n =~ s/-/::/g; $n }, test => { TESTS => "t/*.t" }, %dynamic_config, ); $WriteMakefileArgs{LICENSE} = $meta->{license}[0] if $EUMM >= 6.3001; sub deps { my %r; for my $stage (@_) { for my $dep (keys %{$meta->{prereqs}{$stage}{requires}}) { next if $dep eq 'perl'; my $ver = $meta->{prereqs}{$stage}{requires}{$dep}; $r{$dep} = $ver if !exists($r{$dep}) || $ver >= $r{$dep}; } } \%r; } my ($build_requires, $configure_requires, $runtime_requires, $test_requires); if ($EUMM >= 6.6303) { $WriteMakefileArgs{BUILD_REQUIRES} ||= deps('build'); $WriteMakefileArgs{CONFIGURE_REQUIRES} ||= deps('configure'); $WriteMakefileArgs{TEST_REQUIRES} ||= deps('test'); $WriteMakefileArgs{PREREQ_PM} ||= deps('runtime'); } elsif ($EUMM >= 6.5503) { $WriteMakefileArgs{BUILD_REQUIRES} ||= deps('build', 'test'); $WriteMakefileArgs{CONFIGURE_REQUIRES} ||= deps('configure'); $WriteMakefileArgs{PREREQ_PM} ||= deps('runtime'); } elsif ($EUMM >= 6.52) { $WriteMakefileArgs{CONFIGURE_REQUIRES} ||= deps('configure'); $WriteMakefileArgs{PREREQ_PM} ||= deps('runtime', 'build', 'test'); } else { $WriteMakefileArgs{PREREQ_PM} ||= deps('configure', 'build', 'test', 'runtime'); } { my ($minperl) = reverse sort( grep defined && /^[0-9]+(\.[0-9]+)?$/, map $meta->{prereqs}{$_}{requires}{perl}, qw( configure build runtime ) ); if (defined($minperl)) { die "Installing $meta->{name} requires Perl >= $minperl" unless $] >= $minperl; $WriteMakefileArgs{MIN_PERL_VERSION} ||= $minperl if $EUMM >= 6.48; } } sub FixMakefile { return unless -d 'inc'; my $file = shift; local *MAKEFILE; open MAKEFILE, "< $file" or die "FixMakefile: Couldn't open $file: $!; bailing out"; my $makefile = do { local $/; }; close MAKEFILE or die $!; $makefile =~ s/\b(test_harness\(\$\(TEST_VERBOSE\), )/$1'inc', /; $makefile =~ s/( -I\$\(INST_ARCHLIB\))/ -Iinc$1/g; $makefile =~ s/( "-I\$\(INST_LIB\)")/ "-Iinc"$1/g; $makefile =~ s/^(FULLPERL = .*)/$1 "-Iinc"/m; $makefile =~ s/^(PERL = .*)/$1 "-Iinc"/m; open MAKEFILE, "> $file" or die "FixMakefile: Couldn't open $file: $!; bailing out"; print MAKEFILE $makefile or die $!; close MAKEFILE or die $!; } my $mm = WriteMakefile(%WriteMakefileArgs); FixMakefile($mm->{FIRST_MAKEFILE} || 'Makefile'); exit(0); README000644001750001750 377712544325252 16560 0ustar00kjetilkjetil000000000000LWP-UserAgent-CHICaching-0.03NAME LWP::UserAgent::CHICaching - LWP::UserAgent with caching based on CHI SYNOPSIS The usual way of using LWP::UserAgent, really, just pass a `cache` parameter with a CHI object to the constructor: my $cache = CHI->new( driver => 'Memory', global => 1 ); my $ua = LWP::UserAgent::CHICaching->new(cache => $cache); my $res1 = $ua->get("http://localhost:3000/?query=DAHUT"); DESCRIPTION This is YA caching user agent. When the client makes a request to the server, sometimes the response should be cached, so that no actual request has to be sent at all, or possibly just a request to validate the cache. HTTP 1.1 defines how to do this. This class simply extends LWP::UserAgent with LWP::UserAgent::Role::CHICaching (also in this distribution) which is doing the real work to make it possible to use the very flexible CHI module to manage such a cache. But why? Mainly because I wanted to use CHI facilities, and partly because I wanted to focus on HTTP 1.1 features. TODO This is an early release, but it supports RFC7234 quite well already. Much work remains though. These are the things that I'd like to do: * Enable smarter generation of keys, so that semantically identical content can be cached efficiently even though they may have different URIs. This can be done in a separate role with the current code. * Support all of RFC7234 and RFC7232 AUTHOR Kjetil Kjernsmo . COPYRIGHT AND LICENCE This software is copyright (c) 2015 by Kjetil Kjernsmo. This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. DISCLAIMER OF WARRANTIES 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. README.pod000644001750001750 436612544325252 17334 0ustar00kjetilkjetil000000000000LWP-UserAgent-CHICaching-0.03package LWP::UserAgent::CHICaching; use 5.006000; our $AUTHORITY = 'cpan:KJETILK'; our $VERSION = '0.03'; use Moo; extends 'LWP::UserAgent'; with 'LWP::UserAgent::Role::CHICaching', 'LWP::UserAgent::Role::CHICaching::SimpleKeyGen'; 1; =pod =encoding utf-8 =head1 NAME LWP::UserAgent::CHICaching - LWP::UserAgent with caching based on CHI =head1 SYNOPSIS The usual way of using L, really, just pass a C parameter with a L object to the constructor: my $cache = CHI->new( driver => 'Memory', global => 1 ); my $ua = LWP::UserAgent::CHICaching->new(cache => $cache); my $res1 = $ua->get("http://localhost:3000/?query=DAHUT"); =head1 DESCRIPTION This is YA caching user agent. When the client makes a request to the server, sometimes the response should be cached, so that no actual request has to be sent at all, or possibly just a request to validate the cache. HTTP 1.1 defines how to do this. This class simply extends L with L (also in this distribution) which is doing the real work to make it possible to use the very flexible L module to manage such a cache. But why? Mainly because I wanted to use L facilities, and partly because I wanted to focus on HTTP 1.1 features. =head1 TODO This is an early release, but it supports RFC7234 quite well already. Much work remains though. These are the things that I'd like to do: =over =item * Enable smarter generation of keys, so that semantically identical content can be cached efficiently even though they may have different URIs. This can be done in a separate role with the current code. =item * Support all of L and L =back =head1 AUTHOR Kjetil Kjernsmo Ekjetilk@cpan.orgE. =head1 COPYRIGHT AND LICENCE This software is copyright (c) 2015 by Kjetil Kjernsmo. This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. =head1 DISCLAIMER OF WARRANTIES 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. SIGNATURE000644001750001750 503512544325270 17151 0ustar00kjetilkjetil000000000000LWP-UserAgent-CHICaching-0.03This file contains message digests of all files listed in MANIFEST, signed via the Module::Signature module, version 0.73. To verify the content in this distribution, first make sure you have Module::Signature installed, then type: % cpansign -v It will check each file's integrity, as well as the signature's validity. If "==> Signature verified OK! <==" is not displayed, the distribution may already have been compromised, and you should not run its Makefile.PL or Build.PL. -----BEGIN PGP SIGNED MESSAGE----- Hash: SHA256 SHA1 58360249e10611bee83dea1de99a24a975bbe5e2 COPYRIGHT SHA1 1a7f4f0ed7f702d78ab613cac4d160099dc9c350 CREDITS SHA1 2d76ace30f60d44d611632bfb4754065c97694bd Changes SHA1 a3ae4f583f47722f2be214a8f525a2178f5973c1 INSTALL SHA1 1e48bd80fcf337dfe5aedd07d3012ffa792a162a LICENSE SHA1 3b91009dbb6ea46fbbf98003ecd2d739c6ded53a MANIFEST SHA1 4bf0e94bddf296a2013a80c590b68fdb7819dec5 META.json SHA1 63277112992c2c3bdb1fe175c19d8b6ddc716170 META.yml SHA1 06fc0d15d7cc3bd459095e747ab797755746025c Makefile.PL SHA1 edaaf71b8abfc1979cba8b0b3753277d55c8c688 README SHA1 47c3596adc87c3bdf9a72ae9cd5648f424114c76 README.pod SHA1 959848056a74404c176766a0604f0359f70464a0 dist.ini SHA1 233d3495af268a8784322a30a657c63efab20ca4 doap.ttl SHA1 47c3596adc87c3bdf9a72ae9cd5648f424114c76 lib/LWP/UserAgent/CHICaching.pm SHA1 7b240a495f04dc21219cdae528744f8a551727c2 lib/LWP/UserAgent/Role/CHICaching.pm SHA1 7675571a728f503f4403cd227538f39be0adcf99 lib/LWP/UserAgent/Role/CHICaching/SimpleKeyGen.pm SHA1 d646dbce280bd32ea131b2dd34eddbd646a96331 lib/LWP/UserAgent/Role/CHICaching/VaryNotAsterisk.pm SHA1 48d4455bc047d8810c5c52e6ac0a9edd4fc46c9b t/01basic.t SHA1 3535bac74e27eb1a467247d8ed26f9455c116ea7 t/maxage.t SHA1 0894711613089f356c4c3c3e05370e1bfd90d8aa t/vary.t -----BEGIN PGP SIGNATURE----- Version: GnuPG v1 iQIVAwUBVZGqqn++6N86nkqlAQh0og/7B5U+ft9vzzNvVUQhfAQ9c+/R7F0FyeKb paQbPVdY/OYuqpUWnUJf42BFs6Mhjq64IKA5VJ+YijxErY8VCWz5ClNu2KBNSL26 puAuioXZuN5nBleF4ESVZOnI3fukj8dNsXo2f7WXm/es8Nd5EZDFqnDyHd3sL7NR Fh+v/QKqAajbY2zxcB3HCOSJlsY0nXZgu5zAVZeZDNt3fkAd4KBfjYgJamtjvDun XQZTy3/vhY5VOGBsqI3+mV+u75xDNfwmvgEUnqAo/4Cpj8yB+PB4TsoarLOSEaIt N9R9Q/6myZCX61zHIQgEj6cHYNzraPff3amcTPpkLaSKOQ3yPxgAy+eK3IXR6HFi rZEEdrdFwyPPgTSjMJWrgRJrTkgfr+fbbD2z8ZzT/Ljo7Rgv37/5xNE7kpO7WkR9 d9fSqXyQJ9B6kHNM2CeYlOBy2rms00PxTR3NWlYaJh9fPdE7wf2/uz9lO1ZZCBix 7Vm8BdrNq6HS5iUi+mO9n//lHzETcFsUxDfaSjBUgBtukPU9K4CPQVMSP2Bz2qqY wmSVJsorT1YQ8RvpZi8aiUXsHuBD98WY3QexGOeVbqlXGi/8ZJopUqURzPzaBmK2 b7Yugo6aZIDbIluj0Ez2zXxq26jKdeosga+ueqAR9KKn4wTa8KE2VSog5nwyZSTU lo2GZpVCqiw= =hikF -----END PGP SIGNATURE----- dist.ini000644001750001750 11212544325252 17300 0ustar00kjetilkjetil000000000000LWP-UserAgent-CHICaching-0.03;;class='Dist::Inkt::Profile::TOBYINK' ;;name='LWP-UserAgent-CHICaching' doap.ttl000644001750001750 1654012544325252 17360 0ustar00kjetilkjetil000000000000LWP-UserAgent-CHICaching-0.03@prefix dc: . @prefix doap: . @prefix doap-changeset: . @prefix doap-deps: . @prefix foaf: . @prefix owl: . @prefix prov: . @prefix rdfs: . @prefix xsd: . dc:title "the same terms as the perl 5 programming language system itself". a doap:Project; dc:contributor ; doap-deps:develop-recommendation [ doap-deps:on "Dist::Inkt 0.001"^^doap-deps:CpanId ]; doap-deps:runtime-requirement [ doap-deps:on "perl 5.006000"^^doap-deps:CpanId ], [ doap-deps:on "CHI"^^doap-deps:CpanId ], [ doap-deps:on "Moo 1.006000"^^doap-deps:CpanId ], [ doap-deps:on "Types::Standard"^^doap-deps:CpanId ], [ doap-deps:on "Types::URI"^^doap-deps:CpanId ], [ doap-deps:on "LWP::UserAgent"^^doap-deps:CpanId ]; doap-deps:test-requirement [ doap-deps:on "Test::More 0.96"^^doap-deps:CpanId ], [ doap-deps:on "LWP::Protocol::PSGI"^^doap-deps:CpanId; ], [ doap-deps:on "Plack::Request"^^doap-deps:CpanId ]; doap:bug-database ; doap:category ; doap:created "2014-09-03"^^xsd:date; doap:developer ; doap:download-page ; doap:homepage ; doap:license ; doap:maintainer ; doap:name "LWP-UserAgent-CHICaching"; doap:programming-language "Perl"; doap:release , , , , ; doap:repository [ a doap:GitRepository; doap:browse ; prov:has_provenance ; ]; doap:shortdesc "LWP::UserAgent with caching based on CHI". a doap:Version; rdfs:label "Initial release"; dc:identifier "LWP-UserAgent-CHICaching-0.001"^^xsd:string; dc:issued "2015-02-17"^^xsd:date; doap-changeset:released-by ; doap:file-release ; doap:revision "0.001"^^xsd:string. a doap:Version; rdfs:label "Create a Role"; dc:identifier "LWP-UserAgent-CHICaching-0.002"^^xsd:string; dc:issued "2015-02-17"^^xsd:date; doap-changeset:changeset [ doap-changeset:item [ a doap-changeset:Change; rdfs:label "Refactor the code into a Role."; doap-changeset:thanks ; ]; doap-changeset:versus ; ]; doap-changeset:released-by ; doap:file-release ; doap:revision "0.002"^^xsd:string. a doap:Version; rdfs:label "Improve support for RFC7234"; dc:identifier "LWP-UserAgent-CHICaching-0.01"^^xsd:string; dc:issued "2015-06-26"^^xsd:date; doap-changeset:changeset [ doap-changeset:item [ a doap-changeset:Addition; rdfs:label "Support large parts of RFC7234."; ], [ a doap-changeset:Addition; rdfs:label "Add Perl version dep for better kwalitee."; ], [ a doap-changeset:Addition; rdfs:label "Improve distro metadata."; ]; doap-changeset:versus ; ]; doap-changeset:released-by ; doap:file-release ; doap:revision "0.01"^^xsd:string. a doap:Version; rdfs:label "Improve the support for Vary header"; dc:identifier "LWP-UserAgent-CHICaching-0.02"^^xsd:string; dc:issued "2015-06-29"^^xsd:date; doap-changeset:changeset [ doap-changeset:item [ a doap-changeset:Addition; rdfs:label "Refactor key and logic for Vary headers in roles on their own."; ], [ a doap-changeset:Change; rdfs:label "Add Moo version dep for coerce to work."; ], [ a doap-changeset:Addition; rdfs:label "New role for simplest keys and Vary treatment."; ], [ a doap-changeset:Addition; rdfs:label "New role for when Vary is *."; ], [ a doap-changeset:Addition; rdfs:label "Improve documentation."; ], [ a doap-changeset:Addition; rdfs:label "More tests."; ]; doap-changeset:versus ; ]; doap-changeset:released-by ; doap:file-release ; doap:revision "0.02"^^xsd:string. a doap:Version; rdfs:label "Fix testing on old Perls"; dc:identifier "LWP-UserAgent-CHICaching-0.03"^^xsd:string; dc:issued "2015-06-29"^^xsd:date; doap-changeset:changeset [ doap-changeset:item [ a doap-changeset:Change; rdfs:label "Skip some tests on old Perl versions, that doesn't support test syntax."; ]; doap-changeset:versus ; ]; doap-changeset:released-by ; doap:file-release ; doap:revision "0.03"^^xsd:string. a foaf:Person; foaf:mbox ; foaf:name "Kjetil Kjernsmo"; owl:sameAs , . a foaf:Person; foaf:mbox ; foaf:name "Matt S Trout"; foaf:nick "MSTROUT", "mst"; foaf:page . 01basic.t000644001750001750 73212544325252 17516 0ustar00kjetilkjetil000000000000LWP-UserAgent-CHICaching-0.03/t=pod =encoding utf-8 =head1 PURPOSE Test that LWP::UserAgent::CHICaching compiles. =head1 AUTHOR Kjetil Kjernsmo Ekjetilk@cpan.orgE. =head1 COPYRIGHT AND LICENCE This software is copyright (c) 2014 by Kjetil Kjernsmo. 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 use strict; use warnings; use Test::More; use_ok('LWP::UserAgent::CHICaching'); done_testing; maxage.t000644001750001750 357712544325252 17570 0ustar00kjetilkjetil000000000000LWP-UserAgent-CHICaching-0.03/tuse strict; use warnings; use Test::More; use LWP::Protocol::PSGI; use CHI; use Plack::Request; use_ok('LWP::UserAgent::CHICaching'); my %counter; $counter{'DAHUT'} = 0; my $app = sub { my $env = shift; my $req = Plack::Request->new($env); my $query = $req->param('query'); $counter{$query}++; my $content = "Hello $query\nCounter: $counter{$query}"; return [ 200, [ 'Cache-Control' => 'max-age=4', 'Content-Type' => 'text/plain'], [ $content] ] }; LWP::Protocol::PSGI->register($app); my $cache = CHI->new( driver => 'Memory', global => 1 ); my $ua = LWP::UserAgent::CHICaching->new(cache => $cache); my $res1 = $ua->get("http://localhost:3000/?query=DAHUT"); isa_ok($res1, 'HTTP::Response'); like($res1->content, qr/Hello DAHUT/, 'First request, got the right shout'); like($res1->content, qr/Counter: 1$/, 'First request, correct count'); is($res1->freshness_lifetime, 4, 'Freshness lifetime is 4 secs'); is($ua->cache_vary($res1), 1, 'Vary header not present, so we can cache'); my $cres = $cache->get("http://localhost:3000/?query=DAHUT"); isa_ok($cres, 'HTTP::Response'); note "Sleep 2 secs to see Age"; sleep 2; my $res2 = $ua->get("http://localhost:3000/?query=DAHUT"); like($res2->content, qr/Hello DAHUT/, 'Second request, got the right shout'); like($res2->content, qr/Counter: 1$/, 'Second request, the count is the same'); unlike($res2->content, qr/Counter: 2/, 'Second request, the count is not 2'); is($res2->header('Age'), 2, 'The Age of resource is 2 secs'); is($ua->cache_vary($res2), 1, 'Vary header not present, so we can cache'); note "Sleep 3 secs to expire cache"; sleep 3; my $res3 = $ua->get("http://localhost:3000/?query=DAHUT"); like($res3->content, qr/Hello DAHUT/, 'Third request, got the right shout'); like($res3->content, qr/Counter: 2$/, 'Third request, the count is 2'); unlike($res3->content, qr/Counter: 3/, 'Third request, the count is not 3'); done_testing; vary.t000644001750001750 747212544325252 17305 0ustar00kjetilkjetil000000000000LWP-UserAgent-CHICaching-0.03/t BEGIN { use Test::More; if ($] < 5.014) { plan skip_all => 'Contains things old perls cannot parse'; } } use strict; use warnings; use LWP::Protocol::PSGI; use LWP::UserAgent; use CHI; use Plack::Request; package TestUAManual { use Moo; use Types::Standard qw(Str); extends 'LWP::UserAgent'; has key => ( is => 'rw', isa => Str, lazy => 1, clearer => 1, builder => '_build_key' ); sub _build_key { shift->request_uri->canonical->as_string } with 'LWP::UserAgent::Role::CHICaching', 'LWP::UserAgent::Role::CHICaching::VaryNotAsterisk'; } use_ok('LWP::UserAgent::CHICaching'); my $app = sub { my $env = shift; my $req = Plack::Request->new($env); my %headers = ('Cache-Control' => 'max-age=100', 'Content-Type' => 'text/plain'); my $vary = $req->param('vary'); if (defined($vary)) { $headers{'Vary'} = $vary; } return [ 200, [ %headers ], [ "Hello dahut"] ] }; LWP::Protocol::PSGI->register($app); my $cache = CHI->new( driver => 'Memory', global => 1 ); subtest 'Testing normal UA without Vary' => sub { my $uabasic = LWP::UserAgent::CHICaching->new(cache => $cache); my $res1 = $uabasic->get("http://localhost:3000/"); isa_ok($res1, 'HTTP::Response'); is($res1->content, 'Hello dahut', 'First request, got the right shout'); is($res1->freshness_lifetime, 100, 'Freshness lifetime is 100 secs'); is($uabasic->cache_vary($res1), 1, 'Vary header not present, so we can cache'); }; subtest 'Testing normal UA with Vary' => sub { my $uabasic = LWP::UserAgent::CHICaching->new(cache => $cache); my $res1 = $uabasic->get("http://localhost:3000/?vary=accept"); isa_ok($res1, 'HTTP::Response'); is($res1->content, 'Hello dahut', 'First request, got the right shout'); is($res1->freshness_lifetime, 100, 'Freshness lifetime is 100 secs'); is($uabasic->cache_vary($res1), 0, 'Vary header present, so we cant cache'); is($res1->header('Vary'), 'accept', 'Check the actual header'); }; subtest 'Testing normal UA with Vary: *' => sub { my $uabasic = LWP::UserAgent::CHICaching->new(cache => $cache); my $res1 = $uabasic->get("http://localhost:3000/?vary=*"); isa_ok($res1, 'HTTP::Response'); is($res1->content, 'Hello dahut', 'First request, got the right shout'); is($res1->freshness_lifetime, 100, 'Freshness lifetime is 100 secs'); is($uabasic->cache_vary($res1), 0, 'Vary header present, so we cant cache'); is($res1->header('Vary'), '*', 'Check the actual header'); }; subtest 'Testing manually composed UA without Vary' => sub { my $uamanual = TestUAManual->new(cache => $cache); my $res1 = $uamanual->get("http://localhost:3000/"); isa_ok($res1, 'HTTP::Response'); is($res1->content, 'Hello dahut', 'First request, got the right shout'); is($res1->freshness_lifetime, 100, 'Freshness lifetime is 100 secs'); is($uamanual->cache_vary($res1), 1, 'Vary header not present, so we can cache'); }; subtest 'Testing manually composed UA with Vary' => sub { my $uamanual = TestUAManual->new(cache => $cache); my $res1 = $uamanual->get("http://localhost:3000/?vary=accept"); isa_ok($res1, 'HTTP::Response'); is($res1->content, 'Hello dahut', 'First request, got the right shout'); is($res1->freshness_lifetime, 100, 'Freshness lifetime is 100 secs'); is($uamanual->cache_vary($res1), 1, 'Vary header with accept present, we can cache that'); is($res1->header('Vary'), 'accept', 'Check the actual header'); }; subtest 'Testing manually composed UA with Vary: *' => sub { my $uamanual = TestUAManual->new(cache => $cache); my $res1 = $uamanual->get("http://localhost:3000/?vary=*"); isa_ok($res1, 'HTTP::Response'); is($res1->content, 'Hello dahut', 'First request, got the right shout'); is($res1->freshness_lifetime, 100, 'Freshness lifetime is 100 secs'); is($uamanual->cache_vary($res1), 0, 'Vary header present, so we cant cache'); is($res1->header('Vary'), '*', 'Check the actual header'); }; done_testing; CHICaching.pm000644001750001750 436612544325252 23216 0ustar00kjetilkjetil000000000000LWP-UserAgent-CHICaching-0.03/lib/LWP/UserAgentpackage LWP::UserAgent::CHICaching; use 5.006000; our $AUTHORITY = 'cpan:KJETILK'; our $VERSION = '0.03'; use Moo; extends 'LWP::UserAgent'; with 'LWP::UserAgent::Role::CHICaching', 'LWP::UserAgent::Role::CHICaching::SimpleKeyGen'; 1; =pod =encoding utf-8 =head1 NAME LWP::UserAgent::CHICaching - LWP::UserAgent with caching based on CHI =head1 SYNOPSIS The usual way of using L, really, just pass a C parameter with a L object to the constructor: my $cache = CHI->new( driver => 'Memory', global => 1 ); my $ua = LWP::UserAgent::CHICaching->new(cache => $cache); my $res1 = $ua->get("http://localhost:3000/?query=DAHUT"); =head1 DESCRIPTION This is YA caching user agent. When the client makes a request to the server, sometimes the response should be cached, so that no actual request has to be sent at all, or possibly just a request to validate the cache. HTTP 1.1 defines how to do this. This class simply extends L with L (also in this distribution) which is doing the real work to make it possible to use the very flexible L module to manage such a cache. But why? Mainly because I wanted to use L facilities, and partly because I wanted to focus on HTTP 1.1 features. =head1 TODO This is an early release, but it supports RFC7234 quite well already. Much work remains though. These are the things that I'd like to do: =over =item * Enable smarter generation of keys, so that semantically identical content can be cached efficiently even though they may have different URIs. This can be done in a separate role with the current code. =item * Support all of L and L =back =head1 AUTHOR Kjetil Kjernsmo Ekjetilk@cpan.orgE. =head1 COPYRIGHT AND LICENCE This software is copyright (c) 2015 by Kjetil Kjernsmo. This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. =head1 DISCLAIMER OF WARRANTIES 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. CHICaching.pm000644001750001750 1536312544325252 24136 0ustar00kjetilkjetil000000000000LWP-UserAgent-CHICaching-0.03/lib/LWP/UserAgent/Rolepackage LWP::UserAgent::Role::CHICaching; use 5.006000; use CHI; use Moo::Role; use Types::Standard qw(Str Bool Ref InstanceOf); use Types::URI -all; our $AUTHORITY = 'cpan:KJETILK'; our $VERSION = '0.03'; =pod =encoding utf-8 =head1 NAME LWP::UserAgent::Role::CHICaching - A role to allow LWP::UserAgent to cache with CHI =head1 SYNOPSIS Compose it into a class, e.g. package LWP::UserAgent::MyCacher; use Moo; extends 'LWP::UserAgent'; with 'LWP::UserAgent::Role::CHICaching', 'LWP::UserAgent::Role::CHICaching::SimpleKeyGen'; =head1 DESCRIPTION This is a role for creating caching user agents. When the client makes a request to the server, sometimes the response should be cached, so that no actual request has to be sent at all, or possibly just a request to validate the cache. HTTP 1.1 defines how to do this. This role makes it possible to use the very flexible L module to manage such a cache. See L for a finished class you can use. =head2 Attributes and Methods =over =item C<< cache >> Used to set the C object to be used as cache in the constructor. =item C<< request_uri >> The Request-URI of the request. When set, it will clear the C, but should probably be left to be used internally for now. =item C<< request >> Wrapping L's request method. =item C<< is_shared >> A boolean value to set whether the cache can be shared. The default is that it is. =item C<< heuristics_opts >> A hashref that is passed to the C method of L, and used to determine the behaviour of the heuristic lifetime. By default, heuristic freshness lifetime is off, only standards-compliant freshness lifetime (i.e. based on the C and C headers) are used. =back =head2 Implemented elsewhere The following are required by this role, but implemented elsewhere. See L for further explanations. =over =item C<< key >>, C<< clear_key >> The key to use for a response. =item C<< cache_vary($response) >> A method that returns true if the response may be cached even if it contains a C header, false otherwise. The L object will be passed to it as a parameter. =back =cut has cache => ( is => 'ro', isa => InstanceOf['CHI::Driver'], required => 1, ); requires 'key'; requires 'cache_vary'; has request_uri => ( is =>'rw', isa => Uri, coerce => 1, trigger => sub { shift->clear_key }, ); has is_shared => ( is => 'rw', isa => Bool, default => 1); has heuristics_opts => ( is => 'rw', isa => Ref['HASH'], default => sub {return {heuristic_expiry => 0}} ); around request => sub { my ($orig, $self) = (shift, shift); my @args = @_; my $request = $args[0]; return $self->$orig(@args) if $request->method ne 'GET'; $self->request_uri($request->uri); my $cached = $self->cache->get($self->key); # CHI will take care of expiration my $expires_in = 0; if (defined($cached)) { ######## Here, we decide whether to reuse a cached response. ######## The standard describing this is: ######## http://tools.ietf.org/html/rfc7234#section-4 $cached->header('Age' => $cached->current_age); return $cached; } else { my $res = $self->$orig(@args); ######## Here, we decide whether to store a response ######## This is defined in: ######## http://tools.ietf.org/html/rfc7234#section-3 # Quoting the standard ## A cache MUST NOT store a response to any request, unless: ## o The request method is understood by the cache and defined as being ## cacheable, and # TODO: Ok, only GET supported, see above ## o the response status code is understood by the cache, and if ($res->is_success) { # TODO: Cache only successful responses for now # First, we deal superficially with the Vary header, for the # full complexity see # http://tools.ietf.org/html/rfc7234#section-4.1 return $res unless ($self->cache_vary($res)); my $cc = join('|',$res->header('Cache-Control')); # Since we only do string matching, this should be ok if (defined($cc)) { ## o the "no-store" cache directive (see Section 5.2) does not appear ## in request or response header fields, and return $res if ($cc =~ m/no-store|no-cache/); # TODO: Improve no-cache use if ($self->is_shared) { ## o the "private" response directive (see Section 5.2.2.6) does not ## appear in the response, if the cache is shared, and return $res if ($cc =~ m/private/); ## o the Authorization header field (see Section 4.2 of [RFC7235]) does ## not appear in the request, if the cache is shared, unless the ## response explicitly allows it (see Section 3.2), and if ($request->header('Authorization')) { return $res unless ($cc =~ m/public|must-revalidate|s-maxage/); } } ## o the response either: ## ## * contains an Expires header field (see Section 5.3), or ## * contains a max-age response directive (see Section 5.2.2.8), or # This is implemented in HTTP::Response, but it relates to the old RFC2616 # and doesn't support shared caches. $expires_in = $res->freshness_lifetime(%{$self->heuristics_opts}) || 0; ## * contains a s-maxage response directive (see Section 5.2.2.9) ## and the cache is shared, or if ($self->is_shared && ($cc =~ m/s-maxage\s*=\s*(\d+)/)) { $expires_in = $1; } ## * contains a Cache Control Extension (see Section 5.2.3) that ## allows it to be cached, or # TODO ## * has a status code that is defined as cacheable by default (see ## Section 4.2.2), or # TODO: We only do GET ## * contains a public response directive (see Section 5.2.2.5). # We do not specifically deal with this } if ($expires_in > 0) { $self->cache->set($self->key, $res, { expires_in => $expires_in }); } } return $res; } }; 1; __END__ =head1 LIMITATIONS Will only cache C requests, and only successful responses. The module does not validate and does not serve stale responses, even when it would be allowed to do so. It nevertheless does most of RFC7234. =head1 BUGS Please report any bugs to L. =head1 AUTHOR Kjetil Kjernsmo Ekjetilk@cpan.orgE. =head1 ACKNOWLEDGEMENTS It was really nice looking at the code of L, when I wrote this. Thanks to Matt S. Trout for rewriting this to a Role. =head1 COPYRIGHT AND LICENCE This software is copyright (c) 2015 by Kjetil Kjernsmo. This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. SimpleKeyGen.pm000644001750001750 421412544325252 26443 0ustar00kjetilkjetil000000000000LWP-UserAgent-CHICaching-0.03/lib/LWP/UserAgent/Role/CHICachingpackage LWP::UserAgent::Role::CHICaching::SimpleKeyGen; use 5.006000; use CHI; use Moo::Role; use Types::Standard qw(Str); our $AUTHORITY = 'cpan:KJETILK'; our $VERSION = '0.03'; =pod =encoding utf-8 =head1 NAME LWP::UserAgent::Role::CHICaching::SimpleKeyGen - A role for cache keys when caching LWP::UserAgent =head1 SYNOPSIS See L. =head1 DESCRIPTION L is a role for creating caching user agents. There's some complexity around caching different variants of the same resource (e.g. the same thing in different natural languages, different serializations that is considered in L
that this role is factored out to address in the dumbest way possible: Just don't cache when the problem arises. To really solve this problem in a better way, you need to generate a cache key based on not only the URI, but also on the content (e.g. C), and so, provide a better implementation of the C attribute, and then, you also need to tell the system when it is OK to cache something with a C header by making the C method smarter. See L for an example of an alternative. =head2 Attributes and Methods =over =item C<< key >>, C<< clear_key >> The key to use for a response. This role will return the canonical URI of the request as a string, which is a reasonable default. =item C<< cache_vary >> Will never allow a response with a C header to be cached. =back =cut has key => ( is => 'rw', isa => Str, lazy => 1, clearer => 1, builder => '_build_key' ); sub _build_key { return shift->request_uri->canonical->as_string } sub cache_vary { my ($self, $res) = @_; return (defined($res->header('Vary')) ? 0 : 1); } 1; __END__ =head1 AUTHOR Kjetil Kjernsmo Ekjetilk@cpan.orgE. =head1 COPYRIGHT AND LICENCE This software is copyright (c) 2015 by Kjetil Kjernsmo. This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. VaryNotAsterisk.pm000644001750001750 242112544325252 27215 0ustar00kjetilkjetil000000000000LWP-UserAgent-CHICaching-0.03/lib/LWP/UserAgent/Role/CHICachingpackage LWP::UserAgent::Role::CHICaching::VaryNotAsterisk; use 5.006000; use CHI; use Moo::Role; use Types::Standard qw(Str); our $AUTHORITY = 'cpan:KJETILK'; our $VERSION = '0.03'; =pod =encoding utf-8 =head1 NAME LWP::UserAgent::Role::CHICaching::VaryNotAsterisk - A role for when Vary is not * when caching LWP::UserAgent =head1 SYNOPSIS See L. =head1 DESCRIPTION See L for a background. Basically, this module does the second dumbest thing, but in doing so, the User Agent ceases to be compliant with the HTTP standard. You basically have to implement your own C attribute to make it compliant. =head2 Attributes and Methods =over =item C<< cache_vary >> Allow a response with a C header to be cached if it doesn't contain an asterisk (*). =back =cut sub cache_vary { my ($self, $res) = @_; foreach my $vary ($res->header('Vary')) { return 0 if ($vary =~ m/\*/); } return 1; } 1; __END__ =head1 AUTHOR Kjetil Kjernsmo Ekjetilk@cpan.orgE. =head1 COPYRIGHT AND LICENCE This software is copyright (c) 2015 by Kjetil Kjernsmo. This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.